ci: implementing ci/cd with 80% code coverage and linter verification

Author: renanjava

.github/workflows/check.yml

@@ -0,0 +1,26 @@
+name: 'Verificação básica de código'
+
+on:
+  push:
+    branches:
+      - 'main'
+
+jobs:
+  basic-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Subir o Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.12.2'
+
+      - name: Instalar as dependências
+        run: npm install
+
+      - name: Rodar o ESLint
+        run: npm run lint
+
+      - name: Rodar os testes unitários com 80% de cobertura de código
+        run: npm run test:cov

backend/jest.coverage.config.ts

@@ -0,0 +1,27 @@
+export default {
+  moduleFileExtensions: ['js', 'json', 'ts'],
+  testRegex: '.*\\.(spec|int-spec)\\.ts$',
+  transform: {
+    '^.+\\.(t|j)s$': 'ts-jest',
+  },
+  collectCoverageFrom: [
+    'src/**/*.{ts,tsx}',
+    '!src/**/*.d.ts',
+    '!src/**/*.spec.ts',
+    '!src/**/*.test.ts',
+    '!src/**/*mock*.ts',
+  ],
+  coverageDirectory: './coverage',
+  testEnvironment: 'node',
+  coveragePathIgnorePatterns: ['/node_modules/', '/dist/', '/build/'],
+  transformIgnorePatterns: ['/node_modules/(?!@faker-js/faker)'],
+  collectCoverage: true,
+  coverageThreshold: {
+    global: {
+      branches: 80,
+      functions: 80,
+      lines: 80,
+      statements: 80,
+    },
+  },
+};

backend/package.json

@@ -15,7 +15,7 @@
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "test": "jest",
     "test:watch": "jest --watch",
-    "test:cov": "jest --coverage",
+    "test:cov": "jest --coverage --runInBand --config ./jest.coverage.config.ts",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
     "test:e2e": "jest --config ./test/jest-e2e.json"
   },
@@ -79,4 +79,4 @@
     "coverageDirectory": "../coverage",
     "testEnvironment": "node"
   }
-}
+}

backend/src/__tests__/app.module.spec.ts

@@ -0,0 +1,17 @@
+import { AppModule } from './../app.module';
+import { mockPrismaService } from './../prisma/mocks/prisma-service.mock';
+import { PrismaService } from '../prisma/prisma.service';
+import { Test } from '@nestjs/testing';
+
+describe('AppModule', () => {
+  it('should compile AppModule with mocked Prisma', async () => {
+    const moduleRef = await Test.createTestingModule({
+      imports: [AppModule],
+    })
+      .overrideProvider(PrismaService)
+      .useValue(mockPrismaService)
+      .compile();
+
+    expect(moduleRef).toBeDefined();
+  });
+});

backend/src/modules/collaborators/collaborators.module.ts

@@ -1,7 +1,7 @@
 import { Module } from '@nestjs/common';
 import { CollaboratorsService } from './collaborators.service';
 import { CollaboratorsController } from './collaborators.controller';
-import { PrismaModule } from 'src/prisma/prisma.module';
+import { PrismaModule } from '../../prisma/prisma.module';
 import { PrismaCollaboratorsRepository } from './repositories/prisma-collaborators.repository';
 
 @Module({

backend/src/modules/projects/projects.module.ts

@@ -1,7 +1,7 @@
 import { Module } from '@nestjs/common';
 import { ProjectsService } from './projects.service';
 import { ProjectsController } from './projects.controller';
-import { PrismaModule } from 'src/prisma/prisma.module';
+import { PrismaModule } from '../../prisma/prisma.module';
 import { PrismaProjectsRepository } from './repositories/prisma-projects.repository';
 
 @Module({

backend/src/modules/tasks/tasks.module.ts

@@ -2,7 +2,7 @@ import { Module } from '@nestjs/common';
 import { TasksService } from './tasks.service';
 import { TasksController } from './tasks.controller';
 import { PrismaTasksRepository } from './repositories/prisma-tasks.repository';
-import { PrismaModule } from 'src/prisma/prisma.module';
+import { PrismaModule } from '../../prisma/prisma.module';
 
 @Module({
   imports: [PrismaModule],

backend/src/modules/time-trackers/time-trackers.module.ts

@@ -1,7 +1,7 @@
 import { Module } from '@nestjs/common';
 import { TimeTrackersService } from './time-trackers.service';
 import { TimeTrackersController } from './time-trackers.controller';
-import { PrismaModule } from 'src/prisma/prisma.module';
+import { PrismaModule } from '../../prisma/prisma.module';
 import { PrismaTimeTrackersRepository } from './repositories/prisma-time-trackers.repository';
 
 @Module({