Add schema validation support for tests #215
Conversation
marchuffnagle
requested review from
sethvincent,
indiejames,
scisco,
kkelly51,
abarciauskas-bgse,
laurenfrederick and
jennyhliu
| "properties": { | ||
| "useQueue": { | ||
| "type": "boolean" | ||
| }, | ||
| "provider": { | ||
| "type": "object", | ||
| "required": [ "protocol" ], |
There was a problem hiding this comment.
should we also require the host?
packages/common/test-utils.js
Outdated
| * @returns {boolean} - whether the object is valid or not | ||
| */ | ||
| async function validateOutput(t, data) { | ||
| return validateJSON(t, './schemas/input.json', data); |
There was a problem hiding this comment.
Should be output.json
packages/common/test-utils.js
Outdated
| * @returns {boolean} - whether the object is valid or not | ||
| */ | ||
| async function validateJSON(t, schemaFilename, data) { | ||
| const schema = await promisedReadFile(schemaFilename, 'utf8').then(JSON.parse); |
There was a problem hiding this comment.
What happens if the schema file does not exist?
There was a problem hiding this comment.
The assumption is that you would only add this check to your test if the schema file exists.
There was a problem hiding this comment.
It might be nice to just comment the expected behavior or spit out an error in that case. I don't love that the schema locations are assumed, but think it's fine for now and we can make updates if we run into a different scenario.
packages/common/test-utils.js
Outdated
| * @returns {boolean} - whether the object is valid or not | ||
| */ | ||
| async function validateOutput(t, data) { | ||
| return validateJSON(t, './schemas/input.json', data); |
There was a problem hiding this comment.
this should be './schemas/output.json'
packages/common/test-utils.js
Outdated
| const schema = await promisedReadFile(schemaFilename, 'utf8').then(JSON.parse); | ||
| const ajv = new Ajv(); | ||
| const valid = (new Ajv()).validate(schema, data); | ||
| if (!valid) t.fail(`input validation failed: ${ajv.errorsText()}`); |
There was a problem hiding this comment.
input validation failed: ${ajv.errorsText()} could be ${schemaFilename} validation failed: ${ajv.errorsText()}
Also refactored granule ingestFile method
|
please open this PR against the master branch |
No description provided.