From 35f72a3a09923a9131e1ebaf50e3972ac4643e1c Mon Sep 17 00:00:00 2001 From: Teodora Sechkova Date: Wed, 24 Jun 2020 13:40:27 +0300 Subject: [PATCH] Rename get_*_metadata_filenames functions Rename repository_lib.get_metadata_filenames() and get_delegations_filenames() to better match their functionality and tuf terminology. Signed-off-by: Teodora Sechkova --- tests/test_repository_lib.py | 13 ++++++++----- tuf/repository_lib.py | 8 ++++---- tuf/repository_tool.py | 4 ++-- 3 files changed, 14 insertions(+), 11 deletions(-) diff --git a/tests/test_repository_lib.py b/tests/test_repository_lib.py index 9e07b0be25..53ca0000d9 100755 --- a/tests/test_repository_lib.py +++ b/tests/test_repository_lib.py @@ -201,7 +201,7 @@ def test_import_ed25519_privatekey_from_file(self): - def test_get_metadata_filenames(self): + def test_get_top_level_metadata_filenames(self): # Test normal case. metadata_directory = os.path.join('metadata/') @@ -210,7 +210,8 @@ def test_get_metadata_filenames(self): 'snapshot.json': metadata_directory + 'snapshot.json', 'timestamp.json': metadata_directory + 'timestamp.json'} - self.assertEqual(filenames, repo_lib.get_metadata_filenames('metadata/')) + self.assertEqual(filenames, + repo_lib.get_top_level_metadata_filenames('metadata/')) # If a directory argument is not specified, the current working directory # is used. @@ -219,11 +220,13 @@ def test_get_metadata_filenames(self): 'targets.json': os.path.join(metadata_directory, 'targets.json'), 'snapshot.json': os.path.join(metadata_directory, 'snapshot.json'), 'timestamp.json': os.path.join(metadata_directory, 'timestamp.json')} - self.assertEqual(filenames, repo_lib.get_metadata_filenames(metadata_directory)) + self.assertEqual(filenames, + repo_lib.get_top_level_metadata_filenames(metadata_directory)) # Test improperly formatted argument. - self.assertRaises(securesystemslib.exceptions.FormatError, repo_lib.get_metadata_filenames, 3) + self.assertRaises(securesystemslib.exceptions.FormatError, + repo_lib.get_top_level_metadata_filenames, 3) @@ -797,7 +800,7 @@ def test__load_top_level_metadata(self): storage_backend = securesystemslib.storage.FilesystemBackend() repo_lib.write_metadata_file(signable, root_file, 8, False, storage_backend) - filenames = repo_lib.get_metadata_filenames(metadata_directory) + filenames = repo_lib.get_top_level_metadata_filenames(metadata_directory) repository = repo_tool.create_new_repository(repository_directory, repository_name) repo_lib._load_top_level_metadata(repository, filenames, repository_name) diff --git a/tuf/repository_lib.py b/tuf/repository_lib.py index de088aa462..5f39d6edff 100644 --- a/tuf/repository_lib.py +++ b/tuf/repository_lib.py @@ -812,8 +812,8 @@ def import_ed25519_privatekey_from_file(filepath, password=None): -def get_delegations_filenames(metadata_directory, consistent_snapshot, - storage_backend=None): +def get_delegated_roles_metadata_filenames(metadata_directory, + consistent_snapshot, storage_backend=None): """ Return a dictionary containing all filenames in 'metadata_directory' except the top-level roles. @@ -861,7 +861,7 @@ def get_delegations_filenames(metadata_directory, consistent_snapshot, -def get_metadata_filenames(metadata_directory): +def get_top_level_metadata_filenames(metadata_directory): """ Return a dictionary containing the filenames of the top-level roles. @@ -1826,7 +1826,7 @@ def _log_status_of_top_level_roles(targets_directory, metadata_directory, # The expected full filenames of the top-level roles needed to write them to # disk. - filenames = get_metadata_filenames(metadata_directory) + filenames = get_top_level_metadata_filenames(metadata_directory) root_filename = filenames[ROOT_FILENAME] targets_filename = filenames[TARGETS_FILENAME] snapshot_filename = filenames[SNAPSHOT_FILENAME] diff --git a/tuf/repository_tool.py b/tuf/repository_tool.py index ba91825584..89ff9c4051 100755 --- a/tuf/repository_tool.py +++ b/tuf/repository_tool.py @@ -3090,7 +3090,7 @@ def load_repository(repository_directory, repository_name='default', repository = Repository(repository_directory, metadata_directory, targets_directory, storage_backend, repository_name) - filenames = repo_lib.get_metadata_filenames(metadata_directory) + filenames = repo_lib.get_top_level_metadata_filenames(metadata_directory) # The Root file is always available without a version number (a consistent # snapshot) attached to the filename. Store the 'consistent_snapshot' value @@ -3102,7 +3102,7 @@ def load_repository(repository_directory, repository_name='default', repository, consistent_snapshot = repo_lib._load_top_level_metadata(repository, filenames, repository_name) - delegated_roles_filenames = repo_lib.get_delegations_filenames( + delegated_roles_filenames = repo_lib.get_delegated_roles_metadata_filenames( metadata_directory, consistent_snapshot, storage_backend) # Load the delegated targets metadata and their fileinfo.