test: navigation for raml fragments

Author: carowright

demo/apis.json

@@ -19,6 +19,14 @@
   "models/APIC-557/APIC-557.yaml": "OAS 3.0",
   "models/APIC-538/APIC-538.raml": "RAML 1.0",
   "models/test-api/test-api.raml": "RAML 1.0",
+  "models/test-api/basicAuth.raml": "RAML 1.0",
+  "models/test-api/documentation.raml": "RAML 1.0",
+  "models/test-api/extension.raml": "RAML 1.0",
+  "models/test-api/library.raml": "RAML 1.0",
+  "models/test-api/overlay.raml": "RAML 1.0",
+  "models/test-api/person.raml": "RAML 1.0",
+  "models/test-api/resourceType.raml": "RAML 1.0",
+  "models/test-api/secured.raml": "RAML 1.0",
   "models/anyOf/anyOf.yaml": "ASYNC 2.0",
   "models/streetlights/streetlights.yaml": "ASYNC 2.0",
   "models/visual-tests-raml/visual-tests-raml.raml": "RAML 1.0"

demo/models/test-api/basicAuth.raml

@@ -0,0 +1,5 @@
+#%RAML 1.0 SecurityScheme
+
+type: Basic Authentication
+displayName: BasicAuth
+description: This security scheme validates requests to the API using client ID and client Secret as basic auth

demo/models/test-api/documentation.raml

