[8.19] [Search][Query Rules UI] FTR tests (#223553)

x-pack/solutions/search/plugins/search_query_rules/public/components/query_rules_sets/delete_ruleset_modal.tsx

@@ -76,6 +76,7 @@ export const DeleteRulesetModal = ({
       <EuiCheckbox
         id={confirmCheckboxId}
         label="This ruleset is safe to delete"
+        data-test-subj="confirmDeleteRulesetCheckbox"
         checked={checked}
         onChange={(e) => {
           setChecked(e.target.checked);

x-pack/solutions/search/plugins/search_query_rules/public/components/query_rules_sets/query_rules_sets.tsx

@@ -132,6 +132,7 @@ export const QueryRulesSets = () => {
           icon: 'trash',
           color: 'danger',
           type: 'icon',
+          'data-test-subj': 'queryRulesSetDeleteButton',
           isPrimary: true,
           onClick: (ruleset: QueryRulesListRulesetsQueryRulesetListItem) => {
             useTracker?.click?.(AnalyticsEvents.deleteRulesetInlineDropdownClicked);

x-pack/solutions/search/plugins/search_query_rules/public/components/query_ruleset_detail/query_rule_flyout/query_rule_flyout.tsx

@@ -119,6 +119,7 @@ export const QueryRuleFlyout: React.FC<QueryRuleFlyoutProps> = ({
       onClose={onClose}
       ownFocus={false}
       size="l"
+      data-test-subj="searchQueryRulesQueryRuleFlyout"
       aria-labelledby="flyoutTitle"
       css={css({
         overflowY: 'hidden',

x-pack/solutions/search/plugins/search_query_rules/public/components/query_ruleset_detail/query_rule_flyout/query_rule_metadata_editor.tsx

@@ -40,7 +40,7 @@ export const QueryRuleMetadataEditor: React.FC<QueryRuleMetadataEditorProps> = (
   const [metadataField, setMetadataField] = useState<string>(criteria.metadata || '');
 
   return (
-    <EuiPanel hasBorder>
+    <EuiPanel data-test-subj="searchQueryRulesQueryRuleMetadataEditor" hasBorder>
       <EuiFlexGroup direction="row">
         <EuiFlexItem>
           <EuiFormRow

x-pack/solutions/search/plugins/search_query_rules/public/components/query_ruleset_detail/query_ruleset_detail.tsx

@@ -240,6 +240,7 @@ export const QueryRulesetDetail: React.FC<QueryRulesetDetailProps> = ({ createMo
                   })}
                 </>
               ),
+              'data-test-subj': 'queryRulesetDetailBackButton',
               color: 'primary',
               'aria-current': false,
               onClick: () => {
@@ -371,7 +372,7 @@ export const QueryRulesetDetail: React.FC<QueryRulesetDetailProps> = ({ createMo
                     id={splitButtonPopoverActionsId}
                     button={
                       <EuiButtonIcon
-                        data-test-subj="searchQueryRulesQueryRulesetDetailButton"
+                        data-test-subj="searchQueryRulesQueryRulesetActionsButton"
                         size="m"
                         iconType="boxesVertical"
                         aria-label="More"

x-pack/test/functional/page_objects/index.ts

@@ -55,6 +55,7 @@ import { UptimePageObject } from './uptime_page';
 import { UserProfilePageProvider } from './user_profile_page';
 import { SearchPlaygroundPageProvider } from './search_playground_page';
 import { SearchSynonymsPageProvider } from './search_synonyms_page';
+import { SearchQueryRulesPageProvider } from './search_query_rules_page';
 import { SearchClassicNavigationProvider } from './search_classic_navigation';
 
 // just like services, PageObjects are defined as a map of
@@ -99,6 +100,7 @@ export const pageObjects = {
   searchProfiler: SearchProfilerPageProvider,
   searchPlayground: SearchPlaygroundPageProvider,
   searchSynonyms: SearchSynonymsPageProvider,
+  searchQueryRules: SearchQueryRulesPageProvider,
   searchSessionsManagement: SearchSessionsPageProvider,
   security: SecurityPageObject,
   shareSavedObjectsToSpace: ShareSavedObjectsToSpacePageProvider,

x-pack/test/functional/page_objects/search_query_rules_page.ts

@@ -0,0 +1,260 @@
+/*
+ * 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 { Key } from 'selenium-webdriver';
+import { FtrProviderContext } from '../ftr_provider_context';
+
+export function SearchQueryRulesPageProvider({ getService }: FtrProviderContext) {
+  const testSubjects = getService('testSubjects');
+  const find = getService('find');
+  const comboBox = getService('comboBox');
+  const browser = getService('browser');
+
+  return {
+    QueryRulesEmptyPromptPage: {
+      TEST_IDS: {
+        GET_STARTED_BUTTON: 'searchQueryRulesEmptyPromptGetStartedButton',
+      },
+      async expectQueryRulesEmptyPromptPageComponentsToExist() {
+        await testSubjects.existOrFail(this.TEST_IDS.GET_STARTED_BUTTON);
+      },
+      async clickCreateQueryRulesSetButton() {
+        await testSubjects.click(this.TEST_IDS.GET_STARTED_BUTTON);
+      },
+    },
+    QueryRulesManagementPage: {
+      TEST_IDS: {
+        QUERY_RULES_RULESETS_TABLE: 'queryRulesSetTable',
+        QUERY_RULES_ITEM_NAME: 'queryRuleSetName',
+        QUERY_RULES_ITEM_RULE_COUNT: 'queryRuleSetItemRuleCount',
+        QUERY_RULES_ITEM_ACTIONS_DELETE_BUTTON: 'queryRulesSetDeleteButton',
+        CREATE_RULESET_BUTTON: 'queryRulesOverviewCreateButton',
+        PAGINATION_NEXT_BUTTON: 'pagination-button-next',
+        PAGINATION_PREVIOUS_BUTTON: 'pagination-button-previous',
+      },
+      async clickCreateQueryRulesRulesetButton() {
+        await testSubjects.click(this.TEST_IDS.CREATE_RULESET_BUTTON);
+      },
+      async expectQueryRulesTableToExist() {
+        await testSubjects.existOrFail(this.TEST_IDS.QUERY_RULES_RULESETS_TABLE);
+      },
+      async getQueryRulesRulesetsList() {
+        const table = await testSubjects.find(this.TEST_IDS.QUERY_RULES_RULESETS_TABLE);
+        const allRows = await table
+          .findByTagName('tbody')
+          .then((tbody) => tbody.findAllByTagName('tr'));
+
+        return Promise.all(
+          allRows.map(async (row) => {
+            const $ = await row.parseDomContent();
+            return {
+              name: $.findTestSubject(this.TEST_IDS.QUERY_RULES_ITEM_NAME).text().trim(),
+              ruleCount: Number(
+                $.findTestSubject(this.TEST_IDS.QUERY_RULES_ITEM_RULE_COUNT).text()
+              ),
+            };
+          })
+        );
+      },
+      async clickRuleset(name: string) {
+        // find rulesets with name and click on it
+        const table = await testSubjects.findAll(this.TEST_IDS.QUERY_RULES_ITEM_NAME);
+        for (const item of table) {
+          const text = await item.getVisibleText();
+          if (text === name) {
+            await item.click();
+            return;
+          }
+        }
+        throw new Error(`Ruleset with name "${name}" not found`);
+      },
+      async clickDeleteRulesetRow(index: number) {
+        const table = await testSubjects.find(this.TEST_IDS.QUERY_RULES_RULESETS_TABLE);
+        const allRows = await table
+          .findByTagName('tbody')
+          .then((tbody) => tbody.findAllByTagName('tr'));
+        const deleteButton = await allRows[index].findByTestSubject(
+          this.TEST_IDS.QUERY_RULES_ITEM_ACTIONS_DELETE_BUTTON
+        );
+        await deleteButton.click();
+      },
+      async expectQueryRulesListPageComponentsToExist() {
+        await testSubjects.existOrFail(this.TEST_IDS.QUERY_RULES_RULESETS_TABLE);
+        await testSubjects.existOrFail(this.TEST_IDS.QUERY_RULES_ITEM_RULE_COUNT);
+      },
+      async clickPaginationNext() {
+        await testSubjects.click(this.TEST_IDS.PAGINATION_NEXT_BUTTON);
+      },
+      async clickPaginationPrevious() {
+        await testSubjects.click(this.TEST_IDS.PAGINATION_PREVIOUS_BUTTON);
+      },
+    },
+    QueryRulesDetailPage: {
+      TEST_IDS: {
+        RULESET_DETAILS_PAGE_BACK_BUTTON: 'queryRulesetDetailBackButton',
+        RULESET_DETAILS_PAGE_SAVE_BUTTON: 'queryRulesetDetailHeaderSaveButton',
+        RULESET_DETAILS_PAGE_HEADER: 'queryRulesetDetailHeader',
+        RULESET_DETAILS_PAGE_ACTIONS_BUTTON: 'searchQueryRulesQueryRulesetActionsButton',
+        RULESET_DETAILS_PAGE_DELETE_BUTTON: 'queryRulesetDetailDeleteButton',
+        RULESET_RULES_CONTAINER: 'searchQueryRulesDroppable',
+        RULESET_RULE_ITEM_NAME: 'searchQueryRulesDraggableItem',
+        RULESET_RULE_ITEM_ACTIONS_BUTTON: 'searchQueryRulesQueryRulesetDetailButton',
+        RULESET_RULE_ITEM_ACTIONS_DELETE_BUTTON: 'searchQueryRulesQueryRulesetDetailDeleteButton',
+        RULESET_RULE_ITEM_ACTIONS_EDIT_BUTTON: 'searchQueryRulesQueryRulesetDetailEditButton',
+      },
+      async expectQueryRulesDetailPageNavigated(name: string) {
+        const h1Element = await find.byCssSelector(
+          `main header[data-test-subj="${this.TEST_IDS.RULESET_DETAILS_PAGE_HEADER}"] h1`
+        );
+        const text = await h1Element.getVisibleText();
+        if (text !== name) {
+          throw new Error(`Expected page title to be "${name}" but got "${text}"`);
+        }
+      },
+      async expectQueryRulesDetailPageBackButtonToExist() {
+        await testSubjects.existOrFail(this.TEST_IDS.RULESET_DETAILS_PAGE_BACK_BUTTON);
+      },
+      async expectQueryRulesDetailPageSaveButtonToExist() {
+        await testSubjects.existOrFail(this.TEST_IDS.RULESET_DETAILS_PAGE_SAVE_BUTTON);
+      },
+      async clickQueryRulesDetailPageSaveButton() {
+        await testSubjects.click(this.TEST_IDS.RULESET_DETAILS_PAGE_SAVE_BUTTON);
+      },
+      async clickQueryRulesDetailPageActionsButton() {
+        await testSubjects.click(this.TEST_IDS.RULESET_DETAILS_PAGE_ACTIONS_BUTTON);
+      },
+      async clickQueryRulesDetailPageDeleteButton() {
+        await testSubjects.click(this.TEST_IDS.RULESET_DETAILS_PAGE_DELETE_BUTTON);
+      },
+      async clickEditRulesetRule(id: number) {
+        const items = await testSubjects.findAll(this.TEST_IDS.RULESET_RULE_ITEM_NAME);
+        if (items[id]) {
+          const actionButton = await items[id].findByTestSubject(
+            this.TEST_IDS.RULESET_RULE_ITEM_ACTIONS_BUTTON
+          );
+          await actionButton.click();
+          await testSubjects.click(this.TEST_IDS.RULESET_RULE_ITEM_ACTIONS_EDIT_BUTTON);
+        } else {
+          throw new Error(`Ruleset rule with id "${id}" not found`);
+        }
+      },
+    },
+    QueryRulesCreateRulesetModal: {
+      TEST_IDS: {
+        CREATE_QUERY_RULES_SET_MODAL_INPUT: 'searchRulesetCreateRulesetModalFieldText',
+        CREATE_QUERY_RULES_SET_MODAL_CREATE_BUTTON: 'searchRulesetCreateRulesetModalCreateButton',
+      },
+      async setQueryRulesSetName(name: string) {
+        await testSubjects.setValue(this.TEST_IDS.CREATE_QUERY_RULES_SET_MODAL_INPUT, name);
+      },
+      async clickSaveButton() {
+        await testSubjects.click(this.TEST_IDS.CREATE_QUERY_RULES_SET_MODAL_CREATE_BUTTON);
+      },
+    },
+    QueryRulesDeleteRulesetModal: {
+      TEST_IDS: {
+        DELETE_QUERY_RULES_RULESET_MODAL_DELETE_BUTTON:
+          'searchRulesetDeleteRulesetModalDeleteButton',
+        DELETE_QUERY_RULES_RULESET_MODAL_ACKNOWLEDGE_BUTTON: 'confirmDeleteRulesetCheckbox',
+        DELETE_QUERY_RULES_RULESET_MODAL_CANCEL_BUTTON:
+          'searchRulesetDeleteRulesetModalCancelButton',
+      },
+      async clickDeleteButton() {
+        await testSubjects.click(this.TEST_IDS.DELETE_QUERY_RULES_RULESET_MODAL_DELETE_BUTTON);
+      },
+      async clickAcknowledgeButton() {
+        await testSubjects.click(this.TEST_IDS.DELETE_QUERY_RULES_RULESET_MODAL_ACKNOWLEDGE_BUTTON);
+      },
+      async clickCancelButton() {
+        await testSubjects.click(this.TEST_IDS.DELETE_QUERY_RULES_RULESET_MODAL_CANCEL_BUTTON);
+      },
+      async clickConfirmDeleteModal() {
+        await testSubjects.click('confirmModalConfirmButton');
+      },
+    },
+    QueryRulesRuleFlyout: {
+      TEST_IDS: {
+        RULE_FLYOUT: 'searchQueryRulesQueryRuleFlyout',
+        RULE_FLYOUT_UPDATE_BUTTON: 'searchQueryRulesQueryRuleFlyoutUpdateButton',
+        RULE_FLYOUT_PIN_MORE_BUTTON: 'searchQueryRulesPinMoreButton',
+        RULE_FLYOUT_METADATA_ADD_BUTTON: 'searchQueryRulesQueryRuleMetadataEditorAddCriteriaButton',
+        RULE_FLYOUT_DOCUMENT_DRAGGABLE_ID: 'editableResultDocumentId',
+        RULE_FLYOUT_DOCUMENT_INDEX: 'editableResultIndexSelector',
+        RULE_FLYOUT_ACTION_TYPE_EXCLUDE: 'searchQueryRulesQueryRuleActionTypeExclude',
+        RULE_FLYOUT_ACTION_TYPE_PINNED: 'searchQueryRulesQueryRuleActionTypePinned',
+        RULE_FLYOUT_CRITERIA_CUSTOM: 'searchQueryRulesQueryRuleCriteriaCustom',
+        RULE_FLYOUT_CRITERIA_ALWAYS: 'searchQueryRulesQueryRuleCriteriaAlways',
+        RULE_FLYOUT_CRITERIA_METADATA_BLOCK: 'searchQueryRulesQueryRuleMetadataEditor',
+        RULE_FLYOUT_CRITERIA_METADATA_BLOCK_FIELD: 'searchQueryRulesQueryRuleMetadataEditorField',
+        RULE_FLYOUT_CRITERIA_METADATA_BLOCK_VALUES: 'searchQueryRulesQueryRuleMetadataEditorValues',
+      },
+      async expectRuleFlyoutToExist() {
+        await testSubjects.existOrFail(this.TEST_IDS.RULE_FLYOUT);
+      },
+      async clickUpdateButton() {
+        await testSubjects.click(this.TEST_IDS.RULE_FLYOUT_UPDATE_BUTTON);
+      },
+      async clickActionTypeExclude() {
+        await testSubjects.click(this.TEST_IDS.RULE_FLYOUT_ACTION_TYPE_EXCLUDE);
+      },
+      async clickActionTypePinned() {
+        await testSubjects.click(this.TEST_IDS.RULE_FLYOUT_ACTION_TYPE_PINNED);
+      },
+      async clickCriteriaCustom() {
+        await testSubjects.click(this.TEST_IDS.RULE_FLYOUT_CRITERIA_CUSTOM);
+      },
+      async clickCriteriaAlways() {
+        await testSubjects.click(this.TEST_IDS.RULE_FLYOUT_CRITERIA_ALWAYS);
+      },
+      async changeDocumentIdField(id: number, newValue: string = '') {
+        const documentFields = await testSubjects.findAll(
+          this.TEST_IDS.RULE_FLYOUT_DOCUMENT_DRAGGABLE_ID
+        );
+        if (documentFields[id]) {
+          const targetField = documentFields[id];
+          await targetField.click();
+          await targetField.type(newValue);
+        } else {
+          await testSubjects.click(this.TEST_IDS.RULE_FLYOUT_PIN_MORE_BUTTON);
+          await this.changeDocumentIdField(id);
+        }
+      },
+      async changeDocumentIndexField(id: number, newValue: string = '') {
+        const comboBoxes = await testSubjects.findAll(this.TEST_IDS.RULE_FLYOUT_DOCUMENT_INDEX);
+        if (comboBoxes[id]) {
+          const targetComboBox = comboBoxes[id];
+          await targetComboBox.click();
+          await comboBox.setCustom(this.TEST_IDS.RULE_FLYOUT_DOCUMENT_INDEX, newValue);
+          // Press tab to ensure the value is set correctly
+          await browser.pressKeys(Key.TAB);
+        }
+      },
+      async changeMetadataField(id: number, newValue: string = '') {
+        const metadataFields = await testSubjects.findAll(
+          this.TEST_IDS.RULE_FLYOUT_CRITERIA_METADATA_BLOCK
+        );
+        if (metadataFields[id]) {
+          const targetMetadataBlock = metadataFields[id];
+          const targetField = await targetMetadataBlock.findByTestSubject(
+            this.TEST_IDS.RULE_FLYOUT_CRITERIA_METADATA_BLOCK_FIELD
+          );
+          await targetField.click();
+          await targetField.type(newValue);
+        } else {
+          await testSubjects.click(this.TEST_IDS.RULE_FLYOUT_METADATA_ADD_BUTTON);
+          await this.changeMetadataField(id);
+        }
+      },
+      async changeMetadataValues(_: number, newValue: string = '') {
+        await comboBox.setCustom(
+          this.TEST_IDS.RULE_FLYOUT_CRITERIA_METADATA_BLOCK_VALUES,
+          newValue
+        );
+      },
+    },
+  };
+}

x-pack/test_serverless/functional/test_suites/search/config.feature_flags.ts

@@ -26,6 +26,8 @@ export default createTestConfig({
     `--xpack.cloud.organization_url=/account/members`,
     `--xpack.security.roleManagementEnabled=true`,
     `--xpack.spaces.maxSpaces=100`, // enables spaces UI capabilities
+    `--uiSettings.overrides.queryRules:queryRulesEnabled=true`,
+    '--xpack.searchQueryRules.enabled=true',
   ],
   // load tests in the index file
   testFiles: [require.resolve('./index.feature_flags.ts')],
@@ -46,6 +48,9 @@ export default createTestConfig({
     searchSynonyms: {
       pathname: '/app/elasticsearch/search_synonyms',
     },
+    searchQueryRules: {
+      pathname: '/app/elasticsearch/query_rules',
+    },
     elasticsearchStart: {
       pathname: '/app/elasticsearch/start',
     },

x-pack/test_serverless/functional/test_suites/search/index.feature_flags.ts

@@ -15,5 +15,6 @@ export default function ({ loadTestFile }: FtrProviderContext) {
     loadTestFile(require.resolve('../common/platform_security/roles.ts'));
     loadTestFile(require.resolve('../common/spaces/multiple_spaces_enabled.ts'));
     loadTestFile(require.resolve('./search_synonyms/search_synonyms_overview'));
+    loadTestFile(require.resolve('./search_query_rules/search_query_rules_overview'));
   });
 }