Skip to content

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

fix: resolve GitHub release asset API URL for private repo preset and workflow downloads (#2855)

lselvarf512b8b0d159
diff --git a/src/specify_cli/__init__.py b/src/specify_cli/__init__.py
index 18885a296..99b312621 100644
--- a/src/specify_cli/__init__.py
+++ b/src/specify_cli/__init__.py
@@ -702,7 +702,6 @@ def preset_add(
raise typer.Exit(1)
console.print(f"Installing preset from [cyan]{from_url}[/cyan]...")
- import urllib.request
import urllib.error
import tempfile
@@ -710,8 +709,15 @@ def preset_add(
zip_path = Path(tmpdir) / "preset.zip"
try:
from specify_cli.authentication.http import open_url as _open_url
+ from specify_cli._github_http import resolve_github_release_asset_api_url
- with _open_url(from_url, timeout=60) as response:
+ _preset_extra_headers = None
+ _resolved_from_url = resolve_github_release_asset_api_url(from_url, _open_url)
+ if _resolved_from_url:
+ from_url = _resolved_from_url
+ _preset_extra_headers = {"Accept": "application/octet-stream"}
+
+ with _open_url(from_url, timeout=60, extra_headers=_preset_extra_headers) as response:
zip_path.write_bytes(response.read())
except urllib.error.URLError as e:
console.print(f"[red]Error:[/red] Failed to download: {e}")
@@ -3065,9 +3071,17 @@ def workflow_add(
console.print("[red]Error:[/red] Only HTTPS URLs are allowed, except HTTP for localhost.")
raise typer.Exit(1)
+ from specify_cli._github_http import resolve_github_release_asset_api_url as _resolve_gh_asset
+
+ _wf_url_extra_headers = None
+ _resolved_wf_url = _resolve_gh_asset(source, _open_url, timeout=30)
+ if _resolved_wf_url:
+ source = _resolved_wf_url
+ _wf_url_extra_headers = {"Accept": "application/octet-stream"}
+
import tempfile
try:
- with _open_url(source, timeout=30) as resp:
+ with _open_url(source, timeout=30, extra_headers=_wf_url_extra_headers) as resp:
final_url = resp.geturl()
final_parsed = urlparse(final_url)
final_host = final_parsed.hostname or ""
@@ -3164,9 +3178,16 @@ def workflow_add(
try:
from specify_cli.authentication.http import open_url as _open_url
+ from specify_cli._github_http import resolve_github_release_asset_api_url as _resolve_gh_asset
+
+ _wf_cat_extra_headers = None
+ _resolved_workflow_url = _resolve_gh_asset(workflow_url, _open_url, timeout=30)
+ if _resolved_workflow_url:
+ workflow_url = _resolved_workflow_url
+ _wf_cat_extra_headers = {"Accept": "application/octet-stream"}
workflow_dir.mkdir(parents=True, exist_ok=True)
- with _open_url(workflow_url, timeout=30) as response:
+ with _open_url(workflow_url, timeout=30, extra_headers=_wf_cat_extra_headers) as response:
# Validate final URL after redirects
final_url = response.geturl()
final_parsed = urlparse(final_url)
diff --git a/src/specify_cli/_github_http.py b/src/specify_cli/_github_http.py
index ffa804dbb..8f6abc40f 100644
--- a/src/specify_cli/_github_http.py
+++ b/src/specify_cli/_github_http.py
@@ -8,8 +8,8 @@ third-party hosts on redirects.
import os
import urllib.request
-from typing import Dict
-from urllib.parse import urlparse
+from typing import Callable, Dict, Optional
+from urllib.parse import quote, unquote, urlparse
# GitHub-owned hostnames that should receive the Authorization header.
# Includes codeload.github.com because GitHub archive URL downloads
@@ -76,6 +76,79 @@ class _StripAuthOnRedirect(urllib.request.HTTPRedirectHandler):
return new_req
+def resolve_github_release_asset_api_url(
+ download_url: str,
+ open_url_fn: Callable,
+ timeout: int = 60,
+) -> Optional[str]:
+ """Resolve a GitHub browser release URL to its REST API asset URL.
+
+ For private or SSO-protected repositories, browser release download
+ URLs (``https://github.com/<owner>/<repo>/releases/download/<tag>/<asset>``)
+ redirect to an HTML/SSO page instead of delivering the file. This
+ helper resolves such a URL to the matching GitHub REST API asset URL
+ (``https://api.github.com/repos/…/releases/assets/<id>``), which can
+ then be downloaded with ``Accept: application/octet-stream`` and an
+ auth token to retrieve the actual file payload.
+
+ If *download_url* is already a REST API asset URL, it is returned
+ as-is. Non-GitHub URLs and GitHub URLs that are not release-download
+ URLs return ``None``. If the API lookup fails (e.g. network error or
+ asset not found), ``None`` is returned so callers can fall back to the
+ original URL.
+
+ Args:
+ download_url: The URL to resolve.
+ open_url_fn: A callable compatible with
+ ``specify_cli.authentication.http.open_url`` used to make the
+ authenticated API request.
+ timeout: Per-request timeout in seconds.
+
+ Returns:
+ The resolved REST API asset URL, or ``None`` if resolution is not
+ applicable or fails.
+ """
+ import json
+ import urllib.error
+
+ parsed = urlparse(download_url)
+ parts = [unquote(part) for part in parsed.path.strip("/").split("/")]
+
+ # Already a REST API asset URL — use it directly
+ if (
+ parsed.hostname == "api.github.com"
+ and len(parts) >= 6
+ and parts[:1] == ["repos"]
+ and parts[3:5] == ["releases", "assets"]
+ ):
+ return download_url
+
+ # Only handle github.com browser release download URLs
+ if parsed.hostname != "github.com":
+ return None
+
+ # Expecting /<owner>/<repo>/releases/download/<tag>/<asset>
+ if len(parts) < 6 or parts[2:4] != ["releases", "download"]:
+ return None
+
+ owner, repo, tag = parts[0], parts[1], parts[4]
+ asset_name = "/".join(parts[5:])
+ encoded_tag = quote(tag, safe="")
+ release_url = f"https://api.github.com/repos/{owner}/{repo}/releases/tags/{encoded_tag}"
+
+ try:
+ with open_url_fn(release_url, timeout=timeout) as response:
+ release_data = json.loads(response.read())
+ except (urllib.error.URLError, json.JSONDecodeError):
+ return None
+
+ for asset in release_data.get("assets", []):
+ if asset.get("name") == asset_name and asset.get("url"):
+ return str(asset["url"])
+
+ return None
+
+
def open_github_url(url: str, timeout: int = 10):
"""Open a URL with GitHub auth, stripping the header on cross-host redirects.
diff --git a/src/specify_cli/extensions.py b/src/specify_cli/extensions.py
index 50e2a8ecd..0b2a3923a 100644
--- a/src/specify_cli/extensions.py
+++ b/src/specify_cli/extensions.py
@@ -1861,41 +1861,15 @@ class ExtensionCatalog(CatalogStackBase):
download_url: str,
timeout: int = 60,
) -> Optional[str]:
- """Resolve a GitHub release asset URL to its API asset URL."""
- import urllib.error
- from urllib.parse import unquote, urlparse
-
- parsed = urlparse(download_url)
- parts = [unquote(part) for part in parsed.path.strip("/").split("/")]
- if (
- parsed.hostname == "api.github.com"
- and len(parts) >= 6
- and parts[:1] == ["repos"]
- and parts[3:5] == ["releases", "assets"]
- ):
- return download_url
-
- if parsed.hostname != "github.com":
- return None
-
- if len(parts) < 6 or parts[2:4] != ["releases", "download"]:
- return None
-
- owner, repo, tag = parts[0], parts[1], parts[4]
- asset_name = "/".join(parts[5:])
- release_url = f"https://api.github.com/repos/{owner}/{repo}/releases/tags/{tag}"
+ """Resolve a GitHub release asset URL to its API asset URL.
- try:
- with self._open_url(release_url, timeout=timeout) as response:
- release_data = json.loads(response.read())
- except (urllib.error.URLError, json.JSONDecodeError):
- return None
-
- for asset in release_data.get("assets", []):
- if asset.get("name") == asset_name and asset.get("url"):
- return str(asset["url"])
+ Delegates to the shared helper in :mod:`specify_cli._github_http`.
+ """
+ from specify_cli._github_http import resolve_github_release_asset_api_url
- return None
+ return resolve_github_release_asset_api_url(
+ download_url, self._open_url, timeout=timeout
+ )
def get_active_catalogs(self) -> List[CatalogEntry]:
"""Get the ordered list of active catalogs.
diff --git a/src/specify_cli/presets.py b/src/specify_cli/presets.py
index 4468bcdb6..ebb99e7fb 100644
--- a/src/specify_cli/presets.py
+++ b/src/specify_cli/presets.py
@@ -1868,13 +1868,29 @@ class PresetCatalog:
from specify_cli.authentication.http import build_request
return build_request(url)
- def _open_url(self, url: str, timeout: int = 10):
+ def _open_url(
+ self,
+ url: str,
+ timeout: int = 10,
+ extra_headers: Optional[Dict[str, str]] = None,
+ ):
"""Open a URL with provider-based auth, trying each configured provider.
Delegates to :func:`specify_cli.authentication.http.open_url`.
"""
from specify_cli.authentication.http import open_url
- return open_url(url, timeout)
+ return open_url(url, timeout, extra_headers=extra_headers)
+
+ def _resolve_github_release_asset_api_url(
+ self,
+ download_url: str,
+ timeout: int = 60,
+ ) -> Optional[str]:
+ """Resolve a GitHub release asset URL to its REST API asset URL."""
+ from specify_cli._github_http import resolve_github_release_asset_api_url
+ return resolve_github_release_asset_api_url(
+ download_url, self._open_url, timeout=timeout
+ )
def _load_catalog_config(self, config_path: Path) -> Optional[List[PresetCatalogEntry]]:
"""Load catalog stack configuration from a YAML file.
@@ -2332,8 +2348,14 @@ class PresetCatalog:
zip_filename = f"{pack_id}-{version}.zip"
zip_path = target_dir / zip_filename
+ extra_headers = None
+ resolved_download_url = self._resolve_github_release_asset_api_url(download_url)
+ if resolved_download_url:
+ download_url = resolved_download_url
+ extra_headers = {"Accept": "application/octet-stream"}
+
try:
- with self._open_url(download_url, timeout=60) as response:
+ with self._open_url(download_url, timeout=60, extra_headers=extra_headers) as response:
zip_data = response.read()
zip_path.write_bytes(zip_data)
diff --git a/tests/test_github_http.py b/tests/test_github_http.py
index f414aeeb2..f51368079 100644
--- a/tests/test_github_http.py
+++ b/tests/test_github_http.py
@@ -1,12 +1,15 @@
"""Tests for GitHub-authenticated HTTP request helpers."""
+import json
import os
-from unittest.mock import patch
+from contextlib import contextmanager
+from unittest.mock import MagicMock, patch
import pytest
from specify_cli._github_http import (
build_github_request,
+ resolve_github_release_asset_api_url,
)
@@ -76,4 +79,112 @@ class TestBuildGitHubRequest:
def test_missing_hostname_raises_value_error(self):
"""build_github_request() must reject URLs with valid scheme but no hostname."""
with pytest.raises(ValueError, match="url must include a hostname"):
- build_github_request("http://")
\ No newline at end of file
+ build_github_request("http://")
+
+
+class TestResolveGitHubReleaseAssetApiUrl:
+ """Tests for resolve_github_release_asset_api_url()."""
+
+ def _make_open_url_fn(self, release_json):
+ """Create a fake open_url_fn that returns release JSON."""
+ @contextmanager
+ def fake_open(url, timeout=None, extra_headers=None):
+ resp = MagicMock()
+ resp.read.return_value = json.dumps(release_json).encode()
+ yield resp
+ return fake_open
+
+ def test_returns_none_for_non_github_url(self):
+ """Non-GitHub URLs should return None."""
+ result = resolve_github_release_asset_api_url(
+ "https://example.com/file.zip", lambda *a, **kw: None
+ )
+ assert result is None
+
+ def test_returns_none_for_non_release_github_url(self):
+ """GitHub URLs that aren't release downloads return None."""
+ result = resolve_github_release_asset_api_url(
+ "https://github.com/org/repo/archive/refs/tags/v1.zip",
+ lambda *a, **kw: None,
+ )
+ assert result is None
+
+ def test_passthrough_for_existing_api_asset_url(self):
+ """Already-resolved REST API asset URLs are returned as-is."""
+ url = "https://api.github.com/repos/org/repo/releases/assets/12345"
+ result = resolve_github_release_asset_api_url(url, lambda *a, **kw: None)
+ assert result == url
+
+ def test_resolves_browser_url_to_api_url(self):
+ """Browser release URL resolves to REST API asset URL."""
+ release_json = {
+ "assets": [
+ {"name": "pack.zip", "url": "https://api.github.com/repos/org/repo/releases/assets/99"}
+ ]
+ }
+ result = resolve_github_release_asset_api_url(
+ "https://github.com/org/repo/releases/download/v1.0/pack.zip",
+ self._make_open_url_fn(release_json),
+ )
+ assert result == "https://api.github.com/repos/org/repo/releases/assets/99"
+
+ def test_returns_none_when_asset_not_found(self):
+ """Returns None when the release exists but asset name doesn't match."""
+ release_json = {"assets": [{"name": "other.zip", "url": "https://api.github.com/repos/org/repo/releases/assets/1"}]}
+ result = resolve_github_release_asset_api_url(
+ "https://github.com/org/repo/releases/download/v1/missing.zip",
+ self._make_open_url_fn(release_json),
+ )
+ assert result is None
+
+ def test_returns_none_on_network_error(self):
+ """Returns None when the API request fails."""
+ import urllib.error
+
+ @contextmanager
+ def failing_open(url, timeout=None, extra_headers=None):
+ raise urllib.error.URLError("network error")
+ yield # noqa: unreachable
+
+ result = resolve_github_release_asset_api_url(
+ "https://github.com/org/repo/releases/download/v1/pack.zip",
+ failing_open,
+ )
+ assert result is None
+
+ def test_tag_with_special_characters_is_url_encoded(self):
+ """Tags with reserved characters (e.g. '/') are encoded in the API URL."""
+ captured_urls = []
+
+ @contextmanager
+ def capturing_open(url, timeout=None, extra_headers=None):
+ captured_urls.append(url)
+ resp = MagicMock()
+ resp.read.return_value = json.dumps({"assets": []}).encode()
+ yield resp
+
+ resolve_github_release_asset_api_url(
+ "https://github.com/org/repo/releases/download/feature%2Fv1/pack.zip",
+ capturing_open,
+ )
+ # The tag "feature/v1" (decoded from %2F) must be re-encoded as "feature%2Fv1"
+ assert len(captured_urls) == 1
+ assert "releases/tags/feature%2Fv1" in captured_urls[0]
+
+ def test_tag_with_hash_is_url_encoded(self):
+ """Tags with '#' character are properly encoded."""
+ captured_urls = []
+
+ @contextmanager
+ def capturing_open(url, timeout=None, extra_headers=None):
+ captured_urls.append(url)
+ resp = MagicMock()
+ resp.read.return_value = json.dumps({"assets": []}).encode()
+ yield resp
+
+ resolve_github_release_asset_api_url(
+ "https://github.com/org/repo/releases/download/v1%23beta/pack.zip",
+ capturing_open,
+ )
+ assert len(captured_urls) == 1
+ assert "releases/tags/v1%23beta" in captured_urls[0]
\ No newline at end of file
diff --git a/tests/test_presets.py b/tests/test_presets.py
index 380b12861..ecd21a7b6 100644
--- a/tests/test_presets.py
+++ b/tests/test_presets.py
@@ -1528,17 +1528,33 @@ class TestPresetCatalog:
zf.writestr("preset.yml", "id: test-pack\nname: Test\nversion: 1.0.0\n")
zip_bytes = zip_buf.getvalue()
- mock_response = MagicMock()
- mock_response.read.return_value = zip_bytes
- mock_response.__enter__ = lambda s: s
- mock_response.__exit__ = MagicMock(return_value=False)
+ release_response = MagicMock()
+ release_response.read.return_value = json.dumps(
+ {
+ "assets": [
+ {
+ "name": "test-pack.zip",
+ "url": "https://api.github.com/repos/org/repo/releases/assets/1",
+ }
+ ]
+ }
+ ).encode()
+ release_response.__enter__ = lambda s: s
+ release_response.__exit__ = MagicMock(return_value=False)
- captured = {}
+ asset_response = MagicMock()
+ asset_response.read.return_value = zip_bytes
+ asset_response.__enter__ = lambda s: s
+ asset_response.__exit__ = MagicMock(return_value=False)
+
+ captured = []
mock_opener = MagicMock()
def fake_open(req, timeout=None):
- captured["req"] = req
- return mock_response
+ captured.append(req)
+ if req.full_url.endswith("/releases/tags/v1"):
+ return release_response
+ return asset_response
mock_opener.open.side_effect = fake_open
@@ -1554,7 +1570,56 @@ class TestPresetCatalog:
patch("specify_cli.authentication.http.urllib.request.build_opener", return_value=mock_opener):
catalog.download_pack("test-pack", target_dir=project_dir)
- assert captured["req"].get_header("Authorization") == "Bearer ghp_testtoken"
+ assert captured[0].full_url == "https://api.github.com/repos/org/repo/releases/tags/v1"
+ assert captured[0].get_header("Authorization") == "Bearer ghp_testtoken"
+ assert captured[1].full_url == "https://api.github.com/repos/org/repo/releases/assets/1"
+ assert captured[1].get_header("Authorization") == "Bearer ghp_testtoken"
+ assert captured[1].get_header("Accept") == "application/octet-stream"
+
+ def test_download_pack_accepts_direct_github_rest_asset_url(self, project_dir, monkeypatch):
+ """download_pack can use a GitHub REST release asset URL directly."""
+ from unittest.mock import patch, MagicMock
+
+ monkeypatch.setenv("GITHUB_TOKEN", "ghp_testtoken")
+ self._inject_github_config(monkeypatch, token_env="GITHUB_TOKEN")
+ catalog = PresetCatalog(project_dir)
+
+ import io
+ zip_buf = io.BytesIO()
+ with zipfile.ZipFile(zip_buf, "w") as zf:
+ zf.writestr("preset.yml", "id: test-pack\nname: Test\nversion: 1.0.0\n")
+ zip_bytes = zip_buf.getvalue()
+
+ asset_response = MagicMock()
+ asset_response.read.return_value = zip_bytes
+ asset_response.__enter__ = lambda s: s
+ asset_response.__exit__ = MagicMock(return_value=False)
+
+ captured = []
+ mock_opener = MagicMock()
+
+ def fake_open(req, timeout=None):
+ captured.append(req)
+ return asset_response
+
+ mock_opener.open.side_effect = fake_open
+
+ pack_info = {
+ "id": "test-pack",
+ "name": "Test Pack",
+ "version": "1.0.0",
+ "download_url": "https://api.github.com/repos/org/repo/releases/assets/1",
+ "_install_allowed": True,
+ }
+
+ with patch.object(catalog, "get_pack_info", return_value=pack_info), \
+ patch("specify_cli.authentication.http.urllib.request.build_opener", return_value=mock_opener):
+ catalog.download_pack("test-pack", target_dir=project_dir)
+
+ assert len(captured) == 1
+ assert captured[0].full_url == "https://api.github.com/repos/org/repo/releases/assets/1"
+ assert captured[0].get_header("Authorization") == "Bearer ghp_testtoken"
+ assert captured[0].get_header("Accept") == "application/octet-stream"
# ===== Integration Tests =====
@@ -3831,6 +3896,119 @@ class TestBundledPresetLocator:
assert "reinstall" in output, result.output
+class TestPresetAddFromUrlResolution:
+ """CLI-level tests for preset add --from <url> GitHub release resolution."""
+
+ def test_preset_add_from_github_release_url_resolves_and_downloads(self, project_dir):
+ """'preset add --from <github-release-url>' resolves to API asset URL."""
+ from typer.testing import CliRunner
+ from unittest.mock import patch
+ from specify_cli import app
+
+ manifest_content = yaml.dump({
+ "schema_version": "1.0",
+ "preset": {"id": "my-preset", "name": "My Preset", "version": "1.0.0", "description": "Test preset", "author": "Test", "license": "MIT"},
+ "requires": {"speckit_version": ">=0.1.0"},
+ "provides": {"templates": [{"type": "template", "name": "t", "file": "templates/t.md", "description": "t"}]},
+ })
+ zip_buf = __import__("io").BytesIO()
+ with zipfile.ZipFile(zip_buf, "w") as zf:
+ zf.writestr("preset.yml", manifest_content)
+ zip_bytes = zip_buf.getvalue()
+
+ captured_urls = []
+
+ class FakeResponse:
+ def __init__(self, data):
+ self._data = data
+
+ def read(self):
+ return self._data
+
+ def __enter__(self):
+ return self
+
+ def __exit__(self, *a):
+ return False
+
+ def fake_open_url(url, timeout=None, extra_headers=None):
+ captured_urls.append((url, extra_headers))
+ if "releases/tags/" in url:
+ return FakeResponse(json.dumps({
+ "assets": [{"name": "preset.zip", "url": "https://api.github.com/repos/org/repo/releases/assets/42"}]
+ }).encode())
+ return FakeResponse(zip_bytes)
+
+ runner = CliRunner()
+ with patch.object(Path, "cwd", return_value=project_dir), \
+ patch("specify_cli.get_speckit_version", return_value="1.0.0"), \
+ patch("specify_cli.authentication.http.open_url", side_effect=fake_open_url):
+ result = runner.invoke(app, [
+ "preset", "add",
+ "--from", "https://github.com/org/repo/releases/download/v1.0/preset.zip",
+ ])
+
+ assert result.exit_code == 0, result.output
+ assert "My Preset" in result.output
+ # First call should resolve the release tag
+ assert any("releases/tags/v1.0" in url for url, _ in captured_urls)
+ # Second call should download from the resolved asset URL with octet-stream
+ asset_calls = [(url, h) for url, h in captured_urls if "releases/assets/" in url]
+ assert len(asset_calls) >= 1
+ assert asset_calls[0][1] == {"Accept": "application/octet-stream"}
+
+ def test_preset_add_from_direct_api_asset_url_passes_through(self, project_dir):
+ """'preset add --from <api-asset-url>' uses URL directly with octet-stream."""
+ from typer.testing import CliRunner
+ from unittest.mock import patch
+ from specify_cli import app
+
+ manifest_content = yaml.dump({
+ "schema_version": "1.0",
+ "preset": {"id": "my-preset", "name": "My Preset", "version": "1.0.0", "description": "Test preset", "author": "Test", "license": "MIT"},
+ "requires": {"speckit_version": ">=0.1.0"},
+ "provides": {"templates": [{"type": "template", "name": "t", "file": "templates/t.md", "description": "t"}]},
+ })
+ zip_buf = __import__("io").BytesIO()
+ with zipfile.ZipFile(zip_buf, "w") as zf:
+ zf.writestr("preset.yml", manifest_content)
+ zip_bytes = zip_buf.getvalue()
+
+ captured_urls = []
+
+ class FakeResponse:
+ def __init__(self, data):
+ self._data = data
+
+ def read(self):
+ return self._data
+
+ def __enter__(self):
+ return self
+
+ def __exit__(self, *a):
+ return False
+
+ def fake_open_url(url, timeout=None, extra_headers=None):
+ captured_urls.append((url, extra_headers))
+ return FakeResponse(zip_bytes)
+
+ runner = CliRunner()
+ with patch.object(Path, "cwd", return_value=project_dir), \
+ patch("specify_cli.get_speckit_version", return_value="1.0.0"), \
+ patch("specify_cli.authentication.http.open_url", side_effect=fake_open_url):
+ result = runner.invoke(app, [
+ "preset", "add",
+ "--from", "https://api.github.com/repos/org/repo/releases/assets/42",
+ ])
+
+ assert result.exit_code == 0, result.output
+ # Should go directly to the asset URL with Accept header
+ assert len(captured_urls) == 1
+ assert captured_urls[0][0] == "https://api.github.com/repos/org/repo/releases/assets/42"
+ assert captured_urls[0][1] == {"Accept": "application/octet-stream"}
+
+
class TestWrapStrategy:
"""Tests for strategy: wrap preset command substitution."""
diff --git a/tests/test_workflows.py b/tests/test_workflows.py
index 92188e3b7..90f836b2e 100644
--- a/tests/test_workflows.py
+++ b/tests/test_workflows.py
@@ -3681,3 +3681,185 @@ steps:
)
assert result.exit_code == 1
assert "Invalid input format" in result.stdout
+
+
+class TestWorkflowAddUrlResolution:
+ """CLI-level tests for workflow add <url> GitHub release URL resolution."""
+
+ VALID_WORKFLOW_YAML = """
+schema_version: "1.0"
+workflow:
+ id: "test-wf"
+ name: "Test Workflow"
+ version: "1.0.0"
+ description: "A test workflow"
+steps:
+ - id: step-one
+ type: shell
+ run: "echo hello"
+"""
+
+ def test_workflow_add_from_github_release_url_resolves_and_downloads(self, project_dir):
+ """'workflow add <github-release-url>' resolves to API asset URL."""
+ from typer.testing import CliRunner
+ from unittest.mock import patch
+ from specify_cli import app
+
+ captured_urls = []
+
+ class FakeResponse:
+ def __init__(self, data, url=None):
+ self._data = data
+ self._url = url or "https://api.github.com/repos/org/repo/releases/assets/42"
+
+ def read(self):
+ return self._data
+
+ def geturl(self):
+ return self._url
+
+ def __enter__(self):
+ return self
+
+ def __exit__(self, *a):
+ return False
+
+ def fake_open_url(url, timeout=None, extra_headers=None):
+ captured_urls.append((url, extra_headers, timeout))
+ if "releases/tags/" in url:
+ return FakeResponse(json.dumps({
+ "assets": [{"name": "workflow.yml", "url": "https://api.github.com/repos/org/repo/releases/assets/42"}]
+ }).encode())
+ return FakeResponse(self.VALID_WORKFLOW_YAML.encode())
+
+ runner = CliRunner()
+ with patch.object(Path, "cwd", return_value=project_dir), \
+ patch("specify_cli.authentication.http.open_url", side_effect=fake_open_url):
+ result = runner.invoke(app, [
+ "workflow", "add",
+ "https://github.com/org/repo/releases/download/v1.0/workflow.yml",
+ ])
+
+ assert result.exit_code == 0, result.output
+ assert "Test Workflow" in result.output
+ # First call resolves the release tag with timeout=30
+ tag_calls = [(url, h, t) for url, h, t in captured_urls if "releases/tags/" in url]
+ assert len(tag_calls) == 1
+ assert tag_calls[0][2] == 30 # timeout matches download timeout
+ # Second call downloads from the resolved asset URL with octet-stream
+ asset_calls = [(url, h, t) for url, h, t in captured_urls if "releases/assets/" in url]
+ assert len(asset_calls) >= 1
+ assert asset_calls[0][1] == {"Accept": "application/octet-stream"}
+
+ def test_workflow_add_from_direct_api_asset_url_passes_through(self, project_dir):
+ """'workflow add <api-asset-url>' uses URL directly with octet-stream."""
+ from typer.testing import CliRunner
+ from unittest.mock import patch
+ from specify_cli import app
+
+ captured_urls = []
+
+ class FakeResponse:
+ def __init__(self, data, url=None):
+ self._data = data
+ self._url = url or "https://api.github.com/repos/org/repo/releases/assets/42"
+
+ def read(self):
+ return self._data
+
+ def geturl(self):
+ return self._url
+
+ def __enter__(self):
+ return self
+
+ def __exit__(self, *a):
+ return False
+
+ def fake_open_url(url, timeout=None, extra_headers=None):
+ captured_urls.append((url, extra_headers))
+ return FakeResponse(self.VALID_WORKFLOW_YAML.encode())
+
+ runner = CliRunner()
+ with patch.object(Path, "cwd", return_value=project_dir), \
+ patch("specify_cli.authentication.http.open_url", side_effect=fake_open_url):
+ result = runner.invoke(app, [
+ "workflow", "add",
+ "https://api.github.com/repos/org/repo/releases/assets/42",
+ ])
+
+ assert result.exit_code == 0, result.output
+ # Should go directly to the asset URL with Accept header
+ assert len(captured_urls) == 1
+ assert captured_urls[0][0] == "https://api.github.com/repos/org/repo/releases/assets/42"
+ assert captured_urls[0][1] == {"Accept": "application/octet-stream"}
+
+ def test_workflow_add_catalog_based_resolves_github_release_url(self, project_dir):
+ """'workflow add <id>' with catalog GitHub release URL resolves via API."""
+ from typer.testing import CliRunner
+ from unittest.mock import patch
+ from specify_cli import app
+
+ captured_urls = []
+
+ class FakeResponse:
+ def __init__(self, data, url=None):
+ self._data = data
+ self._url = url or "https://api.github.com/repos/org/repo/releases/assets/55"
+
+ def read(self):
+ return self._data
+
+ def geturl(self):
+ return self._url
+
+ def __enter__(self):
+ return self
+
+ def __exit__(self, *a):
+ return False
+
+ def fake_open_url(url, timeout=None, extra_headers=None):
+ captured_urls.append((url, extra_headers))
+ if "releases/tags/" in url:
+ return FakeResponse(json.dumps({
+ "assets": [{"name": "workflow.yml", "url": "https://api.github.com/repos/org/repo/releases/assets/55"}]
+ }).encode())
+ # Use workflow YAML with id matching catalog key
+ wf_yaml = """
+schema_version: "1.0"
+workflow:
+ id: "my-wf"
+ name: "My Workflow"
+ version: "1.0.0"
+ description: "A catalog workflow"
+steps:
+ - id: step-one
+ type: shell
+ run: "echo hello"
+"""
+ return FakeResponse(wf_yaml.encode())
+
+ fake_catalog_info = {
+ "id": "my-wf",
+ "name": "My Workflow",
+ "version": "1.0.0",
+ "url": "https://github.com/org/repo/releases/download/v2.0/workflow.yml",
+ "_install_allowed": True,
+ }
+
+ runner = CliRunner()
+ with patch.object(Path, "cwd", return_value=project_dir), \
+ patch("specify_cli.authentication.http.open_url", side_effect=fake_open_url), \
+ patch("specify_cli.workflows.catalog.WorkflowCatalog.get_workflow_info", return_value=fake_catalog_info):
+ result = runner.invoke(app, ["workflow", "add", "my-wf"])
+
+ assert result.exit_code == 0, result.output
+ # Should resolve via releases/tags API
+ tag_calls = [url for url, _ in captured_urls if "releases/tags/" in url]
+ assert len(tag_calls) == 1
+ assert "releases/tags/v2.0" in tag_calls[0]
+ # Should download from resolved asset URL with octet-stream
+ asset_calls = [(url, h) for url, h in captured_urls if "releases/assets/" in url]
+ assert len(asset_calls) >= 1
+ assert asset_calls[0][1] == {"Accept": "application/octet-stream"}