github2gerrit 0.1.4__py3-none-any.whl → 0.1.6__py3-none-any.whl

github2gerrit/gerrit_urls.py

@@ -0,0 +1,256 @@
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: 2025 The Linux Foundation
+"""
+Centralized Gerrit URL construction utilities.
+
+This module provides a unified way to construct Gerrit URLs, ensuring
+consistent handling of GERRIT_HTTP_BASE_PATH and eliminating the need
+for manual URL construction throughout the codebase.
+"""
+
+from __future__ import annotations
+
+import logging
+import os
+from urllib.parse import urljoin
+
+
+log = logging.getLogger(__name__)
+
+
+class GerritUrlBuilder:
+    """
+    Centralized builder for Gerrit URLs with consistent base path handling.
+
+    This class encapsulates all Gerrit URL construction logic, ensuring that
+    GERRIT_HTTP_BASE_PATH is properly handled in all contexts. It provides
+    methods for building different types of URLs (API, web, hooks) and handles
+    the common fallback patterns used throughout the application.
+    """
+
+    def __init__(self, host: str, base_path: str | None = None):
+        """
+        Initialize the URL builder for a specific Gerrit host.
+
+        Args:
+            host: Gerrit hostname (without protocol)
+            base_path: Optional base path override. If None, reads from
+                      GERRIT_HTTP_BASE_PATH environment variable.
+        """
+        self.host = host.strip()
+
+        # Normalize base path - remove leading/trailing slashes and whitespace
+        if base_path is not None:
+            self._base_path = base_path.strip().strip("/")
+        else:
+            self._base_path = os.getenv("GERRIT_HTTP_BASE_PATH", "").strip().strip("/")
+
+        log.debug(
+            "GerritUrlBuilder initialized for host=%s, base_path='%s'",
+            self.host,
+            self._base_path,
+        )
+
+    @property
+    def base_path(self) -> str:
+        """Get the normalized base path."""
+        return self._base_path
+
+    @property
+    def has_base_path(self) -> bool:
+        """Check if a base path is configured."""
+        return bool(self._base_path)
+
+    def _build_base_url(self, base_path_override: str | None = None) -> str:
+        """
+        Build the base URL with optional base path override.
+
+        Args:
+            base_path_override: Optional base path to use instead of the instance default
+
+        Returns:
+            Base URL with trailing slash
+        """
+        path = base_path_override if base_path_override is not None else self._base_path
+        if path:
+            return f"https://{self.host}/{path}/"
+        else:
+            return f"https://{self.host}/"
+
+    def api_url(self, endpoint: str = "", base_path_override: str | None = None) -> str:
+        """
+        Build a Gerrit REST API URL.
+
+        Args:
+            endpoint: API endpoint path (e.g., "/changes/", "/accounts/self")
+            base_path_override: Optional base path override for fallback scenarios
+
+        Returns:
+            Complete API URL
+        """
+        base_url = self._build_base_url(base_path_override)
+        # Ensure endpoint starts with / for proper URL joining
+        if endpoint and not endpoint.startswith("/"):
+            endpoint = "/" + endpoint
+        return urljoin(base_url, endpoint.lstrip("/"))
+
+    def web_url(self, path: str = "", base_path_override: str | None = None) -> str:
+        """
+        Build a Gerrit web UI URL.
+
+        Args:
+            path: Web path (e.g., "c/project/+/123", "dashboard")
+            base_path_override: Optional base path override for fallback scenarios
+
+        Returns:
+            Complete web URL
+        """
+        base_url = self._build_base_url(base_path_override)
+        if path:
+            # Remove leading slash if present to avoid double slashes
+            path = path.lstrip("/")
+            return urljoin(base_url, path)
+        return base_url.rstrip("/")
+
+    def change_url(
+        self,
+        project: str,
+        change_number: int,
+        base_path_override: str | None = None,
+    ) -> str:
+        """
+        Build a URL for a specific Gerrit change.
+
+        Args:
+            project: Gerrit project name
+            change_number: Gerrit change number
+            base_path_override: Optional base path override for fallback scenarios
+
+        Returns:
+            Complete change URL
+        """
+        # Don't URL-encode project names - Gerrit expects them as-is (backward compatibility)
+        path = f"c/{project}/+/{change_number}"
+        return self.web_url(path, base_path_override)
+
+    def hook_url(self, hook_name: str, base_path_override: str | None = None) -> str:
+        """
+        Build a URL for downloading Gerrit hooks.
+
+        Args:
+            hook_name: Name of the hook (e.g., "commit-msg")
+            base_path_override: Optional base path override for fallback scenarios
+
+        Returns:
+            Complete hook download URL
+        """
+        path = f"tools/hooks/{hook_name}"
+        return self.web_url(path, base_path_override)
+
+    def get_api_url_candidates(self, endpoint: str = "") -> list[str]:
+        """
+        Get a list of candidate API URLs for fallback scenarios.
+
+        This method returns URLs in order of preference:
+        1. URL with configured base path (if any)
+        2. URL with /r/ base path (common fallback)
+        3. URL with no base path (root)
+
+        Args:
+            endpoint: API endpoint path
+
+        Returns:
+            List of candidate URLs to try
+        """
+        candidates = []
+
+        # Primary URL with configured base path
+        if self.has_base_path:
+            candidates.append(self.api_url(endpoint))
+
+        # Common fallback: /r/ base path
+        if self._base_path != "r":
+            candidates.append(self.api_url(endpoint, base_path_override="r"))
+
+        # Final fallback: no base path
+        if self.has_base_path:
+            candidates.append(self.api_url(endpoint, base_path_override=""))
+
+        # If no base path was configured, add the primary URL
+        if not self.has_base_path:
+            candidates.append(self.api_url(endpoint))
+
+        return candidates
+
+    def get_hook_url_candidates(self, hook_name: str) -> list[str]:
+        """
+        Get a list of candidate hook URLs for fallback scenarios.
+
+        This method returns URLs in order of preference for downloading hooks:
+        1. URL with configured base path (if any)
+        2. URL with /r/ base path (common for hooks)
+        3. URL with no base path (root)
+
+        Args:
+            hook_name: Name of the hook to download
+
+        Returns:
+            List of candidate URLs to try
+        """
+        candidates = []
+
+        # Primary URL with configured base path
+        if self.has_base_path:
+            candidates.append(self.hook_url(hook_name))
+
+        # Common fallback: /r/ base path (very common for hooks)
+        if self._base_path != "r":
+            candidates.append(self.hook_url(hook_name, base_path_override="r"))
+
+        # Final fallback: no base path
+        if self.has_base_path:
+            candidates.append(self.hook_url(hook_name, base_path_override=""))
+
+        # If no base path was configured, add the primary URL
+        if not self.has_base_path:
+            candidates.append(self.hook_url(hook_name))
+
+        return candidates
+
+    def get_web_base_path(self, base_path_override: str | None = None) -> str:
+        """
+        Get the web base path for URL construction.
+
+        This is useful when you need just the path component for manual URL building.
+
+        Args:
+            base_path_override: Optional base path override
+
+        Returns:
+            Web base path with leading and trailing slashes (e.g., "/r/", "/")
+        """
+        path = base_path_override if base_path_override is not None else self._base_path
+        if path:
+            return f"/{path}/"
+        else:
+            return "/"
+
+    def __repr__(self) -> str:
+        """String representation for debugging."""
+        return f"GerritUrlBuilder(host='{self.host}', base_path='{self._base_path}')"
+
+
+def create_gerrit_url_builder(host: str, base_path: str | None = None) -> GerritUrlBuilder:
+    """
+    Factory function to create a GerritUrlBuilder instance.
+
+    This is the preferred way to create URL builders throughout the application.
+
+    Args:
+        host: Gerrit hostname
+        base_path: Optional base path override
+
+    Returns:
+        Configured GerritUrlBuilder instance
+    """
+    return GerritUrlBuilder(host, base_path)

