[8.10] [DOCS] Automate Elasticsearch query rule screenshots (#164127) (…

…#164629) # Backport This will backport the following commits from `main` to `8.10`: - [[DOCS] Automate Elasticsearch query rule screenshots (#164127)](#164127)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Lisa Cawley <[email protected]>
elastic · Aug 23, 2023 · e1a7190 · e1a7190
1 parent 7552ff2
commit e1a7190
Show file tree

Hide file tree

Showing 6 changed files with 118 additions and 2 deletions.
diff --git a/docs/user/alerting/images/rule-types-es-query-conditions.png b/docs/user/alerting/images/rule-types-es-query-conditions.png
diff --git a/docs/user/alerting/images/rule-types-es-query-invalid.png b/docs/user/alerting/images/rule-types-es-query-invalid.png
diff --git a/docs/user/alerting/images/rule-types-es-query-valid.png b/docs/user/alerting/images/rule-types-es-query-valid.png
diff --git a/docs/user/alerting/rule-types/es-query.asciidoc b/docs/user/alerting/rule-types/es-query.asciidoc
@@ -23,7 +23,8 @@ Fill in the name and optional tags, then select
 Define properties to detect the condition.
 
 [role="screenshot"]
-image::user/alerting/images/rule-types-es-query-conditions.png[Eight clauses define the condition to detect]
+image::user/alerting/images/rule-types-es-query-conditions.png[Define the condition to detect]
+// NOTE: This is an autogenerated screenshot. Do not edit it directly.
 
 Define your query::
 If you chose the query DSL option, you must specify indices to query and a time field that is used for the time window. You must then define a query in {es} query DSL. Only the `query`, `fields`, `_source` and `runtime_mappings` fields are used, other DSL fields are not considered.
@@ -122,11 +123,13 @@ Use the *Test query* feature to verify that your query DSL is valid.
 +
 [role="screenshot"]
 image::user/alerting/images/rule-types-es-query-valid.png[Test {es} query returns number of matches when valid]
+// NOTE: This is an autogenerated screenshot. Do not edit it directly.
 
 * An error message is shown if the query is invalid.
 +
 [role="screenshot"]
 image::user/alerting/images/rule-types-es-query-invalid.png[Test {es} query shows error when invalid]
+// NOTE: This is an autogenerated screenshot. Do not edit it directly.
 
 [float]
 === Handling multiple matches of the same document

diff --git a/x-pack/test/screenshot_creation/apps/response_ops_docs/stack_alerting/es_query_rule.ts b/x-pack/test/screenshot_creation/apps/response_ops_docs/stack_alerting/es_query_rule.ts
@@ -0,0 +1,112 @@
+/*
+ * 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 ({ getService, getPageObjects }: FtrProviderContext) {
+  const browser = getService('browser');
+  const commonScreenshots = getService('commonScreenshots');
+  const find = getService('find');
+  const rules = getService('rules');
+  const testSubjects = getService('testSubjects');
+  const pageObjects = getPageObjects(['common', 'header']);
+  const screenshotDirectories = ['response_ops_docs', 'stack_alerting'];
+  const ruleName = 'test query rule';
+
+  const validQueryJson = JSON.stringify({
+    query: {
+      bool: {
+        filter: [
+          {
+            term: {
+              'host.keyword': 'www.elastic.co',
+            },
+          },
+        ],
+      },
+    },
+  });
+  const invalidQueryJson = JSON.stringify({
+    query: {
+      bool: {
+        filter: [
+          {
+            error_clause: {
+              'host.keyword': 'www.elastic.co',
+            },
+          },
+        ],
+      },
+    },
+  });
+
+  describe('elasticsearch query rule', function () {
+    it('create rule screenshot', async () => {
+      await pageObjects.common.navigateToApp('triggersActions');
+      await pageObjects.header.waitUntilLoadingHasFinished();
+      await rules.common.clickCreateAlertButton();
+      await testSubjects.scrollIntoView('ruleNameInput');
+      await testSubjects.setValue('ruleNameInput', ruleName);
+      await testSubjects.click(`.es-query-SelectOption`);
+      await testSubjects.click('queryFormType_esQuery');
+      const indexSelector = await testSubjects.find('selectIndexExpression');
+      await indexSelector.click();
+      const indexComboBox = await find.byCssSelector('#indexSelectSearchBox');
+      await indexComboBox.type('kibana_sample_data_logs ');
+      const filterSelectItem = await find.byCssSelector(`.euiFilterSelectItem`);
+      await filterSelectItem.click();
+      await testSubjects.click('thresholdAlertTimeFieldSelect');
+      await testSubjects.setValue('thresholdAlertTimeFieldSelect', '@timestamp');
+      await testSubjects.click('closePopover');
+      await commonScreenshots.takeScreenshot(
+        'rule-types-es-query-conditions',
+        screenshotDirectories,
+        1400,
+        1500
+      );
+      // Test a valid query
+      await testSubjects.setValue('queryJsonEditor', '', {
+        clearWithKeyboard: true,
+      });
+      const queryJsonEditor = await testSubjects.find('queryJsonEditor');
+      await queryJsonEditor.clearValue();
+      await testSubjects.setValue('queryJsonEditor', validQueryJson, {
+        clearWithKeyboard: true,
+      });
+      await testSubjects.click('forLastExpression');
+      await testSubjects.setValue('timeWindowSizeNumber', '1');
+      await testSubjects.setValue('timeWindowUnitSelect', 'day');
+      await browser.pressKeys(browser.keys.ESCAPE);
+      await testSubjects.click('testQuery');
+      await testSubjects.scrollIntoView('ruleNameInput');
+      await commonScreenshots.takeScreenshot(
+        'rule-types-es-query-valid',
+        screenshotDirectories,
+        1400,
+        1500
+      );
+      // Test an invalid query
+      await testSubjects.setValue('queryJsonEditor', '', {
+        clearWithKeyboard: true,
+      });
+      await queryJsonEditor.clearValue();
+      await testSubjects.setValue('queryJsonEditor', invalidQueryJson, {
+        clearWithKeyboard: true,
+      });
+      await testSubjects.click('testQuery');
+      await testSubjects.scrollIntoView('ruleNameInput');
+      await pageObjects.header.waitUntilLoadingHasFinished();
+      await commonScreenshots.takeScreenshot(
+        'rule-types-es-query-invalid',
+        screenshotDirectories,
+        1400,
+        1500
+      );
+      await testSubjects.click('cancelSaveRuleButton');
+    });
+  });
+}
diff --git a/x-pack/test/screenshot_creation/apps/response_ops_docs/stack_alerting/index.ts b/x-pack/test/screenshot_creation/apps/response_ops_docs/stack_alerting/index.ts
@@ -100,8 +100,9 @@ export default function ({ loadTestFile, getService }: FtrProviderContext) {
       await actions.api.deleteAllConnectors();
     });
 
-    loadTestFile(require.resolve('./list_view'));
+    loadTestFile(require.resolve('./es_query_rule'));
     loadTestFile(require.resolve('./index_threshold_rule'));
+    loadTestFile(require.resolve('./list_view'));
     loadTestFile(require.resolve('./metrics_threshold_rule'));
     loadTestFile(require.resolve('./tracking_containment_rule'));
   });