commit 04833700a5fc19bf853c3cdd31a46bedc944f7eb
author George Burgess IV <gbiv@google.com> Tue Aug 09 22:00:38 2022 -0700
committer Chromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com> Sat Aug 13 09:09:37 2022 +0000
tree 4945a96ba1deb1f38756e18cd0bd1417fe7aa04e
parent 635f726ae9e21d22cc316998c0d1173a68b39a62

vendor.py: write a license shorthand file

This has us write a simple file that describes the licenses used by
`vendor/`. This file is intended to be used by ebuilds so we can
automatically verify that ebuilds are updated appropriately.

BUG=b:240953811
TEST=./vendor.py

Change-Id: I135dc18f7c384a3d66165d1a5c04ae0bd355080f
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/third_party/rust_crates/+/3822124
Commit-Queue: George Burgess <gbiv@chromium.org>
Tested-by: George Burgess <gbiv@chromium.org>
Reviewed-by: Abhishek Pandit-Subedi <abhishekpandit@google.com>

vendor.py

diff --git a/vendor.py b/vendor.py
index 051f998..b3b327d 100755
--- a/vendor.py
+++ b/vendor.py
@@ -14,6 +14,7 @@
 import re
 import shutil
 import subprocess
+import textwrap
 import toml
 
 # We only care about crates we're actually going to use and that's usually
@@ -324,7 +325,8 @@
 
         return ''
 
-    def generate_license(self, skip_license_check, print_map_to_file):
+    def generate_license(self, skip_license_check, print_map_to_file,
+                         license_shorthand_file):
         """Generate single massive license file from metadata."""
         metadata = load_metadata(self.working_dir)
 
@@ -460,8 +462,17 @@
                 "Unhandled missing license file. "
                 "Make sure all are accounted for before continuing.")
 
-        print("Add the following licenses to the ebuild: \n",
-              sorted([x for x in has_license_types]))
+        sorted_licenses = sorted(has_license_types)
+        print("Add the following licenses to the ebuild:\n",
+              sorted_licenses)
+        header = textwrap.dedent("""\
+            # File to describe the licenses used by this registry.
+            # Used to it's easy to automatically verify ebuilds are updated.
+            # Each line is a license. Lines starting with # are comments.
+            """)
+        with open(license_shorthand_file, 'w', encoding='utf-8') as f:
+            f.write(header)
+            f.write('\n'.join(sorted_licenses))
 
 
 # TODO(abps) - This needs to be replaced with datalog later. We should compile
@@ -607,6 +618,7 @@
     patches = os.path.join(current_path, "patches")
     vendor = os.path.join(current_path, "vendor")
     crab_dir = os.path.join(current_path, "crab", "crates")
+    license_shorthand_file = os.path.join(current_path, "licenses_used.txt")
 
     # First, actually run cargo vendor
     run_cargo_vendor(current_path)
@@ -623,7 +635,8 @@
 
     # Combine license file and check for any bad licenses
     lm = LicenseManager(current_path, vendor)
-    lm.generate_license(args.skip_license_check, args.license_map)
+    lm.generate_license(args.skip_license_check, args.license_map,
+                        license_shorthand_file)
 
     # Run crab audit on all packages
     crab = CrabManager(current_path, crab_dir)