Home | History | Annotate | Download | only in v8
      1 # Copyright 2012 the V8 project authors. All rights reserved.
      2 # Redistribution and use in source and binary forms, with or without
      3 # modification, are permitted provided that the following conditions are
      4 # met:
      5 #
      6 #     * Redistributions of source code must retain the above copyright
      7 #       notice, this list of conditions and the following disclaimer.
      8 #     * Redistributions in binary form must reproduce the above
      9 #       copyright notice, this list of conditions and the following
     10 #       disclaimer in the documentation and/or other materials provided
     11 #       with the distribution.
     12 #     * Neither the name of Google Inc. nor the names of its
     13 #       contributors may be used to endorse or promote products derived
     14 #       from this software without specific prior written permission.
     15 #
     16 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     17 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     18 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     19 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     20 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     21 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     22 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     23 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     24 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     25 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     26 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     27 
     28 """Top-level presubmit script for V8.
     29 
     30 See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts
     31 for more details about the presubmit API built into gcl.
     32 """
     33 
     34 def _V8PresubmitChecks(input_api, output_api):
     35   """Runs the V8 presubmit checks."""
     36   import sys
     37   sys.path.append(input_api.os_path.join(
     38         input_api.PresubmitLocalPath(), 'tools'))
     39   from presubmit import CppLintProcessor
     40   from presubmit import SourceProcessor
     41 
     42   results = []
     43   if not CppLintProcessor().Run(input_api.PresubmitLocalPath()):
     44     results.append(output_api.PresubmitError("C++ lint check failed"))
     45   if not SourceProcessor().Run(input_api.PresubmitLocalPath()):
     46     results.append(output_api.PresubmitError(
     47         "Copyright header, trailing whitespaces and two empty lines " \
     48         "between declarations check failed"))
     49   return results
     50 
     51 
     52 def _CommonChecks(input_api, output_api):
     53   """Checks common to both upload and commit."""
     54   results = []
     55   results.extend(input_api.canned_checks.CheckOwners(
     56       input_api, output_api, source_file_filter=None))
     57   results.extend(_V8PresubmitChecks(input_api, output_api))
     58   return results
     59 
     60 
     61 def _SkipTreeCheck(input_api, output_api):
     62   """Check the env var whether we want to skip tree check.
     63      Only skip if src/version.cc has been updated."""
     64   src_version = 'src/version.cc'
     65   FilterFile = lambda file: file.LocalPath() == src_version
     66   if not input_api.AffectedSourceFiles(
     67       lambda file: file.LocalPath() == src_version):
     68     return False
     69   return input_api.environ.get('PRESUBMIT_TREE_CHECK') == 'skip'
     70 
     71 
     72 def _CheckChangeLogFlag(input_api, output_api):
     73   """Checks usage of LOG= flag in the commit message."""
     74   results = []
     75   if input_api.change.BUG and not 'LOG' in input_api.change.tags:
     76     results.append(output_api.PresubmitError(
     77         'An issue reference (BUG=) requires a change log flag (LOG=). '
     78         'Use LOG=Y for including this commit message in the change log. '
     79         'Use LOG=N or leave blank otherwise.'))
     80   return results
     81 
     82 
     83 def CheckChangeOnUpload(input_api, output_api):
     84   results = []
     85   results.extend(_CommonChecks(input_api, output_api))
     86   results.extend(_CheckChangeLogFlag(input_api, output_api))
     87   return results
     88 
     89 
     90 def CheckChangeOnCommit(input_api, output_api):
     91   results = []
     92   results.extend(_CommonChecks(input_api, output_api))
     93   results.extend(_CheckChangeLogFlag(input_api, output_api))
     94   results.extend(input_api.canned_checks.CheckChangeHasDescription(
     95       input_api, output_api))
     96   if not _SkipTreeCheck(input_api, output_api):
     97     results.extend(input_api.canned_checks.CheckTreeIsOpen(
     98         input_api, output_api,
     99         json_url='http://v8-status.appspot.com/current?format=json'))
    100   return results
    101