PRESUBMIT Namespace Reference

Classes
class	_WarningsAsErrors
class	CodeReview

Functions
def	load_source (modname, filename)
def	runSmokeTest (input_api, output_api)
def	CheckChangeOnCommit (input_api, output_api)
def	CheckChangeOnUpload (input_api, output_api)
def	EnsurePubspecAndChangelogAltered (input_api, package_name)
def	CheckChange (input_api, output_api)
def	CheckNodeTextExpectationsCollectorUpdatingIsDisabled (input_api, output_api)
def	is_cpp_file (path)
def	is_dart_file (path)
def	get_old_contents (input_api, path)
def	files_to_check_for_format (input_api, extension, exclude_folders)
def	CheckMemcpy (filename)
def	RunLint (input_api, output_api)
def	CheckGn (input_api, output_api)
def	CheckFormatted (input_api, output_api)
def	PostUploadHook (gerrit, change, output_api)

Variables
bool	USE_PYTHON3 = True
string	PRESUBMIT_VERSION = '2.0.0'
string	RELEASE_NOTES_DIR = 'relnotes'
string	RELEASE_NOTES_FILE_NAME = 'RELEASE_NOTES.md'
string	RELEASE_NOTES_README = '//relnotes/README.md'
string	GOLD_TRYBOT_URL = 'https://gold.skia.org/search?issue='
list	SERVICE_ACCOUNT_SUFFIX

Function Documentation

CheckChange()

def PRESUBMIT.CheckChange	(		input_api,
			output_api
	)

Definition at line 41 of file PRESUBMIT.py.

def CheckChange(input_api, output_api):
    errors = []
 
    # If the `lib` dir is altered, we also require a change to the pubspec.yaml
    # of both this package and the `macros` package.
    lib_changed = any(file.LocalPath().startswith('pkg/_macros/lib')
                      for file in input_api.AffectedFiles())
    if lib_changed:
        errors += EnsurePubspecAndChangelogAltered(input_api, '_macros')
        errors += EnsurePubspecAndChangelogAltered(input_api, 'macros')
 
    if errors:
        return [
            output_api.PresubmitError(
                'pkg/_macros presubmit/PRESUBMIT.py failure(s):',
                long_text='\n\n'.join(errors))
        ]
 
    return []

CheckChangeOnCommit()

def PRESUBMIT.CheckChangeOnCommit	(	input_api	,
		output_api
	)

Presubmit checks for the change on commit.

Definition at line 66 of file PRESUBMIT.py.

def CheckChangeOnCommit(input_api, output_api):
    return runSmokeTest(input_api, output_api)
 
 

CheckChangeOnUpload()

def PRESUBMIT.CheckChangeOnUpload	(	input_api	,
		output_api
	)

Presubmit checks for the change on upload.

Definition at line 70 of file PRESUBMIT.py.

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

CheckFormatted()

def PRESUBMIT.CheckFormatted	(		input_api,
			output_api
	)

Definition at line 62 of file PRESUBMIT.py.

def CheckFormatted(input_api, output_api):
 
    def convert_warning_to_error(presubmit_result):
        if not presubmit_result.fatal:
            # Convert this warning to an error.
            result_json = presubmit_result.json_format()
            return output_api.PresubmitError(
                message=result_json['message'],
                items=result_json['items'],
                long_text=result_json['long_text'])
        return presubmit_result
 
    results = input_api.canned_checks.CheckPatchFormatted(input_api, output_api)
    return [convert_warning_to_error(r) for r in results]
 
 

CheckGn()

def PRESUBMIT.CheckGn	(		input_api,
			output_api
	)

Definition at line 58 of file PRESUBMIT.py.

def CheckGn(input_api, output_api):
    return input_api.canned_checks.CheckGNFormatted(input_api, output_api)
 
 

CheckMemcpy()

def PRESUBMIT.CheckMemcpy

(

filename

)

Definition at line 17 of file PRESUBMIT.py.

def CheckMemcpy(filename):
    if filename.endswith(os.path.join('platform', 'globals.h')) or \
       filename.find('third_party') != -1:
        return 0
    fh = open(filename, 'r')
    content = fh.read()
    match = re.search('\\bmemcpy\\b', content)
    if match:
        offset = match.start()
        end_of_line = content.index('\n', offset)
        # We allow explicit use of memcpy with an opt-in via NOLINT
        if 'NOLINT' not in content[offset:end_of_line]:
            line_number = content[0:match.start()].count('\n') + 1
            print("%s:%d: use of memcpy is forbidden" % (filename, line_number))
            return 1
    return 0
 
 

CheckNodeTextExpectationsCollectorUpdatingIsDisabled()

def PRESUBMIT.CheckNodeTextExpectationsCollectorUpdatingIsDisabled	(		input_api,
			output_api
	)

Definition at line 18 of file PRESUBMIT.py.

