TrustedMetadataSet testing: start using setUp

This way we remove the repetitive code of creating a new
TrustedMetadataSet instance for each test function.

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

Author: MVrachev

tests/test_trusted_metadata_set.py

@@ -41,63 +41,61 @@ def setUpClass(cls):
                 password="password"
             )
 
-    def test_update(self):
-        trusted_set = TrustedMetadataSet(self.metadata["root"])
-        trusted_set.root_update_finished()
+    def setUp(self) -> None:
+        self.trusted_set = TrustedMetadataSet(self.metadata["root"])
 
-        trusted_set.update_timestamp(self.metadata["timestamp"])
-        trusted_set.update_snapshot(self.metadata["snapshot"])
-        trusted_set.update_targets(self.metadata["targets"])
-        trusted_set.update_delegated_targets(
+    def test_update(self):
+        self.trusted_set.root_update_finished()
+        self.trusted_set.update_timestamp(self.metadata["timestamp"])
+        self.trusted_set.update_snapshot(self.metadata["snapshot"])
+        self.trusted_set.update_targets(self.metadata["targets"])
+        self.trusted_set.update_delegated_targets(
             self.metadata["role1"], "role1", "targets"
         )
-        trusted_set.update_delegated_targets(
+        self.trusted_set.update_delegated_targets(
             self.metadata["role2"], "role2", "role1"
         )
-
         # the 4 top level metadata objects + 2 additional delegated targets
-        self.assertTrue(len(trusted_set), 6)
+        self.assertTrue(len(self.trusted_set), 6)
 
     def test_out_of_order_ops(self):
-        trusted_set = TrustedMetadataSet(self.metadata["root"])
-
         # Update timestamp before root is finished
         with self.assertRaises(RuntimeError):
-            trusted_set.update_timestamp(self.metadata["timestamp"])
+            self.trusted_set.update_timestamp(self.metadata["timestamp"])
 
-        trusted_set.root_update_finished()
+        self.trusted_set.root_update_finished()
         with self.assertRaises(RuntimeError):
-            trusted_set.root_update_finished()
+            self.trusted_set.root_update_finished()
 
         # Update snapshot before timestamp
         with self.assertRaises(RuntimeError):
-            trusted_set.update_snapshot(self.metadata["snapshot"])
+            self.trusted_set.update_snapshot(self.metadata["snapshot"])
 
-        trusted_set.update_timestamp(self.metadata["timestamp"])
+        self.trusted_set.update_timestamp(self.metadata["timestamp"])
 
         # Update targets before snapshot
         with self.assertRaises(RuntimeError):
-            trusted_set.update_targets(self.metadata["targets"])
+            self.trusted_set.update_targets(self.metadata["targets"])
 
-        trusted_set.update_snapshot(self.metadata["snapshot"])
+        self.trusted_set.update_snapshot(self.metadata["snapshot"])
 
         # update timestamp after snapshot
         with self.assertRaises(RuntimeError):
-            trusted_set.update_timestamp(self.metadata["timestamp"])
+            self.trusted_set.update_timestamp(self.metadata["timestamp"])
 
         # Update delegated targets before targets
         with self.assertRaises(RuntimeError):
-            trusted_set.update_delegated_targets(
+            self.trusted_set.update_delegated_targets(
                 self.metadata["role1"], "role1", "targets"
             )
 
-        trusted_set.update_targets(self.metadata["targets"])
-        trusted_set.update_delegated_targets(
+        self.trusted_set.update_targets(self.metadata["targets"])
+        self.trusted_set.update_delegated_targets(
             self.metadata["role1"], "role1", "targets"
         )
 
-        trusted_set.update_targets(self.metadata["targets"])
-        trusted_set.update_delegated_targets(
+        self.trusted_set.update_targets(self.metadata["targets"])
+        self.trusted_set.update_delegated_targets(
             self.metadata["role1"], "role1", "targets"
         )
 
@@ -111,13 +109,12 @@ def test_update_with_invalid_json(self):
         with self.assertRaises(exceptions.RepositoryError):
             TrustedMetadataSet(json.dumps(root.to_dict()).encode())
 
-        trusted_set = TrustedMetadataSet(self.metadata["root"])
-        trusted_set.root_update_finished()
+        self.trusted_set.root_update_finished()
 
         top_level_md = [
-            (self.metadata["timestamp"], trusted_set.update_timestamp),
-            (self.metadata["snapshot"], trusted_set.update_snapshot),
-            (self.metadata["targets"], trusted_set.update_targets),
+            (self.metadata["timestamp"], self.trusted_set.update_timestamp),
+            (self.metadata["snapshot"], self.trusted_set.update_snapshot),
+            (self.metadata["targets"], self.trusted_set.update_targets),
         ]
         for metadata, update_func in top_level_md:
             # metadata is not json
@@ -148,7 +145,6 @@ def test_verify_with_threshold(self):
             verify_with_threshold(targets, "foo", delegated_role)
 
     def test_invalid_update_root(self):
-        trusted_set = TrustedMetadataSet(self.metadata["root"])
         # new_root data with invalid snapshot type
         invalid_type_data = json.loads(self.metadata["root"])
         invalid_type_data["signed"]["_type"] = "snapshot"
@@ -157,7 +153,7 @@ def test_invalid_update_root(self):
         # RepositoryError is thrown during new_root deserialization.
         # It's not thrown when checking new_root.signed.type != "root"
         with self.assertRaises(exceptions.RepositoryError):
-            trusted_set.update_root(invalid_type_data)
+            self.trusted_set.update_root(invalid_type_data)
 
         # new_root data with threshold which cannot be verified.
         modified_threshold_data = copy.deepcopy(
@@ -166,26 +162,26 @@ def test_invalid_update_root(self):
         modified_threshold_data["signed"]["roles"]["root"]["threshold"] = 2
         modified_threshold_data = json.dumps(modified_threshold_data).encode()
         with self.assertRaises(exceptions.UnsignedMetadataError):
-            trusted_set.update_root(modified_threshold_data)
+            self.trusted_set.update_root(modified_threshold_data)
 
         # new_root.signed.version has the same version as old root
         with self.assertRaises(exceptions.ReplayedMetadataError):
-            trusted_set.update_root(self.metadata["root"])
+            self.trusted_set.update_root(self.metadata["root"])
 
         # if _root_update_finished, then fail when calling update_root
-        trusted_set.root_update_finished()
+        self.trusted_set.root_update_finished()
         with self.assertRaises(RuntimeError):
-            trusted_set.update_root(self.metadata["root"])
+            self.trusted_set.update_root(self.metadata["root"])
+        self.trusted_set._root_update_finished = False
 
     def test_root_update_finished_expired(self):
-        trusted_set = TrustedMetadataSet(self.metadata["root"])
         # call root_update_finished when trusted root has expired
         expired_datetime = datetime.strptime(
             "1970-01-01T00:00:00Z", "%Y-%m-%dT%H:%M:%SZ"
         )
-        trusted_set.root.signed.expires = expired_datetime
+        self.trusted_set.root.signed.expires = expired_datetime
         with self.assertRaises(exceptions.ExpiredMetadataError):
-            trusted_set.root_update_finished()
+            self.trusted_set.root_update_finished()
 
     def _sign_modified_obj(
         self,
@@ -198,20 +194,19 @@ def _sign_modified_obj(
         return signature.to_dict()
 
     def test_update_timestamp(self):
-        trusted_set = TrustedMetadataSet(self.metadata["root"])
-        trusted_set.root_update_finished()
-        trusted_set.update_timestamp(self.metadata["timestamp"])
+        self.trusted_set.root_update_finished()
+        self.trusted_set.update_timestamp(self.metadata["timestamp"])
         # new_timestamp.version < trusted_timestamp.version
-        trusted_set.timestamp.signed.version = 2
+        self.trusted_set.timestamp.signed.version = 2
         with self.assertRaises(exceptions.ReplayedMetadataError):
-            trusted_set.update_timestamp(self.metadata["timestamp"])
-        trusted_set.timestamp.signed.version = 1
+            self.trusted_set.update_timestamp(self.metadata["timestamp"])
+        self.trusted_set.timestamp.signed.version = 1
 
         # new_timestamp.snapshot.version < trusted_timestamp.snapshot.version
-        trusted_set.timestamp.signed.meta["snapshot.json"].version = 2
+        self.trusted_set.timestamp.signed.meta["snapshot.json"].version = 2
         with self.assertRaises(exceptions.ReplayedMetadataError):
-            trusted_set.update_timestamp(self.metadata["timestamp"])
-        trusted_set.timestamp.signed.meta["snapshot.json"].version = 1
+            self.trusted_set.update_timestamp(self.metadata["timestamp"])
+        self.trusted_set.timestamp.signed.meta["snapshot.json"].version = 1
 
         # new_timestamp has expired
         timestamp = Metadata.from_bytes(self.metadata["timestamp"])
@@ -221,7 +216,7 @@ def test_update_timestamp(self):
         self._sign_modified_obj("timestamp", timestamp)
         new_timestamp_byte_data = json.dumps(timestamp.to_dict()).encode()
         with self.assertRaises(exceptions.ExpiredMetadataError):
-            trusted_set.update_timestamp(new_timestamp_byte_data)
+            self.trusted_set.update_timestamp(new_timestamp_byte_data)
 
     def _calculate_modified_hashes(
         self, true_hashes,
@@ -237,86 +232,84 @@ def _calculate_modified_hashes(
         return modified_hashes
 
     def test_update_snapshot(self):
-        trusted_set = TrustedMetadataSet(self.metadata["root"])
-        trusted_set.root_update_finished()
-        trusted_set.update_timestamp(self.metadata["timestamp"])
+        self.trusted_set.root_update_finished()
+        self.trusted_set.update_timestamp(self.metadata["timestamp"])
         # new_snapshot data with invalid targets type
         invalid_type_data = json.loads(self.metadata["snapshot"])
         invalid_type_data["signed"]["_type"] = "targets"
         invalid_type_data["signed"]["targets"] = {}
         invalid_type_data = json.dumps(invalid_type_data).encode()
-        timestamp_meta = trusted_set.timestamp.signed.meta["snapshot.json"]
+        timestamp_meta = self.trusted_set.timestamp.signed.meta["snapshot.json"]
         true_hashes = timestamp_meta.hashes or {}
         modified_hashes = self._calculate_modified_hashes(
             true_hashes, invalid_type_data
         )
-        trusted_set.timestamp.signed.meta["snapshot.json"].hashes = modified_hashes
+        self.trusted_set.timestamp.signed.meta["snapshot.json"].hashes = modified_hashes
 
         with self.assertRaises(exceptions.RepositoryError):
-            trusted_set.update_snapshot(invalid_type_data)
-        trusted_set.timestamp.signed.meta["snapshot.json"].hashes = true_hashes
+            self.trusted_set.update_snapshot(invalid_type_data)
+        self.trusted_set.timestamp.signed.meta["snapshot.json"].hashes = true_hashes
         # cannot update snapshot after targets update completes or targets != None
         targets_obj = Metadata.from_bytes(self.metadata["targets"])
-        trusted_set._trusted_set["targets"] = targets_obj
+        self.trusted_set._trusted_set["targets"] = targets_obj
         with self.assertRaises(RuntimeError):
-            trusted_set.update_snapshot(self.metadata["snapshot"])
-        del trusted_set._trusted_set["targets"]
+            self.trusted_set.update_snapshot(self.metadata["snapshot"])
+        del self.trusted_set._trusted_set["targets"]
 
         #  Deserialization error - failed to decode the new_snapshot JSON.
-        timestamp_meta = trusted_set.timestamp.signed.meta["snapshot.json"]
+        timestamp_meta = self.trusted_set.timestamp.signed.meta["snapshot.json"]
         true_hashes = timestamp_meta.hashes or {}
 
         modified_hashes = self._calculate_modified_hashes(
             true_hashes, b'{""sig": }'
         )
-        trusted_set.timestamp.signed.meta["snapshot.json"].hashes = modified_hashes
+        self.trusted_set.timestamp.signed.meta["snapshot.json"].hashes = modified_hashes
         with self.assertRaises(exceptions.RepositoryError):
-            trusted_set.update_snapshot(b'{""sig": }')
-        trusted_set.timestamp.signed.meta["snapshot.json"].hashes = true_hashes
+            self.trusted_set.update_snapshot(b'{""sig": }')
+        self.trusted_set.timestamp.signed.meta["snapshot.json"].hashes = true_hashes
 
         # root data with threshold which cannot be verified for new_snapshot
-        trusted_set.root.signed.roles["snapshot"].threshold = 2
+        self.trusted_set.root.signed.roles["snapshot"].threshold = 2
         with self.assertRaises(exceptions.UnsignedMetadataError):
-            trusted_set.update_snapshot(self.metadata["snapshot"])
-        trusted_set.root.signed.roles["snapshot"].threshold = 1
+            self.trusted_set.update_snapshot(self.metadata["snapshot"])
+        self.trusted_set.root.signed.roles["snapshot"].threshold = 1
 
         # new_snapshot.version != trusted timestamp.meta["snapshot"].version
-        trusted_set.timestamp.signed.meta["snapshot.json"].version = 2
+        self.trusted_set.timestamp.signed.meta["snapshot.json"].version = 2
         with self.assertRaises(exceptions.BadVersionNumberError):
-            trusted_set.update_snapshot(self.metadata["snapshot"])
-        trusted_set.timestamp.signed.meta["snapshot.json"].version = 1
+            self.trusted_set.update_snapshot(self.metadata["snapshot"])
+        self.trusted_set.timestamp.signed.meta["snapshot.json"].version = 1
 
 
     def test_update_snapshot_after_succesfull_update(self):
-        trusted_set = TrustedMetadataSet(self.metadata["root"])
-        trusted_set.root_update_finished()
-        trusted_set.update_timestamp(self.metadata["timestamp"])
-        trusted_set.update_snapshot(self.metadata["snapshot"])
+        self.trusted_set.root_update_finished()
+        self.trusted_set.update_timestamp(self.metadata["timestamp"])
+        self.trusted_set.update_snapshot(self.metadata["snapshot"])
 
         # Test removing a meta_file in new_snapshot compared to the old snapshot
         snapshot_obj = Metadata.from_bytes(self.metadata["snapshot"])
         snapshot_obj.signed.meta = {}
         # prepare timestamp.meta["snapshot"].hashes
         self._sign_modified_obj("snapshot", snapshot_obj)
-        timestamp_meta = trusted_set.timestamp.signed.meta["snapshot.json"]
+        timestamp_meta = self.trusted_set.timestamp.signed.meta["snapshot.json"]
         true_hashes = timestamp_meta.hashes or {}
         modified_snapshot_data = json.dumps(snapshot_obj.to_dict()).encode()
         modified_hashes = self._calculate_modified_hashes(
             true_hashes, modified_snapshot_data
         )
-        trusted_set.timestamp.signed.meta["snapshot.json"].hashes = modified_hashes
+        self.trusted_set.timestamp.signed.meta["snapshot.json"].hashes = modified_hashes
 
         with self.assertRaises(exceptions.RepositoryError):
-            trusted_set.update_snapshot(modified_snapshot_data)
-        trusted_set.timestamp.signed.meta["snapshot.json"].hashes = true_hashes
+            self.trusted_set.update_snapshot(modified_snapshot_data)
+        self.trusted_set.timestamp.signed.meta["snapshot.json"].hashes = true_hashes
 
         # snapshot.meta["project1"].version != new_snapshot.meta["project1"].version
-        for meta_file_path in trusted_set.snapshot.signed.meta.keys():
-            trusted_set.snapshot.signed.meta[meta_file_path].version = 2
+        for meta_file_path in self.trusted_set.snapshot.signed.meta.keys():
+            self.trusted_set.snapshot.signed.meta[meta_file_path].version = 2
         with self.assertRaises(exceptions.BadVersionNumberError):
-            trusted_set.update_snapshot(self.metadata["snapshot"])
-        for meta_file_path in trusted_set.snapshot.signed.meta.keys():
-            trusted_set.snapshot.signed.meta[meta_file_path].version = 1
+            self.trusted_set.update_snapshot(self.metadata["snapshot"])
+        for meta_file_path in self.trusted_set.snapshot.signed.meta.keys():
+            self.trusted_set.snapshot.signed.meta[meta_file_path].version = 1
 
         # new_snapshot has expired
         snapshot_obj = Metadata.from_bytes(self.metadata["snapshot"])
@@ -328,42 +321,41 @@ def test_update_snapshot_after_succesfull_update(self):
         modified_hashes = self._calculate_modified_hashes(
             true_hashes, modified_snapshot_data
         )
-        trusted_set.timestamp.signed.meta["snapshot.json"].hashes = modified_hashes
+        self.trusted_set.timestamp.signed.meta["snapshot.json"].hashes = modified_hashes
         with self.assertRaises(exceptions.ExpiredMetadataError):
-            trusted_set.update_snapshot(modified_snapshot_data)
-        trusted_set.timestamp.signed.meta["snapshot.json"].hashes = true_hashes
+            self.trusted_set.update_snapshot(modified_snapshot_data)
+        self.trusted_set.timestamp.signed.meta["snapshot.json"].hashes = true_hashes
 
     def test_update_targets(self):
-        trusted_set = TrustedMetadataSet(self.metadata["root"])
-        trusted_set.root_update_finished()
-        trusted_set.update_timestamp(self.metadata["timestamp"])
-        trusted_set.update_snapshot(self.metadata["snapshot"])
+        self.trusted_set.root_update_finished()
+        self.trusted_set.update_timestamp(self.metadata["timestamp"])
+        self.trusted_set.update_snapshot(self.metadata["snapshot"])
 
         # remove meta information with information about targets from snapshot
-        trusted_set.snapshot.signed.meta = {}
+        self.trusted_set.snapshot.signed.meta = {}
         with self.assertRaises(exceptions.RepositoryError):
-            trusted_set.update_targets(self.metadata["targets"])
+            self.trusted_set.update_targets(self.metadata["targets"])
         snapshot = Metadata.from_bytes(self.metadata["snapshot"])
-        trusted_set.snapshot.signed.meta = snapshot.signed.meta
+        self.trusted_set.snapshot.signed.meta = snapshot.signed.meta
 
         # observed_hash != stored hash in snapshot meta for targets
         true_hashes = {}
-        for target_path, meta_file in trusted_set.snapshot.signed.meta.items():
+        for target_path, meta_file in self.trusted_set.snapshot.signed.meta.items():
             true_hashes[target_path] = meta_file.hashes
-            trusted_set.snapshot.signed.meta[target_path].hashes = {"sha256": "b"}
+            self.trusted_set.snapshot.signed.meta[target_path].hashes = {"sha256": "b"}
         with self.assertRaises(exceptions.BadHashError):
-            trusted_set.update_targets(self.metadata["targets"])
+            self.trusted_set.update_targets(self.metadata["targets"])
         # Return to the original hash values
         for target_path in true_hashes.keys():
-            trusted_set.snapshot.signed.meta[target_path].hashes = \
+            self.trusted_set.snapshot.signed.meta[target_path].hashes = \
                 true_hashes[target_path]
 
         # new_delegate.signed.version != meta.version stored in snapshot
-        for target_path in trusted_set.snapshot.signed.meta.keys():
-            trusted_set.snapshot.signed.meta[target_path].version = 2
+        for target_path in self.trusted_set.snapshot.signed.meta.keys():
+            self.trusted_set.snapshot.signed.meta[target_path].version = 2
         with self.assertRaises(exceptions.BadVersionNumberError):
-            trusted_set.update_targets(self.metadata["targets"])
-        trusted_set.snapshot.signed.meta[target_path].version = 1
+            self.trusted_set.update_targets(self.metadata["targets"])
+        self.trusted_set.snapshot.signed.meta[target_path].version = 1
 
         # new_delegate has expired
         targets_obj = Metadata.from_bytes(self.metadata["targets"])
@@ -373,7 +365,7 @@ def test_update_targets(self):
         self._sign_modified_obj("targets", targets_obj)
         modified_targets_data = json.dumps(targets_obj.to_dict()).encode()
         with self.assertRaises(exceptions.ExpiredMetadataError):
-            trusted_set.update_targets(modified_targets_data)
+            self.trusted_set.update_targets(modified_targets_data)
 
     # TODO test updating over initial metadata (new keys, newer timestamp, etc)