Home | History | Annotate | Download | only in build
      1 # Copyright (c) 2011 The Chromium Authors. All rights reserved.
      2 # Use of this source code is governed by a BSD-style license that can be
      3 # found in the LICENSE file.
      4 
      5 # This file is meant to be included into an target to create a unittest that
      6 # invokes a set of no-compile tests.  A no-compile test is a test that asserts
      7 # a particular construct will not compile.
      8 #
      9 # Also see:
     10 #   http://dev.chromium.org/developers/testing/no-compile-tests
     11 #
     12 # To use this, create a gyp target with the following form:
     13 # {
     14 #   'target_name': 'my_module_nc_unittests',
     15 #   'type': 'executable',
     16 #   'sources': [
     17 #     'nc_testset_1.nc',
     18 #     'nc_testset_2.nc',
     19 #   ],
     20 #   'includes': ['path/to/this/gypi/file'],
     21 # }
     22 #
     23 # The .nc files are C++ files that contain code we wish to assert will not
     24 # compile.  Each individual test case in the file should be put in its own
     25 # #ifdef section.  The expected output should be appended with a C++-style
     26 # comment that has a python list of regular expressions.  This will likely
     27 # be greater than 80-characters. Giving a solid expected output test is
     28 # important so that random compile failures do not cause the test to pass.
     29 #
     30 # Example .nc file:
     31 #
     32 #   #if defined(TEST_NEEDS_SEMICOLON)  // [r"expected ',' or ';' at end of input"]
     33 #
     34 #   int a = 1
     35 #
     36 #   #elif defined(TEST_NEEDS_CAST)  // [r"invalid conversion from 'void*' to 'char*'"]
     37 #
     38 #   void* a = NULL;
     39 #   char* b = a;
     40 #
     41 #   #endif
     42 #
     43 # If we needed disable TEST_NEEDS_SEMICOLON, then change the define to:
     44 #
     45 #   DISABLE_TEST_NEEDS_SEMICOLON
     46 #   TEST_NEEDS_CAST
     47 #
     48 # The lines above are parsed by a regexp so avoid getting creative with the
     49 # formatting or ifdef logic; it will likely just not work.
     50 #
     51 # Implementation notes:
     52 # The .nc files are actually processed by a python script which executes the
     53 # compiler and generates a .cc file that is empty on success, or will have a
     54 # series of #error lines on failure, and a set of trivially passing gunit
     55 # TEST() functions on success. This allows us to fail at the compile step when
     56 # something goes wrong, and know during the unittest run that the test was at
     57 # least processed when things go right.
     58 
     59 {
     60   # TODO(awong): Disabled until http://crbug.com/105388 is resolved.
     61   'sources/': [['exclude', '\\.nc$']],
     62   'conditions': [
     63     [ 'OS=="linux" and clang==0', {
     64       'rules': [
     65         {
     66           'variables': {
     67             'nocompile_driver': '<(DEPTH)/tools/nocompile_driver.py',
     68             'nc_result_path': ('<(INTERMEDIATE_DIR)/<(module_dir)/'
     69                                '<(RULE_INPUT_ROOT)_nc.cc'),
     70            },
     71           'rule_name': 'run_nocompile',
     72           'extension': 'nc',
     73           'inputs': [
     74             '<(nocompile_driver)',
     75           ],
     76           'outputs': [
     77             '<(nc_result_path)'
     78           ],
     79           'action': [
     80             'python',
     81             '<(nocompile_driver)',
     82             '4', # number of compilers to invoke in parallel.
     83             '<(RULE_INPUT_PATH)',
     84             '-Wall -Werror -Wfatal-errors -I<(DEPTH)',
     85             '<(nc_result_path)',
     86             ],
     87           'message': 'Generating no compile results for <(RULE_INPUT_PATH)',
     88           'process_outputs_as_sources': 1,
     89         },
     90       ],
     91     }, {
     92       'sources/': [['exclude', '\\.nc$']]
     93     }],  # 'OS=="linux" and clang=="0"'
     94   ],
     95 }
     96 
     97