diff --git a/swh/web/api/utils.py b/swh/web/api/utils.py --- a/swh/web/api/utils.py +++ b/swh/web/api/utils.py @@ -86,17 +86,17 @@ enrich_release = enrich_object -def enrich_directory( +def enrich_directory_entry( directory: Dict[str, str], request: Optional[HttpRequest] = None ) -> Dict[str, str]: - """Enrich directory with url to content or directory. + """Enrich directory entry with url to target. Args: - directory: dict of data associated to a swh directory object + directory: dict of data associated to a swh directory entry request: Absolute URIs will be generated if provided Returns: - An enriched directory dict filled with additional urls + An enriched directory dict filled with additional url """ if "type" in directory: target_type = directory["type"] diff --git a/swh/web/api/views/directory.py b/swh/web/api/views/directory.py --- a/swh/web/api/views/directory.py +++ b/swh/web/api/views/directory.py @@ -79,7 +79,7 @@ sha1_git, path, notfound_msg=error_msg_path, - enrich_fn=utils.enrich_directory, + enrich_fn=utils.enrich_directory_entry, request=request, ) else: @@ -88,6 +88,6 @@ archive.lookup_directory, sha1_git, notfound_msg=error_msg_nopath, - enrich_fn=utils.enrich_directory, + enrich_fn=utils.enrich_directory_entry, request=request, ) diff --git a/swh/web/api/views/revision.py b/swh/web/api/views/revision.py --- a/swh/web/api/views/revision.py +++ b/swh/web/api/views/revision.py @@ -53,8 +53,8 @@ """ - def enrich_directory_local(dir, context_url=request_path): - return utils.enrich_directory(dir, context_url) + def enrich_directory_entry_local(dir, context_url=request_path): + return utils.enrich_directory_entry(dir, context_url) rev_id, result = archive.lookup_directory_through_revision( revision, path, limit=limit, with_data=with_data @@ -62,7 +62,7 @@ content = result["content"] if result["type"] == "dir": # dir_entries - result["content"] = list(map(enrich_directory_local, content)) + result["content"] = list(map(enrich_directory_entry_local, content)) elif result["type"] == "file": # content result["content"] = utils.enrich_content(content) elif result["type"] == "rev": # revision diff --git a/swh/web/tests/api/test_utils.py b/swh/web/tests/api/test_utils.py --- a/swh/web/tests/api/test_utils.py +++ b/swh/web/tests/api/test_utils.py @@ -183,12 +183,12 @@ assert actual_release == release_data -def test_enrich_directory_no_type(): - assert utils.enrich_directory({"id": "dir-id"}) == {"id": "dir-id"} +def test_enrich_directory_entry_no_type(): + assert utils.enrich_directory_entry({"id": "dir-id"}) == {"id": "dir-id"} @given(directory()) -def test_enrich_directory_with_type(api_request_factory, archive_data, directory): +def test_enrich_directory_entry_with_type(api_request_factory, archive_data, directory): dir_content = archive_data.directory_ls(directory) @@ -197,7 +197,7 @@ url = reverse("api-1-directory", url_args={"sha1_git": directory}) request = api_request_factory.get(url) - actual_directory = utils.enrich_directory(dir_entry, request) + actual_directory = utils.enrich_directory_entry(dir_entry, request) if dir_entry["type"] == "file": dir_entry["target_url"] = reverse( diff --git a/swh/web/tests/api/views/test_directory.py b/swh/web/tests/api/views/test_directory.py --- a/swh/web/tests/api/views/test_directory.py +++ b/swh/web/tests/api/views/test_directory.py @@ -7,7 +7,7 @@ from hypothesis import given -from swh.web.api.utils import enrich_directory +from swh.web.api.utils import enrich_directory_entry from swh.web.common.utils import reverse from swh.web.tests.data import random_sha1 from swh.web.tests.strategies import directory @@ -22,7 +22,7 @@ dir_content = list(archive_data.directory_ls(directory)) expected_data = list( - map(enrich_directory, dir_content, [rv.wsgi_request] * len(dir_content)) + map(enrich_directory_entry, dir_content, [rv.wsgi_request] * len(dir_content)) ) assert rv.data == expected_data @@ -43,13 +43,13 @@ def test_api_directory_with_path_found(api_client, archive_data, directory): directory_content = archive_data.directory_ls(directory) - path = random.choice(directory_content) + dir_entry = random.choice(directory_content) url = reverse( - "api-1-directory", url_args={"sha1_git": directory, "path": path["name"]} + "api-1-directory", url_args={"sha1_git": directory, "path": dir_entry["name"]} ) rv = check_api_get_responses(api_client, url, status_code=200) - assert rv.data == enrich_directory(path, rv.wsgi_request) + assert rv.data == enrich_directory_entry(dir_entry, rv.wsgi_request) @given(directory())