fix: SL-2192 stringify examples (#205)

* fix: SL-2191 repaired mock config switch * chore: SL-2191 separated config from components * fix: SL-2191 fixed cli tests * fix: SL-2191 fixed tests * fix: SL-2191 config as a separate parameter for prism * fix: SL-2191 fixed tests * fix: SL-2191 removed unneeded merge of defaultConfig * fix: SL-2192 forced examples to be stringified * fix: SL-2192 specific static examples fixture * fix: SL-2192 trimmed static example
stoplightio · Apr 2, 2019 · bbf6492 · bbf6492
1 parent 7621f8a
commit bbf6492
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 20 deletions.
diff --git a/packages/http/src/__tests__/fixtures/static-examples.oas2.json b/packages/http/src/__tests__/fixtures/static-examples.oas2.json
@@ -0,0 +1,32 @@
+{
+  "swagger": "2.0",
+  "paths": {
+    "/todos": {
+      "get": {
+        "produces": [
+          "application/json"
+        ],
+        "responses": {
+          "200": {
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "name": {"type": "string"},
+                  "completed": {"type": ["boolean", "null"]}
+                },
+                "required": ["name", "completed"]
+              }
+            },
+            "examples": {
+              "application/json": [
+                {"id": 1, "name": "design the thingz", "completed": true}
+              ]
+            }
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/packages/http/src/__tests__/http-prism-instance.spec.ts b/packages/http/src/__tests__/http-prism-instance.spec.ts
@@ -131,4 +131,21 @@ describe('Http Prism Instance function tests', () => {
 
     expect(prism.resources).toHaveLength(5);
   });
+
+  test('returns stringified static example when one defined in spec', async () => {
+    prism = createInstance();
+    await prism.load({
+      path: relative(process.cwd(), resolve(__dirname, 'fixtures', 'static-examples.oas2.json')),
+    });
+
+    const response = await prism.process({
+      method: 'get',
+      url: {
+        path: '/todos',
+      },
+    });
+
+    expect(response.output).toBeDefined();
+    expect(typeof response.output!.body).toBe('string');
+  });
 });
diff --git a/packages/http/src/mocker/HttpMocker.ts b/packages/http/src/mocker/HttpMocker.ts
@@ -59,7 +59,7 @@ Here is the original validation result instead: ${JSON.stringify(input.validatio
     const example = negotiationResult.example;
 
     if (example && 'value' in example && example.value !== undefined) {
-      body = example.value;
+      body = typeof example.value === 'string' ? example.value : JSON.stringify(example.value);
     } else if (negotiationResult.schema) {
       body = await this._exampleGenerator.generate(
         negotiationResult.schema,

diff --git a/packages/http/src/mocker/__tests__/__snapshots__/functional.spec.ts.snap b/packages/http/src/mocker/__tests__/__snapshots__/functional.spec.ts.snap
@@ -2,11 +2,7 @@
 
 exports[`http mocker request is invalid returns 400 and static error response 1`] = `
 Object {
-  "body": Array [
-    Object {
-      "message": "error",
-    },
-  ],
+  "body": "[{\\"message\\":\\"error\\"}]",
   "headers": Object {
     "Content-type": "application/json",
   },
@@ -16,13 +12,7 @@ Object {
 
 exports[`http mocker request is valid HttpOperation contains example return lowest 2xx code and match response example to media type accepted by request 1`] = `
 Object {
-  "body": Array [
-    Object {
-      "completed": true,
-      "id": 1,
-      "name": "make prism",
-    },
-  ],
+  "body": "[{\\"id\\":1,\\"completed\\":true,\\"name\\":\\"make prism\\"}]",
   "headers": Object {
     "Content-type": "application/json",
   },
@@ -54,13 +44,7 @@ Object {
 
 exports[`http mocker request is valid given enforced example key should return application/json, 200 response 1`] = `
 Object {
-  "body": Array [
-    Object {
-      "completed": false,
-      "id": 2,
-      "name": "make bears",
-    },
-  ],
+  "body": "[{\\"id\\":2,\\"completed\\":false,\\"name\\":\\"make bears\\"}]",
   "headers": Object {
     "Content-type": "application/json",
   },