feat: add validation of support element

- Add validation of support element. Previous
  validation was only for package-support.json
  and did not include validation of the support
  element in Package.json

- Fix validation support to work on more than just
  'true' for support

- Add a number of validation tests

Signed-off-by: Michael Dawson <[email protected]>

Author: mhdawson

index.js

@@ -7,11 +7,30 @@ const got = require('got')
 
 let ajv
 let compiledSchema
+let ajvElement
+let compiledSchemaElement
 
 const schema = module.exports.schema = require('./schema.json')
+const supportElementSchema = module.exports.schema = require('./support-element-schema.json')
 
 module.exports.defaultPackageSupport = 'package-support.json'
 
+module.exports.validateSupportElement = (obj) => {
+  if (!ajvElement) {
+    ajvElement = new Ajv()
+    compiledSchemaElement = ajvElement.compile(supportElementSchema)
+  }
+
+  const validates = compiledSchemaElement(obj)
+  if (!validates) {
+    const err = new Error('Validation Failed')
+    err.validationErrors = compiledSchemaElement.errors
+    err.validationSchema = compiledSchemaElement.schema
+    throw err
+  }
+  return true
+}
+
 module.exports.validate = (obj) => {
   if (!ajv) {
     ajv = new Ajv()

lib/cli/commands/validate.js

@@ -24,7 +24,16 @@ module.exports = function (opts) {
       }
 
       let supportData = userPackageJson.support
-      if (supportData === true) {
+      if ((supportData === false) || supportData) {
+        // first validate that the supportData is correct
+        try {
+          support.validateSupportElement({ support: supportData })
+        } catch (e) {
+          argv.log.info('validate: ', e.validationErrors)
+          return
+        }
+
+        // support element was ok so validate the data itself
         supportData = await support.getSupportData(userPackageJson,
           path.join(process.cwd()),
           argv.canonical,
@@ -39,7 +48,7 @@ module.exports = function (opts) {
               return
             }
           } catch (e) {
-            argv.log.error('validate: ', e.validationErrors)
+            argv.log.info('validate: ', e.validationErrors)
           }
         } else {
           argv.log.info('support info not resolved: ' + supportData.url)

support-element-schema.json

@@ -0,0 +1,38 @@
+{
+  "$id": "https://raw.githubusercontent.com/pkgjs/support/master/support-element-schema.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Package Support Package.json element",
+
+  "type": "object",
+  "properties": {
+    "support": {
+      "oneOf": [{
+        "enum": [ true ]
+      }, {
+        "type": "string"
+      }, {
+        "type": "object",
+        "required": ["repository"],
+        "properties": {
+          "repository": { "$ref": "#Repository" },
+          "path": { "type": "string" }
+        },
+        "additionalProperties": false
+      }]
+    }
+  },
+
+  "definitions": {
+    "repository": {
+      "$id": "#Repository",
+      "type": "object",
+      "required": ["type", "url"],
+      "properties": {
+        "type": { "enum": [ "git" ] },
+        "url": { "type": "string" },
+        "directory": { "type": "string" }
+      },
+      "additionalProperties": false
+    }
+  }
+}

test/cli/validate-local-bad-element1/command

@@ -0,0 +1 @@
+validate 

test/cli/validate-local-bad-element1/expected

@@ -0,0 +1,29 @@
+info    › validate:  
+  - 0: {
+  keyword: 'enum',
+  dataPath: '.support',
+  schemaPath: '#/properties/support/oneOf/0/enum',
+  params: { allowedValues: [ true ] },
+  message: 'should be equal to one of the allowed values'
+}
+  - 1: {
+  keyword: 'type',
+  dataPath: '.support',
+  schemaPath: '#/properties/support/oneOf/1/type',
+  params: { type: 'string' },
+  message: 'should be string'
+}
+  - 2: {
+  keyword: 'type',
+  dataPath: '.support',
+  schemaPath: '#/properties/support/oneOf/2/type',
+  params: { type: 'object' },
+  message: 'should be object'
+}
+  - 3: {
+  keyword: 'oneOf',
+  dataPath: '.support',
+  schemaPath: '#/properties/support/oneOf',
+  params: { passingSchemas: null },
+  message: 'should match exactly one schema in oneOf'
+}

test/cli/validate-local-bad-element1/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@pkgjs/support-show-local",
+  "version": "0.0.1",
+  "support": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pkgjs/support.git"
+  }
+}

test/cli/validate-local-bad-element2/command

@@ -0,0 +1 @@
+validate 

test/cli/validate-local-bad-element2/expected

@@ -0,0 +1,29 @@
+info    › validate:  
+  - 0: {
+  keyword: 'enum',
+  dataPath: '.support',
+  schemaPath: '#/properties/support/oneOf/0/enum',
+  params: { allowedValues: [ true ] },
+  message: 'should be equal to one of the allowed values'
+}
+  - 1: {
+  keyword: 'type',
+  dataPath: '.support',
+  schemaPath: '#/properties/support/oneOf/1/type',
+  params: { type: 'string' },
+  message: 'should be string'
+}
+  - 2: {
+  keyword: 'type',
+  dataPath: '.support',
+  schemaPath: '#/properties/support/oneOf/2/type',
+  params: { type: 'object' },
+  message: 'should be object'
+}
+  - 3: {
+  keyword: 'oneOf',
+  dataPath: '.support',
+  schemaPath: '#/properties/support/oneOf',
+  params: { passingSchemas: null },
+  message: 'should match exactly one schema in oneOf'
+}

test/cli/validate-local-bad-element2/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@pkgjs/support-show-local",
+  "version": "0.0.1",
+  "support": 1235,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pkgjs/support.git"
+  }
+}

test/cli/validate-local-bad-element3/command

@@ -0,0 +1 @@
+validate