serverless-openapi-documenter 0.0.107 → 0.0.109

package/test/unit/definitionGenerator.spec.js

@@ -10,6 +10,14 @@ const DefinitionGenerator = require("../../src/definitionGenerator");
 
 describe("DefinitionGenerator", () => {
   let mockServerless;
+  const logger = {
+    verbose: (str) => {
+      console.log(str);
+    },
+    warn: (str) => {
+      console.log(str);
+    },
+  };
   const v4 = new RegExp(
     /^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i
   );
@@ -26,7 +34,7 @@ describe("DefinitionGenerator", () => {
 
   describe("constructor", () => {
     it("should return a definitionGenerator", function () {
-      const expected = new DefinitionGenerator(mockServerless, {});
+      const expected = new DefinitionGenerator(mockServerless, logger);
       expect(expected).to.be.an.instanceOf(DefinitionGenerator);
     });
 
@@ -37,46 +45,65 @@ describe("DefinitionGenerator", () => {
       delete serverlessWithoutOpenAPIVersion.processedInput;
       let expected = new DefinitionGenerator(
         serverlessWithoutOpenAPIVersion,
-        {}
+        logger
       );
       expect(expected.version).to.be.equal("3.0.0");
 
       Object.assign(serverlessWithoutOpenAPIVersion, { processedInput: {} });
-      expected = new DefinitionGenerator(serverlessWithoutOpenAPIVersion, {});
+      expected = new DefinitionGenerator(serverlessWithoutOpenAPIVersion, {
+        verbose: (str) => {
+          console.log(str);
+        },
+      });
       expect(expected.version).to.be.equal("3.0.0");
 
       serverlessWithoutOpenAPIVersion.processedInput = {
         options: {},
       };
-      expected = new DefinitionGenerator(serverlessWithoutOpenAPIVersion, {});
+      expected = new DefinitionGenerator(
+        serverlessWithoutOpenAPIVersion,
+        logger
+      );
       expect(expected.version).to.be.equal("3.0.0");
 
       serverlessWithoutOpenAPIVersion.processedInput.options = {
         test: "abc",
       };
 
-      expected = new DefinitionGenerator(serverlessWithoutOpenAPIVersion, {});
+      expected = new DefinitionGenerator(
+        serverlessWithoutOpenAPIVersion,
+        logger
+      );
       expect(expected.version).to.be.equal("3.0.0");
 
       serverlessWithoutOpenAPIVersion.processedInput.options = {
         openApiVersion: null,
       };
 
-      expected = new DefinitionGenerator(serverlessWithoutOpenAPIVersion, {});
+      expected = new DefinitionGenerator(
+        serverlessWithoutOpenAPIVersion,
+        logger
+      );
       expect(expected.version).to.be.equal("3.0.0");
 
       serverlessWithoutOpenAPIVersion.processedInput.options = {
         openApiVersion: undefined,
       };
 
-      expected = new DefinitionGenerator(serverlessWithoutOpenAPIVersion, {});
+      expected = new DefinitionGenerator(
+        serverlessWithoutOpenAPIVersion,
+        logger
+      );
       expect(expected.version).to.be.equal("3.0.0");
 
       serverlessWithoutOpenAPIVersion.processedInput.options = {
         openapiVersion: undefined,
       };
 
-      expected = new DefinitionGenerator(serverlessWithoutOpenAPIVersion, {});
+      expected = new DefinitionGenerator(
+        serverlessWithoutOpenAPIVersion,
+        logger
+      );
       expect(expected.version).to.be.equal("3.0.0");
     });
 
@@ -86,12 +113,15 @@ describe("DefinitionGenerator", () => {
       );
       serverlessWithOpenAPIVersion.processedInput.options.openApiVersion =
         "3.0.2";
-      let expected = new DefinitionGenerator(serverlessWithOpenAPIVersion, {});
+      let expected = new DefinitionGenerator(
+        serverlessWithOpenAPIVersion,
+        logger
+      );
       expect(expected.version).to.be.equal("3.0.2");
 
       serverlessWithOpenAPIVersion.processedInput.options.openApiVersion =
         "3.0.1";
-      expected = new DefinitionGenerator(serverlessWithOpenAPIVersion, {});
+      expected = new DefinitionGenerator(serverlessWithOpenAPIVersion, logger);
       expect(expected.version).to.be.equal("3.0.1");
     });
 
@@ -111,7 +141,7 @@ describe("DefinitionGenerator", () => {
           throw err;
         });
 
-      const expected = new DefinitionGenerator(mockServerless, {});
+      const expected = new DefinitionGenerator(mockServerless, logger);
 
       expect(expected.REDOCLY_RULES).to.have.property(
         "operation-2xx-response",
@@ -132,7 +162,10 @@ describe("DefinitionGenerator", () => {
 
   describe("createInfo", () => {
     it("should create openAPI info object correctly", function () {
-      const definitionGenerator = new DefinitionGenerator(mockServerless);
+      const definitionGenerator = new DefinitionGenerator(
+        mockServerless,
+        logger
+      );
       definitionGenerator.createInfo();
 
       expect(definitionGenerator.openAPI).to.be.an("object");
@@ -142,7 +175,10 @@ describe("DefinitionGenerator", () => {
 
     it("should use the service name when documentation title has not been supplied", function () {
       delete mockServerless.service.custom.documentation.title;
-      const definitionGenerator = new DefinitionGenerator(mockServerless);
+      const definitionGenerator = new DefinitionGenerator(
+        mockServerless,
+        logger
+      );
       definitionGenerator.createInfo();
 
       expect(definitionGenerator.openAPI).to.be.an("object");
@@ -154,7 +190,10 @@ describe("DefinitionGenerator", () => {
 
     it("should use the service name when documentation description has not been supplied", function () {
       delete mockServerless.service.custom.documentation.description;
-      const definitionGenerator = new DefinitionGenerator(mockServerless);
+      const definitionGenerator = new DefinitionGenerator(
+        mockServerless,
+        logger
+      );
       definitionGenerator.createInfo();
 
       expect(definitionGenerator.openAPI).to.be.an("object");
@@ -164,7 +203,10 @@ describe("DefinitionGenerator", () => {
 
     it("should use an empty string when documentation description has not been supplied", function () {
       delete mockServerless.service.custom.documentation.description;
-      const definitionGenerator = new DefinitionGenerator(mockServerless);
+      const definitionGenerator = new DefinitionGenerator(
+        mockServerless,
+        logger
+      );
       definitionGenerator.createInfo();
 
       expect(definitionGenerator.openAPI).to.be.an("object");
@@ -175,7 +217,10 @@ describe("DefinitionGenerator", () => {
     it("should generate a uuid for version when documentation version has not been supplied", function () {
       delete mockServerless.service.custom.documentation.version;
 
-      const definitionGenerator = new DefinitionGenerator(mockServerless);
+      const definitionGenerator = new DefinitionGenerator(
+        mockServerless,
+        logger
+      );
       definitionGenerator.createInfo();
 
       expect(definitionGenerator.openAPI).to.be.an("object");
@@ -189,7 +234,10 @@ describe("DefinitionGenerator", () => {
         url: "http://example.com",
         email: "john@example.com",
       };
-      const definitionGenerator = new DefinitionGenerator(mockServerless);
+      const definitionGenerator = new DefinitionGenerator(
+        mockServerless,
+        logger
+      );
       definitionGenerator.createInfo();
 
       expect(definitionGenerator.openAPI).to.be.an("object");
@@ -204,7 +252,10 @@ describe("DefinitionGenerator", () => {
         name: "John",
         email: "john@example.com",
       };
-      const definitionGenerator = new DefinitionGenerator(mockServerless);
+      const definitionGenerator = new DefinitionGenerator(
+        mockServerless,
+        logger
+      );
       definitionGenerator.createInfo();
 
       expect(definitionGenerator.openAPI).to.be.an("object");
@@ -222,7 +273,10 @@ describe("DefinitionGenerator", () => {
         name: "Apache 2.0",
         url: "https://www.apache.org/licenses/LICENSE-2.0.html",
       };
-      const definitionGenerator = new DefinitionGenerator(mockServerless);
+      const definitionGenerator = new DefinitionGenerator(
+        mockServerless,
+        logger
+      );
       definitionGenerator.createInfo();
 
       expect(definitionGenerator.openAPI).to.be.an("object");
@@ -236,7 +290,10 @@ describe("DefinitionGenerator", () => {
       mockServerless.service.custom.documentation.license = {
         url: "https://www.apache.org/licenses/LICENSE-2.0.html",
       };
-      const definitionGenerator = new DefinitionGenerator(mockServerless);
+      const definitionGenerator = new DefinitionGenerator(
+        mockServerless,
+        logger
+      );
       definitionGenerator.createInfo();
 
       expect(definitionGenerator.openAPI).to.be.an("object");
@@ -248,7 +305,10 @@ describe("DefinitionGenerator", () => {
       mockServerless.service.custom.documentation.license = {
         name: "John",
       };
-      const definitionGenerator = new DefinitionGenerator(mockServerless);
+      const definitionGenerator = new DefinitionGenerator(
+        mockServerless,
+        logger
+      );
       definitionGenerator.createInfo();
 
       expect(definitionGenerator.openAPI).to.be.an("object");
@@ -263,7 +323,10 @@ describe("DefinitionGenerator", () => {
 
     it("should assign specification extension fields when included", function () {
       mockServerless.service.custom.documentation["x-field"] = "john";
-      const definitionGenerator = new DefinitionGenerator(mockServerless);
+      const definitionGenerator = new DefinitionGenerator(
+        mockServerless,
+        logger
+      );
       definitionGenerator.createInfo();
 
       expect(definitionGenerator.openAPI).to.be.an("object");
@@ -274,7 +337,10 @@ describe("DefinitionGenerator", () => {
 
     it("should ignore fields that do not conform to specifiction extension", function () {
       mockServerless.service.custom.documentation.otherField = "john";
-      const definitionGenerator = new DefinitionGenerator(mockServerless);
+      const definitionGenerator = new DefinitionGenerator(
+        mockServerless,
+        logger
+      );
       definitionGenerator.createInfo();
 
       expect(definitionGenerator.openAPI).to.be.an("object");
@@ -296,7 +362,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         definitionGenerator.createSecuritySchemes(
           mockServerless.service.custom.documentation.securitySchemes
         );
@@ -328,7 +397,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         expect(() => {
           definitionGenerator.createSecuritySchemes(
             mockServerless.service.custom.documentation.securitySchemes
@@ -346,7 +418,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         expect(() => {
           definitionGenerator.createSecuritySchemes(
             mockServerless.service.custom.documentation.securitySchemes
@@ -366,7 +441,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         definitionGenerator.createSecuritySchemes(
           mockServerless.service.custom.documentation.securitySchemes
         );
@@ -391,7 +469,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         expect(() => {
           definitionGenerator.createSecuritySchemes(
             mockServerless.service.custom.documentation.securitySchemes
@@ -409,7 +490,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         definitionGenerator.createSecuritySchemes(
           mockServerless.service.custom.documentation.securitySchemes
         );
@@ -434,7 +518,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         expect(() => {
           definitionGenerator.createSecuritySchemes(
             mockServerless.service.custom.documentation.securitySchemes
@@ -462,7 +549,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         definitionGenerator.createSecuritySchemes(
           mockServerless.service.custom.documentation.securitySchemes
         );
@@ -516,7 +606,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         expect(() => {
           definitionGenerator.createSecuritySchemes(
             mockServerless.service.custom.documentation.securitySchemes
@@ -539,7 +632,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         expect(() => {
           definitionGenerator.createSecuritySchemes(
             mockServerless.service.custom.documentation.securitySchemes
@@ -563,7 +659,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         expect(() => {
           definitionGenerator.createSecuritySchemes(
             mockServerless.service.custom.documentation.securitySchemes
@@ -589,7 +688,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         expect(() => {
           definitionGenerator.createSecuritySchemes(
             mockServerless.service.custom.documentation.securitySchemes
@@ -612,7 +714,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         expect(() => {
           definitionGenerator.createSecuritySchemes(
             mockServerless.service.custom.documentation.securitySchemes
@@ -635,7 +740,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         expect(() => {
           definitionGenerator.createSecuritySchemes(
             mockServerless.service.custom.documentation.securitySchemes
@@ -655,7 +763,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         expect(() => {
           definitionGenerator.createSecuritySchemes(
             mockServerless.service.custom.documentation.securitySchemes
@@ -676,7 +787,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         expect(() => {
           definitionGenerator.createSecuritySchemes(
             mockServerless.service.custom.documentation.securitySchemes
@@ -696,7 +810,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         expect(() => {
           definitionGenerator.createSecuritySchemes(
             mockServerless.service.custom.documentation.securitySchemes
@@ -716,7 +833,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         expect(() => {
           definitionGenerator.createSecuritySchemes(
             mockServerless.service.custom.documentation.securitySchemes
@@ -747,7 +867,10 @@ describe("DefinitionGenerator", () => {
           },
         };
 
-        const definitionGenerator = new DefinitionGenerator(mockServerless);
+        const definitionGenerator = new DefinitionGenerator(
+          mockServerless,
+          logger
+        );
         definitionGenerator.createSecuritySchemes(
           mockServerless.service.custom.documentation.securitySchemes
         );
@@ -773,7 +896,10 @@ describe("DefinitionGenerator", () => {
     it("should add tags to the openAPI object correctly", function () {
       mockServerless.service.custom.documentation.tags = [{ name: "tag1" }];
 
-      const definitionGenerator = new DefinitionGenerator(mockServerless);
+      const definitionGenerator = new DefinitionGenerator(
+        mockServerless,
+        logger
+      );
       definitionGenerator.createTags();
 
       expect(definitionGenerator.openAPI).to.be.an("object");
@@ -782,10 +908,41 @@ describe("DefinitionGenerator", () => {
     });
 
     it("should not add tags when they are not defined", function () {
-      const definitionGenerator = new DefinitionGenerator(mockServerless);
+      const definitionGenerator = new DefinitionGenerator(
+        mockServerless,
+        logger
+      );
       expect(() => {
         definitionGenerator.createTags();
       }).to.throw();
     });
   });
+
+  describe(`createResponses`, async function () {
+    it(`handles creating headers with pragma as a default`, async function () {
+      const description = "this is a description";
+      const responseMock = {
+        methodResponses: [
+          {
+            responseBody: { description: description },
+            statusCode: 200,
+            owasp: { pragma: true },
+          },
+        ],
+      };
+
+      const definitionGenerator = new DefinitionGenerator(
+        mockServerless,
+        logger
+      );
+
+      const response = await definitionGenerator.createResponses(responseMock);
+
+      expect(response).to.be.an("object");
+      expect(response).to.have.property("200");
+      expect(response["200"]).to.have.property("description", description);
+      expect(response["200"].headers).to.be.an("object");
+      expect(response["200"].headers).to.have.property("Pragma");
+    });
+  });
 });

package/test/unit/logger.spec.js

@@ -0,0 +1,160 @@
+"use strict";
+
+const expect = require("chai").expect;
+const sinon = require("sinon");
+
+const Logger = require("../../src/logger");
+
+describe(`Logger`, function () {
+  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: {
+        debug: (str) => {},
+        error: (str) => {},
+        info: (str) => {},
+        notice: (str) => {},
+        success: (str) => {},
+        verbose: (str) => {},
+        warning: (str) => {},
+      },
+    };
+  });
+
+  describe(`debug`, function () {
+    it(`should log a debug log type when debug is called`, function () {
+      const logger = new Logger(sls, logOutput.log);
+      const spy = sinon.spy(logger, "log");
+
+      logger.debug("Testing");
+
+      expect(spy.called).to.be.true;
+
+      spy.restore();
+    });
+  });
+
+  describe(`error`, function () {
+    it(`should log a error log type when error is called`, function () {
+      const logger = new Logger(sls, logOutput.log);
+      const spy = sinon.spy(logger, "log");
+
+      logger.error("Testing");
+
+      expect(spy.called).to.be.true;
+
+      spy.restore();
+    });
+  });
+
+  describe(`info`, function () {
+    it(`should log a info log type when info is called`, function () {
+      const logger = new Logger(sls, logOutput.log);
+      const spy = sinon.spy(logger, "log");
+
+      logger.info("Testing");
+
+      expect(spy.called).to.be.true;
+
+      spy.restore();
+    });
+  });
+
+  describe(`notice`, function () {
+    it(`should log a notice log type when log is called without a log type`, function () {
+      const logger = new Logger(sls, logOutput.log);
+      const spy = sinon.spy(logger, "log");
+
+      logger.log("Testing");
+
+      expect(spy.called).to.be.true;
+
+      spy.restore();
+    });
+
+    it(`should log a notice log type when notice is called`, function () {
+      const logger = new Logger(sls, logOutput.log);
+      const spy = sinon.spy(logger, "log");
+
+      logger.notice("Testing");
+
+      expect(spy.called).to.be.true;
+
+      spy.restore();
+    });
+  });
+
+  describe(`success`, function () {
+    it(`should log a success log type when success is called`, function () {
+      const logger = new Logger(sls, logOutput.log);
+      const spy = sinon.spy(logger, "log");
+
+      logger.success("Testing");
+
+      expect(spy.called).to.be.true;
+
+      spy.restore();
+    });
+  });
+
+  describe(`verbose`, function () {
+    it(`should log a verbose log type when verbose is called`, function () {
+      const logger = new Logger(sls, logOutput.log);
+      const spy = sinon.spy(logger, "log");
+
+      logger.verbose("Testing");
+
+      expect(spy.called).to.be.true;
+
+      spy.restore();
+    });
+  });
+
+  describe(`warning`, function () {
+    it(`should log a warning log type when warning is called`, function () {
+      const logger = new Logger(sls, logOutput.log);
+      const spy = sinon.spy(logger, "log");
+
+      logger.warning("Testing");
+
+      expect(spy.called).to.be.true;
+
+      spy.restore();
+    });
+  });
+});