Skip to content

Commit 35f72a3

Browse files
committed
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 <[email protected]>
1 parent c79ea55 commit 35f72a3

File tree

3 files changed

+14
-11
lines changed

3 files changed

+14
-11
lines changed

tests/test_repository_lib.py

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ def test_import_ed25519_privatekey_from_file(self):
201201

202202

203203

204-
def test_get_metadata_filenames(self):
204+
def test_get_top_level_metadata_filenames(self):
205205

206206
# Test normal case.
207207
metadata_directory = os.path.join('metadata/')
@@ -210,7 +210,8 @@ def test_get_metadata_filenames(self):
210210
'snapshot.json': metadata_directory + 'snapshot.json',
211211
'timestamp.json': metadata_directory + 'timestamp.json'}
212212

213-
self.assertEqual(filenames, repo_lib.get_metadata_filenames('metadata/'))
213+
self.assertEqual(filenames,
214+
repo_lib.get_top_level_metadata_filenames('metadata/'))
214215

215216
# If a directory argument is not specified, the current working directory
216217
# is used.
@@ -219,11 +220,13 @@ def test_get_metadata_filenames(self):
219220
'targets.json': os.path.join(metadata_directory, 'targets.json'),
220221
'snapshot.json': os.path.join(metadata_directory, 'snapshot.json'),
221222
'timestamp.json': os.path.join(metadata_directory, 'timestamp.json')}
222-
self.assertEqual(filenames, repo_lib.get_metadata_filenames(metadata_directory))
223+
self.assertEqual(filenames,
224+
repo_lib.get_top_level_metadata_filenames(metadata_directory))
223225

224226

225227
# Test improperly formatted argument.
226-
self.assertRaises(securesystemslib.exceptions.FormatError, repo_lib.get_metadata_filenames, 3)
228+
self.assertRaises(securesystemslib.exceptions.FormatError,
229+
repo_lib.get_top_level_metadata_filenames, 3)
227230

228231

229232

@@ -797,7 +800,7 @@ def test__load_top_level_metadata(self):
797800
storage_backend = securesystemslib.storage.FilesystemBackend()
798801
repo_lib.write_metadata_file(signable, root_file, 8, False, storage_backend)
799802

800-
filenames = repo_lib.get_metadata_filenames(metadata_directory)
803+
filenames = repo_lib.get_top_level_metadata_filenames(metadata_directory)
801804
repository = repo_tool.create_new_repository(repository_directory, repository_name)
802805
repo_lib._load_top_level_metadata(repository, filenames, repository_name)
803806

tuf/repository_lib.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -812,8 +812,8 @@ def import_ed25519_privatekey_from_file(filepath, password=None):
812812

813813

814814

815-
def get_delegations_filenames(metadata_directory, consistent_snapshot,
816-
storage_backend=None):
815+
def get_delegated_roles_metadata_filenames(metadata_directory,
816+
consistent_snapshot, storage_backend=None):
817817
"""
818818
Return a dictionary containing all filenames in 'metadata_directory'
819819
except the top-level roles.
@@ -861,7 +861,7 @@ def get_delegations_filenames(metadata_directory, consistent_snapshot,
861861

862862

863863

864-
def get_metadata_filenames(metadata_directory):
864+
def get_top_level_metadata_filenames(metadata_directory):
865865
"""
866866
<Purpose>
867867
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,
18261826

18271827
# The expected full filenames of the top-level roles needed to write them to
18281828
# disk.
1829-
filenames = get_metadata_filenames(metadata_directory)
1829+
filenames = get_top_level_metadata_filenames(metadata_directory)
18301830
root_filename = filenames[ROOT_FILENAME]
18311831
targets_filename = filenames[TARGETS_FILENAME]
18321832
snapshot_filename = filenames[SNAPSHOT_FILENAME]

tuf/repository_tool.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3090,7 +3090,7 @@ def load_repository(repository_directory, repository_name='default',
30903090
repository = Repository(repository_directory, metadata_directory,
30913091
targets_directory, storage_backend, repository_name)
30923092

3093-
filenames = repo_lib.get_metadata_filenames(metadata_directory)
3093+
filenames = repo_lib.get_top_level_metadata_filenames(metadata_directory)
30943094

30953095
# The Root file is always available without a version number (a consistent
30963096
# snapshot) attached to the filename. Store the 'consistent_snapshot' value
@@ -3102,7 +3102,7 @@ def load_repository(repository_directory, repository_name='default',
31023102
repository, consistent_snapshot = repo_lib._load_top_level_metadata(repository,
31033103
filenames, repository_name)
31043104

3105-
delegated_roles_filenames = repo_lib.get_delegations_filenames(
3105+
delegated_roles_filenames = repo_lib.get_delegated_roles_metadata_filenames(
31063106
metadata_directory, consistent_snapshot, storage_backend)
31073107

31083108
# Load the delegated targets metadata and their fileinfo.

0 commit comments

Comments
 (0)