Plugin Extensions: E2E test addLink and legacy APIs (#92394)

* cleanup tests

* more cleanup

* added links

* test legacy hooks

* test legacy hooks

* update codeowners

* revert package changes

* add project specfic example script

* remove console log

* Update .github/CODEOWNERS

Co-authored-by: Timur Olzhabayev <timur.olzhabayev@grafana.com>

* Update CODEOWNERS

* use correct file names

* cleanup tests

---------

Co-authored-by: Timur Olzhabayev <timur.olzhabayev@grafana.com>
This commit is contained in:
Erik Sundell
2024-08-26 16:01:32 +02:00
committed by GitHub
parent a2de893ab3
commit 1373b37166
35 changed files with 422 additions and 390 deletions
@@ -1,51 +0,0 @@
import { test, expect } from '@grafana/plugin-e2e';
import { ensureExtensionRegistryIsPopulated } from './utils';
const testIds = {
container: 'main-app-body',
actions: {
button: 'action-button',
},
modal: {
container: 'container',
open: 'open-link',
},
appA: {
container: 'a-app-body',
},
appB: {
modal: 'b-app-modal',
reusableComponent: 'b-app-configure-extension-component',
},
legacyAPIPage: {
container: 'data-testid pg-two-container',
},
};
const pluginId = 'grafana-extensionstest-app';
test('should extend the actions menu with a link to a-app plugin', async ({ page }) => {
await page.goto(`/a/${pluginId}/legacy-apis`);
await ensureExtensionRegistryIsPopulated(page);
await page.getByTestId(testIds.actions.button).click();
await page.getByTestId(testIds.container).getByText('Go to A').click();
await page.getByTestId(testIds.modal.open).click();
await expect(page.getByTestId(testIds.appA.container)).toBeVisible();
});
test('should extend the actions menu with a command triggered from b-app plugin', async ({ page }) => {
await page.goto(`/a/${pluginId}/legacy-apis`);
await ensureExtensionRegistryIsPopulated(page);
await expect(
page.getByTestId(testIds.legacyAPIPage.container).getByTestId(testIds.appB.reusableComponent)
).toHaveText('Hello World!');
});
test('should extend main app with component extension from app B', async ({ page }) => {
await page.goto(`/a/${pluginId}/legacy-apis`);
await ensureExtensionRegistryIsPopulated(page);
await page.getByTestId(testIds.actions.button).click();
await page.getByTestId(testIds.container).getByText('Open from B').click();
await expect(page.getByTestId(testIds.appB.modal)).toBeVisible();
});
@@ -1,44 +0,0 @@
import { selectors } from '@grafana/e2e-selectors';
import { expect, test } from '@grafana/plugin-e2e';
import { ensureExtensionRegistryIsPopulated } from './utils';
const panelTitle = 'Link with defaults';
const extensionTitle = 'Open from time series...';
const testIds = {
modal: {
container: 'ape-modal-body',
},
mainPage: {
container: 'main-app-body',
},
};
const linkOnClickDashboardUid = 'dbfb47c5-e5e5-4d28-8ac7-35f349b95946';
const linkPathDashboardUid = 'd1fbb077-cd44-4738-8c8a-d4e66748b719';
test('should add link extension (path) with defaults to time series panel', async ({ gotoDashboardPage, page }) => {
const dashboardPage = await gotoDashboardPage({ uid: linkPathDashboardUid });
await ensureExtensionRegistryIsPopulated(page);
const panel = await dashboardPage.getPanelByTitle(panelTitle);
await panel.clickOnMenuItem(extensionTitle, { parentItem: 'Extensions' });
await expect(page.getByTestId(testIds.mainPage.container)).toBeVisible();
});
test('should add link extension (onclick) with defaults to time series panel', async ({ gotoDashboardPage, page }) => {
const dashboardPage = await gotoDashboardPage({ uid: linkOnClickDashboardUid });
await ensureExtensionRegistryIsPopulated(page);
const panel = await dashboardPage.getPanelByTitle(panelTitle);
await panel.clickOnMenuItem(extensionTitle, { parentItem: 'Extensions' });
await expect(page.getByRole('dialog')).toContainText('Select query from "Link with defaults"');
});
test('should add link extension (onclick) with new title to pie chart panel', async ({ gotoDashboardPage, page }) => {
const panelTitle = 'Link with new name';
const extensionTitle = 'Open from piechart';
const dashboardPage = await gotoDashboardPage({ uid: linkOnClickDashboardUid });
await ensureExtensionRegistryIsPopulated(page);
const panel = await dashboardPage.getPanelByTitle(panelTitle);
await panel.clickOnMenuItem(extensionTitle, { parentItem: 'Extensions' });
await expect(page.getByRole('dialog')).toContainText('Select query from "Link with new name"');
});
@@ -1,9 +0,0 @@
import { test, expect } from '@grafana/plugin-e2e';
const pluginId = 'grafana-extensionstest-app';
const exposedComponentTestId = 'exposed-component';
test('should display component exposed by another app', async ({ page }) => {
await page.goto(`/a/${pluginId}/exposed-components`);
await expect(await page.getByTestId(exposedComponentTestId)).toHaveText('Hello World!');
});
@@ -1,11 +0,0 @@
import { test, expect } from '@grafana/plugin-e2e';
const pluginId = 'grafana-extensionstest-app';
const exposedComponentTestId = 'exposed-component';
test('should render component with usePluginComponents hook', async ({ page }) => {
await page.goto(`/a/${pluginId}/added-components`);
await expect(
page.getByTestId('data-testid pg-added-components-container').getByTestId('b-app-add-component')
).toHaveText('Hello World!');
});
@@ -1,10 +0,0 @@
import { Page } from '@playwright/test';
import { selectors } from '@grafana/e2e-selectors';
export async function ensureExtensionRegistryIsPopulated(page: Page) {
// Due to these plugins using the old getter extensions api we need to force a refresh by navigating home then back
// to guarantee the extensions are available to the plugin before we interact with the page.
await page.getByTestId(selectors.components.Breadcrumbs.breadcrumb('Home')).click();
await page.goBack();
}