Clean up spk dashboard (#99)

Author: edaena

docs/service-introspection.md

@@ -101,6 +101,7 @@ Launch the service introspection dashboard
 
 Options:
   -p, --port <port>  Port to launch the dashboard on (default: 4040)
+  -r, --remove-all   Removes previously launched instances of the dashboard (default: false)
   -h, --help         output usage information
 ```
 

src/commands/deployment/dashboard.test.ts

@@ -25,7 +25,7 @@ afterAll(() => {
 describe("Validate dashboard container pull", () => {
   test("Pull dashboard container if docker is installed", async () => {
     try {
-      const dashboardContainerId = await launchDashboard(2020);
+      const dashboardContainerId = await launchDashboard(2020, false);
       const dockerInstalled = await validatePrereqs(["docker"], false);
       if (dockerInstalled) {
         const dockerId = await exec("docker", [
@@ -45,3 +45,30 @@ describe("Validate dashboard container pull", () => {
     }
   }, 30000);
 });
+
+describe("Validate dashboard clean up", () => {
+  test("Launch the dashboard two times", async () => {
+    try {
+      const dashboardContainerId = await launchDashboard(2020, true);
+      const dockerInstalled = await validatePrereqs(["docker"], false);
+      if (dockerInstalled) {
+        const dockerId = await exec("docker", [
+          "images",
+          "-q",
+          Config().introspection!.dashboard!.image!
+        ]);
+
+        expect(dockerId).toBeDefined();
+        expect(dashboardContainerId).not.toBe("");
+        logger.info("Verified that docker image has been pulled.");
+        const dashboardContainerId2 = await launchDashboard(2020, true);
+        expect(dashboardContainerId).not.toBe(dashboardContainerId2);
+        await exec("docker", ["container", "stop", dashboardContainerId2]);
+      } else {
+        expect(dashboardContainerId).toBe("");
+      }
+    } catch (err) {
+      logger.error(err);
+    }
+  }, 30000);
+});

src/commands/deployment/dashboard.ts

@@ -15,6 +15,11 @@ export const dashboardCommandDecorator = (command: commander.Command): void => {
     .alias("d")
     .description("Launch the service introspection dashboard")
     .option("-p, --port <port>", "Port to launch the dashboard on", 4040)
+    .option(
+      "-r, --remove-all",
+      "Removes previously launched instances of the dashboard",
+      false
+    )
     .action(async opts => {
       const config = Config();
       if (
@@ -33,17 +38,53 @@ export const dashboardCommandDecorator = (command: commander.Command): void => {
         );
         return;
       }
-      if (await launchDashboard(opts.port)) {
+      if (await launchDashboard(opts.port, opts.removeAll)) {
         await open("http://localhost:" + opts.port);
       }
     });
 };
 
-export const launchDashboard = async (port: number): Promise<string> => {
+/**
+ * Cleans previously launched spk dashboard docker containers
+ */
+export const cleanDashboarContainers = async () => {
+  const config = Config();
+
+  let dockerOutput = await exec("docker", [
+    "ps",
+    "-a",
+    "-q",
+    "--filter",
+    "ancestor=" + config.introspection!.dashboard!.image!,
+    '--format="{{.ID}}"'
+  ]);
+  if (dockerOutput.length > 0) {
+    dockerOutput = dockerOutput.replace(/\n/g, " ");
+    dockerOutput = dockerOutput.replace(/"/g, "");
+    const containerIds = dockerOutput.split(" ");
+    const args = ["kill", ...containerIds];
+
+    await exec("docker", args);
+  }
+};
+
+/**
+ * Launches an instance of the spk dashboard
+ * @param port the port number to launch the dashboard
+ */
+export const launchDashboard = async (
+  port: number,
+  removeAll: boolean
+): Promise<string> => {
   try {
     if (!(await validatePrereqs(["docker"], false))) {
       return "";
     }
+    // Clean previous dashboard containers
+    if (removeAll) {
+      await cleanDashboarContainers();
+    }
+
     const config = Config();
     const dockerRepository = config.introspection!.dashboard!.image!;
     logger.info("Pulling dashboard docker image");