Skip to content

Commit 1f074f8

Browse files
committed
New API: rename "update" function in a few classes
The method name "update" is ambigious and doesn't tell what we are actually updating. Are we updating one or all meta files in Snapshot? Are we updating one or all target files in Targets? Are we updating "version", "spec_version" or what in Timestamp? Signed-off-by: Martin Vrachev <[email protected]>
1 parent 860b8c9 commit 1f074f8

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

tests/test_api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -232,11 +232,11 @@ def test_metadata_snapshot(self):
232232

233233

234234
self.assertNotEqual(snapshot.signed.meta, fileinfo)
235-
snapshot.signed.update('role1', 2, 123, hashes)
235+
snapshot.signed.update_meta_file('role1', 2, 123, hashes)
236236
self.assertEqual(snapshot.signed.meta, fileinfo)
237237

238238
# Update only version. Length and hashes are optional.
239-
snapshot.signed.update('role1', 3)
239+
snapshot.signed.update_meta_file('role1', 3)
240240
fileinfo['role1.json'] = MetaFile(3)
241241
self.assertEqual(snapshot.signed.meta, fileinfo)
242242

@@ -271,11 +271,11 @@ def test_metadata_timestamp(self):
271271
fileinfo['snapshot.json'].version = 2
272272
fileinfo['snapshot.json'].length = 520
273273
self.assertNotEqual(timestamp.signed.meta, fileinfo)
274-
timestamp.signed.update(2, 520, hashes)
274+
timestamp.signed.update_snapshot_meta(2, 520, hashes)
275275
self.assertEqual(timestamp.signed.meta, fileinfo)
276276

277277
# Update only version. Length and hashes are optional.
278-
timestamp.signed.update(3)
278+
timestamp.signed.update_snapshot_meta(3)
279279
fileinfo['snapshot.json'] = MetaFile(version=3)
280280
self.assertEqual(timestamp.signed.meta, fileinfo)
281281

@@ -333,7 +333,7 @@ def test_metadata_targets(self):
333333
# Assert that data is not aleady equal
334334
self.assertNotEqual(targets.signed.targets[filename], fileinfo)
335335
# Update an already existing fileinfo
336-
targets.signed.update(filename, fileinfo)
336+
targets.signed.update_target(filename, fileinfo)
337337
expected_target_file = TargetFile(length=28, hashes=hashes)
338338
# Verify that data is updated
339339
self.assertEqual(targets.signed.targets[filename], expected_target_file)

tuf/api/metadata.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -506,7 +506,7 @@ def to_dict(self) -> JsonDict:
506506

507507

508508
# Modification.
509-
def update(self, version: int, length: Optional[int] = None,
509+
def update_snapshot_meta(self, version: int, length: Optional[int] = None,
510510
hashes: Optional[JsonDict] = None) -> None:
511511
"""Assigns passed info about snapshot metadata to meta dict. """
512512

@@ -557,7 +557,7 @@ def to_dict(self) -> JsonDict:
557557

558558

559559
# Modification.
560-
def update(
560+
def update_meta_file(
561561
self, rolename: str, version: int, length: Optional[int] = None,
562562
hashes: Optional[JsonDict] = None) -> None:
563563
"""Assigns passed (delegated) targets role info to meta dict. """
@@ -705,7 +705,7 @@ def to_dict(self) -> JsonDict:
705705
return json_dict
706706

707707
# Modification.
708-
def update(self, filename: str, fileinfo: JsonDict) -> None:
708+
def update_target(self, filename: str, fileinfo: JsonDict) -> None:
709709
"""Assigns passed target file info to meta dict. """
710710
self.targets[filename] = TargetFile(fileinfo['length'],
711711
fileinfo['hashes'], fileinfo.get('custom'))

0 commit comments

Comments
 (0)