refactor(mirror): enforce primary origin URL and align mirror resolution logic
Some checks failed
Mark stable commit / test-unit (push) Has been cancelled
Mark stable commit / test-integration (push) Has been cancelled
Mark stable commit / test-env-virtual (push) Has been cancelled
Mark stable commit / test-env-nix (push) Has been cancelled
Mark stable commit / test-e2e (push) Has been cancelled
Mark stable commit / test-virgin-user (push) Has been cancelled
Mark stable commit / test-virgin-root (push) Has been cancelled
Mark stable commit / linter-shell (push) Has been cancelled
Mark stable commit / linter-python (push) Has been cancelled
Mark stable commit / mark-stable (push) Has been cancelled

- Resolve primary remote via RepoMirrorContext (origin → file order → config → default)
- Always set origin fetch and push URL to primary
- Add additional mirrors as extra push URLs without duplication
- Update remote provisioning and setup commands to use context-based resolution
- Adjust and extend unit tests to cover new origin/push behavior

https://chatgpt.com/share/693f4538-42d4-800f-98c2-2ec264fd2e19
This commit is contained in:
Kevin Veen-Birkenbach
2025-12-15 00:16:04 +01:00
parent 48a0d1d458
commit 1a13fcaa4e
6 changed files with 246 additions and 344 deletions

View File

