Issue 135 : Added ability to limit number of builds to keep (just like Jenkins) (#142)

suratdas · web-flow · commit d8b284ac550e · 2021-06-16T16:09:49.000+03:00
diff --git a/prisma/migrations/20210612140950-limit-build-number/README.md b/prisma/migrations/20210612140950-limit-build-number/README.md
@@ -0,0 +1,40 @@
+# Migration `20210612140950-limit-build-number`
+
+This migration has been generated by Pavel Strunkin at 6/12/2021, 5:09:50 PM.
+You can check out the [state of the schema](./schema.prisma) after the migration.
+
+## Database Steps
+
+```sql
+ALTER TABLE "Project" ADD COLUMN     "maxBuildAllowed" INTEGER NOT NULL DEFAULT 100
+```
+
+## Changes
+
+```diff
+diff --git schema.prisma schema.prisma
+migration 20210605124856-image-compare-config-as-json..20210612140950-limit-build-number
+--- datamodel.dml
++++ datamodel.dml
+@@ -3,9 +3,9 @@
+ }
+ datasource db {
+   provider = "postgresql"
+-  url = "***"
++  url = "***"
+ }
+ model Build {
+   id         String    @id @default(uuid())
+@@ -30,8 +30,9 @@
+   name                  String
+   mainBranchName        String          @default("master")
+   builds                Build[]
+   buildsCounter         Int             @default(0)
++  maxBuildAllowed       Int             @default(100)
+   testVariations        TestVariation[]
+   updatedAt             DateTime        @updatedAt
+   createdAt             DateTime        @default(now())
+   // config
+```
+
+
diff --git a/prisma/migrations/20210612140950-limit-build-number/schema.prisma b/prisma/migrations/20210612140950-limit-build-number/schema.prisma
@@ -0,0 +1,136 @@
+generator client {
+  provider = "prisma-client-js"
+}
+
+datasource db {
+  provider = "postgresql"
+  url = "***"
+}
+
+model Build {
+  id         String    @id @default(uuid())
+  ciBuildId  String?
+  number     Int?
+  branchName String?
+  status     String?
+  testRuns   TestRun[]
+  projectId  String
+  project    Project   @relation(fields: [projectId], references: [id])
+  updatedAt  DateTime  @updatedAt
+  createdAt  DateTime  @default(now())
+  user       User?     @relation(fields: [userId], references: [id])
+  userId     String?
+  isRunning  Boolean?
+
+  @@unique([projectId, ciBuildId])
+}
+
+model Project {
+  id                    String          @id @default(uuid())
+  name                  String
+  mainBranchName        String          @default("master")
+  builds                Build[]
+  buildsCounter         Int             @default(0)
+  maxBuildAllowed       Int             @default(100)
+  testVariations        TestVariation[]
+  updatedAt             DateTime        @updatedAt
+  createdAt             DateTime        @default(now())
+  // config
+  autoApproveFeature    Boolean         @default(false)
+  imageComparison       ImageComparison @default(pixelmatch)
+  imageComparisonConfig String          @default("{ \"threshold\": 0.1, \"ignoreAntialiasing\": true, \"allowDiffDimensions\": false }")
+
+  @@unique([name])
+}
+
+model TestRun {
+  id                    String         @id @default(uuid())
+  imageName             String
+  diffName              String?
+  diffPercent           Float?
+  diffTollerancePercent Float          @default(0)
+  pixelMisMatchCount    Int?
+  status                TestStatus
+  buildId               String
+  build                 Build          @relation(fields: [buildId], references: [id])
+  testVariationId       String?
+  testVariation         TestVariation? @relation(fields: [testVariationId], references: [id])
+  merge                 Boolean        @default(false)
+  updatedAt             DateTime       @updatedAt
+  createdAt             DateTime       @default(now())
+  // Test variation data
+  name                  String         @default("")
+  browser               String?
+  device                String?
+  os                    String?
+  viewport              String?
+  customTags            String?        @default("")
+  baselineName          String?
+  comment               String?
+  baseline              Baseline?
+  branchName            String         @default("master")
+  baselineBranchName    String?
+  ignoreAreas           String         @default("[]")
+  tempIgnoreAreas       String         @default("[]")
+}
+
+model TestVariation {
+  id           String     @id @default(uuid())
+  name         String
+  branchName   String     @default("master")
+  browser      String     @default("")
+  device       String     @default("")
+  os           String     @default("")
+  viewport     String     @default("")
+  customTags   String     @default("")
+  baselineName String?
+  ignoreAreas  String     @default("[]")
+  projectId    String
+  project      Project    @relation(fields: [projectId], references: [id])
+  testRuns     TestRun[]
+  baselines    Baseline[]
+  comment      String?
+  updatedAt    DateTime   @updatedAt
+  createdAt    DateTime   @default(now())
+
+  @@unique([projectId, name, browser, device, os, viewport, customTags, branchName])
+}
+
+model Baseline {
+  id              String        @id @default(uuid())
+  baselineName    String
+  testVariationId String
+  testVariation   TestVariation @relation(fields: [testVariationId], references: [id])
+  testRunId       String?
+  testRun         TestRun?      @relation(fields: [testRunId], references: [id])
+  updatedAt       DateTime      @updatedAt
+  createdAt       DateTime      @default(now())
+}
+
+model User {
+  id        String   @id @default(uuid())
+  email     String   @unique
+  password  String
+  firstName String?
+  lastName  String?
+  apiKey    String   @unique
+  isActive  Boolean  @default(true)
+  builds    Build[]
+  updatedAt DateTime @updatedAt
+  createdAt DateTime @default(now())
+}
+
+enum TestStatus {
+  failed
+  new
+  ok
+  unresolved
+  approved
+  autoApproved
+}
+
+enum ImageComparison {
+  pixelmatch
+  lookSame
+  odiff
+}
diff --git a/prisma/migrations/20210612140950-limit-build-number/steps.json b/prisma/migrations/20210612140950-limit-build-number/steps.json
@@ -0,0 +1,37 @@
+{
+  "version": "0.3.14-fixed",
+  "steps": [
+    {
+      "tag": "CreateField",
+      "model": "Project",
+      "field": "maxBuildAllowed",
+      "type": "Int",
+      "arity": "Required"
+    },
+    {
+      "tag": "CreateDirective",
+      "location": {
+        "path": {
+          "tag": "Field",
+          "model": "Project",
+          "field": "maxBuildAllowed"
+        },
+        "directive": "default"
+      }
+    },
+    {
+      "tag": "CreateArgument",
+      "location": {
+        "tag": "Directive",
+        "path": {
+          "tag": "Field",
+          "model": "Project",
+          "field": "maxBuildAllowed"
+        },
+        "directive": "default"
+      },
+      "argument": "",
+      "value": "100"
+    }
+  ]
+}
diff --git a/prisma/migrations/migrate.lock b/prisma/migrations/migrate.lock
@@ -18,4 +18,5 @@
 20210405171118-github_243-set-empty-test-variation-tags-instead-of-null
 20210425191116-github_215_project_config
 20210517203552-add-custom-tags
-20210605124856-image-compare-config-as-json
+20210605124856-image-compare-config-as-json
+20210612140950-limit-build-number
diff --git a/prisma/schema.prisma b/prisma/schema.prisma
@@ -31,6 +31,7 @@ model Project {
   mainBranchName        String          @default("master")
   builds                Build[]
   buildsCounter         Int             @default(0)
+  maxBuildAllowed       Int             @default(100)
   testVariations        TestVariation[]
   updatedAt             DateTime        @updatedAt
   createdAt             DateTime        @default(now())
diff --git a/src/_data_/index.ts b/src/_data_/index.ts
@@ -4,6 +4,7 @@ export const TEST_PROJECT: Project = {
   id: '1',
   name: 'Test Project',
   buildsCounter: 2,
+  maxBuildAllowed: 100,
   mainBranchName: 'master',
   createdAt: new Date(),
   updatedAt: new Date(),
diff --git a/src/builds/builds.controller.spec.ts b/src/builds/builds.controller.spec.ts
@@ -16,6 +16,7 @@ const initController = async ({
   buildFindOrCreateMock = jest.fn(),
   buildIncrementBuildNumberMock = jest.fn(),
   eventBuildCreatedMock = jest.fn(),
+  deleteOldBuilds = jest.fn(),
 }) => {
   const module: TestingModule = await Test.createTestingModule({
     controllers: [BuildsController],
@@ -31,6 +32,7 @@ const initController = async ({
         useValue: {
           findOrCreate: buildFindOrCreateMock,
           incrementBuildNumber: buildIncrementBuildNumberMock,
+          deleteOldBuilds: deleteOldBuilds,
         },
       },
       { provide: EventsGateway, useValue: { buildCreated: eventBuildCreatedMock } },
@@ -60,7 +62,7 @@ describe('Builds Controller', () => {
     number: 12,
   };
 
-  beforeEach(async () => {});
+  beforeEach(async () => { });
 
   it('should be defined', async () => {
     controller = await initController({});
@@ -72,16 +74,19 @@ describe('Builds Controller', () => {
     const projectFindOneMock = jest.fn().mockResolvedValueOnce(project);
     const buildFindOrCreateMock = jest.fn().mockResolvedValueOnce(newBuild);
     const buildIncrementBuildNumberMock = jest.fn().mockResolvedValueOnce(buildWithNumber);
+    const deleteOldBuilds = jest.fn();
     controller = await initController({
       projectFindOneMock,
       buildFindOrCreateMock,
       buildIncrementBuildNumberMock,
       eventBuildCreatedMock,
+      deleteOldBuilds,
     });
 
     const result = await controller.create(createBuildDto);
 
     expect(result).toStrictEqual(new BuildDto(buildWithNumber));
+    expect(deleteOldBuilds).toHaveBeenCalledWith(project.id, project.maxBuildAllowed);
     expect(buildIncrementBuildNumberMock).toHaveBeenCalledWith(newBuild.id, project.id);
     expect(eventBuildCreatedMock).toHaveBeenCalledWith(new BuildDto(buildWithNumber));
   });
@@ -90,10 +95,12 @@ describe('Builds Controller', () => {
     const eventBuildCreatedMock = jest.fn();
     const projectFindOneMock = jest.fn().mockResolvedValueOnce(project);
     const buildFindOrCreateMock = jest.fn().mockResolvedValueOnce(buildWithNumber);
+    const deleteOldBuilds = jest.fn();
     controller = await initController({
       projectFindOneMock,
       buildFindOrCreateMock,
       eventBuildCreatedMock,
+      deleteOldBuilds,
     });
 
     const result = await controller.create(createBuildDto);
diff --git a/src/builds/builds.controller.ts b/src/builds/builds.controller.ts
@@ -35,7 +35,7 @@ export class BuildsController {
     private eventsGateway: EventsGateway,
     @Inject(forwardRef(() => ProjectsService))
     private projectService: ProjectsService
-  ) {}
+  ) { }
 
   @Get()
   @ApiOkResponse({ type: PaginatedBuildDto })
@@ -70,6 +70,7 @@ export class BuildsController {
   @UseGuards(ApiGuard)
   async create(@Body() createBuildDto: CreateBuildDto): Promise<BuildDto> {
     const project = await this.projectService.findOne(createBuildDto.project);
+    await this.buildsService.deleteOldBuilds(project.id, project.maxBuildAllowed);
     let build = await this.buildsService.findOrCreate({
       projectId: project.id,
       branchName: createBuildDto.branchName,
diff --git a/src/builds/builds.service.spec.ts b/src/builds/builds.service.spec.ts
@@ -3,8 +3,7 @@ import { BuildsService } from './builds.service';
 import { PrismaService } from '../prisma/prisma.service';
 import { TestRunsService } from '../test-runs/test-runs.service';
 import { EventsGateway } from '../shared/events/events.gateway';
-import { CreateBuildDto } from './dto/build-create.dto';
-import { Build, TestRun, Project, TestStatus } from '@prisma/client';
+import { Build, TestRun, TestStatus } from '@prisma/client';
 import { mocked } from 'ts-jest/utils';
 import { BuildDto } from './dto/build.dto';
 import { ProjectsService } from '../projects/projects.service';
@@ -24,6 +23,7 @@ const initService = async ({
   testRunFindManyMock = jest.fn(),
   eventsBuildUpdatedMock = jest.fn(),
   eventsBuildCreatedMock = jest.fn(),
+  eventBuildDeletedMock = jest.fn(),
   projectFindOneMock = jest.fn(),
   projectUpdateMock = jest.fn(),
 }) => {
@@ -60,6 +60,7 @@ const initService = async ({
         useValue: {
           buildUpdated: eventsBuildUpdatedMock,
           buildCreated: eventsBuildCreatedMock,
+          buildDeleted: eventBuildDeletedMock,
         },
       },
       {
@@ -108,7 +109,7 @@ describe('BuildsService', () => {
         device: null,
         os: null,
         viewport: '1800x1600',
-        customTags:'',
+        customTags: '',
         baselineName: null,
         ignoreAreas: '[]',
         tempIgnoreAreas: '[]',
@@ -177,9 +178,11 @@ describe('BuildsService', () => {
 
   it('delete', async () => {
     const buildFindUniqueMock = jest.fn().mockResolvedValueOnce(build);
-    const buildDeleteMock = jest.fn();
+    const buildFindManyMock = jest.fn().mockImplementation(() => Promise.resolve(build));
+    const buildDeleteMock = jest.fn().mockImplementation(() => Promise.resolve(build));
     const testRunDeleteMock = jest.fn();
-    service = await initService({ buildFindUniqueMock, buildDeleteMock, testRunDeleteMock });
+    const eventBuildDeletedMock = jest.fn();
+    service = await initService({ buildFindUniqueMock, buildDeleteMock, testRunDeleteMock, eventBuildDeletedMock, buildFindManyMock });
 
     await service.remove(build.id);
 
@@ -190,6 +193,7 @@ describe('BuildsService', () => {
       },
     });
     expect(testRunDeleteMock).toHaveBeenCalledWith(build.testRuns[0].id);
+    expect(eventBuildDeletedMock).toHaveBeenCalledWith(new BuildDto(build));
     expect(buildDeleteMock).toHaveBeenCalledWith({
       where: { id: build.id },
     });
diff --git a/src/builds/builds.service.ts b/src/builds/builds.service.ts
diff --git a/src/projects/dto/project.dto.ts b/src/projects/dto/project.dto.ts
diff --git a/src/projects/projects.service.ts b/src/projects/projects.service.ts
diff --git a/src/shared/events/events.gateway.ts b/src/shared/events/events.gateway.ts
