Use full schema (schema-base.yaml) for coverage #4701
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,11 @@ | ||
| import { readFileSync } from "node:fs"; | ||
| import { readdir, readFile } from "node:fs/promises"; | ||
| import YAML from "yaml"; | ||
| import { join } from "node:path"; | ||
| import { argv } from "node:process"; | ||
| import { registerSchema, validate } from "@hyperjump/json-schema/draft-2020-12"; | ||
| import "@hyperjump/json-schema/draft-04"; | ||
| import { BASIC, addKeyword, defineVocabulary } from "@hyperjump/json-schema/experimental"; | ||
|
|
||
| /** | ||
| * @import { EvaluationPlugin } from "@hyperjump/json-schema/experimental" | ||
|
|
@@ -45,7 +46,14 @@ class TestCoveragePlugin { | |
| this.allLocations = []; | ||
|
|
||
| for (const schemaLocation in context.ast) { | ||
| if ( | ||
| schemaLocation === "metaData" || | ||
| // Do not require coverage of standard JSON Schema | ||
| schemaLocation.includes("json-schema.org") || | ||
| // Do not require coverage of default $dynamicAnchor | ||
| // schemas, as they are not expected to be reached | ||
| schemaLocation.endsWith("/schema/WORK-IN-PROGRESS#/$defs/schema") | ||
| ) { | ||
| continue; | ||
| } | ||
|
|
||
|
|
@@ -110,6 +118,68 @@ const runTests = async (schemaUri, testDirectory) => { | |
| }; | ||
| }; | ||
|
|
||
| addKeyword({ | ||
| id: "https://spec.openapis.org/oas/schema/vocab/keyword/discriminator", | ||
| interpret: (discriminator, instance, context) => { | ||
| return true; | ||
| }, | ||
| /* discriminator is not exactly an annotation, but it's not allowed | ||
| * to change the validation outcome (hence returing true from interopret()) | ||
| * and for our purposes of testing, this is sufficient. | ||
| */ | ||
| annotation: (discriminator) => { | ||
| return discriminator; | ||
| }, | ||
| }); | ||
|
|
||
| addKeyword({ | ||
| id: "https://spec.openapis.org/oas/schema/vocab/keyword/example", | ||
| interpret: (example, instance, context) => { | ||
| return true; | ||
| }, | ||
| annotation: (example) => { | ||
| return example; | ||
| }, | ||
| }); | ||
|
|
||
| addKeyword({ | ||
| id: "https://spec.openapis.org/oas/schema/vocab/keyword/externalDocs", | ||
| interpret: (externalDocs, instance, context) => { | ||
| return true; | ||
| }, | ||
| annotation: (externalDocs) => { | ||
| return externalDocs; | ||
| }, | ||
| }); | ||
|
|
||
| addKeyword({ | ||
| id: "https://spec.openapis.org/oas/schema/vocab/keyword/xml", | ||
| interpret: (xml, instance, context) => { | ||
| return true; | ||
| }, | ||
| annotation: (xml) => { | ||
| return xml; | ||
| }, | ||
| }); | ||
|
|
||
| defineVocabulary( | ||
| "https://spec.openapis.org/oas/3.1/vocab/base", | ||
|
There was a problem hiding this comment. This apparently needs to be parameterized with the OpenAPI version of the branch it is running on, because the script fails if run as-is on the No spontanous idea on how to reliably do that, other than parsing There was a problem hiding this comment. @ralfhandl I was just going to modify the line on the 3.2 port There was a problem hiding this comment. Which would end up in main (and then dev and v3.1-dev) after the release unless someone fiddles with the v3.2.0-rel branch. Automatically detecting the release seems preferable. There was a problem hiding this comment. @ralfhandl Which is fine but let's fix it separately. I do not have the mental bandwidth today for that, and want to get the XML PR merged so I can unblock further work that depends on it. There was a problem hiding this comment.
I didn't realize you were versioning the vocabulary now. So, ignore what I said about not needing |
||
| { | ||
| "discriminator": "https://spec.openapis.org/oas/schema/vocab/keyword/discriminator", | ||
| "example": "https://spec.openapis.org/oas/schema/vocab/keyword/example", | ||
| "externalDocs": "https://spec.openapis.org/oas/schema/vocab/keyword/externalDocs", | ||
| "xml": "https://spec.openapis.org/oas/schema/vocab/keyword/xml", | ||
| }, | ||
| ); | ||
|
|
||
| const parseYamlFromFile = (filePath) => { | ||
| const schemaYaml = readFileSync(filePath, "utf8"); | ||
| return YAML.parse(schemaYaml, { prettyErrors: true }); | ||
| }; | ||
| registerSchema(parseYamlFromFile("./src/schemas/validation/meta.yaml")); | ||
| registerSchema(parseYamlFromFile("./src/schemas/validation/dialect.yaml")); | ||
| registerSchema(parseYamlFromFile("./src/schemas/validation/schema.yaml")); | ||
|
|
||
| /////////////////////////////////////////////////////////////////////////////// | ||
|
|
||
| const { allLocations, visitedLocations } = await runTests(argv[2], argv[3]); | ||
ralfhandl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
@@ -122,16 +192,13 @@ if (notCovered.length > 0) { | |
| const firstNotCovered = notCovered.slice(0, maxNotCovered); | ||
| if (notCovered.length > maxNotCovered) firstNotCovered.push("..."); | ||
| console.log(firstNotCovered); | ||
| process.exitCode = 1; | ||
| } | ||
|
|
||
| console.log( | ||
| "Covered:", | ||
| (allocations.length - notCovered.length), | ||
| "of", | ||
| allLocations.length, | ||
| "(" + Math.floor(((allocations.length - notCovered.length) / allLocations.length) * 100) + "%)", | ||
| ); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These seem to be unnecessary, commenting them out does not change the test result.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ralfhandl they make the vocabulary be handled correctly if we want to further utilize those keywords in tests. I prefer to set up the vocabulary correctly rather than stub it out just because we're not using it right now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would checks of the keyword's correct use go into the
interpretstubs?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ralfhandl they're not stubs. Annotations are always valid, returning
trueis correct.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At least I think. That was as far as I got in the library's documentation. It's at least closer to correct than it was, and we can work on it more later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It works because the vocabulary is set as optional. If there is no keyword implementation, it's treated like an unknown keyword, which is allowed, but not quite the same thing.
These keyword implementations are already provided, so you shouldn't need to define them here. Instead of importing
@hyperjump/json-schema/draft-2020-12, use@hyperjump/json-schema/openapi-3-1. Then the keywords and vocabulary definitions will be loaded and you can skip this. However, you still need to register the local schemas because you're testing the local schemas, not the ones included with the@hyperjump/json-schema.