fix(oas3): refactors, add test, remove file

Author: Marco Friso

packages/fury-adapter-oas3-parser/lib/parser/oas/parseHostsObject.js

@@ -144,11 +144,7 @@ function parseOASObject(context, object) {
       }
 
       if (hosts) {
-        if (!hosts.isEmpty) {
-          api.push(new namespace.elements.Category(
-            hosts.content, { classes: ['hosts'] }
-          ));
-        }
+        api.push(hosts);
       }
 
       const resources = object.get('paths');

packages/fury-adapter-oas3-parser/lib/parser/oas/parseOpenAPIObject.js

@@ -16,16 +16,15 @@ const requiredKeys = ['url'];
 const parseMember = context => R.cond([
   [hasKey('description'), parseString(context, name, false)],
   [hasKey('url'), parseString(context, name, true)],
-  // [hasKey('variables'), R.compose(parseServerVariablesObject(context), getValue)], // NOT SUPPORTED YET
-  [hasKey('variables'), createUnsupportedMemberWarning(context.namespace, name)],
+  [hasKey('variables'), createUnsupportedMemberWarning(context.namespace, name)], // NOT SUPPORTED YET
   [isExtension, () => new context.namespace.elements.ParseResult()],
   [R.T, createInvalidMemberWarning(context.namespace, name)],
 ]);
 
 /**
  * Parse the OpenAPI 'Server Object' (`#/server`)
  * @see http://spec.openapis.org/oas/v3.0.3#server-object
- * @returns ParseResult<Link>
+ * @returns ParseResult<Resource>
  * @private
  */
 const parseServerObject = context => pipeParseResult(context.namespace,
@@ -37,11 +36,10 @@ const parseServerObject = context => pipeParseResult(context.namespace,
     resource.classes.push('host');
 
     if (object.hasKey('description')) {
-      const description = object.getValue('description');
-      resource.description = description;
+      resource.description = object.get('description');
     }
 
-    resource.href = object.getValue('url');
+    resource.href = object.get('url');
 
     return resource;
   });

packages/fury-adapter-oas3-parser/lib/parser/oas/parseServerObject.js

@@ -18,7 +18,11 @@ function parseServersArray(context, element) {
   const { namespace } = context;
 
   const parseServers = pipeParseResult(namespace,
-    parseArray(context, name, R.curry(parseServerObject)(context)));
+    parseArray(context, name, R.curry(parseServerObject)(context)),
+    array => new namespace.elements.Category(
+      array.content, { classes: ['hosts'] }
+    ));
+
   return parseServers(element);
 }
 

packages/fury-adapter-oas3-parser/lib/parser/oas/parseServersArray.js

