Improve Docker cleanup in tests to reduce other flakes & races

Author: pimterry

test/integration/interceptors/docker-attachment.spec.ts

@@ -8,9 +8,10 @@ import { delay } from '@httptoolkit/util';
 import Docker from 'dockerode';
 import fetch from 'node-fetch';
 
-import { FIXTURES_DIR } from '../../test-util';
+import { FIXTURES_DIR, TEST_CONTAINER_LABEL, removeTestContainers } from '../../test-util';
 import { setupInterceptor, itIsAvailable } from './interceptor-test-utils';
 import { waitForDockerStream } from '../../../src/interceptors/docker/docker-utils';
+import { DOCKER_CONTAINER_LABEL } from '../../../src/interceptors/docker/docker-commands';
 
 const docker = new Docker();
 const DOCKER_FIXTURES = path.join(FIXTURES_DIR, 'docker');
@@ -49,6 +50,7 @@ async function buildAndRun(dockerFolder: string, options: {
     // Run the container, using its default entrypoint
     const container = await docker.createContainer({
         Image: imageName,
+        Labels: { [TEST_CONTAINER_LABEL]: '' },
         HostConfig: {
             AutoRemove: true,
             PortBindings: portBindings
@@ -86,10 +88,15 @@ async function buildAndRun(dockerFolder: string, options: {
 }
 
 async function killAllContainers() {
-    const containers = await docker.listContainers()
+    const containers = await docker.listContainers({
+        filters: JSON.stringify({ label: [TEST_CONTAINER_LABEL] })
+    });
     await Promise.all(containers.map(c =>
-        docker.getContainer(c.Id).stop({ t: 0 })
+        docker.getContainer(c.Id).stop({ t: 0 }).catch(() => {})
     ));
+
+    // Wait until containers are fully gone (AutoRemove may be async):
+    await removeTestContainers(docker, TEST_CONTAINER_LABEL);
 }
 
 const interceptorSetup = setupInterceptor('docker-attach');
@@ -105,6 +112,7 @@ describe('Docker single-container interceptor', function () {
         const { server, interceptor } = await interceptorSetup;
         await killAllContainers();
         await interceptor.deactivate(server.port);
+        await removeTestContainers(docker, DOCKER_CONTAINER_LABEL);
         await server.stop();
     });
 

test/integration/interceptors/docker-terminal-interception.spec.ts

@@ -8,7 +8,7 @@ import { expect } from 'chai';
 import { delay } from '@httptoolkit/util';
 
 import { setupTest } from './interceptor-test-utils';
-import { FIXTURES_DIR } from '../../test-util';
+import { FIXTURES_DIR, TEST_CONTAINER_LABEL, removeTestContainers } from '../../test-util';
 import { spawnToResult } from '../../../src/util/process-management';
 
 import { getTerminalEnvVars } from '../../../src/interceptors/terminal/terminal-env-overrides';
@@ -17,6 +17,7 @@ import {
     startDockerInterceptionServices,
     stopDockerInterceptionServices
 } from '../../../src/interceptors/docker/docker-interception-services';
+import { DOCKER_CONTAINER_LABEL } from '../../../src/interceptors/docker/docker-commands';
 
 const testSetup = setupTest();
 
@@ -37,6 +38,13 @@ describe('Docker CLI interception', function () {
     afterEach(async () => {
         const { server } = await testSetup;
         await stopDockerInterceptionServices(server.port, ruleParams);
+
+        // Make sure all relevant containers are fully gone, so the next test
+        // definitely starts clean:
+        const docker = new Docker();
+        await removeTestContainers(docker, TEST_CONTAINER_LABEL);
+        await removeTestContainers(docker, DOCKER_CONTAINER_LABEL);
+
         await server.stop();
     });
 
@@ -318,7 +326,7 @@ Successfully built <hash>
 
         const terminalEnvOverrides = getTerminalEnvVars(server.port, httpsConfig, process.env);
 
-        const uninterceptedResult = await spawnToResult('docker', ['create', 'node:14']);
+        const uninterceptedResult = await spawnToResult('docker', ['create', '--label', TEST_CONTAINER_LABEL, 'node:14']);
 
         expect(uninterceptedResult.exitCode).to.equal(0);
         expect(uninterceptedResult.stderr).to.equal('');

test/test-util.ts

@@ -1,3 +1,33 @@
 import * as path from 'path';
 
-export const FIXTURES_DIR = path.join(__dirname, 'fixtures');
+import { delay } from '@httptoolkit/util';
+import Docker from 'dockerode';
+
+export const FIXTURES_DIR = path.join(__dirname, 'fixtures');
+
+// Label applied to all Docker containers created by tests, to allow targeted cleanup
+// without interfering with system containers or the app's own labels (tech.httptoolkit.docker.*).
+export const TEST_CONTAINER_LABEL = 'tech.httptoolkit.test';
+
+// Remove all containers matching a label filter, polling until they're fully
+// gone from Docker's perspective (not just API-removed but still visible).
+export async function removeTestContainers(docker: Docker, label: string) {
+    const containers = await docker.listContainers({
+        all: true,
+        filters: JSON.stringify({ label: [label] })
+    });
+
+    await Promise.all(containers.map(c =>
+        docker.getContainer(c.Id).remove({ force: true }).catch(() => {})
+    ));
+
+    // Poll until Docker confirms no matching containers remain:
+    for (let i = 0; i < 20; i++) {
+        const remaining = await docker.listContainers({
+            all: true,
+            filters: JSON.stringify({ label: [label] })
+        });
+        if (remaining.length === 0) return;
+        await delay(100);
+    }
+}