Skip to content

Commit

Permalink
Address review comments
Browse files Browse the repository at this point in the history 
Revive package-url#245 by adding the
following changes:

- `registry_url` -> `repository_url`
- `registry_version` -> `port_revision`
- Remove percent escaping from `repository_url` to be more consistent
  with other uses of `repository_url` in the purl spec
  • Loading branch information
@aristotelos
aristotelos committed Sep 17, 2024
1 parent 08ca6fa commit 20b979f
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 46 deletions.
31 changes: 10 additions & 21 deletions PURL-TYPES.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -530,32 +530,21 @@ vcpkg
- **port** - A package, along with it's build scripts and possibly minor modifications.
- **registry** - A collection of ports, possibly private to the user. Analogous to **repository**.

- ``namespace``: Currently reserved for future use and should be empty

- ``namespace``: Currently reserved for future use and should be empty.
- ``name``: The case-sensitive name of the port. **Required**
- ``version``: The port version. **Required**
- ``qualifiers``: The qualifiers below are used to provide more specific information on a port's origin registry and to distinguish between multiple instances of the same port dependency within the same project (for example, when the project targets multiple platforms).

- ``repository_url``: A `percent-encoded <https://www.rfc-editor.org/rfc/rfc3986#section-2.1>`_ absolute URI for the registry the port came from. For filesystem registries, the URI will have a `file` URI scheme. **Optional**

- If empty, the port comes from the default registry, ``https://github.com/microsoft/vcpkg``.

- ``registry_version``: A string specifying the version of the registry specified by `repository_url`.

- For git registries, the commit hash (potentially abbreviated). This must __NOT__ be any other kind of git reference, such as `HEAD` or tags. **Required**
- For filesystem registries, an string that can be used to identify specific versions, such as Coordinated Universal Time (UTC) as described in `RFC 3339 <https://datatracker.ietf.org/doc/html/rfc3339>`_. If using a UTC time, be sure to percent-encode it correctly. **Optional**

- Additional qualifiers may be present on the purl that provide additional information about the context in which the package is being used, such as build configuration or platform information. These additional qualifiers must be tolerated during parsing and can be ignored if the parser does not expect them.