github2gerrit/github_api.py

@@ -30,6 +30,12 @@ from typing import TypeVar
 from typing import cast
 
 
+# Error message constants to comply with TRY003
+_MSG_PYGITHUB_REQUIRED = "PyGithub required"
+_MSG_MISSING_GITHUB_TOKEN = "missing GITHUB_TOKEN"  # noqa: S105
+_MSG_BAD_GITHUB_REPOSITORY = "bad GITHUB_REPOSITORY"
+
+
 class GithubExceptionType(Exception):
     pass
 
@@ -38,9 +44,7 @@ class RateLimitExceededExceptionType(GithubExceptionType):
     pass
 
 
-def _load_github_classes() -> tuple[
-    Any | None, type[BaseException], type[BaseException]
-]:
+def _load_github_classes() -> tuple[Any | None, type[BaseException], type[BaseException]]:
     try:
         exc_mod = import_module("github.GithubException")
         ge = exc_mod.GithubException
@@ -65,7 +69,7 @@ else:
 
     class Github:  # type: ignore[no-redef]
         def __init__(self, *args: Any, **kwargs: Any) -> None:
-            raise RuntimeError("PyGithub required")  # noqa: TRY003
+            raise RuntimeError(_MSG_PYGITHUB_REQUIRED)
 
 
 class GhIssueComment(Protocol):
