@redocly/openapi-core 1.0.0-beta.106 → 1.0.0-beta.109

package/src/__tests__/lint.test.ts

@@ -12,16 +12,16 @@ describe('lint', () => {
     const results = await lintFromString({
       absoluteRef: '/test/spec.yaml',
       source: outdent`
-      openapi: 3.0.0
-      info:
-        title: Test API
-        version: "1.0"
-        description: Test
-        license: Fail
+        openapi: 3.0.0
+        info:
+          title: Test API
+          version: "1.0"
+          description: Test
+          license: Fail
 
-      servers:
-        - url: http://example.com
-      paths: {}
+        servers:
+          - url: http://example.com
+        paths: {}
     `,
       config: await loadConfig(),
     });
@@ -29,6 +29,7 @@ describe('lint', () => {
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
       Array [
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/info/license",
@@ -48,8 +49,7 @@ describe('lint', () => {
   it('lintConfig should work', async () => {
     const document = parseYamlToDocument(
       outdent`
-      apis: error string
-      styleguide:
+        apis: error string
         plugins:
           - './local-plugin.js'
         extends:
@@ -60,16 +60,16 @@ describe('lint', () => {
           no-invalid-media-type-examples: error
           path-http-verbs-order: error
           boolean-parameter-prefixes: off
-      features.openapi:
-        showConsole: true
-        layout:
-          scope: section
-        routingStrategy: browser
-        theme:
-          rightPanel:
-            backgroundColor: '#263238'
-          links:
-            color: '#6CC496'
+        features.openapi:
+          showConsole: true
+          layout:
+            scope: section
+          routingStrategy: browser
+          theme:
+            rightPanel:
+              backgroundColor: '#263238'
+            links:
+              color: '#6CC496'
       `,
       ''
     );
@@ -78,6 +78,7 @@ describe('lint', () => {
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
       Array [
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/apis",
@@ -91,6 +92,7 @@ describe('lint', () => {
           "suggest": Array [],
         },
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/features.openapi/layout",
@@ -110,10 +112,9 @@ describe('lint', () => {
   it('lintConfig should detect wrong fields and suggest correct ones', async () => {
     const document = parseYamlToDocument(
       outdent`
-      api: 
-        name@version:
-          root: ./file.yaml
-      syleguide:
+        api:
+          name@version:
+            root: ./file.yaml
         rules:
           operation-2xx-response: warn
       `,
@@ -124,6 +125,7 @@ describe('lint', () => {
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
       Array [
         Object {
+          "from": undefined,
           "location": Array [
             Object {
               "pointer": "#/api",
@@ -138,21 +140,6 @@ describe('lint', () => {
             "apis",
           ],
         },
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/syleguide",
-              "reportOnKey": true,
-              "source": "",
-            },
-          ],
-          "message": "Property \`syleguide\` is not expected here.",
-          "ruleId": "configuration spec",
-          "severity": "error",
-          "suggest": Array [
-            "styleguide",
-          ],
-        },
       ]
     `);
   });
@@ -160,13 +147,13 @@ describe('lint', () => {
   it('lintConfig should work with legacy fields', async () => {
     const document = parseYamlToDocument(
       outdent`
-      apiDefinitions: 
-        entry: ./file.yaml
-      lint:
+        apis: 
+          entry: 
+            root: ./file.yaml
         rules:
           operation-2xx-response: warn
-      referenceDocs:
-        showConsole: true
+        referenceDocs:
+          showConsole: true
       `,
       ''
     );
@@ -175,16 +162,16 @@ describe('lint', () => {
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
   });
 
-  it("'plugins' shouldn't be allowed in 'apis' -> 'styleguide' field", async () => {
+  it("'plugins' shouldn't be allowed in 'apis'", async () => {
     const document = parseYamlToDocument(
       outdent`
-      apis: 
-        styleguide: 
-          plugins: 
+        apis:
+          main:
+            root: ./main.yaml
+            plugins:
             - './local-plugin.js'
-      styleguide:
         plugins:
-          - './local-plugin.js'
+        - './local-plugin.js'
       `,
       ''
     );
@@ -193,22 +180,10 @@ describe('lint', () => {
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
       Array [
         Object {
+          "from": undefined,
           "location": Array [
             Object {
-              "pointer": "#/apis/styleguide",
-              "reportOnKey": true,
-              "source": "",
-            },
-          ],
-          "message": "The field \`root\` must be present on this level.",
-          "ruleId": "configuration spec",
-          "severity": "error",
-          "suggest": Array [],
-        },
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/apis/styleguide/plugins",
+              "pointer": "#/apis/main/plugins",
               "reportOnKey": true,
               "source": "",
             },
@@ -225,31 +200,31 @@ describe('lint', () => {
   it("'const' can have any type", async () => {
     const document = parseYamlToDocument(
       outdent`
-      openapi: "3.1.0"
-      info:
-        version: 1.0.0
-        title: Swagger Petstore
-        description: Information about Petstore
-        license:
-          name: MIT
-          url: https://opensource.org/licenses/MIT
-      servers:
-        - url: http://petstore.swagger.io/v1
-      paths:
-        /pets:
-          get:
-            summary: List all pets
-            operationId: listPets
-            tags:
-              - pets
-            responses:
-              200:
-                description: An paged array of pets
-                content:
-                  application/json:
-                    schema:
-                      type: string
-                      const: ABC
+        openapi: "3.1.0"
+        info:
+          version: 1.0.0
+          title: Swagger Petstore
+          description: Information about Petstore
+          license:
+            name: MIT
+            url: https://opensource.org/licenses/MIT
+        servers:
+          - url: http://petstore.swagger.io/v1
+        paths:
+          /pets:
+            get:
+              summary: List all pets
+              operationId: listPets
+              tags:
+                - pets
+              responses:
+                200:
+                  description: An paged array of pets
+                  content:
+                    application/json:
+                      schema:
+                        type: string
+                        const: ABC
         `,
       'foobar.yaml'
     );
@@ -266,8 +241,8 @@ describe('lint', () => {
   it('detect OpenAPI should throw an error when version is not string', () => {
     const testDocument = parseYamlToDocument(
       outdent`
-      openapi: 3.0
-    `,
+        openapi: 3.0
+      `,
       ''
     );
     expect(() => detectOpenAPI(testDocument.parsed)).toThrow(
@@ -278,28 +253,28 @@ describe('lint', () => {
   it("spec rule shouldn't throw an error for named callback", async () => {
     const document = parseYamlToDocument(
       outdent`
-      openapi: 3.1.0
-      info:
-        title: Callback test
-        version: 'alpha'
-      components:
-        callbacks:
-          resultCallback:
-            '{$url}':
-              post:
-                requestBody:
-                  description: Callback payload
-                  content:
-                    'application/json':
-                      schema:
-                        type: object
-                        properties:
-                          test:
-                            type: string
-                responses:
-                  '200':
-                    description: callback successfully processed
-    `,
+        openapi: 3.1.0
+        info:
+          title: Callback test
+          version: 'alpha'
+        components:
+          callbacks:
+            resultCallback:
+              '{$url}':
+                post:
+                  requestBody:
+                    description: Callback payload
+                    content:
+                      'application/json':
+                        schema:
+                          type: object
+                          properties:
+                            test:
+                              type: string
+                  responses:
+                    '200':
+                      description: callback successfully processed
+      `,
       'foobar.yaml'
     );
 
@@ -316,23 +291,23 @@ describe('lint', () => {
     const absoluteRef = path.join(__dirname, 'fixtures/openapi.yaml');
     const document = parseYamlToDocument(
       outdent`
-      openapi: 3.0.0
-      info:
-        version: 1.0.0
-        title: Example OpenAPI 3 definition.
-        description: Information about API
-        license:
-          name: MIT
-          url: 'https://opensource.org/licenses/MIT'
-      servers:
-        - url: 'https://redocly.com/v1'
-      paths:
-        '/pets/{petId}':
-          post:
-            responses:
-              '201':
-                summary: Exist 
-                description: example description
+        openapi: 3.0.0
+        info:
+          version: 1.0.0
+          title: Example OpenAPI 3 definition.
+          description: Information about API
+          license:
+            name: MIT
+            url: 'https://opensource.org/licenses/MIT'
+        servers:
+          - url: 'https://redocly.com/v1'
+        paths:
+          '/pets/{petId}':
+            post:
+              responses:
+                '201':
+                  summary: Exist
+                  description: example description
       `,
       absoluteRef
     );

package/src/__tests__/logger-browser.test.ts

@@ -0,0 +1,53 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import * as colorette from 'colorette';
+import { logger, colorize } from '../logger';
+
+describe('Logger in Browser', () => {
+  it('should call "console.error"', () => {
+    const error = jest.spyOn(console, 'error').mockImplementation();
+
+    logger.error('error');
+
+    expect(error).toBeCalledTimes(1);
+    expect(error).toBeCalledWith('error');
+
+    error.mockRestore();
+  });
+
+  it('should call "console.log"', () => {
+    const log = jest.spyOn(console, 'log').mockImplementation();
+
+    logger.info('info');
+
+    expect(log).toBeCalledTimes(1);
+    expect(log).toBeCalledWith('info');
+
+    log.mockRestore();
+  });
+
+  it('should call "console.warn"', () => {
+    const warn = jest.spyOn(console, 'warn').mockImplementation();
+
+    logger.warn('warn');
+
+    expect(warn).toBeCalledTimes(1);
+    expect(warn).toBeCalledWith('warn');
+
+    warn.mockRestore();
+  });
+});
+
+describe('colorize in Browser', () => {
+  it('should not call original colorette lib', () => {
+    const color = 'cyan';
+    const spyingCyan = jest.spyOn(colorette, color);
+
+    const colorized = colorize.cyan(color);
+
+    expect(spyingCyan).not.toBeCalled();
+    expect(colorized).toEqual(color);
+  });
+});

package/src/__tests__/logger.test.ts

@@ -0,0 +1,47 @@
+import * as colorette from 'colorette';
+import { logger, colorize } from '../logger';
+
+describe('Logger in nodejs', () => {
+  let spyingStderr: jest.SpyInstance;
+
+  beforeEach(() => {
+    spyingStderr = jest.spyOn(process.stderr, 'write').mockImplementation();
+  });
+
+  afterEach(() => {
+    spyingStderr.mockRestore();
+  });
+
+  it('should call "process.stderr.write" for error severity', () => {
+    logger.error('error');
+
+    expect(spyingStderr).toBeCalledTimes(1);
+    expect(spyingStderr).toBeCalledWith(colorette.red('error'));
+  });
+
+  it('should call "process.stderr.write" for warn severity', () => {
+    logger.warn('warn');
+
+    expect(spyingStderr).toBeCalledTimes(1);
+    expect(spyingStderr).toBeCalledWith(colorette.yellow('warn'));
+  });
+
+  it('should call "process.stderr.write" for info severity', () => {
+    logger.info('info');
+
+    expect(spyingStderr).toBeCalledTimes(1);
+    expect(spyingStderr).toBeCalledWith('info');
+  });
+});
+
+describe('colorize in nodejs', () => {
+  it('should call original colorette lib', () => {
+    const color = 'cyan';
+    const spyingCyan = jest.spyOn(colorette, color);
+
+    const colorized = colorize.cyan(color);
+
+    expect(spyingCyan).toBeCalledWith(color);
+    expect(colorized).toEqual(colorette[color](color));
+  });
+});

package/src/__tests__/output-browser.test.ts

@@ -0,0 +1,18 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import { output } from '../output';
+
+describe('output', () => {
+  it('should ignore all parsable data in browser', () => {
+    const spyingStdout = jest.spyOn(process.stdout, 'write').mockImplementation();
+    const data = '{ "errors" : [] }';
+
+    output.write(data);
+
+    expect(spyingStdout).not.toBeCalled();
+
+    spyingStdout.mockRestore();
+  });
+});

package/src/__tests__/output.test.ts

@@ -0,0 +1,15 @@
+import { output } from '../output';
+
+describe('output', () => {
+  it('should write all parsable data to stdout', () => {
+    const spyingStdout = jest.spyOn(process.stdout, 'write').mockImplementation();
+    const data = '{ "errors" : [] }';
+
+    output.write(data);
+
+    expect(spyingStdout).toBeCalledTimes(1);
+    expect(spyingStdout).toBeCalledWith(data);
+
+    spyingStdout.mockRestore();
+  });
+});

package/src/__tests__/resolve-http.test.ts

@@ -43,7 +43,7 @@ describe('Resolve http-headers', () => {
           ],
         },
       }),
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+      rootType: normalizeTypes(Oas3Types).Root,
     });
 
     expect(fetchMock).toBeCalledTimes(3);

package/src/__tests__/resolve.test.ts

@@ -24,7 +24,7 @@ describe('collect refs', () => {
     const resolvedRefs = await resolveDocument({
       rootDocument,
       externalRefResolver: new BaseResolver(),
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+      rootType: normalizeTypes(Oas3Types).Root,
     });
 
     expect(resolvedRefs).toBeDefined();
@@ -63,7 +63,7 @@ describe('collect refs', () => {
       await resolveDocument({
         rootDocument,
         externalRefResolver: new BaseResolver(),
-        rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+        rootType: normalizeTypes(Oas3Types).Root,
       });
     } catch (e) {
       expect(e.message).toEqual('Self-referencing circular pointer');
@@ -95,7 +95,7 @@ describe('collect refs', () => {
     const resolvedRefs = await resolveDocument({
       rootDocument,
       externalRefResolver: new BaseResolver(),
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+      rootType: normalizeTypes(Oas3Types).Root,
     });
 
     expect(resolvedRefs).toBeDefined();
@@ -132,7 +132,7 @@ describe('collect refs', () => {
       await resolveDocument({
         rootDocument,
         externalRefResolver: new BaseResolver(),
-        rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+        rootType: normalizeTypes(Oas3Types).Root,
       });
     } catch (e) {
       expect(e.message).toEqual('Self-referencing circular pointer');
@@ -153,7 +153,7 @@ describe('collect refs', () => {
     const resolvedRefs = await resolveDocument({
       rootDocument,
       externalRefResolver: new BaseResolver(),
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+      rootType: normalizeTypes(Oas3Types).Root,
     });
 
     expect(resolvedRefs).toBeDefined();
@@ -187,7 +187,7 @@ describe('collect refs', () => {
     const resolvedRefs = await resolveDocument({
       rootDocument: rootDocument as Document,
       externalRefResolver: externalRefResolver,
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+      rootType: normalizeTypes(Oas3Types).Root,
     });
 
     expect(resolvedRefs).toBeDefined();
@@ -263,7 +263,7 @@ describe('collect refs', () => {
     const resolvedRefs = await resolveDocument({
       rootDocument: rootDocument as Document,
       externalRefResolver: externalRefResolver,
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+      rootType: normalizeTypes(Oas3Types).Root,
     });
 
     expect(resolvedRefs).toBeDefined();
@@ -358,7 +358,7 @@ describe('collect refs', () => {
     const resolvedRefs = await resolveDocument({
       rootDocument: rootDocument as Document,
       externalRefResolver: externalRefResolver,
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+      rootType: normalizeTypes(Oas3Types).Root,
     });
 
     expect(resolvedRefs).toBeDefined();
@@ -392,7 +392,7 @@ describe('collect refs', () => {
     const resolvedRefs = await resolveDocument({
       rootDocument,
       externalRefResolver: new BaseResolver(),
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+      rootType: normalizeTypes(Oas3Types).Root,
     });
 
     expect(resolvedRefs).toBeDefined();

package/src/__tests__/utils-browser.test.ts

@@ -0,0 +1,11 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import { isBrowser } from '../env';
+
+describe('isBrowser', () => {
+  it('should be browser', () => {
+    expect(isBrowser).toBe(true);
+  });
+});

package/src/__tests__/utils.test.ts

@@ -5,6 +5,7 @@ import {
   getMatchingStatusCodeRange,
   doesYamlFileExist,
 } from '../utils';
+import { isBrowser } from '../env';
 import * as fs from 'fs';
 import * as path from 'path';
 
@@ -122,5 +123,11 @@ describe('utils', () => {
         expect(doesYamlFileExist('redocly.yam')).toBe(false);
       });
     });
+
+    describe('isBrowser', () => {
+      it('should not be browser', () => {
+        expect(isBrowser).toBe(false);
+      });
+    });
   });
 });