Licensing plugin functional tests (#53580) (#53784)

* NP licensing add functional tests (#53002)

* fix comment

* introduce core provider plugin for integration tests

* platform functional tests use core_provider_plugin for testing

* add 3 scenario for licensing plugins: server, client, legacy

* remove unused code

* run all licensing_plugin tests on CI

* remove duplicated config

* address comments

* declare global type for core provider

* remove potentially dangerous operation

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

test/plugin_functional/config.js

@@ -57,11 +57,12 @@ export default async function({ readConfigFile }) {
       ...functionalConfig.get('kbnTestServer'),
       serverArgs: [
         ...functionalConfig.get('kbnTestServer.serverArgs'),
+
+        // Required to load new platform plugins via `--plugin-path` flag.
+        '--env.name=development',
         ...plugins.map(
           pluginDir => `--plugin-path=${path.resolve(__dirname, 'plugins', pluginDir)}`
         ),
-        // Required to load new platform plugins via `--plugin-path` flag.
-        '--env.name=development',
       ],
     },
   };

test/plugin_functional/plugins/core_plugin_b/public/plugin.tsx

@@ -22,9 +22,6 @@ import { CorePluginAPluginSetup } from '../../core_plugin_a/public/plugin';
 
 declare global {
   interface Window {
-    corePluginB?: string;
-    hasAccessToInjectedMetadata?: boolean;
-    receivedStartServices?: boolean;
     env?: PluginInitializerContext['env'];
   }
 }
@@ -39,12 +36,6 @@ export class CorePluginBPlugin
     window.env = pluginContext.env;
   }
   public setup(core: CoreSetup, deps: CorePluginBDeps) {
-    window.corePluginB = `Plugin A said: ${deps.core_plugin_a.getGreeting()}`;
-    window.hasAccessToInjectedMetadata = 'getInjectedVar' in core.injectedMetadata;
-    core.getStartServices().then(([coreStart, plugins]) => {
-      window.receivedStartServices = 'overlays' in coreStart;
-    });
-
     core.application.register({
       id: 'bar',
       title: 'Bar',
@@ -53,6 +44,12 @@ export class CorePluginBPlugin
         return renderApp(context, params);
       },
     });
+
+    return {
+      sayHi() {
+        return `Plugin A said: ${deps.core_plugin_a.getGreeting()}`;
+      },
+    };
   }
 
   public start() {}

test/plugin_functional/plugins/core_provider_plugin/index.ts

@@ -0,0 +1,36 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { resolve } from 'path';
+import { Legacy } from '../../../../kibana';
+
+// eslint-disable-next-line import/no-default-export
+export default function CoreProviderPlugin(kibana: any) {
+  const config: Legacy.PluginSpecOptions = {
+    id: 'core-provider',
+    require: [],
+    publicDir: resolve(__dirname, 'public'),
+    init: (server: Legacy.Server) => ({}),
+    uiExports: {
+      hacks: [resolve(__dirname, 'public/index')],
+    },
+  };
+
+  return new kibana.Plugin(config);
+}

test/plugin_functional/plugins/core_provider_plugin/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "core_provider_plugin",
+  "version": "1.0.0",
+  "main": "target/test/plugin_functional/plugins/core_provider_plugin",
+  "kibana": {
+    "version": "kibana",
+    "templateVersion": "1.0.0"
+  },
+  "license": "Apache-2.0",
+  "scripts": {
+    "kbn": "node ../../../../scripts/kbn.js",
+    "build": "rm -rf './target' && tsc"
+  },
+  "devDependencies": {
+    "typescript": "3.5.3"
+  }
+}

test/plugin_functional/plugins/ui_settings_plugin/public/index.ts → test/plugin_functional/plugins/core_provider_plugin/public/index.ts

@@ -16,6 +16,13 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { UiSettingsPlugin } from './plugin';
+import { npSetup, npStart } from 'ui/new_platform';
+import '../types';
 
-export const plugin = () => new UiSettingsPlugin();
+window.__coreProvider = {
+  setup: npSetup,
+  start: npStart,
+  testUtils: {
+    delay: (ms: number) => new Promise(res => setTimeout(res, ms)),
+  },
+};

test/plugin_functional/plugins/core_provider_plugin/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./target",
+    "skipLibCheck": true
+  },
+  "include": [
+    "index.ts",
+    "types.ts",
+    "public/**/*.ts",
+    "../../../../typings/**/*",
+  ],
+  "exclude": []
+}

test/plugin_functional/plugins/ui_settings_plugin/public/plugin.tsx → test/plugin_functional/plugins/core_provider_plugin/types.ts

@@ -16,22 +16,22 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
-import { CoreSetup, Plugin } from 'kibana/public';
+import { LegacyCoreSetup, LegacyCoreStart } from 'kibana/public';
 
 declare global {
   interface Window {
-    uiSettingsPlugin?: Record<string, any>;
-    uiSettingsPluginValue?: string;
+    __coreProvider: {
+      setup: {
+        core: LegacyCoreSetup;
+        plugins: Record<string, any>;
+      };
+      start: {
+        core: LegacyCoreStart;
+        plugins: Record<string, any>;
+      };
+      testUtils: {
+        delay: (ms: number) => Promise<void>;
+      };
+    };
   }
 }
-
-export class UiSettingsPlugin implements Plugin {
-  public setup(core: CoreSetup) {
-    window.uiSettingsPlugin = core.uiSettings.getAll().ui_settings_plugin;
-    window.uiSettingsPluginValue = core.uiSettings.get('ui_settings_plugin');
-  }
-
-  public start() {}
-  public stop() {}
-}

