Merge pull request #1481 from MVrachev/fix-role-keyids-order

Jussi Kukkonen · web-flow · commit 23e4f5cdcc14 · 2021-07-15T11:52:35.000+03:00
Metadata API: preserve Role.keyids order
diff --git a/tests/test_metadata_serialization.py b/tests/test_metadata_serialization.py
@@ -141,6 +141,7 @@ def test_invalid_role_serialization(self, test_case_data: Dict[str, str]):
 
     valid_roles: DataSet = {
         "all": '{"keyids": ["keyid"], "threshold": 3}',
+        "many keyids": '{"keyids": ["a", "b", "c", "d", "e"], "threshold": 1}',
         "unrecognized field": '{"keyids": ["keyid"], "threshold": 3, "foo": "bar"}',
     }
 
diff --git a/tuf/api/metadata.py b/tuf/api/metadata.py
@@ -614,7 +614,7 @@ def from_dict(cls, role_dict: Dict[str, Any]) -> "Role":
     def to_dict(self) -> Dict[str, Any]:
         """Returns the dictionary representation of self."""
         return {
-            "keyids": list(self.keyids),
+            "keyids": sorted(self.keyids),
             "threshold": self.threshold,
             **self.unrecognized_fields,
         }

Original file line number	Diff line number	Diff line change
`@@ -141,6 +141,7 @@ def test_invalid_role_serialization(self, test_case_data: Dict[str, str]):`
`141`	`141`
`142`	`142`	`valid_roles: DataSet = {`
`143`	`143`	`"all": '{"keyids": ["keyid"], "threshold": 3}',`
	`144`	`+ "many keyids": '{"keyids": ["a", "b", "c", "d", "e"], "threshold": 1}',`
`144`	`145`	`"unrecognized field": '{"keyids": ["keyid"], "threshold": 3, "foo": "bar"}',`
`145`	`146`	`}`
`146`	`147`
Original file line number	Diff line number	Diff line change
`@@ -614,7 +614,7 @@ def from_dict(cls, role_dict: Dict[str, Any]) -> "Role":`
`614`	`614`	`def to_dict(self) -> Dict[str, Any]:`
`615`	`615`	`"""Returns the dictionary representation of self."""`
`616`	`616`	`return {`
`617`		`- "keyids": list(self.keyids),`
	`617`	`+ "keyids": sorted(self.keyids),`
`618`	`618`	`"threshold": self.threshold,`
`619`	`619`	`**self.unrecognized_fields,`
`620`	`620`	`}`