Support copying directories to a started container (#614)

docs/features/containers.md

@@ -112,6 +112,25 @@ const container = await new GenericContainer("alpine")
   .start();
 ```
 
+Or after it starts:
+
+```javascript
+const container = await new GenericContainer("alpine").start();
+
+container.copyFilesToContainer([{ 
+  source: "/local/file.txt", 
+  target: "/remote/file1.txt"
+}])
+container.copyDirectoriesToContainer([{
+  source: "/localdir",
+  target: "/some/nested/remotedir"
+}])
+container.copyContentToContainer([{ 
+  content: "hello world",
+  target: "/remote/file2.txt"
+}])
+````
+
 An optional `mode` can be specified in octal for setting file permissions:
 
 ```javascript

src/generic-container/generic-container.test.ts

@@ -293,6 +293,18 @@ describe("GenericContainer", () => {
     await container.stop();
   });
 
+  it("should copy file to started container", async () => {
+    const source = path.resolve(fixtures, "docker", "test.txt");
+    const target = "/tmp/test.txt";
+    const container = await new GenericContainer("cristianrgreco/testcontainer:1.1.14").withExposedPorts(8080).start();
+
+    await container.copyFilesToContainer([{ source, target }]);
+
+    expect((await container.exec(["cat", target])).output).toEqual(expect.stringContaining("hello world"));
+
+    await container.stop();
+  });
+
   it("should copy directory to container", async () => {
     const source = path.resolve(fixtures, "docker");
     const target = "/tmp";
@@ -323,6 +335,18 @@ describe("GenericContainer", () => {
     await container.stop();
   });
 
+  it("should copy directory to started container", async () => {
+    const source = path.resolve(fixtures, "docker");
+    const target = "/tmp";
+    const container = await new GenericContainer("cristianrgreco/testcontainer:1.1.14").withExposedPorts(8080).start();
+
+    container.copyDirectoriesToContainer([{ source, target }]);
+
+    expect((await container.exec("cat /tmp/test.txt")).output).toEqual(expect.stringContaining("hello world"));
+
+    await container.stop();
+  });
+
   it("should copy content to container", async () => {
     const content = "hello world";
     const target = "/tmp/test.txt";
@@ -353,6 +377,18 @@ describe("GenericContainer", () => {
     await container.stop();
   });
 
+  it("should copy content to started container", async () => {
+    const content = "hello world";
+    const target = "/tmp/test.txt";
+    const container = await new GenericContainer("cristianrgreco/testcontainer:1.1.14").withExposedPorts(8080).start();
+
+    container.copyContentToContainer([{ content, target }]);
+
+    expect((await container.exec(["cat", target])).output).toEqual(expect.stringContaining(content));
+
+    await container.stop();
+  });
+
   it("should honour .dockerignore file", async () => {
     const context = path.resolve(fixtures, "docker-with-dockerignore");
     const container = await GenericContainer.fromDockerfile(context).build();

src/generic-container/started-generic-container.ts

@@ -1,6 +1,6 @@
 import { RestartOptions, StartedTestContainer, StopOptions, StoppedTestContainer } from "../test-container";
 import Dockerode from "dockerode";
-import { ContentToCopy, ExecResult, FileToCopy, Labels } from "../docker/types";
+import { ContentToCopy, DirectoryToCopy, ExecResult, FileToCopy, Labels } from "../docker/types";
 import { inspectContainer, InspectResult } from "../docker/functions/container/inspect-container";
 import { BoundPorts } from "../bound-ports";
 import { containerLog, log } from "../logger";
@@ -135,6 +135,15 @@ export class StartedGenericContainer implements StartedTestContainer {
     log.debug(`Copied files to container`, { containerId: this.container.id });
   }
 
+  public async copyDirectoriesToContainer(directoriesToCopy: DirectoryToCopy[]): Promise<void> {
+    log.debug(`Copying directories to container...`, { containerId: this.container.id });
+    const tar = archiver("tar");
+    directoriesToCopy.forEach(({ source, target }) => tar.directory(source, target));
+    tar.finalize();
+    await putContainerArchive({ container: this.container, stream: tar, containerPath: "/" });
+    log.debug(`Copied directories to container`, { containerId: this.container.id });
+  }
+
   public async copyContentToContainer(contentsToCopy: ContentToCopy[]): Promise<void> {
     log.debug(`Copying content to container...`, { containerId: this.container.id });
     const tar = archiver("tar");

src/modules/abstract-started-container.ts

@@ -1,5 +1,5 @@
 import { RestartOptions, StartedTestContainer, StopOptions, StoppedTestContainer } from "../test-container";
-import { ContentToCopy, ExecResult, FileToCopy, Labels } from "../docker/types";
+import { ContentToCopy, DirectoryToCopy, ExecResult, FileToCopy, Labels } from "../docker/types";
 import { Readable } from "stream";
 
 export class AbstractStartedContainer implements StartedTestContainer {
@@ -67,6 +67,10 @@ export class AbstractStartedContainer implements StartedTestContainer {
     return this.startedTestContainer.copyFilesToContainer(filesToCopy);
   }
 
+  public async copyDirectoriesToContainer(directoriesToCopy: DirectoryToCopy[]): Promise<void> {
+    return this.startedTestContainer.copyDirectoriesToContainer(directoriesToCopy);
+  }
+
   public async copyContentToContainer(contentsToCopy: ContentToCopy[]): Promise<void> {
     return this.startedTestContainer.copyContentToContainer(contentsToCopy);
   }

src/test-container.ts

@@ -75,6 +75,7 @@ export interface StartedTestContainer {
   getNetworkId(networkName: string): string;
   getIpAddress(networkName: string): string;
   copyArchiveFromContainer(path: string): Promise<NodeJS.ReadableStream>;
+  copyDirectoriesToContainer(directoriesToCopy: DirectoryToCopy[]): Promise<void>;
   copyFilesToContainer(filesToCopy: FileToCopy[]): Promise<void>;
   copyContentToContainer(contentsToCopy: ContentToCopy[]): Promise<void>;
   exec(command: string | string[]): Promise<ExecResult>;