@grafana/create-plugin 4.8.0 → 4.9.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v4.9.0 (Thu Apr 25 2024)
+
+#### 🚀 Enhancement
+
+- Create plugin: update scaffolded tests when creating an app plugin [#892](https://github.com/grafana/plugin-tools/pull/892) ([@mckn](https://github.com/mckn))
+
+#### Authors: 1
+
+- Marcus Andersson ([@mckn](https://github.com/mckn))
+
+---
+
 # v4.8.0 (Wed Apr 24 2024)
 
 #### 🚀 Enhancement

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "4.8.0",
+  "version": "4.9.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -87,5 +87,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "96389ff99fec497ed6b2ab509709d578ecaf13f0"
+  "gitHead": "d8db91c5320a7355d3ad6c9734157292fee769ab"
 }

package/templates/app/tests/appConfig.spec.ts

@@ -1,7 +1,7 @@
 import { test, expect } from './fixtures';
 
 test('should be possible to save app configuration', async ({ appConfigPage, page }) => {
-  const saveForm = page.getByRole('button', { name: /Save API settings/i });
+  const saveButton = page.getByRole('button', { name: /Save API settings/i });
 
   // reset the configured secret
   await page.getByRole('button', { name: /reset/i }).click();
@@ -14,6 +14,6 @@ test('should be possible to save app configuration', async ({ appConfigPage, pag
   // listen for the server response on the saved form
   const saveResponse = appConfigPage.waitForSettingsResponse();
 
-  await saveForm.click();
+  await saveButton.click();
   await expect(saveResponse).toBeOK();
 });

package/templates/app/tests/appNavigation.spec.ts

@@ -1,26 +1,25 @@
-import pluginJson from '../src/plugin.json';
-import { test, expect } from '@grafana/plugin-e2e';
+import { test, expect } from './fixtures';
 import { ROUTES } from '../src/constants';
 
 test.describe('navigating app', () => {
-  test('page one should render successfully', async ({ page }) => {
-    await page.goto(`/a/${pluginJson.id}/${ROUTES.One}`);
+  test('page one should render successfully', async ({ gotoPage, page }) => {
+    await gotoPage(`/${ROUTES.One}`);
     await expect(page.getByText('This is page one.')).toBeVisible();
   });
 
-  test('page two should render successfully', async ({ page }) => {
-    await page.goto(`/a/${pluginJson.id}/${ROUTES.Two}`);
+  test('page two should render successfully', async ({ gotoPage, page }) => {
+    await gotoPage(`/${ROUTES.Two}`);
     await expect(page.getByText('This is page two.')).toBeVisible();
   });
 
-  test('page three should support an id parameter', async ({ page }) => {
-    await page.goto(`/a/${pluginJson.id}/${ROUTES.Three}/123456`);
+  test('page three should support an id parameter', async ({ gotoPage, page }) => {
+    await gotoPage(`/${ROUTES.Three}/123456`);
     await expect(page.getByText('ID: 123456')).toBeVisible();
   });
 
-  test('page three should render sucessfully', async ({ page }) => {
+  test('page three should render sucessfully', async ({ gotoPage, page }) => {
     // wait for page to successfully render
-    await page.goto(`/a/${pluginJson.id}/${ROUTES.One}`);
+    await gotoPage(`/${ROUTES.One}`);
     await expect(page.getByText('This is page one.')).toBeVisible();
 
     // navigating to page four with full width layout without sidebar menu

package/templates/app/tests/fixtures.ts

@@ -1,19 +1,26 @@
-import { AppConfigPage, test as base } from '@grafana/plugin-e2e';
+import { AppConfigPage, AppPage, test as base } from '@grafana/plugin-e2e';
 import pluginJson from '../src/plugin.json';
 
-type AppTestFixture = { appConfigPage: AppConfigPage };
+type AppTestFixture = {
+  appConfigPage: AppConfigPage;
+  gotoPage: (path?: string) => Promise<AppPage>;
+};
 
 export const test = base.extend<AppTestFixture>({
-  appConfigPage: async ({ page, selectors, grafanaVersion, request }, use, testInfo) => {
-    const configPage = new AppConfigPage(
-      { page, selectors, grafanaVersion, request, testInfo },
-      {
+  appConfigPage: async ({ gotoAppConfigPage }, use) => {
+    const configPage = await gotoAppConfigPage({
+      pluginId: pluginJson.id,
+    });
+    await use(configPage);
+  },
+  gotoPage: async ({ gotoAppPage }, use) => {
+    await use((path) =>
+      gotoAppPage({
+        path,
         pluginId: pluginJson.id,
-      }
+      })
     );
-    await configPage.goto();
-    await use(configPage);
   },
 });
 
-export { expect } from '@grafana/plugin-e2e';
+export { expect } from '@grafana/plugin-e2e';