serverless-openapi-documenter 0.0.72 → 0.0.81

package/README.md

@@ -751,6 +751,8 @@ requestModels:
 
 #### `methodResponses`
 
+`methodResponses` is a mandatory property and should include the `responseBody` and `description` properties.
+
 You can define the response schemas by defining properties for your function event.
 
 For an example of a `methodResponses` configuration for an event see below:
@@ -763,6 +765,12 @@ methodResponse:
     responseModels:
       application/json: "CreateResponse"
       application/xml: "CreateResponseXML"
+    links:
+      getDataLink:
+        operation: getData
+        description: The id created here can be used to get Data
+        parameters:
+          contentId: $response.body#/id
     responseHeaders:
       X-Rate-Limit-Limit:
         description: The number of allowed requests in the current period
@@ -788,6 +796,53 @@ responseModels:
   application/xml: "CreateResponseXML"
 ```
 
+##### `links`
+
+The `links` property allows you to define how operations are linked to each other:
+
+```yml
+links:
+  linkName:
+    operation: getContent
+    description: The contentId created here can be used to get content
+    parameters:
+      contentId: $response.body#/contentId
+```
+
+Where we are specifying operation, this should map to the function name:
+
+```yml
+functions:
+  createContent:
+    events:
+      - httpApi:
+          path: /
+          method: POST
+          documentation: ...
+  getContent:
+    events:
+      - http:
+          path: /{contentId}
+          method: POST
+          documentation: ...
+```
+
+If our example link was attached to the **createContent** function, and we wanted the `contentId` that was created to be used on the **getContent** function in the `contentId` parameter, we'd specify the `operation` property as **getContent**. If however, you had specified an operationId in the documentation to override the automatically created one:
+
+```yml
+getContent:
+  events:
+    - http:
+        path: /{contentId}
+        method: POST
+        documentation:
+          operationId: getMyContent
+```
+
+You can refer to the `operationId` that you created.
+
+You can read more about [links](https://swagger.io/docs/specification/links/) on the swagger.io site and in the [OpenAPI](https://spec.openapis.org/oas/v3.0.3#link-object) specification. They don't seem widely supported just yet, but perhaps they'll improve your documentation.
+
 ##### `responseHeaders`
 
 The `responseHeaders` property allows you to define the headers expected in a HTTP Response of the function event. This should only contain a description and a schema, which must be a JSON schema (inline, file or externally hosted).
@@ -882,7 +937,7 @@ This will set the `Cache-Control` Response Header to have a value of "no-store"
 
 ## Example configuration
 
-Please view the example [serverless.yml](test/serverless-tests/serverless%202/serverless.yml).
+Please view the example [serverless.yml](test/serverless-tests/best/serverless.yml).
 
 ## Notes on schemas
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-openapi-documenter",
-  "version": "0.0.72",
+  "version": "0.0.81",
   "description": "Generate OpenAPI v3 documentation and Postman Collections from your Serverless Config",
   "main": "index.js",
   "keywords": [
@@ -40,10 +40,10 @@
     "@apidevtools/json-schema-ref-parser": "^9.1.0",
     "chalk": "^4.1.2",
     "js-yaml": "^4.1.0",
-    "json-schema-for-openapi": "^0.3.2",
+    "json-schema-for-openapi": "^0.4.1",
     "lodash.isequal": "^4.5.0",
     "oas-validator": "^5.0.8",
-    "openapi-to-postmanv2": "^4.16.0",
+    "openapi-to-postmanv2": "^4.17.0",
     "swagger2openapi": "^7.0.8",
     "uuid": "^9.0.0"
   },
@@ -51,9 +51,9 @@
     "node": ">=14"
   },
   "devDependencies": {
-    "chai": "^4.3.7",
+    "chai": "^4.3.8",
     "mocha": "^10.2.0",
-    "nock": "^13.3.0",
-    "sinon": "^15.0.3"
+    "nock": "^13.3.3",
+    "sinon": "^16.0.0"
   }
 }

package/src/definitionGenerator.js

@@ -34,6 +34,9 @@ class DefinitionGenerator {
 
     this.schemaHandler = new SchemaHandler(serverless, this.openAPI);
 
+    this.operationIdMap = {};
+    this.functionMap = {};
+
     this.operationIds = [];
     this.schemaIDs = [];
 
@@ -92,6 +95,8 @@ class DefinitionGenerator {
       throw err;
     });
 
+    this.cleanupLinks();
+
     if (this.serverless.service.custom.documentation.servers) {
       const servers = this.createServers(
         this.serverless.service.custom.documentation.servers
@@ -156,6 +161,7 @@ class DefinitionGenerator {
   async createPaths() {
     const paths = {};
     const httpFunctions = this.getHTTPFunctions();
+
     for (const httpFunction of httpFunctions) {
       for (const event of httpFunction.event) {
         if (event?.http?.documentation || event?.httpApi?.documentation) {
@@ -164,21 +170,11 @@ class DefinitionGenerator {
             event?.http?.documentation || event?.httpApi?.documentation;
 
           this.currentFunctionName = httpFunction.functionInfo.name;
-
-          let opId;
-          if (
-            this.operationIds.includes(httpFunction.functionInfo.name) === false
-          ) {
-            opId = httpFunction.functionInfo.name;
-            this.operationIds.push(opId);
-          } else {
-            opId = `${httpFunction.functionInfo.name}-${uuid()}`;
-          }
+          this.operationName = httpFunction.operationName;
 
           const path = await this.createOperationObject(
             event?.http?.method || event?.httpApi?.method,
-            documentation,
-            opId
+            documentation
           ).catch((err) => {
             throw err;
           });
@@ -282,11 +278,25 @@ class DefinitionGenerator {
     Object.assign(this.openAPI, { tags: tags });
   }
 
-  async createOperationObject(method, documentation, name = uuid()) {
+  async createOperationObject(method, documentation) {
+    let operationId = documentation?.operationId || this.operationName;
+    if (this.operationIds.includes(operationId)) {
+      operationId += `-${uuid()}`;
+    }
+
+    const arr = this.functionMap[this.operationName];
+    arr.push(operationId);
+    this.functionMap[this.operationName] = arr;
+
+    this.operationIds.push(operationId);
+    Object.assign(this.operationIdMap, {
+      [operationId]: this.operationName,
+    });
+
     const obj = {
       summary: documentation.summary || "",
       description: documentation.description || "",
-      operationId: documentation.operationId || name,
+      operationId: operationId,
       parameters: [],
       tags: documentation.tags || [],
     };
@@ -472,6 +482,10 @@ class DefinitionGenerator {
         }
       }
 
+      if (response.links) {
+        obj.links = this.createLinks(response.links);
+      }
+
       Object.assign(responses, { [response.statusCode]: obj });
     }
 
@@ -691,6 +705,36 @@ class DefinitionGenerator {
     return params;
   }
 
+  createLinks(links) {
+    const linksObj = {};
+    for (const link in links) {
+      const linkObj = links[link];
+      const obj = {};
+
+      obj.operationId = linkObj.operation;
+
+      if (linkObj.description) {
+        obj.description = linkObj.description;
+      }
+
+      if (linkObj.server) {
+        obj.server = this.createServers(linkObj.server);
+      }
+
+      if (linkObj.parameters) {
+        obj.parameters = linkObj.parameters;
+      }
+
+      if (linkObj.requestBody) {
+        obj.requestBody = linkObj.requestBody;
+      }
+
+      Object.assign(linksObj, { [link]: obj });
+    }
+
+    return linksObj;
+  }
+
   addToComponents(type, schema, name) {
     const schemaObj = {
       [name]: schema,
@@ -863,6 +907,27 @@ class DefinitionGenerator {
     return examplesObj;
   }
 
+  cleanupLinks() {
+    for (const path of Object.keys(this.openAPI.paths)) {
+      for (const [name, value] of Object.entries(this.openAPI.paths[path])) {
+        for (const [statusCode, responseObj] of Object.entries(
+          value.responses
+        )) {
+          if (responseObj.links) {
+            for (const [linkName, linkObj] of Object.entries(
+              responseObj.links
+            )) {
+              const opId = linkObj.operationId;
+              if (this.functionMap[opId]) {
+                linkObj.operationId = this.functionMap[opId][0];
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+
   getHTTPFunctions() {
     const isHttpFunction = (funcType) => {
       const keys = Object.keys(funcType);
@@ -883,7 +948,16 @@ class DefinitionGenerator {
       })
       .map((functionType) => {
         const event = functionType.events.filter(isHttpFunction);
+        const name = functionType.name.split(
+          `${this.serverless.service.service}-${this.serverless.service.provider.stage}-`
+        )[1];
+
+        Object.assign(this.functionMap, {
+          [name]: [],
+        });
+
         return {
+          operationName: name,
           functionInfo: functionType,
           handler: functionType.handler,
           name: functionType.name,

package/src/schemaHandler.js

@@ -68,17 +68,10 @@ class SchemaHandler {
       ).catch((err) => {
         if (err.errors) {
           for (const error of err?.errors) {
-            if (error.message.includes("HTTP ERROR")) {
-              //   throw err;
-              throw new Error(
-                `There was an error dereferencing ${
-                  model.name
-                } schema.  \n\n dereferencing message: ${
-                  error.message
-                } \n\n Model received: ${JSON.stringify(model)}`
-              );
-            }
+            this.__HTTPError(error);
           }
+        } else {
+          this.__HTTPError(err);
         }
         return modelSchema;
       });
@@ -108,7 +101,11 @@ class SchemaHandler {
         throw new Error(
           `There was an error converting the ${
             model.name
-          } schema. Model received looks like: \n\n${JSON.stringify(model)}`
+          } schema. Model received looks like: \n\n${JSON.stringify(
+            model
+          )}.  The convereted schema looks like \n\n${JSON.stringify(
+            convertedSchemas
+          )}`
         );
       }
     }