@@ -72,14 +72,14 @@ describe('#parseOpenAPIObject', () => {
     expect(parseResult.api.title.toValue()).to.equal('My API');
     expect(parseResult.api.length).to.equal(1);
 
-    const serversArray = parseResult.api.get(0);
-    expect(serversArray).to.be.instanceof(namespace.elements.Category);
-    expect(serversArray.classes.toValue()).to.deep.equal(['hosts']);
-    expect(serversArray.length).to.equal(2);
+    const hostsCategory = parseResult.api.get(0);
+    expect(hostsCategory).to.be.instanceof(namespace.elements.Category);
+    expect(hostsCategory.classes.toValue()).to.deep.equal(['hosts']);
+    expect(hostsCategory.length).to.equal(2);
 
-    const firstServer = serversArray.get(0);
+    const firstServer = hostsCategory.get(0);
     expect(firstServer).to.be.instanceof(namespace.elements.Resource);
-    expect(firstServer.attributes.content[0].toValue().value).to.equal('https://user.server.com/1.0');
+    expect(firstServer.href.toValue()).to.equal('https://user.server.com/1.0');
   });
 
   describe('with schema components', () => {
@@ -219,22 +219,6 @@ describe('#parseOpenAPIObject', () => {
     expect(parseResult).to.contain.warning("'OpenAPI Object' contains unsupported key 'externalDocs'");
   });
 
-  it('provides warning for unsupported servers key', () => {
-    const object = new namespace.elements.Object({
-      openapi: '3.0.0',
-      info: {
-        title: 'My API',
-        version: '1.0.0',
-      },
-      paths: {},
-      servers: [],
-    });
-
-    const parseResult = parse(context, object);
-
-    expect(parseResult).to.contain.warning("'OpenAPI Object' contains unsupported key 'servers'");
-  });
-
   it('provides warning for invalid keys', () => {
     const object = new namespace.elements.Object({
       openapi: '3.0.0',

packages/fury-adapter-oas3-parser/test/unit/parser/oas/parseOpenAPIObject-test.js

@@ -22,6 +22,26 @@ describe('#parseHostsObject', () => {
   });
 
   describe('#url', () => {
+    it('warns when server object does not contain URL', () => {
+      const server = new namespace.elements.Object({
+      });
+
+      const parseResult = parse(context)(server);
+      expect(parseResult.length).to.equal(1);
+      expect(parseResult).to.contain.warning("'Server Object' is missing required property 'url'");
+    });
+
+    it('warns when URL is not a string', () => {
+      const server = new namespace.elements.Object({
+        url: 1234,
+        description: 'The production API server',
+      });
+
+      const parseResult = parse(context)(server);
+      expect(parseResult).to.contain.annotations;
+      expect(parseResult).to.contain.error("'Server Object' 'url' is not a string");
+    });
+
     it('parse server object with URL', () => {
       const server = new namespace.elements.Object({
         url: 'https://{username}.gigantic-server.com/{version}',
@@ -38,15 +58,6 @@ describe('#parseHostsObject', () => {
       const href = resource.href.toValue();
       expect(href).to.be.equal('https://{username}.gigantic-server.com/{version}');
     });
-
-    it('warns when server object does not contain URL', () => {
-      const server = new namespace.elements.Object({
-      });
-
-      const parseResult = parse(context)(server);
-      expect(parseResult.length).to.equal(1);
-      expect(parseResult).to.contain.warning("'Server Object' is missing required property 'url'");
-    });
   });
 
   describe('#description', () => {
@@ -58,6 +69,7 @@ describe('#parseHostsObject', () => {
 
       const parseResult = parse(context)(server);
       expect(parseResult.get(0)).to.be.instanceof(namespace.elements.Resource);
+      expect(parseResult).to.contain.annotations;
       expect(parseResult).to.contain.warning("'Server Object' 'description' is not a string");
     });
 

packages/fury-adapter-oas3-parser/test/unit/parser/oas/parseServerObject-test.js

@@ -5,7 +5,7 @@ const Context = require('../../../../lib/context');
 
 const { minim: namespace } = new Fury();
 
-describe('Servers Array', () => {
+describe('#parseHostsObject', () => {
   let context;
 
   beforeEach(() => {
@@ -33,14 +33,15 @@ describe('Servers Array', () => {
 
     expect(parseResult.length).to.equal(1);
 
-    const servers = parseResult.get(0);
+    const hosts = parseResult.get(0);
+    const host = hosts.get(0);
 
-    expect(servers).to.be.instanceof(namespace.elements.Array);
-    expect(servers.length).to.equal(1);
-    expect(servers.get(0)).to.be.instanceof(namespace.elements.Resource);
-    expect(servers.get(0).meta.content[0].content.value.content[0].content).to.equal('host');
-    expect(servers.get(0).meta.content[1].content.value.content).to.equal('The production API server');
-    expect(servers.get(0).attributes.content[0].content.value.content).to.equal('https://user.server.com/1.0');
+    expect(hosts).to.be.instanceof(namespace.elements.Array);
+    expect(hosts.length).to.equal(1);
+    expect(host).to.be.instanceof(namespace.elements.Resource);
+    expect(host.classes.toValue()).to.deep.equal(['host']);
+    expect(host.description.toValue()).to.equal('The production API server');
+    expect(host.href.toValue()).to.equal('https://user.server.com/1.0');
   });
 
   it('parses correctly when there are multiple servers', () => {
@@ -58,17 +59,19 @@ describe('Servers Array', () => {
 
     expect(parseResult.length).to.equal(1);
 
-    const servers = parseResult.get(0);
+    const hosts = parseResult.get(0);
+    const firstHost = hosts.get(0);
+    const secondHost = hosts.get(1);
 
-    expect(servers).to.be.instanceof(namespace.elements.Array);
-    expect(servers.length).to.equal(2);
-    expect(servers.get(0)).to.be.instanceof(namespace.elements.Resource);
-    expect(servers.get(0).meta.content[0].content.value.content[0].content).to.equal('host');
-    expect(servers.get(0).attributes.content[0].content.value.content).to.equal('https://user.server.com/1.0');
+    expect(hosts).to.be.instanceof(namespace.elements.Array);
+    expect(hosts.length).to.equal(2);
+    expect(firstHost).to.be.instanceof(namespace.elements.Resource);
+    expect(firstHost.classes.toValue()).to.deep.equal(['host']);
+    expect(firstHost.href.toValue()).to.equal('https://user.server.com/1.0');
 
-    expect(servers.get(1)).to.be.instanceof(namespace.elements.Resource);
-    expect(servers.get(1).meta.content[0].content.value.content[0].content).to.equal('host');
-    expect(servers.get(1).meta.content[1].content.value.content).to.equal('The production API server');
-    expect(servers.get(1).attributes.content[0].content.value.content).to.equal('https://user.server.com/2.0');
+    expect(secondHost).to.be.instanceof(namespace.elements.Resource);
+    expect(secondHost.classes.toValue()).to.deep.equal(['host']);
+    expect(secondHost.description.toValue()).to.equal('The production API server');
+    expect(secondHost.href.toValue()).to.equal('https://user.server.com/2.0');
   });
 });