Include SHA1 hash when deleting a file

README.md

@@ -117,6 +117,7 @@ artifactory-cleanup --help
   configuration for multiple repositories and some of them are not found.
 - Use `--worker-count=<WORKER_NUM>` to increase the number of workers. By default, it's 1. It's useful when you have a lot of
   artifacts and you want to speed up the process.
+- Use `--display-format` to customize the printed information when deleting a file. The default format is "'{path}' - {size}". Supported options are "{path}", "{size}" and "{hash}".
 
 ## Commands ##
 

artifactory_cleanup/artifactorycleanup.py

@@ -25,12 +25,14 @@ def __init__(
         today: date,
         ignore_not_found: bool,
         worker_count: int,
+        display_format: str,
     ):
         self.session = session
         self.policies = policies
         self.destroy = destroy
         self.ignore_not_found = ignore_not_found
         self.worker_count = worker_count
+        self.display_format = display_format
 
         self._init_policies(today)
 
@@ -61,7 +63,7 @@ def cleanup(self, block_ctx_mgr, test_ctx_mgr) -> Iterator[CleanupSummary]:
                 # Delete artifacts
                 def _delete(artifact):
                     with test_ctx_mgr(get_name_for_ci(artifact)):
-                        policy.delete(artifact, destroy=self.destroy, ignore_not_found=self.ignore_not_found)
+                        policy.delete(artifact, destroy=self.destroy, display_format=self.display_format, ignore_not_found=self.ignore_not_found)
 
                 with ThreadPoolExecutor(max_workers=int(self.worker_count)) as executor:
                     for artifact in artifacts_to_remove:

artifactory_cleanup/cli.py

@@ -95,6 +95,14 @@ class ArtifactoryCleanupCLI(cli.Application):
         mandatory=False,
     )
 
+    _display_format = cli.SwitchAttr(
+        "--display-format",
+        help="Set format of the printed message when deleting a file",
+        default="'{path}' - {size}",
+        mandatory=False,
+        envname="ARTIFACTORY_CLEANUP_DISPLAY_FORMAT",
+    )
+
     @property
     def VERSION(self):
         # To prevent circular imports
@@ -172,6 +180,7 @@ def main(self):
             today=today,
             ignore_not_found=self._ignore_not_found,
             worker_count=self._worker_count,
+            display_format=self._display_format,
         )
 
         # Filter policies by name

artifactory_cleanup/rules/base.py

@@ -25,6 +25,7 @@ class ArtifactDict(TypedDict):
     properties: dict
     stats: dict
     size: int
+    actual_sha1: str
 
 
 class ArtifactsList(List[ArtifactDict]):
@@ -294,11 +295,12 @@ def filter(self, artifacts: ArtifactsList) -> ArtifactsList:
                 print()
         return artifacts
 
-    def delete(self, artifact: ArtifactDict, destroy: bool, ignore_not_found: bool = False) -> None:
+    def delete(self, artifact: ArtifactDict, destroy: bool, display_format: str, ignore_not_found: bool = False) -> None:
         """
         Delete the artifact
         :param artifact: artifact to remove
         :param destroy: if False - just log the action, do not actually remove the artifact
+        :param display_format: specify the format string for the file to delete, for example "'{path}' - {size}"
         :param ignore_not_found: if True - do not raise an error if the artifact is not found
         """
 
@@ -310,11 +312,14 @@ def delete(self, artifact: ArtifactDict, destroy: bool, ignore_not_found: bool =
         artifact_path = path.format(**artifact)
         artifact_path = quote(artifact_path)
         artifact_size = artifact.get("size", 0) or 0
+        artifact_hash = artifact.get("actual_sha1", "")
+
+        file_string = display_format.replace("{path}", artifact_path).replace("{size}", size(artifact_size)).replace("{hash}", artifact_hash)
 
         if not destroy:
-            print(f"DEBUG - we would delete '{artifact_path}' - {size(artifact_size)}")
+            print(f"DEBUG - we would delete {file_string}")
             return
-        print(f"DESTROY MODE - delete '{artifact_path} - {size(artifact_size)}'")
+        print(f"DESTROY MODE - delete {file_string}")
         r = self.session.delete(artifact_path)
         try:
             r.raise_for_status()

tests/conftest.py

@@ -27,6 +27,7 @@ def attach_requests_mock_to(mock, server):
                     "modified": "2021-03-21T13:54:32.000+02:00",
                     "modified_by": "admin",
                     "updated": "2021-03-21T13:54:52.384+02:00",
+                    "actual_sha1": "11827853eed40e8b60f5d7e45f2a730915d7704d",
                     "properties": [
                         {"key": "property-1", "value": "property-value-1"},
                         {"key": "property-2", "value": "property-value-2"},

tests/test_cli.py

@@ -169,3 +169,47 @@ def test_require_output_json(capsys, shared_datadir, requests_mock):
     assert (
         "Error: Given --output-format, the following are missing ['output']" in stdout
     )
+
+
+@pytest.mark.usefixtures("requests_repo_name_here")
+def test_display_format_default(capsys, shared_datadir, requests_mock):
+    _, code = ArtifactoryCleanupCLI.run(
+        [
+            "ArtifactoryCleanupCLI",
+            "--config",
+            str(shared_datadir / "cleanup.yaml"),
+            "--load-rules",
+            str(shared_datadir / "myrule.py"),
+        ],
+        exit=False,
+    )
+    stdout, stderr = capsys.readouterr()
+    print(stdout)
+    assert code == 0, stdout
+    assert (
+            "DEBUG - we would delete 'repo-name-here/path/to/file/filename1.json' - 528B"
+            in stdout
+    )
+
+
+@pytest.mark.usefixtures("requests_repo_name_here")
+def test_display_format(capsys, shared_datadir, requests_mock):
+    _, code = ArtifactoryCleanupCLI.run(
+        [
+            "ArtifactoryCleanupCLI",
+            "--config",
+            str(shared_datadir / "cleanup.yaml"),
+            "--load-rules",
+            str(shared_datadir / "myrule.py"),
+            "--display-format",
+            "'{path}' ({hash}) - {size}",
+        ],
+        exit=False,
+    )
+    stdout, stderr = capsys.readouterr()
+    print(stdout)
+    assert code == 0, stdout
+    assert (
+            "DEBUG - we would delete 'repo-name-here/path/to/file/filename1.json' (11827853eed40e8b60f5d7e45f2a730915d7704d) - 528B"
+            in stdout
+    )