OpenMetadata/openmetadata-ui/src/main/resources/ui/playwright/e2e/Features/AdvancedSearch.spec.ts

/*
 *  Copyright 2024 Collate.
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *  http://www.apache.org/licenses/LICENSE-2.0
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
import test from '@playwright/test';
import { SidebarItem } from '../../constant/sidebar';
import { TableClass } from '../../support/entity/TableClass';
import { TopicClass } from '../../support/entity/TopicClass';
import { TagClass } from '../../support/tag/TagClass';
import { UserClass } from '../../support/user/UserClass';
import {
  FIELDS,
  OPERATOR,
  runRuleGroupTests,
  verifyAllConditions,
} from '../../utils/advancedSearch';
import { createNewPage, redirectToHomePage } from '../../utils/common';
import { addMultiOwner, assignTag, assignTier } from '../../utils/entity';
import { sidebarClick } from '../../utils/sidebar';

test.describe('Advanced Search', { tag: '@advanced-search' }, () => {
  // use the admin user to login
  test.use({ storageState: 'playwright/.auth/admin.json' });

  const user1 = new UserClass();
  const user2 = new UserClass();
  const table1 = new TableClass();
  const table2 = new TableClass();
  const topic1 = new TopicClass();
  const topic2 = new TopicClass();
  const tierTag1 = new TagClass({ classification: 'Tier' });
  const tierTag2 = new TagClass({ classification: 'Tier' });

  let searchCriteria = {};

  test.beforeAll('Setup pre-requests', async ({ browser }) => {
    test.setTimeout(150000);

    const { page, apiContext, afterAction } = await createNewPage(browser);
    await Promise.all([
      user1.create(apiContext),
      user2.create(apiContext),
      table1.create(apiContext),
      table2.create(apiContext),
      topic1.create(apiContext),
      topic2.create(apiContext),
      tierTag1.create(apiContext),
      tierTag2.create(apiContext),
    ]);

    // Add Owner & Tag to the table
    await table1.visitEntityPage(page);
    await addMultiOwner({
      page,
      ownerNames: [user1.getUserName()],
      activatorBtnDataTestId: 'edit-owner',
      resultTestId: 'data-assets-header',
      endpoint: table1.endpoint,
      type: 'Users',
    });
    await assignTag(page, 'PersonalData.Personal');

    await table2.visitEntityPage(page);
    await addMultiOwner({
      page,
      ownerNames: [user2.getUserName()],
      activatorBtnDataTestId: 'edit-owner',
      resultTestId: 'data-assets-header',
      endpoint: table1.endpoint,
      type: 'Users',
    });
    await assignTag(page, 'PII.None');

    // Add Tier To the topic 1
    await topic1.visitEntityPage(page);
    await assignTier(page, tierTag1.data.displayName, topic1.endpoint);

    // Add Tier To the topic 2
    await topic2.visitEntityPage(page);
    await assignTier(page, tierTag2.data.displayName, topic2.endpoint);

    // Update Search Criteria here
    searchCriteria = {
      'owners.displayName.keyword': [user1.getUserName(), user2.getUserName()],
      'tags.tagFQN': ['PersonalData.Personal', 'PII.None'],
      'tier.tagFQN': [
        tierTag1.responseData.fullyQualifiedName,
        tierTag2.responseData.fullyQualifiedName,
      ],
      'service.displayName.keyword': [table1.service.name, table2.service.name],
      'database.displayName.keyword': [
        table1.database.name,
        table2.database.name,
      ],
      'databaseSchema.displayName.keyword': [
        table1.schema.name,
        table2.schema.name,
      ],
      'columns.name.keyword': ['email', 'shop_id'],
    };

    await afterAction();
  });

  test.afterAll('Cleanup', async ({ browser }) => {
    const { apiContext, afterAction } = await createNewPage(browser);
    await Promise.all([
      user1.delete(apiContext),
      user2.delete(apiContext),
      table1.delete(apiContext),
      table2.delete(apiContext),
      topic1.delete(apiContext),
      topic2.delete(apiContext),
      tierTag1.delete(apiContext),
      tierTag2.delete(apiContext),
    ]);
    await afterAction();
  });

  test.beforeEach(async ({ page }) => {
    await redirectToHomePage(page);
    await sidebarClick(page, SidebarItem.EXPLORE);
  });

  FIELDS.forEach((field) => {
    test(`Verify All conditions for ${field.id} field`, async ({ page }) => {
      test.slow(true);

      await verifyAllConditions(page, field, searchCriteria[field.name][0]);
    });
  });

  Object.values(OPERATOR).forEach(({ name: operator }) => {
    FIELDS.forEach((field) => {
      // Rule based search
      test(`Verify Rule functionality for field ${field.id} with ${operator} operator`, async ({
        page,
      }) => {
        test.slow(true);

        await runRuleGroupTests(page, field, operator, false, searchCriteria);
      });

      // Group based search
      test(`Verify Group functionality for field ${field.id} with ${operator} operator`, async ({
        page,
      }) => {
        test.slow(true);

        await runRuleGroupTests(page, field, operator, true, searchCriteria);
      });
    });
  });
});