feat: clear cache through the cli (#271)

Author: sdn4z

README.md

@@ -169,3 +169,20 @@ The file format for each reference is as follows:
     rows: {project: string}[]
 }
 ```
+
+### Cache
+By default, Twyn will cache the list of trusted packages to a cache file (.twyn/trusted_packages.json). 
+
+You can disable the cache by adding the following flag:
+
+```python
+  twyn run --no-cache
+```
+In which case it will download again the list of trusted packages, withou saving them to the cache file.
+
+Cache file is valid for 30 days, after that period it will download again the trusted packages list.
+
+To clear the cache, run:
+```python
+  twyn run cache clear
+```

src/twyn/cli.py

@@ -1,7 +1,9 @@
+import logging
 import sys
 from typing import Optional
 
 import click
+from rich.logging import RichHandler
 
 from twyn.__version__ import __version__
 from twyn.base.constants import (
@@ -13,6 +15,14 @@
 from twyn.config.config_handler import ConfigHandler
 from twyn.file_handler.file_handler import FileHandler
 from twyn.main import check_dependencies
+from twyn.trusted_packages.constants import TRUSTED_PACKAGES_FILE_PATH
+
+logging.basicConfig(
+    format="%(message)s",
+    datefmt="[%X]",
+    handlers=[RichHandler(rich_tracebacks=True, show_path=False)],
+)
+logger = logging.getLogger("twyn")
 
 
 @click.group()
@@ -137,5 +147,21 @@ def remove(package_name: str, config: str) -> None:
     ConfigHandler(fh).remove_package_from_allowlist(package_name)
 
 
+@entry_point.group()
+def cache() -> None:
+    pass
+
+
+@cache.command()
+def clear() -> None:
+    fp = FileHandler(TRUSTED_PACKAGES_FILE_PATH).file_path
+    if fp.exists():
+        fp.unlink()
+        fp.parent.rmdir()
+        logger.warning("Cache has been cleared")
+    else:
+        logger.warning("Could not clear cache. Cache file not found.")
+
+
 if __name__ == "__main__":
     sys.exit(entry_point())

src/twyn/main.py

@@ -1,7 +1,6 @@
 import logging
 from typing import Optional
 
-from rich.logging import RichHandler
 from rich.progress import track
 
 from twyn.base.constants import (
@@ -22,11 +21,6 @@
     TyposquatCheckResult,
 )
 
-logging.basicConfig(
-    format="%(message)s",
-    datefmt="[%X]",
-    handlers=[RichHandler(rich_tracebacks=True, show_path=False)],
-)
 logger = logging.getLogger("twyn")
 
 

tests/conftest.py

@@ -43,6 +43,7 @@ def tmp_cache_file(tmp_path: Path, data: Union[dict[str, Any], None] = None) ->
 
     with (
         mock.patch("twyn.trusted_packages.references.TRUSTED_PACKAGES_FILE_PATH", str(cache_file)),
+        mock.patch("twyn.cli.TRUSTED_PACKAGES_FILE_PATH", str(cache_file)),
     ):
         yield cache_file
 

tests/main/test_cli.py

@@ -7,6 +7,17 @@
 
 
 class TestCli:
+    def test_cache_rm_erases_cache(self, tmp_cache_file):
+        runner = CliRunner()
+
+        tmp_cache_file.write_text("{}")
+        assert tmp_cache_file.exists()
+
+        result = runner.invoke(cli.cache.commands["clear"])
+
+        assert result.exit_code == 0
+        assert not tmp_cache_file.exists()
+
     @patch("twyn.cli.check_dependencies")
     def test_no_cache_option_disables_cache(self, mock_check_dependencies):
         runner = CliRunner()