fix(caching): Fix CLI always overriding cache=true/false in the configuration file (#1608)

Author: bhirsz

src/robocop/config.py

@@ -633,11 +633,11 @@ def _sorted_tuple(items: list[str] | None) -> tuple[str, ...]:
         return int.from_bytes(hash_bytes[:8], byteorder="big", signed=True)
 
 
-@dataclass(frozen=True)
+@dataclass
 class CacheConfig:
     """Configuration for file-level caching."""
 
-    enabled: bool = True
+    enabled: bool | None = True
     cache_dir: Path | None = None
 
     @classmethod
@@ -657,6 +657,14 @@ def from_toml(cls, config: dict, config_parent: Path) -> CacheConfig:
                 cache_dir = config_parent / cache_dir
         return cls(enabled=enabled, cache_dir=cache_dir)
 
+    def overwrite_from_config(self, overwrite_config: Self) -> None:
+        """Overwrite configuration with optional values from CLI."""
+        if overwrite_config.cache_dir is not None:
+            self.cache_dir = overwrite_config.cache_dir
+            self.enabled = True
+        elif overwrite_config.enabled is not None:
+            self.enabled = overwrite_config.enabled
+
 
 @dataclass
 class FileFiltersOptions(ConfigContainer):
@@ -828,7 +836,7 @@ def overwrite_from_config(self, overwrite_config: Config | None) -> None:
                 setattr(self, config_field.name, value)
         # Handle cache config - CLI cache settings override file config
         if overwrite_config.cache is not None:
-            self.cache = overwrite_config.cache
+            self.cache.overwrite_from_config(overwrite_config.cache)
         if overwrite_config.linter:
             for config_field in fields(overwrite_config.linter):
                 if config_field.name == "config_source":

src/robocop/run.py

@@ -144,10 +144,10 @@ def list_commands(self, ctx: typer.Context) -> list[str]:  # noqa: ARG002
 ignore_file_config_option = Annotated[
     bool, typer.Option(rich_help_panel="Configuration", help="Do not load configuration files.")
 ]
-no_cache_option = Annotated[
+cache_option = Annotated[
     bool,
     typer.Option(
-        "--no-cache",
+        "--cache",
         help="Disable file caching. All files will be processed regardless of modifications.",
         rich_help_panel="Caching",
     ),
@@ -316,7 +316,7 @@ def check_files(
     root: project_root_option = None,
     verbose: verbose_option = None,
     silent: silent_option = None,
-    no_cache: no_cache_option = False,
+    cache: cache_option = None,
     clear_cache: clear_cache_option = False,
     cache_dir: cache_dir_option = None,
 ) -> list[Diagnostic]:
@@ -342,7 +342,7 @@ def check_files(
     file_filters = config.FileFiltersOptions(
         include=include, default_include=default_include, exclude=exclude, default_exclude=default_exclude
     )
-    cache_config = config.CacheConfig(enabled=not no_cache, cache_dir=cache_dir)
+    cache_config = config.CacheConfig(enabled=cache, cache_dir=cache_dir)
     overwrite_config = config.Config(
         linter=linter_config,
         formatter=None,
@@ -639,7 +639,7 @@ def format_files(
     root: project_root_option = None,
     verbose: verbose_option = None,
     silent: silent_option = None,
-    no_cache: no_cache_option = False,
+    cache: cache_option = None,
     clear_cache: clear_cache_option = False,
     cache_dir: cache_dir_option = None,
     return_result: Annotated[
@@ -685,7 +685,7 @@ def format_files(
     file_filters = config.FileFiltersOptions(
         include=include, default_include=default_include, exclude=exclude, default_exclude=default_exclude
     )
-    cache_config = config.CacheConfig(enabled=not no_cache, cache_dir=cache_dir)
+    cache_config = config.CacheConfig(enabled=cache, cache_dir=cache_dir)
     overwrite_config = config.Config(
         formatter=formatter_config,
         linter=None,

tests/cache/test_cache_integration.py

@@ -144,7 +144,7 @@ def test_cache_disabled_with_no_cache_flag(self, tmp_path, capsys):
             _out1, _ = capsys.readouterr()
 
             # Act - run with --no-cache flag
-            second_result = check_files(no_cache=True, return_result=True, verbose=True)
+            second_result = check_files(cache=False, return_result=True, verbose=True)
             out2, _ = capsys.readouterr()
 
             # Assert - should rescan even though file unchanged
@@ -351,8 +351,29 @@ def test_empty_file_integration(self, tmp_path, capsys):
             # Assert - should rescan (cache invalidated due to size change)
             assert "Scanning file:" in out2
 
+    def test_default_cli_does_not_override_config_file_disabled(self, tmp_path, capsys):
+        """Test CLI without any option set does not override the config file with cache=false."""
+        # Arrange - create config file with cache disabled
+        config_file = tmp_path / "pyproject.toml"
+        config_file.write_text("[tool.robocop]\ncache = false\n", encoding="utf-8")
+        test_file = tmp_path / "test.robot"
+        test_file.write_text("*** Test Cases ***\nTest\n    Log    Hello\n", encoding="utf-8")
+
+        with working_directory(tmp_path):
+            # Act - run with default CLI (cache disabled from config)
+            check_files(verbose=True, return_result=True)
+            out, _ = capsys.readouterr()
+
+            # Assert - should NOT use cache (rescans file)
+            assert "Scanning file:" in out
+            assert "Used cached results" not in out
+
+            # Assert - cache file should not be created
+            cache_dir = tmp_path / ".robocop_cache"
+            assert not cache_dir.exists()
+
     def test_cli_cache_dir_overrides_config_file_disabled(self, tmp_path):
-        """Test CLI --cache-dir enables cache and overrides config file with cache=false."""
+        """Test CLI --cache-dir enables cache and overrides the config file with cache=false."""
         # Arrange - create config file with cache disabled
         config_file = tmp_path / "pyproject.toml"
         config_file.write_text("[tool.robocop]\ncache = false\n", encoding="utf-8")
@@ -396,9 +417,8 @@ def test_cli_no_cache_flag_overrides_config_file_enabled(self, tmp_path, capsys)
             # Verify cache was created
             assert is_file_in_cache(tmp_path, test_file)
 
-            # Act - run with no_cache=True via CLI (simulating --no-cache flag)
-            # This overrides the config file's cache=true
-            check_files(no_cache=True, return_result=True, verbose=True)
+            # Act - Override config file's cache=true with --no-cache flag
+            check_files(cache=False, return_result=True, verbose=True)
             out2, _ = capsys.readouterr()
 
             # Assert - should NOT use cache (rescans file)