Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 1 | #!/usr/bin/env python3 |
| 2 | # -*- coding: utf-8 -*- |
George Burgess IV | 9e0cfde | 2022-09-27 15:08:15 -0700 | [diff] [blame] | 3 | # Copyright 2021 The ChromiumOS Authors |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 4 | # Use of this source code is governed by a BSD-style license that can be |
| 5 | # found in the LICENSE file. |
| 6 | """ This script cleans up the vendor directory. |
| 7 | """ |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 8 | import argparse |
George Burgess IV | 635f726 | 2022-08-09 21:32:20 -0700 | [diff] [blame] | 9 | import collections |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 10 | import hashlib |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 11 | import json |
| 12 | import os |
| 13 | import pathlib |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 14 | import re |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 15 | import shutil |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 16 | import subprocess |
George Burgess IV | 0483370 | 2022-08-09 22:00:38 -0700 | [diff] [blame] | 17 | import textwrap |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 18 | import toml |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 19 | |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 20 | # We only care about crates we're actually going to use and that's usually |
| 21 | # limited to ones with cfg(linux). For running `cargo metadata`, limit results |
| 22 | # to only this platform |
| 23 | DEFAULT_PLATFORM_FILTER = "x86_64-unknown-linux-gnu" |
| 24 | |
George Burgess IV | 8e2cc04 | 2022-10-18 14:50:48 -0600 | [diff] [blame] | 25 | # A series of crates which are to be made empty by having no (non-comment) |
| 26 | # contents in their `lib.rs`, rather than by inserting a compilation error. |
| 27 | NOP_EMPTY_CRATES = frozenset({"windows"}) |
| 28 | |
| 29 | EMPTY_CRATE_BODY = """\ |
| 30 | compile_error!("This crate cannot be built for this configuration."); |
| 31 | """ |
| 32 | NOP_EMPTY_CRATE_BODY = "// " + EMPTY_CRATE_BODY |
| 33 | |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 34 | |
| 35 | def _rerun_checksums(package_path): |
| 36 | """Re-run checksums for given package. |
| 37 | |
| 38 | Writes resulting checksums to $package_path/.cargo-checksum.json. |
| 39 | """ |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 40 | hashes = dict() |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 41 | checksum_path = os.path.join(package_path, ".cargo-checksum.json") |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 42 | if not pathlib.Path(checksum_path).is_file(): |
| 43 | return False |
| 44 | |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 45 | with open(checksum_path, "r") as fread: |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 46 | contents = json.load(fread) |
| 47 | |
| 48 | for root, _, files in os.walk(package_path, topdown=True): |
| 49 | for f in files: |
| 50 | # Don't checksum an existing checksum file |
| 51 | if f == ".cargo-checksum.json": |
| 52 | continue |
| 53 | |
| 54 | file_path = os.path.join(root, f) |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 55 | with open(file_path, "rb") as frb: |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 56 | m = hashlib.sha256() |
| 57 | m.update(frb.read()) |
| 58 | d = m.hexdigest() |
| 59 | |
| 60 | # Key is relative to the package path so strip from beginning |
| 61 | key = os.path.relpath(file_path, package_path) |
| 62 | hashes[key] = d |
| 63 | |
| 64 | if hashes: |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 65 | print( |
| 66 | "{} regenerated {} hashes".format(package_path, len(hashes.keys())) |
| 67 | ) |
| 68 | contents["files"] = hashes |
| 69 | with open(checksum_path, "w") as fwrite: |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 70 | json.dump(contents, fwrite, sort_keys=True) |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 71 | |
| 72 | return True |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 73 | |
| 74 | |
| 75 | def _remove_OWNERS_checksum(root): |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 76 | """Delete all OWNERS files from the checksum file. |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 77 | |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 78 | Args: |
| 79 | root: Root directory for the vendored crate. |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 80 | |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 81 | Returns: |
| 82 | True if OWNERS was found and cleaned up. Otherwise False. |
| 83 | """ |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 84 | checksum_path = os.path.join(root, ".cargo-checksum.json") |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 85 | if not pathlib.Path(checksum_path).is_file(): |
| 86 | return False |
| 87 | |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 88 | with open(checksum_path, "r") as fread: |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 89 | contents = json.load(fread) |
| 90 | |
| 91 | del_keys = [] |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 92 | for cfile in contents["files"]: |
| 93 | if "OWNERS" in cfile: |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 94 | del_keys.append(cfile) |
| 95 | |
| 96 | for key in del_keys: |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 97 | del contents["files"][key] |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 98 | |
| 99 | if del_keys: |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 100 | print("{} deleted: {}".format(root, del_keys)) |
| 101 | with open(checksum_path, "w") as fwrite: |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 102 | json.dump(contents, fwrite, sort_keys=True) |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 103 | |
| 104 | return bool(del_keys) |
| 105 | |
| 106 | |
| 107 | def cleanup_owners(vendor_path): |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 108 | """Remove owners checksums from the vendor directory. |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 109 | |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 110 | We currently do not check in the OWNERS files from vendored crates because |
| 111 | they interfere with the find-owners functionality in gerrit. This cleanup |
| 112 | simply finds all instances of "OWNERS" in the checksum files within and |
| 113 | removes them. |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 114 | |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 115 | Args: |
| 116 | vendor_path: Absolute path to vendor directory. |
| 117 | """ |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 118 | deps_cleaned = [] |
| 119 | for root, dirs, _ in os.walk(vendor_path): |
| 120 | for d in dirs: |
| 121 | removed = _remove_OWNERS_checksum(os.path.join(root, d)) |
| 122 | if removed: |
| 123 | deps_cleaned.append(d) |
| 124 | |
| 125 | if deps_cleaned: |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 126 | print("Cleanup owners:\n {}".format("\n".join(deps_cleaned))) |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 127 | |
| 128 | |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 129 | def apply_single_patch(patch, workdir): |
| 130 | """Apply a single patch and return whether it was successful. |
| 131 | |
| 132 | Returns: |
| 133 | True if successful. False otherwise. |
| 134 | """ |
George Burgess IV | 08664ba | 2022-10-03 11:09:33 -0700 | [diff] [blame] | 135 | proc = subprocess.run( |
| 136 | [ |
| 137 | "patch", |
| 138 | "-p1", |
| 139 | "--no-backup-if-mismatch", |
| 140 | "-i", |
| 141 | patch, |
| 142 | ], |
| 143 | cwd=workdir, |
| 144 | ) |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 145 | return proc.returncode == 0 |
| 146 | |
| 147 | |
George Burgess IV | 30c5c36 | 2022-08-19 17:05:02 -0700 | [diff] [blame] | 148 | def apply_patch_script(script, workdir): |
| 149 | """Run the given patch script, returning whether it exited cleanly. |
| 150 | |
| 151 | Returns: |
| 152 | True if successful. False otherwise. |
| 153 | """ |
| 154 | return subprocess.run([script], cwd=workdir).returncode == 0 |
| 155 | |
| 156 | |
George Burgess IV | 635f726 | 2022-08-09 21:32:20 -0700 | [diff] [blame] | 157 | def determine_vendor_crates(vendor_path): |
| 158 | """Returns a map of {crate_name: [directory]} at the given vendor_path.""" |
| 159 | result = collections.defaultdict(list) |
| 160 | for crate_name_plus_ver in os.listdir(vendor_path): |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 161 | name, _ = crate_name_plus_ver.rsplit("-", 1) |
George Burgess IV | 40cc91c | 2022-08-15 13:07:40 -0700 | [diff] [blame] | 162 | result[name].append(crate_name_plus_ver) |
George Burgess IV | 635f726 | 2022-08-09 21:32:20 -0700 | [diff] [blame] | 163 | |
| 164 | for crate_list in result.values(): |
George Burgess IV | 40cc91c | 2022-08-15 13:07:40 -0700 | [diff] [blame] | 165 | crate_list.sort() |
George Burgess IV | 635f726 | 2022-08-09 21:32:20 -0700 | [diff] [blame] | 166 | return result |
| 167 | |
| 168 | |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 169 | def apply_patches(patches_path, vendor_path): |
| 170 | """Finds patches and applies them to sub-folders in the vendored crates. |
| 171 | |
| 172 | Args: |
| 173 | patches_path: Path to folder with patches. Expect all patches to be one |
| 174 | level down (matching the crate name). |
| 175 | vendor_path: Root path to vendored crates directory. |
| 176 | """ |
| 177 | checksums_for = {} |
| 178 | |
| 179 | # Don't bother running if patches directory is empty |
| 180 | if not pathlib.Path(patches_path).is_dir(): |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 181 | return |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 182 | |
George Burgess IV | 30c5c36 | 2022-08-19 17:05:02 -0700 | [diff] [blame] | 183 | patches_failed = False |
George Burgess IV | 635f726 | 2022-08-09 21:32:20 -0700 | [diff] [blame] | 184 | vendor_crate_map = determine_vendor_crates(vendor_path) |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 185 | # Look for all patches and apply them |
| 186 | for d in os.listdir(patches_path): |
| 187 | dir_path = os.path.join(patches_path, d) |
| 188 | |
| 189 | # We don't process patches in root dir |
| 190 | if not os.path.isdir(dir_path): |
| 191 | continue |
| 192 | |
George Burgess IV | 30c5c36 | 2022-08-19 17:05:02 -0700 | [diff] [blame] | 193 | # We accept one of two forms here: |
| 194 | # - direct targets (these name # `${crate_name}-${version}`) |
| 195 | # - simply the crate name (which applies to all versions of the |
| 196 | # crate) |
| 197 | direct_target = os.path.join(vendor_path, d) |
| 198 | if os.path.isdir(direct_target): |
| 199 | patch_targets = [d] |
| 200 | elif d in vendor_crate_map: |
| 201 | patch_targets = vendor_crate_map[d] |
| 202 | else: |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 203 | raise RuntimeError(f"Unknown crate in {vendor_path}: {d}") |
George Burgess IV | 30c5c36 | 2022-08-19 17:05:02 -0700 | [diff] [blame] | 204 | |
George Burgess IV | 635f726 | 2022-08-09 21:32:20 -0700 | [diff] [blame] | 205 | for patch in os.listdir(dir_path): |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 206 | file_path = os.path.join(dir_path, patch) |
| 207 | |
| 208 | # Skip if not a patch file |
George Burgess IV | 30c5c36 | 2022-08-19 17:05:02 -0700 | [diff] [blame] | 209 | if not os.path.isfile(file_path): |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 210 | continue |
| 211 | |
George Burgess IV | 30c5c36 | 2022-08-19 17:05:02 -0700 | [diff] [blame] | 212 | if patch.endswith(".patch"): |
| 213 | apply = apply_single_patch |
| 214 | elif os.access(file_path, os.X_OK): |
| 215 | apply = apply_patch_script |
George Burgess IV | 635f726 | 2022-08-09 21:32:20 -0700 | [diff] [blame] | 216 | else: |
George Burgess IV | 30c5c36 | 2022-08-19 17:05:02 -0700 | [diff] [blame] | 217 | # Unrecognized. Skip it. |
| 218 | continue |
| 219 | |
| 220 | for target_name in patch_targets: |
| 221 | checksums_for[target_name] = True |
| 222 | target = os.path.join(vendor_path, target_name) |
| 223 | print(f"-- Applying {file_path} to {target}") |
| 224 | if not apply(file_path, target): |
| 225 | print(f"Failed to apply {file_path} to {target}") |
| 226 | patches_failed = True |
| 227 | |
| 228 | # Do this late, so we can report all of the failing patches in one |
| 229 | # invocation. |
| 230 | if patches_failed: |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 231 | raise ValueError("Patches failed; please see above logs") |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 232 | |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 233 | # Re-run checksums for all modified packages since we applied patches. |
| 234 | for key in checksums_for.keys(): |
| 235 | _rerun_checksums(os.path.join(vendor_path, key)) |
| 236 | |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 237 | |
George Burgess IV | 18af563 | 2022-08-30 14:10:53 -0700 | [diff] [blame] | 238 | def get_workspace_cargo_toml(working_dir): |
George Burgess IV | 40cc91c | 2022-08-15 13:07:40 -0700 | [diff] [blame] | 239 | """Returns all Cargo.toml files under working_dir.""" |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 240 | return [working_dir / "projects" / "Cargo.toml"] |
George Burgess IV | 40cc91c | 2022-08-15 13:07:40 -0700 | [diff] [blame] | 241 | |
| 242 | |
Abhishek Pandit-Subedi | fa90238 | 2021-08-20 11:04:33 -0700 | [diff] [blame] | 243 | def run_cargo_vendor(working_dir): |
| 244 | """Runs cargo vendor. |
| 245 | |
| 246 | Args: |
| 247 | working_dir: Directory to run inside. This should be the directory where |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 248 | Cargo.toml is kept. |
Abhishek Pandit-Subedi | fa90238 | 2021-08-20 11:04:33 -0700 | [diff] [blame] | 249 | """ |
George Burgess IV | 635f726 | 2022-08-09 21:32:20 -0700 | [diff] [blame] | 250 | # Cargo will refuse to revendor into versioned directories, which leads to |
| 251 | # repeated `./vendor.py` invocations trying to apply patches to |
| 252 | # already-patched sources. Remove the existing vendor directory to avoid |
| 253 | # this. |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 254 | vendor_dir = working_dir / "vendor" |
George Burgess IV | 635f726 | 2022-08-09 21:32:20 -0700 | [diff] [blame] | 255 | if vendor_dir.exists(): |
George Burgess IV | 40cc91c | 2022-08-15 13:07:40 -0700 | [diff] [blame] | 256 | shutil.rmtree(vendor_dir) |
| 257 | |
George Burgess IV | 18af563 | 2022-08-30 14:10:53 -0700 | [diff] [blame] | 258 | cargo_cmdline = [ |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 259 | "cargo", |
| 260 | "vendor", |
| 261 | "--versioned-dirs", |
| 262 | "-v", |
| 263 | "--manifest-path=projects/Cargo.toml", |
| 264 | "--", |
| 265 | "vendor", |
George Burgess IV | 18af563 | 2022-08-30 14:10:53 -0700 | [diff] [blame] | 266 | ] |
George Burgess IV | 40cc91c | 2022-08-15 13:07:40 -0700 | [diff] [blame] | 267 | subprocess.check_call(cargo_cmdline, cwd=working_dir) |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 268 | |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 269 | |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 270 | def load_metadata(working_dir, filter_platform=DEFAULT_PLATFORM_FILTER): |
George Burgess IV | 40cc91c | 2022-08-15 13:07:40 -0700 | [diff] [blame] | 271 | """Load metadata for all projects under a given directory. |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 272 | |
| 273 | Args: |
George Burgess IV | 40cc91c | 2022-08-15 13:07:40 -0700 | [diff] [blame] | 274 | working_dir: Base directory to run from. |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 275 | filter_platform: Filter packages to ones configured for this platform. |
| 276 | """ |
George Burgess IV | 40cc91c | 2022-08-15 13:07:40 -0700 | [diff] [blame] | 277 | metadata_objects = [] |
George Burgess IV | 18af563 | 2022-08-30 14:10:53 -0700 | [diff] [blame] | 278 | cmd = [ |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 279 | "cargo", |
| 280 | "metadata", |
| 281 | "--format-version=1", |
| 282 | "--manifest-path=projects/Cargo.toml", |
George Burgess IV | 18af563 | 2022-08-30 14:10:53 -0700 | [diff] [blame] | 283 | ] |
| 284 | # Conditionally add platform filter |
| 285 | if filter_platform: |
| 286 | cmd += ("--filter-platform", filter_platform) |
| 287 | output = subprocess.check_output(cmd, cwd=working_dir) |
| 288 | return json.loads(output) |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 289 | |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 290 | |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 291 | class LicenseManager: |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 292 | """Manage consolidating licenses for all packages.""" |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 293 | |
George Burgess IV | 124e6a1 | 2022-09-09 10:44:29 -0700 | [diff] [blame] | 294 | # These are all the licenses we support. Keys are what is seen in metadata |
| 295 | # and values are what is expected by ebuilds. |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 296 | SUPPORTED_LICENSES = { |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 297 | "0BSD": "0BSD", |
| 298 | "Apache-2.0": "Apache-2.0", |
| 299 | "BSD-3-Clause": "BSD-3", |
| 300 | "ISC": "ISC", |
| 301 | "MIT": "MIT", |
| 302 | "MPL-2.0": "MPL-2.0", |
| 303 | "unicode": "unicode", |
Dan Callaghan | 91f8054 | 2022-09-09 10:57:23 +1000 | [diff] [blame] | 304 | "Zlib": "ZLIB", |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 305 | } |
| 306 | |
| 307 | # Prefer to take attribution licenses in this order. All these require that |
| 308 | # we actually use the license file found in the package so they MUST have |
| 309 | # a license file set. |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 310 | PREFERRED_ATTRIB_LICENSE_ORDER = ["MIT", "BSD-3", "ISC"] |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 311 | |
| 312 | # If Apache license is found, always prefer it (simplifies attribution) |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 313 | APACHE_LICENSE = "Apache-2.0" |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 314 | |
| 315 | # Regex for license files found in the vendored directories. Search for |
| 316 | # these files with re.IGNORECASE. |
| 317 | # |
| 318 | # These will be searched in order with the earlier entries being preferred. |
| 319 | LICENSE_NAMES_REGEX = [ |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 320 | r"^license-mit$", |
| 321 | r"^copyright$", |
| 322 | r"^licen[cs]e.*$", |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 323 | ] |
| 324 | |
| 325 | # Some crates have their license file in other crates. This usually occurs |
| 326 | # because multiple crates are published from the same git repository and the |
| 327 | # license isn't updated in each sub-crate. In these cases, we can just |
| 328 | # ignore these packages. |
| 329 | MAP_LICENSE_TO_OTHER = { |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 330 | "failure_derive": "failure", |
| 331 | "grpcio-compiler": "grpcio", |
| 332 | "grpcio-sys": "grpcio", |
| 333 | "rustyline-derive": "rustyline", |
Nicholas Bishop | 7d4433a | 2022-10-07 12:38:26 -0400 | [diff] [blame] | 334 | "uefi-macros": "uefi", |
| 335 | "uefi-services": "uefi", |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 336 | } |
| 337 | |
| 338 | # Map a package to a specific license and license file. Only use this if |
| 339 | # a package doesn't have an easily discoverable license or exports its |
| 340 | # license in a weird way. Prefer to patch the project with a license and |
| 341 | # upstream the patch instead. |
| 342 | STATIC_LICENSE_MAP = { |
| 343 | # "package name": ( "license name", "license file relative location") |
George Burgess IV | 2664287 | 2022-10-18 19:46:58 -0600 | [diff] [blame^] | 344 | # Patch for adding these are upstream, but the patch application |
| 345 | # doesn't apply to `cargo metadata`. This is presumably because it |
| 346 | # can't detect our vendor directory. |
George Burgess IV | f4a5e36 | 2022-08-30 14:30:36 -0700 | [diff] [blame] | 347 | # https://gitlab.freedesktop.org/slirp/libslirp-sys/-/merge_requests/6 |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 348 | "libslirp-sys": ("MIT", "LICENSE"), |
George Burgess IV | 2664287 | 2022-10-18 19:46:58 -0600 | [diff] [blame^] | 349 | # https://gitlab.freedesktop.org/anholt/deqp-runner/-/merge_requests/48 |
| 350 | "deqp-runner": ("MIT", "LICENSE"), |
Dan Callaghan | 91f8054 | 2022-09-09 10:57:23 +1000 | [diff] [blame] | 351 | # Upstream prefers to embed license text inside README.md: |
| 352 | "riscv": ("ISC", "README.md"), |
| 353 | "riscv-rt": ("ISC", "README.md"), |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 354 | } |
| 355 | |
| 356 | def __init__(self, working_dir, vendor_dir): |
| 357 | self.working_dir = working_dir |
| 358 | self.vendor_dir = vendor_dir |
| 359 | |
| 360 | def _find_license_in_dir(self, search_dir): |
| 361 | for p in os.listdir(search_dir): |
| 362 | # Ignore anything that's not a file |
| 363 | if not os.path.isfile(os.path.join(search_dir, p)): |
| 364 | continue |
| 365 | |
| 366 | # Now check if the name matches any of the regexes |
| 367 | # We'll return the first matching file. |
| 368 | for regex in self.LICENSE_NAMES_REGEX: |
| 369 | if re.search(regex, p, re.IGNORECASE): |
| 370 | yield os.path.join(search_dir, p) |
| 371 | break |
| 372 | |
| 373 | def _guess_license_type(self, license_file): |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 374 | if "-MIT" in license_file: |
| 375 | return "MIT" |
| 376 | elif "-APACHE" in license_file: |
| 377 | return "APACHE" |
| 378 | elif "-BSD" in license_file: |
| 379 | return "BSD-3" |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 380 | |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 381 | with open(license_file, "r") as f: |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 382 | lines = f.read() |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 383 | if "MIT" in lines: |
| 384 | return "MIT" |
| 385 | elif "Apache" in lines: |
| 386 | return "APACHE" |
| 387 | elif "BSD 3-Clause" in lines: |
| 388 | return "BSD-3" |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 389 | |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 390 | return "" |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 391 | |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 392 | def generate_license( |
| 393 | self, skip_license_check, print_map_to_file, license_shorthand_file |
| 394 | ): |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 395 | """Generate single massive license file from metadata.""" |
George Burgess IV | 18af563 | 2022-08-30 14:10:53 -0700 | [diff] [blame] | 396 | metadata = load_metadata(self.working_dir) |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 397 | |
| 398 | has_license_types = set() |
| 399 | bad_licenses = {} |
| 400 | |
| 401 | # Keep license map ordered so it generates a consistent license map |
| 402 | license_map = {} |
| 403 | |
| 404 | skip_license_check = skip_license_check or [] |
George Burgess IV | 4ae4206 | 2022-08-15 18:54:51 -0700 | [diff] [blame] | 405 | has_unicode_license = False |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 406 | |
George Burgess IV | 18af563 | 2022-08-30 14:10:53 -0700 | [diff] [blame] | 407 | for package in metadata["packages"]: |
George Burgess IV | 40cc91c | 2022-08-15 13:07:40 -0700 | [diff] [blame] | 408 | # Skip the synthesized Cargo.toml packages that exist solely to |
| 409 | # list dependencies. |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 410 | if "path+file:///" in package["id"]: |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 411 | continue |
| 412 | |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 413 | pkg_name = package["name"] |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 414 | if pkg_name in skip_license_check: |
| 415 | print( |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 416 | "Skipped license check on {}. Reason: Skipped from command line".format( |
| 417 | pkg_name |
| 418 | ) |
| 419 | ) |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 420 | continue |
| 421 | |
| 422 | if pkg_name in self.MAP_LICENSE_TO_OTHER: |
| 423 | print( |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 424 | "Skipped license check on {}. Reason: License already in {}".format( |
| 425 | pkg_name, self.MAP_LICENSE_TO_OTHER[pkg_name] |
| 426 | ) |
| 427 | ) |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 428 | continue |
| 429 | |
| 430 | # Check if we have a static license map for this package. Use the |
| 431 | # static values if we have it already set. |
| 432 | if pkg_name in self.STATIC_LICENSE_MAP: |
| 433 | (license, license_file) = self.STATIC_LICENSE_MAP[pkg_name] |
| 434 | license_map[pkg_name] = { |
| 435 | "license": license, |
| 436 | "license_file": license_file, |
| 437 | } |
| 438 | continue |
| 439 | |
| 440 | license_files = [] |
George Burgess IV | 93ba473 | 2022-08-13 14:10:10 -0700 | [diff] [blame] | 441 | # use `or ''` instead of get's default, since `package` may have a |
| 442 | # None value for 'license'. |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 443 | license = package.get("license") or "" |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 444 | |
| 445 | # We ignore the metadata for license file because most crates don't |
| 446 | # have it set. Just scan the source for licenses. |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 447 | pkg_version = package["version"] |
| 448 | license_files = list( |
| 449 | self._find_license_in_dir( |
| 450 | os.path.join(self.vendor_dir, f"{pkg_name}-{pkg_version}") |
| 451 | ) |
| 452 | ) |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 453 | |
George Burgess IV | 4ae4206 | 2022-08-15 18:54:51 -0700 | [diff] [blame] | 454 | # FIXME(b/240953811): The code later in this loop is only |
| 455 | # structured to handle ORs, not ANDs. Fortunately, this license in |
| 456 | # particular is `AND`ed between a super common license (Apache) and |
| 457 | # a more obscure one (unicode). This hack is specifically intended |
| 458 | # for the `unicode-ident` crate, though no crate name check is |
| 459 | # made, since it's OK other crates happen to have this license. |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 460 | if license == "(MIT OR Apache-2.0) AND Unicode-DFS-2016": |
George Burgess IV | 4ae4206 | 2022-08-15 18:54:51 -0700 | [diff] [blame] | 461 | has_unicode_license = True |
| 462 | # We'll check later to be sure MIT or Apache-2.0 is represented |
| 463 | # properly. |
| 464 | for x in license_files: |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 465 | if os.path.basename(x) == "LICENSE-UNICODE": |
George Burgess IV | 4ae4206 | 2022-08-15 18:54:51 -0700 | [diff] [blame] | 466 | license_file = x |
| 467 | break |
| 468 | else: |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 469 | raise ValueError( |
| 470 | "No LICENSE-UNICODE found in " f"{license_files}" |
| 471 | ) |
George Burgess IV | 4ae4206 | 2022-08-15 18:54:51 -0700 | [diff] [blame] | 472 | license_map[pkg_name] = { |
| 473 | "license": license, |
| 474 | "license_file": license_file, |
| 475 | } |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 476 | has_license_types.add("unicode") |
George Burgess IV | 4ae4206 | 2022-08-15 18:54:51 -0700 | [diff] [blame] | 477 | continue |
| 478 | |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 479 | # If there are multiple licenses, they are delimited with "OR" or "/" |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 480 | delim = " OR " if " OR " in license else "/" |
George Burgess IV | 40cc91c | 2022-08-15 13:07:40 -0700 | [diff] [blame] | 481 | found = [x.strip() for x in license.split(delim)] |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 482 | |
| 483 | # Filter licenses to ones we support |
| 484 | licenses_or = [ |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 485 | self.SUPPORTED_LICENSES[f] |
| 486 | for f in found |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 487 | if f in self.SUPPORTED_LICENSES |
| 488 | ] |
| 489 | |
| 490 | # If apache license is found, always prefer it because it simplifies |
| 491 | # license attribution (we can use existing Apache notice) |
| 492 | if self.APACHE_LICENSE in licenses_or: |
| 493 | has_license_types.add(self.APACHE_LICENSE) |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 494 | license_map[pkg_name] = {"license": self.APACHE_LICENSE} |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 495 | |
| 496 | # Handle single license that has at least one license file |
| 497 | # We pick the first license file and the license |
| 498 | elif len(licenses_or) == 1: |
| 499 | if license_files: |
| 500 | l = licenses_or[0] |
| 501 | lf = license_files[0] |
| 502 | |
| 503 | has_license_types.add(l) |
| 504 | license_map[pkg_name] = { |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 505 | "license": l, |
| 506 | "license_file": os.path.relpath(lf, self.working_dir), |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 507 | } |
| 508 | else: |
| 509 | bad_licenses[pkg_name] = "{} missing license file".format( |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 510 | licenses_or[0] |
| 511 | ) |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 512 | # Handle multiple licenses |
| 513 | elif len(licenses_or) > 1: |
| 514 | # Check preferred licenses in order |
| 515 | license_found = False |
| 516 | for l in self.PREFERRED_ATTRIB_LICENSE_ORDER: |
| 517 | if not l in licenses_or: |
| 518 | continue |
| 519 | |
| 520 | for f in license_files: |
| 521 | if self._guess_license_type(f) == l: |
| 522 | license_found = True |
| 523 | has_license_types.add(l) |
| 524 | license_map[pkg_name] = { |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 525 | "license": l, |
| 526 | "license_file": os.path.relpath( |
| 527 | f, self.working_dir |
| 528 | ), |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 529 | } |
| 530 | break |
| 531 | |
| 532 | # Break out of loop if license is found |
| 533 | if license_found: |
| 534 | break |
| 535 | else: |
| 536 | bad_licenses[pkg_name] = license |
| 537 | |
| 538 | # If we had any bad licenses, we need to abort |
| 539 | if bad_licenses: |
| 540 | for k in bad_licenses.keys(): |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 541 | print( |
| 542 | "{} had no acceptable licenses: {}".format( |
| 543 | k, bad_licenses[k] |
| 544 | ) |
| 545 | ) |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 546 | raise Exception("Bad licenses in vendored packages.") |
| 547 | |
| 548 | # Write license map to file |
| 549 | if print_map_to_file: |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 550 | with open( |
| 551 | os.path.join(self.working_dir, print_map_to_file), "w" |
| 552 | ) as lfile: |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 553 | json.dump(license_map, lfile, sort_keys=True) |
| 554 | |
| 555 | # Raise missing licenses unless we have a valid reason to ignore them |
| 556 | raise_missing_license = False |
| 557 | for name, v in license_map.items(): |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 558 | if ( |
| 559 | "license_file" not in v |
| 560 | and v.get("license", "") != self.APACHE_LICENSE |
| 561 | ): |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 562 | raise_missing_license = True |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 563 | print( |
| 564 | " {}: Missing license file. Fix or add to ignorelist.".format( |
| 565 | name |
| 566 | ) |
| 567 | ) |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 568 | |
| 569 | if raise_missing_license: |
| 570 | raise Exception( |
| 571 | "Unhandled missing license file. " |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 572 | "Make sure all are accounted for before continuing." |
| 573 | ) |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 574 | |
George Burgess IV | 4ae4206 | 2022-08-15 18:54:51 -0700 | [diff] [blame] | 575 | if has_unicode_license: |
| 576 | if self.APACHE_LICENSE not in has_license_types: |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 577 | raise ValueError( |
| 578 | "Need the apache license; currently have: " |
| 579 | f"{sorted(has_license_types)}" |
| 580 | ) |
George Burgess IV | 4ae4206 | 2022-08-15 18:54:51 -0700 | [diff] [blame] | 581 | |
George Burgess IV | 0483370 | 2022-08-09 22:00:38 -0700 | [diff] [blame] | 582 | sorted_licenses = sorted(has_license_types) |
George Burgess IV | 124e6a1 | 2022-09-09 10:44:29 -0700 | [diff] [blame] | 583 | print("The following licenses are in use:", sorted_licenses) |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 584 | header = textwrap.dedent( |
| 585 | """\ |
George Burgess IV | 0483370 | 2022-08-09 22:00:38 -0700 | [diff] [blame] | 586 | # File to describe the licenses used by this registry. |
Daniel Verkamp | d9d085b | 2022-09-07 10:52:27 -0700 | [diff] [blame] | 587 | # Used so it's easy to automatically verify ebuilds are updated. |
George Burgess IV | 0483370 | 2022-08-09 22:00:38 -0700 | [diff] [blame] | 588 | # Each line is a license. Lines starting with # are comments. |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 589 | """ |
| 590 | ) |
| 591 | with open(license_shorthand_file, "w", encoding="utf-8") as f: |
George Burgess IV | 0483370 | 2022-08-09 22:00:38 -0700 | [diff] [blame] | 592 | f.write(header) |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 593 | f.write("\n".join(sorted_licenses)) |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 594 | |
| 595 | |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 596 | # TODO(abps) - This needs to be replaced with datalog later. We should compile |
| 597 | # all crab files into datalog and query it with our requirements |
| 598 | # instead. |
| 599 | class CrabManager: |
| 600 | """Manage audit files.""" |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 601 | |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 602 | def __init__(self, working_dir, crab_dir): |
| 603 | self.working_dir = working_dir |
| 604 | self.crab_dir = crab_dir |
| 605 | |
| 606 | def _check_bad_traits(self, crabdata): |
| 607 | """Checks that a package's crab audit meets our requirements. |
| 608 | |
| 609 | Args: |
| 610 | crabdata: Dict with crab keys in standard templated format. |
| 611 | """ |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 612 | common = crabdata["common"] |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 613 | # TODO(b/200578411) - Figure out what conditions we should enforce as |
| 614 | # part of the audit. |
| 615 | conditions = [ |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 616 | common.get("deny", None), |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 617 | ] |
| 618 | |
| 619 | # If any conditions are true, this crate is not acceptable. |
| 620 | return any(conditions) |
| 621 | |
| 622 | def verify_traits(self): |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 623 | """Verify that all required CRAB traits for this repository are met.""" |
George Burgess IV | 18af563 | 2022-08-30 14:10:53 -0700 | [diff] [blame] | 624 | metadata = load_metadata(self.working_dir) |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 625 | |
| 626 | failing_crates = {} |
| 627 | |
| 628 | # Verify all packages have a CRAB file associated with it and they meet |
| 629 | # all our required traits |
George Burgess IV | 18af563 | 2022-08-30 14:10:53 -0700 | [diff] [blame] | 630 | for package in metadata["packages"]: |
George Burgess IV | 40cc91c | 2022-08-15 13:07:40 -0700 | [diff] [blame] | 631 | # Skip the synthesized Cargo.toml packages that exist solely to |
| 632 | # list dependencies. |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 633 | if "path+file:///" in package["id"]: |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 634 | continue |
| 635 | |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 636 | crabname = "{}-{}".format(package["name"], package["version"]) |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 637 | filename = os.path.join(self.crab_dir, "{}.toml".format(crabname)) |
| 638 | |
| 639 | # If crab file doesn't exist, the crate fails |
| 640 | if not os.path.isfile(filename): |
| 641 | failing_crates[crabname] = "No crab file".format(filename) |
| 642 | continue |
| 643 | |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 644 | with open(filename, "r") as f: |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 645 | crabdata = toml.loads(f.read()) |
| 646 | |
| 647 | # If crab file's crate_name and version keys don't match this |
| 648 | # package, it also fails. This is just housekeeping... |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 649 | if ( |
| 650 | package["name"] != crabdata["crate_name"] |
| 651 | or package["version"] != crabdata["version"] |
| 652 | ): |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 653 | failing_crates[crabname] = "Crate name or version don't match" |
| 654 | continue |
| 655 | |
| 656 | if self._check_bad_traits(crabdata): |
| 657 | failing_crates[crabname] = "Failed bad traits check" |
| 658 | |
George Burgess IV | 9e0cfde | 2022-09-27 15:08:15 -0700 | [diff] [blame] | 659 | # If we had any failing crates, list them now, and exit with an error. |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 660 | if failing_crates: |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 661 | print("Failed CRAB audit:") |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 662 | for k, v in failing_crates.items(): |
George Burgess IV | 9e0cfde | 2022-09-27 15:08:15 -0700 | [diff] [blame] | 663 | print(f" {k}: {v}") |
| 664 | raise ValueError("CRAB audit did not complete successfully.") |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 665 | |
| 666 | |
George Burgess IV | d026147 | 2022-10-17 18:59:10 -0600 | [diff] [blame] | 667 | def clean_source_related_lines_in_place(cargo_toml): |
| 668 | """Removes all [[bin]] (and similar) sections in `cargo_toml`.""" |
| 669 | cargo_toml.pop("bench", None) |
| 670 | cargo_toml.pop("bin", None) |
| 671 | cargo_toml.pop("examples", None) |
| 672 | cargo_toml.pop("test", None) |
| 673 | |
| 674 | lib = cargo_toml.get("lib") |
| 675 | if lib: |
| 676 | lib.pop("path", None) |
| 677 | |
| 678 | package = cargo_toml.get("package") |
| 679 | if package: |
| 680 | package.pop("build", None) |
| 681 | package.pop("default-run", None) |
| 682 | package.pop("include", None) |
| 683 | |
| 684 | |
George Burgess IV | d4ff050 | 2022-08-14 23:27:57 -0700 | [diff] [blame] | 685 | def clean_features_in_place(cargo_toml): |
| 686 | """Removes all side-effects of features in `cargo_toml`.""" |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 687 | features = cargo_toml.get("features") |
George Burgess IV | d4ff050 | 2022-08-14 23:27:57 -0700 | [diff] [blame] | 688 | if not features: |
| 689 | return |
| 690 | |
George Burgess IV | d026147 | 2022-10-17 18:59:10 -0600 | [diff] [blame] | 691 | for name in features: |
| 692 | features[name] = [] |
George Burgess IV | d4ff050 | 2022-08-14 23:27:57 -0700 | [diff] [blame] | 693 | |
| 694 | |
George Burgess IV | d026147 | 2022-10-17 18:59:10 -0600 | [diff] [blame] | 695 | def remove_all_dependencies_in_place(cargo_toml): |
George Burgess IV | d4ff050 | 2022-08-14 23:27:57 -0700 | [diff] [blame] | 696 | """Removes all `target.*.dependencies` from `cargo_toml`.""" |
George Burgess IV | d026147 | 2022-10-17 18:59:10 -0600 | [diff] [blame] | 697 | cargo_toml.pop("build-dependencies", None) |
| 698 | cargo_toml.pop("dependencies", None) |
| 699 | cargo_toml.pop("dev-dependencies", None) |
| 700 | |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 701 | target = cargo_toml.get("target") |
George Burgess IV | d4ff050 | 2022-08-14 23:27:57 -0700 | [diff] [blame] | 702 | if not target: |
| 703 | return |
George Burgess IV | 0313d78 | 2022-08-15 23:45:44 -0700 | [diff] [blame] | 704 | |
George Burgess IV | d4ff050 | 2022-08-14 23:27:57 -0700 | [diff] [blame] | 705 | empty_keys = [] |
| 706 | for key, values in target.items(): |
George Burgess IV | d026147 | 2022-10-17 18:59:10 -0600 | [diff] [blame] | 707 | values.pop("build-dependencies", None) |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 708 | values.pop("dependencies", None) |
| 709 | values.pop("dev-dependencies", None) |
George Burgess IV | d4ff050 | 2022-08-14 23:27:57 -0700 | [diff] [blame] | 710 | if not values: |
| 711 | empty_keys.append(key) |
George Burgess IV | 0313d78 | 2022-08-15 23:45:44 -0700 | [diff] [blame] | 712 | |
George Burgess IV | d4ff050 | 2022-08-14 23:27:57 -0700 | [diff] [blame] | 713 | if len(empty_keys) == len(target): |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 714 | del cargo_toml["target"] |
George Burgess IV | d4ff050 | 2022-08-14 23:27:57 -0700 | [diff] [blame] | 715 | else: |
| 716 | for key in empty_keys: |
| 717 | del target[key] |
George Burgess IV | 0313d78 | 2022-08-15 23:45:44 -0700 | [diff] [blame] | 718 | |
| 719 | |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 720 | class CrateDestroyer: |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 721 | def __init__(self, working_dir, vendor_dir): |
| 722 | self.working_dir = working_dir |
| 723 | self.vendor_dir = vendor_dir |
| 724 | |
| 725 | def _modify_cargo_toml(self, pkg_path): |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 726 | with open(os.path.join(pkg_path, "Cargo.toml"), "r") as cargo: |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 727 | contents = toml.load(cargo) |
| 728 | |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 729 | package = contents["package"] |
George Burgess IV | d4ff050 | 2022-08-14 23:27:57 -0700 | [diff] [blame] | 730 | |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 731 | # Change description, license and delete license key |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 732 | package["description"] = "Empty crate that should not build." |
| 733 | package["license"] = "Apache-2.0" |
George Burgess IV | d4ff050 | 2022-08-14 23:27:57 -0700 | [diff] [blame] | 734 | |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 735 | package.pop("license_file", None) |
George Burgess IV | d4ff050 | 2022-08-14 23:27:57 -0700 | [diff] [blame] | 736 | # If there's no build.rs but we specify `links = "foo"`, Cargo gets |
| 737 | # upset. |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 738 | package.pop("links", None) |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 739 | |
George Burgess IV | 0313d78 | 2022-08-15 23:45:44 -0700 | [diff] [blame] | 740 | # Some packages have cfg-specific dependencies. Remove them here; we |
| 741 | # don't care about the dependencies of an empty package. |
| 742 | # |
| 743 | # This is a load-bearing optimization: `dev-python/toml` doesn't |
| 744 | # always round-trip dumps(loads(x)) correctly when `x` has keys with |
| 745 | # strings (b/242589711#comment3). The place this has bitten us so far |
| 746 | # is target dependencies, which can be harmlessly removed for now. |
George Burgess IV | d4ff050 | 2022-08-14 23:27:57 -0700 | [diff] [blame] | 747 | # |
| 748 | # Cleaning features in-place is also necessary, since we're removing |
| 749 | # dependencies, and a feature can enable features in dependencies. |
| 750 | # Cargo errors out on `[features] foo = "bar/baz"` if `bar` isn't a |
| 751 | # dependency. |
| 752 | clean_features_in_place(contents) |
George Burgess IV | d026147 | 2022-10-17 18:59:10 -0600 | [diff] [blame] | 753 | remove_all_dependencies_in_place(contents) |
| 754 | |
| 755 | # Since we're removing all source files, also be sure to remove |
| 756 | # source-related keys. |
| 757 | clean_source_related_lines_in_place(contents) |
George Burgess IV | 0313d78 | 2022-08-15 23:45:44 -0700 | [diff] [blame] | 758 | |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 759 | with open(os.path.join(pkg_path, "Cargo.toml"), "w") as cargo: |
| 760 | toml.dump(contents, cargo) |
| 761 | |
George Burgess IV | 8e2cc04 | 2022-10-18 14:50:48 -0600 | [diff] [blame] | 762 | def _replace_source_contents(self, package_path, compile_error): |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 763 | # First load the checksum file before starting |
| 764 | checksum_file = os.path.join(package_path, ".cargo-checksum.json") |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 765 | with open(checksum_file, "r") as csum: |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 766 | checksum_contents = json.load(csum) |
| 767 | |
| 768 | # Also load the cargo.toml file which we need to write back |
| 769 | cargo_file = os.path.join(package_path, "Cargo.toml") |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 770 | with open(cargo_file, "rb") as cfile: |
George Burgess IV | 3e344e4 | 2022-08-09 21:07:04 -0700 | [diff] [blame] | 771 | cargo_contents = cfile.read() |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 772 | |
| 773 | shutil.rmtree(package_path) |
| 774 | |
| 775 | # Make package and src dirs and replace lib.rs |
| 776 | os.makedirs(os.path.join(package_path, "src"), exist_ok=True) |
| 777 | with open(os.path.join(package_path, "src", "lib.rs"), "w") as librs: |
George Burgess IV | 8e2cc04 | 2022-10-18 14:50:48 -0600 | [diff] [blame] | 778 | librs.write( |
| 779 | EMPTY_CRATE_BODY if compile_error else NOP_EMPTY_CRATE_BODY |
| 780 | ) |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 781 | |
| 782 | # Restore cargo.toml |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 783 | with open(cargo_file, "wb") as cfile: |
George Burgess IV | 3e344e4 | 2022-08-09 21:07:04 -0700 | [diff] [blame] | 784 | cfile.write(cargo_contents) |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 785 | |
| 786 | # Restore checksum |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 787 | with open(checksum_file, "w") as csum: |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 788 | json.dump(checksum_contents, csum) |
| 789 | |
| 790 | def destroy_unused_crates(self): |
George Burgess IV | 18af563 | 2022-08-30 14:10:53 -0700 | [diff] [blame] | 791 | metadata = load_metadata(self.working_dir, filter_platform=None) |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 792 | used_packages = { |
| 793 | p["name"] for p in load_metadata(self.working_dir)["packages"] |
| 794 | } |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 795 | |
| 796 | cleaned_packages = [] |
George Burgess IV | 40cc91c | 2022-08-15 13:07:40 -0700 | [diff] [blame] | 797 | # Since we're asking for _all_ metadata packages, we may see |
| 798 | # duplication. |
George Burgess IV | 18af563 | 2022-08-30 14:10:53 -0700 | [diff] [blame] | 799 | for package in metadata["packages"]: |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 800 | # Skip used packages |
George Burgess IV | 8e2cc04 | 2022-10-18 14:50:48 -0600 | [diff] [blame] | 801 | package_name = package["name"] |
| 802 | if package_name in used_packages: |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 803 | continue |
| 804 | |
| 805 | # Detect the correct package path to destroy |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 806 | pkg_path = os.path.join( |
| 807 | self.vendor_dir, |
George Burgess IV | 8e2cc04 | 2022-10-18 14:50:48 -0600 | [diff] [blame] | 808 | "{}-{}".format(package_name, package["version"]), |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 809 | ) |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 810 | if not os.path.isdir(pkg_path): |
George Burgess IV | 8e2cc04 | 2022-10-18 14:50:48 -0600 | [diff] [blame] | 811 | print(f"Crate {package_name} not found at {pkg_path}") |
George Burgess IV | 635f726 | 2022-08-09 21:32:20 -0700 | [diff] [blame] | 812 | continue |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 813 | |
George Burgess IV | 8e2cc04 | 2022-10-18 14:50:48 -0600 | [diff] [blame] | 814 | self._replace_source_contents( |
| 815 | pkg_path, compile_error=package_name not in NOP_EMPTY_CRATES |
| 816 | ) |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 817 | self._modify_cargo_toml(pkg_path) |
| 818 | _rerun_checksums(pkg_path) |
| 819 | cleaned_packages.append(package["name"]) |
| 820 | |
| 821 | for pkg in cleaned_packages: |
George Burgess IV | 635f726 | 2022-08-09 21:32:20 -0700 | [diff] [blame] | 822 | print("Removed unused crate", pkg) |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 823 | |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 824 | |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 825 | def main(args): |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 826 | current_path = pathlib.Path(__file__).parent.absolute() |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 827 | patches = os.path.join(current_path, "patches") |
| 828 | vendor = os.path.join(current_path, "vendor") |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 829 | crab_dir = os.path.join(current_path, "crab", "crates") |
George Burgess IV | 0483370 | 2022-08-09 22:00:38 -0700 | [diff] [blame] | 830 | license_shorthand_file = os.path.join(current_path, "licenses_used.txt") |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 831 | |
Abhishek Pandit-Subedi | fa90238 | 2021-08-20 11:04:33 -0700 | [diff] [blame] | 832 | # First, actually run cargo vendor |
| 833 | run_cargo_vendor(current_path) |
| 834 | |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 835 | # Order matters here: |
| 836 | # - Apply patches (also re-calculates checksums) |
| 837 | # - Cleanup any owners files (otherwise, git check-in or checksums are |
| 838 | # unhappy) |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 839 | # - Destroy unused crates |
Abhishek Pandit-Subedi | 5065a0f | 2021-06-13 20:38:55 +0000 | [diff] [blame] | 840 | apply_patches(patches, vendor) |
| 841 | cleanup_owners(vendor) |
Abhishek Pandit-Subedi | f0eb6e0 | 2021-09-24 16:36:12 -0700 | [diff] [blame] | 842 | destroyer = CrateDestroyer(current_path, vendor) |
| 843 | destroyer.destroy_unused_crates() |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 844 | |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 845 | # Combine license file and check for any bad licenses |
| 846 | lm = LicenseManager(current_path, vendor) |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 847 | lm.generate_license( |
| 848 | args.skip_license_check, args.license_map, license_shorthand_file |
| 849 | ) |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 850 | |
Abhishek Pandit-Subedi | ce0f5b2 | 2021-09-10 15:50:08 -0700 | [diff] [blame] | 851 | # Run crab audit on all packages |
| 852 | crab = CrabManager(current_path, crab_dir) |
| 853 | crab.verify_traits() |
| 854 | |
Abhishek Pandit-Subedi | b75bd56 | 2021-02-25 15:32:22 -0800 | [diff] [blame] | 855 | |
George Burgess IV | 7dffc25 | 2022-08-31 14:37:01 -0700 | [diff] [blame] | 856 | if __name__ == "__main__": |
| 857 | parser = argparse.ArgumentParser(description="Vendor packages properly") |
| 858 | parser.add_argument( |
| 859 | "--skip-license-check", |
| 860 | "-s", |
| 861 | help="Skip the license check on a specific package", |
| 862 | action="append", |
| 863 | ) |
| 864 | parser.add_argument("--license-map", help="Write license map to this file") |
Abhishek Pandit-Subedi | e393cb7 | 2021-08-22 10:41:13 -0700 | [diff] [blame] | 865 | args = parser.parse_args() |
| 866 | |
| 867 | main(args) |