yaml-language-server/out/server/test/yamlParser.test.js

YAML language server

"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Red Hat. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/
const assert_1 = __importDefault(require("assert"));
const chai_1 = require("chai");
const yamlParser07_1 = require("./../src/languageservice/parser/yamlParser07");
const ast_converter_1 = require("../src/languageservice/parser/ast-converter");
describe('YAML parser', () => {
    describe('YAML parser', function () {
        it('parse emtpy text', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('');
            (0, assert_1.default)(parsedDocument.documents.length === 1, 'A document has been created for an empty text');
        });
        it('parse only comment', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('# a comment');
            (0, assert_1.default)(parsedDocument.documents.length === 1, 'A document has been created when there is a comment');
        });
        it('parse single document with --- at the start of the file', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('---\n# a comment\ntest: test');
            (0, assert_1.default)(parsedDocument.documents.length === 1, `A single document should be available but there are ${parsedDocument.documents.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments.length === 1);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments[0] === '# a comment');
        });
        it('parse multi document with --- at the start of the file', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('---\n# a comment\ntest: test\n...\n---\n# second document\ntest2: test2');
            (0, assert_1.default)(parsedDocument.documents.length === 2, `two documents should be available but there are ${parsedDocument.documents.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments.length === 1);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments[0] === '# a comment');
            (0, assert_1.default)(parsedDocument.documents[1].lineComments.length === 1);
            (0, assert_1.default)(parsedDocument.documents[1].lineComments[0] === '# second document');
        });
        it('parse single document with directives and line comments', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('%TAG !yaml! tag:yaml.org,2002:\n---\n# a comment\ntest');
            (0, assert_1.default)(parsedDocument.documents.length === 1, `A single document should be available but there are ${parsedDocument.documents.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].root.children.length === 0, `There should no children available but there are ${parsedDocument.documents[0].root.children.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments.length === 1);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments[0] === '# a comment');
        });
        it('parse 2 documents with directives and line comments', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('%TAG !yaml! tag:yaml.org,2002:\n# a comment\ntest\n...\n---\ntest2');
            (0, assert_1.default)(parsedDocument.documents.length === 2, `2 documents should be available but there are ${parsedDocument.documents.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].root.children.length === 0, `There should no children available but there are ${parsedDocument.documents[0].root.children.length}`);
            (0, assert_1.default)(parsedDocument.documents[1].root.children.length === 0, `There should no children available but there are ${parsedDocument.documents[1].root.children.length}`);
            (0, assert_1.default)(parsedDocument.documents[1].root.value === 'test2');
            (0, assert_1.default)(parsedDocument.documents[0].lineComments.length === 1);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments[0] === '# a comment');
        });
        it('parse single document', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('test');
            (0, assert_1.default)(parsedDocument.documents.length === 1, `A single document should be available but there are ${parsedDocument.documents.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].root.children.length === 0, `There should no children available but there are ${parsedDocument.documents[0].root.children.length}`);
        });
        it('parse single document with directives', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('%TAG !yaml! tag:yaml.org,2002:\n---\ntest');
            (0, assert_1.default)(parsedDocument.documents.length === 1, `A single document should be available but there are ${parsedDocument.documents.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].root.children.length === 0, `There should no children available but there are ${parsedDocument.documents[0].root.children.length}`);
        });
        it('parse 2 documents', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('test\n---\ntest2');
            (0, assert_1.default)(parsedDocument.documents.length === 2, `2 documents should be available but there are ${parsedDocument.documents.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].root.children.length === 0, `There should no children available but there are ${parsedDocument.documents[0].root.children.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].root.value === 'test');
            (0, assert_1.default)(parsedDocument.documents[1].root.children.length === 0, `There should no children available but there are ${parsedDocument.documents[1].root.children.length}`);
            (0, assert_1.default)(parsedDocument.documents[1].root.value === 'test2');
        });
        it('parse 3 documents', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('test\n---\ntest2\n---\ntest3');
            (0, assert_1.default)(parsedDocument.documents.length === 3, `3 documents should be available but there are ${parsedDocument.documents.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].root.children.length === 0, `There should no children available but there are ${parsedDocument.documents[0].root.children.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].root.value === 'test');
            (0, assert_1.default)(parsedDocument.documents[1].root.children.length === 0, `There should no children available but there are ${parsedDocument.documents[1].root.children.length}`);
            (0, assert_1.default)(parsedDocument.documents[1].root.value === 'test2');
            (0, assert_1.default)(parsedDocument.documents[2].root.children.length === 0, `There should no children available but there are ${parsedDocument.documents[2].root.children.length}`);
            (0, assert_1.default)(parsedDocument.documents[2].root.value === 'test3');
        });
        it('parse single document with comment', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('# a comment\ntest');
            (0, assert_1.default)(parsedDocument.documents.length === 1, `A single document should be available but there are ${parsedDocument.documents.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].root.children.length === 0, `There should no children available but there are ${parsedDocument.documents[0].root.children.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments.length === 1);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments[0] === '# a comment');
        });
        it('parse 2 documents with comment', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('---\n# a comment\ntest: test\n---\n# a second comment\ntest2');
            (0, assert_1.default)(parsedDocument.documents.length === 2, `2 documents should be available but there are ${parsedDocument.documents.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].root.children.length === 1, `There should one children available but there are ${parsedDocument.documents[0].root.children.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments.length === 1);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments[0] === '# a comment');
            (0, assert_1.default)(parsedDocument.documents[1].root.children.length === 0, `There should no children available but there are ${parsedDocument.documents[0].root.children.length}`);
            (0, assert_1.default)(parsedDocument.documents[1].lineComments.length === 1);
            (0, assert_1.default)(parsedDocument.documents[1].lineComments[0] === '# a second comment');
        });
        it('parse 2 documents with comment and a directive', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('%TAG !yaml! tag:yaml.org,2002:\n---\n# a comment\ntest\n---\n# a second comment\ntest2');
            (0, assert_1.default)(parsedDocument.documents.length === 2, `2 documents should be available but there are ${parsedDocument.documents.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].root.children.length === 0, `There should no children available but there are ${parsedDocument.documents[0].root.children.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments.length === 1);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments[0] === '# a comment');
            (0, assert_1.default)(parsedDocument.documents[1].root.children.length === 0, `There should no children available but there are ${parsedDocument.documents[0].root.children.length}`);
            (0, assert_1.default)(parsedDocument.documents[1].lineComments.length === 1);
            (0, assert_1.default)(parsedDocument.documents[1].lineComments[0] === '# a second comment');
        });
        it('parse document with comment first', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('# a comment\n---\ntest:test');
            (0, assert_1.default)(parsedDocument.documents.length === 1, `1 document should be available but there are ${parsedDocument.documents.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments.length === 1);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments[0] === '# a comment');
        });
        it('parse document with comment first and directive', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('# a comment\n%TAG !yaml! tag:yaml.org,2002:\ntest: test');
            (0, assert_1.default)(parsedDocument.documents.length === 1, `1 document should be available but there are ${parsedDocument.documents.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments.length === 1);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments[0] === '# a comment');
        });
        it('parse document with comment first, directive, and seperator', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('# a comment\n%TAG !yaml! tag:yaml.org,2002:\n---test: test');
            (0, assert_1.default)(parsedDocument.documents.length === 1, `1 document should be available but there are ${parsedDocument.documents.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments.length === 1);
            (0, assert_1.default)(parsedDocument.documents[0].lineComments[0] === '# a comment');
        });
        it('parse document with "str" tag from recommended schema', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('"yes as a string with tag": !!str yes');
            (0, assert_1.default)(parsedDocument.documents.length === 1, `1 document should be available but there are ${parsedDocument.documents.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].errors.length === 0);
        });
        it('parse document with "int" tag from recommended schema', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('POSTGRES_PORT: !!int 54');
            (0, assert_1.default)(parsedDocument.documents.length === 1, `1 document should be available but there are ${parsedDocument.documents.length}`);
            (0, assert_1.default)(parsedDocument.documents[0].errors.length === 0, JSON.stringify(parsedDocument.documents[0].errors));
        });
        it('parse aliases up to a depth', () => {
            // If maxRefCount is set to 1, it will only resolve one layer of aliases, which means
            // `b` below will inherit `a`, but `c` will not inherit `a`.
            let parsedDocument;
            try {
                ast_converter_1.aliasDepth.maxRefCount = 1;
                parsedDocument = (0, yamlParser07_1.parse)(`
a: &a
  foo: "web"
b: &b
  <<: *a
c: &c
  <<: *b
`);
            }
            finally {
                ast_converter_1.aliasDepth.maxRefCount = 1000;
            }
            const anode = parsedDocument.documents[0].root.children[0].valueNode;
            const aval = anode.properties[0].valueNode;
            const bnode = parsedDocument.documents[0].root.children[1].valueNode;
            const bvalprops = bnode.properties[0].valueNode.properties[0];
            const bval = bvalprops.valueNode;
            const cnode = parsedDocument.documents[0].root.children[2].valueNode;
            const cvalprops = cnode.properties[0].valueNode.properties[0];
            const cval = cvalprops.valueNode;
            (0, assert_1.default)(aval?.value === 'web');
            (0, assert_1.default)(bval?.value === 'web');
            (0, assert_1.default)(cval?.value === undefined);
        });
        it('parse aliases up to a depth for multiple objects', () => {
            // In the below configuration, `c` will not inherit `a` because of depth issues
            // but the following object `o` will still resolve correctly.
            let parsedDocument;
            try {
                ast_converter_1.aliasDepth.maxRefCount = 1;
                parsedDocument = (0, yamlParser07_1.parse)(`
a: &a
  foo: "web"
b: &b
  <<: *a
c: &c
  <<: *b

o: &o
  <<: *a
`);
            }
            finally {
                ast_converter_1.aliasDepth.maxRefCount = 1000;
            }
            const onode = parsedDocument.documents[0].root.children[3].valueNode;
            const ovalprops = onode.properties[0].valueNode.properties[0];
            const oval = ovalprops.valueNode;
            const cnode = parsedDocument.documents[0].root.children[2].valueNode;
            const cvalprops = cnode.properties[0].valueNode.properties[0];
            const cval = cvalprops.valueNode;
            (0, assert_1.default)(cval?.value === undefined);
            (0, assert_1.default)(oval?.value === 'web');
        });
    });
    describe('YAML parser bugs', () => {
        it('should work with "Billion Laughs" attack', () => {
            const yaml = `apiVersion: v1
data:
  a: &a ["web","web","web","web","web","web","web","web","web"]
  b: &b [*a,*a,*a,*a,*a,*a,*a,*a,*a]
  c: &c [*b,*b,*b,*b,*b,*b,*b,*b,*b]
  d: &d [*c,*c,*c,*c,*c,*c,*c,*c,*c]
  e: &e [*d,*d,*d,*d,*d,*d,*d,*d,*d]
  f: &f [*e,*e,*e,*e,*e,*e,*e,*e,*e]
  g: &g [*f,*f,*f,*f,*f,*f,*f,*f,*f]
  h: &h [*g,*g,*g,*g,*g,*g,*g,*g,*g]
  i: &i [*h,*h,*h,*h,*h,*h,*h,*h,*h]
kind: ConfigMap
metadata:
  name: yaml-bomb
  namespace: defaul`;
            const parsedDocument = (0, yamlParser07_1.parse)(yaml);
            assert_1.default.strictEqual(parsedDocument.documents.length, 1, `1 document should be available but there are ${parsedDocument.documents.length}`);
        });
        it('should work with circular aliases', () => {
            const yaml = '&a [ 1, *a ]\n';
            const parsedDocument = (0, yamlParser07_1.parse)(yaml);
            parsedDocument.documents[0].root;
            (0, chai_1.expect)(parsedDocument.documents).to.have.length(1);
        });
        it('should not add "undefined" as array item', () => {
            const yaml = `foo: 
  - *`;
            const parsedDocument = (0, yamlParser07_1.parse)(yaml);
            parsedDocument.documents[0].root;
            (0, chai_1.expect)(parsedDocument.documents).to.have.length(1);
            (0, chai_1.expect)(parsedDocument.documents[0].root.properties[0].valueNode
                .items[0]).is.not.undefined;
        });
    });
    describe('YAML version', () => {
        it('should use yaml 1.2 by default', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('SOME_BOOLEAN : !!bool yes');
            (0, assert_1.default)(parsedDocument.documents[0].warnings.length === 1);
        });
        it('should respect yaml 1.1', () => {
            const parsedDocument = (0, yamlParser07_1.parse)('SOME_BOOLEAN : !!bool yes', { customTags: [], yamlVersion: '1.1' });
            (0, assert_1.default)(parsedDocument.documents[0].warnings.length === 0);
        });
    });
});
//# sourceMappingURL=yamlParser.test.js.map