Disable GitHub summary when there's only one tox environment (#166)

* Disable GitHub summary when there's only one tox environment

* PR feedback

Signed-off-by: Bernát Gábor <[email protected]>

---------

Signed-off-by: Bernát Gábor <[email protected]>
Co-authored-by: Bernát Gábor <[email protected]>

Author: kemzeb

pyproject.toml

@@ -76,7 +76,6 @@ lint.select = [
   "ALL",
 ]
 lint.ignore = [
-  "ANN101", # Missing type annotation for `self` in method
   "COM812", # Conflict with formatter
   "CPY",    # No copyright statements
   "D203",   # `one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible
@@ -86,6 +85,7 @@ lint.ignore = [
   "D401",   # First line of docstring should be in imperative mood
   "DOC",    # not supported
   "ISC001", # Conflict with formatter
+  "LOG015", # call on root logger
   "S104",   # Possible binding to all interface
 ]
 lint.per-file-ignores."tests/**/*.py" = [

src/tox_gh/plugin.py

@@ -23,6 +23,7 @@
     from tox.tox_env.api import ToxEnv
 
 GITHUB_STEP_SUMMARY = os.getenv("GITHUB_STEP_SUMMARY")
+WILL_RUN_MULTIPLE_ENVS = False
 
 
 def is_running_on_actions() -> bool:
@@ -69,6 +70,8 @@ def tox_add_core_config(core_conf: ConfigSet, state: State) -> None:
     :param core_conf: the core configuration
     :param state: tox state object
     """
+    global WILL_RUN_MULTIPLE_ENVS  # noqa: PLW0603
+
     core_conf.add_constant(keys="is_on_gh_action", desc="flag for running on Github", value=is_running_on_actions())
 
     bail_reason = None
@@ -88,6 +91,7 @@ def tox_add_core_config(core_conf: ConfigSet, state: State) -> None:
     if env_list is not None:  # override the env_list core configuration with our values
         logging.warning("tox-gh set %s", ", ".join(env_list))
         state.conf.core.loaders.insert(0, MemoryLoader(env_list=env_list))
+        WILL_RUN_MULTIPLE_ENVS = len(env_list.envs) > 1
 
 
 _STATE = threading.local()
@@ -136,7 +140,8 @@ def tox_after_run_commands(tox_env: ToxEnv, exit_code: int, outcomes: list[Outco
     """
     if tox_env.core["is_on_gh_action"]:
         print("::endgroup::")  # noqa: T201
-        write_to_summary(exit_code == Outcome.OK, tox_env.name)
+        if WILL_RUN_MULTIPLE_ENVS:
+            write_to_summary(exit_code == Outcome.OK, tox_env.name)
 
 
 def write_to_summary(success: bool, message: str) -> None:  # noqa: FBT001

tests/test_tox_gh.py

@@ -19,6 +19,14 @@ def _clear_env_var(monkeypatch: MonkeyPatch) -> None:
     monkeypatch.delenv("TOX_GH_MAJOR_MINOR", raising=False)
 
 
+@pytest.fixture
+def summary_output_path(monkeypatch: MonkeyPatch, tmp_path: Path) -> Path:
+    path = tmp_path / "gh_out"
+    path.touch()
+    monkeypatch.setattr(plugin, "GITHUB_STEP_SUMMARY", str(path))
+    return path
+
+
 def test_gh_not_in_actions(monkeypatch: MonkeyPatch, tox_project: ToxProjectCreator) -> None:
     monkeypatch.delenv("GITHUB_ACTIONS", raising=False)
     project = tox_project({"tox.ini": "[testenv]\npackage=skip"})
@@ -54,18 +62,17 @@ def test_gh_toxenv_set(monkeypatch: MonkeyPatch, tox_project: ToxProjectCreator)
 
 
 @pytest.mark.parametrize("via_env", [True, False])
-def test_gh_ok(monkeypatch: MonkeyPatch, tox_project: ToxProjectCreator, tmp_path: Path, via_env: bool) -> None:
+def test_gh_ok(
+    monkeypatch: MonkeyPatch, tox_project: ToxProjectCreator, tmp_path: Path, summary_output_path: Path, via_env: bool
+) -> None:
     if via_env:
         monkeypatch.setenv("TOX_GH_MAJOR_MINOR", f"{sys.version_info.major}.{sys.version_info.minor}")
     else:
         monkeypatch.setenv("PATH", "")
-    step_output_file = tmp_path / "gh_out"
-    step_output_file.touch()
     empty_requirements = tmp_path / "empty.txt"
     empty_requirements.touch()
     monkeypatch.setenv("GITHUB_ACTIONS", "true")
     monkeypatch.delenv("TOXENV", raising=False)
-    monkeypatch.setattr(plugin, "GITHUB_STEP_SUMMARY", str(step_output_file))
     ini = f"""
     [testenv]
     package = editable
@@ -111,17 +118,14 @@ def test_gh_ok(monkeypatch: MonkeyPatch, tox_project: ToxProjectCreator, tmp_pat
     assert "a: OK" in result.out
     assert "b: OK" in result.out
 
-    summary_text = step_output_file.read_text()
+    summary_text = summary_output_path.read_text()
     assert ":white_check_mark:: a" in summary_text
     assert ":white_check_mark:: b" in summary_text
 
 
-def test_gh_fail(monkeypatch: MonkeyPatch, tox_project: ToxProjectCreator, tmp_path: Path) -> None:
-    step_output_file = tmp_path / "gh_out"
-    step_output_file.touch()
+def test_gh_fail(monkeypatch: MonkeyPatch, tox_project: ToxProjectCreator, summary_output_path: Path) -> None:
     monkeypatch.setenv("GITHUB_ACTIONS", "true")
     monkeypatch.delenv("TOXENV", raising=False)
-    monkeypatch.setattr(plugin, "GITHUB_STEP_SUMMARY", str(step_output_file))
     ini = f"""
     [testenv]
     package = skip
@@ -162,6 +166,45 @@ def test_gh_fail(monkeypatch: MonkeyPatch, tox_project: ToxProjectCreator, tmp_p
     assert "a: FAIL code 1" in result.out
     assert "b: FAIL code 1" in result.out
 
-    summary_text = step_output_file.read_text()
+    summary_text = summary_output_path.read_text()
     assert ":negative_squared_cross_mark:: a" in summary_text
     assert ":negative_squared_cross_mark:: b" in summary_text
+
+
+def test_gh_single_env_ok(monkeypatch: MonkeyPatch, tox_project: ToxProjectCreator, summary_output_path: Path) -> None:
+    monkeypatch.setenv("GITHUB_ACTIONS", "true")
+    monkeypatch.delenv("TOXENV", raising=False)
+    ini = f"""
+    [testenv]
+    package = editable
+    [gh]
+    python =
+        {sys.version_info[0]} = a
+    """
+    project = tox_project({"tox.ini": ini})
+    result = project.run()
+    result.assert_success()
+
+    summary_text = summary_output_path.read_text()
+    assert len(summary_text) == 0
+
+
+def test_gh_single_env_fail(
+    monkeypatch: MonkeyPatch, tox_project: ToxProjectCreator, summary_output_path: Path
+) -> None:
+    monkeypatch.setenv("GITHUB_ACTIONS", "true")
+    monkeypatch.delenv("TOXENV", raising=False)
+    ini = f"""
+    [testenv]
+    package = skip
+    commands = python -c exit(1)
+    [gh]
+    python =
+        {sys.version_info[0]} = a
+    """
+    project = tox_project({"tox.ini": ini})
+    result = project.run()
+    result.assert_failed()
+
+    summary_text = summary_output_path.read_text()
+    assert len(summary_text) == 0