Add Cypress tests (#8)

* Add first Cypress unit test

* Auto-run Cypress unit tests

* Fix Cypress env setting

* Simplify sleep step

* Skip dependency installation via Cypress

* Fix wrong job creation

* Build Cypress

* Update Cypress config

* Remove Docker image caching (not working)

* Run Cypress tests using Firefox

* Move Cypress config

* Reorganise Cypress unit tests

* Avoid Cypress GPU error

* Ignore Cypress support file

* Add default Cypress support file

* Add E2E support file

* Reorganise E2E tests

* Fix Flower unit test

* Add Cypress tests

* Add 404 test

* Add wait commands

* Add baseUrl

* Remove wait commands

* Store screnshots on failure only

* Save screenshots even when Cypress fails

* Fix baseUrl config

* Improve tests

* Get Docker Compose logs

* Set up test mode

* Fix tests

* Fix baseUrl

* Improve tests on shiny apps

* Remove shiny app shortcut tests (not working)

* Fix some test issues

* Minor tests

Author: nuno-agostinho

.github/workflows/check.yml

@@ -9,19 +9,38 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Check out the repo
-        uses: actions/checkout@v2
+      - name: Checkout repo
+        uses: actions/checkout@v3
 
       - name: Setup project
-        run: ./setup.sh
-    
-      - name: Build the Docker Compose stack
+        run: ./setup-testing-mode.sh
+
+      - name: Build Docker Compose stack
         run: docker compose up -d
 
       - name: Sleep
-        uses: jakejarvis/wait-action@master
-        with:
-          time: '60s'
+        run: sleep 10s
+        shell: bash
 
       - name: Check running containers
         run: docker ps
+
+      - name: Run Cypress unit tests
+        uses: cypress-io/github-action@v5
+        with:
+          install: false
+          build: npm i -D cypress
+          browser: firefox
+        env:
+          CYPRESS_VIDEO: false
+          ELECTRON_EXTRA_LAUNCH_ARGS: '--disable-gpu'
+
+      - name: Store Cypress screenshots
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: screenshots
+          path: cypress/screenshots
+
+      - name: Docker Compose logs
+        run: docker compose logs

cypress.config.js

@@ -0,0 +1,18 @@
+const { defineConfig } = require('cypress')
+
+module.exports = defineConfig({
+  // These settings apply everywhere unless overridden
+  defaultCommandTimeout: 5000,
+  viewportWidth: 1000,
+  viewportHeight: 600,
+  // Viewport settings overridden for component tests
+  component: {
+    viewportWidth: 500,
+    viewportHeight: 500,
+  },
+  // Command timeout overridden for E2E tests
+  e2e: {
+    defaultCommandTimeout: 10000,
+    baseUrl: 'http://localhost',
+  },
+})

cypress/e2e/tests.cy.js

@@ -0,0 +1,61 @@
+describe('ShinyProxy', () => {
+  it('main', () => {
+    cy.visit('/')
+    cy.screenshot()
+    cy.contains('psichomics')
+    cy.contains('cTRAP')
+  })
+
+  it('psichomics', () => {
+    cy.visit('/psichomics')
+    cy.wait(30000)
+    cy.url().should('include', '/app/psichomics')
+    cy.screenshot()
+  })
+  
+  it('cTRAP', () => {
+    cy.visit('/cTRAP')
+    cy.wait(30000)
+    cy.url().should('include', '/app/cTRAP')
+    cy.screenshot()
+  })
+})
+
+describe('Flower dashboard', () => {
+  it('open', () => {
+    cy.visit('http://localhost:5555/flower/dashboard')
+    cy.screenshot()
+    cy.contains('celery@ctrap').click()
+    cy.screenshot()
+  })
+})
+
+describe('Grafana', () => {
+  it('open', () => {
+    cy.visit('http://localhost:3000')
+    cy.screenshot()
+  })
+})
+
+describe('Prometheus', () => {
+  it('open', () => {
+    cy.visit('http://localhost:9090')
+    cy.screenshot()
+  })
+})
+
+// Issues with setting up Plausible because of password issues :(
+// describe('Plausible', () => {
+//   it('open', () => {
+//     cy.visit('http://localhost:8000/login')
+//     cy.screenshot()
+//   })
+// })
+
+describe('404', () => {
+  it('open', () => {
+    cy.request({url: '/404', failOnStatusCode: false}).its('status').should('equal', 404)
+    cy.visit('/404', {failOnStatusCode: false})
+    cy.screenshot()
+  })
+})

cypress/support/e2e.js

@@ -0,0 +1 @@
+// DO NOT DELETE THIS FILE: required for Cypress to run unit tests