test: Cypress e2e setup

.github/workflows/ci.yml

@@ -149,6 +149,26 @@ jobs:
         run: ./scripts/before_script.sh
         env:
           CI: true
+  check-ui:
+    name: UI Check
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: npm
+      - name: Install dependencies
+        run: npm ci --ignore-scripts
+      - name: Test dashboard
+        uses: cypress-io/github-action@v5
+        timeout-minutes: 10
+        with:
+          start: npm run start
+          browser: chrome
+          wait-on: 'http://localhost:4040'
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true

.gitignore

@@ -17,3 +17,7 @@ test_logs
 
 # visual studio code
 .vscode
+
+# cypress
+cypress/screenshots
+cypress/videos

CONTRIBUTING.md

@@ -9,11 +9,17 @@ When working on the dashboard, use `npm run dashboard` and visit `localhost:4040
 
 When working on React components, use `npm run pig` and visit `localhost:4041` to view our component library and documentation (you can have both Dashboard and PIG running at once). The demos for each component are the primary way we test components, although there are also a small number of automated tests you can run with `npm test`. If you would like to create a new component that does not exist in the component library, use `npm run generate yourComponentName` to generate boilerplate code and quickly get started.
 
+## UI Tests
+
+1. Start the dashboard with `npm run dashboard`. Make sure that dashboard server is running on port `4040`.
+2. Start the UI tests in interactive mode for debugging with `npm run cypress:open`, or run the tests silently with `npm run cypress:run`.
+
 ## Pull Requests
-We actively welcome your pull requests.
+
+We welcome and appreciate your contribution to Parse Dashboard. Please keep the following in mind:
 
 1. Fork the repo and create your branch from the `alpha` branch.
-2. If you've added code that should be tested, add tests.
+2. If you've modified code, add a test. If the modification involves UI changes, add a UI test.
 3. If you've changed APIs, update the documentation.
 4. If you've updated/added an UI component, please add a screenshot.
 5. If you've fixed an issue or added features, add what you've changed to the CHANGELOG.

cypress.config.js

@@ -0,0 +1,8 @@
+const { defineConfig } = require('cypress')
+
+module.exports = defineConfig({
+  e2e: {
+    baseUrl: 'http://localhost:4040',
+    video: true,
+  },
+})

cypress/.eslintrc.json

@@ -0,0 +1,8 @@
+{
+    "plugins": [
+      "cypress"
+    ],
+    "env": {
+      "cypress/globals": true
+    }
+  }

cypress/e2e/apps-index.cy.js

@@ -0,0 +1,145 @@
+import { getDashboardConfig } from '../utils/getDashboardConfig';
+
+describe('Apps index', () => {
+  it('Redirects to app lists from root path if there are 2 or more apps', () => {
+    cy.intercept(
+      {
+        method: 'GET',
+        url: '/parse-dashboard-config.json',
+      },
+      getDashboardConfig([
+        {
+          appName: 'test1',
+        },
+        {
+          appName: 'test2',
+        },
+      ]),
+    );
+
+    cy.visit('/')
+    cy.wait(3000)
+
+    cy
+      .url()
+      .should('match', /\/apps$/);
+  });
+
+  it('Can filter apps with search input', () => {
+    cy.intercept(
+      {
+        method: 'GET',
+        url: '/parse-dashboard-config.json',
+      },
+      getDashboardConfig([
+        {
+          appName: 'test1',
+        },
+        {
+          appName: 'test2',
+        },
+      ]),
+    );
+
+    cy.visit('/apps')
+    cy.wait(3000)
+
+    cy
+      .get('[data-cy="apps-index-app"]')
+      .should('have.length', 2)
+
+    cy
+      .get('[data-cy="apps-index-search-input"]')
+      .type('test1')
+
+    cy
+      .get('[data-cy="apps-index-app"]')
+      .should('have.length', 1)
+
+    cy
+      .get('[data-cy="apps-index-search-input"]')
+      .type('qwerty')
+
+    cy
+      .get('[data-cy="apps-index-app"]')
+      .should('have.length', 0)
+  })
+
+  it('Can show error states in the list', () => {
+    cy.intercept(
+      {
+        method: 'GET',
+        url: '/parse-dashboard-config.json',
+      },
+      getDashboardConfig([
+        {
+          appName: 'test1',
+        },
+        {
+          appName: 'test2',
+          masterKey: 'cos',
+        },
+        {
+          appName: 'test3',
+          appId: 'cos',
+        },
+        {
+          appName: 'test4',
+          masterKey: 'cos',
+          appId: 'cos',
+        },
+        {
+          appName: 'test5',
+          serverURL: 'http://unavailablehost:1234'
+        },
+        {
+          appName: 'test6',
+          serverURL: 'http://localhost:1337/parse2'
+        },
+      ]),
+    );
+
+    cy.visit('/apps')
+    cy.wait(3000)
+
+    cy
+      .get('[data-cy="apps-index-app"]')
+      .should('have.length', 6)
+
+    cy
+      .get('[data-cy="apps-index-app"]')
+      .eq(0)
+      .find('[data-cy="apps-index-app-details"]')
+      .contains('Server URL: http://localhost:1337/parse')
+
+    cy
+      .get('[data-cy="apps-index-app"]')
+      .eq(1)
+      .find('[data-cy="apps-index-app-details"]')
+      .contains('Server not reachable: unauthorized')
+
+    cy
+      .get('[data-cy="apps-index-app"]')
+      .eq(2)
+      .find('[data-cy="apps-index-app-details"]')
+      .contains('Server not reachable: unauthorized')
+
+    cy
+      .get('[data-cy="apps-index-app"]')
+      .eq(3)
+      .find('[data-cy="apps-index-app-details"]')
+      .contains('Server not reachable: unauthorized')
+
+    cy
+      .get('[data-cy="apps-index-app"]')
+      .eq(4)
+      .find('[data-cy="apps-index-app-details"]')
+      .contains('Server not reachable: unable to connect to server')
+
+    cy
+      .get('[data-cy="apps-index-app"]')
+      .eq(5)
+      .find('[data-cy="apps-index-app-details"]')
+      .contains('Server not reachable: unable to connect to server')
+  });
+})

cypress/e2e/dashboard.cy.js

@@ -0,0 +1,30 @@
+
+import { getDashboardConfig } from '../utils/getDashboardConfig';
+
+describe('Dashboard', () => {
+  it('Shows loader during loading', () => {
+    cy.intercept(
+      {
+        method: 'GET',
+        url: '/parse-dashboard-config.json',
+      },
+      (req) => {
+        req.reply({
+          statusCode: 200,
+          delay: 250,
+          body: getDashboardConfig([
+            {
+              appName: 'test',
+            }
+          ]),
+        })
+      }
+    )
+
+    cy.visit('/')
+
+    cy.get('[data-cy="dashboard-loader"]', {
+      timeout: 250
+    });
+  })
+})

cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "[email protected]",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

cypress/support/commands.js

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+//   namespace Cypress {
+//     interface Chainable {
+//       login(email: string, password: string): Chainable<void>
+//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+//     }
+//   }
+// }

cypress/support/e2e.js

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/e2e.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

cypress/utils/getDashboardConfig.js

@@ -0,0 +1,14 @@
+export function getDashboardConfig(apps) {
+  return {
+    newFeaturesInLatestVersion: [],
+    apps: apps.map(app => ({
+      serverURL: app.serverURL || 'http://localhost:1337/parse',
+      appId: app.appId || 'hello',
+      masterKey: app.masterKey || 'world',
+      appName: app.appName,
+      iconName: app.iconName || '',
+      primaryBackgroundColor: app.primaryBackgroundColor || '',
+      secondaryBackgroundColor: app.secondaryBackgroundColor || '',
+    })),
+  };
+}