@tsed/platform-test-sdk 7.79.4 → 7.80.0

package/src/tests/testPathParams.ts

@@ -1,123 +0,0 @@
-import {Context, Controller, Get, PathParams, PlatformTest, Post} from "@tsed/common";
-import {Pattern} from "@tsed/schema";
-import SuperTest from "supertest";
-import {PlatformTestingSdkOpts} from "../interfaces/index.js";
-
-@Controller("/path-params")
-class TestPathParamsCtrl {
-  @Get("/scenario-1/:scope/:scopeId")
-  testScenario1(@PathParams("scope") scope: string) {
-    // Here scope will be {0: 'a', 1: 'b', 2: 'c'} instead of 'abc' in version 5.47.0
-    expect(scope).toEqual("abc");
-
-    return Promise.resolve(scope);
-  }
-
-  @Get("/scenario-2/:scope/:scopeId")
-  testScenario2(@PathParams("scope") scope: any) {
-    // This way it works in version 5.47.0
-    expect(scope).toEqual("abc");
-
-    return scope;
-  }
-
-  @Post("/scenario-3/:scope/:scopeId")
-  testScenario3(@PathParams("scope") scope: string): Promise<any[]> {
-    expect(scope).toEqual("abc");
-
-    // Here the function will return  {0: 'a', 1: 'b', 2: 'c'} instead of ['a','b','c']  in version 5.44.13
-    return Promise.resolve(["a", "b", "c"]);
-  }
-
-  @Post("/scenario-4/:scope/:scopeId")
-  testScenario4(@PathParams("scope") scope: string, @Context() ctx: Context) {
-    expect(scope).toEqual("abc");
-
-    // This way it works  in version 5.44.13
-    ctx.response.body(["a", "b", "c"]);
-  }
-
-  @Get("/scenario-5/:scopeId")
-  testScenario5(@PathParams("scopeId") @Pattern(/^[0-9a-fA-F]{24}$/) scopeId: string, @Context() ctx: Context) {
-    return "test";
-  }
-
-  @Get("/scenario-6/:id")
-  testScenario6(@PathParams("id") id: number) {
-    return {id};
-  }
-}
-
-export function testPathParams(options: PlatformTestingSdkOpts) {
-  let request: SuperTest.Agent;
-
-  beforeAll(
-    PlatformTest.bootstrap(options.server, {
-      ...options,
-      mount: {
-        "/rest": [TestPathParamsCtrl]
-      }
-    })
-  );
-  beforeAll(() => {
-    request = SuperTest(PlatformTest.callback());
-  });
-  afterAll(PlatformTest.reset);
-
-  it("Scenario 1: GET /rest/path-params/scenario-1/scope/scopeId", async () => {
-    const response = await request.get("/rest/path-params/scenario-1/abc/1").expect(200);
-
-    expect(response.text).toEqual("abc");
-  });
-
-  it("Scenario 2: GET /rest/path-params/scenario-2/scopeId", async () => {
-    const response = await request.get("/rest/path-params/scenario-2/abc/1").expect(200);
-
-    expect(response.text).toEqual("abc");
-  });
-
-  it("Scenario 3: POST /rest/path-params/scenario-3/scope/scopeId", async () => {
-    const response = await request.post("/rest/path-params/scenario-3/abc/1").expect(200);
-
-    expect(response.body).toEqual(["a", "b", "c"]);
-  });
-
-  it("Scenario 4: POST /rest/path-params/scenario-4/scope/scopeId", async () => {
-    const response = await request.post("/rest/path-params/scenario-4/abc/1").expect(200);
-
-    expect(response.body).toEqual(["a", "b", "c"]);
-  });
-
-  it("Scenario 5 a: GET /rest/path-params/scenario-5/scopeId", async () => {
-    const response = await request.get("/rest/path-params/scenario-5/1").expect(400);
-
-    expect(response.body).toEqual({
-      errors: [
-        {
-          data: "1",
-          requestPath: "path",
-          dataPath: ".scopeId",
-          instancePath: "",
-          keyword: "pattern",
-          message: 'must match pattern "^[0-9a-fA-F]{24}$"',
-          params: {
-            pattern: "^[0-9a-fA-F]{24}$"
-          },
-          schemaPath: "#/pattern"
-        }
-      ],
-      message: 'Bad request on parameter "request.path.scopeId".\nValue must match pattern "^[0-9a-fA-F]{24}$". Given value: "1"',
-      name: "AJV_VALIDATION_ERROR",
-      status: 400
-    });
-  });
-  it("Scenario 5b: GET /rest/path-params/scenario-5/scopeId", async () => {
-    await request.get("/rest/path-params/scenario-5/5ce4ee471495836c5e2e4cb0").expect(200);
-  });
-
-  it("Scenario 6: GET /rest/path-params/scenario-6/id", async () => {
-    const response = await request.get("/rest/path-params/scenario-6/1").expect(200);
-
-    expect(response.body).toEqual({id: 1});
-  });
-}

