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

test: add playwright test for tour and api docs (#17328)

Browse Source 
* test: add playwright test for tour

* fix tests

* test: Add API docs test for Playwright

* test: Update API docs link selector for exact match
This commit is contained in:
Sachin Chaurasiya 2024-08-08 13:01:12 +05:30 committed by GitHub
parent 062a7abd27
commit 71a57a83bb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 158 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -0,0 +1,40 @@
/*
* 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 { redirectToHomePage } from '../../utils/common';
// use the admin user to login
test.use({ storageState: 'playwright/.auth/admin.json' });
test.describe('API docs should work properly', () => {
test.beforeEach('Visit entity details page', async ({ page }) => {
await redirectToHomePage(page);
});
test('API docs should work properly', async ({ page }) => {
await page.locator('[data-testid="help-icon"]').click();
await page.getByRole('link', { name: 'API', exact: true }).click();
await expect(
page.getByRole('link', {
name: 'openmetadata-dev@googlegroups.com',
})
).toBeVisible();
await expect(
page.getByRole('link', {
name: 'https://open-metadata.org',
})
).toBeVisible();
});
});

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

@ -0,0 +1,117 @@
/*
* 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 { redirectToHomePage } from '../../utils/common';
// use the admin user to login
test.use({ storageState: 'playwright/.auth/admin.json' });
test.describe('Tour should work properly', () => {
test.beforeEach('Visit entity details page', async ({ page }) => {
await redirectToHomePage(page);
});
test('All tour steps should work', async ({ page }) => {
await page.locator('[data-testid="help-icon"]').click();
await page.getByRole('link', { name: 'Tour' }).click();
await expect(page.locator(`[data-tour-elem="badge"]`)).toHaveText('1');
// step 1
await page.locator('[data-tour-elem="right-arrow"]').click();
await expect(page.locator(`[data-tour-elem="badge"]`)).toHaveText('2');
// step 2
await page.locator('[data-tour-elem="right-arrow"]').click();
await expect(page.locator(`[data-tour-elem="badge"]`)).toHaveText('3');
await page.getByTestId('searchBox').fill('dim_a');
await page.getByTestId('searchBox').press('Enter');
await expect(page.locator(`[data-tour-elem="badge"]`)).toHaveText('4');
// step 3
await page.locator('[data-tour-elem="right-arrow"]').click();
await expect(page.locator(`[data-tour-elem="badge"]`)).toHaveText('5');
await expect(
page.getByTestId('sample_data.ecommerce_db.shopify.dim_address')
).toBeVisible();
// step 4
await page.locator('[data-tour-elem="right-arrow"]').click();
await expect(page.locator(`[data-tour-elem="badge"]`)).toHaveText('6');
// step 5
await page.locator('[data-tour-elem="right-arrow"]').click();
await expect(page.locator(`[data-tour-elem="badge"]`)).toHaveText('7');
// step 6
await page.locator('[data-tour-elem="right-arrow"]').click();
await expect(page.locator(`[data-tour-elem="badge"]`)).toHaveText('8');
// step 7
await page.locator('[data-tour-elem="right-arrow"]').click();
await expect(page.locator(`[data-tour-elem="badge"]`)).toHaveText('9');
// step 8
await page.locator('[data-tour-elem="right-arrow"]').click();
await expect(page.locator(`[data-tour-elem="badge"]`)).toHaveText('10');
await expect(
page.getByTestId('sample_data').getByText('Sample Data')
).toBeVisible();
// step 9
await page.locator('[data-tour-elem="right-arrow"]').click();
await expect(page.locator(`[data-tour-elem="badge"]`)).toHaveText('11');
// step 10
await page.locator('[data-tour-elem="right-arrow"]').click();
await expect(page.locator(`[data-tour-elem="badge"]`)).toHaveText('12');
await expect(page.getByText('Profiler & Data Quality')).toBeVisible();
// step 11
await page.locator('[data-tour-elem="right-arrow"]').click();
await expect(page.locator(`[data-tour-elem="badge"]`)).toHaveText('13');
// step 12
await page.locator('[data-tour-elem="right-arrow"]').click();
await expect(page.locator(`[data-tour-elem="badge"]`)).toHaveText('14');
await expect(
page.getByTestId('lineage').getByText('Lineage')
).toBeVisible();
// step 13
await page.locator('[data-tour-elem="right-arrow"]').click();
await expect(page.locator(`[data-tour-elem="badge"]`)).toHaveText('15');
await page.getByTestId('last-step-button').click();
await page.getByTestId('saveButton').click();
});
});

1
openmetadata-ui/src/main/resources/ui/src/components/NavBar/NavBar.tsx
View File

@ -558,6 +558,7 @@ const NavBar = ({
<Icon
className="align-middle"
component={Help}
data-testid="help-icon"
style={{ fontSize: '24px' }}
/>
</Tooltip>