- ``version``: The upstream version of the port. **Required**
- ``subpath``: Currently reserved for future use and should be empty.
- Qualifier ``repository_url``: The vcpkg registry where the package is available (optional). If omitted, ``https://github.com/microsoft/vcpkg`` as default registry is assumed.
- Qualifier ``port_revision``: A string specifying the [port file revision](https://learn.microsoft.com/en-us/vcpkg/reference/vcpkg-json#port-version) (optional).
- Additional qualifiers may be present on the purl that provide additional information about the context in which the package is being used, such as build configuration or platform information. These additional qualifiers must be tolerated during parsing and can be ignored if the parser does not expect them.
- Examples::

Microsoft GSL version 4.0.0 from the default registry at commit 4e2b371
pkg:vcpkg/[email protected]?registry_version=4e2b371
ffmpeg version 5.1.2 from the azure-sdk registry at commit e6c17cc
pkg:vcpkg/[email protected]?registry_url=https%3A%2F%2Fgithub.com%2Fazure-sdk%2Fvcpkg&registry_version=e6c17cc
Microsoft GSL version 4.0.0 from the default registry with port file revision 4
pkg:vcpkg/[email protected]?port_revision=4
ffmpeg version 5.1.2 from the azure-sdk registry
pkg:vcpkg/[email protected]?repository_url=https://github.com/azure-sdk/vcpkg
LLVM from a filesystem registry
pkg:vcpkg/[email protected]?registry_url=file%3A%2F%2F%2FC%3A%2Flocal-registry%2Fvcpkg&registry_version=2023-08-18T22%3A28%3A52Z
pkg:vcpkg/[email protected]?repository_url=file:///C:/local-registry/vcpkg



Expand Down
81 changes: 56 additions & 25 deletions test-suite-data.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
"namespace": "debian",
"name": "curl",
"version": "7.50.3-1",
"qualifiers": {"arch": "i386", "distro": "jessie"},
"qualifiers": { "arch": "i386", "distro": "jessie" },
"subpath": null,
"is_invalid": false
},
Expand All @@ -91,7 +91,7 @@
"namespace": "customer",
"name": "dockerimage",
"version": "sha256:244fd47e07d1004f0aed9c",
"qualifiers": {"repository_url": "gcr.io"},
"qualifiers": { "repository_url": "gcr.io" },
"subpath": null,
"is_invalid": false
},
Expand All @@ -103,7 +103,7 @@
"namespace": null,
"name": "jruby-launcher",
"version": "1.1.2",
"qualifiers": {"platform": "java"},
"qualifiers": { "platform": "java" },
"subpath": null,
"is_invalid": false
},
Expand All @@ -115,7 +115,10 @@
"namespace": "org.apache.xmlgraphics",
"name": "batik-anim",
"version": "1.9.1",
"qualifiers": {"classifier": "sources", "repository_url": "repo.spring.io/release"},
"qualifiers": {
"classifier": "sources",
"repository_url": "repo.spring.io/release"
},
"subpath": null,
"is_invalid": false
},
Expand All @@ -127,7 +130,10 @@
"namespace": "org.apache.xmlgraphics",
"name": "batik-anim",
"version": "1.9.1",
"qualifiers": {"extension": "pom", "repository_url": "repo.spring.io/release"},
"qualifiers": {
"extension": "pom",
"repository_url": "repo.spring.io/release"
},
"subpath": null,
"is_invalid": false
},
Expand All @@ -139,7 +145,7 @@
"namespace": "net.sf.jacob-project",
"name": "jacob",
"version": "1.14.3",
"qualifiers": {"classifier": "x86", "type": "dll"},
"qualifiers": { "classifier": "x86", "type": "dll" },
"subpath": null,
"is_invalid": false
},
Expand Down Expand Up @@ -187,7 +193,7 @@
"namespace": "fedora",
"name": "curl",
"version": "7.50.3-1.fc25",
"qualifiers": {"arch": "i386", "distro": "fedora-25"},
"qualifiers": { "arch": "i386", "distro": "fedora-25" },
"subpath": null,
"is_invalid": false
},
Expand Down Expand Up @@ -283,7 +289,7 @@
"namespace": "mygroup",
"name": "myartifact",
"version": "1.0.0 Final",
"qualifiers": {"mykey": "my value"},
"qualifiers": { "mykey": "my value" },
"subpath": null,
"is_invalid": false
},
Expand All @@ -295,7 +301,7 @@
"namespace": null,
"name": "myartifact",
"version": "1.0.0",
"qualifiers": {"in production": "true"},
"qualifiers": { "in production": "true" },
"subpath": null,
"is_invalid": true
},
Expand All @@ -319,7 +325,7 @@
"namespace": "bincrafters",
"name": "cctz",
"version": "2.3",
"qualifiers": {"channel": "stable"},
"qualifiers": { "channel": "stable" },
"subpath": null,
"is_invalid": false
},
Expand All @@ -343,43 +349,55 @@
"namespace": null,
"name": "cctz",
"version": "2.3",
"qualifiers": {"channel": "stable"},
"qualifiers": { "channel": "stable" },
"subpath": null,
"is_invalid": true
},
{
"description": "simple vcpkg purl",
"purl": "pkg:vcpkg/[email protected]?registry_version=4e2b371",
"canonical_purl": "pkg:vcpkg/[email protected]?registry_version=4e2b371",
"purl": "pkg:vcpkg/[email protected]",
"canonical_purl": "pkg:vcpkg/[email protected]",
"type": "vcpkg",
"namespace": null,
"name": "ms-gsl",
"version": "4.0.0",
"qualifiers": {"registry_version": "4e2b371"},
"qualifiers": null,
"subpath": null,
"is_invalid": false
},
{
"description": "vcpkg with port_revision",
"purl": "pkg:vcpkg/[email protected]?port_revision=4",
"canonical_purl": "pkg:vcpkg/[email protected]?port_revision=4",
"type": "vcpkg",
"namespace": null,
"name": "ms-gsl",
"version": "4.0.0",
"qualifiers": { "port_revision": "4" },
"subpath": null,
"is_invalid": false
},
{
"description": "vcpkg non-default git registry",
"purl": "pkg:vcpkg/[email protected]?registry_url=https%3A%2F%2Fgithub.com%2Fazure-sdk%2Fvcpkg&registry_version=e6c17cc",
"canonical_purl": "pkg:vcpkg/[email protected]?registry_url=https%3A%2F%2Fgithub.com%2Fazure-sdk%2Fvcpkg&registry_version=e6c17cc",
"purl": "pkg:vcpkg/[email protected]?repository_url=https://github.com/azure-sdk/vcpkg&port_revision=3",
"canonical_purl": "pkg:vcpkg/[email protected]?repository_url=https://github.com/azure-sdk/vcpkg&port_revision=3",
"type": "vcpkg",
"namespace": null,
"name": "ffmpeg",
"version": "5.1.2",
"qualifiers": {"registry_url": "https://github.com/azure-sdk/vcpkg", "registry_version": "e6c17cc"},
"qualifiers": { "repository_url": "https://github.com/azure-sdk/vcpkg", "port_revision": "3" },
"subpath": null,
"is_invalid": false
},
{
"description": "vcpkg filesystem registry",
"purl": "pkg:vcpkg/[email protected]?registry_url=file%3A%2F%2F%2FC%3A%2Flocal-registry%2Fvcpkg&registry_version=2023-08-18T22%3A28%3A52Z",
"canonical_purl": "pkg:vcpkg/[email protected]?registry_url=file%3A%2F%2F%2FC%3A%2Flocal-registry%2Fvcpkg&registry_version=2023-08-18T22%3A28%3A52Z",
"purl": "pkg:vcpkg/[email protected]?registry_url=file:///C:/local-registry/vcpkg",
"canonical_purl": "pkg:vcpkg/[email protected]?registry_url=file:///C:/local-registry/vcpkg",
"type": "vcpkg",
"namespace": null,
"name": "llvm",
"version": "15.0.7",
"qualifiers": {"registry_url": "file:///C:/local-registry/vcpkg", "registry_version": "2023-08-18T22:28:52Z"},
"qualifiers": { "registry_url": "file:///C:/local-registry/vcpkg" },
"subpath": null,
"is_invalid": false
},
Expand All @@ -391,7 +409,12 @@
"namespace": null,
"name": "absl-py",
"version": "0.4.1",
"qualifiers": {"build": "py36h06a4308_0", "channel": "main", "subdir": "linux-64", "type": "tar.bz2"},
"qualifiers": {
"build": "py36h06a4308_0",
"channel": "main",
"subdir": "linux-64",
"type": "tar.bz2"
},
"subpath": null,
"is_invalid": false
},
Expand Down Expand Up @@ -523,7 +546,7 @@
"namespace": "microsoft",
"name": "deberta-v3-base",
"version": "559062ad13d311b87b2c455e67dcd5f1c8f65111",
"qualifiers": {"repository_url": "https://hub-ci.huggingface.co"},
"qualifiers": { "repository_url": "https://hub-ci.huggingface.co" },
"subpath": null,
"is_invalid": false
},
Expand All @@ -547,7 +570,9 @@
"namespace": null,
"name": "creditfraud",
"version": "3",
"qualifiers": {"repository_url": "https://adb-5245952564735461.0.azuredatabricks.net/api/2.0/mlflow"},
"qualifiers": {
"repository_url": "https://adb-5245952564735461.0.azuredatabricks.net/api/2.0/mlflow"
},
"subpath": null,
"is_invalid": false
},
Expand All @@ -559,7 +584,9 @@
"namespace": null,
"name": "CreditFraud",
"version": "3",
"qualifiers": {"repository_url": "https://westus2.api.azureml.ms/mlflow/v1.0/subscriptions/a50f2011-fab8-4164-af23-c62881ef8c95/resourceGroups/TestResourceGroup/providers/Microsoft.MachineLearningServices/workspaces/TestWorkspace"},
"qualifiers": {
"repository_url": "https://westus2.api.azureml.ms/mlflow/v1.0/subscriptions/a50f2011-fab8-4164-af23-c62881ef8c95/resourceGroups/TestResourceGroup/providers/Microsoft.MachineLearningServices/workspaces/TestWorkspace"
},
"subpath": null,
"is_invalid": false
},
Expand All @@ -571,7 +598,11 @@
"namespace": null,
"name": "trafficsigns",
"version": "10",
"qualifiers": {"model_uuid": "36233173b22f4c89b451f1228d700d49", "run_id": "410a3121-2709-4f88-98dd-dba0ef056b0a", "repository_url": "https://adb-5245952564735461.0.azuredatabricks.net/api/2.0/mlflow"},
"qualifiers": {
"model_uuid": "36233173b22f4c89b451f1228d700d49",
"run_id": "410a3121-2709-4f88-98dd-dba0ef056b0a",
"repository_url": "https://adb-5245952564735461.0.azuredatabricks.net/api/2.0/mlflow"
},
"subpath": null,
"is_invalid": false
},
Expand Down

0 comments on commit 20b979f

Please sign in to comment.