feat(312): add optional comment property for test runs (#170)

Author: dimitriharding

src/test-runs/dto/create-test-request.dto.ts

@@ -1,6 +1,6 @@
 import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 import { Transform } from 'class-transformer';
-import { IsOptional, IsUUID, IsNumber, IsBoolean } from 'class-validator';
+import { IsOptional, IsUUID, IsNumber, IsBoolean, IsString } from 'class-validator';
 import { isArray } from 'lodash';
 import { BaselineDataDto } from '../../shared/dto/baseline-data.dto';
 import { IgnoreAreaDto } from './ignore-area.dto';
@@ -17,13 +17,13 @@ export class CreateTestRequestDto extends BaselineDataDto {
   @ApiPropertyOptional()
   @IsOptional()
   @IsNumber()
-  @Transform(({value}) => parseFloat(value))
+  @Transform(({ value }) => parseFloat(value))
   diffTollerancePercent?: number;
 
   @ApiPropertyOptional()
   @IsBoolean()
   @IsOptional()
-  @Transform(({value}) => {
+  @Transform(({ value }) => {
     switch (value) {
       case 'true':
         return true;
@@ -37,11 +37,16 @@ export class CreateTestRequestDto extends BaselineDataDto {
 
   @ApiPropertyOptional({ type: [IgnoreAreaDto] })
   @IsOptional()
-  @Transform(({value}) => {
+  @Transform(({ value }) => {
     if (isArray(value)) {
       return it;
     }
     return JSON.parse(value);
   })
   ignoreAreas?: IgnoreAreaDto[];
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString()
+  comment?: string;
 }

src/test-runs/test-runs.service.spec.ts

@@ -504,6 +504,7 @@ describe('TestRunsService', () => {
       device: 'device',
       branchName: 'develop',
       customTags: 'customTags',
+      comment: 'new comment',
     };
     const testVariation: TestVariation = {
       id: '123',

src/test-runs/test-runs.service.ts

@@ -34,9 +34,7 @@ export class TestRunsService {
     return list.map((item) => new TestRunDto(item));
   }
 
-  async findOne(
-    id: string
-  ): Promise<
+  async findOne(id: string): Promise<
     TestRun & {
       testVariation?: TestVariation;
     }
@@ -233,7 +231,7 @@ export class TestRunsService {
         baselineBranchName: testVariation.branchName,
         ignoreAreas: testVariation.ignoreAreas,
         tempIgnoreAreas: JSON.stringify(createTestRequestDto.ignoreAreas),
-        comment: testVariation.comment,
+        comment: createTestRequestDto.comment || testVariation.comment,
         diffTollerancePercent: createTestRequestDto.diffTollerancePercent,
         branchName: createTestRequestDto.branchName,
         merge: createTestRequestDto.merge,

test/test-runs.e2e-spec.ts

@@ -218,6 +218,7 @@ describe('TestRuns (e2e)', () => {
         .field('diffTollerancePercent', '0.12')
         .field('merge', 'false')
         .field('ignoreAreas', '[]')
+        .field('comment', 'Comment')
         .attach('image', image_v1)
         .expect(201);
     });