test/plugin_functional/plugins/ui_settings_plugin/kibana.json

@@ -4,5 +4,5 @@
   "kibanaVersion": "kibana",
   "configPath": ["ui_settings_plugin"],
   "server": true,
-  "ui": true
+  "ui": false
 }

test/plugin_functional/plugins/ui_settings_plugin/tsconfig.json

@@ -5,9 +5,6 @@
     "skipLibCheck": true
   },
   "include": [
-    "index.ts",
-    "public/**/*.ts",
-    "public/**/*.tsx",
     "server/**/*.ts",
     "../../../../typings/**/*",
   ],

test/plugin_functional/test_suites/core_plugins/ui_plugins.ts

@@ -19,6 +19,7 @@
 
 import expect from '@kbn/expect';
 import { PluginFunctionalProviderContext } from '../../services';
+import '../../../../test/plugin_functional/plugins/core_provider_plugin/types';
 
 // eslint-disable-next-line import/no-default-export
 export default function({ getService, getPageObjects }: PluginFunctionalProviderContext) {
@@ -31,22 +32,35 @@ export default function({ getService, getPageObjects }: PluginFunctionalProvider
         await PageObjects.common.navigateToApp('settings');
       });
 
-      it('should attach string to window.corePluginB', async () => {
-        const corePluginB = await browser.execute('return window.corePluginB');
-        expect(corePluginB).to.equal(`Plugin A said: Hello from Plugin A!`);
+      it('should run the new platform plugins', async () => {
+        expect(
+          await browser.execute(() => {
+            return window.__coreProvider.setup.plugins.core_plugin_b.sayHi();
+          })
+        ).to.be('Plugin A said: Hello from Plugin A!');
       });
     });
 
-    describe('have injectedMetadata service provided', function describeIndexTests() {
+    describe('should have access to the core services', function describeIndexTests() {
       before(async () => {
-        await PageObjects.common.navigateToApp('bar');
+        await PageObjects.common.navigateToApp('settings');
+      });
+
+      it('to injectedMetadata service', async () => {
+        expect(
+          await browser.execute(() => {
+            return window.__coreProvider.setup.core.injectedMetadata.getKibanaBuildNumber();
+          })
+        ).to.be.a('number');
       });
 
-      it('should attach boolean to window.hasAccessToInjectedMetadata', async () => {
-        const hasAccessToInjectedMetadata = await browser.execute(
-          'return window.hasAccessToInjectedMetadata'
-        );
-        expect(hasAccessToInjectedMetadata).to.equal(true);
+      it('to start services via coreSetup.getStartServices', async () => {
+        expect(
+          await browser.executeAsync(async cb => {
+            const [coreStart] = await window.__coreProvider.setup.core.getStartServices();
+            cb(Boolean(coreStart.overlays));
+          })
+        ).to.be(true);
       });
     });
 
@@ -61,16 +75,5 @@ export default function({ getService, getPageObjects }: PluginFunctionalProvider
         expect(envData.packageInfo.version).to.be.a('string');
       });
     });
-
-    describe('have access to start services via coreSetup.getStartServices', function describeIndexTests() {
-      before(async () => {
-        await PageObjects.common.navigateToApp('bar');
-      });
-
-      it('should attach boolean to window.receivedStartServices', async () => {
-        const receivedStartServices = await browser.execute('return window.receivedStartServices');
-        expect(receivedStartServices).to.equal(true);
-      });
-    });
   });
 }

test/plugin_functional/test_suites/core_plugins/ui_settings.ts

@@ -18,6 +18,7 @@
  */
 import expect from '@kbn/expect';
 import { PluginFunctionalProviderContext } from '../../services';
+import '../../plugins/core_provider_plugin/types';
 
 // eslint-disable-next-line import/no-default-export
 export default function({ getService, getPageObjects }: PluginFunctionalProviderContext) {
@@ -31,15 +32,30 @@ export default function({ getService, getPageObjects }: PluginFunctionalProvider
     });
 
     it('client plugins have access to registered settings', async () => {
-      const settings = await browser.execute('return window.uiSettingsPlugin');
+      const settings = await browser.execute(() => {
+        return window.__coreProvider.setup.core.uiSettings.getAll().ui_settings_plugin;
+      });
+
       expect(settings).to.eql({
         category: ['any'],
         description: 'just for testing',
         name: 'from_ui_settings_plugin',
         value: '2',
       });
-      const settingsValue = await browser.execute('return window.uiSettingsPluginValue');
+
+      const settingsValue = await browser.execute(() => {
+        return window.__coreProvider.setup.core.uiSettings.get('ui_settings_plugin');
+      });
+
       expect(settingsValue).to.be('2');
+
+      const settingsValueViaObservables = await browser.executeAsync(async (callback: Function) => {
+        window.__coreProvider.setup.core.uiSettings
+          .get$('ui_settings_plugin')
+          .subscribe(v => callback(v));
+      });
+
+      expect(settingsValueViaObservables).to.be('2');
     });
 
     it('server plugins have access to registered settings', async () => {

x-pack/scripts/functional_tests.js

@@ -35,4 +35,6 @@ require('@kbn/test').runTestsCli([
   require.resolve('../test/ui_capabilities/spaces_only/config'),
   require.resolve('../test/upgrade_assistant_integration/config'),
   require.resolve('../test/licensing_plugin/config'),
+  require.resolve('../test/licensing_plugin/config.public'),
+  require.resolve('../test/licensing_plugin/config.legacy'),
 ]);