@@ -1,20 +1,15 @@
from __future__ import annotations
import os
from typing import List, Optional, Set
from pkgmgr.core.command.run import run_command
from pkgmgr.core.git import GitError, run_git
from typing import List, Optional, Set
from .types import MirrorMap, RepoMirrorContext, Repository
def build_default_ssh_url(repo: Repository) -> Optional[str]:
"""
Build a simple SSH URL from repo config if no explicit mirror is defined.
Example: git@github.com:account/repository.git
"""
provider = repo.get("provider")
account = repo.get("account")
name = repo.get("repository")
@@ -23,95 +18,82 @@ def build_default_ssh_url(repo: Repository) -> Optional[str]:
if not provider or not account or not name:
return None
provider = str(provider)
account = str(account)
name = str(name)
if port:
return f"ssh://git@{provider}:{port}/{account}/{name}.git"
# GitHub-style shorthand
return f"git@{provider}:{account}/{name}.git"
def determine_primary_remote_url(
repo: Repository,
resolved_mirrors: MirrorMap,
ctx: RepoMirrorContext,
) -> Optional[str]:
"""
Determine the primary remote URL in a consistent way:
1. resolved_mirrors["origin"]
2. any resolved mirror (first by name)
3. default SSH URL from provider/account/repository
Priority order:
1. origin from resolved mirrors
2. MIRRORS file order
3. config mirrors order
4. default SSH URL
"""
if "origin" in resolved_mirrors:
return resolved_mirrors["origin"]
resolved = ctx.resolved_mirrors
if resolved_mirrors:
first_name = sorted(resolved_mirrors.keys())[0]
return resolved_mirrors[first_name]
if resolved.get("origin"):
return resolved["origin"]
for mirrors in (ctx.file_mirrors, ctx.config_mirrors):
for _, url in mirrors.items():
if url:
return url
return build_default_ssh_url(repo)
def _safe_git_output(args: List[str], cwd: str) -> Optional[str]:
"""
Run a Git command via run_git and return its stdout, or None on failure.
"""
try:
return run_git(args, cwd=cwd)
except GitError:
return None
def current_origin_url(repo_dir: str) -> Optional[str]:
"""
Return the current URL for remote 'origin', or None if not present.
"""
output = _safe_git_output(["remote", "get-url", "origin"], cwd=repo_dir)
if not output:
return None
url = output.strip()
return url or None
def has_origin_remote(repo_dir: str) -> bool:
"""
Check whether a remote called 'origin' exists in the repository.
"""
output = _safe_git_output(["remote"], cwd=repo_dir)
if not output:
return False
names = output.split()
return "origin" in names
out = _safe_git_output(["remote"], cwd=repo_dir)
return bool(out and "origin" in out.split())
def _ensure_push_urls_for_origin(
def _set_origin_fetch_and_push(repo_dir: str, url: str, preview: bool) -> None:
fetch = f"git remote set-url origin {url}"
push = f"git remote set-url --push origin {url}"
if preview:
print(f"[PREVIEW] Would run in {repo_dir!r}: {fetch}")
print(f"[PREVIEW] Would run in {repo_dir!r}: {push}")
return
run_command(fetch, cwd=repo_dir, preview=False)
run_command(push, cwd=repo_dir, preview=False)
def _ensure_additional_push_urls(
repo_dir: str,
mirrors: MirrorMap,
primary: str,
preview: bool,
) -> None:
"""
Ensure that all mirror URLs are present as push URLs on 'origin'.
"""
desired: Set[str] = {url for url in mirrors.values() if url}
desired: Set[str] = {u for u in mirrors.values() if u and u != primary}
if not desired:
return
existing_output = _safe_git_output(
out = _safe_git_output(
["remote", "get-url", "--push", "--all", "origin"],
cwd=repo_dir,
)
existing = set(existing_output.splitlines()) if existing_output else set()
existing = set(out.splitlines()) if out else set()
missing = sorted(desired - existing)
for url in missing:
for url in sorted(desired - existing):
cmd = f"git remote set-url --add --push origin {url}"
if preview:
print(f"[PREVIEW] Would run in {repo_dir!r}: {cmd}")
else:
print(f"[INFO] Adding push URL to 'origin': {url}")
run_command(cmd, cwd=repo_dir, preview=False)
@@ -120,60 +102,32 @@ def ensure_origin_remote(
ctx: RepoMirrorContext,
preview: bool,
) -> None:
"""
Ensure that a usable 'origin' remote exists and has all push URLs.
"""
repo_dir = ctx.repo_dir
resolved_mirrors = ctx.resolved_mirrors
if not os.path.isdir(os.path.join(repo_dir, ".git")):
print(f"[WARN] {repo_dir} is not a Git repository (no .git directory).")
print(f"[WARN] {repo_dir} is not a Git repository.")
return
url = determine_primary_remote_url(repo, resolved_mirrors)
primary = determine_primary_remote_url(repo, ctx)
if not primary:
print("[WARN] No primary mirror URL could be determined.")
return
if not has_origin_remote(repo_dir):
if not url:
print(
"[WARN] Could not determine URL for 'origin' remote. "
"Please configure mirrors or provider/account/repository."
)
return
cmd = f"git remote add origin {url}"
cmd = f"git remote add origin {primary}"
if preview:
print(f"[PREVIEW] Would run in {repo_dir!r}: {cmd}")
else:
print(f"[INFO] Adding 'origin' remote in {repo_dir}: {url}")
run_command(cmd, cwd=repo_dir, preview=False)
else:
current = current_origin_url(repo_dir)
if current == url or not url:
print(
"[INFO] 'origin' already points to "
f"{current or '<unknown>'} (no change needed)."
)
else:
# We do not auto-change origin here, only log the mismatch.
print(
"[INFO] 'origin' exists with URL "
f"{current or '<unknown>'}; not changing to {url}."
)
# Ensure all mirrors are present as push URLs
_ensure_push_urls_for_origin(repo_dir, resolved_mirrors, preview)
_set_origin_fetch_and_push(repo_dir, primary, preview)
_ensure_additional_push_urls(repo_dir, ctx.resolved_mirrors, primary, preview)
def is_remote_reachable(url: str, cwd: Optional[str] = None) -> bool:
"""
Check whether a remote repository is reachable via `git ls-remote`.
This does NOT modify anything; it only probes the remote.
"""
workdir = cwd or os.getcwd()
try:
# --exit-code → non-zero exit code if the remote does not exist
run_git(["ls-remote", "--exit-code", url], cwd=workdir)
run_git(["ls-remote", "--exit-code", url], cwd=cwd or os.getcwd())
return True
except GitError:
return False

View File

@@ -1,4 +1,3 @@
# src/pkgmgr/actions/mirror/remote_provision.py
from __future__ import annotations
from typing import List
@@ -19,36 +18,28 @@ def ensure_remote_repository(
preview: bool,
) -> None:
ctx = build_context(repo, repositories_base_dir, all_repos)
resolved_mirrors = ctx.resolved_mirrors
primary_url = determine_primary_remote_url(repo, resolved_mirrors)
primary_url = determine_primary_remote_url(repo, ctx)
if not primary_url:
print("[INFO] No remote URL could be derived; skipping remote provisioning.")
print("[INFO] No primary URL found; skipping remote provisioning.")
return
host_raw, owner_from_url, name_from_url = parse_repo_from_git_url(primary_url)
host_raw, owner, name = parse_repo_from_git_url(primary_url)
host = normalize_provider_host(host_raw)
if not host or not owner_from_url or not name_from_url:
print("[WARN] Could not derive host/owner/repository from URL; cannot ensure remote repo.")
print(f" url={primary_url!r}")
print(f" host={host!r}, owner={owner_from_url!r}, repository={name_from_url!r}")
if not host or not owner or not name:
print("[WARN] Could not parse remote URL:", primary_url)
return
print("------------------------------------------------------------")
print(f"[REMOTE ENSURE] {ctx.identifier}")
print(f"[REMOTE ENSURE] host: {host}")
print("------------------------------------------------------------")
spec = RepoSpec(
host=str(host),
owner=str(owner_from_url),
name=str(name_from_url),
host=host,
owner=owner,
name=name,
private=bool(repo.get("private", True)),
description=str(repo.get("description", "")),
)
provider_kind = str(repo.get("provider", "")).strip().lower() or None
provider_kind = str(repo.get("provider", "")).lower() or None
try:
result = ensure_remote_repo(
@@ -66,5 +57,3 @@ def ensure_remote_repository(
print(f"[REMOTE ENSURE] URL: {result.url}")
except Exception as exc: # noqa: BLE001
print(f"[ERROR] Remote provisioning failed: {exc}")
print()

View File

@@ -1,4 +1,3 @@
# src/pkgmgr/actions/mirror/setup_cmd.py
from __future__ import annotations
from typing import List
@@ -9,6 +8,7 @@ from .remote_check import probe_mirror
from .remote_provision import ensure_remote_repository
from .types import Repository
def _setup_local_mirrors_for_repo(
repo: Repository,
repositories_base_dir: str,
@@ -22,7 +22,7 @@ def _setup_local_mirrors_for_repo(
print(f"[MIRROR SETUP:LOCAL] dir: {ctx.repo_dir}")
print("------------------------------------------------------------")
ensure_origin_remote(repo, ctx, preview=preview)
ensure_origin_remote(repo, ctx, preview)
print()
@@ -34,7 +34,6 @@ def _setup_remote_mirrors_for_repo(
ensure_remote: bool,
) -> None:
ctx = build_context(repo, repositories_base_dir, all_repos)
resolved_mirrors = ctx.resolved_mirrors
print("------------------------------------------------------------")
print(f"[MIRROR SETUP:REMOTE] {ctx.identifier}")
@@ -44,37 +43,28 @@ def _setup_remote_mirrors_for_repo(
if ensure_remote:
ensure_remote_repository(
repo,
repositories_base_dir=repositories_base_dir,
all_repos=all_repos,
preview=preview,
repositories_base_dir,
all_repos,
preview,
)
if not resolved_mirrors:
primary_url = determine_primary_remote_url(repo, resolved_mirrors)
if not primary_url:
print("[INFO] No mirrors configured and no primary URL available.")
print()
if not ctx.resolved_mirrors:
primary = determine_primary_remote_url(repo, ctx)
if not primary:
return
ok, error_message = probe_mirror(primary_url, ctx.repo_dir)
if ok:
print(f"[OK] primary: {primary_url}")
else:
print(f"[WARN] primary: {primary_url}")
for line in error_message.splitlines():
print(f" {line}")
ok, msg = probe_mirror(primary, ctx.repo_dir)
print("[OK]" if ok else "[WARN]", primary)
if msg:
print(msg)
print()
return
for name, url in sorted(resolved_mirrors.items()):
ok, error_message = probe_mirror(url, ctx.repo_dir)
if ok:
print(f"[OK] {name}: {url}")
else:
print(f"[WARN] {name}: {url}")
for line in error_message.splitlines():
print(f" {line}")
for name, url in ctx.resolved_mirrors.items():
ok, msg = probe_mirror(url, ctx.repo_dir)
print(f"[OK] {name}: {url}" if ok else f"[WARN] {name}: {url}")
if msg:
print(msg)
print()
@@ -91,17 +81,17 @@ def setup_mirrors(
for repo in selected_repos:
if local:
_setup_local_mirrors_for_repo(
repo=repo,
repositories_base_dir=repositories_base_dir,
all_repos=all_repos,
preview=preview,
repo,
repositories_base_dir,
all_repos,
preview,
)
if remote:
_setup_remote_mirrors_for_repo(
repo=repo,
repositories_base_dir=repositories_base_dir,
all_repos=all_repos,
preview=preview,
ensure_remote=ensure_remote,
repo,
repositories_base_dir,
all_repos,
preview,
ensure_remote,
)