Merge pull request #1039 from MTES-MCT/chore-add-coverage

Add code coverage

.github/workflows/main.yml

@@ -71,11 +71,34 @@ jobs:
         run: yarn lint
 
       - name: Test
-        run: yarn test --parallel
+        run: yarn coverage --parallel
         env:
           LOG_LEVEL: fatal
           REACT_APP_API_URL: http://localhost:3001
 
+      - name: Upload frontend coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          disable_search: true
+          files: ./frontend/coverage/coverage-final.json
+          flags: frontend
+
+      - name: Upload packages coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          directory: packages
+          flags: packages
+
+      - name: Upload packages coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          disable_search: true
+          files: ./server/coverage/coverage-final.json
+          flags: server
+
       - name: Test database migrations
         run: yarn workspace @zerologementvacant/server run test:migrations --run-in-band
 

frontend/craco.config.js

@@ -24,6 +24,12 @@ module.exports = {
         'jest-extended/all',
         '<rootDir>/src/setupTests.ts'
       ];
+      config.collectCoverageFrom = [
+        'src/**/*.{ts,tsx}',
+        '!src/**/test/*',
+        '!src/components/_dsfr/*',
+        '!src/*'
+      ];
       config.testTimeout = 30_000;
       config.transformIgnorePatterns = [
         '<rootDir>/node_modules/(?!@codegouvfr)/.+\\.js$',

frontend/package.json

@@ -7,6 +7,7 @@
     "build": "yarn clean && yarn icons && tsc -b tsconfig.build.json && DISABLE_ESLINT_PLUGIN=true craco build",
     "dev": "yarn icons && DISABLE_ESLINT_PLUGIN=true craco start",
     "test": "DISABLE_ESLINT_PLUGIN=true craco test",
+    "coverage": "DISABLE_ESLINT_PLUGIN=true craco test --coverage",
     "postinstall": "copy-dsfr-to-public"
   },
   "browserslist": {

package.json

@@ -18,7 +18,8 @@
     "clean": "lerna run clean",
     "build": "lerna run build",
     "lint": "eslint .",
-    "test": "lerna run test"
+    "test": "lerna run test",
+    "coverage": "lerna run coverage"
   },
   "keywords": [],
   "author": "",

packages/draft/jest.config.json

@@ -2,5 +2,6 @@
   "preset": "ts-jest",
   "testEnvironment": "jsdom",
   "rootDir": "src",
+  "collectCoverageFrom": ["<rootDir>/pdf.ts"],
   "setupFilesAfterEnv": ["jest-extended/all", "<rootDir>/test/setup-tests.ts"]
 }

packages/draft/package.json

@@ -8,7 +8,8 @@
     "copy": "copyfiles -V -u 1 'src/**/*.css' 'src/**/*.hbs' dist",
     "build": "tsc -b tsconfig.build.json && yarn copy",
     "dev": "nodemon --watch src -e ts --exec 'yarn build'",
-    "test": "jest"
+    "test": "jest",
+    "coverage": "jest --coverage"
   },
   "devDependencies": {
     "@testing-library/dom": "^10.4.0",

packages/healthcheck/jest.config.json

@@ -2,5 +2,10 @@
   "preset": "ts-jest",
   "testEnvironment": "node",
   "rootDir": "src",
+  "collectCoverageFrom": [
+    "<rootDir>/**/*.ts",
+    "!<rootDir>/**/test/*",
+    "!<rootDir>/**/index.ts"
+  ],
   "setupFilesAfterEnv": ["jest-extended/all", "<rootDir>/test/setup-tests.ts"]
 }

packages/healthcheck/package.json

@@ -6,7 +6,8 @@
   "scripts": {
     "clean": "rimraf dist tsconfig.build.tsbuildinfo",
     "build": "tsc -b tsconfig.build.json",
-    "test": "jest"
+    "test": "jest",
+    "coverage": "jest --coverage"
   },
   "peerDependencies": {
     "express": "^4.20.0"

packages/models/jest.config.json

@@ -1,6 +1,12 @@
 {
   "preset": "ts-jest",
   "testEnvironment": "node",
+  "collectCoverageFrom": [
+    "<rootDir>/**/*.ts",
+    "!<rootDir>/**/*.test.ts",
+    "!<rootDir>/index.ts",
+    "!<rootDir>/**/test/**"
+  ],
   "rootDir": "src",
   "setupFilesAfterEnv": ["jest-extended/all", "<rootDir>/test/setup-tests.ts"]
 }

packages/models/package.json

@@ -17,6 +17,7 @@
     "clean": "rimraf dist tsconfig.build.tsbuildinfo",
     "build": "tsc -b tsconfig.build.json",
     "test": "jest",
+    "coverage": "jest --coverage",
     "dev": "nodemon --watch src -e ts --exec 'yarn build'"
   },
   "dependencies": {

packages/schemas/jest.config.json

@@ -2,5 +2,6 @@
   "preset": "ts-jest",
   "testEnvironment": "node",
   "rootDir": "src",
+  "collectCoverageFrom": ["<rootDir>/*.ts", "!<rootDir>/index.ts"],
   "setupFilesAfterEnv": ["jest-extended/all", "<rootDir>/test/setup-tests.ts"]
 }

packages/schemas/package.json

@@ -5,7 +5,9 @@
   "types": "dist/index.d.ts",
   "scripts": {
     "clean": "rimraf dist tsconfig.build.tsbuildinfo",
-    "build": "tsc -b tsconfig.build.json"
+    "build": "tsc -b tsconfig.build.json",
+    "test": "jest",
+    "coverage": "jest --coverage"
   },
   "dependencies": {
     "@zerologementvacant/models": "workspace:*",

packages/utils/jest.config.json

@@ -2,5 +2,10 @@
   "preset": "ts-jest",
   "testEnvironment": "node",
   "rootDir": "src",
+  "collectCoverageFrom": [
+    "<rootDir>/**/*.ts",
+    "!<rootDir>/**/test/*",
+    "!<rootDir>/**/index.ts"
+  ],
   "setupFilesAfterEnv": ["jest-extended/all", "<rootDir>/test/setup-tests.ts"]
 }

packages/utils/package.json

@@ -18,7 +18,8 @@
   "scripts": {
     "clean": "rimraf dist tsconfig.build.tsbuildinfo",
     "build": "tsc -b tsconfig.build.json",
-    "test": "jest"
+    "test": "jest",
+    "coverage": "jest --coverage"
   },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.658.1",

server/jest.config.ts

@@ -5,6 +5,15 @@ const tsconfig = require('./tsconfig.json');
 
 const config: JestConfigWithTsJest = {
   preset: 'ts-jest',
+  // These files are used if `jest --coverage` is run
+  collectCoverageFrom: [
+    '<rootDir>/src/**/*.ts',
+    '!<rootDir>/src/**/*.test.ts',
+    '!<rootDir>/src/infra/database/**',
+    '<rootDir>/src/infra/database/test/*.test.ts',
+    '!<rootDir>/src/**/index.ts',
+    '!<rootDir>/src/types'
+  ],
   testEnvironment: 'node',
   testTimeout: 30_000,
   forceExit: true,

server/package.json

@@ -10,6 +10,7 @@
     "start": "node dist/index.js",
     "test": "jest",
     "test:migrations": "jest -c database.jest.config.ts -i",
+    "coverage": "jest --coverage",
     "db": "knex --knexfile=src/infra/database/knexfile.ts",
     "migrate": "yarn db migrate:latest",
     "seed": "yarn db seed:run"