scenario.ts

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

import expect from '@kbn/expect';
import { PublicLicenseJSON } from '@kbn/licensing-plugin/server';
import { FtrProviderContext } from './services';
import '@kbn/core-provider-plugin/types';

const delay = (ms: number) => new Promise((res) => setTimeout(res, ms));

export function createScenario({ getService, getPageObjects }: FtrProviderContext) {
  const supertest = getService('supertest');
  const esSupertestWithoutAuth = getService('esSupertestWithoutAuth');
  const security = getService('security');
  const PageObjects = getPageObjects(['common', 'security']);

  const scenario = {
    async setup() {
      await security.role.create('license_manager-role', {
        elasticsearch: {
          cluster: ['all'],
        },
        kibana: [
          {
            base: ['all'],
            spaces: ['*'],
          },
        ],
      });

      await security.user.create('license_manager_user', {
        password: 'license_manager_user-password',
        roles: ['license_manager-role'],
        full_name: 'license_manager user',
      });

      // ensure we're logged out so we can login as the appropriate users
      await PageObjects.security.logout();
      await PageObjects.security.login('license_manager_user', 'license_manager_user-password');
    },

    // make sure a license is present, otherwise the security is not available anymore.
    async teardown() {
      await security.role.delete('license_manager-role');
      await security.user.delete('license_manager_user');
    },

    // elasticsearch allows to downgrade a license only once. other attempts will throw 403.
    async startBasic() {
      const response = await esSupertestWithoutAuth
        .post('/_license/start_basic?acknowledge=true')
        .auth('license_manager_user', 'license_manager_user-password')
        .expect(200);

      expect(response.body.basic_was_started).to.be(true);
    },

    // elasticsearch allows to request trial only once. other attempts will throw 403.
    async startTrial() {
      const response = await esSupertestWithoutAuth
        .post('/_license/start_trial?acknowledge=true')
        .auth('license_manager_user', 'license_manager_user-password')
        .expect(200);

      expect(response.body.trial_was_started).to.be(true);
    },

    async startEnterprise() {
      const response = await esSupertestWithoutAuth
        .post('/_license/?acknowledge=true')
        .send({
          license: {
            uid: '504430e6-503c-4316-85cb-b402c730ca08',
            type: 'enterprise',
            issue_date_in_millis: 1669680000000,
            start_date_in_millis: 1669680000000,
            // expires 2024-12-31
            expiry_date_in_millis: 1735689599999,
            max_resource_units: 250,
            max_nodes: null,
            issued_to: 'Elastic - INTERNAL (development environments)',
            issuer: 'API',
            signature:
              'AAAABQAAAA2h1vBafHuRhjOHREKYAAAAIAo5/x6hrsGh1GqqrJmy4qgmEC7gK0U4zQ6q5ZEMhm4jAAABAByGz9MmRW/L7vQriISa6u8Oov7zykA+Cv55BToWEthSn0c5KQUxcWG+K5Cm4/OkFsXA8TE4zFnlSgYxmQi2Eqq7IAKGdcxI/xhQfMsq5RWlSEwtfyV0M2RKJxgam8o2lvKC9EbrU76ISYr7jTkgoBl6GFSjdfXMHmxNXBSKDDm03ZeXkWkvuNNFrHJuYivf2Se9OeeB/eu4jqUI0UuNfPYF07ZcYvtKfj3KX+aysCSV2FW8wgyAjndOPEinfYcwAJ09zcl+MTig2K0DQTsYkLykXmzZnLz6qeuVVFjCTowxizDFW+5MrpzUnwkjqv8CFhLfvxG7waWQWslv8fXLUn8=',
          },
        })
        .auth('license_manager_user', 'license_manager_user-password')
        .expect(200);

      expect(response.body.license_status).to.be('valid');
    },

    async deleteLicense() {
      const response = await esSupertestWithoutAuth
        .delete('/_license')
        .auth('license_manager_user', 'license_manager_user-password')
        .expect(200);

      expect(response.body.acknowledged).to.be(true);
    },

    async getLicense(): Promise<PublicLicenseJSON> {
      const { body } = await supertest.get('/api/licensing/info').expect(200);
      return body;
    },

    async waitForPluginToDetectLicenseUpdate() {
      // > --xpack.licensing.api_polling_frequency set in test config
      // to wait for Kibana server to re-fetch the license from Elasticsearch
      await delay(500);
    },
  };
  return scenario;
}