yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-12-29 00:18:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

test: add e2e playwright test for collect endpoint (#16816)

Browse Source 
* test: add e2e playwright test for collect endpoint

* refactor: Improve collect endpoint e2e test
This commit is contained in:
Sachin Chaurasiya 2024-06-27 16:07:04 +05:30 committed by GitHub
parent 396ff362c5
commit f744705c41
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 82 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
openmetadata-ui/src/main/resources/ui/cypress/e2e/Flow/Collect.spec.ts
View File

@ -1,70 +0,0 @@
/*
* Copyright 2022 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 { interceptURL } from '../../common/common';
import { SidebarItem } from '../../constants/Entity.interface';
describe('Collect end point should work properly', () => {
const PAGES = {
setting: {
name: 'Settings',
menuId: SidebarItem.SETTINGS,
},
explore: {
name: 'Explore',
menuId: SidebarItem.EXPLORE,
},
dataQuality: {
name: 'Quality',
menuId: SidebarItem.DATA_QUALITY,
},
incidentManager: {
name: 'Incident Manager',
menuId: SidebarItem.INCIDENT_MANAGER,
},
insight: {
name: 'Insights',
menuId: SidebarItem.DATA_INSIGHT,
},
glossary: {
name: 'Glossary',
menuId: SidebarItem.GLOSSARY,
},
tag: {
name: 'Tags',
menuId: SidebarItem.TAGS,
},
};
const assertCollectEndPoint = () => {
cy.wait('@collect').then(({ request, response }) => {
expect(response.body).to.have.any.key('eventId');
const modifiedResponse = Cypress._.omit(response.body, 'eventId');
expect(request.body).deep.equal(modifiedResponse);
});
};
beforeEach(() => {
cy.login();
interceptURL('PUT', '/api/v1/analytics/web/events/collect', 'collect');
});
Object.values(PAGES).map((page) => {
it(`Visit ${page.name} page should trigger collect API`, () => {
cy.sidebarClick(page.menuId);
assertCollectEndPoint();
});
});
});

82
openmetadata-ui/src/main/resources/ui/playwright/e2e/Flow/Collect.spec.ts Normal file
View File

@ -0,0 +1,82 @@
/*
* 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 { expect, test } from '@playwright/test';
import { SidebarItem } from '../../constant/sidebar';
import { redirectToHomePage } from '../../utils/common';
import { settingClick } from '../../utils/sidebar';
// use the admin user to login
test.use({ storageState: 'playwright/.auth/admin.json' });
test.describe('Collect end point should work properly', () => {
const PAGES = {
setting: {
name: 'Settings',
menuId: SidebarItem.SETTINGS,
},
explore: {
name: 'Explore',
menuId: SidebarItem.EXPLORE,
},
dataQuality: {
name: 'Quality',
menuId: SidebarItem.DATA_QUALITY,
},
incidentManager: {
name: 'Incident Manager',
menuId: SidebarItem.INCIDENT_MANAGER,
},
insight: {
name: 'Insights',
menuId: SidebarItem.DATA_INSIGHT,
},
glossary: {
name: 'Glossary',
menuId: SidebarItem.GLOSSARY,
},
tag: {
name: 'Tags',
menuId: SidebarItem.TAGS,
},
};
test.beforeEach('Visit entity details page', async ({ page }) => {
await redirectToHomePage(page);
});
for (const key of Object.keys(PAGES)) {
const pageDetails = PAGES[key];
test(`Visit ${pageDetails.name} page should trigger collect API`, async ({
page,
}) => {
// Wait for the request and response after the click action
const collectResponsePromise = page.waitForResponse(
'/api/v1/analytics/web/events/collect'
);
await settingClick(page, pageDetails.menuId);
const collectResponse = await collectResponsePromise;
const requestPayload = JSON.parse(
collectResponse.request().postData() ?? '{}'
);
const collectJsonResponse = await collectResponse.json();
// omit the eventId from the response
delete collectJsonResponse.eventId;
expect(collectJsonResponse).toStrictEqual(requestPayload);
});
}
});