tests: Refactor key rotation in simulator

Add a method to rotate roles keys into RepositorySimulator (only top-level roles are supported for now). Rotation is used in four places already and this refactoring makes the tests easier to understand. Signed-off-by: Jussi Kukkonen <[email protected]>
theupdateframework · Jan 12, 2022 · a38bf7c · a38bf7c
1 parent f172972
commit a38bf7c
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 24 deletions.
diff --git a/tests/repository_simulator.py b/tests/repository_simulator.py
@@ -163,6 +163,15 @@ def add_signer(self, role: str, signer: SSlibSigner) -> None:
             self.signers[role] = {}
         self.signers[role][signer.key_dict["keyid"]] = signer
 
+    def rotate_keys(self, role: str) -> None:
+        """remove all keys for role, then add threshold of new keys"""
+        self.root.roles[role].keyids.clear()
+        self.signers[role].clear()
+        for _ in range(0, self.root.roles[role].threshold):
+            key, signer = self.create_key()
+            self.root.add_key(role, key)
+            self.add_signer(role, signer)
+
     def _initialize(self) -> None:
         """Setup a minimal valid repository."""
 

diff --git a/tests/test_updater_top_level_update.py b/tests/test_updater_top_level_update.py
@@ -360,12 +360,8 @@ def test_new_timestamp_fast_foward_recovery(self) -> None:
         self._run_refresh()
         self._assert_version_equals(Timestamp.type, 99999)
 
-        # repo add new timestamp keys and recovers the timestamp version
-        self.sim.root.roles[Timestamp.type].keyids.clear()
-        self.sim.signers[Timestamp.type].clear()
-        key, signer = self.sim.create_key()
-        self.sim.root.add_key(Timestamp.type, key)
-        self.sim.add_signer(Timestamp.type, signer)
+        # repository rotates timestamp keys, rolls back timestamp version
+        self.sim.rotate_keys(Timestamp.type)
         self.sim.root.version += 1
         self.sim.publish_root()
         self.sim.timestamp.version = 1
@@ -448,17 +444,9 @@ def test_new_snapshot_fast_foward_recovery(self) -> None:
         self._run_refresh()
         self._assert_version_equals(Snapshot.type, 99999)
 
-        # repo add new snapshot and timestamp keys and recovers snapshot version
-        self.sim.root.roles[Snapshot.type].keyids.clear()
-        self.sim.signers[Snapshot.type].clear()
-        self.sim.root.roles[Timestamp.type].keyids.clear()
-        self.sim.signers[Timestamp.type].clear()
-        snapshot_key, snapshot_signer = self.sim.create_key()
-        self.sim.root.add_key(Snapshot.type, snapshot_key)
-        self.sim.add_signer(Snapshot.type, snapshot_signer)
-        timestamp_key, timestamp_signer = self.sim.create_key()
-        self.sim.root.add_key(Timestamp.type, timestamp_key)
-        self.sim.add_signer(Timestamp.type, timestamp_signer)
+        # repository rotates snapshot & timestamp keys, rolls back snapshot
+        self.sim.rotate_keys(Snapshot.type)
+        self.sim.rotate_keys(Timestamp.type)
         self.sim.root.version += 1
         self.sim.publish_root()
 
@@ -562,13 +550,8 @@ def test_new_targets_fast_forward_recovery(self) -> None:
         self._run_refresh()
         self._assert_version_equals(Targets.type, 99999)
 
-        # repo add new snapshot keys and recovers the targets version
-        self.sim.root.roles[Snapshot.type].keyids.clear()
-        self.sim.signers[Snapshot.type].clear()
-        snapshot_key, snapshot_signer = self.sim.create_key()
-        self.sim.root.add_key(Snapshot.type, snapshot_key)
-        self.sim.add_signer(Snapshot.type, snapshot_signer)
-
+        # repository rotates snapshot keys, rolls back targets version
+        self.sim.rotate_keys(Snapshot.type)
         self.sim.root.version += 1
         self.sim.publish_root()