Add functional test for Kibana embedded in iframe

packages/kbn-test/src/kbn/kbn_test_config.js → packages/kbn-test/src/kbn/kbn_test_config.ts

@@ -16,26 +16,34 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
-import { kibanaTestUser } from './users';
 import url from 'url';
+import { kibanaTestUser } from './users';
+
+interface UrlParts {
+  protocol: string;
+  hostname: string;
+  port: number;
+  auth: string;
+  username: string;
+  password: string;
+}
 
 export const kbnTestConfig = new (class KbnTestConfig {
   getPort() {
     return this.getUrlParts().port;
   }
 
-  getUrlParts() {
+  getUrlParts(): UrlParts {
     // allow setting one complete TEST_KIBANA_URL for ES like https://elastic:[email protected]:9200
     if (process.env.TEST_KIBANA_URL) {
       const testKibanaUrl = url.parse(process.env.TEST_KIBANA_URL);
       return {
-        protocol: testKibanaUrl.protocol.slice(0, -1),
-        hostname: testKibanaUrl.hostname,
-        port: parseInt(testKibanaUrl.port, 10),
-        auth: testKibanaUrl.auth,
-        username: testKibanaUrl.auth.split(':')[0],
-        password: testKibanaUrl.auth.split(':')[1],
+        protocol: testKibanaUrl.protocol!.slice(0, -1),
+        hostname: testKibanaUrl.hostname!,
+        port: parseInt(testKibanaUrl.port!, 10),
+        auth: testKibanaUrl.auth!,
+        username: testKibanaUrl.auth!.split(':')[0],
+        password: testKibanaUrl.auth!.split(':')[1],
       };
     }
 
@@ -44,7 +52,7 @@ export const kbnTestConfig = new (class KbnTestConfig {
     return {
       protocol: process.env.TEST_KIBANA_PROTOCOL || 'http',
       hostname: process.env.TEST_KIBANA_HOSTNAME || 'localhost',
-      port: parseInt(process.env.TEST_KIBANA_PORT, 10) || 5620,
+      port: parseInt(process.env.TEST_KIBANA_PORT!, 10) || 5620,
       auth: `${username}:${password}`,
       username,
       password,

x-pack/test/functional_embedded/config.ts

@@ -0,0 +1,58 @@
+/*
+ * 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 { resolve } from 'path';
+// import { CA_CERT_PATH, KBN_CERT_PATH, KBN_KEY_PATH } from '@kbn/dev-utils';
+import { FtrConfigProviderContext } from '@kbn/test/types/ftr';
+import { pageObjects } from '../functional/page_objects';
+
+export default async function ({ readConfigFile }: FtrConfigProviderContext) {
+  const kibanaFunctionalConfig = await readConfigFile(require.resolve('../functional/config.js'));
+
+  const iframeEmbeddedPlugin = resolve(__dirname, './plugins/iframe_embedded');
+
+  const servers = {
+    ...kibanaFunctionalConfig.get('servers'),
+    elasticsearch: {
+      ...kibanaFunctionalConfig.get('servers.elasticsearch'),
+    },
+    kibana: {
+      ...kibanaFunctionalConfig.get('servers.kibana'),
+      // protocol: 'https',
+    },
+  };
+
+  return {
+    testFiles: [require.resolve('./tests')],
+    servers,
+    services: kibanaFunctionalConfig.get('services'),
+    pageObjects,
+    junit: {
+      reportName: 'Kibana Embedded in iframe with X-Pack Security',
+    },
+
+    esTestCluster: kibanaFunctionalConfig.get('esTestCluster'),
+    apps: {
+      ...kibanaFunctionalConfig.get('apps'),
+    },
+
+    kbnTestServer: {
+      ...kibanaFunctionalConfig.get('kbnTestServer'),
+      serverArgs: [
+        ...kibanaFunctionalConfig.get('kbnTestServer.serverArgs'),
+        `--plugin-path=${iframeEmbeddedPlugin}`,
+        // '--server.ssl.enabled=true',
+        // `--server.ssl.key=${KBN_KEY_PATH}`,
+        // `--server.ssl.certificate=${KBN_CERT_PATH}`,
+        // `--server.ssl.certificateAuthorities=${JSON.stringify([CA_CERT_PATH])}`,
+        // `--server.ssl.clientAuthentication=optional`,
+
+        // '--xpack.security.sameSiteCookies=None',
+        // '--xpack.security.secureCookies=true',
+      ],
+    },
+  };
+}

x-pack/test/functional_embedded/ftr_provider_context.d.ts

@@ -0,0 +1,12 @@
+/*
+ * 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 { GenericFtrProviderContext } from '@kbn/test/types/ftr';
+import { pageObjects } from '../functional/page_objects';
+import { services } from './services';
+
+export type FtrProviderContext = GenericFtrProviderContext<typeof services, typeof pageObjects>;
+export { pageObjects };

x-pack/test/functional_embedded/plugins/iframe_embedded/kibana.json

@@ -0,0 +1,7 @@
+{
+  "id": "iframe_embedded",
+  "version": "1.0.0",
+  "kibanaVersion": "kibana",
+  "server": true,
+  "ui": false
+}

x-pack/test/functional_embedded/plugins/iframe_embedded/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "iframe_embedded",
+  "version": "0.0.0",
+  "kibana": {
+    "version": "kibana"
+  },
+  "main": "target/test/plugin_api_integration/plugins/event_log",
+  "scripts": {
+    "kbn": "node ../../../../../scripts/kbn.js",
+    "build": "rm -rf './target' && tsc"
+  },
+  "devDependencies": {
+    "typescript": "3.7.2"
+  }
+}

x-pack/test/functional_embedded/plugins/iframe_embedded/server/index.ts

@@ -0,0 +1,11 @@
+/*
+ * 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 { PluginInitializerContext } from 'kibana/server';
+import { IframeEmbeddedPlugin } from './plugin';
+
+export const plugin = (initContext: PluginInitializerContext) =>
+  new IframeEmbeddedPlugin(initContext);

x-pack/test/functional_embedded/plugins/iframe_embedded/server/plugin.ts

@@ -0,0 +1,48 @@
+/*
+ * 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 Url from 'url';
+import { Plugin, CoreSetup, PluginInitializerContext } from 'src/core/server';
+import { kbnTestConfig } from '@kbn/test';
+
+function renderBody(iframeUrl: string = 'https://localhost:5601') {
+  return `
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>Kibana embedded in iframe</title>
+  </head>
+  <body>
+    <iframe data-test-subj="iframe_embedded" width="1000" height="1200" src="${iframeUrl}" frameborder="0"/>
+  </body>
+</html>
+`;
+}
+export class IframeEmbeddedPlugin implements Plugin {
+  constructor(initializerContext: PluginInitializerContext) {}
+
+  public setup(core: CoreSetup) {
+    const router = core.http.createRouter();
+    router.get(
+      {
+        path: '/iframe_embedded',
+        validate: false,
+      },
+      async (context, request, response) => {
+        const { protocol, hostname, port } = kbnTestConfig.getUrlParts();
+        const kibanaUrl = Url.format({ protocol, hostname, port });
+        return response.ok({
+          body: renderBody(kibanaUrl),
+          headers: {
+            'content-type': 'text/html',
+          },
+        });
+      }
+    );
+  }
+  public start() {}
+  public stop() {}
+}

x-pack/test/functional_embedded/services.ts

@@ -0,0 +1,9 @@
+/*
+ * 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 { services as functionalServices } from '../functional/services';
+
+export const services = functionalServices;

x-pack/test/functional_embedded/tests/iframe_embedded.ts

@@ -0,0 +1,41 @@
+/*
+ * 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 Url from 'url';
+import { By, until } from 'selenium-webdriver';
+import testSubjSelector from '@kbn/test-subj-selector';
+import { kbnTestConfig } from '@kbn/test';
+
+import { FtrProviderContext } from '../ftr_provider_context';
+
+export default function ({ getService, getPageObjects }: FtrProviderContext) {
+  const PageObjects = getPageObjects(['security', 'common']);
+  const browser = getService('browser');
+  const testSubjects = getService('testSubjects');
+
+  const WD = getService('__webdriver__');
+
+  describe('Kibana embedded', () => {
+    it('should open Kibana for logged-in user', async () => {
+      await PageObjects.security.login();
+      const { protocol, hostname, port } = await kbnTestConfig.getUrlParts();
+      const url = Url.format({
+        protocol,
+        hostname,
+        port,
+        pathname: 'iframe_embedded',
+      });
+
+      await browser.navigateTo(url);
+
+      const iframe = await testSubjects.find('iframe_embedded');
+      WD.driver.switchTo().frame(iframe._webElement);
+
+      const selector = By.css(testSubjSelector('kibanaChrome'));
+      const minute = 60000;
+      await WD.driver.wait(until.elementLocated(selector), minute);
+    });
+  });
+}

x-pack/test/functional_embedded/tests/index.ts

@@ -0,0 +1,14 @@
+/*
+ * 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 { FtrProviderContext } from '../ftr_provider_context';
+
+export default function ({ loadTestFile }: FtrProviderContext) {
+  describe('apis', function () {
+    this.tags('ciGroup6');
+    loadTestFile(require.resolve('./iframe_embedded'));
+  });
+}