-
Notifications
You must be signed in to change notification settings - Fork 268
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
handle scenario of multiple documents in single yaml file (#81)
* add custom schemaSequence in schema object to map schema to multiple documents in single yaml file
- Loading branch information
Showing
7 changed files
with
169 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| { | ||
| "schemaSequence": [ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-04/schema#", | ||
| "description": "Person object", | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { | ||
| "type": "string", | ||
| "description": "The name of this person" | ||
| }, | ||
| "age": { | ||
| "type": "number", | ||
| "description": "The age of this person" | ||
| } | ||
| }, | ||
| "required":["name","age"] | ||
| }, | ||
| { | ||
| "$ref": "http://json.schemastore.org/bowerrc" | ||
| } | ||
| ] | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| /*--------------------------------------------------------------------------------------------- | ||
| * Copyright (c) Red Hat. All rights reserved. | ||
| * Licensed under the MIT License. See License.txt in the project root for license information. | ||
| *--------------------------------------------------------------------------------------------*/ | ||
| import { TextDocument } from 'vscode-languageserver'; | ||
| import {getLanguageService} from '../src/languageservice/yamlLanguageService' | ||
| import path = require('path'); | ||
| import {schemaRequestService, workspaceContext} from './testHelper'; | ||
| import { parse as parseYAML } from '../src/languageservice/parser/yamlParser'; | ||
| var assert = require('assert'); | ||
|
|
||
| let languageService = getLanguageService(schemaRequestService, workspaceContext, [], null); | ||
|
|
||
| function toFsPath(str): string { | ||
| if (typeof str !== 'string') { | ||
| throw new TypeError(`Expected a string, got ${typeof str}`); | ||
| } | ||
|
|
||
| let pathName; | ||
| pathName = path.resolve(str); | ||
| pathName = pathName.replace(/\\/g, '/'); | ||
| // Windows drive letter must be prefixed with a slash | ||
| if (pathName[0] !== '/') { | ||
| pathName = `/${pathName}`; | ||
| } | ||
| return encodeURI(`file://${pathName}`).replace(/[?#]/g, encodeURIComponent); | ||
| } | ||
|
|
||
| let uri = toFsPath(path.join(__dirname, './fixtures/customMultipleSchemaSequences.json')); | ||
| let languageSettings = { | ||
| schemas: [], | ||
| validate: true, | ||
| customTags: [] | ||
| }; | ||
| let fileMatch = ["*.yml", "*.yaml"]; | ||
| languageSettings.schemas.push({ uri, fileMatch: fileMatch }); | ||
| languageSettings.customTags.push("!Test"); | ||
| languageSettings.customTags.push("!Ref sequence"); | ||
| languageService.configure(languageSettings); | ||
| // Defines a Mocha test suite to group tests of similar kind together | ||
| suite("Multiple Documents Validation Tests", () => { | ||
|
|
||
| // Tests for validator | ||
| describe('Multiple Documents Validation', function() { | ||
| function setup(content: string){ | ||
| return TextDocument.create("file://~/Desktop/vscode-k8s/test.yaml", "yaml", 0, content); | ||
| } | ||
|
|
||
| function validatorSetup(content: string){ | ||
| const testTextDocument = setup(content); | ||
| const yDoc = parseYAML(testTextDocument.getText(), languageSettings.customTags); | ||
| return languageService.doValidation(testTextDocument, yDoc); | ||
| } | ||
|
|
||
| function hoverSetup(content: string, position){ | ||
| let testTextDocument = setup(content); | ||
| let jsonDocument = parseYAML(testTextDocument.getText()); | ||
| return languageService.doHover(testTextDocument, testTextDocument.positionAt(position), jsonDocument); | ||
| } | ||
|
|
||
| it('Should validate multiple documents', (done) => { | ||
| const content = ` | ||
| name: jack | ||
| age: 22 | ||
| --- | ||
| analytics: true | ||
| `; | ||
| const validator = validatorSetup(content); | ||
| validator.then((result) => { | ||
| assert.equal(result.length, 0); | ||
| }).then(done, done); | ||
| }); | ||
|
|
||
| it('Should find errors in both documents', (done) => { | ||
| let content = `name1: jack | ||
| age: asd | ||
| --- | ||
| cwd: False`; | ||
| let validator = validatorSetup(content); | ||
| validator.then(function(result){ | ||
| assert.equal(result.length, 3); | ||
| }).then(done, done); | ||
| }); | ||
|
|
||
| it('Should find errors in first document', (done) => { | ||
| let content = `name: jack | ||
| age: age | ||
| --- | ||
| analytics: true`; | ||
| let validator = validatorSetup(content); | ||
| validator.then(function(result){ | ||
| assert.equal(result.length, 1); | ||
| }).then(done, done); | ||
| }); | ||
|
|
||
| it('Should find errors in second document', (done) => { | ||
| let content = `name: jack | ||
| age: 22 | ||
| --- | ||
| cwd: False`; | ||
| let validator = validatorSetup(content); | ||
| validator.then(function(result){ | ||
| assert.equal(result.length, 1); | ||
| }).then(done, done); | ||
| }); | ||
|
|
||
| it('Should hover in first document', (done) => { | ||
| let content = `name: jack\nage: 22\n---\ncwd: False`; | ||
| let hover = hoverSetup(content, 1 + content.indexOf('age')); | ||
| hover.then(function(result){ | ||
| assert.notEqual(result.contents.length, 0); | ||
| assert.equal(result.contents[0], 'The age of this person'); | ||
| }).then(done, done); | ||
| }); | ||
| }); | ||
| }); |