Merge pull request #91 from GrantBirki/copilot/fix-70

Fix file duplication issue - YAML validator now skips JSON files when not in yamlAsJson mode

Author: GrantBirki

__tests__/functions/yaml-validator.test.js

@@ -17,6 +17,7 @@ beforeEach(() => {
   jest.clearAllMocks()
   process.env.INPUT_YAML_SCHEMA = '__tests__/fixtures/schemas/schema1.yaml'
   process.env.INPUT_BASE_DIR = '__tests__/fixtures/yaml/valid'
+  process.env.INPUT_JSON_EXTENSION = '.json'
   process.env.INPUT_YAML_EXTENSION = '.yaml'
   process.env.INPUT_YAML_EXTENSION_SHORT = '.yml'
   process.env.INPUT_YAML_EXCLUDE_REGEX = '.*bad.*\\.yaml'
@@ -437,3 +438,21 @@ test('edge case: yaml with undefined/null values in error paths', async () => {
   // Cleanup
   fs.unlinkSync(tempFile)
 })
+
+test('skips json files when yaml_as_json is false', async () => {
+  process.env.INPUT_YAML_AS_JSON = 'false'
+  process.env.INPUT_FILES =
+    '__tests__/fixtures/json/valid/json1.json\n__tests__/fixtures/yaml/valid/yaml1.yaml'
+
+  expect(await yamlValidator(excludeMock)).toStrictEqual({
+    failed: 0,
+    passed: 1,
+    skipped: 0,
+    success: true,
+    violations: []
+  })
+
+  expect(debugMock).toHaveBeenCalledWith(
+    "the yaml-validator found a json file so it will be skipped here: '__tests__/fixtures/json/valid/json1.json'"
+  )
+})

dist/index.js

@@ -11,6 +11,7 @@ const INVALID_YAML_MESSAGE = 'Invalid YAML'
 // Helper function to validate all yaml files in the baseDir
 export async function yamlValidator(exclude) {
   const baseDir = core.getInput('base_dir')
+  const jsonExtension = core.getInput('json_extension')
   const yamlExtension = core.getInput('yaml_extension')
   const yamlExtensionShort = core.getInput('yaml_extension_short')
   const yamlSchema = core.getInput('yaml_schema')
@@ -76,6 +77,17 @@ export async function yamlValidator(exclude) {
       continue
     }
 
+    // if the file is a json file but it should not be treated as yaml
+    // skipped++ does not need to be called here as the file should be validated later...
+    // ...on as json with the json-validator
+    const isJsonFile = jsonExtension && fullPath.endsWith(jsonExtension)
+    if (yamlAsJson === false && isJsonFile) {
+      core.debug(
+        `the yaml-validator found a json file so it will be skipped here: '${fullPath}'`
+      )
+      continue
+    }
+
     if (yamlAsJson) {
       core.debug(
         `skipping yaml since it should be treated as json: ${fullPath}`