test(common): added test for fieldname in validation pipes

nestjs · Sep 18, 2023 · 9a72802 · 9a72802
1 parent 7ddc06e
commit 9a72802
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 12 deletions.
diff --git a/packages/common/pipes/parse-uuid.pipe.ts b/packages/common/pipes/parse-uuid.pipe.ts
@@ -61,7 +61,7 @@ export class ParseUUIDPipe implements PipeTransform<string> {
       throw this.exceptionFactory(
         `Validation failed (uuid${
           this.version ? ` v ${this.version}` : ''
-        } is expected in ${metadata.data})`,
+        } is expected in "${metadata.data}")`,
       );
     }
     return value;

diff --git a/packages/common/test/pipes/parse-array.pipe.spec.ts b/packages/common/test/pipes/parse-array.pipe.spec.ts
@@ -43,6 +43,11 @@ describe('ParseArrayPipe', () => {
       beforeEach(() => {
         target = new ParseArrayPipe();
       });
+      it('should mention the field name in the error', async () => {
+        return expect(
+          target.transform(true, { data: 'foo' } as ArgumentMetadata),
+        ).to.be.rejectedWith(/.*Validation failed.*"foo".*/);
+      });
       it('should throw an exception (boolean)', async () => {
         return expect(
           target.transform(true, {} as ArgumentMetadata),

diff --git a/packages/common/test/pipes/parse-bool.pipe.spec.ts b/packages/common/test/pipes/parse-bool.pipe.spec.ts
@@ -1,6 +1,7 @@
 import { expect } from 'chai';
 import { ArgumentMetadata } from '../../interfaces';
 import { ParseBoolPipe } from '../../pipes/parse-bool.pipe';
+import { BadRequestException } from '../../exceptions';
 
 describe('ParseBoolPipe', () => {
   let target: ParseBoolPipe;
@@ -27,8 +28,14 @@ describe('ParseBoolPipe', () => {
     });
     describe('when validation fails', () => {
       it('should throw an error', async () => {
-        return expect(target.transform('123abc', {} as ArgumentMetadata)).to.be
-          .rejected;
+        return expect(
+          target.transform('123abc', {} as ArgumentMetadata),
+        ).to.be.rejectedWith(BadRequestException);
+      });
+      it('should mention the field name in the error', async () => {
+        return expect(
+          target.transform('123abc', { data: 'foo' } as ArgumentMetadata),
+        ).to.be.rejectedWith(/.*Validation failed.*"foo".*/);
       });
     });
   });

diff --git a/packages/common/test/pipes/parse-float.pipe.spec.ts b/packages/common/test/pipes/parse-float.pipe.spec.ts
@@ -2,7 +2,7 @@ import * as sinon from 'sinon';
 import { expect } from 'chai';
 import { ArgumentMetadata } from '../../interfaces';
 import { ParseFloatPipe } from '../../pipes/parse-float.pipe';
-import { HttpException } from '../../exceptions';
+import { BadRequestException, HttpException } from '../../exceptions';
 
 class CustomTestError extends HttpException {
   constructor() {
@@ -13,9 +13,7 @@ class CustomTestError extends HttpException {
 describe('ParseFloatPipe', () => {
   let target: ParseFloatPipe;
   beforeEach(() => {
-    target = new ParseFloatPipe({
-      exceptionFactory: (error: any) => new CustomTestError(),
-    });
+    target = new ParseFloatPipe();
   });
   describe('transform', () => {
     describe('when validation passes', () => {
@@ -35,6 +33,23 @@ describe('ParseFloatPipe', () => {
       it('should throw an error', async () => {
         return expect(
           target.transform('123.123abc', {} as ArgumentMetadata),
+        ).to.be.rejectedWith(BadRequestException);
+      });
+      it('should mention the field name in the error', async () => {
+        return expect(
+          target.transform('123.123abc', { data: 'foo' } as ArgumentMetadata),
+        ).to.be.rejectedWith(/.*Validation failed.*"foo".*/);
+      });
+    });
+    describe('with an exceptionFactory', () => {
+      beforeEach(() => {
+        target = new ParseFloatPipe({
+          exceptionFactory: (error: any) => new CustomTestError(),
+        });
+      });
+      it('uses it when the validation fails', async () => {
+        return expect(
+          target.transform('123abc', {} as ArgumentMetadata),
         ).to.be.rejectedWith(CustomTestError);
       });
     });

diff --git a/packages/common/test/pipes/parse-int.pipe.spec.ts b/packages/common/test/pipes/parse-int.pipe.spec.ts
@@ -1,7 +1,7 @@
 import { expect } from 'chai';
 import { ArgumentMetadata } from '../../interfaces';
 import { ParseIntPipe } from '../../pipes/parse-int.pipe';
-import { HttpException } from '../../exceptions';
+import { BadRequestException, HttpException } from '../../exceptions';
 
 class CustomTestError extends HttpException {
   constructor() {
@@ -12,9 +12,7 @@ class CustomTestError extends HttpException {
 describe('ParseIntPipe', () => {
   let target: ParseIntPipe;
   beforeEach(() => {
-    target = new ParseIntPipe({
-      exceptionFactory: (error: any) => new CustomTestError(),
-    });
+    target = new ParseIntPipe();
   });
   describe('transform', () => {
     describe('when validation passes', () => {
@@ -37,14 +35,31 @@ describe('ParseIntPipe', () => {
       });
     });
     describe('when validation fails', () => {
+      it('should mention the field name in the error', async () => {
+        return expect(
+          target.transform('123abc', { data: 'foo' } as ArgumentMetadata),
+        ).to.be.rejectedWith(/.*Validation failed.*"foo".*/);
+      });
       it('should throw an error', async () => {
         return expect(
           target.transform('123abc', {} as ArgumentMetadata),
-        ).to.be.rejectedWith(CustomTestError);
+        ).to.be.rejectedWith(BadRequestException);
       });
       it('should throw an error when number has wrong number encoding', async () => {
         return expect(
           target.transform('0xFF', {} as ArgumentMetadata),
+        ).to.be.rejectedWith(BadRequestException);
+      });
+    });
+    describe('with an exceptionFactory', () => {
+      beforeEach(() => {
+        target = new ParseIntPipe({
+          exceptionFactory: (error: any) => new CustomTestError(),
+        });
+      });
+      it('uses it when the validation fails', async () => {
+        return expect(
+          target.transform('123abc', {} as ArgumentMetadata),
         ).to.be.rejectedWith(CustomTestError);
       });
     });

diff --git a/packages/common/test/pipes/parse-uuid.pipe.spec.ts b/packages/common/test/pipes/parse-uuid.pipe.spec.ts
@@ -56,6 +56,13 @@ describe('ParseUUIDPipe', () => {
         ).to.be.rejectedWith(TestException);
       });
 
+      it('should mention the field name in the error', async () => {
+        target = new ParseUUIDPipe();
+        await expect(
+          target.transform('123a', { data: 'foo' } as ArgumentMetadata),
+        ).to.be.rejectedWith(/.*Validation failed.*"foo".*/);
+      });
+
       it('should throw an error - not a string', async () => {
         target = new ParseUUIDPipe({ exceptionFactory });
         await expect(