feat(oas3): support generating body from schema with references

kylef · kylef · commit 759caec4623a · 2019-03-25T16:03:06.000Z
Closes #100 Closes #186
diff --git a/packages/fury-adapter-oas3-parser/CHANGELOG.md b/packages/fury-adapter-oas3-parser/CHANGELOG.md
@@ -7,8 +7,8 @@
 - Added primitive support for 'examples' in 'Media Type Object'. The first
   example value is used for JSON media types.
 
-- Added primitive support for generating a JSON message body from a schema for
-  JSON media types. Referencing is not supported for this feature.
+- Added support for generating a JSON message body from a schema for
+  JSON media types.
 
 - Added support for header parameters.
 
diff --git a/packages/fury-adapter-oas3-parser/lib/parser/oas/parseComponentsObject.js b/packages/fury-adapter-oas3-parser/lib/parser/oas/parseComponentsObject.js
@@ -119,7 +119,14 @@ function parseComponentsObject(context, element) {
       validateIsObject,
       R.compose(parseObject(context, name, parseMember), getValue),
       (object) => {
-        context.state.components.push(new namespace.elements.Member(member.key, object));
+        const contextMember = context.state.components.getMember(member.key.toValue());
+
+        if (contextMember) {
+          contextMember.value = object;
+        } else {
+          context.state.components.push(new namespace.elements.Member(member.key, object));
+        }
+
         return object;
       })(member);
   };
@@ -169,7 +176,8 @@ function parseComponentsObject(context, element) {
     [R.T, createInvalidMemberWarning(namespace, name)],
   ]);
 
-  return parseObject(context, name, parseMember)(element);
+  const order = ['schemas'];
+  return parseObject(context, name, parseMember, [], order)(element);
 }
 
 
diff --git a/packages/fury-adapter-oas3-parser/lib/parser/oas/parseMediaTypeObject.js b/packages/fury-adapter-oas3-parser/lib/parser/oas/parseMediaTypeObject.js
@@ -115,7 +115,18 @@ function parseMediaTypeObject(context, MessageBodyClass, element) {
       const dataStructure = mediaTypeObject.get('schema');
 
       if (!messageBody && dataStructure && isJSONMediaType(mediaType)) {
-        const value = dataStructure.content.valueOf();
+        let elements = [];
+        const { components } = context.state;
+        if (components) {
+          const schemas = components.get('schemas');
+          if (schemas) {
+            elements = schemas.content
+              .filter(e => e.value && e.value.content)
+              .map(e => e.value.content);
+          }
+        }
+
+        const value = dataStructure.content.valueOf(undefined, elements);
 
         if (value) {
           const body = JSON.stringify(value);
diff --git a/packages/fury-adapter-oas3-parser/test/integration/fixtures/components/media-type-object-schema.json b/packages/fury-adapter-oas3-parser/test/integration/fixtures/components/media-type-object-schema.json
@@ -101,7 +101,7 @@
                               "content": "application/json"
                             }
                           },
-                          "content": "{}"
+                          "content": "{\"name\":\"\",\"company\":{\"name\":\"\"}}"
                         },
                         {
                           "element": "dataStructure",
diff --git a/packages/fury-adapter-oas3-parser/test/integration/fixtures/components/responses-object-response-with-schema.json b/packages/fury-adapter-oas3-parser/test/integration/fixtures/components/responses-object-response-with-schema.json
@@ -82,6 +82,27 @@
                         }
                       },
                       "content": [
+                        {
+                          "element": "asset",
+                          "meta": {
+                            "classes": {
+                              "element": "array",
+                              "content": [
+                                {
+                                  "element": "string",
+                                  "content": "messageBody"
+                                }
+                              ]
+                            }
+                          },
+                          "attributes": {
+                            "contentType": {
+                              "element": "string",
+                              "content": "application/json"
+                            }
+                          },
+                          "content": "{}"
+                        },
                         {
                           "element": "dataStructure",
                           "content": {
diff --git a/packages/fury-adapter-oas3-parser/test/integration/fixtures/petstore.json b/packages/fury-adapter-oas3-parser/test/integration/fixtures/petstore.json
@@ -154,7 +154,7 @@
                               "content": "application/json"
                             }
                           },
-                          "content": "[]"
+                          "content": "[{\"id\":0,\"name\":\"\",\"tag\":\"\"}]"
                         },
                         {
                           "element": "dataStructure",
@@ -329,7 +329,7 @@
                               "content": "application/json"
                             }
                           },
-                          "content": "[]"
+                          "content": "[{\"id\":0,\"name\":\"\",\"tag\":\"\"}]"
                         },
                         {
                           "element": "dataStructure",
diff --git a/packages/fury-adapter-oas3-parser/test/integration/fixtures/petstore.sourcemap.json b/packages/fury-adapter-oas3-parser/test/integration/fixtures/petstore.sourcemap.json
@@ -404,7 +404,7 @@
                               "content": "application/json"
                             }
                           },
-                          "content": "[]"
+                          "content": "[{\"id\":0,\"name\":\"\",\"tag\":\"\"}]"
                         },
                         {
                           "element": "dataStructure",
@@ -854,7 +854,7 @@
                               "content": "application/json"
                             }
                           },
