fix tests

Author: filipchristiansen

.pre-commit-config.yaml

@@ -44,7 +44,7 @@ repos:
       - id: black
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.19.1
+    rev: v3.20.0
     hooks:
       - id: pyupgrade
         description: "Automatically upgrade syntax for newer versions."
@@ -73,7 +73,7 @@ repos:
       - id: djlint-reformat-jinja
 
   - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.44.0
+    rev: v0.45.0
     hooks:
       - id: markdownlint
         description: "Lint markdown files."
@@ -88,7 +88,7 @@ repos:
         files: ^src/
 
   - repo: https://github.com/pycqa/pylint
-    rev: v3.3.6
+    rev: v3.3.7
     hooks:
       - id: pylint
         name: pylint for source

src/gitingest/cli.py

@@ -163,15 +163,15 @@ async def _async_main(
             token=token,
         )
 
-        if output != "-":
-            click.echo(f"Analysis complete! Output written to: {output_target}")
-            click.echo("\nSummary:")
-            click.echo(summary)
-        else:
+        if output_target == "-":  # stdout
             click.echo("\n--- Summary ---", err=True)
             click.echo(summary, err=True)
             click.echo("--- End Summary ---", err=True)
             click.echo("Analysis complete! Output sent to stdout.", err=True)
+        else:  # file
+            click.echo(f"Analysis complete! Output written to: {output_target}")
+            click.echo("\nSummary:")
+            click.echo(summary)
 
     except Exception as exc:
         # Convert any exception into Click.Abort so that exit status is non-zero

tests/test_cli.py

@@ -1,63 +1,80 @@
-"""Tests for the gitingest cli."""
+"""Tests for the Gitingest CLI."""
 
 import os
 from inspect import signature
+from pathlib import Path
+from typing import List
 
-from click.testing import CliRunner
+import pytest
+from _pytest.monkeypatch import MonkeyPatch
+from click.testing import CliRunner, Result
 
 from gitingest.cli import main
 from gitingest.config import MAX_FILE_SIZE, OUTPUT_FILE_NAME
 
 
-def test_cli_with_default_options():
-    runner = CliRunner()
-    result = runner.invoke(main, ["./"])
-    output_lines = result.output.strip().split("\n")
-    assert f"Analysis complete! Output written to: {OUTPUT_FILE_NAME}" in output_lines
-    assert os.path.exists(OUTPUT_FILE_NAME), f"Output file was not created at {OUTPUT_FILE_NAME}"
-
-    os.remove(OUTPUT_FILE_NAME)
-
-
-def test_cli_with_options():
-    runner = CliRunner()
-    result = runner.invoke(
-        main,
-        [
-            "./",
-            "--output",
-            str(OUTPUT_FILE_NAME),
-            "--max-size",
-            str(MAX_FILE_SIZE),
-            "--exclude-pattern",
-            "tests/",
-            "--include-pattern",
-            "src/",
-        ],
-    )
-    output_lines = result.output.strip().split("\n")
-    assert f"Analysis complete! Output written to: {OUTPUT_FILE_NAME}" in output_lines
-    assert os.path.exists(OUTPUT_FILE_NAME), f"Output file was not created at {OUTPUT_FILE_NAME}"
-
-    os.remove(OUTPUT_FILE_NAME)
-
-
-def test_cli_with_stdout_output():
-    """Test CLI invocation with output directed to STDOUT."""
+@pytest.mark.parametrize(
+    "cli_args, expect_file",
+    [
+        pytest.param(["./"], True, id="default-options"),
+        pytest.param(
+            [
+                "./",
+                "--output",
+                str(OUTPUT_FILE_NAME),
+                "--max-size",
+                str(MAX_FILE_SIZE),
+                "--exclude-pattern",
+                "tests/",
+                "--include-pattern",
+                "src/",
+            ],
+            True,
+            id="custom-options",
+        ),
+    ],
+)
+def test_cli_writes_file(tmp_path: Path, monkeypatch: MonkeyPatch, cli_args: list[str], expect_file: bool) -> None:
+    """Run the CLI and verify that the SARIF file is created (or not)."""
+    # Work inside an isolated temp directory
+    monkeypatch.chdir(tmp_path)
 
-    kwargs = {}
-    if "mix_stderr" in signature(CliRunner.__init__).parameters:
-        kwargs["mix_stderr"] = (
-            False  # Click < 8.2 (https://click.palletsprojects.com/en/stable/changes/#version-8-2-0)
-        )
+    result = _invoke_isolated_cli_runner(cli_args)
 
-    runner = CliRunner(**kwargs)
-    result = runner.invoke(main, ["./", "--output", "-", "--exclude-pattern", "tests/"])
+    assert result.exit_code == 0, result.stderr
 
+    # Summary line should be on STDOUT
+    stdout_lines = result.stdout.splitlines()
+    assert f"Analysis complete! Output written to: {OUTPUT_FILE_NAME}" in stdout_lines
+
+    # File side-effect
+    sarif_file = tmp_path / OUTPUT_FILE_NAME
+    assert sarif_file.exists() is expect_file, f"{OUTPUT_FILE_NAME} existence did not match expectation"
+
+
+def test_cli_with_stdout_output() -> None:
+    """Test CLI invocation with output directed to STDOUT."""
+    result = _invoke_isolated_cli_runner(["./", "--output", "-", "--exclude-pattern", "tests/"])
+
+    # ─── core expectations (stdout) ────────────────────────────────────-
     assert result.exit_code == 0, f"CLI exited with code {result.exit_code}, stderr: {result.stderr}"
-    assert "---" in result.output, "Expected file separator '---' not found in STDOUT"
-    assert "src/gitingest/cli.py" in result.output, "Expected content (e.g., src/gitingest/cli.py) not found in STDOUT"
+    assert "---" in result.stdout, "Expected file separator '---' not found in STDOUT"
+    assert "src/gitingest/cli.py" in result.stdout, "Expected content (e.g., src/gitingest/cli.py) not found in STDOUT"
     assert not os.path.exists(OUTPUT_FILE_NAME), f"Output file {OUTPUT_FILE_NAME} was unexpectedly created."
-    assert "Analysis complete!  Output sent to stdout." not in result.output
-    assert "Analysis complete!" in result.stderr, "Expected summary message 'Analysis complete!' not found in STDERR"
-    assert f"Output written to: {OUTPUT_FILE_NAME}" not in result.stderr
+
+    # ─── the summary must *not* pollute STDOUT, must appear on STDERR ───
+    summary = "Analysis complete! Output sent to stdout."
+    stdout_lines = result.stdout.splitlines()
+    stderr_lines = result.stderr.splitlines()
+    assert summary not in stdout_lines, "Unexpected summary message found in STDOUT"
+    assert summary in stderr_lines, "Expected summary message not found in STDERR"
+    assert f"Output written to: {OUTPUT_FILE_NAME}" not in stderr_lines
+
+
+def _invoke_isolated_cli_runner(args: List[str]) -> Result:
+    """Return a CliRunner that keeps stderr apart on Click 8.0-8.1."""
+    kwargs = {}
+    if "mix_stderr" in signature(CliRunner.__init__).parameters:
+        kwargs["mix_stderr"] = False  # Click 8.0–8.1
+    runner = CliRunner(**kwargs)
+    return runner.invoke(main, args)