feat: add mockserver module

Author: botflux

package-lock.json

@@ -0,0 +1,11 @@
+import type { Config } from "jest";
+import * as path from "path";
+
+const config: Config = {
+  preset: "ts-jest",
+  moduleNameMapper: {
+    "^testcontainers$": path.resolve(__dirname, "../../testcontainers/src"),
+  },
+};
+
+export default config;

packages/modules/mockserver/jest.config.ts

@@ -0,0 +1,39 @@
+{
+  "name": "@testcontainers/mockserver",
+  "version": "10.16.0",
+  "description": "Mockserver module for Testcontainers",
+  "main": "build/index.js",
+  "devDependencies": {
+    "@types/superagent": "^8.1.9",
+    "mockserver-client": "^5.15.0",
+    "superagent": "^10.1.1"
+  },
+  "scripts": {
+    "prepack": "shx cp ../../../README.md . && shx cp ../../../LICENSE .",
+    "build": "tsc --project tsconfig.build.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/testcontainers/testcontainers-node.git"
+  },
+  "files": [
+    "build"
+  ],
+  "keywords": [
+    "mockserver",
+    "testing",
+    "docker",
+    "testcontainers"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/testcontainers/testcontainers-node/issues"
+  },
+  "homepage": "https://github.com/testcontainers/testcontainers-node#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "testcontainers": "^10.16.0"
+  }
+}

packages/modules/mockserver/package.json

@@ -0,0 +1 @@
+export { MockserverContainer, StartedMockserverContainer } from "./mockserver-container";

packages/modules/mockserver/src/index.ts

@@ -0,0 +1,31 @@
+import { mockServerClient } from "mockserver-client";
+import superagent from "superagent";
+import { MockserverContainer } from "./mockserver-container";
+
+describe.only("MockserverContainer", () => {
+  jest.setTimeout(240_000);
+
+  it("should start and accept mocks", async () => {
+    const container = await new MockserverContainer().start();
+    const client = mockServerClient(container.getHost(), container.getMockserverPort());
+    const url = container.getUrl();
+
+    await client.mockAnyResponse({
+      httpRequest: {
+        method: "GET",
+        path: "/foo",
+      },
+      httpResponse: {
+        body: {
+          string: "bar",
+        },
+        statusCode: 200,
+      },
+    });
+
+    const response = await superagent.get(`${url}/foo`);
+
+    expect(response.statusCode).toBe(200);
+    expect(response.text).toBe("bar");
+  });
+});

packages/modules/mockserver/src/mockserver-container.test.ts

@@ -0,0 +1,27 @@
+import { AbstractStartedContainer, GenericContainer, Wait } from "testcontainers";
+
+export class StartedMockserverContainer extends AbstractStartedContainer {
+  getMockserverPort(): number {
+    return this.getFirstMappedPort();
+  }
+
+  getUrl(): string {
+    return `http://${this.getHost()}:${this.getFirstMappedPort()}`;
+  }
+}
+
+const MOCKSERVER_PORT = 1080;
+
+export class MockserverContainer extends GenericContainer {
+  constructor(image = "mockserver/mockserver:5.15.0") {
+    super(image);
+
+    this.withWaitStrategy(Wait.forAll([Wait.forLogMessage(/started on port: 1080/)])).withStartupTimeout(120_000);
+  }
+
+  override async start(): Promise<StartedMockserverContainer> {
+    this.withExposedPorts(MOCKSERVER_PORT);
+
+    return new StartedMockserverContainer(await super.start());
+  }
+}

packages/modules/mockserver/src/mockserver-container.ts

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": [
+    "build",
+    "jest.config.ts",
+    "src/**/*.test.ts"
+  ],
+  "references": [
+    {
+      "path": "../../testcontainers"
+    }
+  ]
+}

packages/modules/mockserver/tsconfig.build.json

@@ -0,0 +1,21 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "build",
+    "paths": {
+      "testcontainers": [
+        "../../testcontainers/src"
+      ]
+    }
+  },
+  "exclude": [
+    "build",
+    "jest.config.ts"
+  ],
+  "references": [
+    {
+      "path": "../../testcontainers"
+    }
+  ]
+}