package/src/tests/testQueryParams.ts

@@ -1,233 +0,0 @@
-import "@tsed/ajv";
-import {Controller, Get, PlatformTest, QueryParams} from "@tsed/common";
-import {Maximum, Minimum, Required} from "@tsed/schema";
-import SuperTest from "supertest";
-import {PlatformTestingSdkOpts} from "../interfaces/index.js";
-
-export class RandomStringModel {
-  @Maximum(250)
-  @Minimum(1)
-  @Required()
-  length: number;
-}
-
-@Controller("/query-params")
-class TestQueryParamsCtrl {
-  @Get("/scenario-1")
-  testScenario1(@QueryParams("test") value: boolean): any {
-    return {value};
-  }
-
-  @Get("/scenario-2")
-  testScenario2(@QueryParams("test") value: boolean = true): any {
-    return {value};
-  }
-
-  @Get("/scenario-3")
-  testScenario3(@QueryParams("test") value: number): any {
-    return {value};
-  }
-
-  @Get("/scenario-4")
-  testScenario4(@QueryParams("test") value: string): any {
-    return {value};
-  }
-
-  @Get("/scenario-5")
-  testScenario5(@QueryParams() value: RandomStringModel): any {
-    return {value};
-  }
-
-  @Get("/scenario-6")
-  testScenario8(@QueryParams("test", String) value: string[]): any {
-    return {value};
-  }
-}
-
-export function testQueryParams(options: PlatformTestingSdkOpts) {
-  let request: SuperTest.Agent;
-
-  beforeAll(
-    PlatformTest.bootstrap(options.server, {
-      ...options,
-      ajv: {
-        verbose: false
-      },
-      mount: {
-        "/rest": [TestQueryParamsCtrl]
-      }
-    })
-  );
-  beforeAll(() => {
-    request = SuperTest(PlatformTest.callback());
-  });
-  afterAll(PlatformTest.reset);
-  describe("Scenario1: Boolean value", () => {
-    it("should return true when query is true", async () => {
-      const response = await request.get("/rest/query-params/scenario-1?test=true").expect(200);
-
-      expect(response.body).toEqual({value: true});
-    });
-    it("should return true when query is 1", async () => {
-      const response = await request.get("/rest/query-params/scenario-1?test=1").expect(200);
-
-      expect(response.body).toEqual({value: true});
-    });
-    it("should return false when query is false", async () => {
-      const response = await request.get("/rest/query-params/scenario-1?test=false").expect(200);
-
-      expect(response.body).toEqual({value: false});
-    });
-    it("should return false when query is 0", async () => {
-      const response = await request.get("/rest/query-params/scenario-1?test=0").expect(200);
-
-      expect(response.body).toEqual({value: false});
-    });
-    it("should return false when query is null", async () => {
-      const response = await request.get("/rest/query-params/scenario-1?test=null").expect(200);
-
-      expect(response.body).toEqual({value: null});
-    });
-    it("should return undefined when query is empty", async () => {
-      const response = await request.get("/rest/query-params/scenario-1?test=").expect(200);
-
-      expect(response.body).toEqual({});
-    });
-    it("should return undefined when no query", async () => {
-      const response = await request.get("/rest/query-params/scenario-1").expect(200);
-
-      expect(response.body).toEqual({});
-    });
-  });
-  describe("Scenario2: Boolean value with default value", () => {
-    it("should return true when query is true", async () => {
-      const response = await request.get("/rest/query-params/scenario-2?test=true").expect(200);
-
-      expect(response.body).toEqual({value: true});
-    });
-    it("should return true when query is 1", async () => {
-      const response = await request.get("/rest/query-params/scenario-2?test=1").expect(200);
-
-      expect(response.body).toEqual({value: true});
-    });
-    it("should return false when query is false", async () => {
-      const response = await request.get("/rest/query-params/scenario-2?test=false").expect(200);
-
-      expect(response.body).toEqual({value: false});
-    });
-    it("should return false when query is 0", async () => {
-      const response = await request.get("/rest/query-params/scenario-2?test=0").expect(200);
-
-      expect(response.body).toEqual({value: false});
-    });
-    it("should return false when query is null", async () => {
-      const response = await request.get("/rest/query-params/scenario-2?test=null").expect(200);
-
-      expect(response.body).toEqual({value: null});
-    });
-    it("should return undefined when query is empty", async () => {
-      const response = await request.get("/rest/query-params/scenario-2?test=").expect(200);
-
-      expect(response.body).toEqual({value: true});
-    });
-    it("should return undefined when no query", async () => {
-      const response = await request.get("/rest/query-params/scenario-2").expect(200);
-
-      expect(response.body).toEqual({value: true});
-    });
-  });
-  describe("Scenario3: Number value", () => {
-    const endpoint = "/rest/query-params/scenario-3";
-    it("should return 0 when query is 0", async () => {
-      const response = await request.get(`${endpoint}?test=0`).expect(200);
-
-      expect(response.body).toEqual({value: 0});
-    });
-    it("should return 1 when query is 1", async () => {
-      const response = await request.get(`${endpoint}?test=1`).expect(200);
-
-      expect(response.body).toEqual({value: 1});
-    });
-    it("should return 0.1 when query is 0.1", async () => {
-      const response = await request.get(`${endpoint}?test=0.1`).expect(200);
-
-      expect(response.body).toEqual({value: 0.1});
-    });
-    it("should throw bad request", async () => {
-      const response = await request.get(`${endpoint}?test=error`).expect(400);
-      expect(response.body).toEqual({
-        name: "AJV_VALIDATION_ERROR",
-        message: 'Bad request on parameter "request.query.test".\nValue must be number. Given value: "error"',
-        status: 400,
-        errors: [
-          {
-            keyword: "type",
-            requestPath: "query",
-            dataPath: ".test",
-            instancePath: "",
-            schemaPath: "#/type",
-            params: {type: "number"},
-            message: "must be number",
-            data: "error"
-          }
-        ]
-      });
-    });
-    it("should return undefined when query is empty", async () => {
-      const response = await request.get(`${endpoint}?test=null`).expect(200);
-
-      expect(response.body).toEqual({value: null});
-    });
-    it("should return undefined when query is empty", async () => {
-      const response = await request.get(`${endpoint}?test=`).expect(200);
-
-      expect(response.body).toEqual({});
-    });
-    it("should return undefined when no query", async () => {
-      const response = await request.get(`${endpoint}`).expect(200);
-
-      expect(response.body).toEqual({});
-    });
-  });
-  describe("Scenario4: String value", () => {
-    const endpoint = "/rest/query-params/scenario-4";
-    it("should return 0 when query is 0", async () => {
-      const response = await request.get(`${endpoint}?test=0`).expect(200);
-
-      expect(response.body).toEqual({value: "0"});
-    });
-    it("should return 1 when query is 1", async () => {
-      const response = await request.get(`${endpoint}?test=1`).expect(200);
-
-      expect(response.body).toEqual({value: "1"});
-    });
-    it("should return 0.1 when query is 0.1", async () => {
-      const response = await request.get(`${endpoint}?test=0.1`).expect(200);
-
-      expect(response.body).toEqual({value: "0.1"});
-    });
-    it("should return undefined when query is empty", async () => {
-      const response = await request.get(`${endpoint}?test=`).expect(200);
-
-      expect(response.body).toEqual({value: ""});
-    });
-    it("should return undefined when no query", async () => {
-      const response = await request.get(`${endpoint}`).expect(200);
-
-      expect(response.body).toEqual({});
-    });
-  });
-  describe("Scenario6: String[] value", () => {
-    const endpoint = "/rest/query-params/scenario-6";
-    it("should return 0 when query is 0", async () => {
-      const response = await request.get(`${endpoint}?test=0`).expect(200);
-
-      expect(response.body).toEqual({value: ["0"]});
-    });
-    it("should return 1 when query is 1", async () => {
-      const response = await request.get(`${endpoint}?test=1&test=2`).expect(200);
-
-      expect(response.body).toEqual({value: ["1", "2"]});
-    });
-  });
-}

