chore: add cypress and GitHub workflows

Author: spaenleh

.eslintrc.json

@@ -7,8 +7,13 @@
     "plugin:react/recommended",
     "airbnb",
     "plugin:@typescript-eslint/recommended",
-    "prettier"
+    "prettier",
+    "plugin:cypress/recommended"
   ],
+  "globals": {
+    "cy": true,
+    "Cypress": true
+  },
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaFeatures": {
@@ -19,6 +24,7 @@
   },
   "plugins": ["react", "react-hooks", "@typescript-eslint", "prettier"],
   "rules": {
+    "import/prefer-default-export": "off",
     "prettier/prettier": "error",
     "import/extensions": [
       "error",

.github/workflows/cypress.yml

@@ -0,0 +1,57 @@
+name: cypress tests
+on: [push]
+jobs:
+  cypress-run:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+
+      - name: set up node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '14'
+          cache: 'yarn'
+
+      - name: install yarn
+        # avoid checksum errors with github packages
+        run: YARN_CHECKSUM_BEHAVIOR=update yarn
+
+      - name: cypress run
+        uses: cypress-io/github-action@v2
+        env:
+          REACT_APP_API_HOST: http://localhost:3636
+          REACT_APP_GRAASP_DOMAIN: localhost
+          REACT_APP_GRAASP_APP_ID: id-1234567890
+          REACT_APP_MOCK_API: true
+          NODE_ENV: test
+        with:
+          install: false
+          config: baseUrl=http://localhost:3000
+          start: yarn start:ci
+          wait-on: 'http://localhost:3000'
+          wait-on-timeout: 180
+          browser: chrome
+          headless: true
+          quiet: true
+
+      # after the test run completes
+      # store videos and any screenshots
+      # NOTE: screenshots will be generated only if E2E test failed
+      # thus we store screenshots only on failures
+      # Alternative: create and commit an empty cypress/screenshots folder
+      # to always have something to upload
+      - uses: actions/upload-artifact@v2
+        if: failure()
+        with:
+          name: cypress-screenshots
+          path: cypress/screenshots
+      # Test run video was always captured, so this action uses "always()" condition
+      - uses: actions/upload-artifact@v2
+        if: always()
+        with:
+          name: cypress-videos
+          path: cypress/videos
+
+      - name: coverage report
+        run: npx nyc report --reporter=text-summary

.gitignore

@@ -16,11 +16,25 @@
 .env.local
 .env.development.local
 .env.test.local
+.env.test
 .env.production.local
 
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
+# yarn
+.yarn/
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+yarn-error.log
+
 # editor files
 /.idea
+
+# cypress
+cypress/screenshots/
+cypress/videos/

.yarnrc.yml

@@ -1,3 +1,7 @@
 nodeLinker: node-modules
 
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
+    spec: '@yarnpkg/plugin-interactive-tools'
+
 yarnPath: .yarn/releases/yarn-3.2.0.cjs

cypress.json

@@ -0,0 +1,4 @@
+{
+  "baseUrl": "http://localhost:3000",
+  "video": false
+}

cypress/integration/home.spec.ts

@@ -0,0 +1,14 @@
+import {
+  buildDataCy,
+  LEARN_REACT_LINK_CYPRESS,
+} from '../../src/config/selectors';
+
+describe('Renders Home', () => {
+  it('should render the link', () => {
+    cy.visit('/');
+    cy.get(buildDataCy(LEARN_REACT_LINK_CYPRESS)).should(
+      'contain.text',
+      'Learn React',
+    );
+  });
+});

cypress/plugins/index.js

@@ -0,0 +1,22 @@
+/// <reference types="cypress" />
+// ***********************************************************
+// This example plugins/index.js can be used to load plugins
+//
+// You can change the location of this file or turn off loading
+// the plugins file with the 'pluginsFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/plugins-guide
+// ***********************************************************
+
+// This function is called when a project is opened or re-opened (e.g. due to
+// the project's config changing)
+
+/**
+ * @type {Cypress.PluginConfig}
+ */
+// eslint-disable-next-line no-unused-vars
+module.exports = (on, config) => {
+  // `on` is used to hook into various events Cypress emits
+  // `config` is the resolved Cypress config
+};

cypress/support/commands.js

@@ -0,0 +1,26 @@
+import '@testing-library/cypress/add-commands';
+// ***********************************************
+// This example commands.js 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) => { ... })

cypress/support/index.js

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/index.js 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.js';
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

package.json

@@ -1,8 +1,9 @@
 {
-  "name": "graasp-code-review-app-test",
+  "name": "graasp-app-code-review-rewrite",
   "version": "0.1.0",
   "private": true,
   "dependencies": {
+    "@testing-library/cypress": "^8.0.2",
     "@testing-library/jest-dom": "^5.14.1",
     "@testing-library/react": "^13.0.0",
     "@testing-library/user-event": "^13.2.1",
@@ -26,7 +27,7 @@
     "hooks:install": "husky install",
     "hooks:uninstall": "husky uninstall",
     "lint": "eslint .",
-    "test:once": "",
+    "test:once": "yarn test:ci",
     "test:ci": "env-cmd -f ./.env.test cypress run"
   },
   "browserslist": {
@@ -47,10 +48,12 @@
     "@commitlint/config-conventional": "16.0.0",
     "@typescript-eslint/eslint-plugin": "^5.22.0",
     "@typescript-eslint/parser": "^5.22.0",
+    "cypress": "^9.6.0",
     "eslint": "^8.14.0",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-prettier": "^8.5.0",
     "eslint-import-resolver-typescript": "^2.7.1",
+    "eslint-plugin-cypress": "^2.12.1",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jsx-a11y": "^6.5.1",
     "eslint-plugin-prettier": "^4.0.0",