add opam package url specification

docs/candidate-purl-types.md

@@ -30,7 +30,6 @@
 - ``meteor`` for Meteor JavaScript packages
 - ``nim`` for Nim packages
 - ``nix`` for Nixos packages
-- ``opam`` for OCaml packages
 - ``openwrt`` for OpenWRT packages
 - ``osgi`` for OSGi bundle packages
 - ``p2`` for Eclipse p2 packages

purl-types-index.json

@@ -27,6 +27,7 @@
   "npm",
   "nuget",
   "oci",
+  "opam",
   "otp",
   "pub",
   "pypi",

tests/types/opam-test.json

@@ -0,0 +1,89 @@
+{
+  "$schema": "https://packageurl.org/schemas/purl-test.schema-0.1.json",
+  "tests": [
+    {
+      "description": "valid opam purl. Roundtrip an input purl to canonical.",
+      "test_group": "advanced",
+      "test_type": "roundtrip",
+      "input": "pkg:opam/[email protected]",
+      "expected_output": "pkg:opam/[email protected]",
+      "expected_failure": false,
+      "expected_failure_reason": null
+    },
+    {
+      "description": "valid opam purl",
+      "test_group": "base",
+      "test_type": "parse",
+      "input": "pkg:opam/[email protected]",
+      "expected_output": {
+        "type": "opam",
+        "namespace": null,
+        "name": "conex",
+        "version": "1.0.0",
+        "qualifiers": null,
+        "subpath": null
+      },
+      "expected_failure": false,
+      "expected_failure_reason": null
+    },
+    {
+      "description": "valid opam purl. Roundtrip a canonical input to canonical output.",
+      "test_group": "base",
+      "test_type": "roundtrip",
+      "input": "pkg:opam/[email protected]",
+      "expected_output": "pkg:opam/[email protected]",
+      "expected_failure": false,
+      "expected_failure_reason": null
+    },
+    {
+      "description": "valid opam purl",
+      "test_group": "base",
+      "test_type": "build",
+      "input": {
+        "type": "opam",
+        "namespace": null,
+        "name": "conex",
+        "version": "1.0.0",
+        "qualifiers": null,
+        "subpath": null
+      },
+      "expected_output": "pkg:opam/[email protected]",
+      "expected_failure": false,
+      "expected_failure_reason": null
+    },
+    {
+      "description": "name and version are always required",
+      "test_group": "base",
+      "test_type": "parse",
+      "input": "pkg:opam",
+      "expected_output": null,
+      "expected_failure": true,
+      "expected_failure_reason": "Should fail to parse a PURL from invalid purl input"
+    },
+    {
+      "description": "name and version are always required",
+      "test_group": "base",
+      "test_type": "parse",
+      "input": "pkg:opam",
+      "expected_output": null,
+      "expected_failure": true,
+      "expected_failure_reason": "Should fail to parse a PURL from invalid canonical purl input"
+    },
+    {
+      "description": "name and version are always required",
+      "test_group": "base",
+      "test_type": "build",
+      "input": {
+        "type": "opam",
+        "namespace": null,
+        "name": null,
+        "version": null,
+        "qualifiers": null,
+        "subpath": null
+      },
+      "expected_output": null,
+      "expected_failure": true,
+      "expected_failure_reason": "Should fail to build a PURL from invalid input components"
+    }
+  ]
+}

types/opam-definition.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "https://packageurl.org/schemas/purl-type-definition.schema-1.0.json",
+  "$id": "https://packageurl.org/types/opam-definition.json",
+  "type": "opam",
+  "type_name": "Opam package",
+  "description": "Opam packages",
+  "repository": {
+    "use_repository": true,
+    "default_repository_url": "https://opam.ocaml.org"
+  },
+  "namespace_definition": {
+    "requirement": "prohibited",
+    "note": "there is no namespace"
+  },
+  "name_definition": {
+    "requirement": "required",
+    "case_sensitive": true,
+    "native_name": "name",
+    "note": "The name is case sensitive."
+  },
+  "version_definition": {
+    "requirement": "optional",
+    "native_name": "version",
+    "note": "The version is package version."
+  },
+  "examples": [
+    "pkg:opam/[email protected]",
+    "pkg:opam/git@3/16.1"
+  ]
+}