Mockserver

Author: cristianrgreco

docs/modules/cockroachdb.md

@@ -13,9 +13,6 @@ These examples use the following libraries:
 - [pg](https://www.npmjs.com/package/pg)
 
         npm install pg
-
-- [@types/pg](https://www.npmjs.com/package/@types/pg)
-
         npm install @types/pg
 
 Choose an image from the [container registry](https://hub.docker.com/r/cockroachdb/cockroach) and substitute `IMAGE`.

docs/modules/mockserver.md

@@ -1,6 +1,4 @@
-# Mockserver Module
-
-[MockServer](https://www.mock-server.com/#what-is-mockserver) allows you to mock any server or service via HTTP or HTTPS, such as a REST or RPC service.
+# Mockserver
 
 ## Install
 
@@ -10,12 +8,32 @@ npm install @testcontainers/mockserver --save-dev
 
 ## Examples
 
+These examples use the following libraries:
+
+- [mockserver-client](https://www.npmjs.com/package/mockserver-client)
+
+        npm install mockserver-client
+
+- [superagent](https://www.npmjs.com/package/superagent)
+
+        npm install superagent
+        npm install @types/superagent
+
+Choose an image from the [container registry](https://hub.docker.com/r/mockserver/mockserver) and substitute `IMAGE`.
+
+## Examples
+
+### Mock HTTP request
+
 <!--codeinclude-->
-[Start container:](../../packages/modules/mockserver/src/mockserver-container.test.ts) inside_block:startContainer
+[](../../packages/modules/mockserver/src/mockserver-container.test.ts) inside_block:httpMockServer
 <!--/codeinclude-->
 
-MockServer includes built-in TLS support. To obtain an HTTPS URL, use the `getSecureUrl` method. Keep in mind that MockServer uses a self-signed certificate.
+### Mock HTTPS request
+
+!!! note
+    MockServer uses a self-signed certificate for HTTPS connections.
 
 <!--codeinclude-->
-[Using TLS:](../../packages/modules/mockserver/src/mockserver-container.test.ts) inside_block:httpsRequests
-<!--/codeinclude-->
+[](../../packages/modules/mockserver/src/mockserver-container.test.ts) inside_block:mockServerHttps
+<!--/codeinclude-->

packages/modules/mockserver/package.json

@@ -3,11 +3,6 @@
   "version": "11.4.0",
   "description": "Mockserver module for Testcontainers",
   "main": "build/index.js",
-  "devDependencies": {
-    "@types/superagent": "^8.1.9",
-    "mockserver-client": "^5.15.0",
-    "superagent": "^10.2.2"
-  },
   "scripts": {
     "prepack": "shx cp ../../../README.md . && shx cp ../../../LICENSE .",
     "build": "tsc --project tsconfig.build.json"
@@ -35,5 +30,10 @@
   },
   "dependencies": {
     "testcontainers": "^11.4.0"
+  },
+  "devDependencies": {
+    "@types/superagent": "^8.1.9",
+    "mockserver-client": "^5.15.0",
+    "superagent": "^10.2.2"
   }
 }

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

@@ -6,12 +6,11 @@ import { MockserverContainer } from "./mockserver-container";
 const IMAGE = getImage(__dirname);
 
 describe("MockserverContainer", { timeout: 240_000 }, () => {
-  // startContainer {
   it("should start and accept mocks", async () => {
+    // httpMockServer {
     await using container = await new MockserverContainer(IMAGE).start();
-    const client = mockServerClient(container.getHost(), container.getMockserverPort());
-    const url = container.getUrl();
 
+    const client = mockServerClient(container.getHost(), container.getMockserverPort());
     await client.mockAnyResponse({
       httpRequest: {
         method: "GET",
@@ -25,24 +24,24 @@ describe("MockserverContainer", { timeout: 240_000 }, () => {
       },
     });
 
-    const response = await superagent.get(`${url}/foo`);
+    const response = await superagent.get(`${container.getUrl()}/foo`);
 
     expect(response.statusCode).toBe(200);
     expect(response.text).toBe("bar");
+    // }
   });
-  // }
 
   it("should return an https url", async () => {
     await using container = await new MockserverContainer(IMAGE).start();
     const secureUrl = container.getSecureUrl();
     expect(secureUrl.startsWith("https://")).to.equal(true, `${secureUrl} does not start with https://`);
   });
 
-  // httpsRequests {
   it("should respond to https requests", async () => {
+    // mockServerHttps {
     await using container = await new MockserverContainer(IMAGE).start();
-    const client = mockServerClient(container.getHost(), container.getMockserverPort());
 
+    const client = mockServerClient(container.getHost(), container.getMockserverPort());
     await client.mockAnyResponse({
       httpRequest: {
         method: "GET",
@@ -61,6 +60,6 @@ describe("MockserverContainer", { timeout: 240_000 }, () => {
 
     expect(response.statusCode).toBe(200);
     expect(response.text).toBe("bar");
+    // }
   });
-  // }
 });