github2gerrit 0.1.5__py3-none-any.whl → 0.1.7__py3-none-any.whl

github2gerrit/ssh_discovery.py

@@ -16,6 +16,8 @@ import os
 import socket
 from pathlib import Path
 
+from .external_api import ApiType
+from .external_api import external_api_call
 from .gitutils import CommandError
 from .gitutils import run_cmd
 
@@ -28,31 +30,17 @@ class SSHDiscoveryError(Exception):
 
 
 # Error message constants to comply with TRY003
-_MSG_HOST_UNREACHABLE = (
-    "Host {hostname}:{port} is not reachable. "
-    "Check network connectivity and server availability."
-)
+_MSG_HOST_UNREACHABLE = "Host {hostname}:{port} is not reachable. Check network connectivity and server availability."
 _MSG_NO_KEYS_FOUND = (
-    "No SSH host keys found for {hostname}:{port}. "
-    "The server may not be running SSH or may be blocking connections."
+    "No SSH host keys found for {hostname}:{port}. The server may not be running SSH or may be blocking connections."
 )
 _MSG_NO_VALID_KEYS = (
-    "No valid SSH host keys found for {hostname}:{port}. "
-    "The ssh-keyscan output was empty or malformed."
-)
-_MSG_CONNECTION_FAILED = (
-    "Failed to connect to {hostname}:{port} for SSH key discovery. "
-    "Error: {error}"
-)
-_MSG_KEYSCAN_FAILED = (
-    "ssh-keyscan failed with return code {returncode}: {error}"
-)
-_MSG_UNEXPECTED_ERROR = (
-    "Unexpected error during SSH key discovery for {hostname}:{port}: {error}"
-)
-_MSG_SAVE_FAILED = (
-    "Failed to save host keys to configuration file {config_file}: {error}"
+    "No valid SSH host keys found for {hostname}:{port}. The ssh-keyscan output was empty or malformed."
 )
+_MSG_CONNECTION_FAILED = "Failed to connect to {hostname}:{port} for SSH key discovery. Error: {error}"
+_MSG_KEYSCAN_FAILED = "ssh-keyscan failed with return code {returncode}: {error}"
+_MSG_UNEXPECTED_ERROR = "Unexpected error during SSH key discovery for {hostname}:{port}: {error}"
+_MSG_SAVE_FAILED = "Failed to save host keys to configuration file {config_file}: {error}"
 
 
 def is_host_reachable(hostname: str, port: int, timeout: int = 5) -> bool:
@@ -64,9 +52,8 @@ def is_host_reachable(hostname: str, port: int, timeout: int = 5) -> bool:
         return False
 
 
-def fetch_ssh_host_keys(
-    hostname: str, port: int = 22, timeout: int = 10
-) -> str:
+@external_api_call(ApiType.SSH, "fetch_ssh_host_keys")
+def fetch_ssh_host_keys(hostname: str, port: int = 22, timeout: int = 10) -> str:
     """
     Fetch SSH host keys for a given hostname and port using ssh-keyscan.
 
@@ -85,9 +72,7 @@ def fetch_ssh_host_keys(
 
     # First check if the host is reachable
     if not is_host_reachable(hostname, port, timeout=5):
-        raise SSHDiscoveryError(
-            _MSG_HOST_UNREACHABLE.format(hostname=hostname, port=port)
-        )
+        raise SSHDiscoveryError(_MSG_HOST_UNREACHABLE.format(hostname=hostname, port=port))
 
     try:
         # Use ssh-keyscan to fetch all available key types
@@ -142,23 +127,13 @@ def fetch_ssh_host_keys(
             # ssh-keyscan returns 1 when it can't connect
             error_msg = exc.stderr or exc.stdout or "Connection failed"
             raise SSHDiscoveryError(
-                _MSG_CONNECTION_FAILED.format(
-                    hostname=hostname, port=port, error=error_msg
-                )
+                _MSG_CONNECTION_FAILED.format(hostname=hostname, port=port, error=error_msg)
             ) from exc
         else:
             error_msg = exc.stderr or exc.stdout or "Unknown error"
-            raise SSHDiscoveryError(
-                _MSG_KEYSCAN_FAILED.format(
-                    returncode=exc.returncode, error=error_msg
-                )
-            ) from exc
+            raise SSHDiscoveryError(_MSG_KEYSCAN_FAILED.format(returncode=exc.returncode, error=error_msg)) from exc
     except Exception as exc:
-        raise SSHDiscoveryError(
-            _MSG_UNEXPECTED_ERROR.format(
-                hostname=hostname, port=port, error=exc
-            )
-        ) from exc
+        raise SSHDiscoveryError(_MSG_UNEXPECTED_ERROR.format(hostname=hostname, port=port, error=exc)) from exc
     else:
         return discovered_keys
 
@@ -196,9 +171,8 @@ def extract_gerrit_info_from_gitreview(content: str) -> tuple[str, int] | None:
     return (hostname, port) if hostname else None
 
 
-def discover_and_save_host_keys(
-    hostname: str, port: int, organization: str, config_path: str | None = None
-) -> str:
+@external_api_call(ApiType.SSH, "discover_and_save_host_keys")
+def discover_and_save_host_keys(hostname: str, port: int, organization: str, config_path: str | None = None) -> str:
     """
     Discover SSH host keys and save them to the organization's configuration.
 
