Skip to content

Add TargetFile.get_prefixed_paths() #2338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lukpueh merged 4 commits into from
Mar 29, 2023
Merged

Add TargetFile.get_prefixed_paths() #2338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
24b1db6
feat: generate hash-prefixed path names for target
kamui-fin Nov 17, 2022
1e47e39
docs: add docstring for method
kamui-fin Nov 17, 2022
0eef15a
fix: parse manually and handle url edge cases
kamui-fin Nov 18, 2022
cddae3b
Updates to TargetFile.get_prefixed_paths()
jku Mar 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions tests/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -725,6 +725,34 @@ def test_targetfile_from_data(self) -> None:
targetfile_from_data = TargetFile.from_data(target_file_path, data)
targetfile_from_data.verify_length_and_hashes(data)

def test_targetfile_get_prefixed_paths(self) -> None:
target = TargetFile(100, {"sha256": "abc", "md5": "def"}, "a/b/f.ext")
self.assertEqual(
target.get_prefixed_paths(), ["a/b/abc.f.ext", "a/b/def.f.ext"]
)

target = TargetFile(100, {"sha256": "abc", "md5": "def"}, "")
self.assertEqual(target.get_prefixed_paths(), ["abc.", "def."])

target = TargetFile(100, {"sha256": "abc", "md5": "def"}, "a/b/")
self.assertEqual(target.get_prefixed_paths(), ["a/b/abc.", "a/b/def."])

target = TargetFile(100, {"sha256": "abc", "md5": "def"}, "f.ext")
self.assertEqual(
target.get_prefixed_paths(), ["abc.f.ext", "def.f.ext"]
)

target = TargetFile(100, {"sha256": "abc", "md5": "def"}, "a/b/.ext")
self.assertEqual(
target.get_prefixed_paths(), ["a/b/abc..ext", "a/b/def..ext"]
)

target = TargetFile(100, {"sha256": "abc"}, "/root/file.ext")
self.assertEqual(target.get_prefixed_paths(), ["/root/abc.file.ext"])

target = TargetFile(100, {"sha256": "abc"}, "/")
self.assertEqual(target.get_prefixed_paths(), ["/abc."])

def test_is_delegated_role(self) -> None:
# test path matches
# see more extensive tests in test_is_target_in_pathpattern()
Expand Down
11 changes: 11 additions & 0 deletions tuf/api/metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1737,6 +1737,17 @@ def verify_length_and_hashes(self, data: Union[bytes, IO[bytes]]) -> None:
self._verify_length(data, self.length)
self._verify_hashes(data, self.hashes)

def get_prefixed_paths(self) -> List[str]:
"""
Return hash-prefixed URL path fragments for the target file path.
"""
paths = []
parent, sep, name = self.path.rpartition("/")
for hash_value in self.hashes.values():
paths.append(f"{parent}{sep}{hash_value}.{name}")

return paths


class Targets(Signed):
"""A container for the signed part of targets metadata.
Expand Down