@grafana/create-plugin 5.12.0 → 5.12.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# v5.12.1 (Thu Dec 19 2024)
+
+#### 🐛 Bug Fix
+
+- Create Plugin: Fix scaffolded panel plugin tests [#1421](https://github.com/grafana/plugin-tools/pull/1421) ([@sunker](https://github.com/sunker))
+- Update dependency @grafana/e2e-selectors to v11.4.0 [#1412](https://github.com/grafana/plugin-tools/pull/1412) ([@renovate[bot]](https://github.com/renovate[bot]))
+
+#### Authors: 2
+
+- [@renovate[bot]](https://github.com/renovate[bot])
+- Erik Sundell ([@sunker](https://github.com/sunker))
+
+---
+
 # v5.12.0 (Wed Dec 18 2024)
 
 #### 🚀 Enhancement

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "5.12.0",
+  "version": "5.12.1",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -86,5 +86,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "31b8a33141248ccb27ab8278adbbfc452c35d912"
+  "gitHead": "4ab1966bea18043ca8e76bac1f3e6b5ef06da141"
 }

package/templates/backend/tests/configEditor.spec.ts

@@ -1,6 +1,11 @@
 import { test, expect } from '@grafana/plugin-e2e';
 import { MyDataSourceOptions, MySecureJsonData } from '../src/types';
 
+test('smoke: should render config editor', async ({ createDataSourceConfigPage, readProvisionedDataSource, page }) => {
+  const ds = await readProvisionedDataSource({ fileName: 'datasources.yml' });;
+  await createDataSourceConfigPage({ type: ds.type });
+  await expect(page.getByLabel('Path')).toBeVisible();
+});
 test('"Save & test" should be successful when configuration is valid', async ({
   createDataSourceConfigPage,
   readProvisionedDataSource,

package/templates/backend/tests/queryEditor.spec.ts

@@ -1,5 +1,12 @@
 import { test, expect } from '@grafana/plugin-e2e';
 
+
+test('smoke: should render query editor', async ({ panelEditPage, readProvisionedDataSource }) => {
+  const ds = await readProvisionedDataSource({ fileName: 'datasources.yml' });
+  await panelEditPage.datasource.set(ds.name);
+  await expect(panelEditPage.getQueryEditorRow('A').getByRole('textbox', { name: 'Query Text' })).toBeVisible();
+});
+
 test('should trigger new query when Constant field is changed', async ({
   panelEditPage,
   readProvisionedDataSource,

package/templates/common/.config/Dockerfile

@@ -16,7 +16,7 @@ ENV DEV "${development}"
 # Make it as simple as possible to access the grafana instance for development purposes
 # Do NOT enable these settings in a public facing / production grafana instance
 ENV GF_AUTH_ANONYMOUS_ORG_ROLE "Admin"
-ENV GF_AUTH_ANONYMOUS_ENABLED "true"
+ENV GF_AUTH_ANONYMOUS_ENABLED "{anonymous_auth_enabled}"
 ENV GF_AUTH_BASIC_ENABLED "false"
 # Set development mode so plugins can be loaded without the need to sign
 ENV GF_DEFAULT_APP_MODE "development"
@@ -32,14 +32,14 @@ USER root
 # Installing supervisor and inotify-tools
 RUN if [ "${development}" = "true" ]; then \
     if grep -i -q alpine /etc/issue; then \
-        apk add supervisor inotify-tools git; \
+    apk add supervisor inotify-tools git; \
     elif grep -i -q ubuntu /etc/issue; then \
-      DEBIAN_FRONTEND=noninteractive && \
-      apt-get update && \
-      apt-get install -y supervisor inotify-tools git && \
-      rm -rf /var/lib/apt/lists/*; \
+    DEBIAN_FRONTEND=noninteractive && \
+    apt-get update && \
+    apt-get install -y supervisor inotify-tools git && \
+    rm -rf /var/lib/apt/lists/*; \
     else \
-      echo 'ERROR: Unsupported base image' && /bin/false; \
+    echo 'ERROR: Unsupported base image' && /bin/false; \
     fi \
     fi
 

package/templates/common/_package.json

@@ -19,7 +19,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
 {{#if useCypress}}    "@grafana/e2e": "^11.0.7",
-    "@grafana/e2e-selectors": "^11.3.1",{{/if}}
+    "@grafana/e2e-selectors": "^11.4.0",{{/if}}
     "@grafana/eslint-config": "^8.0.0",{{#if usePlaywright}}
     "@grafana/plugin-e2e": "^1.13.1",{{/if}}
     "@grafana/tsconfig": "^2.0.0",{{#if usePlaywright}}

package/templates/common/docker-compose.yaml

@@ -9,6 +9,7 @@ services:
         grafana_image: ${GRAFANA_IMAGE:-{{~grafanaImage~}} }
         grafana_version: ${GRAFANA_VERSION:-11.3.2}
         development: ${DEVELOPMENT:-false}
+        anonymous_auth_enabled: ${ANONYMOUS_AUTH_ENABLED:-true}
     ports:
       - 3000:3000/tcp
 {{#if hasBackend}}

package/templates/datasource/tests/configEditor.spec.ts

@@ -1,6 +1,12 @@
 import { test, expect } from '@grafana/plugin-e2e';
 import { MyDataSourceOptions, MySecureJsonData } from '../src/types';
 
+test('smoke: should render config editor', async ({ createDataSourceConfigPage, readProvisionedDataSource, page }) => {
+  const ds = await readProvisionedDataSource({ fileName: 'datasources.yml' });;
+  await createDataSourceConfigPage({ type: ds.type });
+  await expect(page.getByLabel('Path')).toBeVisible();
+});
+
 test('"Save & test" should be successful when configuration is valid', async ({
   createDataSourceConfigPage,
   readProvisionedDataSource,

package/templates/datasource/tests/queryEditor.spec.ts

@@ -1,5 +1,12 @@
 import { test, expect } from '@grafana/plugin-e2e';
 
+
+test('smoke: should render query editor', async ({ panelEditPage, readProvisionedDataSource }) => {
+  const ds = await readProvisionedDataSource({ fileName: 'datasources.yml' });
+  await panelEditPage.datasource.set(ds.name);
+  await expect(panelEditPage.getQueryEditorRow('A').getByRole('textbox', { name: 'Query Text' })).toBeVisible();
+});
+
 test('data query should return a value', async ({ panelEditPage, readProvisionedDataSource }) => {
   const ds = await readProvisionedDataSource({ fileName: 'datasources.yml' });
   await panelEditPage.datasource.set(ds.name);

package/templates/github/workflows/ci.yml

@@ -189,10 +189,12 @@ jobs:
       - name: Start Grafana
         run: |
           docker compose pull
-          DEVELOPMENT=false GRAFANA_VERSION=$\{{ matrix.GRAFANA_IMAGE.VERSION }} GRAFANA_IMAGE=$\{{ matrix.GRAFANA_IMAGE.NAME }} docker compose up -d
+          ANONYMOUS_AUTH_ENABLED=false DEVELOPMENT=false GRAFANA_VERSION=$\{{ matrix.GRAFANA_IMAGE.VERSION }} GRAFANA_IMAGE=$\{{ matrix.GRAFANA_IMAGE.NAME }} docker compose up -d
 
       - name: Wait for grafana server
         uses: grafana/plugin-actions/wait-for-grafana@main
+        with:
+          url: http://localhost:3000/login
 
       - name: Install Playwright Browsers
         run: {{ packageManagerName }} exec playwright install chromium --with-deps

package/templates/panel/tests/panel.spec.ts

@@ -17,7 +17,7 @@ test('should display circle when data is passed to the panel', async ({
 }) => {
   const ds = await readProvisionedDataSource({ fileName: 'datasources.yml' });
   await panelEditPage.datasource.set(ds.name);
-  await panelEditPage.setVisualization('{{kebabToPascalKebab pluginName }}');
+  await panelEditPage.setVisualization('{{titleCase pluginName }}');
   await expect(page.getByTestId('simple-panel-circle')).toBeVisible();
 });
 
@@ -30,11 +30,11 @@ test('should display series counter when "Show series counter" option is enabled
 }) => {
   const ds = await readProvisionedDataSource({ fileName: 'datasources.yml' });
   await panelEditPage.datasource.set(ds.name);
-  await panelEditPage.setVisualization('{{kebabToPascalKebab pluginName }}');
-  await panelEditPage.collapseSection('{{kebabToPascalKebab pluginName }}');
+  await panelEditPage.setVisualization('{{titleCase pluginName }}');
+  await panelEditPage.collapseSection('{{titleCase pluginName }}');
   await expect(page.getByTestId('simple-panel-circle')).toBeVisible();
   const seriesCounterLabel = panelEditPage.getByGrafanaSelector(
-    selectors.components.PanelEditor.OptionsPane.fieldLabel('{{kebabToPascalKebab pluginName }} Show series counter')
+    selectors.components.PanelEditor.OptionsPane.fieldLabel('{{titleCase pluginName }} Show series counter')
   );
   const switchField = semver.gte(grafanaVersion, '11.4.0')
     ? seriesCounterLabel.getByRole('switch')