fix: better error report when token/repo are empty (#138)

It's very easy in GitHub Actions to do:

run:
    env:
      - MERGIFY_TOKEN: ${{ secrets.MERGIFY_TOKEN }}

And having secrets.MERGIFY_TOKEN empty because of typo, secrets permission issues, misconfigured reusable workflow.

This configuration effectively set the the env but it's an empty string.

The current code don't start a tracer as expected, but didn't report anything.

This adds:
* the reporting for when repo_name and token are empty.
* an generic error message if the tracer didn't start for some reason and we didn't provide the root cause.

Fixes MRGFY-5471

Author: sileht

pytest_mergify/__init__.py

@@ -39,43 +39,46 @@ def pytest_terminal_summary(
 
         terminalreporter.section("Mergify CI")
 
-        # Make sure we shutdown and flush traces before existing: this makes
-        # sure that we capture the possible error logs, otherwise they are
-        # emitted on exit (atexit()).
-        if self.mergify_tracer.tracer_provider is not None:
-            try:
-                self.mergify_tracer.tracer_provider.force_flush()
-            except Exception as e:
+        if self.mergify_tracer.tracer_provider is None:
+            if not self.mergify_tracer.token:
                 terminalreporter.write_line(
-                    f"Error while exporting traces: {e}",
-                    red=True,
-                )
-            else:
-                terminalreporter.write_line(
-                    f"MERGIFY_TEST_RUN_ID={self.mergify_tracer.test_run_id}",
+                    "No token configured for Mergify; test results will not be uploaded",
+                    yellow=True,
                 )
+                return
 
-            try:
-                self.mergify_tracer.tracer_provider.shutdown()
-            except Exception as e:
+            if not self.mergify_tracer.repo_name:
                 terminalreporter.write_line(
-                    f"Error while shutting down the tracer: {e}",
+                    "Unable to determine repository name; test results will not be uploaded",
                     red=True,
                 )
+                return
 
-        if self.mergify_tracer.token is None:
             terminalreporter.write_line(
-                "No token configured for Mergify; test results will not be uploaded",
-                yellow=True,
+                "Mergify Tracer didn't start for unexpected reason (Please contact Mergify support); test results will not be uploaded",
+                red=True,
             )
             return
 
-        if self.mergify_tracer.repo_name is None:
+        try:
+            self.mergify_tracer.tracer_provider.force_flush()
+        except Exception as e:
             terminalreporter.write_line(
-                "Unable to determine repository name; test results will not be uploaded",
+                f"Error while exporting traces: {e}",
+                red=True,
+            )
+        else:
+            terminalreporter.write_line(
+                f"MERGIFY_TEST_RUN_ID={self.mergify_tracer.test_run_id}",
+            )
+
+        try:
+            self.mergify_tracer.tracer_provider.shutdown()
+        except Exception as e:
+            terminalreporter.write_line(
+                f"Error while shutting down the tracer: {e}",
                 red=True,
             )
-            return
 
     @property
     def tracer(self) -> typing.Optional[opentelemetry.trace.Tracer]:

tests/test_plugin.py

@@ -33,9 +33,28 @@ def test_enabled(
     assert any("Mergify CI" in line for line in result.stdout.lines)
 
 
+def test_empty_token(pytester_with_spans: conftest.PytesterWithSpanT) -> None:
+    result, spans = pytester_with_spans(
+        setenv={
+            "MERGIFY_TOKEN": "",
+            "_PYTEST_MERGIFY_TEST": None,
+        }
+    )
+    assert spans is None
+    assert (
+        "No token configured for Mergify; test results will not be uploaded"
+        in result.stdout.lines
+    )
+
+
 def test_no_token(pytester_with_spans: conftest.PytesterWithSpanT) -> None:
-    result, spans = pytester_with_spans()
-    assert spans is not None
+    result, spans = pytester_with_spans(
+        setenv={
+            "MERGIFY_TOKEN": None,
+            "_PYTEST_MERGIFY_TEST": None,
+        }
+    )
+    assert spans is None
     assert (
         "No token configured for Mergify; test results will not be uploaded"
         in result.stdout.lines
@@ -84,6 +103,23 @@ def test_repo_name_github_actions(
     assert plugin.mergify_tracer.repo_name == "Mergifyio/pytest-mergify"
 
 
+def test_with_token_empty_repo(
+    pytester_with_spans: conftest.PytesterWithSpanT,
+) -> None:
+    result, spans = pytester_with_spans(
+        setenv={
+            "GITHUB_ACTIONS": "true",
+            "MERGIFY_TOKEN": "x",
+            "_PYTEST_MERGIFY_TEST": "false",
+            "GITHUB_REPOSITORY": "",
+        }
+    )
+    assert (
+        "Unable to determine repository name; test results will not be uploaded"
+        in result.stdout.lines
+    )
+
+
 def test_with_token_no_repo(
     pytester_with_spans: conftest.PytesterWithSpanT,
 ) -> None: