Merge pull request #84 from juheiseflink/contrib_support_multiple_docs_for_yaml_as_json

Changing JSON validator to be able to deal with multiple docs when YAML is treated as JSON

Author: GrantBirki

.github/workflows/acceptance-test.yml

@@ -66,3 +66,14 @@ jobs:
           yaml_schema: ./__tests__/fixtures/schemas/flat.yaml
           files: |
             __tests__/acceptance/flat_yaml/flat.yaml
+
+      - name: acceptance test - multi yaml as json
+        uses: ./
+        id: json-yaml-validate-multi-yaml-as-json-test
+        with:
+          comment: "true"
+          allow_multiple_documents: true
+          yaml_as_json: true
+          json_schema: ./__tests__/fixtures/schemas/schema1.json
+          files: |
+            __tests__/fixtures/yaml_as_json/valid_multi/yaml1.yaml

.gitignore

@@ -31,3 +31,7 @@ secrets.json
 *.key
 *.secret
 *.secrets
+
+# jetbrains
+.idea
+*.iml

__tests__/fixtures/yaml_as_json/invalid_multi/yaml1.yaml

@@ -0,0 +1,6 @@
+---
+foo: "1" # invalid type, value should be int
+bar: "ok"
+---
+foo: 2
+foobar: "not ok" # invalid key, additionalProperties not allowed

__tests__/fixtures/yaml_as_json/valid_multi/yaml1.yaml

@@ -0,0 +1,6 @@
+---
+foo: 1
+bar: "ok"
+---
+foo: 2
+bar: "also ok"

__tests__/functions/json-validator.test.js

@@ -29,6 +29,7 @@ beforeEach(() => {
   process.env.INPUT_JSON_SCHEMA_VERSION = 'draft-07'
   process.env.INPUT_AJV_STRICT_MODE = 'true'
   process.env.INPUT_AJV_CUSTOM_REGEXP_FORMATS = ''
+  process.env.INPUT_ALLOW_MULTIPLE_DOCUMENTS = 'false'
 })
 
 test('successfully validates a json file with a schema', async () => {
@@ -583,7 +584,7 @@ test('test that validator throws error when custom_ajv_regexp_format does not co
   }
 })
 
