yaml-language-server
Version:
332 lines • 18.2 kB
JavaScript
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
const vscode_languageserver_types_1 = require("vscode-languageserver-types");
const yamlSettings_1 = require("../src/yamlSettings");
const serviceSetup_1 = require("./utils/serviceSetup");
const testHelper_1 = require("./utils/testHelper");
const chai_1 = require("chai");
const sinon = __importStar(require("sinon"));
const verifyError_1 = require("./utils/verifyError");
describe('YAML Validation Tests', () => {
const sandbox = sinon.createSandbox();
let languageSettingsSetup;
let validationHandler;
let yamlSettings;
afterEach(() => {
sandbox.restore();
});
before(() => {
languageSettingsSetup = new serviceSetup_1.ServiceSetup().withValidate();
const { validationHandler: valHandler, yamlSettings: settings } = (0, testHelper_1.setupLanguageService)(languageSettingsSetup.languageSettings);
validationHandler = valHandler;
yamlSettings = settings;
});
function parseSetup(content, customSchemaID) {
const testTextDocument = (0, testHelper_1.setupSchemaIDTextDocument)(content, customSchemaID);
yamlSettings.documents = new yamlSettings_1.TextDocumentTestManager();
yamlSettings.documents.set(testTextDocument);
return validationHandler.validateTextDocument(testTextDocument);
}
it('disables validation when language-overridable yaml.validate is false', async () => {
const testTextDocument = (0, testHelper_1.setupSchemaIDTextDocument)('foo:\n\t- bar');
yamlSettings.documents = new yamlSettings_1.TextDocumentTestManager();
yamlSettings.documents.set(testTextDocument);
const connection = validationHandler.connection;
sandbox.stub(connection.workspace, 'getConfiguration').resolves({ 'yaml.validate': false });
yamlSettings.hasConfigurationCapability = true;
const result = await validationHandler.validateTextDocument(testTextDocument);
(0, chai_1.expect)(result).to.be.empty;
});
describe('TAB Character diagnostics', () => {
it('Should report if TAB character present', async () => {
const yaml = 'foo:\n\t- bar';
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).is.not.empty;
(0, chai_1.expect)(result.length).to.be.equal(1);
(0, chai_1.expect)(result[0]).deep.equal((0, verifyError_1.createExpectedError)('Tabs are not allowed as indentation', 1, 0, 1, 6));
});
it('Should report one error for TAB character present in a row', async () => {
const yaml = 'foo:\n\t\t- bar';
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).is.not.empty;
(0, chai_1.expect)(result.length).to.be.equal(1);
(0, chai_1.expect)(result[0]).deep.equal((0, verifyError_1.createExpectedError)('Tabs are not allowed as indentation', 1, 0, 1, 7));
});
it('Should report one error for TAB`s characters present in the middle of indentation', async () => {
const yaml = 'foo:\n \t\t\t - bar';
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).is.not.empty;
(0, chai_1.expect)(result.length).to.be.equal(1);
(0, chai_1.expect)(result[0]).deep.equal((0, verifyError_1.createExpectedError)('Tabs are not allowed as indentation', 1, 1, 1, 10));
});
it('Should allow proper space indentation followed by tab', async () => {
const yaml = 'foo:\n bar';
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).to.be.empty;
});
});
describe('Unused anchors diagnostics', () => {
it('should report unused anchor', async () => {
const yaml = 'foo: &bar bar\n';
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).is.not.empty;
(0, chai_1.expect)(result.length).to.be.equal(1);
(0, chai_1.expect)(result[0]).deep.equal((0, verifyError_1.createUnusedAnchorDiagnostic)('Unused anchor "&bar"', 0, 5, 0, 9));
});
it('should not report used anchor', async () => {
const yaml = 'foo: &bar bar\nfff: *bar';
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).is.empty;
});
it('should report unused anchors in array ', async () => {
const yaml = `foo: &bar doe
aaa: some
dd: *ba
some:
&a ss: ss
&aa ff:
- s
- &g o
- &e m
- e
ee: *g`;
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).is.not.empty;
(0, chai_1.expect)(result.length).to.be.equal(5);
(0, chai_1.expect)(result).to.include.deep.members([
(0, verifyError_1.createUnusedAnchorDiagnostic)('Unused anchor "&bar"', 0, 5, 0, 9),
(0, verifyError_1.createUnusedAnchorDiagnostic)('Unused anchor "&a"', 4, 2, 4, 4),
(0, verifyError_1.createUnusedAnchorDiagnostic)('Unused anchor "&aa"', 5, 0, 5, 3),
(0, verifyError_1.createUnusedAnchorDiagnostic)('Unused anchor "&e"', 8, 4, 8, 6),
]);
});
});
describe('Unresolved alias diagnostics', () => {
it('should report unresolved alias', async () => {
const yaml = 'foo: *bar';
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).is.not.empty;
(0, chai_1.expect)(result.length).to.be.equal(1);
(0, chai_1.expect)(result[0]).deep.equal((0, verifyError_1.createUnusedAnchorDiagnostic)('Unresolved alias "*bar"', 0, 5, 0, 9));
});
});
describe(`YAML styles test`, () => {
it('should not report flow style', async () => {
const yaml = `host: phl-42
datacenter:
location: canada
cab: 15
animals:
- dog
- cat
- mouse`;
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).to.be.empty;
});
it('should report flow style', async () => {
const yaml = `host: phl-42
datacenter: {location: canada , cab: 15}
animals: [dog , cat , mouse] `;
yamlSettings.style = {
flowMapping: 'forbid',
flowSequence: 'forbid',
};
languageSettingsSetup = new serviceSetup_1.ServiceSetup().withValidate().withFlowMapping('forbid').withFlowSequence('forbid');
const { validationHandler: valHandler, yamlSettings: settings } = (0, testHelper_1.setupLanguageService)(languageSettingsSetup.languageSettings);
validationHandler = valHandler;
yamlSettings = settings;
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).not.to.be.empty;
(0, chai_1.expect)(result.length).to.be.equal(2);
(0, chai_1.expect)(result).to.include.deep.members([
(0, verifyError_1.createExpectedError)('Flow style mapping is forbidden', 1, 12, 1, 40, vscode_languageserver_types_1.DiagnosticSeverity.Error, 'YAML', 'flowMap'),
(0, verifyError_1.createExpectedError)('Flow style sequence is forbidden', 2, 9, 2, 28, vscode_languageserver_types_1.DiagnosticSeverity.Error, 'YAML', 'flowSeq'),
]);
});
it('should report only sequence when flow mapping is allow', async () => {
const yaml = `host: phl-42
datacenter: {location: canada , cab: 15}
animals: [dog , cat , mouse] `;
yamlSettings.style = {
flowMapping: 'forbid',
flowSequence: 'forbid',
};
languageSettingsSetup = new serviceSetup_1.ServiceSetup().withValidate().withFlowMapping('allow').withFlowSequence('forbid');
const { validationHandler: valHandler, yamlSettings: settings } = (0, testHelper_1.setupLanguageService)(languageSettingsSetup.languageSettings);
validationHandler = valHandler;
yamlSettings = settings;
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).not.to.be.empty;
(0, chai_1.expect)(result.length).to.be.equal(1);
(0, chai_1.expect)(result).to.include.deep.members([
(0, verifyError_1.createExpectedError)('Flow style sequence is forbidden', 2, 9, 2, 28, vscode_languageserver_types_1.DiagnosticSeverity.Error, 'YAML', 'flowSeq'),
]);
});
it('should report flow error for empty map & sequence', async () => {
const yaml = 'object: {} \nobject2: []';
yamlSettings.style = {
flowMapping: 'forbid',
flowSequence: 'forbid',
};
languageSettingsSetup = new serviceSetup_1.ServiceSetup().withValidate().withFlowMapping('forbid').withFlowSequence('forbid');
const { validationHandler: valHandler, yamlSettings: settings } = (0, testHelper_1.setupLanguageService)(languageSettingsSetup.languageSettings);
validationHandler = valHandler;
yamlSettings = settings;
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).not.to.be.empty;
(0, chai_1.expect)(result.length).to.be.equal(2);
(0, chai_1.expect)(result).to.include.deep.members([
(0, verifyError_1.createExpectedError)('Flow style mapping is forbidden', 0, 8, 0, 10, vscode_languageserver_types_1.DiagnosticSeverity.Error, 'YAML', 'flowMap'),
(0, verifyError_1.createExpectedError)('Flow style sequence is forbidden', 1, 9, 1, 11, vscode_languageserver_types_1.DiagnosticSeverity.Error, 'YAML', 'flowSeq'),
]);
});
});
describe('Map keys order Tests', () => {
it('should report the first key order error - test 1', async () => {
const yaml = '- key 2: v\n key 1: val\n key 5: valu\n key 3: ff';
yamlSettings.keyOrdering = true;
languageSettingsSetup = new serviceSetup_1.ServiceSetup().withValidate().withKeyOrdering();
const { validationHandler: valHandler, yamlSettings: settings } = (0, testHelper_1.setupLanguageService)(languageSettingsSetup.languageSettings);
validationHandler = valHandler;
yamlSettings = settings;
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).not.to.be.empty;
(0, chai_1.expect)(result.length).to.be.equal(1);
(0, chai_1.expect)(result).to.include.deep.members([
(0, verifyError_1.createExpectedError)('Wrong ordering of key "key 2" in mapping', 0, 2, 0, 7, vscode_languageserver_types_1.DiagnosticSeverity.Error, 'YAML', 'mapKeyOrder'),
]);
});
it('should report the first key order error - test 2', async () => {
const yaml = `one:
child: moo
two:
child: moo
three:
child: moo
alpha: 1`;
yamlSettings.keyOrdering = true;
languageSettingsSetup = new serviceSetup_1.ServiceSetup().withValidate().withKeyOrdering();
const { validationHandler: valHandler, yamlSettings: settings } = (0, testHelper_1.setupLanguageService)(languageSettingsSetup.languageSettings);
validationHandler = valHandler;
yamlSettings = settings;
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).not.to.be.empty;
(0, chai_1.expect)(result.length).to.be.equal(1);
(0, chai_1.expect)(result).to.include.deep.members([
(0, verifyError_1.createExpectedError)('Wrong ordering of key "two" in mapping', 2, 0, 2, 3, vscode_languageserver_types_1.DiagnosticSeverity.Error, 'YAML', 'mapKeyOrder'),
]);
});
it('should report key order error for flow style maps', async () => {
const yaml = '- {b: 1, a: 2}';
yamlSettings.keyOrdering = true;
languageSettingsSetup = new serviceSetup_1.ServiceSetup().withValidate().withKeyOrdering();
const { validationHandler: valHandler, yamlSettings: settings } = (0, testHelper_1.setupLanguageService)(languageSettingsSetup.languageSettings);
validationHandler = valHandler;
yamlSettings = settings;
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).not.to.be.empty;
(0, chai_1.expect)(result.length).to.be.equal(1);
(0, chai_1.expect)(result).to.include.deep.members([
(0, verifyError_1.createExpectedError)('Wrong ordering of key "b" in mapping', 0, 3, 0, 4, vscode_languageserver_types_1.DiagnosticSeverity.Error, 'YAML', 'mapKeyOrder'),
]);
});
it('should report key order error for nested', async () => {
const yaml = 'one:\n child: moo\ntwo:\n mild: meh\n child: moo\nthree:\n child: moo';
yamlSettings.keyOrdering = true;
languageSettingsSetup = new serviceSetup_1.ServiceSetup().withValidate().withKeyOrdering();
const { validationHandler: valHandler, yamlSettings: settings } = (0, testHelper_1.setupLanguageService)(languageSettingsSetup.languageSettings);
validationHandler = valHandler;
yamlSettings = settings;
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).not.to.be.empty;
(0, chai_1.expect)(result.length).to.be.equal(2);
(0, chai_1.expect)(result).to.include.deep.members([
(0, verifyError_1.createExpectedError)('Wrong ordering of key "two" in mapping', 2, 0, 2, 3, vscode_languageserver_types_1.DiagnosticSeverity.Error, 'YAML', 'mapKeyOrder'),
(0, verifyError_1.createExpectedError)('Wrong ordering of key "mild" in mapping', 3, 2, 3, 6, vscode_languageserver_types_1.DiagnosticSeverity.Error, 'YAML', 'mapKeyOrder'),
]);
});
it('should NOT report any errors', async () => {
const yaml = '- key 1: val\n key 5: valu\n- {a: 1, c: 2}';
yamlSettings.keyOrdering = true;
languageSettingsSetup = new serviceSetup_1.ServiceSetup().withValidate().withKeyOrdering();
const { validationHandler: valHandler, yamlSettings: settings } = (0, testHelper_1.setupLanguageService)(languageSettingsSetup.languageSettings);
validationHandler = valHandler;
yamlSettings = settings;
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).to.be.empty;
});
});
describe('yaml-language-server-disable comment suppression', () => {
it('should suppress all diagnostics on the next line when no specifiers given', async () => {
const yaml = 'foo:\n# yaml-language-server-disable\n\t- bar';
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).to.be.empty;
});
it('should suppress only matching diagnostics when specifiers are given', async () => {
const yaml = 'foo:\n# yaml-language-server-disable Tabs are not allowed\n\t- bar';
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).to.be.empty;
});
it('should keep diagnostics that do not match the specifier', async () => {
const yaml = 'foo:\n# yaml-language-server-disable some other error\n\t- bar';
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).is.not.empty;
(0, chai_1.expect)(result.length).to.be.equal(1);
});
it('should not suppress diagnostics without a preceding disable comment', async () => {
const yaml = 'foo:\n\t- bar';
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).is.not.empty;
});
it('should only suppress the immediately following line', async () => {
const yaml = '# yaml-language-server-disable\nfoo:\n\t- bar';
const result = await parseSetup(yaml);
(0, chai_1.expect)(result.length).to.be.equal(1);
(0, chai_1.expect)(result[0].range.start.line).to.equal(2);
});
it('should suppress unused anchor diagnostics', async () => {
const yaml = '# yaml-language-server-disable\nfoo: &bar bar\n';
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).to.be.empty;
});
it('should handle indented disable comments', async () => {
const yaml = 'foo:\n # yaml-language-server-disable\n \t- bar';
const result = await parseSetup(yaml);
(0, chai_1.expect)(result).to.be.empty;
});
});
});
//# sourceMappingURL=yamlValidation.test.js.map