Added contract validation #8
+973
−24
There are no files selected for viewing
This file contains 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
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,190 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-07/schema#", | ||
| "$id": "contract.json", | ||
|
|
||
| "definitions": { | ||
| "baseContract": { | ||
| "$id": "baseContract", | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "slug": { | ||
| "type": "string", | ||
| "pattern": "^[a-z0-9-]+$" | ||
| }, | ||
| "version": { | ||
| "type": "string", | ||
| "minLength": 1, | ||
| "pattern": "^[~\\^]*\\d+(\\.[~\\^]*\\d+(\\.[~\\^]*\\d+)*)*$" | ||
| }, | ||
| "componentVersion": { | ||
| "type": "string", | ||
| "minLength": 1 | ||
| }, | ||
| "type": { | ||
| "type": "string", | ||
| "pattern": "^[a-z0-9-.]+$" | ||
| }, | ||
| "name": { | ||
| "type": "string", | ||
| "pattern": "^.*\\S.*$" | ||
| }, | ||
| "aliases": { | ||
| "type": "array", | ||
| "additionalItems": false, | ||
| "uniqueItems": true, | ||
| "items": { | ||
| "$ref": "#/properties/slug" | ||
| } | ||
| }, | ||
| "data": { | ||
| "type": "object" | ||
| }, | ||
| "extends": { | ||
| "allOf": [ | ||
| { | ||
| "$ref": "#" | ||
| }, | ||
| { | ||
| "required": [ "slug", "aliases" ] | ||
| } | ||
| ] | ||
| }, | ||
| "requires": { | ||
| "$ref": "contract.json#/definitions/recursiveOR" | ||
| }, | ||
| "tags": { | ||
| "type": "array", | ||
| "uniqueItems": true, | ||
| "additionalItems": false, | ||
| "items": { | ||
| "type": "string", | ||
| "pattern": "^[\\S]+(?: [\\S]+)*$" | ||
| } | ||
| }, | ||
| "capabilities": { | ||
| "type": "array", | ||
| "additionalItems": false, | ||
| "items": { | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "slug": { | ||
| "$ref": "#/properties/slug" | ||
| }, | ||
| "componentVersion": { | ||
| "$ref": "#/properties/componentVersion" | ||
| } | ||
| }, | ||
| "required": [ "slug" ] | ||
| } | ||
| }, | ||
| "conflicts": { | ||
| "$ref": "contract.json#/definitions/recursiveOR" | ||
| }, | ||
| "assets": { | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "patternProperties": { | ||
| "^.*$": { | ||
| "type": "object", | ||
| "properties": { | ||
| "url": { | ||
| "type": "string", | ||
| "pattern": "^[a-z0-9-]+:\/\/(([a-z0-9-.])+\/)*[a-z0-9-.]+$" | ||
| }, | ||
| "name": { | ||
| "type": "string", | ||
| "pattern": "[a-z0-9-.]+$" | ||
| }, | ||
| "checksum": { | ||
| "type": "string", | ||
| "minLength": 1 | ||
| }, | ||
| "checksumType": { | ||
| "type": "string", | ||
| "enum": [ "sha256" ] | ||
| } | ||
| }, | ||
| "required": [ "url" ], | ||
| "dependencies": { | ||
| "checksum": [ "checksumType" ] | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "children": { | ||
| "$id": "childNamespace", | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "patternProperties": { | ||
| "^.*$": { | ||
| "oneOf": [ | ||
| { | ||
| "$ref": "contract.json" | ||
| }, | ||
| { | ||
| "$ref": "childNamespace" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
|
|
||
| "partialContract": { | ||
| "$id": "partialContract", | ||
| "type": "object", | ||
| "allOf": [ | ||
| { | ||
| "$ref": "contract.json#/definitions/baseContract" | ||
| }, | ||
| { | ||
| "dependencies": { | ||
| "version": [ "slug" ] | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
|
|
||
| "recursiveOR": { | ||
| "$id": "recursiveOR", | ||
| "type": "array", | ||
| "additionalItems": false, | ||
| "items": { | ||
| "anyOf": [ | ||
| { | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "or": { | ||
| "$ref": "recursiveOR" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "$ref": "contract.json#/definitions/partialContract" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
|
|
||
| "allOf": [ | ||
| { | ||
| "$ref": "#/definitions/baseContract" | ||
| }, | ||
| { | ||
| "required": [ | ||
| "slug", | ||
| "version", | ||
| "type", | ||
| "componentVersion", | ||
| "aliases", | ||
| "tags", | ||
| "data" | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| /* | ||
| * Copyright 2017 resin.io | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| 'use strict' | ||
|
|
||
| const Ajv = require('ajv') | ||
| const ajv = new Ajv({ | ||
| schemaId: '$id' | ||
| }) | ||
| const baseContractSchema = require('./schema/contract.json') | ||
| ajv.addSchema(baseContractSchema) | ||
|
|
||
| // eslint-disable-next-line jsdoc/require-example | ||
| /** | ||
| * @summary Merge supplied schema with base contract schema | ||
| * @function | ||
| * @private | ||
| * | ||
| * @param {Object} schema - JSON schema | ||
| * @returns {Object} - Merged schema | ||
| * | ||
| */ | ||
| const mergeWithBase = (schema) => { | ||
| return { | ||
| $schema: 'http://json-schema.org/draft-07/schema#', | ||
| $id: schema.$id, | ||
| allOf: [ | ||
| { | ||
| $ref: 'contract.json' | ||
| }, | ||
| schema | ||
| ] | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @module validation | ||
| */ | ||
|
|
||
| /** | ||
| * @summary Checks if a contract is valid. | ||
| * @function | ||
| * @memberof module:validation | ||
| * @public | ||
|
There was a problem hiding this comment. Can you define the arguments and return values? |
||
| * | ||
| * @param {Object} contract - the contract to validate | ||
| * @param {Object} schema - optional schema | ||
| * @returns {Object} result | ||
| * | ||
| * @description | ||
| * This function will validate that the supplied contract is valid according to | ||
| * the json schema specification. Accepts an optional schema that can reference and extend | ||
| * the base schema. If a custom schema is passed, both the generic and custom validation | ||
| * rules will apply | ||
| * | ||
| * @example | ||
| * validation.checkContract({ | ||
| * slug: 'slug', | ||
| * type: 'type', | ||
| * version: '1', | ||
| * componentVersion: 'componentVersion', | ||
| * aliases: [], | ||
| * data: {}, | ||
| * tags: [] | ||
| * } | ||
| */ | ||
| exports.checkContract = (contract, schema) => { | ||
| let success = false | ||
| if (schema) { | ||
| success = ajv.validate(mergeWithBase(schema), contract) | ||
| } else { | ||
| success = ajv.validate('contract.json', contract) | ||
| } | ||
|
|
||
| if (success) { | ||
| return { | ||
| success: true, errors: [] | ||
| } | ||
| } | ||
| return { | ||
| success: false, errors: [ ajv.errorsText() ] | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
We should probably add a regex here, since we control contract versions
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.
Done, I used a regex which includes both fixed version and some of the ranges we support as atm we are using the same version field to validate both cases.