PRESUBMIT.py

# Copyright (C) 2017 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import itertools
import subprocess

def CheckChange(input, output):
    # There apparently is no way to wrap strings in blueprints, so ignore long
    # lines in them.
    long_line_sources = lambda x: input.FilterSourceFile(
            x, white_list=".*",
            black_list=['Android[.]bp', '.*[.]json$', '.*[.]sql$', '.*[.]out$',
                        'test/trace_processor/index$', 'BUILD$', 'protos/BUILD$'])
    results = []
    results += input.canned_checks.CheckDoNotSubmit(input, output)
    results += input.canned_checks.CheckChangeHasNoTabs(input, output)
    results += input.canned_checks.CheckLongLines(
            input, output, 80, source_file_filter=long_line_sources)
    results += input.canned_checks.CheckPatchFormatted(
            input, output, check_js=True)
    results += input.canned_checks.CheckGNFormatted(input, output)
    results += CheckIncludeGuards(input, output)
    results += CheckBuild(input, output)
    results += CheckAndroidBlueprint(input, output)
    results += CheckBinaryDescriptors(input, output)
    results += CheckMergedTraceConfigProto(input, output)
    results += CheckWhitelist(input, output)
    return results


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


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


def CheckBuild(input_api, output_api):
    # If no GN files were modified, bail out.
    def build_file_filter(x): return input_api.FilterSourceFile(
        x,
        white_list=('.*BUILD[.]gn$', '.*[.]gni$', 'tools/gen_bazel'))
    if not input_api.AffectedSourceFiles(build_file_filter):
        return []

    with open('BUILD') as f:
        current_build = f.read()

    new_build = subprocess.check_output(
        ['tools/gen_bazel', '--output', '/dev/stdout', '--output-proto', '/dev/null'])

    with open('protos/BUILD') as f:
        current_proto_build = f.read()

    new_proto_build = subprocess.check_output(
        ['tools/gen_bazel', '--output', '/dev/null', '--output-proto', '/dev/stdout'])

    if current_build != new_build or current_proto_build != new_proto_build:
        return [
            output_api.PresubmitError(
                'BUILD and/or protos/BUILD is out of date. Please run tools/gen_bazel '
                'to update it.')
        ]
    return []


def CheckAndroidBlueprint(input_api, output_api):
    # If no GN files were modified, bail out.
    build_file_filter = lambda x: input_api.FilterSourceFile(
          x,
          white_list=('.*BUILD[.]gn$', '.*[.]gni$', 'tools/gen_android_bp'))
    if not input_api.AffectedSourceFiles(build_file_filter):
        return []

    with open('Android.bp') as f:
        current_blueprint = f.read()

    new_blueprint = subprocess.check_output(
        ['tools/gen_android_bp', '--output', '/dev/stdout'])

    if current_blueprint != new_blueprint:
        return [
            output_api.PresubmitError(
                'Android.bp is out of date. Please run tools/gen_android_bp '
                'to update it.')
        ]
    return []


def CheckIncludeGuards(input_api, output_api):
    tool = 'tools/fix_include_guards'
    file_filter = lambda x: input_api.FilterSourceFile(
          x,
          white_list=('.*[.]cc$', '.*[.]h$', tool))
    if not input_api.AffectedSourceFiles(file_filter):
        return []
    if subprocess.call([tool, '--check-only']):
        return [
            output_api.PresubmitError(
                'Please run ' + tool + ' to fix include guards.')
        ]
    return []


def CheckBinaryDescriptors(input_api, output_api):
    tool = 'tools/gen_binary_descriptors'
    file_filter = lambda x: input_api.FilterSourceFile(
          x,
          white_list=('protos/perfetto/.*[.]proto$', '.*[.]h', tool))
    if not input_api.AffectedSourceFiles(file_filter):
        return []
    if subprocess.call([tool, '--check-only']):
        return [
            output_api.PresubmitError(
                'Please run ' + tool + ' to update binary descriptors.')
        ]
    return []


def CheckMergedTraceConfigProto(input_api, output_api):
    tool = 'tools/gen_merged_protos'
    build_file_filter = lambda x: input_api.FilterSourceFile(
          x,
          white_list=('protos/perfetto/.*[.]proto$', tool))
    if not input_api.AffectedSourceFiles(build_file_filter):
        return []
    if subprocess.call([tool, '--check-only']):
        return [
            output_api.PresubmitError(
                'perfetto_config.proto or perfetto_trace.proto is out of ' +
                'date. Please run ' + tool + ' to update it.')
        ]
    return []


# Prevent removing or changing lines in event_whitelist.
def CheckWhitelist(input_api, output_api):
  for f in input_api.AffectedFiles():
    if f.LocalPath() != 'tools/ftrace_proto_gen/event_whitelist':
      continue
    if any((not new_line.startswith('removed'))
            and new_line != old_line for old_line, new_line
           in itertools.izip(f.OldContents(), f.NewContents())):
      return [
        output_api.PresubmitError(
            'event_whitelist only has two supported changes: '
            'appending a new line, and replacing a line with removed.'
        )
      ]
  return []