-                          "content": "[]"
+                          "content": "[{\"id\":0,\"name\":\"\",\"tag\":\"\"}]"
                         },
                         {
                           "element": "dataStructure",
diff --git a/packages/fury-adapter-oas3-parser/test/unit/parser/oas/parseMediaTypeObject-test.js b/packages/fury-adapter-oas3-parser/test/unit/parser/oas/parseMediaTypeObject-test.js
@@ -260,5 +260,75 @@ describe('Media Type Object', () => {
       expect(message.messageBody.toValue()).to.equal('{"name":"doe"}');
       expect(message.messageBody.contentType.toValue()).to.equal('application/json');
     });
+
+    it('generates a messageBody asset for JSON type with referenced schema with no examples', () => {
+      context.state.components = new namespace.elements.Object({
+        schemas: {
+          Name: new namespace.elements.DataStructure(
+            new namespace.elements.String('doe', {
+              id: 'Name',
+            })
+          ),
+        },
+      });
+
+      const mediaType = new namespace.elements.Member('application/json', {
+        schema: {
+          type: 'object',
+          properties: {
+            name: {
+              $ref: '#/components/schemas/Name',
+            },
+          },
+        },
+      });
+
+      const parseResult = parse(context, messageBodyClass, mediaType);
+
+      const message = parseResult.get(0);
+      expect(message).to.be.instanceof(messageBodyClass);
+      expect(message.messageBody.toValue()).to.equal('{"name":"doe"}');
+      expect(message.messageBody.contentType.toValue()).to.equal('application/json');
+    });
+
+    it('generates a messageBody asset for JSON type with circular referenced schema with no examples', () => {
+      const node = new namespace.Element();
+      node.element = 'Node';
+
+      const nodes = new namespace.Element();
+      nodes.element = 'Nodes';
+
+      context.state.components = new namespace.elements.Object({
+        schemas: {
+          Nodes: new namespace.elements.DataStructure(
+            new namespace.elements.Array({
+              node,
+            }, {
+              id: 'Nodes',
+            })
+          ),
+          Node: new namespace.elements.DataStructure(
+            new namespace.elements.Object({
+              parents: nodes,
+            }, {
+              id: 'Node',
+            })
+          ),
+        },
+      });
+
+      const mediaType = new namespace.elements.Member('application/json', {
+        schema: {
+          $ref: '#/components/schemas/Node',
+        },
+      });
+
+      const parseResult = parse(context, messageBodyClass, mediaType);
+
+      const message = parseResult.get(0);
+      expect(message).to.be.instanceof(messageBodyClass);
+      expect(message.messageBody.toValue()).to.equal('{"parents":[]}');
+      expect(message.messageBody.contentType.toValue()).to.equal('application/json');
+    });
   });
 });
diff --git a/packages/fury-adapter-oas3-parser/test/unit/parser/oas/parseResponseObject-test.js b/packages/fury-adapter-oas3-parser/test/unit/parser/oas/parseResponseObject-test.js
@@ -175,19 +175,14 @@ describe('Response Object', () => {
         },
       });
 
-      const dataStructure = new namespace.elements.DataStructure();
-      dataStructure.id = 'Node';
-
+      const pets = new namespace.elements.Array();
+      pets.id = 'Pets';
       context.state.components = new namespace.elements.Object({
         schemas: {
-          Node: dataStructure,
+          Pets: new namespace.elements.DataStructure(pets),
         },
       });
 
-      context.state.components.set('schemas', new namespace.elements.Object([
-        new namespace.elements.Member('Pets', new namespace.elements.Array()),
-      ]));
-
       const parseResult = parse(context, response);
 
       expect(parseResult.get(0).headers.length).to.be.equal(2);

Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@`
`101`	`101`	`"content": "application/json"`
`102`	`102`	`}`
`103`	`103`	`},`
`104`		`- "content": "{}"`
	`104`	`+ "content": "{\"name\":\"\",\"company\":{\"name\":\"\"}}"`
`105`	`105`	`},`
`106`	`106`	`{`
`107`	`107`	`"element": "dataStructure",`
Original file line number	Diff line number	Diff line change
`@@ -154,7 +154,7 @@`
`154`	`154`	`"content": "application/json"`
`155`	`155`	`}`
`156`	`156`	`},`
`157`		`- "content": "[]"`
	`157`	`+ "content": "[{\"id\":0,\"name\":\"\",\"tag\":\"\"}]"`
`158`	`158`	`},`
`159`	`159`	`{`
`160`	`160`	`"element": "dataStructure",`
`@@ -329,7 +329,7 @@`
`329`	`329`	`"content": "application/json"`
`330`	`330`	`}`
`331`	`331`	`},`
`332`		`- "content": "[]"`
	`332`	`+ "content": "[{\"id\":0,\"name\":\"\",\"tag\":\"\"}]"`
`333`	`333`	`},`
`334`	`334`	`{`
`335`	`335`	`"element": "dataStructure",`
Original file line number	Diff line number	Diff line change
`@@ -404,7 +404,7 @@`
`404`	`404`	`"content": "application/json"`
`405`	`405`	`}`
`406`	`406`	`},`
`407`		`- "content": "[]"`
	`407`	`+ "content": "[{\"id\":0,\"name\":\"\",\"tag\":\"\"}]"`
`408`	`408`	`},`
`409`	`409`	`{`
`410`	`410`	`"element": "dataStructure",`
`@@ -854,7 +854,7 @@`
`854`	`854`	`"content": "application/json"`
`855`	`855`	`}`
`856`	`856`	`},`
`857`		`- "content": "[]"`
	`857`	`+ "content": "[{\"id\":0,\"name\":\"\",\"tag\":\"\"}]"`
`858`	`858`	`},`
`859`	`859`	`{`
`860`	`860`	`"element": "dataStructure",`