test(resolve): add tests for ApiDOM YAML 1.2 parser

Refs #2717

src/helpers/apidom/reference/parse/parsers/yaml-1-2/index.js

@@ -29,16 +29,22 @@ const YamlParser = Parser.compose({
 
     async parse(file) {
       if (this.sourceMap) {
-        // eslint-disable-next-line no-console
-        console.warn("yaml-1-2-swagger-client parser plugin doesn't support sourceMaps option");
+        throw new ParserError(
+          "yaml-1-2-swagger-client parser plugin doesn't support sourceMaps option"
+        );
       }
 
+      const parseResultElement = new ParseResultElement();
       const source = file.toString();
 
       try {
-        const element = from(YAML.load(source, { schema: JSON_SCHEMA }));
-        const parseResultElement = new ParseResultElement();
+        const parsedYAML = YAML.load(source, { schema: JSON_SCHEMA });
 
+        if (this.allowEmpty && typeof parsedYAML === 'undefined') {
+          return parseResultElement;
+        }
+
+        const element = from(parsedYAML);
         element.classes.push('result');
         parseResultElement.push(element);
         return parseResultElement;

test/helpers/apidom/reference/parse/parsers/yaml-1-2/index.js

@@ -0,0 +1,147 @@
+import { Buffer } from 'node:buffer';
+import { isParseResultElement } from '@swagger-api/apidom-core';
+import { File, ParserError } from '@swagger-api/apidom-reference/configuration/empty';
+
+import YamlParser from '../../../../../../../src/helpers/apidom/reference/parse/parsers/yaml-1-2/index.js';
+
+describe('YamlParser', () => {
+  describe('canParse', () => {
+    describe('given file with .yaml extension', () => {
+      test('should return true', async () => {
+        const file = File({ uri: '/path/to/file.yaml', data: '{"a":"b"}' });
+        const parser = YamlParser();
+
+        expect(await parser.canParse(file)).toBe(true);
+      });
+    });
+
+    describe('given file with .yml extension', () => {
+      test('should return true', async () => {
+        const file = File({ uri: '/path/to/file.yml', data: '{"a":"b"}' });
+        const parser = YamlParser();
+
+        expect(await parser.canParse(file)).toBe(true);
+      });
+    });
+
+    describe('given file with unknown extension', () => {
+      test('should return false', async () => {
+        const file = File({ uri: '/path/to/file.txt' });
+        const parser = YamlParser();
+
+        expect(await parser.canParse(file)).toBe(false);
+      });
+    });
+
+    describe('given file with no extension', () => {
+      test('should return false', async () => {
+        const file = File({ uri: '/path/to/file' });
+        const parser = YamlParser();
+
+        expect(await parser.canParse(file)).toBe(false);
+      });
+    });
+
+    describe('given file with supported extension', () => {
+      describe('and file data is buffer and can be detected as YAML 1.2', () => {
+        test('should return true', async () => {
+          const file = File({
+            uri: '/path/to/yaml-file.yaml',
+            data: Buffer.from('key: value'),
+          });
+          const parser = YamlParser();
+
+          expect(await parser.canParse(file)).toBe(true);
+        });
+      });
+
+      describe('and file data is string and can be detected as YAML 1.2', () => {
+        test('should return true', async () => {
+          const file = File({
+            uri: '/path/to/yaml-file.yaml',
+            data: 'key: value',
+          });
+          const parser = YamlParser();
+
+          expect(await parser.canParse(file)).toBe(true);
+        });
+      });
+    });
+  });
+
+  describe('parse', () => {
+    describe('given generic YAML data', () => {
+      test('should return parse result', async () => {
+        const file = File({ uri: '/path/to/file.json', data: 'prop: val' });
+        const parser = YamlParser();
+        const result = await parser.parse(file);
+        const objElement = result.get(0);
+
+        expect(isParseResultElement(result)).toBe(true);
+        expect(objElement.get('prop').equals('val')).toBe(true);
+      });
+    });
+
+    describe('given generic YAML data as buffer', () => {
+      test('should return parse result', async () => {
+        const file = File({ uri: '/path/to/file.yaml', data: Buffer.from('prop: val') });
+        const parser = YamlParser();
+        const result = await parser.parse(file);
+        const objElement = result.get(0);
+
+        expect(isParseResultElement(result)).toBe(true);
+        expect(objElement.get('prop').equals('val')).toBe(true);
+      });
+    });
+
+    describe('given data that is not a generic YAML data', () => {
+      test('should coerce to string and parse', async () => {
+        const file = File({ uri: '/path/to/file.yaml', data: 1 });
+        const parser = YamlParser();
+        const result = await parser.parse(file);
+        const numberElement = result.get(0);
+
+        expect(isParseResultElement(result)).toBe(true);
+        expect(numberElement.equals(1)).toBe(true);
+      });
+    });
+
+    describe('given empty file', () => {
+      test('should return empty parse result', async () => {
+        const file = File({ uri: '/path/to/file.yaml', data: '' });
+        const parser = YamlParser();
+        const result = await parser.parse(file);
+
+        expect(isParseResultElement(result)).toBe(true);
+        expect(result.isEmpty).toBe(true);
+      });
+    });
+
+    describe('sourceMap', () => {
+      describe('given sourceMap enabled', () => {
+        test('should throw error', () => {
+          const file = File({ uri: '/path/to/file.yaml', data: 'prop: val' });
+          const parser = YamlParser({ sourceMap: true });
+          const parseWithSourceMap = () => parser.parse(file);
+
+          expect(parseWithSourceMap).rejects.toThrow(
+            new ParserError(
+              "yaml-1-2-swagger-client parser plugin doesn't support sourceMaps option"
+            )
+          );
+        });
+      });
+
+      describe('given sourceMap disabled', () => {
+        test('should not decorate ApiDOM with source maps', async () => {
+          const file = File({ uri: '/path/to/file.yaml', data: 'prop: val' });
+          const parser = YamlParser({ sourceMap: false });
+          const result = await parser.parse(file);
+          const objElement = result.get(0);
+
+          expect(objElement.meta.get('sourceMap')).toBeUndefined();
+        });
+      });
+    });
+  });
+});