Plumb scie.jump.hash for scie-jump >= 1.11.0. (#196)

Author: jsirois

CHANGES.md

@@ -1,5 +1,10 @@
 # Release Notes
 
+## 0.18.1
+
+This release passes the `scie_jump.digest.fingerprint` through to the `scie.jump.hash` lift manifest
+field when building scies using a scie-jump version 1.11.0 or newer.
+
 ## 0.18.0
 
 This release adds a `science lift run` command for running lift manifests directly. This can be

science/__init__.py

@@ -3,6 +3,6 @@
 
 from packaging.version import Version
 
-__version__ = "0.18.0"
+__version__ = "0.18.1"
 
 VERSION = Version(__version__)

science/commands/lift.py

@@ -13,6 +13,8 @@
 from typing import Any, Iterable, Iterator, Mapping, TextIO
 from zipfile import ZipInfo
 
+from packaging.version import Version
+
 from science import a_scie, providers
 from science.build_info import BuildInfo
 from science.errors import InputError
@@ -303,8 +305,10 @@ def maybe_invert_lazy(file: File) -> File:
         )
         if load_result.version:
             scie_jump = ScieJump(version=load_result.version, digest=load_result.digest)
+        elif platform_spec == CURRENT_PLATFORM_SPEC:
+            scie_jump = ScieJump.load(scie_jump_path=load_result.path, digest=load_result.digest)
         else:
