Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Nuke tv4 validator #3115

Merged
merged 2 commits into from
Aug 8, 2023
Merged

Nuke tv4 validator #3115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b838f88
Validate all schemas under AJV
hyperupcall Jul 31, 2023
c6592e6
Remove tv4 machinery
hyperupcall Aug 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,11 +104,10 @@ Please install the EditorConfig and Prettier extensions for your IDE or code edi

### Validation mode

SchemaStore supports three types of schema validation mode.
SchemaStore supports two types of schema validation modes:

- [Full strict mode](https://ajv.js.org/strict-mode.html) via AJV validator (SchemaStore default mode)
- Not fully strict mode via AJV validator. (The json filename is present in the `ajvNotStrictMode` list in [schema-validation.json](src/schema-validation.json))
- Validation via [tv4](https://github.com/geraintluff/tv4) (The json filename is present in the `tv4test` list in [schema-validation.json](src/schema-validation.json))

### Avoid common PR problems

Expand Down
172 changes: 8 additions & 164 deletions src/Gruntfile.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,20 @@ const Ajv2019 = require('ajv/dist/2019')
const Ajv2020 = require('ajv/dist/2020')
const AjvDraft06SchemaJson = require('ajv/dist/refs/json-schema-draft-06.json')
const AjvStandalone = require('ajv/dist/standalone').default
const tv4 = require('tv4')
const TOML = require('@ltd/j-toml')
const YAML = require('yaml')
const schemasafe = require('@exodus/schemasafe')
const prettier = require('prettier')
const axios = require('axios').default
const findDuplicatedPropertyKeys = require('find-duplicated-property-keys')

const temporaryPreviousTv4OnlySchemas = ['tslint.json', 'cloudify.json']
const temporaryCoverageDir = 'temp'
const schemaDir = 'schemas/json'
const testPositiveDir = 'test'
const testNegativeDir = 'negative_test'
const urlSchemaStore = 'https://json.schemastore.org/'
const catalog = require('./api/json/catalog.json')
const schemaV4JSON = require(path.resolve(schemaDir, 'schema-draft-v4.json'))
const schemaValidation = require('./schema-validation.json')
const schemasToBeTested = fs.readdirSync(schemaDir)
const foldersPositiveTest = fs.readdirSync(testPositiveDir)
Expand Down Expand Up @@ -145,7 +144,6 @@ module.exports = function (grunt) {
/**
* @typedef {Object} localSchemaFileAndTestFileParameter2
* @prop {boolean} fullScanAllFiles
* @prop {boolean} calledByTV4Validator
* @prop {boolean} skipReadFile
* @prop {boolean} ignoreSkiptest
* @prop {string} processOnlyThisOneSchemaFile
Expand All @@ -168,7 +166,6 @@ module.exports = function (grunt) {
},
{
fullScanAllFiles = false,
calledByTV4Validator = false,
skipReadFile = true,
ignoreSkiptest = false,
processOnlyThisOneSchemaFile = undefined,
Expand Down Expand Up @@ -197,13 +194,7 @@ module.exports = function (grunt) {
if (fullScanAllFiles) {
return true // All tests are always performed.
} else {
// Schema must be run for tv4 or AJV validator
// calledByTV4Validator is only set true when it is called by tv4 validator
// If schema is present in "tv4test" list then it can only be run if calledByTV4Validator = true
// If schema is NOT present in "tv4test" list then it can only be run if calledByTV4Validator = false
return schemaValidation.tv4test.includes(jsonFilename)
? calledByTV4Validator
: !calledByTV4Validator
return true
}
}

Expand Down Expand Up @@ -430,111 +421,6 @@ module.exports = function (grunt) {
}
}

function tv4Validator() {
// tv4 validator can only process draft-04 schema
// All unknown keyword used in draft-06 and newer are just ignored.
// This is the correct implementation of the json schema specification.
const schemaVersion = showSchemaVersions()
const textValidate = 'validate | '
const textPassSchema = 'pass schema | '
const textPositivePassTest = 'pass positive test | '
const textPositiveFailedTest = 'failed positive test | '

let schemaToBeValidated
let countSchema = 0

const processSchemaFile = (/** @type {Schema} */ schema) => {
// Start validate the JSON schema
let validated
let versionObj
let schemaVersionStr = 'unknown'
try {
// select the correct AJV object for this schema
schemaToBeValidated = schema.jsonObj
versionObj = schemaVersion.getObj(schemaToBeValidated)

// What schema draft version is it?
schemaVersionStr = versionObj ? versionObj.schemaName : 'unknown'

// validate the schema with draft-04. This is the only draft version it understands.
validated = tv4.validate(schemaToBeValidated, schemaV4JSON)
} catch (err) {
throwWithErrorText([
`${textValidate}${schema.urlOrFilePath} (${schemaVersionStr})`,
err,
])
}
if (!validated) {
throwWithErrorText([
`${textValidate}${schema.urlOrFilePath} (${schemaVersionStr}`,
`(Schema file) keywordLocation: ${tv4.error.schemaPath}`,
`(Test file) instanceLocation: ${tv4.error.dataPath}`,
`(Message) ${tv4.error.message}`,
'Error in validation',
])
}
countSchema++
grunt.log.writeln()
grunt.log.ok(
`${textPassSchema}${schema.urlOrFilePath} (${schemaVersionStr})`,
)
}

const processSchemaFileDone = () => {
grunt.log.writeln()
grunt.log.writeln(`Total schemas validated with tv4: ${countSchema}`)
countSchema = 0
}

const processPositiveTestFile = (/** @type {Schema} */ schema) => {
const testFile = schema.jsonObj
const validated = tv4.validate(testFile, schemaToBeValidated)
if (tv4.missing.length > 0) {
throwWithErrorText([
`${textPositiveFailedTest}${schema.urlOrFilePath}`,
`Missing URL: ${tv4.missing[0]}`,
'Must add URL and schema file in schema-validation.json (tv4ExternalRef list)',
])
}
if (validated) {
grunt.log.ok(`${textPositivePassTest}${schema.urlOrFilePath}`)
} else {
throwWithErrorText([
`${textPositiveFailedTest}${schema.urlOrFilePath}`,
`(Schema file) keywordLocation: ${tv4.error.schemaPath}`,
`(Test file) instanceLocation: ${tv4.error.dataPath}`,
`(Message) ${tv4.error.message}`,
'Error in positive test.',
])
}
}

const loadExternalSchema = () => {
for (const property in schemaValidation.tv4ExternalRef) {
try {
const schema = require(path.resolve(
'.',
schemaDir,
schemaValidation.tv4ExternalRef[property],
))
tv4.addSchema(property, schema)
} catch (err) {
throwWithErrorText([
`Error in processing tv4ExternalRef ${property} : ${schemaValidation.tv4ExternalRef[property]}`,
err,
])
}
}
}

loadExternalSchema()
return {
testSchemaFile: processSchemaFile,
testSchemaFileDone: processSchemaFileDone,
positiveTestFile: processPositiveTestFile,
}
}

/**
* @typedef {Object} FactoryAJVParameter
* @prop {string} schemaName
Expand Down Expand Up @@ -789,23 +675,6 @@ module.exports = function (grunt) {
}
}

grunt.registerTask(
'local_test_tv4_only_for_non_compliance_schema',
'Use tv4 to validate local schemas in ./test/',
function () {
const x = tv4Validator()
// tv4 is an outdated/unreliable validator. Do not add a negative test scan here.
localSchemaFileAndTestFile(
{
schemaForTestScan: x.testSchemaFile,
positiveTestScan: x.positiveTestFile,
schemaForTestScanDone: x.testSchemaFileDone,
},
{ calledByTV4Validator: true, skipReadFile: false },
)
},
)

grunt.registerTask(
'local_test_ajv',
'Use AJV to validate local schemas in ./test/',
Expand Down Expand Up @@ -1060,7 +929,7 @@ module.exports = function (grunt) {
}
}
}
// Get all the json file for AJV and tv4
// Get all the json file for AJV
localSchemaFileAndTestFile(
{ schemaOnlyScan: schemaFileCompare },
{ fullScanAllFiles: true },
Expand Down Expand Up @@ -1502,7 +1371,6 @@ module.exports = function (grunt) {
}
}
}
checkForDuplicateInList(schemaValidation.tv4test, 'tv4test[]')
checkForDuplicateInList(
schemaValidation.ajvNotStrictMode,
'ajvNotStrictMode[]',
Expand Down Expand Up @@ -1648,25 +1516,6 @@ module.exports = function (grunt) {
},
)

grunt.registerTask(
'local_assert_tv4_validator_has_no_negative_tests',
'Check for forbidden negative test folder',
function () {
const found = foldersNegativeTest.find((x) =>
schemaValidation.tv4test.includes(x + '.json'),
)
if (found) {
throwWithErrorText([
`Negative folder found for TV4 validator => ${path.join(
testNegativeDir,
found,
)}`,
])
}
grunt.log.ok('OK')
},
)

grunt.registerTask(
'local_assert_schema-validation.json_no_missing_schema_files',
'Check if all schema JSON files are present',
Expand All @@ -1684,7 +1533,6 @@ module.exports = function (grunt) {
}
})
}
x(schemaValidation.tv4test)
x(schemaValidation.ajvNotStrictMode)
x(schemaValidation.skiptest)
x(schemaValidation.missingcatalogurl)
Expand Down Expand Up @@ -1724,7 +1572,6 @@ module.exports = function (grunt) {
}
})
}
x(schemaValidation.tv4test, 'tv4test')
x(schemaValidation.ajvNotStrictMode, 'ajvNotStrictMode')
x(schemaValidation.missingcatalogurl, 'missingcatalogurl')
x(schemaValidation.highSchemaVersion, 'highSchemaVersion')
Expand All @@ -1744,7 +1591,12 @@ module.exports = function (grunt) {
// Test folder must not exist if defined in skiptest[]
schemaValidation.skiptest.forEach((schemaName) => {
countSchemaValidationItems++
if (temporaryPreviousTv4OnlySchemas.includes(schemaName)) {
return
}

const folderName = schemaName.replace('.json', '')

if (foldersPositiveTest.includes(folderName)) {
throwWithErrorText([
`Disabled/skiptest[] schema: ${schemaName} cannot have positive test folder`,
Expand Down Expand Up @@ -1892,12 +1744,6 @@ module.exports = function (grunt) {
'Must start "make" file with schema name parameter.',
])
}
// Not for tv4 schema files
if (schemaValidation.tv4test.includes(schemaNameToBeCoverage)) {
throwWithErrorText([
`Coverage is not possible for tv4-validator schema file :${schemaNameToBeCoverage}`,
])
}
generateCoverage(schemaNameToBeCoverage)
grunt.log.ok('OK')
},
Expand Down Expand Up @@ -1988,7 +1834,6 @@ module.exports = function (grunt) {
'local_assert_directory_structure_is_valid',
'local_assert_filenames_have_correct_extensions',
'local_assert_test_folders_have_at_least_one_test_schema',
'local_assert_tv4_validator_has_no_negative_tests',
])
grunt.registerTask('local_test_schema_validation_json', [
'local_assert_schema-validation.json_no_duplicate_list',
Expand Down Expand Up @@ -2020,7 +1865,6 @@ module.exports = function (grunt) {
'local_print_schemas_tested_in_full_strict_mode',
'local_print_schemas_without_positive_test_files',
'local_test_ajv',
'local_test_tv4_only_for_non_compliance_schema',
'local_print_url_counts_in_catalog',
'local_print_count_schema_versions',
])
Expand Down
10 changes: 0 additions & 10 deletions src/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion src/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@
"grunt": "^1.6.0",
"prettier": "^2.8.3",
"prettier-plugin-sort-json": "^1.0.0",
"tv4": "^1.3.0",
"yaml": "^2.2.1"
}
}
Loading