kibana-123/src/cli_plugin/install/__tests__/kibana.js

Kibana is an open source (Apache Licensed), browser based analytics and search dashboard for Elasticsearch. Kibana is a snap to setup and start using. Kibana strives to be easy to get started with, while also being flexible and powerful, just like Elastic

import expect from 'expect.js';
import sinon from 'sinon';
import Logger from '../../lib/logger';
import { join } from 'path';
import rimraf from 'rimraf';
import mkdirp from 'mkdirp';
import { existingInstall, assertVersion } from '../kibana';

describe('kibana cli', function () {

  describe('plugin installer', function () {

    describe('kibana', function () {
      const testWorkingPath = join(__dirname, '.test.data');
      const tempArchiveFilePath = join(testWorkingPath, 'archive.part');

      const settings = {
        workingPath: testWorkingPath,
        tempArchiveFile: tempArchiveFilePath,
        plugin: 'test-plugin',
        version: '1.0.0',
        plugins: [ { name: 'foo', path: join(testWorkingPath, 'foo') } ]
      };

      const logger = new Logger(settings);

      describe('assertVersion', function () {

        beforeEach(function () {
          rimraf.sync(testWorkingPath);
          mkdirp.sync(testWorkingPath);
          sinon.stub(logger, 'log');
          sinon.stub(logger, 'error');
        });

        afterEach(function () {
          logger.log.restore();
          logger.error.restore();
          rimraf.sync(testWorkingPath);
        });

        it('should succeed with exact match', function () {
          const settings = {
            workingPath: testWorkingPath,
            tempArchiveFile: tempArchiveFilePath,
            plugin: 'test-plugin',
            version: '5.0.0-SNAPSHOT',
            plugins: [ { name: 'foo', path: join(testWorkingPath, 'foo'), kibanaVersion: '5.0.0-SNAPSHOT' } ]
          };
          const errorStub = sinon.stub();

          try {
            assertVersion(settings);
          }
          catch (err) {
            errorStub(err);
          }

          expect(errorStub.called).to.be(false);
        });

        it('should throw an error if plugin is missing a kibana version.', function () {
          const errorStub = sinon.stub();

          try {
            assertVersion(settings);
          }
          catch (err) {
            errorStub(err);
          }

          expect(errorStub.firstCall.args[0]).to.match(/plugin package\.json is missing both a version property/i);
        });

        it('should throw an error if plugin kibanaVersion does not match kibana version', function () {
          const errorStub = sinon.stub();
          settings.plugins[0].kibanaVersion = '1.2.3.4';

          try {
            assertVersion(settings);
          }
          catch (err) {
            errorStub(err);
          }

          expect(errorStub.firstCall.args[0]).to.match(/incorrect kibana version/i);
        });

        it('should not throw an error if plugin kibanaVersion matches kibana version', function () {
          const errorStub = sinon.stub();
          settings.plugins[0].kibanaVersion = '1.0.0';

          try {
            assertVersion(settings);
          }
          catch (err) {
            errorStub(err);
          }

          expect(errorStub.called).to.be(false);
        });

        it('should ignore version info after the dash in checks on valid version', function () {
          const errorStub = sinon.stub();
          settings.plugins[0].kibanaVersion = '1.0.0-foo-bar-version-1.2.3';

          try {
            assertVersion(settings);
          }
          catch (err) {
            errorStub(err);
          }

          expect(errorStub.called).to.be(false);
        });

        it('should ignore version info after the dash in checks on invalid version', function () {
          const errorStub = sinon.stub();
          settings.plugins[0].kibanaVersion = '2.0.0-foo-bar-version-1.2.3';

          try {
            assertVersion(settings);
          }
          catch (err) {
            errorStub(err);
          }

          expect(errorStub.firstCall.args[0]).to.match(/incorrect kibana version/i);
        });
      });

      describe('existingInstall', function () {
        let testWorkingPath;
        let processExitStub;

        beforeEach(function () {
          processExitStub = sinon.stub(process, 'exit');
          testWorkingPath = join(__dirname, '.test.data');
          rimraf.sync(testWorkingPath);
          sinon.stub(logger, 'log');
          sinon.stub(logger, 'error');
        });

        afterEach(function () {
          processExitStub.restore();
          logger.log.restore();
          logger.error.restore();
          rimraf.sync(testWorkingPath);
        });

        it('should throw an error if the workingPath already exists.', function () {
          mkdirp.sync(settings.plugins[0].path);
          existingInstall(settings, logger);

          expect(logger.error.firstCall.args[0]).to.match(/already exists/);
          expect(process.exit.called).to.be(true);
        });

        it('should not throw an error if the workingPath does not exist.', function () {
          existingInstall(settings, logger);
          expect(logger.error.called).to.be(false);
        });

      });

    });

  });

});