serverless-openapi-documenter 0.0.120-beta.1 → 0.0.123

package/test/unit/logger.spec.js

@@ -1,160 +0,0 @@
-"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();
-    });
-  });
-});

package/test/unit/openAPIGenerator.spec.js

@@ -1,275 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-
-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) => {},
-        verbose: (str) => {},
-      },
-    };
-  });
-
-  after(function () {
-    delete require
-      .cache[require.resolve(`${path.resolve("options")}/redocly.json`)];
-  });
-
-  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();
-    });
-
-    xit("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 = structuredClone(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();
-    });
-
-    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 = structuredClone(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;
-        });
-
-      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();
-    });
-
-    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 = structuredClone(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(
-          //   `Error validating OpenAPI Description:\r\nThe operation does not define the path parameter \`{name}\` expected by path \`/find/{name}\`.`
-          // );
-          expect(err).to.have.property("message");
-          expect(err.message).to.include(
-            "Error validating OpenAPI Description:"
-          );
-        });
-
-      expect(succSpy.called).to.be.false;
-      expect(errSpy.called).to.be.true;
-
-      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();
-    });
-
-    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("throwing an error from writeFileSync"));
-      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("throwing an error from PostmanGenerator"));
-
-      const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput);
-      openAPIGenerator.processCliInput();
-
-      expect(() => {
-        openAPIGenerator.createPostman(validOpenAPI);
-      }).to.throw();
-
-      expect(errStub.called).to.be.true;
-      expect(succSpy.calledOnce).to.be.false;
-      expect(succSpy.calledTwice).to.be.false;
-
-      succSpy.restore();
-      errStub.restore();
-    });
-  });
-});

package/test/unit/owasp.spec.js

@@ -1,120 +0,0 @@
-"use strict";
-
-const expect = require("chai").expect;
-const nock = require("nock");
-
-const owasp = require("../../src/owasp");
-
-const owaspJSON = require("../../json/owasp.json");
-const newOWASPJSON = require("../json/newOWASP.json");
-
-describe(`owasp`, function () {
-  describe(`getLatest`, function () {
-    it(`populates the defaults from the included OWASP release when the online version can not be reached`, async function () {
-      nock("https://owasp.org")
-        .get("/www-project-secure-headers/ci/headers_add.json")
-        .reply(404, {});
-
-      await owasp.getLatest().catch((err) => {
-        console.error(err);
-        expect(err).to.be.undefined;
-      });
-
-      expect(
-        owasp.DEFAULT_OWASP_HEADERS["Permissions-Policy"]
-      ).to.have.property("schema");
-      const permissionsPolicyDefault = owaspJSON.headers.filter(
-        (obj) => obj.name === "Permissions-Policy"
-      );
-      expect(
-        owasp.DEFAULT_OWASP_HEADERS["Permissions-Policy"].schema.default
-      ).to.be.equal(permissionsPolicyDefault[0].value);
-      expect(Object.keys(owasp.DEFAULT_OWASP_HEADERS).length).to.be.equal(13);
-    });
-
-    it(`populates the defaults with information from a new OWASP release`, async function () {
-      nock("https://owasp.org")
-        .get("/www-project-secure-headers/ci/headers_add.json")
-        .reply(200, newOWASPJSON);
-
-      await owasp.getLatest().catch((err) => {
-        console.error(err);
-        expect(err).to.be.undefined;
-      });
-
-      expect(
-        owasp.DEFAULT_OWASP_HEADERS["Cross-Origin-Embedder-Policy"]
-      ).to.have.property("schema");
-      const newCrossOriginEmbedderPolicy = newOWASPJSON.headers.filter(
-        (obj) => obj.name === "Cross-Origin-Embedder-Policy"
-      );
-      expect(
-        owasp.DEFAULT_OWASP_HEADERS["Cross-Origin-Embedder-Policy"].schema
-          .default
-      ).to.be.equal(newCrossOriginEmbedderPolicy[0].value);
-      expect(Object.keys(owasp.DEFAULT_OWASP_HEADERS).length).to.be.equal(13);
-    });
-
-    it(`adds any properties contained in a new release`, async function () {
-      const newOWASPJSONAdded = structuredClone(newOWASPJSON);
-      newOWASPJSONAdded.headers.push({ name: "x-added", value: "true" });
-
-      nock("https://owasp.org")
-        .get("/www-project-secure-headers/ci/headers_add.json")
-        .reply(200, newOWASPJSONAdded);
-
-      await owasp.getLatest().catch((err) => {
-        console.error(err);
-        expect(err).to.be.undefined;
-      });
-
-      expect(owasp.DEFAULT_OWASP_HEADERS).to.have.property("x-added");
-      expect(owasp.DEFAULT_OWASP_HEADERS["x-added"]).to.have.property("schema");
-      expect(owasp.DEFAULT_OWASP_HEADERS["x-added"].schema.default).to.be.equal(
-        "true"
-      );
-      expect(Object.keys(owasp.DEFAULT_OWASP_HEADERS).length).to.be.equal(14);
-    });
-  });
-
-  describe(`getHeaders`, function () {
-    it(`brings back default headers from a list`, function () {
-      const headerOptions = { cacheControl: true, xFrameOptions: true };
-      const headers = owasp.getHeaders(headerOptions);
-
-      expect(Object.keys(headers).length).to.be.equal(2);
-    });
-
-    it(`brings back default headers from a list with new schema defaults when values are provided`, function () {
-      const headerOptions = {
-        referrerPolicy: {
-          value: "true",
-        },
-        crossOriginOpenerPolicy: {
-          value: "strict",
-        },
-      };
-
-      const headers = owasp.getHeaders(headerOptions);
-
-      expect(Object.keys(headers).length).to.be.equal(2);
-
-      expect(headers["Cross-Origin-Opener-Policy"].schema.default === "strict");
-    });
-
-    it(`handles pragma being deprecated`, function () {
-      const headerOptions = {
-        pragma: {
-          value: "true",
-        },
-      };
-
-      const headers = owasp.getHeaders(headerOptions);
-
-      expect(Object.keys(headers).length).to.be.equal(1);
-
-      expect(headers["Pragma"]).to.have.property("schema");
-      expect(headers["Pragma"].schema).to.have.property("default", "true");
-    });
-  });
-});