Skip to content

Commit

Permalink
test(e2e): Improve the e2e for advanced search filters on Explore page (
Browse files Browse the repository at this point in the history 
#19584)

* fix: add more fields for advance search filters

* added more children values data in respective classes for tests

* added some more fields for advance search filters

* added project and status fields for search filter

* added Glossary field and some code refactoring

* updated EntityDataClass with new entities required for AdvanceSearch spec

* removed some hard coded field values

* updated advancedSearch with additional fields

* removed failing tests of additional fields

* remove failing fields for now to make the test green

* remove the config changes from the PR

---------

Co-authored-by: Ashish Gupta <[email protected]>
  • Loading branch information
@rushikesh1799 @Ashish8689
rushikesh1799 and Ashish8689 authored Feb 6, 2025
1 parent 28bd01c commit 7595288
Show file tree
Hide file tree
Showing 10 changed files with 297 additions and 68 deletions.
207 changes: 141 additions & 66 deletions openmetadata-ui/src/main/resources/ui/playwright/e2e/Features/AdvancedSearch.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,15 @@
*/
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 { EntityDataClass } from '../../support/entity/EntityDataClass';
import {
FIELDS,
OPERATOR,
runRuleGroupTests,
verifyAllConditions,
} from '../../utils/advancedSearch';
import { createNewPage, redirectToHomePage } from '../../utils/common';
import { addMultiOwner, assignTag, assignTier } from '../../utils/entity';
import { assignTier } from '../../utils/entity';
import { sidebarClick } from '../../utils/sidebar';

test.describe.configure({
Expand All @@ -35,100 +32,178 @@ 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: Record<string, any> = {};

test.beforeAll('Setup pre-requests', async ({ browser }) => {
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),
]);
await EntityDataClass.preRequisitesForTests(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 EntityDataClass.table1.visitEntityPage(page);
await EntityDataClass.table1.patch({
apiContext,
patchData: [
{
op: 'add',
value: {
type: 'user',
id: EntityDataClass.user1.responseData.id,
},
path: '/owners/0',
},
{
op: 'add',
value: {
tagFQN: 'PersonalData.Personal',
},
path: '/tags/0',
},
{
op: 'add',
path: '/domain',
value: {
id: EntityDataClass.domain1.responseData.id,
type: 'domain',
name: EntityDataClass.domain1.responseData.name,
displayName: EntityDataClass.domain1.responseData.displayName,
},
},
],
});
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 EntityDataClass.table2.visitEntityPage(page);
await EntityDataClass.table2.patch({
apiContext,
patchData: [
{
op: 'add',
value: {
type: 'user',
id: EntityDataClass.user2.responseData.id,
},
path: '/owners/0',
},
{
op: 'add',
value: {
tagFQN: 'PII.None',
},
path: '/tags/0',
},
{
op: 'add',
path: '/domain',
value: {
id: EntityDataClass.domain2.responseData.id,
type: 'domain',
name: EntityDataClass.domain2.responseData.name,
displayName: EntityDataClass.domain2.responseData.displayName,
},
},
],
});
await assignTag(page, 'PII.None');

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

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

// Update Search Criteria here
searchCriteria = {
'owners.displayName.keyword': [user1.getUserName(), user2.getUserName()],
'owners.displayName.keyword': [
EntityDataClass.user1.getUserName(),
EntityDataClass.user2.getUserName(),
],
'tags.tagFQN': ['PersonalData.Personal', 'PII.None'],
'tier.tagFQN': [
tierTag1.responseData.fullyQualifiedName,
tierTag2.responseData.fullyQualifiedName,
EntityDataClass.tierTag1.responseData.fullyQualifiedName,
EntityDataClass.tierTag2.responseData.fullyQualifiedName,
],
'service.displayName.keyword': [
EntityDataClass.table1.service.name,
EntityDataClass.table2.service.name,
],
'service.displayName.keyword': [table1.service.name, table2.service.name],
'database.displayName.keyword': [
table1.database.name,
table2.database.name,
EntityDataClass.table1.database.name,
EntityDataClass.table2.database.name,
],
'databaseSchema.displayName.keyword': [
table1.schema.name,
table2.schema.name,
EntityDataClass.table1.schema.name,
EntityDataClass.table2.schema.name,
],
'columns.name.keyword': ['email', 'shop_id'],
'displayName.keyword': [
table1.entity.displayName,
table2.entity.displayName,
EntityDataClass.table1.entity.displayName,
EntityDataClass.table2.entity.displayName,
],
serviceType: [
EntityDataClass.table1.service.serviceType,
EntityDataClass.topic1.service.serviceType,
],
'messageSchema.schemaFields.name.keyword': [
EntityDataClass.topic1.entity.messageSchema.schemaFields[0].name,
EntityDataClass.topic1.entity.messageSchema.schemaFields[1].name,
],
'dataModel.columns.name.keyword': [
EntityDataClass.dashboard1.dataModel.columns[0].name,
EntityDataClass.dashboard1.dataModel.columns[1].name,
],
dataModelType: [
EntityDataClass.dashboard1.dataModel.dataModelType,
EntityDataClass.dashboard2.dataModel.dataModelType,
],
'fields.name.keyword': [
EntityDataClass.searchIndex1.entity.fields[1].name,
EntityDataClass.searchIndex1.entity.fields[3].name,
],
'tasks.displayName.keyword': [
EntityDataClass.pipeline1.entity.tasks[0].displayName,
EntityDataClass.pipeline1.entity.tasks[1].displayName,
],
'domain.displayName.keyword': [
EntityDataClass.domain1.data.displayName,
EntityDataClass.domain2.data.displayName,
],
'responseSchema.schemaFields.name.keyword': [
EntityDataClass.apiCollection1.apiEndpoint.responseSchema
.schemaFields[0].name,
EntityDataClass.apiCollection1.apiEndpoint.responseSchema
.schemaFields[1].name,
],
'requestSchema.schemaFields.name.keyword': [
EntityDataClass.apiCollection1.apiEndpoint.requestSchema.schemaFields[0]
.name,
EntityDataClass.apiCollection1.apiEndpoint.requestSchema.schemaFields[1]
.name,
],
'name.keyword': [
EntityDataClass.table1.entity.name,
EntityDataClass.table2.entity.name,
],
'project.keyword': [
EntityDataClass.dashboardDataModel1.entity.project,
EntityDataClass.dashboardDataModel2.entity.project,
],
status: ['Approved', 'In Review'],
};

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 EntityDataClass.postRequisitesForTests(apiContext);
await afterAction();
});

Expand Down
12 changes: 12 additions & 0 deletions openmetadata-ui/src/main/resources/ui/playwright/support/entity/ApiCollectionClass.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,12 @@ export class ApiCollectionClass extends EntityClass {
},
],
},
{
name: 'secondary',
dataType: 'RECORD',
fullyQualifiedName: `${this.fqn}.secondary`,
tags: [],
},
],
},
responseSchema: {
Expand Down Expand Up @@ -139,6 +145,12 @@ export class ApiCollectionClass extends EntityClass {
},
],
},
{
name: 'secondary',
dataType: 'RECORD',
fullyQualifiedName: `${this.fqn}.secondary`,
tags: [],
},
],
},
};
Expand Down
17 changes: 16 additions & 1 deletion openmetadata-ui/src/main/resources/ui/playwright/support/entity/DashboardClass.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,20 @@ export class DashboardClass extends EntityClass {
service: this.service.name,
};
children = [
{
name: 'merchant',
dataType: 'VARCHAR',
dataLength: 256,
dataTypeDisplay: 'varchar',
description: 'merchant',
},
{
name: 'notes',
dataType: 'VARCHAR',
dataLength: 256,
dataTypeDisplay: 'varchar',
description: 'merchant',
},
{
name: 'country_name',
dataType: 'VARCHAR',
Expand All @@ -76,12 +90,13 @@ export class DashboardClass extends EntityClass {
{} as ResponseDataWithServiceType;
chartsResponseData: ResponseDataType = {} as ResponseDataType;

constructor(name?: string) {
constructor(name?: string, dataModelType = 'SupersetDataModel') {
super(EntityTypeEndpoint.Dashboard);
this.service.name = name ?? this.service.name;
this.type = 'Dashboard';
this.serviceCategory = SERVICE_TYPE.Dashboard;
this.serviceType = ServiceTypes.DASHBOARD_SERVICES;
this.dataModel.dataModelType = dataModelType;
}

async create(apiContext: APIRequestContext) {
Expand Down
2 changes: 2 additions & 0 deletions openmetadata-ui/src/main/resources/ui/playwright/support/entity/DashboardDataModelClass.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import { EntityClass } from './EntityClass';

export class DashboardDataModelClass extends EntityClass {
private dashboardDataModelName = `pw-dashboard-data-model-${uuid()}`;
private projectName = `pw-project-${uuid()}`;
service = {
name: `pw-dashboard-service-${uuid()}`,
serviceType: 'Superset',
Expand Down Expand Up @@ -58,6 +59,7 @@ export class DashboardDataModelClass extends EntityClass {
service: this.service.name,
columns: this.children,
dataModelType: 'SupersetDataModel',
project: this.projectName,
};

serviceResponseData: ResponseDataType = {} as ResponseDataType;
Expand Down
Loading

0 comments on commit 7595288

Please sign in to comment.