package/src/tests/testRedirect.ts

@@ -1,124 +0,0 @@
-import {Context, Controller, Get, Location, PlatformTest, Redirect} from "@tsed/common";
-import SuperTest from "supertest";
-import {PlatformTestingSdkOpts} from "../interfaces/index.js";
-
-@Controller("/redirect")
-class RedirectCtrl {
-  @Get("/scenario-1")
-  @Redirect("/test")
-  testScenario1() {
-    return "Hello";
-  }
-
-  @Get("/scenario-2")
-  @Redirect(301, "/test")
-  testScenario2() {
-    return "Hello";
-  }
-
-  @Get("/scenario-3")
-  @Redirect(301, "/test")
-  testScenario3(@Context() ctx: Context) {
-    ctx.response.redirect(302, "/another/path");
-
-    return "Hello";
-  }
-
-  @Get("/scenario-4")
-  @Redirect("back")
-  testScenario4(@Context() ctx: Context) {
-    return "Hello";
-  }
-
-  @Get("/scenario-5")
-  @Location("back")
-  testScenario5(@Context() ctx: Context) {
-    return "Hello";
-  }
-
-  @Get("/scenario-6")
-  @Location("/path/to").Status(301)
-  testScenario6(@Context() ctx: Context) {
-    return "Hello";
-  }
-
-  @Get("/scenario-7")
-  @Location("/path/to")
-  testScenario7(@Context() ctx: Context) {
-    ctx.response.location("/another/path");
-    return "Hello";
-  }
-}
-
-export function testRedirect(options: PlatformTestingSdkOpts) {
-  let request: SuperTest.Agent;
-
-  beforeAll(
-    PlatformTest.bootstrap(options.server, {
-      ...options,
-      mount: {
-        "/rest": [RedirectCtrl]
-      }
-    })
-  );
-  beforeAll(() => {
-    request = SuperTest(PlatformTest.callback());
-  });
-  afterAll(PlatformTest.reset);
-
-  it("Scenario1: GET /rest/redirect/scenario-1", async () => {
-    const response = await request.get("/rest/redirect/scenario-1").expect(302);
-
-    expect(response.text).toEqual("Found. Redirecting to /test");
-    expect(response.header.location).toEqual("/test");
-  });
-
-  it("Scenario1: HEAD /rest/redirect/scenario-1", async () => {
-    const response = await request.head("/rest/redirect/scenario-1").expect(302);
-
-    expect(response.text).toBeUndefined();
-    expect(response.header.location).toEqual("/test");
-  });
-
-  it("Scenario2: GET /rest/redirect/scenario-2", async () => {
-    const response = await request.get("/rest/redirect/scenario-2").expect(301);
-
-    expect(response.text).toEqual("Moved Permanently. Redirecting to /test");
-    expect(response.header.location).toEqual("/test");
-  });
-
-  it("Scenario3: GET /rest/redirect/scenario-3", async () => {
-    const response = await request.get("/rest/redirect/scenario-3").expect(302);
-
-    expect(response.header.location).toEqual("/another/path");
-    expect(response.text).toEqual("Found. Redirecting to /another/path");
-  });
-
-  it("Scenario4: GET /rest/redirect/scenario-4 with referer", async () => {
-    const response = await request.get("/rest/redirect/scenario-4").set("Referrer", "https://referrer.com").expect(302);
-
-    expect(response.text).toEqual("Found. Redirecting to https://referrer.com");
-    expect(response.header.location).toEqual("https://referrer.com");
-  });
-
-  it("Scenario5: GET /rest/redirect/scenario-5", async () => {
-    const response = await request.get("/rest/redirect/scenario-5").set("Referrer", "https://referrer.com").expect(200);
-
-    expect(response.text).toEqual("Hello");
-    expect(response.header.location).toEqual("https://referrer.com");
-  });
-
-  it("Scenario6: GET /rest/redirect/scenario-6", async () => {
-    const response = await request.get("/rest/redirect/scenario-6").set("Referrer", "https://referrer.com").expect(301);
-
-    expect(response.text).toEqual("Hello");
-    expect(response.header.location).toEqual("/path/to");
-  });
-
-  it("Scenario7: GET /rest/redirect/scenario-7", async () => {
-    const response = await request.get("/rest/redirect/scenario-7").set("Referrer", "https://referrer.com").expect(200);
-
-    expect(response.text).toEqual("Hello");
-    expect(response.header.location).toEqual("/another/path");
-  });
-}