monaco-yaml/test/hover.test.ts

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Red Hat. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/
import { ServiceSetup } from './utils/serviceSetup';
import {
  configureLanguageService,
  setupTextDocument,
} from './utils/testHelper';
import { MarkedString } from 'vscode-languageserver-types';
import assert = require('assert');

/**
 * Setup the schema we are going to use with the language settings
 */
const bowerURI = 'http://json.schemastore.org/bowerrc';
const composerURI = 'http://json.schemastore.org/composer';
const fileMatch = ['*.yml', '*.yaml'];
const languageSettingsSetup = new ServiceSetup()
  .withHover()
  .withSchemaFileMatch({ uri: bowerURI, fileMatch: fileMatch });

describe('Hover Tests', () => {
  describe('Hover', function() {
    function parseSetup(content: string, position, schemaURI: string) {
      const testTextDocument = setupTextDocument(content);
      languageSettingsSetup.languageSettings.schemas = [
        {
          fileMatch,
          uri: schemaURI,
        },
      ];
      const languageService = configureLanguageService(
        languageSettingsSetup.languageSettings
      );
      return languageService.doHover(
        testTextDocument,
        testTextDocument.positionAt(position)
      );
    }

    it('Hover on key on root', done => {
      const content = 'cwd: test';
      const hover = parseSetup(content, 1, bowerURI);
      hover
        .then(function(result) {
          assert.equal((result.contents as string).length, 1);
          assert.equal(
            result.contents[0],
            'The directory from which bower should run\\. All relative paths will be calculated according to this setting\\.'
          );
        })
        .then(done, done);
    });

    it('Hover on value on root', done => {
      const content = 'cwd: test';
      const hover = parseSetup(content, 6, bowerURI);
      hover
        .then(function(result) {
          assert.equal((result.contents as string).length, 1);
          assert.equal(
            result.contents[0],
            'The directory from which bower should run\\. All relative paths will be calculated according to this setting\\.'
          );
        })
        .then(done, done);
    });

    it('Hover on key with depth', done => {
      const content = 'scripts:\n  postinstall: test';
      const hover = parseSetup(content, 15, bowerURI);
      hover
        .then(function(result) {
          assert.equal((result.contents as MarkedString[]).length, 1);
          assert.equal(result.contents[0], 'A script to run after install');
        })
        .then(done, done);
    });

    it('Hover on value with depth', done => {
      const content = 'scripts:\n  postinstall: test';
      const hover = parseSetup(content, 26, bowerURI);
      hover
        .then(function(result) {
          assert.equal((result.contents as MarkedString[]).length, 1);
          assert.equal(result.contents[0], 'A script to run after install');
        })
        .then(done, done);
    });

    it('Hover works on both root node and child nodes works', done => {
      const content = 'scripts:\n  postinstall: test';

      const firstHover = parseSetup(content, 3, bowerURI);
      firstHover.then(function(result) {
        assert.equal((result.contents as MarkedString[]).length, 1);
        assert.equal(
          result.contents[0],
          'Contains custom hooks used to trigger other automated tools'
        );
      });

      const secondHover = parseSetup(content, 15, bowerURI);
      secondHover
        .then(function(result) {
          assert.equal((result.contents as MarkedString[]).length, 1);
          assert.equal(result.contents[0], 'A script to run after install');
        })
        .then(done, done);
    });

    it('Hover does not show results when there isnt description field', done => {
      const content = 'analytics: true';
      const hover = parseSetup(content, 3, bowerURI);
      hover
        .then(function(result) {
          assert.equal((result.contents as MarkedString[]).length, 1);
          assert.equal(result.contents[0], '');
        })
        .then(done, done);
    });

    it('Hover on first document in multi document', done => {
      const content = '---\nanalytics: true\n...\n---\njson: test\n...';
      const hover = parseSetup(content, 10, bowerURI);
      hover
        .then(function(result) {
          assert.equal((result.contents as MarkedString[]).length, 1);
          assert.equal(result.contents[0], '');
        })
        .then(done, done);
    });

    it('Hover on second document in multi document', done => {
      const content = '---\nanalytics: true\n...\n---\njson: test\n...';
      const hover = parseSetup(content, 30, bowerURI);
      hover
        .then(function(result) {
          assert.equal((result.contents as MarkedString[]).length, 1);
          assert.equal(
            result.contents[0],
            'A file path to the Bower configuration file'
          );
        })
        .then(done, done);
    });

    it('Hover should not return anything on key', done => {
      const content = 'my_unknown_hover: test';
      const hover = parseSetup(content, 1, bowerURI);
      hover
        .then(function(result) {
          assert.equal((result.contents as MarkedString[]).length, 1);
          assert.equal(result.contents[0], '');
        })
        .then(done, done);
    });

    it('Hover should not return anything on value', done => {
      const content = 'my_unknown_hover: test';
      const hover = parseSetup(content, 21, bowerURI);
      hover
        .then(function(result) {
          assert.equal((result.contents as MarkedString[]).length, 1);
          assert.equal(result.contents[0], '');
        })
        .then(done, done);
    });

    it('Hover works on array nodes', done => {
      const content = 'authors:\n  - name: Josh';
      const hover = parseSetup(content, 14, composerURI);
      hover
        .then(function(result) {
          assert.notEqual((result.contents as MarkedString[]).length, 0);
          assert.equal(result.contents[0], 'Full name of the author\\.');
        })
        .then(done, done);
    });

    it('Hover works on additional array nodes', done => {
      const content = 'authors:\n  - name: Josh\n  - email: jp';
      const hover = parseSetup(content, 28, composerURI);
      hover
        .then(function(result) {
          assert.notEqual((result.contents as MarkedString[]).length, 0);
          assert.equal(result.contents[0], 'Email address of the author\\.');
        })
        .then(done, done);
    });
  });
});