Skip to content

💫 Toolkit to help you get started with SDD or any other process!

fix(extensions): apply GHES auth and resolve release assets for `extension add --from` (#3217)

Manfred Riembbc5f176e3df
diff --git a/src/specify_cli/extensions/_commands.py b/src/specify_cli/extensions/_commands.py
index 3b60b6d52..6821419b3 100644
--- a/src/specify_cli/extensions/_commands.py
+++ b/src/specify_cli/extensions/_commands.py
@@ -482,6 +482,7 @@ def extension_add(
elif from_url:
# Install from URL (ZIP file)
+ import io
import urllib.error
console.print(f"Downloading from {safe_url}...")
@@ -498,10 +499,33 @@ def extension_add(
zip_path = Path(download_file.name)
try:
- from specify_cli.authentication.http import open_url as _open_url
-
- with _open_url(from_url, timeout=60) as response:
+ # Use the catalog's authenticated fetch so configured
+ # credentials (incl. GitHub Enterprise Server) are applied
+ # and GHES release-asset URLs resolve via /api/v3 — keeping
+ # --from consistent with catalog-based installs.
+ dl_catalog = ExtensionCatalog(project_root)
+ download_url = from_url
+ extra_headers = None
+ resolved_url = dl_catalog._resolve_github_release_asset_api_url(download_url)
+ if resolved_url:
+ download_url = resolved_url
+ extra_headers = {"Accept": "application/octet-stream"}
+
+ with dl_catalog._open_url(
+ download_url, timeout=60, extra_headers=extra_headers
+ ) as response:
zip_data = response.read()
+
+ if not zipfile.is_zipfile(io.BytesIO(zip_data)):
+ console.print(
+ f"[red]Error:[/red] {safe_url} did not return a ZIP archive "
+ f"(got {len(zip_data)} bytes). This usually means the request "
+ f"was not authenticated and a login/HTML page was returned. "
+ f"Verify the URL is correct and that credentials for its host "
+ f"are configured in ~/.specify/auth.json."
+ )
+ raise typer.Exit(1)
+
zip_path.write_bytes(zip_data)
# Install from downloaded ZIP
diff --git a/tests/test_extensions.py b/tests/test_extensions.py
index e8dc2b7be..6260ad6ab 100644
--- a/tests/test_extensions.py
+++ b/tests/test_extensions.py
@@ -40,6 +40,10 @@ from specify_cli.extensions import (
version_satisfies,
)
+# Minimal valid ZIP (empty end-of-central-directory record). Passes
+# zipfile.is_zipfile() so --from download tests exercise the content guard.
+_MINIMAL_ZIP_BYTES = b"PK\x05\x06" + b"\x00" * 18
+
def can_create_symlink(tmp_path: Path) -> bool:
"""Return True when the current platform/user can create file symlinks."""
@@ -5378,7 +5382,7 @@ class TestExtensionAddCLI:
runner = CliRunner()
with patch.object(Path, "cwd", return_value=project_dir), \
patch("typer.confirm", return_value=True), \
- patch("specify_cli.authentication.http.open_url", return_value=FakeResponse(b"zip-bytes")), \
+ patch("specify_cli.authentication.http.open_url", return_value=FakeResponse(_MINIMAL_ZIP_BYTES)), \
patch.object(ExtensionManager, "install_from_zip", fake_install_from_zip), \
patch.object(ExtensionRegistry, "get", return_value={}):
result = runner.invoke(
@@ -5446,6 +5450,98 @@ class TestExtensionAddCLI:
assert "https://example.com/[red]ext[/red].zip" in result.output
assert "bad [red]download[/red]" in result.output
+ def test_add_from_url_rejects_non_zip_login_page(self, tmp_path):
+ """An HTML login page (unauthenticated fetch) must fail clearly, not BadZipFile."""
+ import io
+ from typer.testing import CliRunner
+ from unittest.mock import patch
+ from specify_cli import app
+
+ class FakeResponse(io.BytesIO):
+ def __enter__(self):
+ return self
+
+ def __exit__(self, exc_type, exc, tb):
+ return False
+
+ project_dir = tmp_path / "test-project"
+ project_dir.mkdir()
+ (project_dir / ".specify").mkdir()
+
+ runner = CliRunner()
+ with patch.object(Path, "cwd", return_value=project_dir), \
+ patch("typer.confirm", return_value=True), \
+ patch(
+ "specify_cli.authentication.http.open_url",
+ return_value=FakeResponse(b"<!DOCTYPE html><html>Sign in</html>"),
+ ), \
+ patch.object(ExtensionManager, "install_from_zip") as install:
+ result = runner.invoke(
+ app,
+ ["extension", "add", "my-ext", "--from", "https://raw.ghe.example/o/r/ext.zip"],
+ catch_exceptions=True,
+ )
+
+ assert result.exit_code == 1, result.output
+ assert "did not return a ZIP archive" in result.output
+ install.assert_not_called()
+
+ def test_add_from_url_resolves_ghes_release_asset(self, tmp_path):
+ """A GHES release-download URL resolves to /api/v3 with octet-stream Accept."""
+ import io
+ from types import SimpleNamespace
+ from typer.testing import CliRunner
+ from unittest.mock import patch
+ from specify_cli import app
+ import json
+
+ class FakeResponse(io.BytesIO):
+ def __enter__(self):
+ return self
+
+ def __exit__(self, exc_type, exc, tb):
+ return False
+
+ project_dir = tmp_path / "test-project"
+ project_dir.mkdir()
+ (project_dir / ".specify").mkdir()
+ seen = {}
+
+ def fake_open_url(url, timeout=10, extra_headers=None, redirect_validator=None):
+ if "/releases/tags/" in url:
+ body = json.dumps({
+ "assets": [{
+ "name": "ext.zip",
+ "url": "https://ghes.example/api/v3/repos/org/repo/releases/assets/42",
+ }]
+ }).encode()
+ return FakeResponse(body)
+ seen["url"] = url
+ seen["headers"] = extra_headers
+ return FakeResponse(_MINIMAL_ZIP_BYTES)
+
+ def fake_install(self_obj, zip_path, speckit_version, priority=10, force=False):
+ return SimpleNamespace(
+ id="x", name="X", version="1.0.0", description="", warnings=[], commands=[], hooks=[]
+ )
+
+ runner = CliRunner()
+ with patch.object(Path, "cwd", return_value=project_dir), \
+ patch("typer.confirm", return_value=True), \
+ patch("specify_cli.authentication.http.github_provider_hosts", return_value=("ghes.example",)), \
+ patch("specify_cli.authentication.http.open_url", side_effect=fake_open_url), \
+ patch.object(ExtensionManager, "install_from_zip", fake_install):
+ result = runner.invoke(
+ app,
+ ["extension", "add", "x", "--from",
+ "https://ghes.example/org/repo/releases/download/v1.0/ext.zip"],
+ catch_exceptions=True,
+ )
+
+ assert result.exit_code == 0, result.output
+ assert "/api/v3/repos/org/repo/releases/assets/" in seen["url"]
+ assert seen["headers"] == {"Accept": "application/octet-stream"}
+
@pytest.mark.parametrize(
("exc_type", "label"),
[
@@ -5523,7 +5619,7 @@ class TestExtensionAddCLI:
runner = CliRunner()
with patch.object(Path, "cwd", return_value=project_dir), \
patch("typer.confirm", return_value=True), \
- patch("specify_cli.authentication.http.open_url", return_value=FakeResponse(b"zip-bytes")), \
+ patch("specify_cli.authentication.http.open_url", return_value=FakeResponse(_MINIMAL_ZIP_BYTES)), \
patch.object(ExtensionManager, "install_from_zip", fake_install_from_zip):
result = runner.invoke(
app,
@@ -5532,7 +5628,7 @@ class TestExtensionAddCLI:
)
assert result.exit_code == 0
- assert installed["zip_bytes"] == b"zip-bytes"
+ assert installed["zip_bytes"] == _MINIMAL_ZIP_BYTES
assert installed["zip_path"].resolve().is_relative_to(downloads_dir.resolve())
assert installed["zip_path"].name.startswith("extension-url-download-")
assert not installed["zip_path"].exists()