kibana/x-pack/plugins/monitoring/server/__tests__/deprecations.js

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License;
 * you may not use this file except in compliance with the Elastic License.
 */

import { noop } from 'lodash';
import expect from '@kbn/expect';
import { deprecations as deprecationsModule } from '../deprecations';
import sinon from 'sinon';

describe('monitoring plugin deprecations', function () {
  let transformDeprecations;
  const rename = sinon.stub().returns(() => {});
  const fromPath = 'monitoring';

  before(function () {
    const deprecations = deprecationsModule({ rename });
    transformDeprecations = (settings, fromPath, log = noop) => {
      deprecations.forEach((deprecation) => deprecation(settings, fromPath, log));
    };
  });

  describe('cluster_alerts.email_notifications.email_address', function () {
    it(`shouldn't log when email notifications are disabled`, function () {
      const settings = {
        cluster_alerts: {
          email_notifications: {
            enabled: false,
          },
        },
      };

      const log = sinon.spy();
      transformDeprecations(settings, fromPath, log);
      expect(log.called).to.be(false);
    });

    it(`shouldn't log when cluster alerts are disabled`, function () {
      const settings = {
        cluster_alerts: {
          enabled: false,
          email_notifications: {
            enabled: true,
          },
        },
      };

      const log = sinon.spy();
      transformDeprecations(settings, fromPath, log);
      expect(log.called).to.be(false);
    });

    it(`shouldn't log when email_address is specified`, function () {
      const settings = {
        cluster_alerts: {
          enabled: true,
          email_notifications: {
            enabled: true,
            email_address: 'foo@bar.com',
          },
        },
      };

      const log = sinon.spy();
      transformDeprecations(settings, fromPath, log);
      expect(log.called).to.be(false);
    });

    it(`should log when email_address is missing, but alerts/notifications are both enabled`, function () {
      const settings = {
        cluster_alerts: {
          enabled: true,
          email_notifications: {
            enabled: true,
          },
        },
      };

      const log = sinon.spy();
      transformDeprecations(settings, fromPath, log);
      expect(log.called).to.be(true);
    });
  });

  describe('elasticsearch.username', function () {
    it('logs a warning if elasticsearch.username is set to "elastic"', () => {
      const settings = { elasticsearch: { username: 'elastic' } };

      const log = sinon.spy();
      transformDeprecations(settings, fromPath, log);
      expect(log.called).to.be(true);
    });

    it('logs a warning if elasticsearch.username is set to "kibana"', () => {
      const settings = { elasticsearch: { username: 'kibana' } };

      const log = sinon.spy();
      transformDeprecations(settings, fromPath, log);
      expect(log.called).to.be(true);
    });

    it('does not log a warning if elasticsearch.username is set to something besides "elastic" or "kibana"', () => {
      const settings = { elasticsearch: { username: 'otheruser' } };

      const log = sinon.spy();
      transformDeprecations(settings, fromPath, log);
      expect(log.called).to.be(false);
    });

    it('does not log a warning if elasticsearch.username is unset', () => {
      const settings = { elasticsearch: { username: undefined } };

      const log = sinon.spy();
      transformDeprecations(settings, fromPath, log);
      expect(log.called).to.be(false);
    });

    it('logs a warning if ssl.key is set and ssl.certificate is not', () => {
      const settings = { elasticsearch: { ssl: { key: '' } } };

      const log = sinon.spy();
      transformDeprecations(settings, fromPath, log);
      expect(log.called).to.be(true);
    });

    it('logs a warning if ssl.certificate is set and ssl.key is not', () => {
      const settings = { elasticsearch: { ssl: { certificate: '' } } };

      const log = sinon.spy();
      transformDeprecations(settings, fromPath, log);
      expect(log.called).to.be(true);
    });

    it('does not log a warning if both ssl.key and ssl.certificate are set', () => {
      const settings = { elasticsearch: { ssl: { key: '', certificate: '' } } };

      const log = sinon.spy();
      transformDeprecations(settings, fromPath, log);
      expect(log.called).to.be(false);
    });
  });

  describe('xpack_api_polling_frequency_millis', () => {
    it('should call rename for this renamed config key', () => {
      const settings = { xpack_api_polling_frequency_millis: 30000 };
      const log = sinon.spy();
      transformDeprecations(settings, fromPath, log);
      expect(rename.called).to.be(true);
    });
  });
});