4 crcchecker is a tool to used to enforce that .api messages do not change.
5 API files with a semantic version < 1.0.0 are ignored.
13 from subprocess import run, PIPE, check_output, CalledProcessError
15 # pylint: disable=subprocess-run-check
17 ROOTDIR = os.path.dirname(os.path.realpath(__file__)) + '/../..'
18 APIGENBIN = f'{ROOTDIR}/src/tools/vppapigen/vppapigen.py'
21 def crc_from_apigen(revision, filename):
22 '''Runs vppapigen with crc plugin returning a JSON object with CRCs for
23 all APIs in filename'''
24 if not revision and not os.path.isfile(filename):
25 print(f'skipping: {filename}', file=sys.stderr)
29 apigen = (f'{APIGENBIN} --git-revision {revision} --includedir src '
30 f'--input {filename} CRC')
32 apigen = (f'{APIGENBIN} --includedir src --input {filename} CRC')
33 returncode = run(apigen.split(), stdout=PIPE, stderr=PIPE)
34 if returncode.returncode == 2: # No such file
35 print(f'skipping: {revision}:{filename} {returncode}', file=sys.stderr)
37 if returncode.returncode != 0:
38 print(f'vppapigen failed for {revision}:{filename} with '
39 'command\n {apigen}\n error: {rv}',
40 returncode.stderr.decode('ascii'), file=sys.stderr)
43 return json.loads(returncode.stdout)
46 def dict_compare(dict1, dict2):
47 '''Compare two dictionaries returning added, removed, modified
49 d1_keys = set(dict1.keys())
50 d2_keys = set(dict2.keys())
51 intersect_keys = d1_keys.intersection(d2_keys)
52 added = d1_keys - d2_keys
53 removed = d2_keys - d1_keys
54 modified = {o: (dict1[o], dict2[o]) for o in intersect_keys
55 if dict1[o]['crc'] != dict2[o]['crc']}
56 same = set(o for o in intersect_keys if dict1[o] == dict2[o])
57 return added, removed, modified, same
60 def filelist_from_git_ls():
61 '''Returns a list of all api files in the git repository'''
63 git_ls = 'git ls-files *.api'
64 returncode = run(git_ls.split(), stdout=PIPE, stderr=PIPE)
65 if returncode.returncode != 0:
66 sys.exit(returncode.returncode)
68 for line in returncode.stdout.decode('ascii').split('\n'):
74 def is_uncommitted_changes():
75 '''Returns true if there are uncommitted changes in the repo'''
76 git_status = 'git status --porcelain -uno'
77 returncode = run(git_status.split(), stdout=PIPE, stderr=PIPE)
78 if returncode.returncode != 0:
79 sys.exit(returncode.returncode)
86 def filelist_from_git_grep(filename):
87 '''Returns a list of api files that this <filename> api files imports.'''
90 returncode = check_output(f'git grep -e "import .*{filename}"'
93 except CalledProcessError:
95 for line in returncode.decode('ascii').split('\n'):
97 filename, _ = line.split(':')
98 filelist.append(filename)
102 def filelist_from_patchset(pattern):
103 '''Returns list of api files in changeset and the list of api
104 files they import.'''
106 git_cmd = ('((git diff HEAD~1.. --name-only;git ls-files -m) | '
107 'sort -u | grep "\\.api$")')
108 returncode = check_output(git_cmd, shell=True)
110 # Check for dependencies (imports)
112 for line in returncode.decode('ascii').split('\n'):
115 if not re.search(pattern, line):
117 filelist.append(line)
118 imported_files.extend(filelist_from_git_grep(os.path.basename(line)))
120 filelist.extend(imported_files)
124 def is_deprecated(message):
125 '''Given a message, return True if message is deprecated'''
126 if 'options' in message:
127 if 'deprecated' in message['options']:
129 # recognize the deprecated format
130 if 'status' in message['options'] and \
131 message['options']['status'] == 'deprecated':
132 print("WARNING: please use 'option deprecated;'")
137 def is_in_progress(message):
138 '''Given a message, return True if message is marked as in_progress'''
139 if 'options' in message:
140 if 'in_progress' in message['options']:
142 # recognize the deprecated format
143 if 'status' in message['options'] and \
144 message['options']['status'] == 'in_progress':
145 print("WARNING: please use 'option in_progress;'")
150 def report(new, old):
151 '''Given a dictionary of new crcs and old crcs, print all the
152 added, removed, modified, in-progress, deprecated messages.
153 Return the number of backwards incompatible changes made.'''
155 # pylint: disable=too-many-branches
157 new.pop('_version', None)
158 old.pop('_version', None)
159 added, removed, modified, _ = dict_compare(new, old)
160 backwards_incompatible = 0
162 # print the full list of in-progress messages
163 # they should eventually either disappear of become supported
165 newversion = int(new[k]['version'])
166 if newversion == 0 or is_in_progress(new[k]):
167 print(f'in-progress: {k}')
171 oldversion = int(old[k]['version'])
172 if oldversion > 0 and not is_deprecated(old[k]) and not \
173 is_in_progress(old[k]):
174 backwards_incompatible += 1
175 print(f'removed: ** {k}')
177 print(f'removed: {k}')
178 for k in modified.keys():
179 oldversion = int(old[k]['version'])
180 newversion = int(new[k]['version'])
181 if oldversion > 0 and not is_in_progress(old[k]):
182 backwards_incompatible += 1
183 print(f'modified: ** {k}')
185 print(f'modified: {k}')
187 # check which messages are still there but were marked for deprecation
189 newversion = int(new[k]['version'])
190 if newversion > 0 and is_deprecated(new[k]):
192 if not is_deprecated(old[k]):
193 print(f'deprecated: {k}')
195 print(f'added+deprecated: {k}')
197 return backwards_incompatible
200 def check_patchset():
201 '''Compare the changes to API messages in this changeset.
202 Ignores API files with version < 1.0.0.
203 Only considers API files located under the src directory in the repo.
205 files = filelist_from_patchset('^src/')
210 for filename in files:
211 # Ignore files that have version < 1.0.0
212 _ = crc_from_apigen(None, filename)
213 if _['_version']['major'] == '0':
217 oldcrcs.update(crc_from_apigen(revision, filename))
219 backwards_incompatible = report(newcrcs, oldcrcs)
220 if backwards_incompatible:
221 # alert on changing production API
222 print("crcchecker: Changing production APIs in an incompatible way",
227 print('* VPP CHECKAPI SUCCESSFULLY COMPLETED')
232 '''Main entry point.'''
233 parser = argparse.ArgumentParser(description='VPP CRC checker.')
234 parser.add_argument('--git-revision',
235 help='Git revision to compare against')
236 parser.add_argument('--dump-manifest', action='store_true',
237 help='Dump CRC for all messages')
238 parser.add_argument('--check-patchset', action='store_true',
239 help='Check patchset for backwards incompatbile changes')
240 parser.add_argument('files', nargs='*')
241 parser.add_argument('--diff', help='Files to compare (on filesystem)',
244 args = parser.parse_args()
246 if args.diff and args.files:
252 oldcrcs = crc_from_apigen(None, args.diff[0])
253 newcrcs = crc_from_apigen(None, args.diff[1])
254 backwards_incompatible = report(newcrcs, oldcrcs)
257 # Dump CRC for messages in given files / revision
258 if args.dump_manifest:
259 files = args.files if args.files else filelist_from_git_ls()
261 for filename in files:
262 crcs.update(crc_from_apigen(args.git_revision, filename))
263 for k, value in crcs.items():
264 print(f'{k}: {value}')
267 # Find changes between current patchset and given revision (previous)
268 if args.check_patchset:
269 if args.git_revision:
270 print('Argument git-revision ignored', file=sys.stderr)
271 # Check there are no uncomitted changes
272 if is_uncommitted_changes():
273 print('Please stash or commit changes in workspace',
279 # Find changes between current workspace and revision
280 # Find changes between a given file and a revision
281 files = args.files if args.files else filelist_from_git_ls()
283 revision = args.git_revision if args.git_revision else 'HEAD~1'
288 newcrcs.update(crc_from_apigen(None, file))
289 oldcrcs.update(crc_from_apigen(revision, file))
291 backwards_incompatible = report(newcrcs, oldcrcs)
293 if args.check_patchset:
294 if backwards_incompatible:
295 # alert on changing production API
296 print("crcchecker: Changing production APIs in an incompatible way", file=sys.stderr)
300 print('* VPP CHECKAPI SUCCESSFULLY COMPLETED')
304 if __name__ == '__main__':