express-openapi-validate/test/integration/integration.test.ts

Express middleware to validate request based on an OpenAPI 3 document

/*
  Copyright 2018 Santeri Hiltunen

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
*/

import request from "supertest";
// eslint-disable-next-line
import OpenApiValidator from "../../dist/OpenApiValidator";
import openApiDocument from "../open-api-document";
import app from "./app";

const validator = new OpenApiValidator(openApiDocument);

describe("Integration tests with real app", () => {
  test("requests against /echo are validated correctly", async () => {
    const validate = validator.validateResponse("post", "/echo");

    let res = await request(app).post("/echo").send({});
    expect(validate(res)).toBeUndefined();
    expect(res.status).toBe(400);
    expect(res.body).toHaveProperty("error");
    expect(res.body).toMatchSnapshot();

    res = await request(app).post("/echo").send({ input: "Hello!" });
    expect(res.status).toBe(200);
    expect(res.body).toEqual({ output: "Hello!" });
    expect(validate(res)).toBeUndefined();
  });

  test("requests against /match are validated correctly", async () => {
    const validate = validator.validateResponse("post", "/match");

    let res = await request(app).post("/match").send({});
    expect(validate(res)).toBeUndefined();
    expect(res.status).toBe(400);
    expect(res.body).toHaveProperty("error");
    expect(res.body).toMatchSnapshot();

    res = await request(app).post("/match").send({ input: "Hello!" });
    expect(res.status).toBe(200);
    expect(res.body).toEqual({ output: "Hello!" });
    expect(validate(res)).toBeUndefined();

    res = await request(app)
      .post("/match/works-with-url-param")
      .send({ input: "Hello!" });
    expect(res.status).toBe(200);
    expect(res.body).toEqual({ output: "works-with-url-param" });
    expect(validate(res)).toBeUndefined();

    res = await request(app).post("/match/works-with-url-param").send({});
    expect(validate(res)).toBeUndefined();
    expect(res.status).toBe(400);
    expect(res.body).toHaveProperty("error");
    expect(res.body).toMatchSnapshot();
  });

  test("requests against /no-match cause an error", async () => {
    const res = await request(app)
      .post("/no-match")
      .send({ anything: "anything" });
    expect(res.status).toBe(500);
    expect(res.body).toHaveProperty("error");
    expect(res.body).toMatchSnapshot();
  });

  test("path parameters are validated", async () => {
    let res = await request(app).get("/parameters/id/lol");
    expect(res.status).toBe(400);
    expect(res.body).toHaveProperty("error");
    expect(res.body).toMatchSnapshot();

    res = await request(app).get("/parameters/id/789");
    expect(res.status).toBe(200);
    expect(res.body).toEqual({ id: 789 });
  });

  test("query parameters are validated", async () => {
    let res = await request(app).get("/parameters");
    expect(res.status).toBe(400);
    expect(res.body).toHaveProperty("error");
    expect(res.body).toMatchSnapshot();

    res = await request(app).get("/parameters").query({ porom: "moi" });
    expect(res.status).toBe(400);
    expect(res.body).toHaveProperty("error");
    expect(res.body).toMatchSnapshot();

    res = await request(app)
      .get("/parameters")
      .query({ param: "hallo", porom: "moi" });
    expect(res.status).toBe(200);
    expect(res.body).toEqual({ param: "hallo", porom: "moi" });
  });

  test("header parameters are validated", async () => {
    let res = await request(app).get("/parameters/header");
    expect(res.status).toBe(400);
    expect(res.body).toHaveProperty("error");
    expect(res.body).toMatchSnapshot();

    res = await request(app).get("/parameters/header").set("X-param", "hullo");
    expect(res.status).toBe(200);
    expect(res.body).toEqual({ header: "hullo" });
  });

  test("cookie parameters are validated", async () => {
    let res = await request(app).get("/parameters/cookie");
    expect(res.status).toBe(400);
    expect(res.body).toHaveProperty("error");
    expect(res.body).toMatchSnapshot();

    res = await request(app)
      .get("/parameters/cookie")
      .set("cookie", "session=hullo");
    expect(res.status).toBe(200);
    expect(res.body).toEqual({ cookie: "hullo" });
  });
});