Support scie-jump binaries linked against glibc. (#187)

Author: jsirois

CHANGES.md

@@ -1,5 +1,10 @@
 # Release Notes
 
+## 0.17.0
+
+This release adds support for `scie-jump` binaries linked against glibc for Linux aarch64 and
+x86_64.
+
 ## 0.16.0
 
 This release adds support for musl Linux on aarch64 and upgrades the `science` internal Python

science/__init__.py

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

science/a_scie.py

@@ -14,7 +14,25 @@
 from science.fetcher import FetchResult, fetch_and_verify
 from science.hashing import Digest, Fingerprint
 from science.model import Ptex, ScieJump, Url
-from science.platform import CURRENT_PLATFORM, Platform
+from science.platform import CURRENT_PLATFORM, CURRENT_PLATFORM_SPEC, Platform, PlatformSpec
+
+
+def qualify_binary_name(
+    binary_name: str,
+    version: Version | None = None,
+    platform_spec: PlatformSpec = CURRENT_PLATFORM_SPEC,
+) -> str:
+    # N.B.: The scie-jump added support for `-{gnu,musl}-linux-{aarch,x86_}64` suffixes in the
+    # 1.9.0 release.
+    if (
+        platform_spec.libc
+        and binary_name == "scie-jump"
+        and platform_spec.platform in (Platform.Linux_aarch64, Platform.Linux_x86_64)
+        and (not version or version >= Version("1.9.0"))
+    ):
+        return platform_spec.qualified_binary_name(binary_name, gnu_prefix=True)
+
+    return platform_spec.platform.qualified_binary_name(binary_name)
 
 
 @dataclass(frozen=True)
@@ -28,10 +46,12 @@ def load_project_release(
     binary_name: str,
     version: Version | None = None,
     fingerprint: Digest | Fingerprint | None = None,
-    platform: Platform = CURRENT_PLATFORM,
+    platform_spec: PlatformSpec = CURRENT_PLATFORM_SPEC,
     base_url: Url | None = None,
 ) -> LoadResult:
-    qualified_binary_name = platform.qualified_binary_name(binary_name)
+    qualified_binary_name = qualify_binary_name(
+        binary_name, version=version, platform_spec=platform_spec
+    )
     root_url = (base_url or f"https://github.com/a-scie/{project_name}/releases").rstrip("/")
     if version:
         version_path = f"download/v{version}"
@@ -51,7 +71,7 @@ def load_project_release(
 
 
 def jump(
-    specification: ScieJump | None = None, platform: Platform = CURRENT_PLATFORM
+    specification: ScieJump | None = None, platform_spec: PlatformSpec = CURRENT_PLATFORM_SPEC
 ) -> LoadResult:
     version = specification.version if specification else None
     fingerprint = specification.digest if specification and specification.digest else None
@@ -61,7 +81,7 @@ def jump(
         binary_name="scie-jump",
         version=version,
         fingerprint=fingerprint,
-        platform=platform,
+        platform_spec=platform_spec,
         base_url=base_url,
     )
 
@@ -77,7 +97,9 @@ def custom_jump(repo_path: Path) -> LoadResult:
     return LoadResult(path=path, digest=Digest.hash(path), binary_name=qualified_binary_name)
 
 
-def ptex(specification: Ptex | None = None, platform: Platform = CURRENT_PLATFORM) -> LoadResult:
+def ptex(
+    specification: Ptex | None = None, platform_spec: PlatformSpec = CURRENT_PLATFORM_SPEC
+) -> LoadResult:
     version = specification.version if specification else None
     fingerprint = specification.digest if specification and specification.digest else None
     base_url = specification.base_url if specification else None
@@ -86,6 +108,6 @@ def ptex(specification: Ptex | None = None, platform: Platform = CURRENT_PLATFOR
         binary_name="ptex",
         version=version,
         fingerprint=fingerprint,
-        platform=platform,
+        platform_spec=platform_spec,
         base_url=base_url,
     )

science/commands/download.py

@@ -14,7 +14,7 @@
 from science.errors import InputError
 from science.fetcher import fetch_and_verify
 from science.model import Fetch, Identifier
-from science.platform import Platform, PlatformSpec
+from science.platform import PlatformSpec
 from science.providers import ProviderInfo
 
 logger = logging.getLogger(__name__)
@@ -24,7 +24,7 @@ def download_a_scie_executables(
     project_name: str,
     binary_name: str,
     versions: Iterable[Version | None],
-    platforms: Iterable[Platform],
+    platform_specs: Iterable[PlatformSpec],
     dest_dir: Path,
 ) -> None:
     for version in versions or [None]:
@@ -33,17 +33,20 @@ def download_a_scie_executables(
         else:
             dest = dest_dir / project_name / "latest" / "download"
         dest.mkdir(parents=True, exist_ok=True)
-        for platform in platforms:
-            binary = dest / platform.qualified_binary_name(binary_name)
+        for platform_spec in platform_specs:
+            binary = dest / a_scie.qualify_binary_name(
+                binary_name, version=version, platform_spec=platform_spec
+            )
             click.echo(
-                f"Downloading {binary_name} {version or 'latest'} for {platform} to {binary}...",
+                f"Downloading {binary_name} {version or 'latest'} for {platform_spec} to "
+                f"{binary}...",
                 err=True,
             )
             result = a_scie.load_project_release(
                 project_name=project_name,
                 binary_name=binary_name,
                 version=version,
-                platform=platform,
+                platform_spec=platform_spec,
             )
             shutil.copy(result.path, binary)
             binary.with_name(f"{binary.name}.sha256").write_text(

science/commands/lift.py

@@ -159,7 +159,7 @@ def maybe_invert_lazy(file: File) -> File:
             isinstance(file.source, Fetch) and file.source.lazy for file in requested_files
         )
         if application.ptex or fetches_present:
-            ptex = a_scie.ptex(specification=application.ptex, platform=platform_spec.platform)
+            ptex = a_scie.ptex(specification=application.ptex, platform_spec=platform_spec)
             (chroot / ptex.binary_name).symlink_to(ptex.path)
             ptex_key = application.ptex.id if application.ptex and application.ptex.id else "ptex"
             ptex_file = File(
@@ -248,7 +248,7 @@ def maybe_invert_lazy(file: File) -> File:
         load_result = (
             a_scie.custom_jump(repo_path=use_jump)
             if use_jump
-            else a_scie.jump(specification=application.scie_jump, platform=platform_spec.platform)
+            else a_scie.jump(specification=application.scie_jump, platform_spec=platform_spec)
         )
         if load_result.version:
             scie_jump = ScieJump(version=load_result.version, digest=load_result.digest)

science/exe.py

@@ -412,9 +412,7 @@ def _download_ptex(
         project_name="ptex",
         binary_name="ptex",
         versions=versions,
-        platforms=dict.fromkeys(
-            platform_spec.platform for platform_spec in download_config.platform_specs
-        ),
+        platform_specs=dict.fromkeys(download_config.platform_specs),
         dest_dir=dest_dir,
     )
 
@@ -431,9 +429,7 @@ def _download_scie_jump(
         project_name="jump",
         binary_name="scie-jump",
         versions=versions,
-        platforms=dict.fromkeys(
-            platform_spec.platform for platform_spec in download_config.platform_specs
-        ),
+        platform_specs=dict.fromkeys(download_config.platform_specs),
         dest_dir=dest_dir,
     )
 

science/platform.py

@@ -207,8 +207,8 @@ class PlatformSpec:
     def binary_name(self, binary_name: str) -> str:
         return self.platform.binary_name(binary_name)
 
-    def qualified_binary_name(self, binary_name: str) -> str:
-        if LibC.MUSL is self.libc:
+    def qualified_binary_name(self, binary_name: str, gnu_prefix: bool = False) -> str:
+        if LibC.MUSL is self.libc or (LibC.GLIBC is self.libc and gnu_prefix):
             return self.platform.qualified_binary_name(binary_name, self.libc.value)
         return self.platform.qualified_binary_name(binary_name)
 

tests/conftest.py

@@ -11,7 +11,7 @@
 from click.globals import pop_context, push_context
 
 from science.context import ScienceConfig
-from science.platform import CURRENT_PLATFORM, Platform
+from science.platform import CURRENT_PLATFORM, CURRENT_PLATFORM_SPEC, Platform, PlatformSpec
 
 
 def pytest_sessionstart(session: pytest.Session) -> None:
@@ -47,3 +47,8 @@ def cache_dir(tmp_path: Path) -> Iterator[Path]:
 @pytest.fixture
 def current_platform() -> Platform:
     return CURRENT_PLATFORM
+
+
+@pytest.fixture
+def current_platform_spec() -> PlatformSpec:
+    return CURRENT_PLATFORM_SPEC

tests/test_download.py

@@ -15,8 +15,9 @@
 import pytest
 from pytest import MonkeyPatch
 
+from science import a_scie
 from science.hashing import Digest
-from science.platform import CURRENT_PLATFORM_SPEC, Platform
+from science.platform import CURRENT_PLATFORM_SPEC, Platform, PlatformSpec
 from science.providers import PyPy
 
 
@@ -71,13 +72,15 @@ def read_data():
 
 
 def assert_download_mirror(
-    tmp_path: Path, current_platform: Platform, *, download_dir: Path, download_url: str
+    tmp_path: Path, current_platform_spec: PlatformSpec, *, download_dir: Path, download_url: str
 ) -> None:
     subprocess.run(args=["science", "download", "ptex", download_dir], check=True)
     subprocess.run(args=["science", "download", "scie-jump", download_dir], check=True)
 
     lift_manifest = tmp_path / "lift.toml"
-    scie_jump_qualified_binary_name = current_platform.qualified_binary_name("scie-jump")
+    scie_jump_qualified_binary_name = a_scie.qualify_binary_name(
+        "scie-jump", platform_spec=current_platform_spec
+    )
     lift_manifest.write_text(
         dedent(
             f"""\
@@ -99,31 +102,33 @@ def assert_download_mirror(
     )
     subprocess.run(args=["science", "lift", "build", lift_manifest], cwd=tmp_path, check=True)
 
-    scie = tmp_path / current_platform.binary_name("mirror")
+    scie = tmp_path / current_platform_spec.binary_name("mirror")
     split_dir = tmp_path / "split"
     subprocess.run(args=[scie, split_dir], env={**os.environ, "SCIE": "split"}, check=True)
     subprocess.run(args=[scie], cwd=tmp_path, check=True)
 
     assert Digest.hash(tmp_path / scie_jump_qualified_binary_name) == Digest.hash(
-        split_dir / current_platform.binary_name("scie-jump")
+        split_dir / current_platform_spec.binary_name("scie-jump")
     )
 
 
-def test_download_http_mirror(tmp_path: Path, current_platform: Platform, server: Server) -> None:
+def test_download_http_mirror(
+    tmp_path: Path, current_platform_spec: PlatformSpec, server: Server
+) -> None:
     assert_download_mirror(
-        tmp_path, current_platform, download_dir=server.root, download_url=server.url
+        tmp_path, current_platform_spec, download_dir=server.root, download_url=server.url
     )
 
 
-def test_download_file_mirror(tmp_path: Path, current_platform: Platform) -> None:
+def test_download_file_mirror(tmp_path: Path, current_platform_spec: PlatformSpec) -> None:
     download_dir = tmp_path / "download-dir"
     download_dir_url = (
         f"file:///{download_dir.as_posix()}"
-        if current_platform.is_windows
+        if current_platform_spec.is_windows
         else f"file://{download_dir}"
     )
     assert_download_mirror(
-        tmp_path, current_platform, download_dir=download_dir, download_url=download_dir_url
+        tmp_path, current_platform_spec, download_dir=download_dir, download_url=download_dir_url
     )