@grafana/create-plugin 4.7.0-canary.883.3635606.0 → 4.7.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v4.7.0 (Thu Apr 18 2024)
+
+#### 🚀 Enhancement
+
+- Create Plugin: Run e2e tests against multiple Grafana versions in CI workflow [#870](https://github.com/grafana/plugin-tools/pull/870) ([@sunker](https://github.com/sunker))
+
+#### Authors: 1
+
+- Erik Sundell ([@sunker](https://github.com/sunker))
+
+---
+
 # v4.6.2 (Wed Apr 17 2024)
 
 #### 🐛 Bug Fix

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "4.7.0-canary.883.3635606.0",
+  "version": "4.7.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -87,5 +87,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "36356061f59c5a0fd16e9413ac4c50e666033525"
+  "gitHead": "b18692d9bdc211888da99627436f58b1229d88ad"
 }

package/templates/common/docker-compose.yaml

@@ -11,7 +11,6 @@ services:
       args:
         grafana_image: ${GRAFANA_IMAGE:-{{~grafanaImage~}} }
         grafana_version: ${GRAFANA_VERSION:-{{~grafanaVersion~}} }
-        development: ${DEVELOPMENT:-true}
     ports:
       - 3000:3000/tcp
 {{#if hasBackend}}

package/templates/github/ci/.github/workflows/ci.yml

@@ -15,7 +15,13 @@ permissions: read-all
 
 jobs:
   build:
+    name: Build, lint and unit tests
     runs-on: ubuntu-latest
+    outputs:
+      plugin-id: $\{{ steps.metadata.outputs.plugin-id }}
+      plugin-version: $\{{ steps.metadata.outputs.plugin-version }}
+      has-e2e: $\{{ steps.check-for-e2e.outputs.has-e2e }}
+      has-backend: $\{{ steps.check-for-backend.outputs.has-backend }}
     env:
       GRAFANA_ACCESS_POLICY_TOKEN: $\{{ secrets.GRAFANA_ACCESS_POLICY_TOKEN }}
     steps:
@@ -79,42 +85,6 @@ jobs:
             echo "has-e2e=true" >> $GITHUB_OUTPUT
           fi
 
-      - name: Install Playwright Browsers
-        if: steps.check-for-e2e.outputs.has-e2e == 'true'
-        run: {{ packageManagerName }} exec playwright install --with-deps
-
-      - name: Start grafana docker
-        if: steps.check-for-e2e.outputs.has-e2e == 'true'
-        run: docker-compose up -d
-        env:
-          DEVELOPMENT: "false"
-
-      - name: Wait for Grafana to start
-        if: steps.check-for-e2e.outputs.has-e2e == 'true'
-        uses: nev7n/wait_for_response@v1
-        with:
-          url: 'http://localhost:3000/'
-          responseCode: 200
-          timeout: 60000
-          interval: 500
-
-      - name: Run e2e tests
-        id: run-e2e-tests
-        if: steps.check-for-e2e.outputs.has-e2e == 'true'
-        run: {{ packageManagerName }} run e2e
-
-      - name: Stop grafana docker
-        if: steps.check-for-e2e.outputs.has-e2e == 'true'
-        run: docker-compose down
-
-      - name: Archive E2E output
-        uses: actions/upload-artifact@v4
-        if: steps.check-for-e2e.outputs.has-e2e == 'true' && steps.run-e2e-tests.outcome != 'success'
-        with:
-          name: playwright-report
-          path: playwright-report/
-          retention-days: 5
-
       - name: Sign plugin
         run: {{ packageManagerName }} run sign
         if: $\{{ env.GRAFANA_ACCESS_POLICY_TOKEN != '' }}
@@ -144,3 +114,107 @@ jobs:
           name: $\{{ steps.metadata.outputs.plugin-id }}-$\{{ steps.metadata.outputs.plugin-version }}
           path: $\{{ steps.metadata.outputs.plugin-id }}
           retention-days: 5
+
+  resolve-versions:
+    name: Resolve e2e images
+    runs-on: ubuntu-latest
+    timeout-minutes: 3
+    needs: build
+    if: $\{{ needs.build.outputs.has-e2e == 'true' }}
+    outputs:
+      matrix: $\{{ steps.resolve-versions.outputs.matrix }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Resolve Grafana E2E versions
+        id: resolve-versions
+        uses: grafana/plugin-actions/e2e-version@main
+
+  playwright-tests:
+    needs: [resolve-versions, build]
+    timeout-minutes: 15
+    strategy:
+      fail-fast: false
+      matrix:
+        GRAFANA_IMAGE: $\{{fromJson(needs.resolve-versions.outputs.matrix)}}
+    name: e2e test $\{{ matrix.GRAFANA_IMAGE.name }}@$\{{ matrix.GRAFANA_IMAGE.VERSION }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          sparse-checkout: |
+            provisioning
+            tests
+            .config
+
+      - name: Download plugin
+        if: needs.build.outputs.has-backend == 'true'
+        uses: actions/download-artifact@v4
+        with:
+          path: dist
+          name: $\{{ needs.build.outputs.plugin-id }}-$\{{ needs.build.outputs.plugin-version }}
+
+      - name: Execute permissions on binary
+        if: needs.build.outputs.has-backend == 'true'
+        run: |
+          chmod +x ./dist/gpx_cicd_linux_amd64
+
+{{#if_eq packageManagerName "pnpm"}}
+      # pnpm action uses the packageManager field in package.json to
+      # understand which version to install.
+      - uses: pnpm/action-setup@v3
+{{/if_eq}}
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: '{{ packageManagerName }}'
+
+      - name: Install dev dependencies
+        run: {{ packageManagerInstallCmd }}
+
+      - name: Start Grafana
+        run: |
+          docker-compose pull
+          GRAFANA_VERSION=$\{{ matrix.GRAFANA_IMAGE.VERSION }} GRAFANA_IMAGE=$\{{ matrix.GRAFANA_IMAGE.NAME }} docker-compose up -d
+
+      - name: Wait for Grafana to start
+        uses: nev7n/wait_for_response@v1
+        with:
+          url: 'http://localhost:3000/'
+          responseCode: 200
+          timeout: 60000
+          interval: 500
+
+      - name: Install Playwright Browsers
+        run: npx playwright install chromium --with-deps
+
+      - name: Run Playwright tests
+        id: run-tests
+        run: {{ packageManagerName }} run e2e
+
+      - name: Docker logs
+        if: $\{{ always() && steps.run-tests.outcome == 'failure' }}
+        run: |
+          docker logs {{ pluginId }} >& grafana-server.log
+
+      - name: Stop grafana docker
+        run: docker-compose down
+
+      - name: Upload server log
+        uses: actions/upload-artifact@v4
+        if: $\{{ always() && steps.run-tests.outcome == 'failure' }}
+        with:
+          name: $\{{ matrix.GRAFANA_IMAGE.NAME }}-v$\{{ matrix.GRAFANA_IMAGE.VERSION }}-$\{{github.run_id}}-server-log
+          path: grafana-server.log
+          retention-days: 5
+
+      # If your repository is public, uploading the Playwright report will make it public on the Internet.
+      # Beware not to expose sensitive information.
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        if: $\{{ always() && steps.run-tests.outcome == 'failure' }}
+        with:
+          name: playwright-report-$\{{ matrix.GRAFANA_IMAGE.NAME }}-v$\{{ matrix.GRAFANA_IMAGE.VERSION }}-$\{{github.run_id}}
+          path: playwright-report/
+          retention-days: 5