Skip to content

Mockserver

Install

1
npm install @testcontainers/mockserver --save-dev

Examples

These examples use the following libraries:

Choose an image from the container registry and substitute IMAGE.

Mock HTTP request

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
await using container = await new MockserverContainer(IMAGE).start();

const client = mockServerClient(container.getHost(), container.getMockserverPort());
await client.mockAnyResponse({
  httpRequest: {
    method: "GET",
    path: "/foo",
  },
  httpResponse: {
    body: {
      string: "bar",
    },
    statusCode: 200,
  },
});

const response = await superagent.get(`${container.getUrl()}/foo`);

expect(response.statusCode).toBe(200);
expect(response.text).toBe("bar");

Mock HTTPS request

Note

MockServer uses a self-signed certificate for HTTPS connections.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
await using container = await new MockserverContainer(IMAGE).start();

const client = mockServerClient(container.getHost(), container.getMockserverPort());
await client.mockAnyResponse({
  httpRequest: {
    method: "GET",
    path: "/foo",
  },
  httpResponse: {
    body: {
      string: "bar",
    },
    statusCode: 200,
  },
});

const secureUrl = container.getSecureUrl();
const response = await superagent.get(`${secureUrl}/foo`).disableTLSCerts();

expect(response.statusCode).toBe(200);
expect(response.text).toBe("bar");