@@ -224,9 +198,7 @@ def discover_and_save_host_keys(
     return host_keys
 
 
-def save_host_keys_to_config(
-    host_keys: str, organization: str, config_path: str | None = None
-) -> None:
+def save_host_keys_to_config(host_keys: str, organization: str, config_path: str | None = None) -> None:
     """
     Save SSH host keys to the organization's configuration file.
 
@@ -242,9 +214,7 @@ def save_host_keys_to_config(
     from .config import DEFAULT_CONFIG_PATH
 
     if config_path is None:
-        config_path = (
-            os.getenv("G2G_CONFIG_PATH", "").strip() or DEFAULT_CONFIG_PATH
-        )
+        config_path = os.getenv("G2G_CONFIG_PATH", "").strip() or DEFAULT_CONFIG_PATH
 
     config_file = Path(config_path).expanduser()
 
@@ -313,9 +283,7 @@ def save_host_keys_to_config(
 
             # Insert the GERRIT_KNOWN_HOSTS entry
             escaped_keys = host_keys.replace("\n", "\\n")
-            new_lines.insert(
-                section_end, f'GERRIT_KNOWN_HOSTS = "{escaped_keys}"'
-            )
+            new_lines.insert(section_end, f'GERRIT_KNOWN_HOSTS = "{escaped_keys}"')
 
         # Write the updated configuration
         config_file.write_text("\n".join(new_lines), encoding="utf-8")
@@ -327,9 +295,7 @@ def save_host_keys_to_config(
         )
 
     except Exception as exc:
-        raise SSHDiscoveryError(
-            _MSG_SAVE_FAILED.format(config_file=config_file, error=exc)
-        ) from exc
+        raise SSHDiscoveryError(_MSG_SAVE_FAILED.format(config_file=config_file, error=exc)) from exc
 
 
 def auto_discover_gerrit_host_keys(
@@ -360,21 +326,14 @@ def auto_discover_gerrit_host_keys(
             gerrit_port = 29418
 
         if organization is None:
-            organization = (
-                os.getenv("ORGANIZATION")
-                or os.getenv("GITHUB_REPOSITORY_OWNER")
-                or ""
-            ).strip()
+            organization = (os.getenv("ORGANIZATION") or os.getenv("GITHUB_REPOSITORY_OWNER") or "").strip()
 
         if not gerrit_hostname:
             log.debug("No Gerrit hostname provided for auto-discovery")
             return None
 
         if not organization:
-            log.warning(
-                "No organization specified for SSH host key auto-discovery. "
-                "Cannot save to configuration file."
-            )
+            log.warning("No organization specified for SSH host key auto-discovery. Cannot save to configuration file.")
             save_to_config = False
 
         log.info(
@@ -404,9 +363,7 @@ def auto_discover_gerrit_host_keys(
         log.warning("SSH host key auto-discovery failed: %s", exc)
         return None
     except Exception as exc:
-        log.warning(
-            "Unexpected error during SSH host key auto-discovery: %s", exc
-        )
+        log.warning("Unexpected error during SSH host key auto-discovery: %s", exc)
         return None
     else:
         return host_keys

github2gerrit/utils.py

@@ -0,0 +1,113 @@
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: 2025 The Linux Foundation
+
+"""Common utilities used across multiple modules.
+
+This module consolidates helper functions that were previously duplicated
+across cli.py, core.py, and gitutils.py to reduce maintenance overhead
+and ensure consistent behavior.
+"""
+
+import logging
+import os
+from typing import Any
+
+
+def env_bool(name: str, default: bool = False) -> bool:
+    """Parse boolean environment variable correctly handling string values.
+
+    Args:
+        name: Environment variable name
+        default: Default value if variable is not set
+
+    Returns:
+        Boolean value parsed from environment variable
+    """
+    val = os.getenv(name)
+    if val is None:
+        return default
+    s = val.strip().lower()
+    return s in ("1", "true", "yes", "on")
+
+
+def env_str(name: str, default: str = "") -> str:
+    """Get string environment variable with default fallback.
+
+    Args:
+        name: Environment variable name
+        default: Default value if variable is not set
+
+    Returns:
+        String value from environment variable or default
+    """
+    val = os.getenv(name)
+    return val if val is not None else default
+
+
+def parse_bool_env(value: str | None) -> bool:
+    """Parse boolean environment variable correctly handling string values.
+
+    Args:
+        value: String value to parse as boolean
+
+    Returns:
+        Boolean value parsed from string
+    """
+    if value is None:
+        return False
+    s = value.strip().lower()
+    return s in ("1", "true", "yes", "on")
+
+
+def is_verbose_mode() -> bool:
+    """Check if verbose mode is enabled via environment variable.
+
+    Returns:
+        True if G2G_VERBOSE environment variable is set to a truthy value
+    """
+    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.
+
+    Args:
+        logger: Logger instance to use
+        message: Log message format string
+        *args: Arguments for message formatting
+    """
+    if is_verbose_mode():
+        logger.exception(message, *args)
+    else:
+        logger.error(message, *args)
+
+
+def append_github_output(outputs: dict[str, str]) -> None:
+    """Append key-value pairs to GitHub Actions output file.
+
+    This function writes outputs to the GITHUB_OUTPUT file for use by
+    subsequent steps in a GitHub Actions workflow. It handles multiline
+    values using heredoc syntax when running in GitHub Actions.
+
+    Args:
+        outputs: Dictionary of key-value pairs to write to output
+    """
+    gh_out = os.getenv("GITHUB_OUTPUT")
+    if not gh_out:
+        return
+
+    try:
+        with open(gh_out, "a", encoding="utf-8") as fh:
+            for key, val in outputs.items():
+                if not val:
+                    continue
+                if "\n" in val:
+                    fh.write(f"{key}<<G2G\n")
+                    fh.write(f"{val}\n")
+                    fh.write("G2G\n")
+                else:
+                    fh.write(f"{key}={val}\n")
+    except Exception as exc:
+        # Use a basic logger since we can't import from other modules
+        # without creating circular dependencies
+        logging.getLogger(__name__).debug("Failed to write GITHUB_OUTPUT: %s", exc)