| 1 |
#!/usr/bin/env python3 |
| 2 |
|
| 3 |
""" |
| 4 |
Compare checksums for wheels in :mod:`ensurepip` against the Cheeseshop. |
| 5 |
|
| 6 |
When GitHub Actions executes the script, output is formatted accordingly. |
| 7 |
https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-a-notice-message |
| 8 |
""" |
| 9 |
|
| 10 |
import hashlib |
| 11 |
import json |
| 12 |
import os |
| 13 |
import re |
| 14 |
from pathlib import Path |
| 15 |
from urllib.request import urlopen |
| 16 |
|
| 17 |
ENSURE_PIP_ROOT = Path(__file__).parent.parent.parent / "Lib/ensurepip" |
| 18 |
WHEEL_DIR = ENSURE_PIP_ROOT / "_bundled" |
| 19 |
ENSURE_PIP_INIT_PY_TEXT = (ENSURE_PIP_ROOT / "__init__.py").read_text(encoding="utf-8") |
| 20 |
GITHUB_ACTIONS = os.getenv("GITHUB_ACTIONS") == "true" |
| 21 |
|
| 22 |
|
| 23 |
def print_notice(file_path: str | Path, message: str) -> None: |
| 24 |
if GITHUB_ACTIONS: |
| 25 |
message = f"::notice file={file_path}::{message}" |
| 26 |
print(message, end="\n\n") |
| 27 |
|
| 28 |
|
| 29 |
def print_error(file_path: str | Path, message: str) -> None: |
| 30 |
if GITHUB_ACTIONS: |
| 31 |
message = f"::error file={file_path}::{message}" |
| 32 |
print(message, end="\n\n") |
| 33 |
|
| 34 |
|
| 35 |
def verify_wheel(package_name: str) -> bool: |
| 36 |
# Find the package on disk |
| 37 |
package_paths = list(WHEEL_DIR.glob(f"{package_name}*.whl")) |
| 38 |
if len(package_paths) != 1: |
| 39 |
if package_paths: |
| 40 |
for p in package_paths: |
| 41 |
print_error(p, f"Found more than one wheel for package {package_name}.") |
| 42 |
else: |
| 43 |
print_error("", f"Could not find a {package_name} wheel on disk.") |
| 44 |
return False |
| 45 |
|
| 46 |
package_path = package_paths[0] |
| 47 |
|
| 48 |
print(f"Verifying checksum for {package_path}.") |
| 49 |
|
| 50 |
# Find the version of the package used by ensurepip |
| 51 |
package_version_match = re.search( |
| 52 |
f'_{package_name.upper()}_VERSION = "([^"]+)', ENSURE_PIP_INIT_PY_TEXT |
| 53 |
) |
| 54 |
if not package_version_match: |
| 55 |
print_error( |
| 56 |
package_path, |
| 57 |
f"No {package_name} version found in Lib/ensurepip/__init__.py.", |
| 58 |
) |
| 59 |
return False |
| 60 |
package_version = package_version_match[1] |
| 61 |
|
| 62 |
# Get the SHA 256 digest from the Cheeseshop |
| 63 |
try: |
| 64 |
raw_text = urlopen(f"https://pypi.org/pypi/{package_name}/json").read() |
| 65 |
except (OSError, ValueError): |
| 66 |
print_error(package_path, f"Could not fetch JSON metadata for {package_name}.") |
| 67 |
return False |
| 68 |
|
| 69 |
release_files = json.loads(raw_text)["releases"][package_version] |
| 70 |
expected_digest = "" |
| 71 |
for release_info in release_files: |
| 72 |
if package_path.name != release_info["filename"]: |
| 73 |
continue |
| 74 |
expected_digest = release_info["digests"].get("sha256", "") |
| 75 |
break |
| 76 |
else: |
| 77 |
print_error(package_path, f"No digest for {package_name} found from PyPI.") |
| 78 |
return False |
| 79 |
|
| 80 |
# Compute the SHA 256 digest of the wheel on disk |
| 81 |
actual_digest = hashlib.sha256(package_path.read_bytes()).hexdigest() |
| 82 |
|
| 83 |
print(f"Expected digest: {expected_digest}") |
| 84 |
print(f"Actual digest: {actual_digest}") |
| 85 |
|
| 86 |
if actual_digest != expected_digest: |
| 87 |
print_error( |
| 88 |
package_path, f"Failed to verify the checksum of the {package_name} wheel." |
| 89 |
) |
| 90 |
return False |
| 91 |
|
| 92 |
print_notice( |
| 93 |
package_path, |
| 94 |
f"Successfully verified the checksum of the {package_name} wheel.", |
| 95 |
) |
| 96 |
return True |
| 97 |
|
| 98 |
|
| 99 |
|
| 100 |
if __name__ == "__main__": |
| 101 |
exit_status = int(not verify_wheel("pip")) |
| 102 |
raise SystemExit(exit_status) |