Reaper should clean up images (#194)

Author: cristianrgreco

src/docker-compose-environment.test.ts

@@ -2,14 +2,12 @@ import fetch from "node-fetch";
 import path from "path";
 import { DockerComposeEnvironment } from "./docker-compose-environment";
 import { Wait } from "./wait";
-import Dockerode from "dockerode";
-import { getRunningContainerNames } from "./test-helper";
+import { getRunningContainerNames, getVolumeNames } from "./test-helper";
 
 describe("DockerComposeEnvironment", () => {
   jest.setTimeout(60000);
 
   const fixtures = path.resolve(__dirname, "..", "fixtures", "docker-compose");
-  const dockerodeClient = new Dockerode();
 
   it("should throw error when compose file is malformed", async () => {
     await expect(new DockerComposeEnvironment(fixtures, "docker-compose-malformed.yml").up()).rejects.toThrowError(
@@ -83,7 +81,7 @@ describe("DockerComposeEnvironment", () => {
         .up()
     ).rejects.toThrowError(`Log message "unexpected" not received after 0ms`);
 
-    expect(await getRunningContainerNames(dockerodeClient)).not.toContain("custom_container_name");
+    expect(await getRunningContainerNames()).not.toContain("custom_container_name");
   });
 
   it("should stop the container when the health check wait strategy times out", async () => {
@@ -94,7 +92,7 @@ describe("DockerComposeEnvironment", () => {
         .up()
     ).rejects.toThrowError(`Health check not healthy after 0ms`);
 
-    expect(await getRunningContainerNames(dockerodeClient)).not.toContain("container_1");
+    expect(await getRunningContainerNames()).not.toContain("container_1");
   });
 
   it("should support health check wait strategy", async () => {
@@ -125,10 +123,7 @@ describe("DockerComposeEnvironment", () => {
 
     await environment.down();
 
-    const testVolumes = (await dockerodeClient.listVolumes()).Volumes.map(
-      (volume) => volume.Name
-    ).filter((volumeName) => volumeName.includes("test-volume"));
-
+    const testVolumes = (await getVolumeNames()).filter((volumeName) => volumeName.includes("test-volume"));
     expect(testVolumes).toHaveLength(0);
   });
 

src/generic-container.test.ts

@@ -1,4 +1,3 @@
-import Dockerode from "dockerode";
 import fetch from "node-fetch";
 import path from "path";
 import { createServer, Server } from "http";
@@ -9,19 +8,13 @@ import { Readable } from "stream";
 import { RandomUuid } from "./uuid";
 import { TestContainers } from "./test-containers";
 import { RandomPortClient } from "./port-client";
-import { getRunningContainerNames } from "./test-helper";
+import { getContainerById, getEvents, getRunningContainerNames } from "./test-helper";
 
 describe("GenericContainer", () => {
   jest.setTimeout(180_000);
 
   const fixtures = path.resolve(__dirname, "..", "fixtures", "docker");
 
-  let dockerodeClient: Dockerode;
-
-  beforeEach(() => {
-    dockerodeClient = new Dockerode();
-  });
-
   it("should wait for port", async () => {
     const container = await new GenericContainer("cristianrgreco/testcontainer:1.1.12").withExposedPorts(8080).start();
 
@@ -95,7 +88,7 @@ describe("GenericContainer", () => {
 
   it("should set network mode", async () => {
     const container = await new GenericContainer("cristianrgreco/testcontainer:1.1.12").withNetworkMode("host").start();
-    const dockerContainer = dockerodeClient.getContainer(container.getId());
+    const dockerContainer = getContainerById(container.getId());
 
     const containerInfo = await dockerContainer.inspect();
 
@@ -177,7 +170,7 @@ describe("GenericContainer", () => {
 
   it("should set default log driver", async () => {
     const container = await new GenericContainer("cristianrgreco/testcontainer:1.1.12").withDefaultLogDriver().start();
-    const dockerContainer = dockerodeClient.getContainer(container.getId());
+    const dockerContainer = getContainerById(container.getId());
 
     const containerInfo = await dockerContainer.inspect();
 
@@ -193,7 +186,7 @@ describe("GenericContainer", () => {
       .withPrivilegedMode()
       .withExposedPorts(8080)
       .start();
-    const dockerContainer = dockerodeClient.getContainer(container.getId());
+    const dockerContainer = getContainerById(container.getId());
     const containerInfo = await dockerContainer.inspect();
     expect(containerInfo.HostConfig.Privileged).toBe(true);
 
@@ -207,7 +200,7 @@ describe("GenericContainer", () => {
   it("should use pull policy", async () => {
     const container1 = await new GenericContainer("cristianrgreco/testcontainer:1.1.12").withExposedPorts(8080).start();
 
-    const events = (await dockerodeClient.getEvents()).setEncoding("utf-8") as Readable;
+    const events = await getEvents();
 
     const container2 = await new GenericContainer("cristianrgreco/testcontainer:1.1.12")
       .withPullPolicy(new AlwaysPullPolicy())
@@ -277,7 +270,7 @@ describe("GenericContainer", () => {
         .start()
     ).rejects.toThrowError("Port 8081 not bound after 0ms");
 
-    expect(await getRunningContainerNames(dockerodeClient)).not.toContain(containerName);
+    expect(await getRunningContainerNames()).not.toContain(containerName);
   });
 
   it("should stop the container when the log message wait strategy times out", async () => {
@@ -292,7 +285,7 @@ describe("GenericContainer", () => {
         .start()
     ).rejects.toThrowError(`Log message "unexpected" not received after 0ms`);
 
-    expect(await getRunningContainerNames(dockerodeClient)).not.toContain(containerName);
+    expect(await getRunningContainerNames()).not.toContain(containerName);
   });
 
   it("should stop the container when the health check wait strategy times out", async () => {
@@ -309,7 +302,7 @@ describe("GenericContainer", () => {
         .start()
     ).rejects.toThrowError("Health check not healthy after 0ms");
 
-    expect(await getRunningContainerNames(dockerodeClient)).not.toContain(containerName);
+    expect(await getRunningContainerNames()).not.toContain(containerName);
   });
 
   it("should stop the container when the health check fails", async () => {
@@ -326,7 +319,7 @@ describe("GenericContainer", () => {
         .start()
     ).rejects.toThrowError("Health check failed");
 
-    expect(await getRunningContainerNames(dockerodeClient)).not.toContain(containerName);
+    expect(await getRunningContainerNames()).not.toContain(containerName);
   });
 
   it("should honour .dockerignore file", async () => {

src/generic-container.ts

@@ -55,9 +55,10 @@ export class GenericContainerBuilder {
     return this;
   }
 
-  public async build(): Promise<GenericContainer> {
-    const dockerImageName = new DockerImageName(undefined, this.uuid.nextUuid(), this.uuid.nextUuid());
+  public async build(image = `${this.uuid.nextUuid()}:${this.uuid.nextUuid()}`): Promise<GenericContainer> {
+    const dockerImageName = DockerImageName.fromString(image);
     const dockerClient = await DockerClientInstance.getInstance();
+    await ReaperInstance.getInstance(dockerClient);
     await dockerClient.buildImage(dockerImageName, this.context, this.dockerfileName, this.buildArgs);
     const container = new GenericContainer(dockerImageName.toString());
 

src/network.test.ts

@@ -1,6 +1,6 @@
-import Dockerode from "dockerode";
 import { GenericContainer } from "./generic-container";
 import { Network } from "./network";
+import { getContainerById } from "./test-helper";
 
 describe("Network", () => {
   jest.setTimeout(180_000);
@@ -12,9 +12,7 @@ describe("Network", () => {
       .withNetworkMode(network.getName())
       .start();
 
-    const dockerodeClient = new Dockerode();
-
-    const dockerContainer = dockerodeClient.getContainer(container.getId());
+    const dockerContainer = getContainerById(container.getId());
     const containerInfo = await dockerContainer.inspect();
     expect(containerInfo.HostConfig.NetworkMode).toBe(network.getName());
 

src/reaper.test.ts

@@ -0,0 +1,42 @@
+import { GenericContainer } from "./generic-container";
+import { ReaperInstance } from "./reaper";
+import { getImagesRepoTags, getRunningContainerIds, getRunningNetworkIds } from "./test-helper";
+import { Network } from "./network";
+import path from "path";
+import { RandomUuid } from "./uuid";
+
+describe("Reaper", () => {
+  jest.setTimeout(60_000);
+
+  it("should remove containers", async () => {
+    const container = await new GenericContainer("cristianrgreco/testcontainer:1.1.12").start();
+
+    await ReaperInstance.stopInstance();
+
+    expect(await getRunningContainerIds()).toContain(container.getId());
+    await new Promise((resolve) => setTimeout(resolve, 15_000));
+    expect(await getRunningContainerIds()).not.toContain(container.getId());
+  });
+
+  it("should remove networks", async () => {
+    const network = await new Network().start();
+
+    await ReaperInstance.stopInstance();
+
+    expect(await getRunningNetworkIds()).toContain(network.getId());
+    await new Promise((resolve) => setTimeout(resolve, 15_000));
+    expect(await getRunningNetworkIds()).not.toContain(network.getId());
+  });
+
+  it("should remove images", async () => {
+    const imageId = `${new RandomUuid().nextUuid()}:${new RandomUuid().nextUuid()}`;
+    const context = path.resolve(__dirname, "..", "fixtures", "docker", "docker");
+    await GenericContainer.fromDockerfile(context).build(imageId);
+
+    await ReaperInstance.stopInstance();
+
+    expect(await getImagesRepoTags()).toContain(imageId);
+    await new Promise((resolve) => setTimeout(resolve, 15_000));
+    expect(await getImagesRepoTags()).not.toContain(imageId);
+  });
+});

src/reaper.ts

@@ -8,6 +8,7 @@ import { DockerClient } from "./docker-client";
 
 export interface Reaper {
   addProject(projectName: string): void;
+  stop(): void;
 }
 
 class RealReaper implements Reaper {
@@ -20,18 +21,26 @@ class RealReaper implements Reaper {
   public addProject(projectName: string): void {
     this.socket.write(`label=com.docker.compose.project=${projectName}\r\n`);
   }
+
+  public stop(): void {
+    this.socket.end();
+  }
 }
 
 class DisabledReaper implements Reaper {
   public addProject(): void {
     // noop
   }
+
+  public stop(): void {
+    // noop
+  }
 }
 
 export class ReaperInstance {
-  private static DEFAULT_IMAGE = "testcontainers/ryuk:0.3.0";
+  private static DEFAULT_IMAGE = "cristianrgreco/ryuk:0.4.0";
 
-  private static instance: Promise<Reaper>;
+  private static instance?: Promise<Reaper>;
 
   public static async getInstance(dockerClient: DockerClient): Promise<Reaper> {
     if (!this.instance) {
@@ -45,6 +54,14 @@ export class ReaperInstance {
     return this.instance;
   }
 
+  public static async stopInstance(): Promise<void> {
+    if (this.instance) {
+      const reaper = await this.instance;
+      reaper.stop();
+      this.instance = undefined;
+    }
+  }
+
   public static getImage(): string {
     return process.env.RYUK_CONTAINER_IMAGE === undefined ? this.DEFAULT_IMAGE : process.env.RYUK_CONTAINER_IMAGE;
   }

src/test-helper.ts

@@ -1,9 +1,40 @@
 import Dockerode from "dockerode";
+import { Readable } from "stream";
 
-export const getRunningContainerNames = async (dockerode: Dockerode): Promise<string[]> => {
+export const dockerode = new Dockerode();
+
+export const getContainerById = (id: string): Dockerode.Container => dockerode.getContainer(id);
+
+export const getEvents = async (): Promise<Readable> => {
+  const events = (await dockerode.getEvents()) as Readable;
+  events.setEncoding("utf-8");
+  return events;
+};
+
+export const getRunningContainerNames = async (): Promise<string[]> => {
   const containers = await dockerode.listContainers();
   return containers
     .map((container) => container.Names)
     .reduce((result, containerNames) => [...result, ...containerNames], [])
     .map((containerName) => containerName.replace("/", ""));
 };
+
+export const getRunningContainerIds = async (): Promise<string[]> => {
+  const containers = await dockerode.listContainers();
+  return containers.map((container) => container.Id);
+};
+
+export const getRunningNetworkIds = async (): Promise<string[]> => {
+  const networks = await dockerode.listNetworks();
+  return networks.map((network) => network.Id);
+};
+
+export const getImagesRepoTags = async (): Promise<string[]> => {
+  const images = await dockerode.listImages();
+  return images.map((image) => image.RepoTags[0]);
+};
+
+export const getVolumeNames = async (): Promise<string[]> => {
+  const { Volumes: volumes } = await dockerode.listVolumes();
+  return volumes.map((volume) => volume.Name);
+};