@@ -230,6 +227,19 @@ class SchemaHandler {
       Object.assign(this.openAPI, components);
     }
   }
+
+  __HTTPError(error) {
+    if (error.message.includes("HTTP ERROR")) {
+      //   throw err;
+      throw new Error(
+        `There was an error dereferencing ${
+          model.name
+        } schema.  \n\n dereferencing message: ${
+          error.message
+        } \n\n Model received: ${JSON.stringify(model)}`
+      );
+    }
+  }
 }
 
 module.exports = SchemaHandler;

package/test/unit/openAPIGenerator.spec.js

@@ -1,223 +1,264 @@
-'use strict'
-
-const fs = require('fs')
-const PostmanGenerator = require('openapi-to-postmanv2')
-const sinon = require('sinon')
-const expect = require('chai').expect
-
-const validOpenAPI = require('../json/valid-openAPI.json')
-
-const basicDocumentation = require('../models/BasicDocumentation.json')
-const basicValidFunction = require('../models/BasicValidFunction.json')
-
-const OpenAPIGenerator = require('../../src/openAPIGenerator')
-
-describe('OpenAPIGenerator', () => {
-    let sls, logOutput
-    beforeEach(function() {
-        sls = {
-            service: {
-                service: 'test-service',
-                getAllFunctions: () => {},
-                getFunction: () => {}
-            },
-            version: '3.0.0',
-            variables: {
-                service: {
-                    custom: {
-
-                    }
-                }
-            },
-            configSchemaHandler: {
-                defineFunctionEventProperties: () => {},
-                defineFunctionProperties: () => {},
-                defineCustomProperties: () => {},
-            },
-            classes: {
-                Error: class ServerlessError {constructor(err) {return new Error(err)}}
-            },
-            processedInput: {
-                options: {
-                    postmanCollection: 'postman.json'
-                }
-            },
-        }
-
-        logOutput = {
-            log: {
-                notice: (str) => {},
-                error: (str) => {},
-                success: (str) => {}
-            }
-        }
-    });
-
-    describe('generationAndValidation', () => {
-        it('should correctly generate a valid openAPI document', async function() {
-            const succSpy = sinon.spy(logOutput.log, 'success')
-            const errSpy = sinon.spy(logOutput.log, 'error')
-
-            Object.assign(sls.service, basicDocumentation)
-            const getAllFuncsStub = sinon.stub(sls.service, 'getAllFunctions').returns(['createUser'])
-
-            const getFuncStub = sinon.stub(sls.service, 'getFunction').returns(basicValidFunction.createUser)
-
-            const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput)
-            openAPIGenerator.processCliInput()
-
-            const validOpenAPIDocument = await openAPIGenerator.generationAndValidation()
-                .catch(err => {
-                    expect(err).to.be.undefined
-                })
-
-            expect(succSpy.called).to.be.true
-            expect(errSpy.called).to.be.false
-
-            succSpy.restore()
-            errSpy.restore()
-            getAllFuncsStub.reset()
-            getFuncStub.reset()
+"use strict";
+
+const fs = require("fs");
+const PostmanGenerator = require("openapi-to-postmanv2");
+const sinon = require("sinon");
+const expect = require("chai").expect;
+
+const validOpenAPI = require("../json/valid-openAPI.json");
+
+const basicDocumentation = require("../models/BasicDocumentation.json");
+const basicValidFunction = require("../models/BasicValidFunction.json");
+
+const OpenAPIGenerator = require("../../src/openAPIGenerator");
+
+describe("OpenAPIGenerator", () => {
+  let sls, logOutput;
+  beforeEach(function () {
+    sls = {
+      service: {
+        service: "test-service",
+        provider: {
+          stage: "test",
+        },
+        getAllFunctions: () => {},
+        getFunction: () => {},
+      },
+      version: "3.0.0",
+      variables: {
+        service: {
+          custom: {},
+        },
+      },
+      configSchemaHandler: {
+        defineFunctionEventProperties: () => {},
+        defineFunctionProperties: () => {},
+        defineCustomProperties: () => {},
+      },
+      classes: {
+        Error: class ServerlessError {
+          constructor(err) {
+            return new Error(err);
+          }
+        },
+      },
+      processedInput: {
+        options: {
+          postmanCollection: "postman.json",
+        },
+      },
+    };
+
+    logOutput = {
+      log: {
+        notice: (str) => {},
+        error: (str) => {},
+        success: (str) => {},
+      },
+    };
+  });
+
+  describe("generationAndValidation", () => {
+    it("should correctly generate a valid openAPI document", async function () {
+      const succSpy = sinon.spy(logOutput.log, "success");
+      const errSpy = sinon.spy(logOutput.log, "error");
+
+      Object.assign(sls.service, basicDocumentation);
+      const getAllFuncsStub = sinon
+        .stub(sls.service, "getAllFunctions")
+        .returns(["createUser"]);
+
+      const getFuncStub = sinon
+        .stub(sls.service, "getFunction")
+        .returns(basicValidFunction.createUser);
+
+      const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput);
+      openAPIGenerator.processCliInput();
+
+      const validOpenAPIDocument = await openAPIGenerator
+        .generationAndValidation()
+        .catch((err) => {
+          expect(err).to.be.undefined;
         });
 
-        it('should throw an error when trying to generate an invalid openAPI document', async function() {
-            const succSpy = sinon.spy(logOutput.log, 'success')
-            const errSpy = sinon.spy(logOutput.log, 'error')
+      expect(succSpy.called).to.be.true;
+      expect(errSpy.called).to.be.false;
 
-            Object.assign(sls.service, basicDocumentation)
-            const getAllFuncsStub = sinon.stub(sls.service, 'getAllFunctions').returns(['createUser'])
-            const basicInvalidFunction = JSON.parse(JSON.stringify(basicValidFunction))
-
-            delete basicInvalidFunction.createUser.events[0].http.documentation.methodResponses[0].responseModels
-            const getFuncStub = sinon.stub(sls.service, 'getFunction').returns(basicInvalidFunction.createUser)
-
-            const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput)
-            openAPIGenerator.processCliInput()
-
-            const validOpenAPIDocument = await openAPIGenerator.generationAndValidation()
-                .catch(err => {
-                    expect(err.message).to.be.equal('Error: createUser is missing a Response Model for statusCode 200')
-                })
-
-            expect(succSpy.called).to.be.false
-            expect(errSpy.called).to.be.true
+      succSpy.restore();
+      errSpy.restore();
+      getAllFuncsStub.reset();
+      getFuncStub.reset();
+    });
 
-            succSpy.restore()
-            errSpy.restore()
-            getAllFuncsStub.reset()
-            getFuncStub.reset()
+    it("should throw an error when trying to generate an invalid openAPI document", async function () {
+      const succSpy = sinon.spy(logOutput.log, "success");
+      const errSpy = sinon.spy(logOutput.log, "error");
+
+      Object.assign(sls.service, basicDocumentation);
+      const getAllFuncsStub = sinon
+        .stub(sls.service, "getAllFunctions")
+        .returns(["createUser"]);
+      const basicInvalidFunction = JSON.parse(
+        JSON.stringify(basicValidFunction)
+      );
+
+      delete basicInvalidFunction.createUser.events[0].http.documentation
+        .methodResponses[0].responseModels;
+      const getFuncStub = sinon
+        .stub(sls.service, "getFunction")
+        .returns(basicInvalidFunction.createUser);
+
+      const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput);
+      openAPIGenerator.processCliInput();
+
+      const validOpenAPIDocument = await openAPIGenerator
+        .generationAndValidation()
+        .catch((err) => {
+          expect(err.message).to.be.equal(
+            "Error: createUser is missing a Response Model for statusCode 200"
+          );
         });
 
-        it('should correctly validate a valid openAPI document', async function() {
-            const succSpy = sinon.spy(logOutput.log, 'success')
-            const errSpy = sinon.spy(logOutput.log, 'error')
-
-            Object.assign(sls.service, basicDocumentation)
-            const getAllFuncsStub = sinon.stub(sls.service, 'getAllFunctions').returns(['createUser'])
-            const basicInvalidFunction = JSON.parse(JSON.stringify(basicValidFunction))
-
-            const getFuncStub = sinon.stub(sls.service, 'getFunction').returns(basicInvalidFunction.createUser)
+      expect(succSpy.called).to.be.false;
+      expect(errSpy.called).to.be.true;
 
-            const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput)
-            openAPIGenerator.processCliInput()
-
-            const validOpenAPIDocument = await openAPIGenerator.generationAndValidation()
-                .catch(err => {
-                    expect(err).to.be.undefined
-                })
-
-            expect(succSpy.called).to.be.true
-            expect(errSpy.called).to.be.false
-            expect(validOpenAPIDocument).to.have.property('openapi')
+      succSpy.restore();
+      errSpy.restore();
+      getAllFuncsStub.reset();
+      getFuncStub.reset();
+    });
 
-            succSpy.restore()
-            errSpy.restore()
-            getAllFuncsStub.reset()
-            getFuncStub.reset()
+    it("should correctly validate a valid openAPI document", async function () {
+      const succSpy = sinon.spy(logOutput.log, "success");
+      const errSpy = sinon.spy(logOutput.log, "error");
+
+      Object.assign(sls.service, basicDocumentation);
+      const getAllFuncsStub = sinon
+        .stub(sls.service, "getAllFunctions")
+        .returns(["createUser"]);
+      const basicInvalidFunction = JSON.parse(
+        JSON.stringify(basicValidFunction)
+      );
+
+      const getFuncStub = sinon
+        .stub(sls.service, "getFunction")
+        .returns(basicInvalidFunction.createUser);
+
+      const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput);
+      openAPIGenerator.processCliInput();
+
+      const validOpenAPIDocument = await openAPIGenerator
+        .generationAndValidation()
+        .catch((err) => {
+          expect(err).to.be.undefined;
         });
 
-        it('should throw an error when trying to validate an invalid openAPI document', async function() {
-            const succSpy = sinon.spy(logOutput.log, 'success')
-            const errSpy = sinon.spy(logOutput.log, 'error')
-
-            Object.assign(sls.service, basicDocumentation)
-            const getAllFuncsStub = sinon.stub(sls.service, 'getAllFunctions').returns(['createUser'])
-            const basicInvalidFunction = JSON.parse(JSON.stringify(basicValidFunction))
+      expect(succSpy.called).to.be.true;
+      expect(errSpy.called).to.be.false;
+      expect(validOpenAPIDocument).to.have.property("openapi");
 
-            delete basicInvalidFunction.createUser.events[0].http.documentation.pathParams
-            const getFuncStub = sinon.stub(sls.service, 'getFunction').returns(basicInvalidFunction.createUser)
-
-            const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput)
-            openAPIGenerator.processCliInput()
+      succSpy.restore();
+      errSpy.restore();
+      getAllFuncsStub.reset();
+      getFuncStub.reset();
+    });
 
-            const validOpenAPIDocument = await openAPIGenerator.generationAndValidation()
-                .catch(err => {
-                    expect(err.message).to.be.equal('AssertionError: Templated parameter name not found')
-                })
+    it("should throw an error when trying to validate an invalid openAPI document", async function () {
+      const succSpy = sinon.spy(logOutput.log, "success");
+      const errSpy = sinon.spy(logOutput.log, "error");
+
+      Object.assign(sls.service, basicDocumentation);
+      const getAllFuncsStub = sinon
+        .stub(sls.service, "getAllFunctions")
+        .returns(["createUser"]);
+      const basicInvalidFunction = JSON.parse(
+        JSON.stringify(basicValidFunction)
+      );
+
+      delete basicInvalidFunction.createUser.events[0].http.documentation
+        .pathParams;
+      const getFuncStub = sinon
+        .stub(sls.service, "getFunction")
+        .returns(basicInvalidFunction.createUser);
+
+      const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput);
+      openAPIGenerator.processCliInput();
+
+      const validOpenAPIDocument = await openAPIGenerator
+        .generationAndValidation()
+        .catch((err) => {
+          expect(err.message).to.be.equal(
+            "AssertionError: Templated parameter name not found"
+          );
+        });
 
-            expect(succSpy.called).to.be.false
-            expect(errSpy.called).to.be.true
+      expect(succSpy.called).to.be.false;
+      expect(errSpy.called).to.be.true;
 
-            succSpy.restore()
-            errSpy.restore()
-            getAllFuncsStub.reset()
-            getFuncStub.reset()
-        });
+      succSpy.restore();
+      errSpy.restore();
+      getAllFuncsStub.reset();
+      getFuncStub.reset();
+    });
+  });
+
+  describe("createPostman", () => {
+    it("should generate a postman collection when a valid openAPI file is generated", function () {
+      const fsStub = sinon.stub(fs, "writeFileSync").returns(true);
+      const succSpy = sinon.spy(logOutput.log, "success");
+      const errSpy = sinon.spy(logOutput.log, "error");
+      const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput);
+      openAPIGenerator.processCliInput();
+
+      openAPIGenerator.createPostman(validOpenAPI);
+
+      expect(fsStub.called).to.be.true;
+      expect(succSpy.calledTwice).to.be.true;
+      expect(errSpy.called).to.be.false;
+      fsStub.restore();
+      succSpy.restore();
+      errSpy.restore();
     });
 
-    describe('createPostman', () => {
-        it('should generate a postman collection when a valid openAPI file is generated', function() {
-            const fsStub = sinon.stub(fs, 'writeFileSync').returns(true)
-            const succSpy = sinon.spy(logOutput.log, 'success')
-            const errSpy = sinon.spy(logOutput.log, 'error')
-            const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput)
-            openAPIGenerator.processCliInput()
-
-            openAPIGenerator.createPostman(validOpenAPI)
-
-            expect(fsStub.called).to.be.true
-            expect(succSpy.calledTwice).to.be.true
-            expect(errSpy.called).to.be.false
-            fsStub.restore()
-            succSpy.restore()
-            errSpy.restore()
-        });
-
-        it('should throw an error when writing a file fails', function() {
-            const errStub = sinon.stub(logOutput.log, 'error').returns('')
-            const succSpy = sinon.spy(logOutput.log, 'success')
-            const fsStub = sinon.stub(fs, 'writeFileSync').throws(new Error())
-            const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput)
-            openAPIGenerator.processCliInput()
-
-            expect(() => {openAPIGenerator.createPostman(validOpenAPI)}).to.throw()
-
-            expect(fsStub.called).to.be.true
-            expect(errStub.called).to.be.true
-            expect(succSpy.calledOnce).to.be.true
-            expect(succSpy.calledTwice).to.be.false
-            fsStub.restore()
-            succSpy.restore()
-            errStub.restore()
-        });
+    it("should throw an error when writing a file fails", function () {
+      const errStub = sinon.stub(logOutput.log, "error").returns("");
+      const succSpy = sinon.spy(logOutput.log, "success");
+      const fsStub = sinon.stub(fs, "writeFileSync").throws(new Error());
+      const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput);
+      openAPIGenerator.processCliInput();
+
+      expect(() => {
+        openAPIGenerator.createPostman(validOpenAPI);
+      }).to.throw();
+
+      expect(fsStub.called).to.be.true;
+      expect(errStub.called).to.be.true;
+      expect(succSpy.calledOnce).to.be.true;
+      expect(succSpy.calledTwice).to.be.false;
+      fsStub.restore();
+      succSpy.restore();
+      errStub.restore();
+    });
 
-        it('should throw an error converting an OpenAPI fails', function() {
-            const errStub = sinon.spy(logOutput.log, 'error')
-            const succSpy = sinon.spy(logOutput.log, 'success')
-            const pgStub = sinon.stub(PostmanGenerator, 'convert')
-            pgStub.yields(new Error())
+    it("should throw an error converting an OpenAPI fails", function () {
+      const errStub = sinon.spy(logOutput.log, "error");
+      const succSpy = sinon.spy(logOutput.log, "success");
+      const pgStub = sinon.stub(PostmanGenerator, "convert");
+      pgStub.yields(new Error());
 
-            const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput)
-            openAPIGenerator.processCliInput()
+      const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput);
+      openAPIGenerator.processCliInput();
 
-            expect(() => {openAPIGenerator.createPostman(validOpenAPI)}).to.throw()
+      expect(() => {
+        openAPIGenerator.createPostman(validOpenAPI);
+      }).to.throw();
 
-            expect(errStub.called).to.be.true
-            expect(succSpy.calledOnce).to.be.false
-            expect(succSpy.calledTwice).to.be.false
+      expect(errStub.called).to.be.true;
+      expect(succSpy.calledOnce).to.be.false;
+      expect(succSpy.calledTwice).to.be.false;
 
-            succSpy.restore()
-            errStub.restore()
-        });
+      succSpy.restore();
+      errStub.restore();
     });
+  });
 });