feat: add e2e app and configure jest

README.md

@@ -2,6 +2,10 @@
 
 Checkout documentation: https://temarusanov.github.io/nx/
 
+## TODO:
+
+- [ ] Jest coverage bug [#13576](https://github.com/jestjs/jest/issues/13576)
+
 ## Installing
 
 ### Install Ansible

apps/api-e2e/.eslintrc.json

@@ -0,0 +1,10 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

apps/api-e2e/jest.config.ts

@@ -0,0 +1,18 @@
+/* eslint-disable */
+export default {
+    displayName: 'api-e2e',
+    preset: '../../jest.preset.js',
+    globalSetup: '<rootDir>/src/support/global-setup.ts',
+    globalTeardown: '<rootDir>/src/support/global-teardown.ts',
+    setupFiles: ['<rootDir>/src/support/test-setup.ts'],
+    testEnvironment: 'node',
+    transform: {
+        '^.+\\.[tj]s$': [
+            'ts-jest',
+            {
+                tsconfig: '<rootDir>/tsconfig.spec.json',
+            },
+        ],
+    },
+    moduleFileExtensions: ['ts', 'js', 'html'],
+}

apps/api-e2e/project.json

@@ -0,0 +1,22 @@
+{
+  "name": "api-e2e",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "implicitDependencies": ["api"],
+  "targets": {
+    "e2e": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{e2eProjectRoot}"],
+      "options": {
+        "jestConfig": "apps/api-e2e/jest.config.ts",
+        "passWithNoTests": true
+      }
+    },
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["apps/api-e2e/**/*.{js,ts}"]
+      }
+    }
+  }
+}

apps/api-e2e/src/api/api.spec.ts

@@ -0,0 +1,10 @@
+import axios from 'axios'
+
+describe('GET /health', () => {
+    it('should be healthy', async () => {
+        const res = await axios.get(`/health`)
+
+        expect(res.status).toBe(200)
+        expect(res.data.healthy).toEqual(true)
+    })
+})

apps/api-e2e/src/support/global-setup.ts

@@ -0,0 +1,8 @@
+/* eslint-disable */
+var __TEARDOWN_MESSAGE__: string
+
+module.exports = async function () {
+    // Start services that that the app needs to run (e.g. database, docker-compose, etc.).
+    // Hint: Use `globalThis` to pass variables to global teardown.
+    // globalThis.__TEARDOWN_MESSAGE__ = '\nTearing down...\n'
+}

apps/api-e2e/src/support/global-teardown.ts

@@ -0,0 +1,7 @@
+/* eslint-disable */
+
+module.exports = async function () {
+    // Put clean up logic here (e.g. stopping services, docker-compose, etc.).
+    // Hint: `globalThis` is shared between setup and teardown.
+    //console.log(globalThis.__TEARDOWN_MESSAGE__)
+}

apps/api-e2e/src/support/test-setup.ts

@@ -0,0 +1,10 @@
+/* eslint-disable */
+
+import axios from 'axios'
+
+module.exports = async function () {
+    // Configure axios for tests to use.
+    const host = process.env.HOST ?? 'localhost'
+    const port = process.env.PORT ?? '3000'
+    axios.defaults.baseURL = `http://${host}:${port}`
+}

apps/api-e2e/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "compilerOptions": {
+    "esModuleInterop": true
+  }
+}

apps/api-e2e/tsconfig.spec.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": ["jest.config.ts", "src/**/*.ts"]
+}

apps/api/jest.config.ts

@@ -12,5 +12,4 @@ export default {
         '^.+\\.[tj]s$': 'ts-jest',
     },
     moduleFileExtensions: ['ts', 'js', 'html'],
-    coverageDirectory: '../../coverage/apps/api',
 }

jest.preset.js

@@ -1,5 +1,11 @@
 const nxPreset = require('@nx/jest/preset').default;
 
+const globalConf = {
+  collectCoverage: true,
+  coverageDirectory: `${process.env.NX_WORKSPACE_ROOT}/coverage/${process.env['NX_TASK_TARGET_PROJECT']}`,
+};
+
 module.exports = {
   ...nxPreset,
+  ...globalConf,
 };

package.json

@@ -26,6 +26,7 @@
     "@nestjs/platform-express": "9.4.3",
     "@nestjs/testing": "9.4.3",
     "@prisma/client": "^4.15.0",
+    "axios": "^1.4.0",
     "bcrypt": "^5.1.0",
     "clsx": "^1.2.1",
     "env-var": "^7.3.1",