made dry_run effective

Author: forman

tests/test_cli.py

@@ -6,6 +6,7 @@
 from click.testing import CliRunner
 
 from zappend.cli import zappend
+from zappend.fsutil.fileobj import FileObj
 from .helpers import clear_memory_fs
 from .helpers import make_test_dataset
 
@@ -60,6 +61,7 @@ def test_no_slices(self):
         result = runner.invoke(zappend, [])
         self.assertEqual(0, result.exit_code)
         self.assertEqual("No slice datasets given.\n", result.output)
+        self.assertFalse(FileObj("memory://target.zarr").exists())
 
     def test_some_slices_and_target(self):
         make_test_dataset(uri="memory://slice-1.zarr")
@@ -78,6 +80,27 @@ def test_some_slices_and_target(self):
                                ])
         self.assertEqual("", result.output)
         self.assertEqual(0, result.exit_code)
+        self.assertTrue(FileObj("memory://target.zarr").exists())
+
+    def test_some_slices_and_target_dry_run(self):
+        make_test_dataset(uri="memory://slice-1.zarr")
+        make_test_dataset(uri="memory://slice-2.zarr")
+        make_test_dataset(uri="memory://slice-3.zarr")
+
+        runner = CliRunner()
+        # noinspection PyTypeChecker
+        result = runner.invoke(zappend,
+                               [
+                                   "--target",
+                                   "memory://target.zarr",
+                                   "--dry-run",
+                                   "memory://slice-1.zarr",
+                                   "memory://slice-2.zarr",
+                                   "memory://slice-3.zarr",
+                               ])
+        self.assertEqual("", result.output)
+        self.assertEqual(0, result.exit_code)
+        self.assertFalse(FileObj("memory://target.zarr").exists())
 
     def test_some_slices_and_no_target(self):
         make_test_dataset(uri="memory://slice-1.zarr")
@@ -95,3 +118,4 @@ def test_some_slices_and_no_target(self):
         self.assertEqual(1, result.exit_code)
         self.assertEqual("Error: Missing 'target_uri' in configuration\n",
                          result.output)
+        self.assertFalse(FileObj("memory://target.zarr").exists())

tests/test_context.py

@@ -60,3 +60,10 @@ def test_temp_dir(self):
         ctx = Context({"target_uri": "memory://target.zarr"})
         self.assertIsInstance(ctx.temp_dir, FileObj)
         self.assertTrue(ctx.temp_dir.exists())
+
+    def test_dry_run(self):
+        ctx = Context({"target_uri": "memory://target.zarr"})
+        self.assertEqual(False, ctx.dry_run)
+        ctx = Context({"target_uri": "memory://target.zarr",
+                       "dry_run": True})
+        self.assertEqual(True, ctx.dry_run)

zappend/context.py

@@ -100,3 +100,7 @@ def slice_polling(self) -> tuple[float, float] | tuple[None, None]:
     @property
     def temp_dir(self) -> FileObj:
         return self._temp_dir
+
+    @property
+    def dry_run(self) -> bool:
+        return self._config.get("dry_run", False)

zappend/processor.py

@@ -78,6 +78,8 @@ def create_target_from_slice(ctx: Context,
                              rollback_cb: RollbackCallback):
     logger.info(f"Creating target dataset")
     target_ds = tailor_target_dataset(slice_ds, ctx.target_metadata)
+    if ctx.dry_run:
+        return
     target_dir = ctx.target_dir
     # TODO: adjust global attributes dependent on append_dim,
     #  e.g., time coverage
@@ -103,6 +105,9 @@ def update_target_from_slice(ctx: Context,
                                     ctx.target_metadata,
                                     append_dim_name)
 
+    if ctx.dry_run:
+        return
+
     # TODO: adjust global attributes dependent on append_dim,
     #  e.g., time coverage