[8.x] [Scout] add maps test (#204607) (#211350)

dmlemeshko · wayneseymour · web-flow · commit a4e5dabf7fce · 2025-02-17T13:51:34.000+01:00
# Backport This will backport the following commits from `main` to `8.x`: - [[Scout] add maps test (#204607)](#204607)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  Co-authored-by: Tre <wayne.seymour@elastic.co>
diff --git a/.buildkite/scripts/steps/functional/scout_ui_tests.sh b/.buildkite/scripts/steps/functional/scout_ui_tests.sh
@@ -24,10 +24,11 @@ run_tests() {
 
 EXIT_CODE=0
 
-# Discovery Enhanced
+# Discovery Enhanced && Maps
 for run_mode in "--stateful"; do
   run_tests "Discovery Enhanced: Parallel Workers" "x-pack/platform/plugins/private/discover_enhanced/ui_tests/parallel.playwright.config.ts" "$run_mode"
   run_tests "Discovery Enhanced" "x-pack/platform/plugins/private/discover_enhanced/ui_tests/playwright.config.ts" "$run_mode"
+  run_tests "Maps" "x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts" "$run_mode"
 done
 
 exit $EXIT_CODE
diff --git a/packages/kbn-scout/src/playwright/config/create_config.test.ts b/packages/kbn-scout/src/playwright/config/create_config.test.ts
@@ -50,6 +50,7 @@ describe('createPlaywrightConfig', () => {
       serversConfigDir: SCOUT_SERVERS_ROOT,
       [VALID_CONFIG_MARKER]: true,
       screenshot: 'only-on-failure',
+      testIdAttribute: 'data-test-subj',
       trace: 'on-first-retry',
     });
     expect(config.globalSetup).toBeUndefined();
diff --git a/packages/kbn-scout/src/playwright/config/create_config.ts b/packages/kbn-scout/src/playwright/config/create_config.ts
@@ -47,6 +47,7 @@ export function createPlaywrightConfig(options: ScoutPlaywrightOptions): Playwri
     ],
     /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
     use: {
+      testIdAttribute: 'data-test-subj',
       serversConfigDir: SCOUT_SERVERS_ROOT,
       [VALID_CONFIG_MARKER]: true,
       /* Base URL to use in actions like `await page.goto('/')`. */
diff --git a/packages/kbn-scout/src/playwright/page_objects/index.ts b/packages/kbn-scout/src/playwright/page_objects/index.ts
@@ -12,13 +12,17 @@ import { DashboardApp } from './dashboard_app';
 import { DatePicker } from './date_picker';
 import { DiscoverApp } from './discover_app';
 import { FilterBar } from './fiter_bar';
+import { MapsPage } from './maps_page';
+import { RenderablePage } from './renderable_page';
 import { createLazyPageObject } from './utils';
 
 export interface PageObjects {
   datePicker: DatePicker;
   discover: DiscoverApp;
   dashboard: DashboardApp;
   filterBar: FilterBar;
+  maps: MapsPage;
+  renderable: RenderablePage;
 }
 
 /**
@@ -33,6 +37,8 @@ export function createCorePageObjects(page: ScoutPage): PageObjects {
     dashboard: createLazyPageObject(DashboardApp, page),
     discover: createLazyPageObject(DiscoverApp, page),
     filterBar: createLazyPageObject(FilterBar, page),
+    maps: createLazyPageObject(MapsPage, page),
+    renderable: createLazyPageObject(RenderablePage, page),
     // Add new page objects here
   };
 }
diff --git a/packages/kbn-scout/src/playwright/page_objects/maps_page.ts b/packages/kbn-scout/src/playwright/page_objects/maps_page.ts
@@ -0,0 +1,18 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import { ScoutPage } from '..';
+
+export class MapsPage {
+  constructor(private readonly page: ScoutPage) {}
+
+  async gotoNewMap() {
+    await this.page.gotoApp('maps/map');
+  }
+}
diff --git a/packages/kbn-scout/src/playwright/page_objects/renderable_page.ts b/packages/kbn-scout/src/playwright/page_objects/renderable_page.ts
@@ -0,0 +1,43 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import { ScoutPage, expect } from '..';
+
+export class RenderablePage {
+  constructor(private readonly page: ScoutPage) {}
+
+  async waitForRender(count: number = 1): Promise<void> {
+    await expect(async () => await renderWait(count, this.page)).toPass({
+      timeout: 10_000,
+    });
+  }
+}
+
+const RENDER_COMPLETE_SELECTOR = '[data-render-complete="true"]';
+const RENDER_COMPLETE_PENDING_SELECTOR = '[data-render-complete="false"]';
+const DATA_LOADING_SELECTOR = '[data-loading]';
+
+async function renderWait(count: number, page: ScoutPage) {
+  const renderCompleteLocator = page.locator(RENDER_COMPLETE_SELECTOR);
+  const renderPendingDataTitleLocator = page
+    .locator(RENDER_COMPLETE_PENDING_SELECTOR)
+    .and(page.locator('data-title'));
+  const loadingLocator = page.locator(DATA_LOADING_SELECTOR);
+
+  await renderCompleteLocator.waitFor({ timeout: 1000 });
+  const completedElementsCount = await renderCompleteLocator.count();
+
+  if (completedElementsCount < count)
+    throw new Error(
+      `${completedElementsCount} elements completed rendering, still waiting on a total of ${count} - ${await renderPendingDataTitleLocator.all()}`
+    );
+
+  const loadingCount = await loadingLocator.count();
+  if (loadingCount > 0) throw new Error(`${loadingCount} elements still loading contents`);
+}
diff --git a/packages/kbn-scout/src/playwright/page_objects/utils/index.ts b/packages/kbn-scout/src/playwright/page_objects/utils/index.ts
@@ -15,14 +15,14 @@ import { ScoutPage } from '../../fixtures';
  * in certain test scenarios.
  *
  * @param PageObjectClass - The page object class to be instantiated lazily.
- * @param scoutPage - ScoutPage instance, that extendes the Playwright `page` fixture and passed to the page object class constructor.
+ * @param scoutPage - ScoutPage instance, that extends the Playwright `page` fixture and passed to the page object class constructor.
  * @param constructorArgs - Additional arguments to be passed to the page object class constructor.
  * @returns A proxy object that behaves like an instance of the page object class, instantiating it on demand.
  */
-export function createLazyPageObject<T extends object>(
-  PageObjectClass: new (page: ScoutPage, ...args: any[]) => T,
+export function createLazyPageObject<T extends object, Args extends any[]>(
+  PageObjectClass: new (page: ScoutPage, ...args: Args) => T,
   scoutPage: ScoutPage,
-  ...constructorArgs: any[]
+  ...constructorArgs: Args
 ): T {
   let instance: T | null = null;
   return new Proxy({} as T, {
diff --git a/packages/kbn-scout/tsconfig.json b/packages/kbn-scout/tsconfig.json
@@ -27,6 +27,6 @@
     "@kbn/mock-idp-utils",
     "@kbn/test-subj-selector",
     "@kbn/scout-info",
-    "@kbn/scout-reporting"
+    "@kbn/scout-reporting",
   ]
 }
diff --git a/x-pack/platform/plugins/shared/maps/tsconfig.json b/x-pack/platform/plugins/shared/maps/tsconfig.json
@@ -9,7 +9,8 @@
     "public/**/*",
     "server/**/*",
     "server/config.ts",
-    "../../../../../typings/**/*"
+    "../../../../../typings/**/*",
+    "ui_tests/**/*",
   ],
   "kbn_references": [
     "@kbn/core",
@@ -92,6 +93,7 @@
     "@kbn/field-utils",
     "@kbn/react-hooks",
     "@kbn/react-kibana-mount",
+    "@kbn/scout",
   ],
   "exclude": [
     "target/**/*",
diff --git a/x-pack/platform/plugins/shared/maps/ui_tests/README.md b/x-pack/platform/plugins/shared/maps/ui_tests/README.md
@@ -0,0 +1,22 @@
+## How to run tests
+
+You can drop the following in your terminal.
+
+```bash
+run_tests() {
+  local suit_name=$1
+  local config_path=$2
+  local run_mode=$3
+
+  echo "--- $suit_name ($run_mode) UI Tests"
+  if ! node scripts/scout run-tests "$run_mode" --config "$config_path"; then
+    echo "$suit_name: failed"
+  else
+    echo "$suit_name: passed"
+  fi
+}
+
+for run_mode in "--stateful" "--serverless=es" "--serverless=oblt" "--serverless=security"; do
+  run_tests "Maps" "x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts" "$run_mode"
+done
+```
diff --git a/x-pack/platform/plugins/shared/maps/ui_tests/fixtures/constants.ts b/x-pack/platform/plugins/shared/maps/ui_tests/fixtures/constants.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
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export const VISIBLE_CHROME = 'kbnAppWrapper visibleChrome';
+export const HIDDEN_CHROME = 'kbnAppWrapper hiddenChrome';
+export const FULL_SCREEN_MODE = 'mapsFullScreenMode';
+export const EXIT_FULL_SCREEN = 'exitFullScreenModeButton';
diff --git a/x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts b/x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts
@@ -0,0 +1,13 @@
+/*
+ * 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 { createPlaywrightConfig } from '@kbn/scout';
+
+// eslint-disable-next-line import/no-default-export
+export default createPlaywrightConfig({
+  testDir: './tests',
+});
diff --git a/x-pack/platform/plugins/shared/maps/ui_tests/tests/full_screen_mode.spec.ts b/x-pack/platform/plugins/shared/maps/ui_tests/tests/full_screen_mode.spec.ts
@@ -0,0 +1,54 @@
+/*
+ * 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, tags, test } from '@kbn/scout';
+import {
+  VISIBLE_CHROME,
+  HIDDEN_CHROME,
+  FULL_SCREEN_MODE,
+  EXIT_FULL_SCREEN,
+} from '../fixtures/constants';
+
+test.describe(
+  'Maps',
+  {
+    tag: tags.DEPLOYMENT_AGNOSTIC,
+  },
+  () => {
+    test.beforeEach(async ({ browserAuth, pageObjects }) => {
+      await browserAuth.loginAsViewer();
+      await pageObjects.maps.gotoNewMap();
+      await pageObjects.renderable.waitForRender();
+    });
+
+    test('Full screen mode', async ({ page }) => {
+      const fullScreenBtn = page.getByTestId(FULL_SCREEN_MODE);
+      const exitFullScreenBtn = page.getByTestId(EXIT_FULL_SCREEN);
+      const visibleChrome = page.getByTestId(VISIBLE_CHROME);
+      const hiddenChrome = page.getByTestId(HIDDEN_CHROME);
+      const baseMapBtn = page.getByRole('button', { name: 'Basemap' });
+
+      await expect(fullScreenBtn).toBeVisible();
+      await expect(exitFullScreenBtn).not.toBeVisible();
+      await expect(visibleChrome).toBeVisible();
+      await expect(hiddenChrome).not.toBeVisible();
+      await expect(baseMapBtn).toBeVisible();
+
+      await fullScreenBtn.click();
+
+      await expect(fullScreenBtn).not.toBeVisible();
+      await expect(exitFullScreenBtn).toBeVisible();
+      await expect(visibleChrome).not.toBeVisible();
+      await expect(hiddenChrome).toBeVisible();
+      await expect(baseMapBtn).toBeVisible();
+
+      await exitFullScreenBtn.click();
+
+      await expect(fullScreenBtn).toBeVisible();
+    });
+  }
+);

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,6 @@`
`27`	`27`	`"@kbn/mock-idp-utils",`
`28`	`28`	`"@kbn/test-subj-selector",`
`29`	`29`	`"@kbn/scout-info",`
`30`		`- "@kbn/scout-reporting"`
	`30`	`+ "@kbn/scout-reporting",`
`31`	`31`	`]`
`32`	`32`	`}`