def CheckNodeTextExpectationsCollectorUpdatingIsDisabled(input_api, output_api):
    local_root = input_api.change.RepositoryRoot()
    node_text_expectations_file = os.path.join(local_root, 'pkg', 'analyzer',
                                               'test', 'src', 'dart',
                                               'resolution',
                                               'node_text_expectations.dart')
    for git_file in input_api.AffectedTestableFiles():
        filename = git_file.AbsoluteLocalPath()
        if (filename == node_text_expectations_file):
            isEnabledLine = re.compile('static const updatingIsEnabled = (.*);')
            for line in git_file.NewContents():
                m = isEnabledLine.search(line)
                if (m is not None):
                    value = m.group(1)
                    if (value == 'false'):
                        return []
                    else:
                        return [
                            output_api.PresubmitError(
                                'NodeTextExpectationsCollector.updatingIsEnabled '
                                'must be `false`')
                        ]
            return [
                output_api.PresubmitError(
                    'Could not validate '
                    'NodeTextExpectationsCollector.updatingIsEnabled')
            ]
    return []

EnsurePubspecAndChangelogAltered()

def PRESUBMIT.EnsurePubspecAndChangelogAltered	(		input_api,
			package_name
	)

Definition at line 20 of file PRESUBMIT.py.

def EnsurePubspecAndChangelogAltered(input_api, package_name):
    errors = []
    package_path = 'pkg/%s' % package_name
    pubspec_path = '%s/pubspec.yaml' % package_path
    pubspec_changed = any(file.LocalPath() == pubspec_path
                          for file in input_api.change.AffectedFiles())
    if not pubspec_changed:
        errors.append(
            ('The pkg/_macros/lib dir was altered but the version of %s was '
             'not bumped. See pkg/_macros/CONTRIBUTING.md' % package_path))
 
    changelog_path = '%s/CHANGELOG.md' % package_path
    changelog_changed = any(file.LocalPath() == changelog_path
                            for file in input_api.change.AffectedFiles())
    if not changelog_changed:
        errors.append(
            ('The pkg/_macros/lib dir was altered but the CHANGELOG.md of %s '
             'was not edited. See pkg/_macros/CONTRIBUTING.md' % package_path))
    return errors
 
# Invoked on upload and commit.

files_to_check_for_format()

def PRESUBMIT.files_to_check_for_format	(		input_api,
			extension,
			exclude_folders
	)

Definition at line 41 of file PRESUBMIT.py.

def files_to_check_for_format(input_api, extension, exclude_folders):
    files = []
    exclude_folders += [
        "pkg/front_end/testcases/", "pkg/front_end/parser_testcases/"
    ]
    for git_file in input_api.AffectedTextFiles():
        local_path = git_file.LocalPath()
        if not local_path.endswith(extension):
            continue
        if any([local_path.startswith(f) for f in exclude_folders]):
            continue
        files.append(git_file)
    return files
 
 

get_old_contents()

def PRESUBMIT.get_old_contents	(		input_api,
			path
	)

Definition at line 33 of file PRESUBMIT.py.

def get_old_contents(input_api, path):
    local_root = input_api.change.RepositoryRoot()
    upstream = input_api.change._upstream
    return scm.GIT.Capture(['show', upstream + ':' + path],
                           cwd=local_root,
                           strip_out=False)
 
 

is_cpp_file()

def PRESUBMIT.is_cpp_file

(

path

)

Definition at line 25 of file PRESUBMIT.py.

def is_cpp_file(path):
    return path.endswith('.cc') or path.endswith('.h')
 
 

is_dart_file()

def PRESUBMIT.is_dart_file

(

path

)

Definition at line 29 of file PRESUBMIT.py.

def is_dart_file(path):
    return path.endswith('.dart')
 
 

load_source()

def PRESUBMIT.load_source	(		modname,
			filename
	)

Definition at line 19 of file PRESUBMIT.py.

def load_source(modname, filename):
    loader = importlib.machinery.SourceFileLoader(modname, filename)
    spec = importlib.util.spec_from_file_location(modname,
                                                  filename,
                                                  loader=loader)
    module = importlib.util.module_from_spec(spec)
    # The module is always executed and not cached in sys.modules.
    # Uncomment the following line to cache the module.
    # sys.modules[module.__name__] = module
    loader.exec_module(module)
    return module
 
 

PostUploadHook()

def PRESUBMIT.PostUploadHook	(		gerrit,
			change,
			output_api
	)

git cl upload will call this hook after the issue is created/modified.

This hook does the following:
* Adds a link to preview docs changes if there are any docs changes in the CL.
* Adds 'No-Try: true' if the CL contains only docs changes.

Definition at line 658 of file PRESUBMIT.py.

