fix: support for pattern in random path generation (stoplightio#699)

karol-maciaszek · XVincentX · commit 0be47a649029 · 2019-10-14T09:55:35.000+02:00
diff --git a/packages/http/src/mocker/generator/HttpParamGenerator.ts b/packages/http/src/mocker/generator/HttpParamGenerator.ts
@@ -4,7 +4,7 @@ import { pipe } from 'fp-ts/lib/pipeable';
 import { JSONSchema } from '../../types';
 import { generate as generateDynamicExample } from './JSONSchema';
 
-function improveSchema(schema: JSONSchema) {
+export function improveSchema(schema: JSONSchema) {
   const newSchema = { ...schema };
 
   if (newSchema.type === 'integer' || newSchema.type === 'number') {
@@ -18,7 +18,7 @@ function improveSchema(schema: JSONSchema) {
   }
 
   if (newSchema.type === 'string') {
-    if (!newSchema.format && !newSchema.enum) {
+    if (!newSchema.format && !newSchema.enum && !newSchema.pattern) {
       newSchema['x-faker'] = 'lorem.word';
     }
   }
diff --git a/packages/http/src/mocker/generator/__tests__/HttpParamGenerator.spec.ts b/packages/http/src/mocker/generator/__tests__/HttpParamGenerator.spec.ts
@@ -1,6 +1,6 @@
 import { assertNone, assertSome } from '@stoplight/prism-core/src/utils/__tests__/utils';
 import { HttpParamStyles } from '@stoplight/types';
-import { generate } from '../HttpParamGenerator';
+import { generate, improveSchema } from '../HttpParamGenerator';
 
 describe('HttpParamGenerator', () => {
   describe('generate()', () => {
@@ -50,4 +50,50 @@ describe('HttpParamGenerator', () => {
       });
     });
   });
+
+  describe('improveSchema()', () => {
+    describe.each(['number', 'integer'])('when feed with a %s', type => {
+      // @ts-ignore
+      const improvedSchema = improveSchema({ type });
+
+      it('should have a minimum and a maximum', () => {
+        expect(improvedSchema).toHaveProperty('minimum', 1);
+        expect(improvedSchema).toHaveProperty('maximum', 1000);
+      });
+    });
+
+    describe('when feed with string', () => {
+      describe('no format and no enum', () => {
+        const improvedSchema = improveSchema({ type: 'string' });
+
+        it('should have the x-faker extension', () => {
+          expect(improvedSchema).toHaveProperty('x-faker', 'lorem.word');
+        });
+      });
+
+      describe.each<{ 0: string; 1: object }>([['format', { format: 'email' }], ['enum', { enum: [1, 2, 3] }], ['pattern',  { pattern: '^[A-Z]+$' }]])(
+        'when with %s',
+        (_a, additional) => {
+          const improvedSchema = improveSchema({ type: 'string', ...additional });
+
+          it('should not have the x-faker extension', () => expect(improvedSchema).not.toHaveProperty('x-faker'));
+        },
+      );
+    });
+
+    describe('when feed with object', () => {
+      describe('no format and no enum', () => {
+        const improvedSchema = improveSchema({
+          type: 'object',
+          properties: { a: { type: 'string' }, b: { type: 'number' } },
+        });
+
+        it('will recursively improve the schema', () => {
+          expect(improvedSchema).toHaveProperty('properties.a.x-faker', 'lorem.word');
+          expect(improvedSchema).toHaveProperty('properties.b.minimum', 1);
+          expect(improvedSchema).toHaveProperty('properties.b.maximum', 1000);
+        });
+      });
+    });
+  });
 });

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ import { pipe } from 'fp-ts/lib/pipeable';`
`4`	`4`	`import { JSONSchema } from '../../types';`
`5`	`5`	`import { generate as generateDynamicExample } from './JSONSchema';`
`6`	`6`
`7`		`-function improveSchema(schema: JSONSchema) {`
	`7`	`+export function improveSchema(schema: JSONSchema) {`
`8`	`8`	`const newSchema = { ...schema };`
`9`	`9`
`10`	`10`	`if (newSchema.type === 'integer' \|\| newSchema.type === 'number') {`
`@@ -18,7 +18,7 @@ function improveSchema(schema: JSONSchema) {`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`if (newSchema.type === 'string') {`
`21`		`- if (!newSchema.format && !newSchema.enum) {`
	`21`	`+ if (!newSchema.format && !newSchema.enum && !newSchema.pattern) {`
`22`	`22`	`newSchema['x-faker'] = 'lorem.word';`
`23`	`23`	`}`
`24`	`24`	`}`