-            scie_jump = ScieJump()
+            scie_jump = ScieJump(digest=load_result.digest)
 
         with open(lift_manifest, "w") as lift_manifest_output:
             _emit_manifest(
@@ -435,6 +439,10 @@ def render_commands(cmds: Iterable[Command]) -> dict[str, dict[str, Any]]:
     scie_jump_data = dict[str, Any]()
     if (scie_jump_version := scie_jump.version) and (scie_jump_digest := scie_jump.digest):
         scie_jump_data.update(version=str(scie_jump_version), size=scie_jump_digest.size)
+        if scie_jump.version >= Version("1.11.0"):
+            # N.B.: scie.jump.hash support was added in 1.11.0:
+            #   https://github.com/a-scie/jump/releases/tag/v1.11.0
+            scie_jump_data.update(hash=scie_jump.digest.fingerprint)
     if scie_jump_data:
         scie_data.update(jump=scie_jump_data)
 

science/model.py

@@ -3,8 +3,10 @@
 
 
 import dataclasses
+import logging
 import os.path
 import re
+import subprocess
 import urllib.parse
 from collections import Counter, defaultdict
 from dataclasses import dataclass
@@ -36,6 +38,8 @@
 from science.hashing import Digest, ExpectedDigest
 from science.platform import CURRENT_PLATFORM_SPEC, PlatformSpec
 
+logger = logging.getLogger(__name__)
+
 
 class FileType(Enum):
     @classmethod
@@ -267,6 +271,22 @@ def rel_path(self) -> PurePath:
 
 @documented_dataclass(frozen=True, alias="scie_jump")
 class ScieJump:
+    @classmethod
+    def load(cls, scie_jump_path: Path, digest: Digest | None = None) -> ScieJump:
+        version: Version | None = None
+        process = subprocess.Popen(
+            args=[scie_jump_path, "-V"], stdout=subprocess.PIPE, stderr=subprocess.PIPE
+        )
+        stdout, _ = process.communicate()
+        if process.returncode == 0:
+            version = Version(stdout.decode("utf-8").strip())
+        else:
+            logger.warning(
+                f"The scie-jump at {scie_jump_path} does not support `-V` / `--version`. "
+                f"Some science operations may not work as expected."
+            )
+        return cls(version=version, digest=digest or Digest.hash(scie_jump_path))
+
     _DEFAULT_BASE_URL: ClassVar[Url] = Url("https://github.com/a-scie/jump/releases")
 
     version: Version | None = dataclasses.field(default=None, metadata=metadata(reference=True))

tests/test_exe.py

@@ -52,15 +52,15 @@ def science_exe(
     subprocess.run(
         args=[
             sys.executable,
-            str(science_pyz),
+            science_pyz,
             "lift",
             "--file",
             f"science.pyz={science_pyz}",
             "--file",
             f"docsite={docsite}",
             "build",
             "--dest-dir",
-            str(dest),
+            dest,
         ],
         check=True,
         cwd=build_root,
@@ -77,15 +77,15 @@ def test_use_platform_suffix(
     assert not expected_executable.exists()
     subprocess.run(
         args=[
-            str(science_exe),
+            science_exe,
             "lift",
             "--file",
             f"science.pyz={science_pyz}",
             "--file",
             f"docsite={docsite}",
             "build",
             "--dest-dir",
-            str(tmp_path),
+            tmp_path,
             "--use-platform-suffix",
             config,
         ],
@@ -104,7 +104,7 @@ def test_no_use_platform_suffix(
     assert not expected_executable.exists()
     subprocess.run(
         args=[
-            str(science_exe),
+            science_exe,
             "lift",
             "--file",
             f"science.pyz={science_pyz}",
@@ -114,7 +114,7 @@ def test_no_use_platform_suffix(
             foreign_platform.value,
             "build",
             "--dest-dir",
-            str(tmp_path),
+            tmp_path,
             "--no-use-platform-suffix",
             config,
         ],
@@ -157,15 +157,15 @@ def test_hash(
 
     subprocess.run(
         args=[
-            str(science_exe),
+            science_exe,
             "lift",
             "--file",
             f"science.pyz={science_pyz}",
             "--file",
             f"docsite={docsite}",
             "build",
             "--dest-dir",
-            str(tmp_path),
+            tmp_path,
             *itertools.chain.from_iterable(("--hash", algorithm) for algorithm in algorithms),
             config,
         ],
@@ -176,7 +176,7 @@ def test_hash(
     if shasum:
         subprocess.run(
             args=[shasum, "-c", *(checksum_file.name for checksum_file in expected_checksum_paths)],
-            cwd=str(tmp_path),
+            cwd=tmp_path,
             check=True,
         )
     else:
@@ -200,7 +200,7 @@ def test_dogfood(
     dest = tmp_path / "dest"
     subprocess.run(
         args=[
-            str(science_exe),
+            science_exe,
             "lift",
             "--file",
             f"science.pyz={science_pyz}",
@@ -250,7 +250,7 @@ def test_nested_filenames(
     (tmp_path / "docsite").mkdir()
     dest1 = tmp_path / "dest1"
     subprocess.run(
-        args=[str(science_exe), "lift", "build", "--dest-dir", str(dest1)], check=True, cwd=tmp_path
+        args=[science_exe, "lift", "build", "--dest-dir", str(dest1)], check=True, cwd=tmp_path
     )
     science_exe1 = dest1 / science_exe.name
     assert science_exe1.is_file()
@@ -382,7 +382,7 @@ def create_url_source_scie(
 
     scie = dest / CURRENT_PLATFORM.binary_name(expected_name)
     result = subprocess.run(
-        args=[str(science_exe), "lift", *extra_lift_args, "build", "--dest-dir", str(dest), "-"],
+        args=[science_exe, "lift", *extra_lift_args, "build", "--dest-dir", str(dest), "-"],
         input=lift_toml_content,
         stdout=subprocess.PIPE,
         stderr=subprocess.PIPE,
@@ -766,7 +766,7 @@ def test_pypy_provider(tmp_path: Path, science_exe: Path, version: str) -> None:
     chroot.mkdir(parents=True, exist_ok=True)
 
     subprocess.run(
-        args=[str(science_exe), "lift", "build", "--dest-dir", str(dest), "-"],
+        args=[science_exe, "lift", "build", "--dest-dir", str(dest), "-"],
         input=dedent(
             f"""\
             [lift]
@@ -815,7 +815,7 @@ def test_scie_name_collision_with_file(tmp_path: Path, science_exe: Path) -> Non
 
     subprocess.run(
         args=[
-            str(science_exe),
+            science_exe,
             "lift",
             "--file",
             f"exe={exe}",
@@ -877,7 +877,7 @@ def test_pbs_provider_pre_releases(tmp_path: Path, science_exe: Path) -> None:
 
     subprocess.run(
         args=[
-            str(science_exe),
+            science_exe,
             "lift",
             "--file",
             f"exe={exe}",
@@ -952,7 +952,7 @@ def test_pbs_provider_freethreaded_builds(tmp_path: Path, science_exe: Path) ->
 
     subprocess.run(
         args=[
-            str(science_exe),
+            science_exe,
             "lift",
             "--file",
             f"exe={exe}",
@@ -1026,7 +1026,7 @@ def test_pbs_provider_version_suffix(tmp_path: Path, science_exe: Path) -> None:
     chroot.mkdir(parents=True, exist_ok=True)
 
     result = subprocess.run(
-        args=[str(science_exe), "lift", "build", "--dest-dir", str(dest), "-"],
+        args=[science_exe, "lift", "build", "--dest-dir", str(dest), "-"],
         input=dedent(
             """\
             [lift]
@@ -1160,7 +1160,7 @@ def test_pbs_provider_version_suffix(tmp_path: Path, science_exe: Path) -> None:
 
     subprocess.run(
         args=[
-            str(science_exe),
+            science_exe,
             "lift",
             "--file",
             f"exe={exe}",
@@ -1222,7 +1222,7 @@ def test_load_dotenv(tmp_path: Path, science_exe: Path) -> None:
     chroot.mkdir(parents=True, exist_ok=True)
 
     subprocess.run(
-        args=[str(science_exe), "lift", "build", "--dest-dir", str(dest), "-"],
+        args=[science_exe, "lift", "build", "--dest-dir", str(dest), "-"],
         input=dedent(
             """\
             [lift]
@@ -1296,7 +1296,7 @@ def test_custom_jump_nominal(tmp_path: Path, science_exe: Path, version: str) ->
 
     cache_dir = tmp_path / "cache"
     subprocess.run(
-        args=[str(science_exe), "lift", "build", "--dest-dir", str(dest), lift_manifest],
+        args=[science_exe, "lift", "build", "--dest-dir", str(dest), lift_manifest],
         env={**os.environ, "SCIENCE_CACHE_DIR": str(cache_dir)},
         check=True,
     )
@@ -1443,7 +1443,7 @@ def test_custom_jump_invalid(tmp_path: Path, science_exe: Path, digest: Digest)
 
     cache_dir = tmp_path / "cache"
     result = subprocess.run(
-        args=[str(science_exe), "lift", "build", "--dest-dir", str(dest)],
+        args=[science_exe, "lift", "build", "--dest-dir", str(dest)],
         env={**os.environ, "SCIENCE_CACHE_DIR": str(cache_dir)},
         cwd=chroot,
         stderr=subprocess.PIPE,