github2gerrit 2.2.1__py3-none-any.whl → 2.2.2__py3-none-any.whl

github2gerrit/cli.py

@@ -1523,10 +1523,10 @@ def main(
         help="Gerrit server hostname (optional; overrides .gitreview).",
     ),
     gerrit_server_port: int = typer.Option(
-        29418,
+        0,
         "--gerrit-server-port",
         envvar="GERRIT_SERVER_PORT",
-        help="Gerrit SSH port (default: 29418).",
+        help="Gerrit SSH port; .gitreview's when unset, else 29418.",
     ),
     gerrit_ssh_privkey_g2g: str = typer.Option(
         "",
@@ -1899,9 +1899,10 @@ def _build_inputs_from_env() -> Inputs:
         dry_run=env_bool("DRY_RUN", False),
         normalise_commit=env_bool("NORMALISE_COMMIT", True),
         gerrit_server=env_str("GERRIT_SERVER", ""),
-        gerrit_server_port=int(
-            env_str("GERRIT_SERVER_PORT", "29418") or "29418"
-        ),
+        # 0 means unset. A blank value is what the action passes when the
+        # caller gave none, and the distinction matters: an explicit
+        # port outranks .gitreview's, a defaulted one must not.
+        gerrit_server_port=int(env_str("GERRIT_SERVER_PORT", "").strip() or 0),
         gerrit_project=env_str("GERRIT_PROJECT"),
         issue_id=env_str("ISSUE_ID", ""),
         issue_id_lookup_json=env_str("ISSUE_ID_LOOKUP_JSON", ""),
@@ -4030,8 +4031,9 @@ def _add_full_config(
     # Show Gerrit settings if they have values
     if data.gerrit_server:
         config_info["GERRIT_SERVER"] = data.gerrit_server
-    # Only show non-default port (29418 is default)
-    if data.gerrit_server_port and data.gerrit_server_port != 29418:
+    # Any set port is shown: 0 is the unset sentinel, and an explicit
+    # 29418 is a real override of whatever .gitreview names.
+    if data.gerrit_server_port:
         config_info["GERRIT_SERVER_PORT"] = str(data.gerrit_server_port)
     if data.gerrit_project:
         config_info["GERRIT_PROJECT"] = data.gerrit_project

github2gerrit/config.py

@@ -54,9 +54,13 @@ from dataclasses import field
 from pathlib import Path
 from typing import Any
 
+from .config_ini import DEFAULT_CONFIG_PATH as DEFAULT_CONFIG_PATH
 from .config_ini import _coerce_value
 from .config_ini import _load_ini
 from .config_ini import _select_section
+from .config_ini import (
+    save_derived_parameters_to_config as save_derived_parameters_to_config,
+)
 from .project_names import ProjectSource
 from .utils import env_bool
 from .utils import setting_bool
@@ -64,8 +68,6 @@ from .utils import setting_bool
 
 log = logging.getLogger("github2gerrit.config")
 
-DEFAULT_CONFIG_PATH = "~/.config/github2gerrit/configuration.txt"
-
 # Recognized keys. Unknown keys will be reported as warnings to help
 # users catch typos and missing functionality.
 KNOWN_KEYS: set[str] = {
@@ -424,14 +426,22 @@ class DerivedParameters:
             worth exporting for queries but must stay labelled so the
             push refuses it.
         host_from_gitreview: ``True`` when ``GERRIT_SERVER`` in *values*
-            is the ``.gitreview`` host.  That host travels with the
-            project as one target and, like a confirmed project, may
-            displace a per-organization configuration value.
+            is the ``.gitreview`` host.  It travels with the project as
+            one target and, like a confirmed project, may displace a
+            per-organization configuration value.
+        port_from_gitreview: ``True`` when ``GERRIT_SERVER_PORT`` in
+            *values* is the ``.gitreview`` port.  Tracked apart from the
+            host: each field has its own precedence, so the file can win
+            the port while an explicit server wins the host.  The port
+            is exported only when the file supplies it; without a file
+            there is nothing to derive it from, and the Gerrit default
+            applies downstream.
     """
 
     values: dict[str, str] = field(default_factory=dict)
     project_source: ProjectSource | None = None
     host_from_gitreview: bool = False
+    port_from_gitreview: bool = False
 
     @property
     def project_confirmed(self) -> bool:
@@ -455,16 +465,71 @@ def derive_gerrit_parameters(
     return derive_gerrit_parameters_detailed(organization, repository).values
 
 
+def _derive_gerrit_project(
+    repository: str | None,
+    gitreview: Any,
+    gerrit_host: str,
+    config: dict[str, str],
+) -> tuple[str, ProjectSource | None]:
+    """Derive ``GERRIT_PROJECT`` from ``.gitreview``, else the repository.
+
+    A ``.gitreview`` read on behalf of a pull request whose base ref is
+    not yet known came from a default branch, which may not be the
+    branch the pull request targets; its host is kept (servers do not
+    vary by branch, and local SSH-identity derivation needs one) but
+    its project is not this pull request's to export.  Without a
+    ``.gitreview`` project the lookup may ask Gerrit, on *gerrit_host*,
+    the effective host the caller settled.  The loaded configuration
+    goes along because this runs before the file has been exported to
+    the environment, and the paths that consume the result never see
+    the orchestrator's later, environment-only reading of the same
+    settings.  An explicit ``GERRIT_PROJECT`` in the environment makes
+    the lookup moot, exactly as ``.gitreview`` does:
+    :func:`apply_config_to_env` would discard the answer.
+
+    Returns the project (``""`` when the repository is unusable) and its
+    :data:`project_names.ProjectSource`.
+    """
+    if not repository or "/" not in repository:
+        return "", None
+
+    from .gitreview import context_provenance
+    from .project_names import opted_in_gerrit_project_lister
+    from .project_names import resolve_repo_names
+
+    gitreview_project = (gitreview.project if gitreview else "").strip()
+    if gitreview_project and context_provenance(repository).provisional:
+        log.debug(
+            "Base ref not yet known for this pull request; not taking "
+            "project %r from a default-branch .gitreview",
+            gitreview_project,
+        )
+        gitreview_project = ""
+    lookup_moot = bool(gitreview_project) or bool(
+        (os.getenv("GERRIT_PROJECT") or "").strip()
+    )
+    names = resolve_repo_names(
+        repository,
+        gitreview_project=gitreview_project or None,
+        list_projects=None
+        if lookup_moot
+        else opted_in_gerrit_project_lister(gerrit_host, config=config),
+    )
+    return names.project_gerrit, names.source
+
+
 def derive_gerrit_parameters_detailed(
     organization: str | None, repository: str | None = None
 ) -> DerivedParameters:
     """Derive Gerrit parameters using SSH config, git config, and org fallback.
 
     Priority order for server derivation:
-    1. .gitreview host field (local file or fetched from GitHub); this
-       is the host the orchestrator pushes to whenever there is a file
-    2. Per-org configuration file entry (GERRIT_SERVER)
-    3. Heuristic fallback: gerrit.[org].org
+    1. An explicit ``GERRIT_SERVER`` already in the environment (one the
+       operator set, not one an earlier derivation pass exported); this
+       is the host the orchestrator pushes to
+    2. .gitreview host field (local file or fetched from GitHub)
+    3. Per-org configuration file entry (GERRIT_SERVER)
+    4. Heuristic fallback: gerrit.[org].org
 
     The host and the project are exported as one target: the closed-
     pull-request handler and the cleanup sweeps query them together,
@@ -510,7 +575,8 @@ def derive_gerrit_parameters_detailed(
         among them is a guess:
         - GERRIT_SSH_USER_G2G: From SSH config or [org].gh2gerrit
         - GERRIT_SSH_USER_G2G_EMAIL: From git config or fallback email
-        - GERRIT_SERVER: Resolved from config, .gitreview, or gerrit.[org].org
+        - GERRIT_SERVER: An explicit environment value, else .gitreview,
+          else config, else gerrit.[org].org
         - GERRIT_PROJECT: From .gitreview or Gerrit, else guessed
     """
     if not organization:
@@ -521,6 +587,12 @@ def derive_gerrit_parameters_detailed(
     # Check if we have a config file entry for this organization
     config = load_org_config(org)
     configured_server = config.get("GERRIT_SERVER", "").strip()
+    explicit_server = (os.getenv("GERRIT_SERVER") or "").strip()
+    if explicit_server and is_derived_key("GERRIT_SERVER"):
+        explicit_server = ""
+    explicit_port = (os.getenv("GERRIT_SERVER_PORT") or "").strip()
+    if explicit_port and is_derived_key("GERRIT_SERVER_PORT"):
+        explicit_port = ""
 
     # Read .gitreview once for both host and project. The project is
     # per-repository and the configuration file cannot supply it, so
@@ -535,16 +607,25 @@ def derive_gerrit_parameters_detailed(
     gitreview = _read_gitreview_info(repository) if not ci_testing else None
     gitreview_host = (gitreview.host if gitreview else "").strip()
 
-    # Priority: .gitreview > config file > heuristic fallback. The
-    # orchestrator pushes to the .gitreview host whenever there is a
-    # file, so the host exported here -- which the closed-pull-request
-    # handler and the cleanup sweeps query, paired with the project
-    # below -- has to be the same one, or they query the right project
-    # on the wrong server. The per-organization file is a fallback for
-    # repositories that carry no .gitreview.
-    gerrit_host = gitreview_host or configured_server or f"gerrit.{org}.org"
+    # One effective host, in the orchestrator's order: an explicit
+    # GERRIT_SERVER, else .gitreview, else the per-organization file,
+    # else the heuristic. It is the host the push will go to, so it is
+    # the host exported here -- paired with the project below for the
+    # closed-pull-request handler and the cleanup sweeps -- the host
+    # the project lookup asks, and the host SSH credentials are derived
+    # for. Confirming a project or picking an identity on any other
+    # host would be confirming or picking for the wrong server.
+    gerrit_host = (
+        explicit_server
+        or gitreview_host
+        or configured_server
+        or f"gerrit.{org}.org"
+    )
+    # Provenance follows the tier selected, not the value: an explicit
+    # server that happens to equal the file's host is still explicit.
+    host_from_gitreview = not explicit_server and bool(gitreview_host)
 
-    if gitreview_host:
+    if host_from_gitreview:
         log.debug(
             "Using Gerrit host from .gitreview: %s%s",
             gitreview_host,
@@ -552,55 +633,18 @@ def derive_gerrit_parameters_detailed(
             if configured_server and configured_server != gitreview_host
             else "",
         )
-
-    # Derive GERRIT_PROJECT from .gitreview, else from the repository.
-    # A .gitreview read on behalf of a pull request whose base ref is
-    # not yet known came from a default branch, which may not be the
-    # branch the pull request targets; its host is kept (servers do not
-    # vary by branch, and local SSH-identity derivation needs one) but
-    # its project is not this pull request's to export. Without a
-    # .gitreview project the lookup may ask Gerrit. The host asked is
-    # the one the push will go to, in the orchestrator's order: the
-    # file's when there is a file, else an explicit GERRIT_SERVER, else
-    # the host resolved above. The loaded configuration goes along
-    # because this runs before the file has been exported to the
-    # environment, and the paths that consume the result never see the
-    # orchestrator's later, environment-only reading of the same
-    # settings. An explicit GERRIT_PROJECT in the environment makes the
-    # lookup moot, exactly as .gitreview does: apply_config_to_env
-    # would discard the answer.
-    gerrit_project = ""
-    project_source: ProjectSource | None = None
-    if repository and "/" in repository:
-        from .gitreview import context_provenance
-        from .project_names import opted_in_gerrit_project_lister
-        from .project_names import resolve_repo_names
-
-        gitreview_project = (gitreview.project if gitreview else "").strip()
-        if gitreview_project and context_provenance(repository).provisional:
-            log.debug(
-                "Base ref not yet known for this pull request; not taking "
-                "project %r from a default-branch .gitreview",
-                gitreview_project,
-            )
-            gitreview_project = ""
-        lookup_moot = bool(gitreview_project) or bool(
-            (os.getenv("GERRIT_PROJECT") or "").strip()
-        )
-        names = resolve_repo_names(
-            repository,
-            gitreview_project=gitreview_project or None,
-            list_projects=None
-            if lookup_moot
-            else opted_in_gerrit_project_lister(
-                (gitreview.host if gitreview else "")
-                or os.getenv("GERRIT_SERVER", "").strip()
-                or gerrit_host,
-                config=config,
-            ),
+    elif (
+        explicit_server and gitreview_host and gitreview_host != explicit_server
+    ):
+        log.debug(
+            "Using explicit GERRIT_SERVER %s over .gitreview host %s",
+            explicit_server,
+            gitreview_host,
         )
-        gerrit_project = names.project_gerrit
-        project_source = names.source
+
+    gerrit_project, project_source = _derive_gerrit_project(
+        repository, gitreview, gerrit_host, config
+    )
 
     # Try to use SSH config and git config for personalized credentials
     ssh_user: str | None = None
@@ -619,15 +663,97 @@ def derive_gerrit_parameters_detailed(
         or f"releng+{org}-gh2gerrit@linuxfoundation.org",
         "GERRIT_SERVER": gerrit_host,
     }
+    # The port has its own tier, settled by the same rule as the host:
+    # an explicit input, else the file, else nothing here (the Gerrit
+    # default applies downstream). The closed-pull-request handler
+    # abandons over SSH on whatever port the environment holds, so the
+    # file's port is exported whenever it is the winning tier -- with an
+    # explicit host too, since the orchestrator pairs that host with the
+    # file's port in exactly that case. A file that omits port= has
+    # nothing to say about it; the parser's default is not the file's
+    # word and must not displace a configured port.
+    port_from_gitreview = (
+        not explicit_port and gitreview is not None and gitreview.port_given
+    )
+    if port_from_gitreview and gitreview is not None:
+        result["GERRIT_SERVER_PORT"] = str(gitreview.port)
     if gerrit_project:
         result["GERRIT_PROJECT"] = gerrit_project
     return DerivedParameters(
         values=result,
         project_source=project_source,
-        host_from_gitreview=bool(gitreview_host),
+        host_from_gitreview=host_from_gitreview,
+        port_from_gitreview=port_from_gitreview,
     )
 
 
+def _merge_derived(
+    cfg: dict[str, str],
+    derived: DerivedParameters,
+    *,
+    organization: str,
+    repository: str | None,
+) -> tuple[dict[str, str], dict[str, str]]:
+    """Fill *cfg*'s missing keys from *derived*, displacing the target.
+
+    Only missing or empty keys are filled -- with one exception, for the
+    Gerrit target.  A ``GERRIT_PROJECT`` that *cfg* carries from the
+    configuration file is a per-organization fallback, and a project
+    derived for this repository from its own ``.gitreview``, or
+    confirmed against Gerrit, outranks it: the CLOSE dispatch consumes
+    the resulting inputs before the orchestrator runs and never
+    consults provenance, so leaving the file's value in place would
+    keep cleanup on the wrong project despite the read.  The
+    ``.gitreview`` host and port displace the file's ``GERRIT_SERVER``
+    and ``GERRIT_SERVER_PORT`` for the same reason: the three are
+    queried together, and the pipeline pushes to the ``.gitreview``
+    target, so they have to come from one place.  Nothing inferred from
+    the name alone displaces a project, whether a guess or the one
+    reading of a hyphen-free name; the file's value was at least written
+    down by somebody.  An explicit environment value is untouched either
+    way, since :func:`apply_config_to_env` never overwrites one.
+
+    Returns the merged mapping and the keys derivation supplied.
+    """
+    result = dict(cfg)
+    newly_derived: dict[str, str] = {}
+
+    def _env_blank(key: str) -> bool:
+        return (os.getenv(key) or "").strip() == ""
+
+    replaceable = {
+        key
+        for key, confirmed in (
+            ("GERRIT_PROJECT", derived.project_confirmed),
+            ("GERRIT_SERVER", derived.host_from_gitreview),
+            ("GERRIT_SERVER_PORT", derived.port_from_gitreview),
+        )
+        if confirmed and cfg.get(key, "").strip() and _env_blank(key)
+    }
+
+    for key, value in derived.values.items():
+        replacing = key in replaceable
+        if key not in result or not result[key].strip() or replacing:
+            if replacing:
+                log.debug(
+                    "Replacing configuration-file %s %r with %r resolved "
+                    "for repository %s",
+                    key,
+                    result[key],
+                    value,
+                    repository,
+                )
+            log.debug(
+                "Deriving %s from organization '%s': %s",
+                key,
+                organization,
+                value,
+            )
+            result[key] = value
+            newly_derived[key] = value
+    return result, newly_derived
+
+
 def apply_parameter_derivation(
     cfg: dict[str, str],
     organization: str | None = None,
@@ -674,19 +800,23 @@ def apply_parameter_derivation(
     # by releases before such writes stopped, and hand-written ones,
     # which are equally misscoped. Marking it derived keeps it usable as
     # a last resort while letting the per-pull-request .gitreview
-    # outrank it.
+    # outrank it. A GERRIT_SERVER, and a GERRIT_SERVER_PORT, from the
+    # file are marked the same way: sensible per-organization defaults,
+    # but an explicit server or port now outranks .gitreview at the
+    # push, and a default must not carry that authority. Only a value
+    # the operator set for this run does.
     #
     # Recorded ahead of the early returns below, because this describes
     # what cfg already carries rather than anything derivation adds.
     # Neither a missing organization nor G2G_ENABLE_DERIVATION=false
-    # makes a config-file project any more like operator intent, and
+    # makes a config-file value any more like operator intent, and
     # apply_config_to_env still exports it in both cases.
-    if (
-        mark_derived
-        and cfg.get("GERRIT_PROJECT", "").strip()
-        and (os.getenv("GERRIT_PROJECT") or "").strip() == ""
-    ):
-        mark_derived_keys(["GERRIT_PROJECT"])
+    if mark_derived:
+        mark_derived_keys(
+            key
+            for key in ("GERRIT_PROJECT", "GERRIT_SERVER", "GERRIT_SERVER_PORT")
+            if cfg.get(key, "").strip() and (os.getenv(key) or "").strip() == ""
+        )
 
     if not organization:
         return cfg
@@ -706,60 +836,12 @@ def apply_parameter_derivation(
         )
         return cfg
 
-    # Only derive parameters that are missing or empty -- with one
-    # exception, for the Gerrit target. A GERRIT_PROJECT that cfg
-    # carries from the configuration file is the per-organization
-    # fallback described above, and a project derived for this
-    # repository from its own .gitreview, or confirmed against Gerrit,
-    # outranks it: the CLOSE dispatch consumes the resulting Inputs
-    # before the orchestrator runs and never consults provenance, so
-    # leaving the file's value in place would keep cleanup on the wrong
-    # project despite the read. The .gitreview host displaces the
-    # file's GERRIT_SERVER for the same reason: host and project are
-    # queried together, and the pipeline pushes to the .gitreview host,
-    # so the pair has to come from one place. Nothing inferred from the
-    # name alone displaces a project, whether a guess or the one
-    # reading of a hyphen-free name; the file's value was at least
-    # written down by somebody. An explicit environment value is
-    # untouched either way, since apply_config_to_env never overwrites
-    # one and the provenance record above agrees.
+    # Only derive parameters that are missing or empty, except for the
+    # Gerrit target; _merge_derived explains the exception.
     derived = derive_gerrit_parameters_detailed(organization, repository)
-    result = dict(cfg)
-    newly_derived = {}
-
-    def _env_blank(key: str) -> bool:
-        return (os.getenv(key) or "").strip() == ""
-
-    replaceable = {
-        key
-        for key, confirmed in (
-            ("GERRIT_PROJECT", derived.project_confirmed),
-            ("GERRIT_SERVER", derived.host_from_gitreview),
-        )
-        if confirmed and cfg.get(key, "").strip() and _env_blank(key)
-    }
-
-    for key, value in derived.values.items():
-        replacing = key in replaceable
-        if key not in result or not result[key].strip() or replacing:
-            if replacing:
-                log.debug(
-                    "Replacing configuration-file %s %r with %r resolved "
-                    "for repository %s",
-                    key,
-                    result[key],
-                    value,
-                    repository,
-                )
-            log.debug(
-                "Deriving %s from organization '%s': %s (context: %s)",
-                key,
-                organization,
-                value,
-                "GitHub Actions" if is_github_actions else "Local CLI",
-            )
-            result[key] = value
-            newly_derived[key] = value
+    result, newly_derived = _merge_derived(
+        cfg, derived, organization=organization, repository=repository
+    )
 
     if newly_derived:
         log.debug(
@@ -816,95 +898,6 @@ def apply_parameter_derivation(
     return result
 
 
-def save_derived_parameters_to_config(
-    organization: str,
-    derived_params: dict[str, str],
-    config_path: str | None = None,
-) -> None:
-    """Save derived parameters to the organization's configuration file.
-
-    This function updates the configuration file to include any derived
-    parameters that are not already present in the organization section.
-    This creates a persistent configuration that users can modify if needed.
-
-    Args:
-        organization: GitHub organization name for config section
-        derived_params: Dictionary of parameter names to values
-        config_path: Path to config file (optional, uses default if not
-            provided)
-    """
-    # Skip config file writes during dry-run mode
-    if os.getenv("DRY_RUN", "").lower() in ("true", "1", "yes"):
-        log.debug("Skipping config file write in dry-run mode")
-        return
-    if not organization or not derived_params:
-        return
-
-    # GERRIT_PROJECT is per-repository, but this file section is
-    # per-organization: persisting it would hand every other repository
-    # in the org one repository's project name, and would additionally
-    # come back on the next run as configuration indistinguishable from
-    # operator intent, defeating the provenance tracking that lets
-    # duplicate detection prefer a per-pull-request .gitreview.
-    derived_params = {
-        k: v for k, v in derived_params.items() if k != "GERRIT_PROJECT"
-    }
-    if not derived_params:
-        return
-
-    if config_path is None:
-        config_path = (
-            os.getenv("G2G_CONFIG_PATH", "").strip() or DEFAULT_CONFIG_PATH
-        )
-
-    config_file = Path(config_path).expanduser()
-
-    try:
-        # Only update when a configuration file already exists
-        if not config_file.exists():
-            log.debug(
-                "Configuration file does not exist; skipping auto-save of "
-                "derived parameters: %s",
-                config_file,
-            )
-            return
-
-        cp = _load_ini(config_file)
-
-        # Find or create the organization section
-        org_section = _select_section(cp, organization)
-        if org_section is None:
-            # Section doesn't exist, we'll need to add it
-            cp.add_section(organization)
-            org_section = organization
-
-        # Add derived parameters that don't already exist
-        params_added = []
-        for key, value in derived_params.items():
-            if not cp.has_option(org_section, key):
-                cp.set(org_section, key, f'"{value}"')
-                params_added.append(key)
-
-        # Only write if we added parameters
-        if params_added:
-            with config_file.open("w", encoding="utf-8") as f:
-                cp.write(f)
-
-            log.debug(
-                "Saved derived parameters to configuration file %s [%s]: %s",
-                config_file,
-                organization,
-                ", ".join(params_added),
-            )
-
-    except Exception as exc:
-        log.warning(
-            "Failed to save derived parameters to configuration file %s: %s",
-            config_file,
-            exc,
-        )
-
-
 def overlay_missing(
     primary: dict[str, str],
     fallback: dict[str, str],

github2gerrit/config_ini.py

@@ -1,15 +1,16 @@
 # SPDX-License-Identifier: Apache-2.0
 # SPDX-FileCopyrightText: 2025 The Linux Foundation
-"""INI parsing for the github2gerrit configuration file.
+"""INI reading and writing for the github2gerrit configuration file.
 
 The file format :mod:`github2gerrit.config` reads is INI with two
 liberties configparser does not take on its own: values may reference
 environment variables as ``${ENV:VAR}``, and a quoted value may span
 several lines, which is how SSH private keys and known-hosts entries
 are written inline.  This module turns such a file into a
-:class:`configparser.RawConfigParser` and normalises the values it
-yields.  It knows nothing about which keys mean what; that stays in
-:mod:`github2gerrit.config`.
+:class:`configparser.RawConfigParser`, normalises the values it yields,
+and writes derived parameters back into it.  It knows nothing about
+which keys mean what beyond the one it refuses to persist; that stays
+in :mod:`github2gerrit.config`.
 """
 
 from __future__ import annotations
@@ -25,6 +26,8 @@ from typing import cast
 
 log = logging.getLogger("github2gerrit.config")
 
+DEFAULT_CONFIG_PATH = "~/.config/github2gerrit/configuration.txt"
+
 _ENV_REF = re.compile(r"\$\{ENV:([A-Za-z_][A-Za-z0-9_]*)\}")
 
 
@@ -261,3 +264,92 @@ def _load_ini(path: Path) -> configparser.RawConfigParser:
     except Exception as exc:
         log.warning("Failed to read config file %s: %s", path, exc)
     return cp
+
+
+def save_derived_parameters_to_config(
+    organization: str,
+    derived_params: dict[str, str],
+    config_path: str | None = None,
+) -> None:
+    """Save derived parameters to the organization's configuration file.
+
+    This function updates the configuration file to include any derived
+    parameters that are not already present in the organization section.
+    This creates a persistent configuration that users can modify if needed.
+
+    Args:
+        organization: GitHub organization name for config section
+        derived_params: Dictionary of parameter names to values
+        config_path: Path to config file (optional, uses default if not
+            provided)
+    """
+    # Skip config file writes during dry-run mode
+    if os.getenv("DRY_RUN", "").lower() in ("true", "1", "yes"):
+        log.debug("Skipping config file write in dry-run mode")
+        return
+    if not organization or not derived_params:
+        return
+
+    # GERRIT_PROJECT is per-repository, but this file section is
+    # per-organization: persisting it would hand every other repository
+    # in the org one repository's project name, and would additionally
+    # come back on the next run as configuration indistinguishable from
+    # operator intent, defeating the provenance tracking that lets
+    # duplicate detection prefer a per-pull-request .gitreview.
+    derived_params = {
+        k: v for k, v in derived_params.items() if k != "GERRIT_PROJECT"
+    }
+    if not derived_params:
+        return
+
+    if config_path is None:
+        config_path = (
+            os.getenv("G2G_CONFIG_PATH", "").strip() or DEFAULT_CONFIG_PATH
+        )
+
+    config_file = Path(config_path).expanduser()
+
+    try:
+        # Only update when a configuration file already exists
+        if not config_file.exists():
+            log.debug(
+                "Configuration file does not exist; skipping auto-save of "
+                "derived parameters: %s",
+                config_file,
+            )
+            return
+
+        cp = _load_ini(config_file)
+
+        # Find or create the organization section
+        org_section = _select_section(cp, organization)
+        if org_section is None:
+            # Section doesn't exist, we'll need to add it
+            cp.add_section(organization)
+            org_section = organization
+
+        # Add derived parameters that don't already exist
+        params_added = []
+        for key, value in derived_params.items():
+            if not cp.has_option(org_section, key):
+                cp.set(org_section, key, f'"{value}"')
+                params_added.append(key)
+
+        # Only write if we added parameters
+        if params_added:
+            with config_file.open("w", encoding="utf-8") as f:
+                cp.write(f)
+
+            log.debug(
+                "Saved derived parameters to configuration file %s [%s]: %s",
+                config_file,
+                organization,
+                ", ".join(params_added),
+            )
+
+    except Exception as exc:
+        log.warning(
+            "Failed to save derived parameters to configuration file %s: %s",
+            config_file,
+            exc,
+        )

github2gerrit/core.py

@@ -3173,12 +3173,13 @@ class Orchestrator:
         """Resolve Gerrit connection info from .gitreview or inputs.
 
         The project is *repo*'s, settled by :meth:`_derive_repo_names`;
-        only the host and port are resolved here. An explicit
-        ``GERRIT_SERVER`` outranks ``.gitreview``, as an explicit
-        ``GERRIT_PROJECT`` does; otherwise the file's host and port
-        apply when there is a file, and the inputs' otherwise. A guessed
-        project is refused for any run that pushes, whichever supplied
-        the host.
+        only the host and port are resolved here, each by the same rule
+        as the project: an explicit input outranks ``.gitreview``, and
+        ``.gitreview`` outranks a derived input. A port is explicit when
+        it was set at all -- the action and the CLI pass none rather
+        than 29418 when the caller gave none -- and not recorded as
+        derived. 29418 is the final fallback. A guessed project is
+        refused for any run that pushes, whichever supplied the host.
 
         After resolution, the Gerrit host is validated via DNS to
         catch bogus hostnames early — regardless of whether the host
@@ -3216,19 +3217,40 @@ class Orchestrator:
         explicit_host = _explicit_input(
             inputs, "GERRIT_SERVER", inputs.gerrit_server
         )
+        explicit_port = _explicit_input(
+            inputs,
+            "GERRIT_SERVER_PORT",
+            str(inputs.gerrit_server_port or ""),
+        )
+        # The file's port counts only when the file named one; the
+        # parser's default is not the file's word.
+        file_port = gitreview.port if gitreview and gitreview.port_given else 0
         if gitreview and explicit_host is None:
             log.debug("Using .gitreview settings: %s", gitreview)
             self._validate_resolved_gerrit_host(gitreview.host)
-            if gitreview.project == project:
+            port = (
+                (int(explicit_port) if explicit_port else 0)
+                or file_port
+                or inputs.gerrit_server_port
+                or 29418
+            )
+            if explicit_port and port != gitreview.port:
+                log.info(
+                    "Using Gerrit port %d over .gitreview's %d: an explicit "
+                    "GERRIT_SERVER_PORT outranks the file",
+                    port,
+                    gitreview.port,
+                )
+            if gitreview.project == project and port == gitreview.port:
                 return gitreview
-            if gitreview.project.strip():
+            if gitreview.project.strip() and gitreview.project != project:
                 log.info(
                     "Using Gerrit project %r over .gitreview's %r: an "
                     "explicit GERRIT_PROJECT outranks the file",
                     project,
                     gitreview.project,
                 )
-            return dataclass_replace(gitreview, project=project)
+            return dataclass_replace(gitreview, project=project, port=port)
 
         host = inputs.gerrit_server.strip()
         if not host:
@@ -3240,12 +3262,14 @@ class Orchestrator:
                 host,
                 gitreview.host,
             )
-        port_s = str(inputs.gerrit_server_port).strip() or "29418"
-        try:
-            port = int(port_s)
-        except ValueError as exc:
-            msg = "bad GERRIT_SERVER_PORT"
-            raise OrchestratorError(msg) from exc
+        # The port follows its own tier: an explicit input, else the
+        # file's, else a derived input, else the Gerrit default.
+        port = (
+            (int(explicit_port) if explicit_port else 0)
+            or file_port
+            or inputs.gerrit_server_port
+            or 29418
+        )
 
         info = make_gitreview_info(host=host, port=port, project=project)
         log.debug("Resolved Gerrit info: %s", info)

github2gerrit/gitreview.py

@@ -72,12 +72,19 @@ class GitReviewInfo:
             ``gerrit.linuxfoundation.org``).  ``None`` when the host is
             not in the known-hosts table — callers may fall back to
             dynamic discovery (see ``gerrit_urls.py``).
+        port_given: Whether the source named the port, or *port* is the
+            parser's default.  A file that omits ``port=`` has nothing
+            to say about the port and must not outrank a configured
+            one.  Defaults to ``True``: a caller constructing an
+            instance with a port is stating it.  :func:`parse_gitreview`
+            sets it from the file.
     """
 
     host: str
     port: int = DEFAULT_GERRIT_PORT
     project: str = ""
     base_path: str | None = None
+    port_given: bool = True
 
     @property
     def is_valid(self) -> bool:
@@ -174,6 +181,7 @@ def parse_gitreview(text: str) -> GitReviewInfo | None:
         port=port,
         project=project,
         base_path=base_path,
+        port_given=port_match is not None,
     )
     log.debug(
         "Parsed .gitreview: host=%s, port=%d, project=%s, base_path=%s",

{github2gerrit-2.2.1.dist-info → github2gerrit-2.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: github2gerrit
-Version: 2.2.1
+Version: 2.2.2
 Summary: Submit a GitHub pull request to a Gerrit repository.
 Project-URL: Homepage, https://github.com/lfreleng-actions/github2gerrit-action
 Project-URL: Repository, https://github.com/lfreleng-actions/github2gerrit-action
@@ -277,7 +277,7 @@ uvx github2gerrit https://github.com/onap/portal-ng-bff/pull/33
 | `GERRIT_SSH_USER_G2G`          | No       | `""`             | Gerrit SSH username; derived when not supplied                 |
 | `GERRIT_SSH_USER_G2G_EMAIL`    | No       | `""`             | Gerrit user email address; derived when not supplied           |
 | `GERRIT_SERVER`                | No       | `""`             | Gerrit server hostname; overrides `.gitreview` when set        |
-| `GERRIT_SERVER_PORT`           | No       | `"29418"`        | Gerrit SSH port                                                |
+| `GERRIT_SERVER_PORT`           | No       | `""`             | Gerrit SSH port; `.gitreview`'s when unset, else 29418         |
 | `GERRIT_PROJECT`               | No       | `""`             | Gerrit project name; overrides `.gitreview` when set           |
 | `GERRIT_HTTP_BASE_PATH`        | No       | `""`             | HTTP base path for Gerrit REST API (e.g. `/r`)                 |
 | `GERRIT_HTTP_USER`             | No       | `""`             | Gerrit HTTP user for REST queries                              |
@@ -377,7 +377,7 @@ Input defaults match the composite action defaults.
 | `GERRIT_SSH_USER_G2G`          | string  | `""`             | Gerrit SSH username                              |
 | `GERRIT_SSH_USER_G2G_EMAIL`    | string  | `""`             | Gerrit user email address                        |
 | `GERRIT_SERVER`                | string  | `""`             | Gerrit server hostname                           |
-| `GERRIT_SERVER_PORT`           | string  | `"29418"`        | Gerrit SSH port                                  |
+| `GERRIT_SERVER_PORT`           | string  | `""`             | Gerrit SSH port; `.gitreview`'s when unset       |
 | `GERRIT_PROJECT`               | string  | `""`             | Gerrit project name                              |
 | `GERRIT_HTTP_BASE_PATH`        | string  | `""`             | HTTP base path for Gerrit REST                   |
 | `GERRIT_HTTP_USER`             | string  | `""`             | Gerrit HTTP user for REST queries                |

{github2gerrit-2.2.1.dist-info → github2gerrit-2.2.2.dist-info}/RECORD

@@ -1,12 +1,12 @@
 github2gerrit/__init__.py,sha256=N1Vj1HJ28LKCJLAynQdm5jFGQQAz9YSMzZhEfvbBgow,886
 github2gerrit/approvers.py,sha256=Lp1inG2n7-GhaC43WP6tYh-aquVmkj3vV_jUSrKCm0M,10298
-github2gerrit/cli.py,sha256=6PfAp3SfoqpmTdhGpIyvfrdCPlkkpxF2zU4lcsEu5nk,150669
+github2gerrit/cli.py,sha256=V9F7KOGu3NrQY0Cqs9gFwg3Ud5ScGNh5X7_pftPGOzA,150909
 github2gerrit/commit_normalization.py,sha256=Kt_yrklKquNN1tdDakRmZVqQRZxRVBRsNQlv47Yp6vU,16744
 github2gerrit/commit_rules.py,sha256=SeWvVMqvPgXr-yRD5hOpmlHYGg9sroQD60zYSHOOUZU,15415
-github2gerrit/config.py,sha256=YJw7_BtYHLxbHMFczKyJS64qbCu1hqS-PqXlGI9Jx_o,35204
-github2gerrit/config_ini.py,sha256=5guT5L_GTlzOkRROv_9jwWCT1Lq1fRJ0LxX_iLCGcMU,8714
+github2gerrit/config.py,sha256=WO2kwAmo07uNXbruoC_lkjx4wnda5LqHAHmmGQc2Xu0,35487
+github2gerrit/config_ini.py,sha256=eXi_q1Fo5_c9s52zLES19Gw9TFDlLjIvzRiBzwHeqo4,12026
 github2gerrit/constants.py,sha256=uCAx-lZiyxlVSHaGmDx6TFbCajkK3VO2ggCOej0EeXk,1306
-github2gerrit/core.py,sha256=Wy6Ps4Hzs1b4QyGWijQvVgQdXNff6t3hidvB39Kxer4,289353
+github2gerrit/core.py,sha256=nZWH4b1TpHXM_Xl27vbj3KFBeMpPjPs-TyrsrMip-LE,290472
 github2gerrit/duplicate_detection.py,sha256=2jRP-6m9enMdxAeL2svw9k2QzO4IoGx2-HQxJNDQEcU,35909
 github2gerrit/error_codes.py,sha256=1tWo717xFPDlbh7sLwaPzkjPJHqP24D3pOXkhQFHbUI,19561
 github2gerrit/external_api.py,sha256=h2pQYlj_dkr0Lfjo54TpLkIIdfKb3CPAi8MOoD1VOS0,20447
@@ -16,7 +16,7 @@ github2gerrit/gerrit_rest.py,sha256=I0c6Jeag9ygmHigtvFKIzqDZwVNjLTXoQW9w4P-bG2c,
 github2gerrit/gerrit_ssh.py,sha256=UOPI6rPMxUwSrQKRrRAqxuL_tyQabxNslWXTttye70A,9132
 github2gerrit/gerrit_urls.py,sha256=BmFIOQ9ILTbNrjAo4K6shHk_-6sPnucQxqHmT_FMN_Q,13682
 github2gerrit/github_api.py,sha256=GuncFKSyd8PYlTAzc4iIZIvNnQB4sN0pXn_-Gh5s3ck,15537
-github2gerrit/gitreview.py,sha256=NOmk9TPY-9G9Yt9Vm5G4KeNc-P7ej9izS-3COkNut1w,23785
+github2gerrit/gitreview.py,sha256=JV7wIninafcEw5bIt9KxN6ZtGWCPsQ0eq-VeOQ-R2kA,24240
 github2gerrit/gitutils.py,sha256=PtaQMpYrf4hC2TjR8fyI0OjHyCLeDnyK8rsvOac2uoE,26512
 github2gerrit/mapping_comment.py,sha256=4jpiiMnoZCT-rRd3WIdMi-afrI3HriwCfdYZ8qLZHE0,9670
 github2gerrit/models.py,sha256=fwTR7HhEd6zrN2nivi1lvVYST0tC9r5EcFXTAPBHXrc,8441
@@ -39,8 +39,8 @@ github2gerrit/trust.py,sha256=_1T4qRmnpQNd6dcVMBGqrP0pcZsW5QKYgpHWYsAZuoI,4275
 github2gerrit/utils.py,sha256=2izB7vvp0-Lnej4dx5eE8mW3is-PdYBWQyor8eUcyhk,6934
 github2gerrit/orchestrator/__init__.py,sha256=HAEcdCAHOFr8LsdIwAdcIcFZn_ayMbX9rdVUULp8410,864
 github2gerrit/orchestrator/reconciliation.py,sha256=TJaAsuLo0_PRnWt3e_RxwKufETKX8b1unV_U_lsZp8E,22105
-github2gerrit-2.2.1.dist-info/METADATA,sha256=wBgfcz3tTGIKaezbighMCReEIkH6etxso666xSfOD0w,26490
-github2gerrit-2.2.1.dist-info/WHEEL,sha256=THafob7ofN-NsuMN7Mg4qZyHaQI7KkD-QlcQatYhXPo,87
-github2gerrit-2.2.1.dist-info/entry_points.txt,sha256=MxN2_liIKo3-xJwtAulAeS5GcOS6JS96nvwOQIkP3W8,56
-github2gerrit-2.2.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-github2gerrit-2.2.1.dist-info/RECORD,,
+github2gerrit-2.2.2.dist-info/METADATA,sha256=uCAJC9cEIsAnlFIn3wTurSdk4Na-iCAAHJMdKqwRcs0,26490
+github2gerrit-2.2.2.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+github2gerrit-2.2.2.dist-info/entry_points.txt,sha256=MxN2_liIKo3-xJwtAulAeS5GcOS6JS96nvwOQIkP3W8,56
+github2gerrit-2.2.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+github2gerrit-2.2.2.dist-info/RECORD,,

{github2gerrit-2.2.1.dist-info → github2gerrit-2.2.2.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.32.3
+Generator: hatchling 1.32.4
 Root-Is-Purelib: true
 Tag: py3-none-any