Add tests for caching-related CLI

Author: lagru

docs/command_line.md

@@ -15,7 +15,8 @@ Options:
   -h, --help  Show this message and exit.
 
 Commands:
-  run  Generate Python stub files.
+  clean  Clean the cache.
+  run    Generate Python stub files.
 ```
 
 <!--- end cli-docstub --->
@@ -58,3 +59,24 @@ Options:
 ```
 
 <!--- end cli-docstub-run --->
+
+
+## Command `docstub clean`
+
+<!--- The following block is checked by the test suite --->
+<!--- begin cli-docstub-clean --->
+
+```plain
+Usage: docstub clean [OPTIONS]
+
+  Clean the cache.
+
+  Looks for a cache directory relative to the current working directory. If
+  one exists, remove it.
+
+Options:
+  -v, --verbose  Print more details (repeatable).
+  -h, --help     Show this message and exit.
+```
+
+<!--- end cli-docstub-clean --->

tests/test_cli.py

@@ -0,0 +1,92 @@
+"""Test command line interface."""
+
+import logging
+import os
+from pathlib import Path
+
+import pytest
+from click.testing import CliRunner
+
+from docstub import _cli
+from docstub._cache import create_cache
+
+PROJECT_ROOT = Path(__file__).parent.parent
+
+
+@pytest.fixture
+def tmp_path_cwd(tmp_path):
+    """Fixture: Create temporary directory and use it as working directory.
+
+    .. warning::
+        Not written with parallelization in mind!
+    """
+    previous_cwd = Path.cwd()
+    os.chdir(tmp_path)
+    try:
+        yield tmp_path
+    except:
+        os.chdir(previous_cwd)
+        raise
+
+
+class Test_run:
+    def test_no_cache(self, tmp_path_cwd, caplog):
+        caplog.set_level(logging.INFO)
+
+        source_file = tmp_path_cwd / "some_file.py"
+        source_file.touch()
+
+        # First run using '--no-cache' shouldn't create a cache directory
+        runner = CliRunner()
+        run_result = runner.invoke(_cli.run, args=["--no-cache", str(source_file)])
+        assert run_result.exception is None
+        assert run_result.exit_code == 0
+        assert not _cli._cache_dir_in_cwd().exists()
+
+        # Second run without '--no-cache' should create a cache directory
+        caplog.clear()
+        runner = CliRunner()
+        run_result = runner.invoke(_cli.run, args=[str(source_file)])
+        assert run_result.exception is None
+        assert run_result.exit_code == 0
+        assert _cli._cache_dir_in_cwd().exists()
+        # Check that no collected file was logged as "(cached)"
+        assert "(cached)" not in "\n".join(caplog.messages)
+
+        # Third run with existing cache should use cache
+        caplog.clear()
+        runner = CliRunner()
+        run_result = runner.invoke(_cli.run, args=[str(source_file)])
+        assert run_result.exception is None
+        assert run_result.exit_code == 0
+        # Check that at least one collected file was logged as "(cached)"
+        assert "(cached)" in "\n".join(caplog.messages)
+
+        # Fourth run with '--no-cache' should ignore existing cache
+        caplog.clear()
+        runner = CliRunner()
+        run_result = runner.invoke(_cli.run, args=["--no-cache", str(source_file)])
+        assert run_result.exception is None
+        assert run_result.exit_code == 0
+        # Check that at least one collected file was logged as "(cached)"
+        assert "(cached)" not in "\n".join(caplog.messages)
+
+
+class Test_clean:
+    @pytest.mark.parametrize("verbosity", [["-v"], ["--verbose"], []])
+    def test_basic(self, tmp_path_cwd, verbosity):
+        # Cleaning empty directory works
+        runner = CliRunner()
+        run_result = runner.invoke(_cli.clean, args=verbosity)
+        assert run_result.exception is None
+        assert run_result.exit_code == 0
+
+        cache_dir = _cli._cache_dir_in_cwd()
+        create_cache(cache_dir)
+        assert cache_dir.is_dir()
+
+        # Cache directory should be removed after running clean again
+        run_result = runner.invoke(_cli.clean, args=verbosity)
+        assert run_result.exception is None
+        assert run_result.exit_code == 0
+        assert not cache_dir.exists()

tests/test_docs.py

@@ -56,7 +56,8 @@ def test_user_guide_example(tmp_path):
 
 
 @pytest.mark.parametrize(
-    ("command", "name"), [(_cli.cli, "docstub"), (_cli.run, "docstub run")]
+    ("command", "name"),
+    [(_cli.cli, "docstub"), (_cli.run, "docstub run"), (_cli.clean, "docstub clean")],
 )
 def test_command_line_reference(command, name):
     ctx = click.Context(command, info_name=name)