@@ -171,8 +175,7 @@ def _retry_on_github(
                         raise
                     delay = _backoff_delay(attempt)
                     log.warning(
-                        "GitHub call failed (attempt %d): %s; retrying in "
-                        "%.2fs",
+                        "GitHub call failed (attempt %d): %s; retrying in %.2fs",
                         attempt,
                         exc,
                         delay,
@@ -201,7 +204,7 @@ def build_client(token: str | None = None) -> GhClient:
     """
     tok = token or _getenv_str("GITHUB_TOKEN")
     if not tok:
-        raise ValueError("missing GITHUB_TOKEN")  # noqa: TRY003
+        raise ValueError(_MSG_MISSING_GITHUB_TOKEN)
     # per_page improves pagination; adjust as needed.
     base_url = _getenv_str("GITHUB_API_URL")
     if not base_url:
@@ -215,23 +218,17 @@ def build_client(token: str | None = None) -> GhClient:
         if auth_factory is not None and hasattr(auth_factory, "Token"):
             auth_obj = auth_factory.Token(tok)
             if base_url:
-                client_any = Github(
-                    auth=auth_obj, per_page=100, base_url=base_url
-                )
+                client_any = Github(auth=auth_obj, per_page=100, base_url=base_url)
             else:
                 client_any = Github(auth=auth_obj, per_page=100)
         else:
             if base_url:
-                client_any = Github(
-                    login_or_token=tok, per_page=100, base_url=base_url
-                )
+                client_any = Github(login_or_token=tok, per_page=100, base_url=base_url)
             else:
                 client_any = Github(login_or_token=tok, per_page=100)
     except Exception:
         if base_url:
-            client_any = Github(
-                login_or_token=tok, per_page=100, base_url=base_url
-            )
+            client_any = Github(login_or_token=tok, per_page=100, base_url=base_url)
         else:
             client_any = Github(login_or_token=tok, per_page=100)
     return cast(GhClient, client_any)
@@ -242,7 +239,7 @@ def get_repo_from_env(client: GhClient) -> GhRepository:
     """Return the repository object based on GITHUB_REPOSITORY."""
     full = _getenv_str("GITHUB_REPOSITORY")
     if not full or "/" not in full:
-        raise ValueError("bad GITHUB_REPOSITORY")  # noqa: TRY003
+        raise ValueError(_MSG_BAD_GITHUB_REPOSITORY)
     repo = client.get_repo(full)
     return repo
 
@@ -327,7 +324,5 @@ def close_pr(pr: GhPullRequest, *, comment: str | None = None) -> None:
         try:
             create_pr_comment(pr, comment)
         except Exception as exc:
-            log.warning(
-                "Failed to add close comment to PR #%s: %s", pr.number, exc
-            )
+            log.warning("Failed to add close comment to PR #%s: %s", pr.number, exc)
     pr.edit(state="closed")

github2gerrit/gitutils.py

@@ -20,6 +20,20 @@ from collections.abc import Mapping
 from collections.abc import Sequence
 from dataclasses import dataclass
 from pathlib import Path
+from typing import Any
+
+
+def _is_verbose_mode() -> bool:
+    """Check if verbose mode is enabled via environment variable."""
+    return os.getenv("G2G_VERBOSE", "").lower() in ("true", "1", "yes")
+
+
+def _log_exception_conditionally(logger: logging.Logger, message: str, *args: Any) -> None:
+    """Log exception with traceback only if verbose mode is enabled."""
+    if _is_verbose_mode():
+        logger.exception(message, *args)
+    else:
+        logger.error(message, *args)
 
 
 __all__ = [
@@ -41,6 +55,9 @@ __all__ = [
     "run_cmd_with_retries",
 ]
 
+# Error message constants to comply with TRY003
+_MSG_COMMIT_NO_MESSAGE = "Either message or message_file must be provided"
+
 
 _LOGGER_NAME = "github2gerrit.git"
 log = logging.getLogger(_LOGGER_NAME)
@@ -48,10 +65,7 @@ if not log.handlers:
     # Provide a minimal default if the app has not configured logging.
     level_name = os.getenv("G2G_LOG_LEVEL", "INFO").upper()
     level = getattr(logging, level_name, logging.INFO)
-    fmt = (
-        "%(asctime)s %(levelname)-8s %(name)s "
-        "%(filename)s:%(lineno)d | %(message)s"
-    )
+    fmt = "%(asctime)s %(levelname)-8s %(name)s %(filename)s:%(lineno)d | %(message)s"
     logging.basicConfig(level=level, format=fmt)
 
 
@@ -170,6 +184,7 @@ def run_cmd(
     - Raises CommandError on failure when check=True.
     """
     masks = list(masks or [])
+    env = env or non_interactive_env()
     env_full = _merge_env(None, env)
 
     log.debug("Executing: %s", _format_cmd_for_log(cmd, masks))
@@ -187,7 +202,7 @@ def run_cmd(
         )
     except subprocess.TimeoutExpired as exc:
         msg = f"Command timed out: {cmd!r}"
-        log.exception(msg)
+        _log_exception_conditionally(log, msg)
         # TimeoutExpired carries 'output' and 'stderr' attributes,
         # which may be bytes depending on invocation context.
         out = getattr(exc, "output", None)
@@ -201,7 +216,7 @@ def run_cmd(
         ) from exc
     except OSError as exc:
         msg = f"Failed to execute command: {cmd!r} ({exc})"
-        log.exception(msg)
+        _log_exception_conditionally(log, msg)
         raise CommandError(msg, cmd=cmd) from exc
 
     result = CommandResult(
@@ -235,6 +250,29 @@ def run_cmd(
     return result
 
 
+def non_interactive_env() -> dict[str, str]:
+    """Return a non-interactive SSH/Git environment to bypass local
+    agents/keychains."""
+    return {
+        "GIT_SSH_COMMAND": (
+            "ssh -F /dev/null "
+            "-o IdentitiesOnly=yes "
+            "-o IdentityAgent=none "
+            "-o BatchMode=yes "
+            "-o PreferredAuthentications=publickey "
+            "-o StrictHostKeyChecking=yes "
+            "-o PasswordAuthentication=no "
+            "-o PubkeyAcceptedKeyTypes=+ssh-rsa "
+            "-o ConnectTimeout=10"
+        ),
+        "SSH_AUTH_SOCK": "",
+        "SSH_AGENT_PID": "",
+        "SSH_ASKPASS": "/usr/bin/false",
+        "DISPLAY": "",
+        "SSH_ASKPASS_REQUIRE": "never",
+    }
+
+
 def run_cmd_with_retries(
     cmd: Sequence[str],
     *,
@@ -252,6 +290,7 @@ def run_cmd_with_retries(
     The default retry predicate considers common transient git errors.
     """
     masks = list(masks or [])
+    env = env or non_interactive_env()
 
     def _default_retry_on(res: CommandResult) -> bool:
         return res.returncode != 0 and _is_transient_git_error(res.stderr)
@@ -289,8 +328,7 @@ def run_cmd_with_retries(
         if predicate(res):
             delay = _backoff_delay(attempt)
             log.warning(
-                "Retrying (attempt %d) after transient error; delay %.1fs. "
-                "cmd=%s",
+                "Retrying (attempt %d) after transient error; delay %.1fs. cmd=%s",
                 attempt,
                 delay,
                 _format_cmd_for_log(cmd, masks),
@@ -351,7 +389,7 @@ def git_quiet(
         return run_cmd(
             cmd,
             cwd=cwd,
-            env=env,
+            env=env or non_interactive_env(),
             timeout=timeout,
             check=False,
         )
@@ -471,7 +509,7 @@ def git_commit_new(
 ) -> None:
     """Create a new commit using message or message_file."""
     if not message and not message_file:
-        raise ValueError("Either message or message_file must be provided")  # noqa: TRY003
+        raise ValueError(_MSG_COMMIT_NO_MESSAGE)
 
     args: list[str] = ["commit"]
     if signoff:
@@ -599,9 +637,7 @@ def git_config_get_all(
     try:
         res = git_quiet(args, cwd=None)
         if res.returncode == 0:
-            values = [
-                ln.strip() for ln in res.stdout.splitlines() if ln.strip()
-            ]
+            values = [ln.strip() for ln in res.stdout.splitlines() if ln.strip()]
             return values
         else:
             return []

github2gerrit/models.py

@@ -52,6 +52,7 @@ class Inputs:
     gerrit_project: str
     issue_id: str
     allow_duplicates: bool
+    duplicates_filter: str = "open"
 
 
 @dataclass(frozen=True)