Get e2e tests working on GitHub

.eslintrc.js

@@ -17,6 +17,9 @@ module.exports = {
   ],
   plugins: ['prettier', 'promise', 'react', 'react-hooks'],
   settings: {
+    'importer/resolver': {
+      node: {},
+    },
     react: {
       version: 'detect',
     },
@@ -138,5 +141,11 @@ module.exports = {
     'react/no-danger': 'off',
 
     'jsx-a11y/control-has-associated-label': 'warn',
+
+    /**
+     * Due to having our dev dependencies in a monorepo layout, this is
+     * difficult to configure properly.  Disabling for now.
+     */
+    'import/no-extraneous-dependencies': ['off'],
   },
 };

.github/workflows/node-js-ci.yml

@@ -9,18 +9,39 @@ on:
       - master
 
 jobs:
-  build:
-    runs-on: ${{matrix.os}}
+  # Confirm that prettier was run on the changes
+  prettier:
+    name: Prettier Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+      - run: |
+        npm install
+        npm run prettier-check
 
+  # Make sure eslint passes
+  eslint:
+    name: ESLint Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+      - run: |
+        npm install
+        npm run eslint
+
+  # Run unit tests on all platforms/versions of node
+  unit:
+    name: Unit Tests
+    runs-on: ${{matrix.os}}
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
         node-version: [12.x, 14.x]
-
     steps:
       - uses: actions/checkout@v2
-      - name: Cache node modules
-        uses: actions/cache@v2
+      - uses: actions/cache@v2
         env:
           cache-name: cache-node-modules
         with:
@@ -31,25 +52,33 @@ jobs:
             ${{ runner.os }}-build-${{ env.cache-name }}-
             ${{ runner.os }}-build-
             ${{ runner.os }}-
-
-      - name: Test
-        uses: actions/setup-node@v1
+      - uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
-      - run: npm install
-      - run: cp env.example .env
-      # Start the microservices needed for tests
-      - run: npm run services:start auth
-      - run: npm run test
-  Prettier-Check:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
-      - run: npm install && npm run prettier-check
-  Lint:
+      - run: |
+          npm install
+          cp env.example .env
+          npm run jest
+
+  # Run end-to-end tests along with the microservices in docker-compose on Linux
+  e2e:
+    name: End-To-End Tests
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x]
     steps:
+      - uses: actions/cache@v2
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
-      - run: npm install && npm run eslint
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: |
+          npm install
+          npm run services:start
+          npm run jest:e2e

jest-playwright.config.js

@@ -0,0 +1,15 @@
+// NOTE: this should really live in src/api/auth but jest-playwright doesn't
+// seen to know how to find it if I put it there.  It has to be at the root.
+module.exports = {
+  launchOptions: {
+    headless: true,
+  },
+  browsers: ['chromium', 'firefox', 'webkit'],
+  serverOptions: {
+    command: 'npx http-server src/api/auth/test/e2e -p 8888',
+    port: 8888,
+    launchTime: 10000,
+    usedPortAction: 'kill',
+    debug: true,
+  },
+};

jest.config.e2e.js

@@ -0,0 +1,6 @@
+const baseConfig = require('./jest.config.base');
+
+module.exports = {
+  ...baseConfig,
+  projects: ['<rootDir>/src/api/**/jest.config.e2e.js'],
+};

package.json

@@ -26,6 +26,7 @@
     "pretest": "npm run lint",
     "test": "npm run jest",
     "jest": "cross-env NODE_ENV=test LOG_LEVEL=error MOCK_REDIS=1 FEED_URL_INTERVAL_MS=200 jest -c jest.config.js --",
+    "jest:e2e": "jest -c jest.config.e2e.js --",
     "coverage": "cross-env NODE_ENV=test LOG_LEVEL=silent MOCK_REDIS=1 FEED_URL_INTERVAL_MS=200 jest --collectCoverage --",
     "jest-watch": "cross-env MOCK_REDIS=1 jest --watch --",
     "start": "node src/backend",
@@ -115,8 +116,10 @@
     "husky": "5.0.9",
     "jest": "26.6.3",
     "jest-fetch-mock": "3.0.3",
+    "jest-playwright-preset": "1.4.7",
     "nock": "13.0.7",
     "npm-run-all": "4.1.5",
+    "playwright": "1.9.0",
     "prettier": "2.2.1",
     "pretty-quick": "3.1.0",
     "react-test-renderer": "17.0.1",

src/api/auth/jest-playwright.config.js

@@ -1,26 +1,2 @@
-// NOTE: you need to copy ../env.development to ../.env and run services
-const result = require('dotenv').config({ path: '../.env' });
-
-if (result.error) {
-  throw result.error;
-}
-
-const showServerLogs = false;
-
-module.exports = {
-  launchOptions: {
-    headless: true,
-  },
-  browsers: ['chromium', 'firefox', 'webkit'],
-  // Quit when any test fails to save time
-  bail: 1,
-  serverOptions: [
-    {
-      command: 'npx http-server test/e2e -p 8888',
-      port: 8888,
-      launchTime: 5000,
-      usedPortAction: 'kill',
-      debug: showServerLogs,
-    },
-  ],
-};
+// Due to https://github.com/playwright-community/jest-playwright/issues/446
+// we put our jest-playwright config in the Telescope root, see ./jest-playwright.confing.js

src/api/auth/jest.config.e2e.js

@@ -1,5 +1,12 @@
+const baseConfig = require('../../../jest.config.base');
+
 module.exports = {
+  ...baseConfig,
+  rootDir: '../../..',
+  setupFiles: ['<rootDir>/jest.setup.js', '<rootDir>/src/api/auth/jest.setup.js'],
+  testMatch: ['<rootDir>/src/api/auth/test/e2e/**/*.test.js'],
+  collectCoverageFrom: ['<rootDir>/src/api/auth/server.js', '<rootDir>/src/api/auth/src/**/*.js'],
+  // We use jest-playwright to do browser tests, https://github.com/playwright-community/jest-playwright
+  // See the jest-playwright config in the Telescope root ./jest-playwright.config.js
   preset: 'jest-playwright-preset',
-  testPathIgnorePatterns: ['/node_modules/'],
-  testMatch: ['<rootDir>/test/e2e/**/*.test.js'],
 };

src/api/auth/package.json

@@ -4,9 +4,7 @@
   "version": "1.0.0",
   "description": "An Authorization Service",
   "scripts": {
-    "test:e2e": "jest -c jest.config.e2e.js",
     "test:manual": "http-server test/manual -p 8888",
-    "test:unit": "jest -c jest.config.js",
     "dev": "nodemon server.js | pino-pretty -c -t",
     "start": "node server.js"
   },
@@ -34,11 +32,7 @@
   },
   "devDependencies": {
     "http-server": "^0.12.3",
-    "jest": "^26.6.3",
-    "jest-playwright-preset": "^1.4.6",
     "nodemon": "^2.0.7",
-    "pino-pretty": "^4.5.0",
-    "playwright": "^1.8.1",
-    "supertest": "^6.1.3"
+    "pino-pretty": "^4.5.0"
   }
 }