-test('test that schema compile throws error when attemting to validate a json to a schema with unknown format', async () => {
+test('test that schema compile throws error when attempting to validate a json to a schema with unknown format', async () => {
   expect.assertions(1)
   try {
     process.env.INPUT_JSON_SCHEMA =
@@ -597,3 +598,47 @@ test('test that schema compile throws error when attemting to validate a json to
     )
   }
 })
+
+test('yamlAsJson: successful validation of a multi-document-file', async () => {
+  process.env.INPUT_YAML_AS_JSON = 'true'
+  process.env.INPUT_ALLOW_MULTIPLE_DOCUMENTS = 'true'
+  process.env.INPUT_BASE_DIR = '__tests__/fixtures/yaml_as_json/valid_multi'
+  let result = await jsonValidator(excludeMock)
+  expect(result).toStrictEqual({
+    failed: 0,
+    passed: 1,
+    skipped: 0,
+    success: true,
+    violations: []
+  })
+})
+
+test('yamlAsJson: failed validation of a multi-document-file', async () => {
+  process.env.INPUT_YAML_AS_JSON = 'true'
+  process.env.INPUT_ALLOW_MULTIPLE_DOCUMENTS = 'true'
+  process.env.INPUT_BASE_DIR = '__tests__/fixtures/yaml_as_json/invalid_multi'
+  let result = await jsonValidator(excludeMock)
+  expect(result).toStrictEqual({
+    failed: 1,
+    passed: 0,
+    skipped: 0,
+    success: false,
+    violations: [
+      {
+        file: '__tests__/fixtures/yaml_as_json/invalid_multi/yaml1.yaml',
+        errors: [
+          {
+            document: 0,
+            message: 'must be integer',
+            path: '/foo'
+          },
+          {
+            document: 1,
+            message: 'must NOT have additional properties',
+            path: null
+          }
+        ]
+      }
+    ]
+  })
+})

badges/coverage.svg

@@ -6,7 +6,7 @@ import AjvDraft04 from 'ajv-draft-04'
 import addFormats from 'ajv-formats'
 import {readFileSync} from 'fs'
 import {fdir} from 'fdir'
-import {parse} from 'yaml'
+import {parse, parseAllDocuments} from 'yaml'
 import {globSync} from 'glob'
 
 // Helper function to setup the schema
@@ -95,6 +95,9 @@ export async function jsonValidator(exclude) {
   const yamlExtension = core.getInput('yaml_extension')
   const yamlExtensionShort = core.getInput('yaml_extension_short')
   const useDotMatch = core.getBooleanInput('use_dot_match')
+  const allowMultipleDocuments = core.getBooleanInput(
+    'allow_multiple_documents'
+  )
   let patterns = core.getMultilineInput('files').filter(Boolean)
 
   core.debug(`yaml_as_json: ${yamlAsJson}`)
@@ -206,8 +209,11 @@ export async function jsonValidator(exclude) {
           fullPath.endsWith(yamlExtensionShort))
       ) {
         core.debug(`attempting to process yaml file: '${fullPath}' as json`)
-        data = parse(readFileSync(fullPath, 'utf8'))
-
+        if (allowMultipleDocuments === true) {
+          data = parseAllDocuments(readFileSync(fullPath, 'utf8'))
+        } else {
+          data = parse(readFileSync(fullPath, 'utf8'))
+        }
         // if the file is a json file
       } else {
         data = JSON.parse(readFileSync(fullPath, 'utf8'))
@@ -229,32 +235,60 @@ export async function jsonValidator(exclude) {
       continue
     }
 
-    // if a jsonSchema is provided, validate the json against it
-    const valid = validate(data)
-    if (!valid) {
-      // if the json file is invalid against the schema, log an error and set success to false
+    // ensure data is always an array; in case of single-document-mode it'll
+    // have just one element.
+    // this is required to support multi-doc files when yamlAsJson is true
+    if (yamlAsJson === true && allowMultipleDocuments === true) {
+      let newData = []
+      data.forEach(doc => {
+        newData.push(doc.toJS())
+      })
+      data = newData
+    }
+    if (allowMultipleDocuments !== true) {
+      data = [data]
+    }
+
+    if (Array.isArray(data)) {
+      core.debug(`${data.length} object(s) found in file: ${fullPath}`)
+    }
+
+    let allValid = true
+    let allErrors = []
+
+    // perform the validation for each document
+    data.forEach((doc, index) => {
+      const valid = validate(doc)
+      if (valid) {
+        return
+      }
+
+      // validation failed, record the error
+      allValid = false
+      allErrors.push(
+        ...validate.errors.map(error => {
+          let errorValue = {
+            path: error.instancePath || null,
+            message: error.message
+          }
+          // when we have multiple documents, we need to add the document index
+          if (allowMultipleDocuments && yamlAsJson === true) {
+            errorValue.document = index
+          }
+          return errorValue
+        })
+      )
+    })
+
+    if (!allValid) {
       core.error(
-        `❌ failed to parse JSON file: ${fullPath}\n${JSON.stringify(
-          validate.errors
-        )}`
+        `❌ failed to parse JSON file: ${fullPath}\n${JSON.stringify(allErrors)}`
       )
       result.success = false
       result.failed++
-
-      // add the errors to the result object (path and message)
-      // where path is the path to the property that failed validation
-      var errors = []
-      for (const error of validate.errors) {
-        errors.push({
-          path: error.instancePath || null,
-          message: error.message
-        })
-      }
-
-      // add the file and errors to the result object
       result.violations.push({
         file: `${fullPath}`,
-        errors: errors
+        errors: allErrors
       })
       continue
     }