github2gerrit 2.4.2__tar.gz → 2.4.3__tar.gz

{github2gerrit-2.4.2 → github2gerrit-2.4.3}/.pre-commit-config.yaml

@@ -86,7 +86,7 @@ repos:
         types: [yaml]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: a56c0b927e6465d37cae3e97d35d4d18ab2b96cd  # frozen: v0.16.9
+    rev: f12be1ebaa5351c1fc76472de98db2c3446c8253  # frozen: v0.16.10
     hooks:
       - id: ruff
         files: ^(src|scripts|tests)/.+\.py$|^sitecustomize\.py$
@@ -104,12 +104,12 @@ repos:
         pass_filenames: false
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 7ff8d35ae36a7d2b968f2f90b4c723e292e594ee  # frozen: v2.3.1
+    rev: 2834ec6639549dd6796205c8f011dedcd587288b  # frozen: v2.4.0
     hooks:
       - id: mypy
         files: ^(src|scripts|tests)/.+\.py$|^sitecustomize\.py$
         additional_dependencies:
-          - mypy==2.3.1
+          - mypy==2.4.0
           - click==8.5.0
           - pytest==9.1.1
           - responses==0.26.3
@@ -153,13 +153,13 @@ repos:
       - id: codespell
 
   - repo: https://github.com/DetachHead/basedpyright-prek-mirror
-    rev: 706e6acebe9e88c2c28d1527d3085a14b11794c4  # frozen: 1.40.1
+    rev: a11caebebdbf797e1e96611123db279b334a7675  # frozen: 1.40.2
     hooks:
       - id: basedpyright
         files: ^(src|scripts|tests)/.+\.py$|^sitecustomize\.py$
 
   - repo: https://github.com/lfreleng-actions/gha-workflow-linter
-    rev: 0c582e431022f1c7004196fb4ea32744d1fe4843  # frozen: v1.7.0
+    rev: b23b60e5884e985320a030e6114032152e2373cd  # frozen: v1.7.1
     hooks:
       - id: gha-workflow-linter
 

