PRESUBMIT.py

# Copyright (c) 2010 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""Top-level presubmit script for depot tools.

See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts for
details on the presubmit API built into gcl.
"""

UNIT_TESTS = [
  'tests.gcl_unittest',
  'tests.gclient_scm_test',
  'tests.gclient_smoketest',
  'tests.gclient_utils_test',
  'tests.presubmit_unittest',
  'tests.scm_unittest',
  'tests.trychange_unittest',
  'tests.watchlists_unittest',
]

def CommonChecks(input_api, output_api):
  output = []
  # Verify that LocalPath() is local, e.g.:
  #   os.path.join(PresubmitLocalPath(), LocalPath()) == AbsoluteLocalPath()
  for i in input_api.AffectedFiles():
    if (input_api.os_path.join(input_api.PresubmitLocalPath(), i.LocalPath()) !=
        i.AbsoluteLocalPath()):
      output.append(output_api.PresubmitError('Path inconsistency'))
      # Return right away because it needs to be fixed first.
      return output

  output.extend(input_api.canned_checks.RunPythonUnitTests(
      input_api,
      output_api,
      UNIT_TESTS))
  output.extend(WasGitClUploadHookModified(input_api, output_api))

  white_list = [r'.*\.py$', r'^git-try$']
  black_list = list(input_api.DEFAULT_BLACK_LIST) + [
      r'^cpplint\.py$',
      r'^git_cl[\/\\].*',
      r'^git_cl_repo[\/\\].*',
      r'^git_cl[\/\\]test[\/\\]rietveld.*']
  output.extend(input_api.canned_checks.RunPylint(
      input_api,
      output_api,
      white_list=white_list,
      black_list=black_list))
  return output


def CheckChangeOnUpload(input_api, output_api):
  return CommonChecks(input_api, output_api)


def CheckChangeOnCommit(input_api, output_api):
  output = []
  output.extend(CommonChecks(input_api, output_api))
  output.extend(input_api.canned_checks.CheckDoNotSubmit(
      input_api,
      output_api))
  return output


def WasGitClUploadHookModified(input_api, output_api):
  for affected_file in input_api.AffectedSourceFiles(None):
    if (input_api.os_path.basename(affected_file.LocalPath()) ==
        'git-cl-upload-hook'):
      return [output_api.PresubmitPromptWarning(
          'Don\'t forget to fix git-cl to download the newest version of '
          'git-cl-upload-hook')]
  return []