1# Copyright (C) 2017 The Android Open Source Project 2# 3# Licensed under the Apache License, Version 2.0 (the "License"); 4# you may not use this file except in compliance with the License. 5# You may obtain a copy of the License at 6# 7# http://www.apache.org/licenses/LICENSE-2.0 8# 9# Unless required by applicable law or agreed to in writing, software 10# distributed under the License is distributed on an "AS IS" BASIS, 11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12# See the License for the specific language governing permissions and 13# limitations under the License. 14 15import itertools 16import subprocess 17 18def CheckChange(input, output): 19 # There apparently is no way to wrap strings in blueprints, so ignore long 20 # lines in them. 21 long_line_sources = lambda x: input.FilterSourceFile( 22 x, white_list=".*", 23 black_list=['Android[.]bp', '.*[.]json$', '.*[.]sql$', '.*[.]out$', 24 'test/trace_processor/index$', 'BUILD$', 'protos/BUILD$']) 25 results = [] 26 results += input.canned_checks.CheckDoNotSubmit(input, output) 27 results += input.canned_checks.CheckChangeHasNoTabs(input, output) 28 results += input.canned_checks.CheckLongLines( 29 input, output, 80, source_file_filter=long_line_sources) 30 results += input.canned_checks.CheckPatchFormatted( 31 input, output, check_js=True) 32 results += input.canned_checks.CheckGNFormatted(input, output) 33 results += CheckIncludeGuards(input, output) 34 results += CheckBuild(input, output) 35 results += CheckAndroidBlueprint(input, output) 36 results += CheckBinaryDescriptors(input, output) 37 results += CheckMergedTraceConfigProto(input, output) 38 results += CheckWhitelist(input, output) 39 return results 40 41 42def CheckChangeOnUpload(input_api, output_api): 43 return CheckChange(input_api, output_api) 44 45 46def CheckChangeOnCommit(input_api, output_api): 47 return CheckChange(input_api, output_api) 48 49 50def CheckBuild(input_api, output_api): 51 # If no GN files were modified, bail out. 52 def build_file_filter(x): return input_api.FilterSourceFile( 53 x, 54 white_list=('.*BUILD[.]gn$', '.*[.]gni$', 'tools/gen_build')) 55 if not input_api.AffectedSourceFiles(build_file_filter): 56 return [] 57 58 with open('BUILD') as f: 59 current_build = f.read() 60 61 new_build = subprocess.check_output( 62 ['tools/gen_build', '--output', '/dev/stdout', '--output-proto', '/dev/null']) 63 64 with open('protos/BUILD') as f: 65 current_proto_build = f.read() 66 67 new_proto_build = subprocess.check_output( 68 ['tools/gen_build', '--output', '/dev/null', '--output-proto', '/dev/stdout']) 69 70 if current_build != new_build or current_proto_build != new_proto_build: 71 return [ 72 output_api.PresubmitError( 73 'BUILD and/or protos/BUILD is out of date. Please run tools/gen_build ' 74 'to update it.') 75 ] 76 return [] 77 78 79def CheckAndroidBlueprint(input_api, output_api): 80 # If no GN files were modified, bail out. 81 build_file_filter = lambda x: input_api.FilterSourceFile( 82 x, 83 white_list=('.*BUILD[.]gn$', '.*[.]gni$', 'tools/gen_android_bp')) 84 if not input_api.AffectedSourceFiles(build_file_filter): 85 return [] 86 87 with open('Android.bp') as f: 88 current_blueprint = f.read() 89 90 new_blueprint = subprocess.check_output( 91 ['tools/gen_android_bp', '--output', '/dev/stdout']) 92 93 if current_blueprint != new_blueprint: 94 return [ 95 output_api.PresubmitError( 96 'Android.bp is out of date. Please run tools/gen_android_bp ' 97 'to update it.') 98 ] 99 return [] 100 101 102def CheckIncludeGuards(input_api, output_api): 103 tool = 'tools/fix_include_guards' 104 file_filter = lambda x: input_api.FilterSourceFile( 105 x, 106 white_list=('.*[.]cc$', '.*[.]h$', tool)) 107 if not input_api.AffectedSourceFiles(file_filter): 108 return [] 109 if subprocess.call([tool, '--check-only']): 110 return [ 111 output_api.PresubmitError( 112 'Please run ' + tool + ' to fix include guards.') 113 ] 114 return [] 115 116 117def CheckBinaryDescriptors(input_api, output_api): 118 tool = 'tools/gen_binary_descriptors' 119 file_filter = lambda x: input_api.FilterSourceFile( 120 x, 121 white_list=('protos/perfetto/.*[.]proto$', '.*[.]h', tool)) 122 if not input_api.AffectedSourceFiles(file_filter): 123 return [] 124 if subprocess.call([tool, '--check-only']): 125 return [ 126 output_api.PresubmitError( 127 'Please run ' + tool + ' to update binary descriptors.') 128 ] 129 return [] 130 131 132def CheckMergedTraceConfigProto(input_api, output_api): 133 tool = 'tools/gen_merged_protos' 134 build_file_filter = lambda x: input_api.FilterSourceFile( 135 x, 136 white_list=('protos/perfetto/.*[.]proto$', tool)) 137 if not input_api.AffectedSourceFiles(build_file_filter): 138 return [] 139 if subprocess.call([tool, '--check-only']): 140 return [ 141 output_api.PresubmitError( 142 'perfetto_config.proto or perfetto_trace.proto is out of ' + 143 'date. Please run ' + tool + ' to update it.') 144 ] 145 return [] 146 147 148# Prevent removing or changing lines in event_whitelist. 149def CheckWhitelist(input_api, output_api): 150 for f in input_api.AffectedFiles(): 151 if f.LocalPath() != 'tools/ftrace_proto_gen/event_whitelist': 152 continue 153 if any((not new_line.startswith('removed')) 154 and new_line != old_line for old_line, new_line 155 in itertools.izip(f.OldContents(), f.NewContents())): 156 return [ 157 output_api.PresubmitError( 158 'event_whitelist only has two supported changes: ' 159 'appending a new line, and replacing a line with removed.' 160 ) 161 ] 162 return [] 163