{github2gerrit-2.4.2 → github2gerrit-2.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: github2gerrit
-Version: 2.4.2
+Version: 2.4.3
 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

{github2gerrit-2.4.2 → github2gerrit-2.4.3}/action.yaml

@@ -266,7 +266,7 @@ runs:
     - name: "Setup uv"
       if: steps.disabled-check.outputs.disabled != 'true'
       # yamllint disable-line rule:line-length
-      uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4  # v10.1.0
+      uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7  # v10.2.0
       with:
         enable-cache: false
 

{github2gerrit-2.4.2 → github2gerrit-2.4.3}/src/github2gerrit/gitreview.py

@@ -19,15 +19,17 @@ Design goals
   ``config.py`` (host-only), ``core.py`` (host+port+project), and
   ``duplicate_detection.py`` (host+project) is supported, plus the
   ``base_path`` field used by the sister ``dependamerge`` project.
-* **Consistent regex** — a single set of precompiled patterns that
-  tolerates optional whitespace around ``=`` and is case-insensitive on
-  keys (both forms seen in the wild).
+* **Consistent parsing** — a file with a ``[gerrit]`` section is read
+  with ``configparser``, as git-review reads it. Any other file falls
+  back to a single set of precompiled patterns that tolerates optional
+  whitespace around ``=`` and is case-insensitive on keys.
 * **Bug-free fetching** — URL-encodes branch names, deduplicates the
   branch list, and validates raw URLs before opening them.
 """
 
 from __future__ import annotations
 
+import configparser
 import logging
 import os
 import re
@@ -45,9 +47,54 @@ log = logging.getLogger(__name__)
 DEFAULT_GERRIT_PORT: int = 29418
 """Default Gerrit SSH port when the ``port=`` line is absent."""
 
+# Fallback scan for files configparser cannot read (see
+# _read_gerrit_section): keys at the start of a line, anywhere in the file.
 _HOST_RE = re.compile(r"(?mi)^host[ \t]*=[ \t]*(.+?)[ \t\r]*$")
 _PORT_RE = re.compile(r"(?mi)^port[ \t]*=[ \t]*(\d+)[ \t\r]*$")
 _PROJECT_RE = re.compile(r"(?mi)^project[ \t]*=[ \t]*(.+?)[ \t\r]*$")
+_PORT_VALUE_RE = re.compile(r"\d+")
+
+_Fields = tuple[str | None, str | None, str | None]
+"""Raw ``host``, ``port`` and ``project`` values; ``None`` when absent."""
+
+
+def _read_gerrit_section(text: str) -> _Fields | None:
+    """Read the fields as git-review does, through ``configparser``.
+
+    That settles indentation, continuation lines, other sections and
+    ``[DEFAULT]`` inheritance (an empty ``[gerrit]`` value included)
+    exactly as git-review sees them. Returns ``None`` when the text has
+    no ``[gerrit]`` section or ``configparser`` rejects it; git-review
+    cannot read such a file either, so the caller falls back to the
+    lenient scan.
+    """
+    parser = configparser.ConfigParser(interpolation=None)
+    try:
+        parser.read_string(text)
+    except configparser.Error as exc:
+        log.debug(".gitreview: not readable as INI (%s); scanning lines", exc)
+        return None
+    if not parser.has_section("gerrit"):
+        return None
+    section = parser["gerrit"]
+
+    def first_line(key: str) -> str | None:
+        # A continuation makes a multi-line value; a field is one line.
+        value = section.get(key)
+        return None if value is None else value.strip().split("\n", 1)[0]
+
+    return first_line("host"), first_line("port"), first_line("project")
+
+
+def _scan_fields(text: str) -> _Fields:
+    """Find the fields by line pattern anywhere in *text*."""
+    matches = (
+        _HOST_RE.search(text),
+        _PORT_RE.search(text),
+        _PROJECT_RE.search(text),
+    )
+    host, port, project = (m.group(1) if m else None for m in matches)
+    return host, port, project
 
 
 @dataclass(frozen=True)
@@ -144,10 +191,14 @@ def parse_gitreview(text: str) -> GitReviewInfo | None:
 
     This parser is intentionally lenient:
 
-    * Keys are matched case-insensitively.
-    * Optional whitespace around ``=`` is tolerated.
-    * The ``[gerrit]`` section header itself is **not** required —
-      the parser matches the key lines directly.
+    * A file with a ``[gerrit]`` section is read with ``configparser``,
+      as git-review reads it: keys are case-insensitive and may be
+      indented, continuation lines and other sections are ignored, and
+      ``[DEFAULT]`` supplies any field ``[gerrit]`` does not set.
+    * The ``[gerrit]`` header itself is **not** required. A file without
+      one, or one ``configparser`` rejects, is scanned for ``host=``,
+      ``port=`` and ``project=`` lines anywhere, with optional
+      whitespace around ``=``.
 
     Args:
         text: Raw text content of a ``.gitreview`` file.
@@ -156,23 +207,24 @@ def parse_gitreview(text: str) -> GitReviewInfo | None:
         A :class:`GitReviewInfo` if at least ``host`` is present and
         non-empty, otherwise ``None``.
     """
-    host_match = _HOST_RE.search(text)
-    if not host_match:
+    fields = _read_gerrit_section(text)
+    host, port_text, project_text = (
+        fields if fields is not None else _scan_fields(text)
+    )
+    if host is None:
         log.debug(".gitreview: no host= line found")
         return None
 
-    host = host_match.group(1).strip()
+    host = host.strip()
     if not host:
         log.debug(".gitreview: host= line is empty")
         return None
 
-    port_match = _PORT_RE.search(text)
-    port = int(port_match.group(1)) if port_match else DEFAULT_GERRIT_PORT
+    port_text = (port_text or "").strip()
+    port_given = _PORT_VALUE_RE.fullmatch(port_text) is not None
+    port = int(port_text) if port_given else DEFAULT_GERRIT_PORT
 
-    project = ""
-    project_match = _PROJECT_RE.search(text)
-    if project_match:
-        project = project_match.group(1).strip().removesuffix(".git")
+    project = (project_text or "").strip().removesuffix(".git")
 
     base_path = derive_base_path(host)
 
@@ -181,7 +233,7 @@ def parse_gitreview(text: str) -> GitReviewInfo | None:
         port=port,
         project=project,
         base_path=base_path,
-        port_given=port_match is not None,
+        port_given=port_given,
     )
     log.debug(
         "Parsed .gitreview: host=%s, port=%d, project=%s, base_path=%s",

{github2gerrit-2.4.2 → github2gerrit-2.4.3}/tests/test_gitreview.py

@@ -75,6 +75,19 @@ NON_DEFAULT_PORT = (
     "[gerrit]\nhost=gerrit.acme.org\nport=29419\nproject=acme/widgets.git\n"
 )
 
+# The form LF automation wrote into ONAP repositories in 2020, as found in
+# onap/cps: a leading blank line and every line indented by eight spaces.
+# git-review reads it, since configparser ignores leading whitespace.
+INDENTED_GITREVIEW = (
+    "\n"
+    "        [gerrit]\n"
+    "        host=gerrit.onap.org\n"
+    "        port=29418\n"
+    "        project=cps\n"
+    "        defaultbranch=master\n"
+    "        "
+)
+
 
 # -----------------------------------------------------------------------
 # GitReviewInfo data model
@@ -223,6 +236,15 @@ class TestParseGitreview:
         assert info.port == 29419
         assert info.port_given is True
 
+    def test_unicode_decimal_port(self) -> None:
+        # int() accepts any Unicode decimal digits, as the \d in the port
+        # pattern does; Arabic-Indic "٢٩٤١٩" is 29419.
+        text = "[gerrit]\nhost=h.example.org\nport=\u0662\u0669\u0664\u0661\u0669\n"
+        info = parse_gitreview(text)
+        assert info is not None
+        assert info.port == 29419
+        assert info.port_given is True
+
     def test_empty_string(self) -> None:
         assert parse_gitreview("") is None
 
@@ -253,6 +275,181 @@ class TestParseGitreview:
         assert info is not None
         assert info.host == "gerrit.example.org"
 
+    def test_space_indented_keys(self) -> None:
+        info = parse_gitreview(INDENTED_GITREVIEW)
+        assert info is not None
+        assert info.host == "gerrit.onap.org"
+        assert info.port == 29418
+        assert info.port_given is True
+        assert info.project == "cps"
+
+    def test_tab_indented_keys(self) -> None:
+        text = (
+            "[gerrit]\n\thost=gerrit.example.org\n\tport=29419\n\tproject=a/b\n"
+        )
+        info = parse_gitreview(text)
+        assert info is not None
+        assert info.host == "gerrit.example.org"
+        assert info.port == 29419
+        assert info.project == "a/b"
+
+    def test_key_inside_a_line_is_not_matched(self) -> None:
+        text = "[gerrit]\nnote = set host=wrong.example.org\nxhost=wrong\n"
+        assert parse_gitreview(text) is None
+
+    def test_headerless_file_is_searched_whole(self) -> None:
+        info = parse_gitreview("host=h.example.org\nport=29419\nproject=p\n")
+        assert info is not None
+        assert (info.host, info.port, info.project) == (
+            "h.example.org",
+            29419,
+            "p",
+        )
+
+    def test_file_configparser_rejects_is_searched_whole(self) -> None:
+        # A duplicate section makes configparser raise, so git-review
+        # cannot read this file at all; the lenient scan still serves it.
+        text = "[gerrit]\nhost=a.example.org\n[gerrit]\nhost=b.example.org\n"
+        info = parse_gitreview(text)
+        assert info is not None
+        assert info.host == "a.example.org"
+
+    @pytest.mark.parametrize("key", ["host", "port", "project"])
+    def test_continuation_line_is_not_a_key(self, key: str) -> None:
+        # configparser folds a line indented deeper than the option
+        # above it into that option's value; git-review never sees it
+        # as a key, so neither may this parser.
+        value = {"host": "wrong.example.org", "port": "1", "project": "wrong"}
+        text = (
+            "[gerrit]\n"
+            "host=right.example.org\n"
+            "port=29419\n"
+            "project=right\n"
+            "note = explanation\n"
+            f"    {key}={value[key]}\n"
+        )
+        info = parse_gitreview(text)
+        assert info is not None
+        assert (info.host, info.port, info.project) == (
+            "right.example.org",
+            29419,
+            "right",
+        )
+
+    @pytest.mark.parametrize(
+        "gap",
+        ["\n", "# comment\n", "; comment\n"],
+        ids=["blank", "hash", "semi"],
+    )
+    def test_continuation_survives_blank_and_comment_lines(
+        self, gap: str
+    ) -> None:
+        text = f"[gerrit]\nnote = x\n{gap}    host=wrong.example.org\n"
+        assert parse_gitreview(text) is None
+
+
+# Layouts on which parse_gitreview must agree with configparser, the
+# reader git-review uses. Each is a valid .gitreview a repository could
+# hold; the parser is lenient beyond this, but never contrary to it.
+CONFIGPARSER_LAYOUTS = [
+    pytest.param(TYPICAL_GITREVIEW, id="flat"),
+    pytest.param(INDENTED_GITREVIEW, id="all-indented"),
+    pytest.param(
+        "[gerrit]\n\thost=h.example.org\n\tport=29419\n\tproject=p\n",
+        id="tab-indented",
+    ),
+    pytest.param(
+        "[gerrit]\n    host=h.example.org\n",
+        id="indented-under-flat-header",
+    ),
+    pytest.param(
+        "[gerrit]\n    host=h.example.org\nport=29419\n",
+        id="dedent-after-indent",
+    ),
+    pytest.param(
+        "[gerrit]\nnote = x\n    host=wrong.example.org\n", id="continuation"
+    ),
+    pytest.param(
+        "[gerrit]\nnote = x\n    host=wrong.example.org\nhost=h.example.org\n",
+        id="continuation-then-key",
+    ),
+    pytest.param(
+        "[gerrit]\nhost=h.example.org\n    port=1\n", id="continuation-of-host"
+    ),
+    pytest.param(
+        "[gerrit]\n  note = x\n    port=1\n  host=h.example.org\n",
+        id="deeper-option-ends-run",
+    ),
+    pytest.param(
+        "[other]\n    host=wrong.example.org\n    port=1\n    project=wrong\n"
+        "[gerrit]\nhost=right.example.org\nport=29419\nproject=right\n",
+        id="indented-keys-in-other-section",
+    ),
+    pytest.param(
+        "[other]\nhost=wrong.example.org\nport=1\nproject=wrong\n"
+        "[gerrit]\nhost=right.example.org\nport=29419\nproject=right\n",
+        id="flat-keys-in-earlier-section",
+    ),
+    pytest.param(
+        "[gerrit]\nhost=right.example.org\n[other]\nport=1\nproject=wrong\n",
+        id="flat-keys-in-later-section",
+    ),
+    pytest.param(
+        "[DEFAULT]\nhost=default.example.org\nport=29419\n[gerrit]\nproject=p\n",
+        id="default-section-fills-gerrit",
+    ),
+    pytest.param(
+        "[DEFAULT]\nhost=default.example.org\nport=1\n"
+        "[gerrit]\nhost=right.example.org\nport=29419\n",
+        id="gerrit-overrides-earlier-default",
+    ),
+    pytest.param(
+        "[gerrit]\nhost=right.example.org\n[DEFAULT]\nhost=default.example.org\n",
+        id="gerrit-overrides-later-default",
+    ),
+    pytest.param(
+        "[DEFAULT]\nhost=default.example.org\n[gerrit]\nhost=\n",
+        id="empty-host-overrides-default",
+    ),
+    pytest.param(
+        "[DEFAULT]\nport=1\n[gerrit]\nhost=h.example.org\nport=\n",
+        id="empty-port-overrides-default",
+    ),
+    pytest.param(
+        "[DEFAULT]\nproject=wrong\n[gerrit]\nhost=h.example.org\nproject=\n",
+        id="empty-project-overrides-default",
+    ),
+]
+
+
+def _first_line(value: str) -> str:
+    """Return the first line of a configparser value, stripped.
+
+    configparser joins continuation lines into the value; a .gitreview
+    field is single-line, so only the first line is comparable.
+    """
+    return value.strip().split("\n", 1)[0].strip()
+
+
+@pytest.mark.parametrize("text", CONFIGPARSER_LAYOUTS)
+def test_agrees_with_configparser(text: str) -> None:
+    import configparser
+
+    parser = configparser.ConfigParser(interpolation=None)
+    parser.read_string(text)
+    section = parser["gerrit"]
+    info = parse_gitreview(text)
+    expected_host = _first_line(section.get("host", ""))
+    if not expected_host:
+        assert info is None
+        return
+    assert info is not None
+    assert info.host == expected_host
+    port = _first_line(section.get("port", "")) or str(DEFAULT_GERRIT_PORT)
+    assert info.port == int(port)
+    project = _first_line(section.get("project", "")).removesuffix(".git")
+    assert info.project == project
+
 
 # -----------------------------------------------------------------------
 # read_local_gitreview — local file reader
@@ -275,6 +472,14 @@ class TestReadLocalGitreview:
         p.write_text("garbage\n", encoding="utf-8")
         assert read_local_gitreview(p) is None
 
+    def test_reads_indented_file(self, tmp_path: Path) -> None:
+        p = tmp_path / ".gitreview"
+        p.write_text(INDENTED_GITREVIEW, encoding="utf-8")
+        info = read_local_gitreview(p)
+        assert info is not None
+        assert info.host == "gerrit.onap.org"
+        assert info.project == "cps"
+
     def test_returns_none_for_unreadable(self, tmp_path: Path) -> None:
         p = tmp_path / ".gitreview"
         p.write_text(TYPICAL_GITREVIEW, encoding="utf-8")