Stop the test proxy container explicitly when tests finish (Azure#19473)

Giving the container a name and then stopping it using docker container stop once tests complete should fix Azure#19363.

Author: timovv

common/tools/dev-tool/src/commands/test-proxy/index.ts

@@ -10,5 +10,6 @@ export const commandInfo = makeCommandInfo(
 
 export default subCommand(commandInfo, {
   start: () => import("./start"),
+  stop: () => import("./stop"),
   "wait-for-proxy-endpoint": () => import("./waitForProxyEndpoint"),
 });

common/tools/dev-tool/src/commands/test-proxy/stop.ts

@@ -0,0 +1,16 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { leafCommand, makeCommandInfo } from "../../framework/command";
+import { stopProxyTool } from "../../util/testProxyUtils";
+
+export const commandInfo = makeCommandInfo(
+  "test-proxy",
+  "stops the test proxy that was started with test-proxy start, if it was running",
+  {}
+);
+
+export default leafCommand(commandInfo, async () => {
+  await stopProxyTool();
+  return true;
+});

common/tools/dev-tool/src/util/testProxyUtils.ts

@@ -9,6 +9,9 @@ import { createPrinter } from "./printer";
 import { resolveRoot } from "./resolveProject";
 
 const log = createPrinter("test-proxy");
+
+const CONTAINER_NAME = "js-azsdk-test-proxy";
+
 export async function startProxyTool(): Promise<void> {
   log.info(`Attempting to start test proxy at http://localhost:5000 & https://localhost:5001.\n`);
 
@@ -24,12 +27,19 @@ export async function startProxyTool(): Promise<void> {
   log.info(`Check the output file "${outFileName}" for test-proxy logs.`);
 }
 
+export async function stopProxyTool(): Promise<void> {
+  log.info("Attempting to stop the test proxy if it is running");
+  
+  const stopProcess = spawn(`docker stop ${CONTAINER_NAME}`, [], { shell: true });
+  return new Promise(resolve => stopProcess.on("close", resolve));
+};
+
 async function getDockerRunCommand() {
   const repoRoot = await resolveRoot(); // /workspaces/azure-sdk-for-js/
   const testProxyRecordingsLocation = "/srv/testproxy";
   const allowLocalhostAccess = "--add-host host.docker.internal:host-gateway";
   const imageToLoad = `azsdkengsys.azurecr.io/engsys/testproxy-lin:${await getImageTag()}`;
-  return `docker run -v ${repoRoot}:${testProxyRecordingsLocation} -p 5001:5001 -p 5000:5000 ${allowLocalhostAccess} ${imageToLoad}`;
+  return `docker run --rm --name ${CONTAINER_NAME} -v ${repoRoot}:${testProxyRecordingsLocation} -p 5001:5001 -p 5000:5000 ${allowLocalhostAccess} ${imageToLoad}`;
 }
 
 export async function isProxyToolActive(): Promise<boolean> {

common/tools/dev-tool/src/util/testUtils.ts

@@ -28,13 +28,14 @@ export async function runTestsWithProxyTool(
   if (
     await shouldRunProxyTool() // Boolean to figure out if we need to run just the mocha command or the test-proxy too
   ) {
-    const testProxyCMD = "dev-tool test-proxy start";
+    const testProxyStartCMD = "dev-tool test-proxy start";
+    const testProxyStopCMD = "dev-tool test-proxy stop";
     const waitForProxyEndpointCMD = "dev-tool test-proxy wait-for-proxy-endpoint";
     await concurrently(
       [
-        { command: testProxyCMD },
+        { command: testProxyStartCMD },
         {
-          command: `${waitForProxyEndpointCMD} && ${testCommandObj.command}`, // Waits for the proxy endpoint to be active and then starts running the tests
+          command: `${waitForProxyEndpointCMD} && ${testCommandObj.command} && ${testProxyStopCMD}`, // Waits for the proxy endpoint to be active and then starts running the tests
           name: testCommandObj.name,
         },
       ],