Add E2E Cypress testing (#74)

* Add E2E Cypress testing

* Update logo and screenshot

* Add News to the Mega Menu

.github/workflows/e2e.yml

@@ -0,0 +1,44 @@
+name: E2E
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run build
+
+      - name: Start Grafana
+        run: docker-compose up -d
+
+      - name: Run e2e tests
+        run: npm run e2e
+
+      - name: Stop Grafana
+        run: docker-compose down
+
+      - uses: actions/upload-artifact@v3
+        if: failure()
+        with:
+          path: |
+            cypress/videos
+            cypress/screenshots/actual

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-## 2.5.0 (IN PROGRESS)
+## 2.5.0 (2023-06-17)
 
 ### Features / Enhancements
 
@@ -10,6 +10,7 @@
 - Update to Node 18 and npm (#71)
 - Update Docker image 10.0.0 (#72)
 - Add Application Router (#73)
+- Add E2E Cypress testing (#74)
 
 ## 2.4.0 (2023-04-29)
 

Dockerfile

@@ -51,7 +51,7 @@ USER root
 COPY img/fav32.png /usr/share/grafana/public/img
 
 ## Replace Logo
-COPY src/img/logo.svg /usr/share/grafana/public/img/grafana_icon.svg
+COPY img/logo.svg /usr/share/grafana/public/img/grafana_icon.svg
 
 ## Update Background
 COPY img/background.svg /usr/share/grafana/public/img/g8_login_dark.svg
@@ -75,6 +75,12 @@ RUN sed -i "s|\[\[.NavTree\]\],|nav,|g; \
     window.grafanaBootData = {|g" \
     /usr/share/grafana/public/views/index.html
 
+## Add News to the Mega Menu
+RUN sed -i "s|window.grafanaBootData = {| \
+    nav.push({\"id\":\"my-dashboard\",\"text\":\"Volkov Labs News\",\"icon\":\"play\",\"url\":\"/d/O4tc_E6Gz\",\"sortWeight\":-2000}); \
+    window.grafanaBootData = {|g" \
+    /usr/share/grafana/public/views/index.html
+
 ## Update Title
 RUN find /usr/share/grafana/public/build/ -name *.js -exec sed -i 's|AppTitle="Grafana"|AppTitle="Volkov Labs"|g' {} \;
 

README.md

@@ -2,9 +2,10 @@
 
 ![Application](https://raw.githubusercontent.com/volkovlabs/volkovlabs-app/main/img/app.png)
 
-![Grafana 9](https://img.shields.io/badge/Grafana-9.5.2-orange)
+![Grafana 10](https://img.shields.io/badge/Grafana-10.0.0-orange)
 [![YouTube](https://img.shields.io/badge/YouTube-Channel-red)](https://youtube.com/@volkovlabs)
 ![CI](https://github.com/volkovlabs/volkovlabs-app/workflows/CI/badge.svg)
+![E2E](https://github.com/volkovlabs/volkovlabs-app/workflows/E2E/badge.svg)
 [![codecov](https://codecov.io/gh/VolkovLabs/volkovlabs-app/branch/main/graph/badge.svg)](https://codecov.io/gh/VolkovLabs/volkovlabs-app)
 [![CodeQL](https://github.com/VolkovLabs/volkovlabs-app/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/VolkovLabs/volkovlabs-app/actions/workflows/codeql-analysis.yml)
 

cypress/integration/01-view-news.test.ts

@@ -0,0 +1,23 @@
+import { e2e } from '@grafana/e2e';
+
+/**
+ * Dashboard
+ */
+const json = require('../../provisioning/dashboards/news.json');
+const testedPanel = json.panels[0];
+
+/**
+ * Panel
+ */
+describe('Viewing the News dashboard', () => {
+  beforeEach(() => {
+    e2e.flows.openDashboard({
+      uid: json.uid,
+    });
+  });
+
+  it('Should display a Dynamic Text Panel', () => {
+    const currentPanel = e2e.components.Panels.Panel.title(testedPanel.title);
+    currentPanel.should('be.visible');
+  });
+});

cypress/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "compilerOptions": {
+    "types": ["cypress"]
+  }
+}

src/constants/tests.ts

@@ -5,9 +5,6 @@ export const TestIds = {
   config: {
     root: 'data-testid config',
   },
-  rootPage: {
-    loadingIndicator: 'data-testid root-page loading-indicator',
-  },
   community: {
     root: 'data-testid root-page community',
   },

src/plugin.json

@@ -23,8 +23,8 @@
       }
     ],
     "logos": {
-      "large": "img/app-logo.svg",
-      "small": "img/app-logo.svg"
+      "large": "img/logo.svg",
+      "small": "img/logo.svg"
     },
     "screenshots": [],
     "updated": "%TODAY%",
@@ -47,13 +47,6 @@
       "role": "Viewer",
       "icon": "fire",
       "type": "page"
-    },
-    {
-      "addToNav": true,
-      "name": "News",
-      "path": "/d/O4tc_E6Gz",
-      "role": "Viewer",
-      "type": "page"
     }
   ],
   "autoEnabled": true,