Merge pull request #32 from DarthHater/TestSuiteData

Add in test suite json

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

.gitignore

@@ -7,8 +7,6 @@
 # Test binary, build with `go test -c`
 *.test
 
-testdata/*json
-
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 

packageurl.go

@@ -181,7 +181,8 @@ func (p *PackageURL) ToString() string {
 		purl = purl + strings.Join(ns, "/") + "/"
 	}
 	// The name is always required and must be a percent-encoded string
-	purl = purl + url.PathEscape(p.Name)
+	// Use url.QueryEscape instead of PathEscape, as it handles @ signs
+	purl = purl + url.QueryEscape(p.Name)
 	// If a version is provided, add it after the at symbol
 	if p.Version != "" {
 		// A name must be a percent-encoded string
@@ -292,7 +293,12 @@ func FromString(purl string) (PackageURL, error) {
 			return PackageURL{}, fmt.Errorf("failed to unescape purl version: %s", err)
 		}
 		version = v
-		name = name[:atIndex]
+
+		unecapeName, err := url.PathUnescape(name[:atIndex])
+		if err != nil {
+			return PackageURL{}, fmt.Errorf("failed to unescape purl name: %s", err)
+		}
+		name = unecapeName
 	}
 	var namespaces []string
 

testdata/test-suite-data.json

@@ -0,0 +1,362 @@
+[
+  {
+    "description": "valid maven purl",
+    "purl": "pkg:maven/org.apache.commons/io@1.3.4",
+    "canonical_purl": "pkg:maven/org.apache.commons/io@1.3.4",
+    "type": "maven",
+    "namespace": "org.apache.commons",
+    "name": "io",
+    "version": "1.3.4",
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "basic valid maven purl without version",
+    "purl": "pkg:maven/org.apache.commons/io",
+    "canonical_purl": "pkg:maven/org.apache.commons/io",
+    "type": "maven",
+    "namespace": "org.apache.commons",
+    "name": "io",
+    "version": null,
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "valid go purl without version and with subpath",
+    "purl": "pkg:GOLANG/google.golang.org/genproto#/googleapis/api/annotations/",
+    "canonical_purl": "pkg:golang/google.golang.org/genproto#googleapis/api/annotations",
+    "type": "golang",
+    "namespace": "google.golang.org",
+    "name": "genproto",
+    "version": null,
+    "qualifiers": null,
+    "subpath": "googleapis/api/annotations",
+    "is_invalid": false
+  },
+  {
+    "description": "valid go purl with version and subpath",
+    "purl": "pkg:GOLANG/google.golang.org/genproto@abcdedf#/googleapis/api/annotations/",
+    "canonical_purl": "pkg:golang/google.golang.org/genproto@abcdedf#googleapis/api/annotations",
+    "type": "golang",
+    "namespace": "google.golang.org",
+    "name": "genproto",
+    "version": "abcdedf",
+    "qualifiers": null,
+    "subpath": "googleapis/api/annotations",
+    "is_invalid": false
+  },
+  {
+    "description": "valid go purl with namespace that has a forward slash",
+    "purl": "pkg:golang/github.com/etcd-io/etcd@v2.4.0",
+    "canonical_purl": "pkg:golang/github.com/etcd-io/etcd@v2.4.0",
+    "type": "golang",
+    "namespace": "github.com/etcd-io",
+    "name": "etcd",
+    "version": "v2.4.0",
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "bitbucket namespace and name should be lowercased",
+    "purl": "pkg:bitbucket/birKenfeld/pyGments-main@244fd47e07d1014f0aed9c",
+    "canonical_purl": "pkg:bitbucket/birkenfeld/pygments-main@244fd47e07d1014f0aed9c",
+    "type": "bitbucket",
+    "namespace": "birkenfeld",
+    "name": "pygments-main",
+    "version": "244fd47e07d1014f0aed9c",
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "github namespace and name should be lowercased",
+    "purl": "pkg:github/Package-url/purl-Spec@244fd47e07d1004f0aed9c",
+    "canonical_purl": "pkg:github/package-url/purl-spec@244fd47e07d1004f0aed9c",
+    "type": "github",
+    "namespace": "package-url",
+    "name": "purl-spec",
+    "version": "244fd47e07d1004f0aed9c",
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "debian can use qualifiers",
+    "purl": "pkg:deb/debian/curl@7.50.3-1?arch=i386&distro=jessie",
+    "canonical_purl": "pkg:deb/debian/curl@7.50.3-1?arch=i386&distro=jessie",
+    "type": "deb",
+    "namespace": "debian",
+    "name": "curl",
+    "version": "7.50.3-1",
+    "qualifiers": {"arch": "i386","distro": "jessie"},
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "docker uses qualifiers and hash image id as versions",
+    "purl": "pkg:docker/customer/dockerimage@sha256:244fd47e07d1004f0aed9c?repository_url=gcr.io",
+    "canonical_purl": "pkg:docker/customer/dockerimage@sha256:244fd47e07d1004f0aed9c?repository_url=gcr.io",
+    "type": "docker",
+    "namespace": "customer",
+    "name": "dockerimage",
+    "version": "sha256:244fd47e07d1004f0aed9c",
+    "qualifiers": {"repository_url": "gcr.io"},
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "Java gem can use a qualifier",
+    "purl": "pkg:gem/jruby-launcher@1.1.2?Platform=java",
+    "canonical_purl": "pkg:gem/jruby-launcher@1.1.2?platform=java",
+    "type": "gem",
+    "namespace": null,
+    "name": "jruby-launcher",
+    "version": "1.1.2",
+    "qualifiers": {"platform": "java"},
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "maven often uses qualifiers",
+    "purl": "pkg:Maven/org.apache.xmlgraphics/batik-anim@1.9.1?classifier=sources&repositorY_url=repo.spring.io/release",
+    "canonical_purl": "pkg:maven/org.apache.xmlgraphics/batik-anim@1.9.1?classifier=sources&repository_url=repo.spring.io/release",
+    "type": "maven",
+    "namespace": "org.apache.xmlgraphics",
+    "name": "batik-anim",
+    "version": "1.9.1",
+    "qualifiers": {"classifier": "sources","repository_url": "repo.spring.io/release"},
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "maven pom reference",
+    "purl": "pkg:Maven/org.apache.xmlgraphics/batik-anim@1.9.1?extension=pom&repositorY_url=repo.spring.io/release",
+    "canonical_purl": "pkg:maven/org.apache.xmlgraphics/batik-anim@1.9.1?extension=pom&repository_url=repo.spring.io/release",
+    "type": "maven",
+    "namespace": "org.apache.xmlgraphics",
+    "name": "batik-anim",
+    "version": "1.9.1",
+    "qualifiers": {"extension": "pom","repository_url": "repo.spring.io/release"},
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "maven can come with a type qualifier",
+    "purl": "pkg:Maven/net.sf.jacob-project/jacob@1.14.3?classifier=x86&type=dll",
+    "canonical_purl": "pkg:maven/net.sf.jacob-project/jacob@1.14.3?classifier=x86&type=dll",
+    "type": "maven",
+    "namespace": "net.sf.jacob-project",
+    "name": "jacob",
+    "version": "1.14.3",
+    "qualifiers": {"classifier": "x86","type": "dll"},
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "npm can be scoped",
+    "purl": "pkg:npm/%40angular/animation@12.3.1",
+    "canonical_purl": "pkg:npm/%40angular/animation@12.3.1",
+    "type": "npm",
+    "namespace": "@angular",
+    "name": "animation",
+    "version": "12.3.1",
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "nuget names are case sensitive",
+    "purl": "pkg:Nuget/EnterpriseLibrary.Common@6.0.1304",
+    "canonical_purl": "pkg:nuget/EnterpriseLibrary.Common@6.0.1304",
+    "type": "nuget",
+    "namespace": null,
+    "name": "EnterpriseLibrary.Common",
+    "version": "6.0.1304",
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "pypi names have special rules and not case sensitive",
+    "purl": "pkg:PYPI/Django_package@1.11.1.dev1",
+    "canonical_purl": "pkg:pypi/django-package@1.11.1.dev1",
+    "type": "pypi",
+    "namespace": null,
+    "name": "django-package",
+    "version": "1.11.1.dev1",
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "rpm often use qualifiers",
+    "purl": "pkg:Rpm/fedora/curl@7.50.3-1.fc25?Arch=i386&Distro=fedora-25",
+    "canonical_purl": "pkg:rpm/fedora/curl@7.50.3-1.fc25?arch=i386&distro=fedora-25",
+    "type": "rpm",
+    "namespace": "fedora",
+    "name": "curl",
+    "version": "7.50.3-1.fc25",
+    "qualifiers": {"arch": "i386","distro": "fedora-25"},
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "a scheme is always required",
+    "purl": "EnterpriseLibrary.Common@6.0.1304",
+    "canonical_purl": "EnterpriseLibrary.Common@6.0.1304",
+    "type": null,
+    "namespace": null,
+    "name": "EnterpriseLibrary.Common",
+    "version": null,
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": true
+  },
+  {
+    "description": "a type is always required",
+    "purl": "pkg:EnterpriseLibrary.Common@6.0.1304",
+    "canonical_purl": "pkg:EnterpriseLibrary.Common@6.0.1304",
+    "type": null,
+    "namespace": null,
+    "name": "EnterpriseLibrary.Common",
+    "version": null,
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": true
+  },
+  {
+    "description": "a name is required",
+    "purl": "pkg:maven/@1.3.4",
+    "canonical_purl": "pkg:maven/@1.3.4",
+    "type": "maven",
+    "namespace": null,
+    "name": null,
+    "version": null,
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": true
+  },
+  {
+    "description": "slash / after scheme is not significant",
+    "purl": "pkg:/maven/org.apache.commons/io",
+    "canonical_purl": "pkg:maven/org.apache.commons/io",
+    "type": "maven",
+    "namespace": "org.apache.commons",
+    "name": "io",
+    "version": null,
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "double slash // after scheme is not significant",
+    "purl": "pkg://maven/org.apache.commons/io",
+    "canonical_purl": "pkg:maven/org.apache.commons/io",
+    "type": "maven",
+    "namespace": "org.apache.commons",
+    "name": "io",
+    "version": null,
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "slash /// after type  is not significant",
+    "purl": "pkg:///maven/org.apache.commons/io",
+    "canonical_purl": "pkg:maven/org.apache.commons/io",
+    "type": "maven",
+    "namespace": "org.apache.commons",
+    "name": "io",
+    "version": null,
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "valid maven purl with case sensitive namespace and name",
+    "purl": "pkg:maven/HTTPClient/HTTPClient@0.3-3",
+    "canonical_purl": "pkg:maven/HTTPClient/HTTPClient@0.3-3",
+    "type": "maven",
+    "namespace": "HTTPClient",
+    "name": "HTTPClient",
+    "version": "0.3-3",
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "valid maven purl containing a space in the version and qualifier",
+    "purl": "pkg:maven/mygroup/myartifact@1.0.0%20Final?mykey=my%20value",
+    "canonical_purl": "pkg:maven/mygroup/myartifact@1.0.0%20Final?mykey=my%20value",
+    "type": "maven",
+    "namespace": "mygroup",
+    "name": "myartifact",
+    "version": "1.0.0 Final",
+    "qualifiers": {"mykey": "my value"},
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "checks for invalid qualifier keys",
+    "purl": "pkg:npm/myartifact@1.0.0?in%20production=true",
+    "canonical_purl": null,
+    "type": "npm",
+    "namespace": null,
+    "name": "myartifact",
+    "version": "1.0.0",
+    "qualifiers": {"in production": "true"},
+    "subpath": null,
+    "is_invalid": true
+  },
+  {
+    "description": "namespace can contain special characters",
+    "purl": "pkg:npm/%40foo%40%3F%23/bar@1.0.0",
+    "canonical_purl": "pkg:npm/%40foo%40%3F%23/bar@1.0.0",
+    "type": "npm",
+    "namespace": "@foo@?#",
+    "name": "bar",
+    "version": "1.0.0",
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "name can contain special characters (with namespace)",
+    "purl": "pkg:npm/%40foo/bar%40%3F%23@1.0.0",
+    "canonical_purl": "pkg:npm/%40foo/bar%40%3F%23@1.0.0",
+    "type": "npm",
+    "namespace": "@foo",
+    "name": "bar@?#",
+    "version": "1.0.0",
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "name can contain special characters (without namespace)",
+    "purl": "pkg:npm/bar%40%3F%23@1.0.0",
+    "canonical_purl": "pkg:npm/bar%40%3F%23@1.0.0",
+    "type": "npm",
+    "namespace": null,
+    "name": "bar@?#",
+    "version": "1.0.0",
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": false
+  },
+  {
+    "description": "version can contain special characters",
+    "purl": "pkg:npm/%40foo/bar@1.0.0-%40%3F%23",
+    "canonical_purl": "pkg:npm/%40foo/bar@1.0.0-%40%3F%23",
+    "type": "npm",
+    "namespace": "@foo",
+    "name": "bar",
+    "version": "1.0.0-@?#",
+    "qualifiers": null,
+    "subpath": null,
+    "is_invalid": false
+  }
+]