[8.6] [DOCS] Automate transform rule screenshots (#151087) (#151779)

# Backport This will backport the following commits from `main` to `8.6`: - [[DOCS] Automate transform rule screenshots (#151087)](https://github.com/elastic/kibana/pull/151087)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) \n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sqren/backport)\n\n\n\nCo-authored-by: Lisa Cawley <lcawley@elastic.co>"}},{"branch":"8.6","label":"v8.6.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.8.0","labelRegex":"^v8.8.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/151087","number":151087,"mergeCommit":{"message":"[DOCS] Automate transform rule screenshots (#151087)","sha":"6f4cbe21ccabf80b08e27acd54d82bdbd2d2ddb0"}}]}] BACKPORT-->
2025-04-24 01:38:56 -04:00 · 2023-02-21 12:12:45 -08:00 · 2023-02-21 12:12:45 -08:00 · 2ea3206504
commit 2ea3206504
parent ef9b5b2d80
6 changed files with 176 additions and 3 deletions
--- a/x-pack/test/functional/services/transform/alerting.ts
+++ b/x-pack/test/functional/services/transform/alerting.ts
@ -0,0 +1,59 @@
+/*
+ * 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 { FtrProviderContext } from '../../ftr_provider_context';
+
+export function TransformAlertingProvider({ getService }: FtrProviderContext) {
+  const retry = getService('retry');
+  const testSubjects = getService('testSubjects');
+  const comboBox = getService('comboBox');
+  return {
+    async selectTransformAlertType() {
+      await retry.tryForTime(5000, async () => {
+        await testSubjects.click('transform_health-SelectOption');
+        await testSubjects.existOrFail(`transformHealthAlertingRuleForm`, { timeout: 1000 });
+      });
+    },
+
+    async selectTransforms(transformIds: string[]) {
+      for (const transformId of transformIds) {
+        await comboBox.set('transformSelection > comboBoxInput', transformId);
+      }
+      await this.assertTransformSelection(transformIds);
+    },
+
+    async assertTransformSelection(expectedTransformIds: string[]) {
+      const comboBoxSelectedOptions = await comboBox.getComboBoxSelectedOptions(
+        'transformSelection > comboBoxInput'
+      );
+      expect(comboBoxSelectedOptions).to.eql(
+        expectedTransformIds,
+        `Expected job selection to be '${expectedTransformIds}' (got '${comboBoxSelectedOptions}')`
+      );
+    },
+
+    async openAddRuleVariable() {
+      await retry.tryForTime(5000, async () => {
+        await testSubjects.click('messageAddVariableButton');
+        await testSubjects.existOrFail('variableMenuButton-alert.actionGroup', { timeout: 1000 });
+      });
+    },
+
+    async setRuleName(rulename: string) {
+      await testSubjects.setValue('ruleNameInput', rulename);
+    },
+
+    async clickCancelSaveRuleButton() {
+      await retry.tryForTime(5000, async () => {
+        await testSubjects.click('cancelSaveRuleButton');
+        await testSubjects.existOrFail('confirmModalTitleText', { timeout: 1000 });
+        await testSubjects.click('confirmModalConfirmButton');
+      });
+    },
+  };
+}
--- a/x-pack/test/functional/services/transform/index.ts
+++ b/x-pack/test/functional/services/transform/index.ts
@ -18,6 +18,7 @@ import { TransformSourceSelectionProvider } from './source_selection';
 import { TransformTableProvider } from './transform_table';
 import { TransformTestExecutionProvider } from './test_execution';
 import { TransformWizardProvider } from './wizard';
+import { TransformAlertingProvider } from './alerting';

 import { MachineLearningAPIProvider } from '../ml/api';
 import { MachineLearningTestResourcesProvider } from '../ml/test_resources';
@ -36,8 +37,10 @@ export function TransformProvider(context: FtrProviderContext) {
  const testExecution = TransformTestExecutionProvider(context);
  const testResources = MachineLearningTestResourcesProvider(context, mlApi);
  const wizard = TransformWizardProvider(context);
+  const alerting = TransformAlertingProvider(context);

  return {
+    alerting,
    api,
    discover,
    editFlyout,
--- a/x-pack/test/functional/services/transform/navigation.ts
+++ b/x-pack/test/functional/services/transform/navigation.ts
@ -7,12 +7,19 @@

 import { FtrProviderContext } from '../../ftr_provider_context';

-export function TransformNavigationProvider({ getPageObjects }: FtrProviderContext) {
-  const PageObjects = getPageObjects(['common']);
+export function TransformNavigationProvider({ getPageObjects, getService }: FtrProviderContext) {
+  const pageObjects = getPageObjects(['common']);
+  const testSubjects = getService('testSubjects');

  return {
    async navigateTo() {
-      return await PageObjects.common.navigateToApp('transform');
+      return await pageObjects.common.navigateToApp('transform');
+    },
+
+    async navigateToRules() {
+      await pageObjects.common.navigateToApp('triggersActions');
+      await testSubjects.click('rulesTab');
+      await testSubjects.existOrFail('rulesList');
    },
  };
 }
--- a/x-pack/test/screenshot_creation/apps/index.ts
+++ b/x-pack/test/screenshot_creation/apps/index.ts
@ -11,5 +11,6 @@ export default function ({ loadTestFile }: FtrProviderContext) {
  describe('apps', function () {
    loadTestFile(require.resolve('./ml_docs'));
    loadTestFile(require.resolve('./response_ops_docs'));
+    loadTestFile(require.resolve('./transform_docs'));
  });
 }
--- a/x-pack/test/screenshot_creation/apps/transform_docs/index.ts
+++ b/x-pack/test/screenshot_creation/apps/transform_docs/index.ts
@ -0,0 +1,36 @@
+/*
+ * 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 { esTestConfig } from '@kbn/test';
+import { FtrProviderContext } from '../../ftr_provider_context';
+
+export default function ({ getPageObject, getService, loadTestFile }: FtrProviderContext) {
+  const browser = getService('browser');
+  const ml = getService('ml');
+  const securityPage = getPageObject('security');
+
+  describe('transform docs', function () {
+    this.tags(['transforms']);
+
+    before(async () => {
+      await ml.testResources.setKibanaTimeZoneToUTC();
+      await ml.testResources.disableKibanaAnnouncements();
+      await browser.setWindowSize(1920, 1080);
+      await securityPage.login(
+        esTestConfig.getUrlParts().username,
+        esTestConfig.getUrlParts().password
+      );
+    });
+
+    after(async () => {
+      await securityPage.forceLogout();
+      await ml.testResources.resetKibanaTimeZone();
+      await ml.testResources.resetKibanaAnnouncements();
+    });
+
+    loadTestFile(require.resolve('./transform_alerts'));
+  });
+}
--- a/x-pack/test/screenshot_creation/apps/transform_docs/transform_alerts.ts
+++ b/x-pack/test/screenshot_creation/apps/transform_docs/transform_alerts.ts
@ -0,0 +1,67 @@
+/*
+ * 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 { FtrProviderContext } from '../../ftr_provider_context';
+
+export default function ({ getPageObjects, getService }: FtrProviderContext) {
+  const actions = getService('actions');
+  const browser = getService('browser');
+  const commonScreenshots = getService('commonScreenshots');
+  const testSubjects = getService('testSubjects');
+  const transform = getService('transform');
+  const screenshotDirectories = ['transform_docs'];
+  const pageObjects = getPageObjects(['triggersActionsUI']);
+
+  let testTransformId = '';
+
+  describe('transform alerts', function () {
+    before(async () => {
+      await browser.setWindowSize(1920, 1080);
+      await actions.api.createConnector({
+        name: 'server-log-connector',
+        config: {},
+        secrets: {},
+        connectorTypeId: '.server-log',
+      });
+    });
+
+    after(async () => {
+      await actions.api.deleteAllConnectors();
+    });
+
+    it('transform rule screenshot', async () => {
+      await transform.testExecution.logTestStep('navigate to stack management rules');
+      await transform.navigation.navigateToRules();
+      await pageObjects.triggersActionsUI.clickCreateAlertButton();
+      await transform.alerting.setRuleName('transform-health-rule');
+
+      await transform.testExecution.logTestStep(
+        'search for transform rule type and take screenshot'
+      );
+      const searchBox = await testSubjects.find('ruleSearchField');
+      await searchBox.click();
+      await searchBox.clearValue();
+      await searchBox.type('transform');
+      await searchBox.pressKeys(browser.keys.ENTER);
+      await commonScreenshots.takeScreenshot('transform-rule', screenshotDirectories);
+
+      await transform.testExecution.logTestStep('select transform details and take screenshot');
+      await transform.alerting.selectTransformAlertType();
+      testTransformId = '*';
+      await transform.alerting.selectTransforms([testTransformId]);
+      await commonScreenshots.takeScreenshot('transform-check-config', screenshotDirectories);
+
+      await transform.testExecution.logTestStep(
+        'add server log connector and take action variable screenshot'
+      );
+      await testSubjects.click('.server-log-alerting-ActionTypeSelectOption');
+      await transform.alerting.openAddRuleVariable();
+      await commonScreenshots.takeScreenshot('transform-alert-actions', screenshotDirectories);
+      await transform.alerting.clickCancelSaveRuleButton();
+    });
+  });
+}