feat: add GITHUB_REF fallback for --tests-target-branch (#721)

- Add GITHUB_REF as fallback environment variable for --tests-target-branch
- Strip refs/heads/ prefix from --tests-target-branch values automatically
- Maintain precedence: GITHUB_BASE_REF > MERGIFY_TESTS_TARGET_BRANCH > GITHUB_REF

Author: JulianMaurin

mergify_cli/ci/cli.py

@@ -11,6 +11,15 @@
 from mergify_cli.ci import upload
 
 
+def _process_tests_target_branch(
+    _ctx: click.Context,
+    _param: click.Parameter,
+    value: str | None,
+) -> str | None:
+    """Process the tests_target_branch parameter to strip refs/heads/ prefix from GITHUB_REF."""
+    return value.removeprefix("refs/heads/") if value else value
+
+
 ci = click.Group(
     "ci",
     help="Mergify's CI related commands",
@@ -54,7 +63,8 @@
     "-ttb",
     help="The branch used to check if failing tests can be ignored with Mergify's Quarantine.",
     required=True,
-    envvar=["GITHUB_BASE_REF", "MERGIFY_TESTS_TARGET_BRANCH"],
+    envvar=["GITHUB_BASE_REF", "MERGIFY_TESTS_TARGET_BRANCH", "GITHUB_REF"],
+    callback=_process_tests_target_branch,
 )
 @click.argument(
     "files",
@@ -124,7 +134,8 @@ async def junit_upload(  # noqa: PLR0913
     "-ttb",
     help="The branch used to check if failing tests can be ignored with Mergify's Quarantine.",
     required=True,
-    envvar=["GITHUB_BASE_REF", "MERGIFY_TESTS_TARGET_BRANCH"],
+    envvar=["GITHUB_BASE_REF", "MERGIFY_TESTS_TARGET_BRANCH", "GITHUB_REF"],
+    callback=_process_tests_target_branch,
 )
 @click.argument(
     "files",

mergify_cli/tests/ci/test_cli.py

@@ -2,6 +2,7 @@
 from unittest import mock
 
 import anys
+import click
 from click import testing
 import pytest
 
@@ -76,6 +77,115 @@ def test_cli(env: dict[str, str], monkeypatch: pytest.MonkeyPatch) -> None:
     }
 
 
+@pytest.mark.parametrize(
+    ("env", "expected_branch"),
+    [
+        pytest.param(
+            {
+                "GITHUB_EVENT_NAME": "push",
+                "GITHUB_ACTIONS": "true",
+                "MERGIFY_API_URL": "https://api.mergify.com",
+                "MERGIFY_TOKEN": "abc",
+                "GITHUB_REPOSITORY": "user/repo",
+                "GITHUB_SHA": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
+                "GITHUB_WORKFLOW": "JOB",
+                "GITHUB_REF": "refs/heads/feature-branch",
+            },
+            "feature-branch",
+            id="GITHUB_REF with refs/heads/ prefix",
+        ),
+        pytest.param(
+            {
+                "GITHUB_EVENT_NAME": "push",
+                "GITHUB_ACTIONS": "true",
+                "MERGIFY_API_URL": "https://api.mergify.com",
+                "MERGIFY_TOKEN": "abc",
+                "GITHUB_REPOSITORY": "user/repo",
+                "GITHUB_SHA": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
+                "GITHUB_WORKFLOW": "JOB",
+                "GITHUB_REF": "main",
+            },
+            "main",
+            id="GITHUB_REF without refs/heads/ prefix",
+        ),
+        pytest.param(
+            {
+                "GITHUB_EVENT_NAME": "push",
+                "GITHUB_ACTIONS": "true",
+                "MERGIFY_API_URL": "https://api.mergify.com",
+                "MERGIFY_TOKEN": "abc",
+                "GITHUB_REPOSITORY": "user/repo",
+                "GITHUB_SHA": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
+                "GITHUB_WORKFLOW": "JOB",
+                "GITHUB_BASE_REF": "main",
+                "GITHUB_REF": "refs/heads/feature-branch",
+            },
+            "main",
+            id="GITHUB_BASE_REF takes precedence over GITHUB_REF",
+        ),
+        pytest.param(
+            {
+                "GITHUB_EVENT_NAME": "push",
+                "GITHUB_ACTIONS": "true",
+                "MERGIFY_API_URL": "https://api.mergify.com",
+                "MERGIFY_TOKEN": "abc",
+                "GITHUB_REPOSITORY": "user/repo",
+                "GITHUB_SHA": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
+                "GITHUB_WORKFLOW": "JOB",
+                "MERGIFY_TESTS_TARGET_BRANCH": "develop",
+                "GITHUB_REF": "refs/heads/feature-branch",
+            },
+            "develop",
+            id="MERGIFY_TESTS_TARGET_BRANCH takes precedence over GITHUB_REF",
+        ),
+        pytest.param(
+            {
+                "GITHUB_EVENT_NAME": "push",
+                "GITHUB_ACTIONS": "true",
+                "MERGIFY_API_URL": "https://api.mergify.com",
+                "MERGIFY_TOKEN": "abc",
+                "GITHUB_REPOSITORY": "user/repo",
+                "GITHUB_SHA": "3af96aa24f1d32fcfbb7067793cacc6dc0c6b199",
+                "GITHUB_WORKFLOW": "JOB",
+                "GITHUB_REF": "refs/tags/v1.0.0",
+            },
+            "refs/tags/v1.0.0",
+            id="GITHUB_REF with refs/tags/ prefix (should not be stripped)",
+        ),
+    ],
+)
+def test_tests_target_branch_environment_variable_processing(
+    env: dict[str, str],
+    expected_branch: str,
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    """Test that tests_target_branch environment variable processing works correctly."""
+    for key in ["GITHUB_REF", "GITHUB_BASE_REF"]:  # Override value from CI runner
+        monkeypatch.delenv(key, raising=False)
+
+    for key, value in env.items():
+        monkeypatch.setenv(key, value)
+
+    runner = testing.CliRunner()
+
+    with mock.patch.object(
+        cli_junit_upload,
+        "_process_junit_files",
+        mock.AsyncMock(),
+    ) as mocked_process_junit_files:
+        result = runner.invoke(
+            cli_junit_upload.junit_process,
+            [str(REPORT_XML)],
+        )
+
+    assert result.exit_code == 0, result.stdout
+
+    # Check that _process_junit_files was called with the expected branch
+    assert mocked_process_junit_files.call_count == 1
+    call_kwargs = mocked_process_junit_files.call_args.kwargs
+    assert call_kwargs["tests_target_branch"] == expected_branch
+
+
 def test_upload_error(monkeypatch: pytest.MonkeyPatch) -> None:
     for key, value in {
         "GITHUB_EVENT_NAME": "push",
@@ -114,3 +224,62 @@ def test_upload_error(monkeypatch: pytest.MonkeyPatch) -> None:
         "repository": "user/repo",
         "spans": anys.ANY_LIST,
     }
+
+
+def test_process_tests_target_branch_callback() -> None:
+    """Test the _process_tests_target_branch callback function directly."""
+    context_mock = mock.MagicMock(spec=click.Context)
+    param_mock = mock.MagicMock(spec=click.Parameter)
+
+    # Test stripping refs/heads/ prefix
+    assert (
+        cli_junit_upload._process_tests_target_branch(
+            context_mock,
+            param_mock,
+            "refs/heads/main",
+        )
+        == "main"
+    )
+    assert (
+        cli_junit_upload._process_tests_target_branch(
+            context_mock,
+            param_mock,
+            "refs/heads/feature-branch",
+        )
+        == "feature-branch"
+    )
+
+    # Test not stripping other prefixes
+    assert (
+        cli_junit_upload._process_tests_target_branch(
+            context_mock,
+            param_mock,
+            "refs/tags/v1.0.0",
+        )
+        == "refs/tags/v1.0.0"
+    )
+    assert (
+        cli_junit_upload._process_tests_target_branch(
+            context_mock,
+            param_mock,
+            "main",
+        )
+        == "main"
+    )
+
+    # Test None value
+    assert (
+        cli_junit_upload._process_tests_target_branch(
+            context_mock,
+            param_mock,
+            None,
+        )
+        is None
+    )
+
+    # Test empty string
+    assert not cli_junit_upload._process_tests_target_branch(
+        context_mock,
+        param_mock,
+        "",
+    )

pyproject.toml

@@ -148,7 +148,7 @@ ignore = [
 ]
 
 [tool.ruff.lint.per-file-ignores]
-"mergify_cli/tests/**/*.py" = ["S101"]
+"mergify_cli/tests/**/*.py" = ["S101", "SLF001"]
 
 [tool.ruff.lint.isort]
 force-single-line = true