More test coverage for release.py and sbom.py (#187)

Author: hugovk

.coveragerc

@@ -6,3 +6,4 @@ exclude_also =
     # Don't complain if non-runnable code isn't run:
     if __name__ == .__main__.
     def main
+    def get_arg_parser

release.py

@@ -363,13 +363,16 @@ def get_arg_parser() -> optparse.OptionParser:
 
 
 def constant_replace(
-    fn: str, updated_constants: str, comment_start: str = "/*", comment_end: str = "*/"
+    filename: str,
+    updated_constants: str,
+    comment_start: str = "/*",
+    comment_end: str = "*/",
 ) -> None:
     """Inserts in between --start constant-- and --end constant-- in a file"""
     start_tag = comment_start + "--start constants--" + comment_end
     end_tag = comment_start + "--end constants--" + comment_end
-    with open(fn, encoding="ascii") as infile, open(
-        fn + ".new", "w", encoding="ascii"
+    with open(filename, encoding="ascii") as infile, open(
+        filename + ".new", "w", encoding="ascii"
     ) as outfile:
         found_constants = False
         waiting_for_end = False
@@ -387,12 +390,14 @@ def constant_replace(
             else:
                 outfile.write(line)
     if not found_constants:
-        error(f"Constant section delimiters not found: {fn}")
-    os.rename(fn + ".new", fn)
+        error(f"Constant section delimiters not found: {filename}")
+    os.rename(filename + ".new", filename)
 
 
-def tweak_patchlevel(tag: Tag, done: bool = False) -> None:
-    print("Updating Include/patchlevel.h...", end=" ")
+def tweak_patchlevel(
+    tag: Tag, filename: str = "Include/patchlevel.h", done: bool = False
+) -> None:
+    print(f"Updating {filename}...", end=" ")
     template = '''
 #define PY_MAJOR_VERSION\t{tag.major}
 #define PY_MINOR_VERSION\t{tag.minor}
@@ -414,7 +419,7 @@ def tweak_patchlevel(tag: Tag, done: bool = False) -> None:
     )
     if tag.as_tuple() >= (3, 7, 0, "a", 3):
         new_constants = new_constants.expandtabs()
-    constant_replace("Include/patchlevel.h", new_constants)
+    constant_replace(filename, new_constants)
     print("done")
 
 
@@ -440,22 +445,22 @@ def bump(tag: Tag) -> None:
             ".github/ISSUE_TEMPLATE/crash.yml",
         ]
     print("\nManual editing time...")
-    for fn in other_files:
-        if os.path.exists(fn):
-            print(f"Edit {fn}")
-            manual_edit(fn)
+    for filename in other_files:
+        if os.path.exists(filename):
+            print(f"Edit {filename}")
+            manual_edit(filename)
         else:
-            print(f"Skipping {fn}")
+            print(f"Skipping {filename}")
 
     print("Bumped revision")
     if extra_work:
         print("configure.ac has changed; re-run autotools!")
     print("Please commit and use --tag")
 
 
-def manual_edit(fn: str) -> None:
+def manual_edit(filename: str) -> None:
     editor = os.environ["EDITOR"].split()
-    run_cmd([*editor, fn])
+    run_cmd([*editor, filename])
 
 
 @contextmanager

tests/patchlevel.h

@@ -0,0 +1,35 @@
+
+/* Python version identification scheme.
+
+   When the major or minor version changes, the VERSION variable in
+   configure.ac must also be changed.
+
+   There is also (independent) API version information in modsupport.h.
+*/
+
+/* Values for PY_RELEASE_LEVEL */
+#define PY_RELEASE_LEVEL_ALPHA  0xA
+#define PY_RELEASE_LEVEL_BETA   0xB
+#define PY_RELEASE_LEVEL_GAMMA  0xC     /* For release candidates */
+#define PY_RELEASE_LEVEL_FINAL  0xF     /* Serial should be 0 here */
+                                        /* Higher for patch releases */
+
+/* Version parsed out into numeric values */
+/*--start constants--*/
+#define PY_MAJOR_VERSION        3
+#define PY_MINOR_VERSION        14
+#define PY_MICRO_VERSION        0
+#define PY_RELEASE_LEVEL        PY_RELEASE_LEVEL_ALPHA
+#define PY_RELEASE_SERIAL       1
+
+/* Version as a string */
+#define PY_VERSION              "3.14.0a1+"
+/*--end constants--*/
+
+/* Version as a single 4-byte hex number, e.g. 0x010502B2 == 1.5.2b2.
+   Use this for numeric comparisons, e.g. #if PY_VERSION_HEX >= ... */
+#define PY_VERSION_HEX ((PY_MAJOR_VERSION << 24) | \
+                        (PY_MINOR_VERSION << 16) | \
+                        (PY_MICRO_VERSION <<  8) | \
+                        (PY_RELEASE_LEVEL <<  4) | \
+                        (PY_RELEASE_SERIAL << 0))

tests/sbom/sbom-with-pip-removed.json

@@ -0,0 +1,21 @@
+{
+  "SPDXID": "SPDXRef-DOCUMENT",
+  "name": "CPython SBOM",
+  "spdxVersion": "SPDX-2.3",
+  "dataLicense": "CC0-1.0",
+  "documentNamespace": "https://www.python.org/ftp/python/3.13.0/fake-artifact.txt.spdx.json",
+  "creationInfo": {
+    "created": "2024-10-15T20:11:52Z",
+    "creators": [],
+    "licenseListVersion": "3.22"
+  },
+  "files": [],
+  "packages": [],
+  "relationships": [
+    {
+      "relatedSpdxElement": "SPDXRef-FILE-Modules-expat-COPYING",
+      "relationshipType": "CONTAINS",
+      "spdxElementId": "SPDXRef-PACKAGE-expat"
+    }
+  ]
+}

tests/sbom/sbom-with-pip.json

@@ -0,0 +1,56 @@
+{
+  "SPDXID": "SPDXRef-DOCUMENT",
+  "name": "CPython SBOM",
+  "spdxVersion": "SPDX-2.3",
+  "dataLicense": "CC0-1.0",
+  "documentNamespace": "https://www.python.org/ftp/python/3.13.0/fake-artifact.txt.spdx.json",
+  "creationInfo": {
+    "created": "2024-10-15T20:11:52Z",
+    "creators": [],
+    "licenseListVersion": "3.22"
+  },
+  "files": [],
+  "packages": [
+    {
+      "SPDXID": "SPDXRef-PACKAGE-pip",
+      "name": "pip",
+      "versionInfo": "24.0",
+      "licenseConcluded": "MIT",
+      "originator": "Organization: Python Software Foundation",
+      "supplier": "Organization: Python Software Foundation",
+      "packageFileName": "pip-24.0-py3-none-any.whl",
+      "externalRefs": [
+        {
+          "referenceCategory": "SECURITY",
+          "referenceLocator": "cpe:2.3:a:pypa:pip:24.0:*:*:*:*:*:*:*",
+          "referenceType": "cpe23Type"
+        }
+      ],
+      "primaryPackagePurpose": "RUNTIME",
+      "downloadLocation": "https://files.pythonhosted.org/packages/.../pip-24.0-py3-none-any.whl",
+      "checksums": [
+        {
+          "algorithm": "SHA256",
+          "checksumValue": "ba0d021a166865d2265246961bec0152ff124de910c5cc39f1156ce3fa7c69dc"
+        }
+      ]
+    }
+  ],
+  "relationships": [
+    {
+      "relatedSpdxElement": "SPDXRef-FILE-Modules-expat-COPYING",
+      "relationshipType": "CONTAINS",
+      "spdxElementId": "SPDXRef-PACKAGE-expat"
+    },
+    {
+      "relatedSpdxElement": "SPDXRef-PACKAGE-urllib3",
+      "relationshipType": "DEPENDS_ON",
+      "spdxElementId": "SPDXRef-PACKAGE-pip"
+    },
+    {
+      "relatedSpdxElement": "SPDXRef-PACKAGE-pip",
+      "relationshipType": "DEPENDS_ON",
+      "spdxElementId": "SPDXRef-PACKAGE-cpython"
+    }
+  ]
+}

tests/test_release.py

@@ -1,3 +1,6 @@
+from pathlib import Path
+from typing import cast
+
 import pytest
 from pytest_mock import MockerFixture
 
@@ -26,3 +29,42 @@ def test_manual_edit(
 
     # Assert
     mock_run_cmd.assert_called_once_with(expected)
+
+
+def test_task(mocker: MockerFixture) -> None:
+    # Arrange
+    db = {"mock": "mock"}
+    my_task = mocker.Mock()
+    task = release.Task(my_task, "My task")
+
+    # Act
+    task(cast(release.ReleaseShelf, db))
+
+    # Assert
+    assert task.description == "My task"
+    assert task.function == my_task
+    my_task.assert_called_once_with(cast(release.ReleaseShelf, db))
+
+
+def test_tweak_patchlevel(tmp_path: Path) -> None:
+    # Arrange
+    tag = release.Tag("3.14.0b2")
+
+    original_patchlevel_file = Path(__file__).parent / "patchlevel.h"
+    patchlevel_file = tmp_path / "patchlevel.h"
+    patchlevel_file.write_text(original_patchlevel_file.read_text())
+
+    # Act
+    release.tweak_patchlevel(tag, filename=str(patchlevel_file))
+
+    # Assert
+    new_contents = patchlevel_file.read_text()
+    for expected in (
+        "#define PY_MAJOR_VERSION        3",
+        "#define PY_MINOR_VERSION        14",
+        "#define PY_MICRO_VERSION        0",
+        "#define PY_RELEASE_LEVEL        PY_RELEASE_LEVEL_BETA",
+        "#define PY_RELEASE_SERIAL       2",
+        '#define PY_VERSION              "3.14.0b2"',
+    ):
+        assert expected in new_contents

tests/test_sbom.py

@@ -4,6 +4,7 @@
 import random
 import re
 import unittest.mock
+from pathlib import Path
 
 import pytest
 
@@ -132,6 +133,20 @@ def test_fetch_project_metadata_from_pypi(mocker):
     )
 
 
+def test_remove_pip_from_sbom() -> None:
+    # Arrange
+    with (Path(__file__).parent / "sbom" / "sbom-with-pip.json").open() as f:
+        sbom_data = json.load(f)
+    with (Path(__file__).parent / "sbom" / "sbom-with-pip-removed.json").open() as f:
+        expected = json.load(f)
+
+    # Act
+    sbom.remove_pip_from_sbom(sbom_data)
+
+    # Assert
+    assert sbom_data == expected
+
+
 def test_create_cpython_sbom():
     sbom_data = {"packages": []}