def PostUploadHook(gerrit, change, output_api):
  """git cl upload will call this hook after the issue is created/modified.
 
  This hook does the following:
  * Adds a link to preview docs changes if there are any docs changes in the CL.
  * Adds 'No-Try: true' if the CL contains only docs changes.
  """
  if not change.issue:
    return []
 
  # Skip PostUploadHooks for all auto-commit service account bots. New
  # patchsets (caused due to PostUploadHooks) invalidates the CQ+2 vote from
  # the "--use-commit-queue" flag to "git cl upload".
  for suffix in SERVICE_ACCOUNT_SUFFIX:
    if change.author_email.endswith(suffix):
      return []
 
  results = []
  at_least_one_docs_change = False
  all_docs_changes = True
  for affected_file in change.AffectedFiles():
    affected_file_path = affected_file.LocalPath()
    file_path, _ = os.path.splitext(affected_file_path)
    if 'site' == file_path.split(os.path.sep)[0]:
      at_least_one_docs_change = True
    else:
      all_docs_changes = False
    if at_least_one_docs_change and not all_docs_changes:
      break
 
  footers = change.GitFootersFromDescription()
  description_changed = False
 
  # If the change includes only doc changes then add No-Try: true in the
  # CL's description if it does not exist yet.
  if all_docs_changes and 'true' not in footers.get('No-Try', []):
    description_changed = True
    change.AddDescriptionFooter('No-Try', 'true')
    results.append(
        output_api.PresubmitNotifyResult(
            'This change has only doc changes. Automatically added '
            '\'No-Try: true\' to the CL\'s description'))
 
  # If the description has changed update it.
  if description_changed:
    gerrit.UpdateDescription(
        change.FullDescriptionText(), change.issue)
 
  return results
 
 

RunLint()

def PRESUBMIT.RunLint	(		input_api,
			output_api
	)

Definition at line 35 of file PRESUBMIT.py.

def RunLint(input_api, output_api):
    result = []
    cpplint._cpplint_state.ResetErrorCounts()
    memcpy_match_count = 0
    # Find all .cc and .h files in the change list.
    for git_file in input_api.AffectedTextFiles():
        filename = git_file.AbsoluteLocalPath()
        if filename.endswith('.cc') or (
                # cpplint complains about the style of #ifndefs in our .pbzero.h
                # files, but they are generated by the protozero compiler, so we
                # can't fix this.
                not filename.endswith('.pbzero.h') and filename.endswith('.h')):
            # Run cpplint on the file.
            cpplint.ProcessFile(filename, 1)
            # Check for memcpy use.
            memcpy_match_count += CheckMemcpy(filename)
 
    # Report a presubmit error if any of the files had an error.
    if cpplint._cpplint_state.error_count > 0 or memcpy_match_count > 0:
        result = [output_api.PresubmitError('Failed cpplint check.')]
    return result
 
 

runSmokeTest()

def PRESUBMIT.runSmokeTest	(		input_api,
			output_api
	)

Definition at line 32 of file PRESUBMIT.py.

def runSmokeTest(input_api, output_api):
    local_root = input_api.change.RepositoryRoot()
    utils = load_source('utils', os.path.join(local_root, 'tools', 'utils.py'))
    dart = os.path.join(utils.CheckedInSdkPath(), 'bin', 'dart')
    test_helper = os.path.join(local_root, 'pkg', 'front_end',
                               'presubmit_helper.dart')
 
    windows = utils.GuessOS() == 'win32'
    if windows:
        dart += '.exe'
 
    if not os.path.isfile(dart):
        print('WARNING: dart not found: %s' % dart)
        return []
 
    if not os.path.isfile(test_helper):
        print('WARNING: CFE et al presubmit_helper not found: %s' % test_helper)
        return []
 
    args = [dart, test_helper, input_api.PresubmitLocalPath()]
    process = subprocess.Popen(args,
                               stdout=subprocess.PIPE,
                               stdin=subprocess.PIPE)
    outs, _ = process.communicate()
 
    if process.returncode != 0:
        return [
            output_api.PresubmitError('CFE et al presubmit script failure(s):',
                                      long_text=outs)
        ]
 
    return []
 
 

Variable Documentation

GOLD_TRYBOT_URL

string PRESUBMIT.GOLD_TRYBOT_URL = 'https://gold.skia.org/search?issue='

Definition at line 25 of file PRESUBMIT.py.

PRESUBMIT_VERSION

string PRESUBMIT.PRESUBMIT_VERSION = '2.0.0'

Definition at line 11 of file PRESUBMIT.py.

RELEASE_NOTES_DIR

string PRESUBMIT.RELEASE_NOTES_DIR = 'relnotes'

Definition at line 21 of file PRESUBMIT.py.

RELEASE_NOTES_FILE_NAME

string PRESUBMIT.RELEASE_NOTES_FILE_NAME = 'RELEASE_NOTES.md'

Definition at line 22 of file PRESUBMIT.py.

RELEASE_NOTES_README

string PRESUBMIT.RELEASE_NOTES_README = '//relnotes/README.md'

Definition at line 23 of file PRESUBMIT.py.

SERVICE_ACCOUNT_SUFFIX

list PRESUBMIT.SERVICE_ACCOUNT_SUFFIX

Initial value:

=  [
    '@%s.iam.gserviceaccount.com' % project for project in [
        'skia-buildbots.google.com', 'skia-swarming-bots', 'skia-public',
        'skia-corp.google.com', 'chops-service-accounts']]

Definition at line 27 of file PRESUBMIT.py.

USE_PYTHON3

bool PRESUBMIT.USE_PYTHON3 = True

Definition at line 16 of file PRESUBMIT.py.