Merge pull request #656 from package-url/609-update-standard-md-files

Add, update .md files in /standard #609

Author: mjherzog

docs/standard/annex-a.md

@@ -285,321 +285,3 @@ https://github.com/package-url/purl-spec/blob/main/schemas/purl-types-index.sche
 10 |   }
 11 | }
 ```
-
-## A.3 PURL Tests
-
-The schema shown below is available in electronic form at:
-https://github.com/package-url/purl-spec/blob/main/schemas/purl-test.schema.json
-
-```
-  1 | {
-  2 |   "$schema": "http://json-schema.org/draft-07/schema#",
-  3 |   "$id": "https://packageurl.org/schemas/purl-test.schema-1.0.json",
-  4 |   "title": "PURL test definition",
-  5 |   "description": "Schema for Package-URL building and parsing tests with input and expected output.",
-  6 |   "type": "object",
-  7 |   "additionalProperties": false,
-  8 |   "definitions": {
-  9 |     "purl_components": {
- 10 |       "title": "PURL decoded components",
- 11 |       "description": "Individual decoded PURL components to use as a test input or expected output.",
- 12 |       "type": "object",
- 13 |       "additionalProperties": false,
- 14 |       "properties": {
- 15 |         "type": {
- 16 |           "title": "PURL type",
- 17 |           "description": "Package-URL type component.",
- 18 |           "default": null,
- 19 |           "type": [
- 20 |             "string",
- 21 |             "null"
- 22 |           ]
- 23 |         },
- 24 |         "namespace": {
- 25 |           "title": "PURL namespace",
- 26 |           "description": "Package-URL namespace decoded component.",
- 27 |           "default": null,
- 28 |           "type": [
- 29 |             "string",
- 30 |             "null"
- 31 |           ]
- 32 |         },
- 33 |         "name": {
- 34 |           "title": "PURL name",
- 35 |           "description": "Package-URL name decoded component.",
- 36 |           "default": null,
- 37 |           "type": [
- 38 |             "string",
- 39 |             "null"
- 40 |           ]
- 41 |         },
- 42 |         "version": {
- 43 |           "title": "PURL version",
- 44 |           "description": "Package-URL version decoded component.",
- 45 |           "default": null,
- 46 |           "type": [
- 47 |             "string",
- 48 |             "null"
- 49 |           ]
- 50 |         },
- 51 |         "qualifiers": {
- 52 |           "title": "PURL qualifiers",
- 53 |           "description": "Package-URL qualifiers decoded component as an object.",
- 54 |           "default": null,
- 55 |           "type": [
- 56 |             "object",
- 57 |             "null"
- 58 |           ]
- 59 |         },
- 60 |         "subpath": {
- 61 |           "title": "PURL subpath",
- 62 |           "description": "Package-URL subpath decoded component.",
- 63 |           "default": null,
- 64 |           "type": [
- 65 |             "string",
- 66 |             "null"
- 67 |           ]
- 68 |         }
- 69 |       }
- 70 |     },
- 71 |     "purl_test": {
- 72 |       "title": "PURL test",
- 73 |       "description": "A PURL test with input and expected output.",
- 74 |       "type": "object",
- 75 |       "required": [
- 76 |         "description",
- 77 |         "test_group",
- 78 |         "test_type",
- 79 |         "input"
- 80 |       ],
- 81 |       "properties": {
- 82 |         "description": {
- 83 |           "title": "Test description",
- 84 |           "description": "A description for this test.",
- 85 |           "type": "string"
- 86 |         },
- 87 |         "test_group": {
- 88 |           "title": "Test group",
- 89 |           "description": "The group of this test like 'base' or 'advanced'.",
- 90 |           "type": "string",
- 91 |           "enum": [
- 92 |             "base",
- 93 |             "advanced"
- 94 |           ],
- 95 |           "meta:enum": {
- 96 |             "base": "Test group for base conformance tests for PURL building and parsing.",
- 97 |             "advanced": "Test group for advanced tests to support flexible PURL building and parsing."
- 98 |           }
- 99 |         },
-100 |         "test_type": {
-101 |           "title": "Test type",
-102 |           "description": "The type of this test like 'build' or 'parse'.",
-103 |           "type": "string",
-104 |           "enum": [
-105 |             "build",
-106 |             "parse",
-107 |             "roundtrip"
-108 |           ],
-109 |           "meta:enum": {
-110 |             "build": "A PURL building test from decoded components to a canonical PURL string.",
-111 |             "parse": "A PURL building test from decoded components to a canonical PURL string.",
-112 |             "roundtrip": "A PURL roundtrip test, parsing then building back a PURL from a canonical string input."
-113 |           }
-114 |         },
-115 |         "expected_failure": {
-116 |           "title": "Expected failure",
-117 |           "description": "true if this test input is expected to fail to be processed.",
-118 |           "type": "boolean",
-119 |           "default": false
-120 |         },
-121 |         "expected_failure_reason": {
-122 |           "title": "Expected failure reason",
-123 |           "description": "The reason why this test is is expected to fail if expected_failure is true.",
-124 |           "default": null,
-125 |           "type": [
-126 |             "string",
-127 |             "null"
-128 |           ]
-129 |         }
-130 |       },
-131 |       "allOf": [
-132 |         {
-133 |           "if": {
-134 |             "properties": {
-135 |               "test_type": {
-136 |                 "const": "parse"
-137 |               },
-138 |               "expected_failure": {
-139 |                 "const": false
-140 |               }
-141 |             },
-142 |             "required": [
-143 |               "test_type",
-144 |               "expected_failure"
-145 |             ]
-146 |           },
-147 |           "then": {
-148 |             "properties": {
-149 |               "input": {
-150 |                 "title": "Input test PURL",
-151 |                 "description": "A PURL string to use as a test input (canonical or not).",
-152 |                 "type": "string"
-153 |               },
-154 |               "expected_output": {
-155 |                 "title": "Expected output decoded PURL components",
-156 |                 "description": "Test output as an object decoded PURL components, unless expected_failure.",
-157 |                 "$ref": "#/definitions/purl_components"
-158 |               }
-159 |             },
-160 |             "required": [
-161 |               "input",
-162 |               "expected_output"
-163 |             ]
-164 |           }
-165 |         },
-166 |         {
-167 |           "if": {
-168 |             "properties": {
-169 |               "test_type": {
-170 |                 "const": "build"
-171 |               },
-172 |               "expected_failure": {
-173 |                 "const": false
-174 |               }
-175 |             },
-176 |             "required": [
-177 |               "test_type",
-178 |               "expected_failure"
-179 |             ]
-180 |           },
-181 |           "then": {
-182 |             "properties": {
-183 |               "input": {
-184 |                 "title": "Expected output decoded PURL components",
-185 |                 "description": "Test output as an object decoded PURL components, unless expected_failure.",
-186 |                 "$ref": "#/definitions/purl_components"
-187 |               },
-188 |               "expected_output": {
-189 |                 "title": "Expected canonical PURL",
-190 |                 "description": "A canonical PURL string to use as a test ouput.",
-191 |                 "type": "string"
-192 |               }
-193 |             },
-194 |             "required": [
-195 |               "input",
-196 |               "expected_output"
-197 |             ]
-198 |           }
-199 |         },
-200 |         {
-201 |           "if": {
-202 |             "properties": {
-203 |               "test_type": {
-204 |                 "const": "roundtrip"
-205 |               }
-206 |             },
-207 |             "required": [
-208 |               "test_type"
-209 |             ]
-210 |           },
-211 |           "then": {
-212 |             "properties": {
-213 |               "input": {
-214 |                 "title": "Input test PURL",
-215 |                 "description": "A PURL string to use as a test input (canonical or not).",
-216 |                 "type": "string"
-217 |               },
-218 |               "expected_output": {
-219 |                 "title": "Expected canonical PURL",
-220 |                 "description": "A canonical PURL string to use as a test ouput.",
-221 |                 "type": "string"
-222 |               }
-223 |             },
-224 |             "required": [
-225 |               "input",
-226 |               "expected_output"
-227 |             ]
-228 |           }
-229 |         },
-230 |         {
-231 |           "if": {
-232 |             "properties": {
-233 |               "test_type": {
-234 |                 "const": "parse"
-235 |               },
-236 |               "expected_failure": {
-237 |                 "const": true
-238 |               }
-239 |             },
-240 |             "required": [
-241 |               "test_type",
-242 |               "expected_failure"
-243 |             ]
-244 |           },
-245 |           "then": {
-246 |             "properties": {
-247 |               "input": {
-248 |                 "title": "Input test PURL",
-249 |                 "description": "A PURL string to use as a test input (canonical or not).",
-250 |                 "type": "string"
-251 |               }
-252 |             },
-253 |             "required": [
-254 |               "input",
-255 |               "expected_failure_reason"
-256 |             ]
-257 |           }
-258 |         },
-259 |         {
-260 |           "if": {
-261 |             "properties": {
-262 |               "test_type": {
-263 |                 "const": "build"
-264 |               },
-265 |               "expected_failure": {
-266 |                 "const": true
-267 |               }
-268 |             },
-269 |             "required": [
-270 |               "test_type",
-271 |               "expected_failure"
-272 |             ]
-273 |           },
-274 |           "then": {
-275 |             "properties": {
-276 |               "input": {
-277 |                 "title": "Expected output decoded PURL components",
-278 |                 "description": "Test output as an object decoded PURL components, unless expected_failure.",
-279 |                 "$ref": "#/definitions/purl_components"
-280 |               }
-281 |             },
-282 |             "required": [
-283 |               "input",
-284 |               "expected_failure_reason"
-285 |             ]
-286 |           }
-287 |         }
-288 |       ]
-289 |     }
-290 |   },
-291 |   "properties": {
-292 |     "$schema": {
-293 |       "title": "JSON schema",
-294 |       "description": "Contains the URL of the JSON schema for Package-URL tests.",
-295 |       "constant": "https://packageurl.org/schemas/purl-test.schema-1.0.json",
-296 |       "format": "uri"
-297 |     },
-298 |     "tests": {
-299 |       "title": "Test suite",
-300 |       "description": "A list of Package-URL build and parse tests.",
-301 |       "additionalItems": false,
-302 |       "type": "array",
-303 |       "minItems": 1,
-304 |       "uniqueItems": true,
-305 |       "items": {
-306 |         "$ref": "#/definitions/purl_test"
-307 |       }
-308 |     }
-309 |   }
-310 | }
-```