Tests: add dump option in two test files

Add dump option that could be used to the debug the state of the
repository simulator.

Signed-off-by: Martin Vrachev <[email protected]>

Author: MVrachev

tests/test_updater_consistent_snapshot.py

@@ -27,6 +27,9 @@ class TestConsistentSnapshot(unittest.TestCase):
     'prefix_targets_with_hash' and verify that the correct URLs
     are formed for each combination"""
 
+    # set dump_dir to trigger repository state dumps
+    dump_dir: Optional[str] = None
+
     def setUp(self) -> None:
         self.temp_dir = tempfile.TemporaryDirectory()
         self.metadata_dir = os.path.join(self.temp_dir.name, "metadata")
@@ -54,10 +57,19 @@ def _init_repo(
             )
             f.write(root)
 
+        if self.dump_dir is not None:
+            # create test specific dump directory
+            name = self.id().split(".")[-1]
+            sim.dump_dir = os.path.join(self.dump_dir, name)
+            os.mkdir(sim.dump_dir)
+
         return sim
 
     def _init_updater(self, sim: RepositorySimulator) -> Updater:
         """Create a new Updater instance"""
+        if sim.dump_dir is not None:
+            sim.write()
+
         return Updater(
             self.metadata_dir,
             "https://example.com/metadata/",
@@ -232,6 +244,12 @@ def test_download_targets(self, test_case_data: Dict[str, Any]):
 
 
 if __name__ == "__main__":
+    if "--dump" in sys.argv:
+        TestConsistentSnapshot.dump_dir = tempfile.mkdtemp()
+        print(
+            f"Repository Simulator dumps in {TestConsistentSnapshot.dump_dir}"
+        )
+        sys.argv.remove("--dump")
 
     utils.configure_test_logging(sys.argv)
     unittest.main()

tests/test_updater_top_level_update.py

@@ -30,6 +30,8 @@ class TestRefresh(unittest.TestCase):
     """Test update of top-level metadata following
     'Detailed client workflow' in the specification."""
 
+    # set dump_dir to trigger repository state dumps
+    dump_dir: Optional[str] = None
     past_datetime = datetime.utcnow().replace(microsecond=0) - timedelta(days=5)
 
     def setUp(self) -> None:
@@ -47,11 +49,20 @@ def setUp(self) -> None:
             )
             f.write(root)
 
+        if self.dump_dir is not None:
+            # create test specific dump directory
+            name = self.id().split(".")[-1]
+            self.sim.dump_dir = os.path.join(self.dump_dir, name)
+            os.mkdir(self.sim.dump_dir)
+
     def tearDown(self) -> None:
         self.temp_dir.cleanup()
 
     def _run_refresh(self) -> Updater:
         """Create a new Updater instance and refresh"""
+        if self.sim.dump_dir is not None:
+            self.sim.write()
+
         updater = Updater(
             self.metadata_dir,
             "https://example.com/metadata/",
@@ -436,6 +447,10 @@ def test_new_targets_expired(self) -> None:
 
 
 if __name__ == "__main__":
+    if "--dump" in sys.argv:
+        TestRefresh.dump_dir = tempfile.mkdtemp()
+        print(f"Repository Simulator dumps in {TestRefresh.dump_dir}")
+        sys.argv.remove("--dump")
 
     utils.configure_test_logging(sys.argv)
     unittest.main()