Merge branch 'feat/update_checksums_dump' into 'main'

feat: Add optional path to ChecksumsManager dump method

Closes PACMAN-1135

See merge request espressif/idf-component-manager!515

Author: kumekay

idf_component_tools/hash_tools/checksums.py

@@ -46,11 +46,11 @@ def __init__(self, path: Path):
     def exists(self) -> bool:
         """Check if checksums file exists.
 
-        :return: True if checksums file exists, False otherwise
+        :return: True if checksums file exists in the component directory, False otherwise.
         """
         return (self.path / CHECKSUMS_FILENAME).is_file()
 
-    def dump(self) -> None:
+    def dump(self, path: t.Optional[Path] = None) -> None:
         """Writes checksums to a file.
 
         Format of the file is:
@@ -68,8 +68,13 @@ def dump(self) -> None:
                 ...
             ]
         }
+
+        :param path: Path to directory where checksums file will be created.
+        If None, uses the component path provided during initialization.
         """
 
+        checksums_path = (path if path is not None else self.path) / CHECKSUMS_FILENAME
+
         checksums = ChecksumsModel(
             files=[
                 FileField(
@@ -82,7 +87,7 @@ def dump(self) -> None:
             ]
         )
 
-        (self.path / CHECKSUMS_FILENAME).write_text(checksums.model_dump_json())
+        checksums_path.write_text(checksums.model_dump_json())
 
     def load(self) -> ChecksumsModel:
         """Load file with checksums.

tests/idf_component_tools/hash_tools/test_checksums.py

@@ -75,6 +75,34 @@ def test_checksums_dump(tmp_path, checksums_model):
     assert stored_checksums == expected_checksums
 
 
+def test_checksums_dump_to_other_path(tmp_path, checksums_model):
+    component_path = tmp_path / 'component'
+    component_path.mkdir()
+    (component_path / 'file1.txt').write_text('file1')
+    checksums_manager = ChecksumsManager(component_path)
+
+    checksums_model.files.append(
+        create_file_field(
+            'file1.txt', 5, 'c147efcfc2d7ea666a9e4f5187b115c90903f0fc896a56df9a6ef5d8f3fc9f31'
+        )
+    )
+
+    external_path = tmp_path / 'ext'
+    external_path.mkdir()
+    checksums_path = external_path / CHECKSUMS_FILENAME
+
+    checksums_manager.dump(external_path)
+    assert checksums_path.is_file()
+
+    stored_checksums = json.loads(checksums_path.read_text())
+    expected_checksums = checksums_model.model_dump()
+
+    normalize_checksums(stored_checksums)
+    normalize_checksums(expected_checksums)
+
+    assert stored_checksums == expected_checksums
+
+
 def test_load_checksums(tmp_path, checksums_model):
     checksums_path = tmp_path / CHECKSUMS_FILENAME
     checksums_manager = ChecksumsManager(tmp_path)