Implement providing IPC mode (#196)

Author: cristianrgreco

README.md

@@ -281,6 +281,16 @@ const container = await new GenericContainer("alpine")
   .start();
 ```
 
+Creating a container with [IPC mode](https://docs.docker.com/engine/reference/run/#ipc-settings---ipc):
+
+```javascript
+const { GenericContainer } = require("testcontainers");
+
+const container = await new GenericContainer("alpine")
+  .withIpcMode("host")
+  .start();
+```
+
 Testcontainers will not wait for a container to stop, to override:
 
 ```javascript

src/docker-client.ts

@@ -89,6 +89,7 @@ type CreateOptions = {
   privilegedMode: boolean;
   autoRemove: boolean;
   extraHosts: ExtraHost[];
+  ipcMode?: string;
 };
 
 export type CreateNetworkOptions = {
@@ -147,6 +148,7 @@ export class DockerodeClient implements DockerClient {
       // @ts-ignore
       Healthcheck: this.getHealthCheck(options.healthCheck),
       HostConfig: {
+        IpcMode: options.ipcMode,
         ExtraHosts: this.getExtraHosts(options.extraHosts),
         AutoRemove: options.autoRemove,
         NetworkMode: options.networkMode,

src/generic-container.test.ts

@@ -253,6 +253,19 @@ describe("GenericContainer", () => {
     await container.stop();
   });
 
+  it("should set the IPC mode", async () => {
+    const container = await new GenericContainer("cristianrgreco/testcontainer:1.1.12")
+      .withIpcMode("host")
+      .withExposedPorts(8080)
+      .start();
+
+    const url = `http://${container.getHost()}:${container.getMappedPort(8080)}`;
+    const response = await fetch(`${url}/hello-world`);
+
+    expect(response.status).toBe(200);
+    await container.stop();
+  });
+
   it("should stop the container when the host port check wait strategy times out", async () => {
     const containerName = `container-${new RandomUuid().nextUuid()}`;
 

src/generic-container.ts

@@ -89,6 +89,7 @@ export class GenericContainer implements TestContainer {
   protected useDefaultLogDriver = false;
   protected privilegedMode = false;
   protected daemonMode = false;
+  protected ipcMode?: string;
   protected pullPolicy: PullPolicy = new DefaultPullPolicy();
   protected tarToCopy?: archiver.Archiver;
 
@@ -135,6 +136,7 @@ export class GenericContainer implements TestContainer {
       privilegedMode: this.privilegedMode,
       autoRemove: this.daemonMode,
       extraHosts: this.extraHosts,
+      ipcMode: this.ipcMode,
     });
 
     if (!this.dockerImageName.isHelperContainer() && PortForwarderInstance.isRunning()) {
@@ -246,6 +248,11 @@ export class GenericContainer implements TestContainer {
     return this;
   }
 
+  public withIpcMode(ipcMode: string): this {
+    this.ipcMode = ipcMode;
+    return this;
+  }
+
   public withCopyFileToContainer(sourcePath: string, containerPath: string): this {
     this.getTarToCopy().file(sourcePath, { name: containerPath });
     return this;