extras/scripts/crcchecker.py

   1 #!/usr/bin/env python3
   2
   3 """
   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.
   6 """
   7
   8 import sys
   9 import os
  10 import json
  11 import argparse
  12 import re
  13 from subprocess import run, PIPE, check_output, CalledProcessError
  14
  15 # pylint: disable=subprocess-run-check
  16
  17 ROOTDIR = os.path.dirname(os.path.realpath(__file__)) + "/../.."
  18 APIGENBIN = f"{ROOTDIR}/src/tools/vppapigen/vppapigen.py"
  19
  20
  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)
  26         # Return <class 'set'> instead of <class 'dict'>
  27         return {-1}
  28
  29     if revision:
  30         apigen = (
  31             f"{APIGENBIN} --git-revision {revision} --includedir src "
  32             f"--input {filename} CRC"
  33         )
  34     else:
  35         apigen = f"{APIGENBIN} --includedir src --input {filename} CRC"
  36     returncode = run(apigen.split(), stdout=PIPE, stderr=PIPE)
  37     if returncode.returncode == 2:  # No such file
  38         print(f"skipping: {revision}:{filename} {returncode}", file=sys.stderr)
  39         return {}
  40     if returncode.returncode != 0:
  41         print(
  42             f"vppapigen failed for {revision}:{filename} with "
  43             "command\n {apigen}\n error: {rv}",
  44             returncode.stderr.decode("ascii"),
  45             file=sys.stderr,
  46         )
  47         sys.exit(-2)
  48
  49     return json.loads(returncode.stdout)
  50
  51
  52 def dict_compare(dict1, dict2):
  53     """Compare two dictionaries returning added, removed, modified
  54     and equal entries"""
  55     d1_keys = set(dict1.keys())
  56     d2_keys = set(dict2.keys())
  57     intersect_keys = d1_keys.intersection(d2_keys)
  58     added = d1_keys - d2_keys
  59     removed = d2_keys - d1_keys
  60     modified = {
  61         o: (dict1[o], dict2[o])
  62         for o in intersect_keys
  63         if dict1[o]["crc"] != dict2[o]["crc"]
  64     }
  65     same = set(o for o in intersect_keys if dict1[o] == dict2[o])
  66     return added, removed, modified, same
  67
  68
  69 def filelist_from_git_ls():
  70     """Returns a list of all api files in the git repository"""
  71     filelist = []
  72     git_ls = "git ls-files *.api"
  73     returncode = run(git_ls.split(), stdout=PIPE, stderr=PIPE)
  74     if returncode.returncode != 0:
  75         sys.exit(returncode.returncode)
  76
  77     for line in returncode.stdout.decode("ascii").split("\n"):
  78         if line:
  79             filelist.append(line)
  80     return filelist
  81
  82
  83 def is_uncommitted_changes():
  84     """Returns true if there are uncommitted changes in the repo"""
  85     git_status = "git status --porcelain -uno"
  86     returncode = run(git_status.split(), stdout=PIPE, stderr=PIPE)
  87     if returncode.returncode != 0:
  88         sys.exit(returncode.returncode)
  89
  90     if returncode.stdout:
  91         return True
  92     return False
  93
  94
  95 def filelist_from_git_grep(filename):
  96     """Returns a list of api files that this <filename> api files imports."""
  97     filelist = []
  98     try:
  99         returncode = check_output(
 100             f'git grep -e "import .*{filename}"' " -- *.api", shell=True
 101         )
 102     except CalledProcessError:
 103         return []
 104     for line in returncode.decode("ascii").split("\n"):
 105         if line:
 106             filename, _ = line.split(":")
 107             filelist.append(filename)
 108     return filelist
 109
 110
 111 def filelist_from_patchset(pattern):
 112     """Returns list of api files in changeset and the list of api
 113     files they import."""
 114     filelist = []
 115     git_cmd = (
 116         "((git diff HEAD~1.. --name-only;git ls-files -m) | "
 117         'sort -u | grep "\\.api$")'
 118     )
 119     try:
 120         res = check_output(git_cmd, shell=True)
 121     except CalledProcessError:
 122         return []
 123
 124     # Check for dependencies (imports)
 125     imported_files = []
 126     for line in res.decode("ascii").split("\n"):
 127         if not line:
 128             continue
 129         if not re.search(pattern, line):
 130             continue
 131         filelist.append(line)
 132         imported_files.extend(filelist_from_git_grep(os.path.basename(line)))
 133
 134     filelist.extend(imported_files)
 135     return set(filelist)
 136
 137
 138 def is_deprecated(message):
 139     """Given a message, return True if message is deprecated"""
 140     if "options" in message:
 141         if "deprecated" in message["options"]:
 142             return True
 143         # recognize the deprecated format
 144         if (
 145             "status" in message["options"]
 146             and message["options"]["status"] == "deprecated"
 147         ):
 148             print("WARNING: please use 'option deprecated;'")
 149             return True
 150     return False
 151
 152
 153 def is_in_progress(message):
 154     """Given a message, return True if message is marked as in_progress"""
 155     if "options" in message:
 156         if "in_progress" in message["options"]:
 157             return True
 158         # recognize the deprecated format
 159         if (
 160             "status" in message["options"]
 161             and message["options"]["status"] == "in_progress"
 162         ):
 163             print("WARNING: please use 'option in_progress;'")
 164             return True
 165     return False
 166
 167
 168 def report(new, old):
 169     """Given a dictionary of new crcs and old crcs, print all the
 170     added, removed, modified, in-progress, deprecated messages.
 171     Return the number of backwards incompatible changes made."""
 172
 173     # pylint: disable=too-many-branches
 174
 175     new.pop("_version", None)
 176     old.pop("_version", None)
 177     added, removed, modified, _ = dict_compare(new, old)
 178     backwards_incompatible = 0
 179
 180     # print the full list of in-progress messages
 181     # they should eventually either disappear of become supported
 182     for k in new.keys():
 183         newversion = int(new[k]["version"])
 184         if newversion == 0 or is_in_progress(new[k]):
 185             print(f"in-progress: {k}")
 186     for k in added:
 187         print(f"added: {k}")
 188     for k in removed:
 189         oldversion = int(old[k]["version"])
 190         if oldversion > 0 and not is_deprecated(old[k]) and not is_in_progress(old[k]):
 191             backwards_incompatible += 1
 192             print(f"removed: ** {k}")
 193         else:
 194             print(f"removed: {k}")
 195     for k in modified.keys():
 196         oldversion = int(old[k]["version"])
 197         newversion = int(new[k]["version"])
 198         if oldversion > 0 and not is_in_progress(old[k]):
 199             backwards_incompatible += 1
 200             print(f"modified: ** {k}")
 201         else:
 202             print(f"modified: {k}")
 203
 204     # check which messages are still there but were marked for deprecation
 205     for k in new.keys():
 206         newversion = int(new[k]["version"])
 207         if newversion > 0 and is_deprecated(new[k]):
 208             if k in old:
 209                 if not is_deprecated(old[k]):
 210                     print(f"deprecated: {k}")
 211             else:
 212                 print(f"added+deprecated: {k}")
 213
 214     return backwards_incompatible
 215
 216
 217 def check_patchset():
 218     """Compare the changes to API messages in this changeset.
 219     Ignores API files with version < 1.0.0.
 220     Only considers API files located under the src directory in the repo.
 221     """
 222     files = filelist_from_patchset("^src/")
 223     revision = "HEAD~1"
 224
 225     oldcrcs = {}
 226     newcrcs = {}
 227     for filename in files:
 228         # Ignore files that have version < 1.0.0
 229         _ = crc_from_apigen(None, filename)
 230         # Ignore removed files
 231         if isinstance(_, set) == 0:
 232             if isinstance(_, set) == 0 and _["_version"]["major"] == "0":
 233                 continue
 234             newcrcs.update(_)
 235
 236         oldcrcs.update(crc_from_apigen(revision, filename))
 237
 238     backwards_incompatible = report(newcrcs, oldcrcs)
 239     if backwards_incompatible:
 240         # alert on changing production API
 241         print(
 242             "crcchecker: Changing production APIs in an incompatible way",
 243             file=sys.stderr,
 244         )
 245         sys.exit(-1)
 246     else:
 247         print("*" * 67)
 248         print("* VPP CHECKAPI SUCCESSFULLY COMPLETED")
 249         print("*" * 67)
 250
 251
 252 def main():
 253     """Main entry point."""
 254     parser = argparse.ArgumentParser(description="VPP CRC checker.")
 255     parser.add_argument("--git-revision", help="Git revision to compare against")
 256     parser.add_argument(
 257         "--dump-manifest", action="store_true", help="Dump CRC for all messages"
 258     )
 259     parser.add_argument(
 260         "--check-patchset",
 261         action="store_true",
 262         help="Check patchset for backwards incompatbile changes",
 263     )
 264     parser.add_argument("files", nargs="*")
 265     parser.add_argument("--diff", help="Files to compare (on filesystem)", nargs=2)
 266
 267     args = parser.parse_args()
 268
 269     if args.diff and args.files:
 270         parser.print_help()
 271         sys.exit(-1)
 272
 273     # Diff two files
 274     if args.diff:
 275         oldcrcs = crc_from_apigen(None, args.diff[0])
 276         newcrcs = crc_from_apigen(None, args.diff[1])
 277         backwards_incompatible = report(newcrcs, oldcrcs)
 278         sys.exit(0)
 279
 280     # Dump CRC for messages in given files / revision
 281     if args.dump_manifest:
 282         files = args.files if args.files else filelist_from_git_ls()
 283         crcs = {}
 284         for filename in files:
 285             crcs.update(crc_from_apigen(args.git_revision, filename))
 286         for k, value in crcs.items():
 287             print(f"{k}: {value}")
 288         sys.exit(0)
 289
 290     # Find changes between current patchset and given revision (previous)
 291     if args.check_patchset:
 292         if args.git_revision:
 293             print("Argument git-revision ignored", file=sys.stderr)
 294         # Check there are no uncomitted changes
 295         if is_uncommitted_changes():
 296             print("Please stash or commit changes in workspace", file=sys.stderr)
 297             sys.exit(-1)
 298         check_patchset()
 299         sys.exit(0)
 300
 301     # Find changes between current workspace and revision
 302     # Find changes between a given file and a revision
 303     files = args.files if args.files else filelist_from_git_ls()
 304
 305     revision = args.git_revision if args.git_revision else "HEAD~1"
 306
 307     oldcrcs = {}
 308     newcrcs = {}
 309     for file in files:
 310         newcrcs.update(crc_from_apigen(None, file))
 311         oldcrcs.update(crc_from_apigen(revision, file))
 312
 313     backwards_incompatible = report(newcrcs, oldcrcs)
 314
 315     if args.check_patchset:
 316         if backwards_incompatible:
 317             # alert on changing production API
 318             print(
 319                 "crcchecker: Changing production APIs in an incompatible way",
 320                 file=sys.stderr,
 321             )
 322             sys.exit(-1)
 323         else:
 324             print("*" * 67)
 325             print("* VPP CHECKAPI SUCCESSFULLY COMPLETED")
 326             print("*" * 67)
 327
 328
 329 if __name__ == "__main__":
 330     main()