[scout] An abstraction for extending pageObjects

src/platform/packages/shared/kbn-scout/index.ts

@@ -19,6 +19,8 @@ export {
   apiTest,
   globalSetupHook,
   tags,
+  createTest,
+  AbstractPageObject,
 } from './src/playwright';
 
 // Fixtures & configuration

src/platform/packages/shared/kbn-scout/src/playwright/index.ts

@@ -49,3 +49,5 @@ export { apiTest } from './test/api';
 
 // Test helpers for EUI components
 export * from './eui_components';
+
+export * from './test/utils';

src/platform/packages/shared/kbn-scout/src/playwright/test/utils/abstract_page_object.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
+ * 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 type { ScoutPage } from '../../../..';
+
+export class AbstractPageObject {
+  constructor(public readonly page: ScoutPage) {}
+}

src/platform/packages/shared/kbn-scout/src/playwright/test/utils/create_test.ts

@@ -0,0 +1,57 @@
+/*
+ * 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 { test as base } from '../../../..';
+import type { ScoutPage, ScoutTestFixtures, ScoutWorkerFixtures } from '../../../..';
+import type { PageObjects } from '../../../..';
+import { createLazyPageObject } from '../../../..';
+import type { AbstractPageObject } from './abstract_page_object';
+
+type PageObjectClass = new (page: ScoutPage) => AbstractPageObject;
+
+export const createTest = function <PageObjectsExtensions = Record<string, AbstractPageObject>>(
+  pageObjectClassMap: Record<string, PageObjectClass>
+) {
+  type PageObjectsExtended = PageObjectsExtensions & PageObjects;
+
+  function extendPOs(pageObjects: PageObjects, page: ScoutPage): PageObjectsExtended {
+    const initedLazyPageObjects = Object.keys(pageObjectClassMap).reduce<
+      Record<string, AbstractPageObject>
+    >((col, value) => {
+      col[value] = createLazyPageObject(pageObjectClassMap[value], page);
+      return col;
+    }, {});
+
+    return {
+      ...initedLazyPageObjects,
+      ...pageObjects,
+    } as PageObjectsExtended;
+  }
+
+  return base.extend<
+    ScoutTestFixtures & {
+      pageObjects: PageObjectsExtended;
+    },
+    ScoutWorkerFixtures
+  >({
+    pageObjects: async (
+      {
+        pageObjects,
+        page,
+      }: {
+        pageObjects: PageObjectsExtended;
+        page: ScoutPage;
+      },
+      use: (pageObjects: PageObjectsExtended) => Promise<void>
+    ) => {
+      const extendedPageObjects = extendPOs(pageObjects, page);
+      await use(extendedPageObjects);
+    },
+  });
+};

src/platform/packages/shared/kbn-scout/src/playwright/test/utils/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
+ * 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".
+ */
+
+export { createTest } from './create_test';
+export { AbstractPageObject } from './abstract_page_object';

x-pack/platform/plugins/private/discover_enhanced/test/scout/ui/fixtures/index.ts

@@ -8,11 +8,11 @@
 import type {
   PageObjects,
   ScoutTestFixtures,
-  ScoutWorkerFixtures,
   ScoutParallelTestFixtures,
   ScoutParallelWorkerFixtures,
 } from '@kbn/scout';
-import { test as baseTest, spaceTest as spaceBaseTest, createLazyPageObject } from '@kbn/scout';
+import { spaceTest as spaceBaseTest, createLazyPageObject } from '@kbn/scout';
+import { createTest } from '@kbn/scout';
 import { DemoPage } from './page_objects';
 
 export interface ExtScoutTestFixtures extends ScoutTestFixtures {
@@ -21,24 +21,10 @@ export interface ExtScoutTestFixtures extends ScoutTestFixtures {
   };
 }
 
-export const test = baseTest.extend<ExtScoutTestFixtures, ScoutWorkerFixtures>({
-  pageObjects: async (
-    {
-      pageObjects,
-      page,
-    }: {
-      pageObjects: ExtScoutTestFixtures['pageObjects'];
-      page: ExtScoutTestFixtures['page'];
-    },
-    use: (pageObjects: ExtScoutTestFixtures['pageObjects']) => Promise<void>
-  ) => {
-    const extendedPageObjects = {
-      ...pageObjects,
-      demo: createLazyPageObject(DemoPage, page),
-    };
-
-    await use(extendedPageObjects);
-  },
+export const test = createTest<{
+  demo: DemoPage;
+}>({
+  demo: DemoPage,
 });
 
 export interface ExtParallelRunTestFixtures extends ScoutParallelTestFixtures {

x-pack/platform/plugins/private/discover_enhanced/test/scout/ui/fixtures/page_objects/demo.ts

@@ -5,11 +5,9 @@
  * 2.0.
  */
 
-import type { ScoutPage } from '@kbn/scout';
-
-export class DemoPage {
-  constructor(private readonly page: ScoutPage) {}
+import { AbstractPageObject } from '@kbn/scout';
 
+export class DemoPage extends AbstractPageObject {
   async goto() {
     await this.page.gotoApp('not_implemented');
   }