add integration tests

Author: pderaaij

lint.js

@@ -83,24 +83,28 @@ const command = async (specFile, cmd) => {
         buildLoaderOptions(jsonSchema, verbose),
     );
 
-    validator.validate(spec, buildValidatorOptions(skip, verbose), (err, _options) => {
-        const { context, warnings } = _options || err.options;
-        if (err && err.options.valid === false) {
-            console.error(colors.red + 'Specification schema is invalid.' + colors.reset);
-            console.error(formatSchemaError(err, context));
-            process.exit(1);
-        }
-
-        if (warnings.length) {
-            console.error(colors.red + 'Specification contains lint errors: ' + warnings.length + colors.reset);
-            console.warn(formatLintResults(warnings))
-            process.exit(1);
-        }
-
-        if (!cmd.quiet) {
-            console.log(colors.green + 'Specification is valid, with 0 lint errors' + colors.reset)
-        }
-        process.exit(0);
+    return new Promise((resolve, reject) => {
+            validator.validate(spec, buildValidatorOptions(skip, verbose), (err, _options) => {
+            const { context, warnings, valid } = _options || err.options;
+
+            if (err && valid === false) {
+                console.error(colors.red + 'Specification schema is invalid.' + colors.reset);
+                console.error(formatSchemaError(err, context));
+                return reject();
+            }
+
+            if (warnings.length) {
+                console.error(colors.red + 'Specification contains lint errors: ' + warnings.length + colors.reset);
+                console.warn(formatLintResults(warnings))
+                return reject();
+            }
+
+            if (!cmd.quiet) {
+                console.log(colors.green + 'Specification is valid, with 0 lint errors' + colors.reset)
+            }
+
+            return resolve();
+        });
     });
 };
 

speccy.js

@@ -28,7 +28,11 @@ program
     .option('-s, --skip [ruleName]', 'provide multiple rules to skip', collect, [])
     .option('-j, --json-schema', 'treat $ref like JSON Schema and convert to OpenAPI Schema Objects (default: false)')
     .option('-v, --verbose', 'increase verbosity')
-    .action(lint.command);
+    .action((specFile, cmd) => {
+        lint.command(specFile, cmd)
+        .then( () => { process.exit(0) } )
+        .catch( () => { process.exit(1) } );
+    });
 
 program
     .command('resolve <file-or-url>')

test/fixtures/integration/invalid-key.yaml

@@ -0,0 +1,12 @@
+---
+openapi: 3.0.0
+info:
+  contact:
+    namex: Derp
+    email: [email protected]
+  version: 1.0.0
+  title: Swagger 2.0 Without Scheme
+paths: {}
+tags:
+  - name: Gym
+  - name: Pokemon

test/fixtures/integration/missing-contact.yaml

@@ -0,0 +1,9 @@
+---
+openapi: 3.0.0
+info:
+  version: 1.0.0
+  title: Swagger 2.0 Without Scheme
+paths: {}
+tags:
+  - name: Gym
+  - name: Pokemon

test/fixtures/integration/missing-ref.yaml

@@ -0,0 +1,34 @@
+openapi: 3.0.0
+servers:
+  - url: 'http://petstore.swagger.io/v2'
+info:
+  description: >-
+    This is a sample server Petstore server.  You can find out more about
+    Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net,
+    #swagger](http://swagger.io/irc/).  For this sample, you can use the api key
+    `special-key` to test the authorization filters.
+  version: 1.0.0
+  title: Swagger Petstore
+  termsOfService: 'http://swagger.io/terms/'
+  contact:
+    email: [email protected]
+  license:
+    name: Apache 2.0
+    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
+paths:
+  /pet:
+    post:
+      tags:
+        - pet
+      summary: Add a new pet to the store
+      description: ''
+      operationId: addPet
+      responses:
+        '405':
+          description: Invalid input
+      security:
+        - petstore_auth:
+            - 'write:pets'
+            - 'read:pets'
+      requestBody:
+        $ref: '#/components/requestBodies/Pet'

test/integration/lint.test.js

@@ -0,0 +1,76 @@
+'use strict';
+
+const lint = require('../../lint.js');
+
+const commandConfig = {
+    quiet: false,
+    rules: [],
+    skip: []
+};
+
+beforeEach(() => {
+    jest.resetAllMocks();
+});
+
+describe('Lint command', () => {
+    describe('properly handles scheme validation', () => {
+        test('succesfully validates a valid spec', () => {
+            expect.assertions(4);
+            const logSpy = jest.spyOn(console, 'log');
+            const warnSpy = jest.spyOn(console, 'warn');
+            const errorSpy = jest.spyOn(console, 'error');
+
+            return lint.command('./test/fixtures/loader/openapi.yaml', commandConfig).then(() => {
+                expect(logSpy).toBeCalledTimes(1);
+                expect(logSpy.mock.calls[0][0]).toEqual('\x1b[32mSpecification is valid, with 0 lint errors\x1b[0m');
+                expect(warnSpy).toBeCalledTimes(0);
+                expect(errorSpy).toBeCalledTimes(0);
+            });
+        });
+
+        test('displays a validation error on invalid key', () => {
+            expect.assertions(4);
+            const logSpy = jest.spyOn(console, 'log');
+            const warnSpy = jest.spyOn(console, 'warn');
+            const errorSpy = jest.spyOn(console, 'error');
+
+            return lint.command('./test/fixtures/integration/invalid-key.yaml', commandConfig).catch(() => {
+                expect(logSpy).toBeCalledTimes(0);
+                expect(warnSpy).toBeCalledTimes(0);
+                expect(errorSpy).toBeCalledTimes(2);
+                expect(errorSpy).toHaveBeenCalledWith('\x1b[31mSpecification schema is invalid.\x1b[0m');
+            });
+        });
+
+        test('displays a validation error on missing reference', () => {
+            expect.assertions(4);
+            const logSpy = jest.spyOn(console, 'log');
+            const warnSpy = jest.spyOn(console, 'warn');
+            const errorSpy = jest.spyOn(console, 'error');
+
+            return lint.command('./test/fixtures/integration/missing-ref.yaml', commandConfig).catch(() => {
+                expect(logSpy).toBeCalledTimes(0);
+                expect(warnSpy).toBeCalledTimes(0);
+                expect(errorSpy).toBeCalledTimes(2);
+                expect(errorSpy).toHaveBeenCalledWith('\x1b[31mSpecification schema is invalid.\x1b[0m');
+            });
+        });
+    });
+
+    describe('properly handles linter warnings', () => {
+        test('displays a linting error on missing contact field', () => {
+            expect.assertions(5);
+            const logSpy = jest.spyOn(console, 'log');
+            const warnSpy = jest.spyOn(console, 'warn');
+            const errorSpy = jest.spyOn(console, 'error');
+
+            return lint.command('./test/fixtures/integration/missing-contact.yaml', commandConfig).catch(() => {
+                expect(logSpy).toBeCalledTimes(0);
+                expect(warnSpy).toBeCalledTimes(1);
+                expect(errorSpy).toBeCalledTimes(1);
+                expect(errorSpy.mock.calls[0][0]).toEqual('\x1b[31mSpecification contains lint errors: 1\x1b[0m');
+                expect(warnSpy.mock.calls[0][0]).toContain('info-contact');
+            });
+        });
+    });
+});