Skip to content

Commit

Permalink
Add download purl2url support for bitbucket and gitlab
Browse files Browse the repository at this point in the history
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
  • Loading branch information
TG1999 committed Jul 25, 2023
1 parent b0111ad commit 2b7e68a
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 7 deletions.
40 changes: 36 additions & 4 deletions src/packageurl/contrib/purl2url.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,26 @@
from packageurl.contrib.route import NoRouteAvailable
from packageurl.contrib.route import Router


def get_repo_download_url_by_package_type(
type, namespace, name, version, archive_extension="tar.gz"
):
"""
Return the download URL for a hosted git repository given a package type
or None.
"""
assert archive_extension in (
"zip",
"tar.gz",
)
download_url_by_type = {
"github": f"https://github.com/{namespace}/{name}/archive/refs/tags/{version}.{archive_extension}",
"bitbucket": f"https://bitbucket.org/{namespace}/{name}/get/{version}.{archive_extension}",
"gitlab": f"https://gitlab.com/{namespace}/{name}/-/archive/{version}/{name}-{version}.{archive_extension}",
}
return download_url_by_type.get(type)


repo_router = Router()
download_router = Router()

Expand Down Expand Up @@ -328,14 +348,24 @@ def build_nuget_download_url(purl):
return f"https://www.nuget.org/api/v2/package/{name}/{version}"


@download_router.route("pkg:github/.*")
def build_github_download_url(purl):
@download_router.route("pkg:gitlab/.*", "pkg:bitbucket/.*", "pkg:github/.*")
def build_repo_download_url(purl):
"""
Return a github download URL from the `purl` string.
Return a gitlab download URL from the `purl` string.
"""
return get_repo_download_url(purl)


def get_repo_download_url(purl):
"""
Return ``download_url`` if present in ``purl`` qualifiers or
if ``namespace``, ``name`` and ``version`` are present in ``purl``
else return None.
"""
purl_data = PackageURL.from_string(purl)

namespace = purl_data.namespace
type = purl_data.type
name = purl_data.name
version = purl_data.version
qualifiers = purl_data.qualifiers
Expand All @@ -350,4 +380,6 @@ def build_github_download_url(purl):
version_prefix = qualifiers.get("version_prefix", "")
version = f"{version_prefix}{version}"

return f"https://github.com/{namespace}/{name}/archive/refs/tags/{version}.zip"
return get_repo_download_url_by_package_type(
type=type, namespace=namespace, name=name, version=version
)
12 changes: 9 additions & 3 deletions tests/contrib/test_purl2url.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,11 @@ def test_purl2url_get_download_url():
"pkg:npm/is-npm@1.0.0": "http://registry.npmjs.org/is-npm/-/is-npm-1.0.0.tgz",
"pkg:hackage/cli-extras@0.2.0.0": "https://hackage.haskell.org/package/cli-extras-0.2.0.0/cli-extras-0.2.0.0.tar.gz",
"pkg:nuget/System.Text.Json@6.0.6": "https://www.nuget.org/api/v2/package/System.Text.Json/6.0.6",
"pkg:github/nexb/scancode-toolkit@3.1.1?version_prefix=v": "https://github.com/nexb/scancode-toolkit/archive/refs/tags/v3.1.1.zip",
"pkg:github/nexb/scancode-toolkit@3.1.1?version_prefix=v": "https://github.com/nexb/scancode-toolkit/archive/refs/tags/v3.1.1.tar.gz",
"pkg:bitbucket/robeden/trove@3.0.3": "https://bitbucket.org/robeden/trove/get/3.0.3.tar.gz",
"pkg:bitbucket/robeden/trove@3.0.3?version_prefix=v": "https://bitbucket.org/robeden/trove/get/v3.0.3.tar.gz",
"pkg:gitlab/tg1999/firebase@1a122122": "https://gitlab.com/tg1999/firebase/-/archive/1a122122/firebase-1a122122.tar.gz",
"pkg:gitlab/tg1999/firebase@1a122122?version_prefix=v": "https://gitlab.com/tg1999/firebase/-/archive/v1a122122/firebase-v1a122122.tar.gz",
# From `download_url` qualifier
"pkg:github/yarnpkg/yarn@1.3.2?download_url=https://github.com/yarnpkg/yarn/releases/download/v1.3.2/yarn-v1.3.2.tar.gz&version_prefix=v": "https://github.com/yarnpkg/yarn/releases/download/v1.3.2/yarn-v1.3.2.tar.gz",
"pkg:generic/lxc-master.tar.gz?download_url=https://salsa.debian.org/lxc-team/lxc/-/archive/master/lxc-master.tar.gz": "https://salsa.debian.org/lxc-team/lxc/-/archive/master/lxc-master.tar.gz",
Expand All @@ -87,7 +91,6 @@ def test_purl2url_get_download_url():
"pkg:cargo/abc": None,
"pkg:gem/package-name": None,
"pkg:bitbucket/birkenfeld": None,
"pkg:gitlab/tg1999/firebase@1a122122": None,
"pkg:pypi/sortedcontainers@2.4.0": None,
"pkg:golang/xorm.io/xorm@v0.8.2": None,
"pkg:golang/gopkg.in/ldap.v3@v3.1.0": None,
Expand Down Expand Up @@ -121,7 +124,10 @@ def test_purl2url_get_inferred_urls():
],
"pkg:cargo/abc": ["https://crates.io/crates/abc"],
"pkg:github/tg1999/fetchcode": ["https://github.com/tg1999/fetchcode"],
"pkg:gitlab/tg1999/firebase@1a122122": ["https://gitlab.com/tg1999/firebase"],
"pkg:gitlab/tg1999/firebase@1a122122": [
"https://gitlab.com/tg1999/firebase",
"https://gitlab.com/tg1999/firebase/-/archive/1a122122/firebase-1a122122.tar.gz",
],
"pkg:pypi/sortedcontainers@2.4.0": ["https://pypi.org/project/sortedcontainers/2.4.0/"],
"pkg:gem/package-name": [],
"pkg:bitbucket/birkenfeld": [],
Expand Down

0 comments on commit 2b7e68a

Please sign in to comment.