@@ -0,0 +1,10 @@
+#%RAML 1.0 DocumentationItem
+
+title: Home
+content: |
+  Welcome to the _Zencoder API_ Documentation. The _Zencoder API_
+  allows you to connect your application to our encoding service
+  and encode videos without going through the web  interface. You
+  may also benefit from one of our
+  [integration libraries](https://app.zencoder.com/docs/faq/basics/libraries)
+  for different languages.

demo/models/test-api/extension.raml

@@ -0,0 +1,6 @@
+#%RAML 1.0 Extension
+extends: api.raml
+usage: This extension defines additional resources for version 2 of the API.
+version: v2
+/test-v2:
+  get:

demo/models/test-api/library.raml

@@ -0,0 +1,7 @@
+#%RAML 1.0 Library
+
+types:
+  myType:
+    properties:
+      foo: boolean
+      bar: string

demo/models/test-api/overlay.raml

@@ -0,0 +1,7 @@
+#%RAML 1.0 Overlay
+extends: test-api.raml
+usage: Test API v2
+version: v2
+/test-headers:
+  displayName: Headers V2
+  post:

demo/models/test-api/person.raml

@@ -0,0 +1,5 @@
+#%RAML 1.0 DataType
+
+type: object
+properties:
+  name: string

demo/models/test-api/resourceType.raml

@@ -0,0 +1,10 @@
+#%RAML 1.0 ResourceType
+
+delete?:
+  headers:
+    Accept:
+      description: Is used to set specified media type.
+  responses:
+    403:
+      description: |
+        API rate limit exceeded.

demo/models/test-api/secured.raml

@@ -0,0 +1,5 @@
+#%RAML 1.0 Trait
+
+queryParameters:
+  <<tokenName>>:
+    description: A valid <<tokenName>> is required

test/api-console-navigation.test.js

@@ -20,6 +20,11 @@ describe('API Console navigation', () => {
     `));
   }
 
+  const testEndpoint = (endpoint, path, name) => {
+    assert.equal(endpoint.getAttribute('data-endpoint-path'), path)
+    assert.equal(endpoint.querySelector('.endpoint-name').innerText, name)
+  }
+
   const googleApi = 'google-drive-api';
 
   [
@@ -74,11 +79,6 @@ describe('API Console navigation', () => {
       });
 
       describe('Endpoints section', () => {
-        const testEndpoint = (endpoint, path, name) => {
-          assert.equal(endpoint.getAttribute('data-endpoint-path'), path)
-          assert.equal(endpoint.querySelector('.endpoint-name').innerText, name)
-        }
-
         const testGoogleEndpoints = (elem, fullPaths = false) => {
           const endpointsList = navigationEndpointsList(elem);
           assert.ok(endpointsList);
@@ -325,4 +325,181 @@ describe('API Console navigation', () => {
       });
     });
   });
+
+  [
+    new ApiDescribe('Regular model'),
+    new ApiDescribe('Compact model', true)
+  ].forEach(({label, compact}) => {
+    describe(label, () => {
+      let element;
+      let amf;
+
+      describe('RAML Fragments', () => {
+        describe('SecurityScheme fragment', () => {
+          before(async () => {
+            amf = await AmfLoader.load({compact, fileName: 'basicAuth'});
+          });
+
+          beforeEach(async () => {
+            element = await amfFixture(amf);
+          });
+
+          it(`should only render security section`, async () => {
+            assert.notOk(navigationSummarySection(element));
+            assert.notOk(navigationEndpointsSection(element));
+            assert.notOk(navigationDocumentationSection(element));
+            assert.notOk(navigationTypesSection(element));
+            assert.ok(navigationSecuritySection(element));
+          });
+
+          it(`should list all security items`, async () => {
+            const securityList = navigationSecurityList(element);
+            assert.ok(securityList);
+            assert.lengthOf(securityList, 1);
+            assert.equal(securityList[0].innerText.trim(), 'BasicAuth');
+          });
+        });
+
+        describe('DocumentationItem fragment', () => {
+          before(async () => {
+            amf = await AmfLoader.load({compact, fileName: 'documentation'});
+          });
+
+          beforeEach(async () => {
+            element = await amfFixture(amf);
+          });
+
+          it(`should only render documentation section`, async () => {
+            assert.notOk(navigationSummarySection(element));
+            assert.notOk(navigationEndpointsSection(element));
+            assert.ok(navigationDocumentationSection(element));
+            assert.notOk(navigationTypesSection(element));
+            assert.notOk(navigationSecuritySection(element));
+          });
+
+          it(`should list all documentation items`, async () => {
+            const documentationList = navigationDocumentationList(element);
+            assert.ok(documentationList);
+            assert.lengthOf(documentationList, 1);
+            assert.equal(documentationList[0].innerText.trim(), 'Home');
+          });
+        });
+
+        describe('Extension fragment', () => {
+          before(async () => {
+            amf = await AmfLoader.load({compact, fileName: 'extension'});
+          });
+
+          beforeEach(async () => {
+            element = await amfFixture(amf);
+          });
+
+          it(`should render all extended elements`, async () => {
+            assert.ok(navigationSummarySection(element));
+            assert.ok(navigationEndpointsSection(element));
+            assert.notOk(navigationDocumentationSection(element));
+            assert.notOk(navigationTypesSection(element));
+            assert.notOk(navigationSecuritySection(element));
+          });
+
+          it(`should list all endpoints`, async () => {
+            const endpointsList = navigationEndpointsList(element);
+            assert.ok(endpointsList);
+            assert.lengthOf(endpointsList, 1);
+            testEndpoint(endpointsList[0], "/test-v2", "/test-v2");
+          });
+        });
+
+        describe('Library fragment', () => {
+          before(async () => {
+            amf = await AmfLoader.load({compact, fileName: 'library'});
+          });
+
+          beforeEach(async () => {
+            element = await amfFixture(amf);
+          });
+
+          it(`should only render types section`, async () => {
+            assert.notOk(navigationSummarySection(element));
+            assert.notOk(navigationEndpointsSection(element));
+            assert.notOk(navigationDocumentationSection(element));
+            assert.ok(navigationTypesSection(element));
+            assert.notOk(navigationSecuritySection(element));
+          });
+
+          it(`should list all type items`, async () => {
+            const documentationList = navigationTypesList(element);
+            assert.ok(documentationList);
+            assert.lengthOf(documentationList, 1);
+            assert.equal(documentationList[0].innerText.trim(), 'myType')
+          });
+        });
+
+        describe('Overlay fragment', () => {
+          before(async () => {
+            amf = await AmfLoader.load({compact, fileName: 'overlay'});
+          });
+
+          beforeEach(async () => {
+            element = await amfFixture(amf);
+          });
+
+          it(`should render all sections in spec`, async () => {
+            assert.ok(navigationSummarySection(element));
+            assert.ok(navigationEndpointsSection(element));
+            assert.notOk(navigationDocumentationSection(element));
+            assert.notOk(navigationTypesSection(element));
+            assert.ok(navigationSecuritySection(element));
+          });
+
+          it(`should list all endpoints`, async () => {
+            const endpointsList = navigationEndpointsList(element);
+            assert.ok(endpointsList);
+            assert.lengthOf(endpointsList, 4);
+
+            [
+              ["/test-headers", "Headers V2"],
+            ["/test-custom-scheme", "Custom security scheme"],
+            ["/test-oauth10-scheme", "Oauth 1.0 security scheme"],
+            ["/test-oauth20-scheme", "Oauth 2.0 security scheme"]
+              ].forEach(([path, name], index) => testEndpoint(endpointsList[index], path, name))
+          });
+
+          it(`should list all security items`, async () => {
+            const securityList = navigationSecurityList(element);
+            assert.ok(securityList);
+            assert.lengthOf(securityList, 3);
+            assert.equal(securityList[0].innerText.trim(), 'customScheme - x-custom');
+            assert.equal(securityList[1].innerText.trim(), 'oauth_1_0 - OAuth 1.0');
+            assert.equal(securityList[2].innerText.trim(), 'oauth_2_0 - OAuth 2.0');
+          });
+        });
+
+        describe('DataType fragment', () => {
+          before(async () => {
+            amf = await AmfLoader.load({compact, fileName: 'person'});
+          });
+
+          beforeEach(async () => {
+            element = await amfFixture(amf);
+          });
+
+          it(`should render all sections in spec`, async () => {
+            assert.notOk(navigationSummarySection(element));
+            assert.notOk(navigationEndpointsSection(element));
+            assert.notOk(navigationDocumentationSection(element));
+            assert.ok(navigationTypesSection(element));
+            assert.notOk(navigationSecuritySection(element));
+          });
+
+          it(`should list all type items`, async () => {
+            const documentationList = navigationTypesList(element);
+            assert.ok(documentationList);
+            assert.lengthOf(documentationList, 1);
+            assert.equal(documentationList[0].innerText.trim(), 'type')
+          });
+        });
+      });
+    });
+  });
 });