fix eslint warnings/errors in Deployment Dashboard command (#449)

Author: dennisseah

src/commands/deployment/dashboard.test.ts

@@ -11,6 +11,7 @@ import {
   logger,
 } from "../../logger";
 import {
+  DashboardConfig,
   execute,
   extractManifestRepositoryInformation,
   getEnvVars,
@@ -20,6 +21,20 @@ import {
 import * as dashboard from "./dashboard";
 
 import uuid from "uuid/v4";
+import { deepClone } from "../../lib/util";
+
+const dashboardConf: DashboardConfig = {
+  port: 2020,
+  image: "mcr.microsoft.com/k8s/bedrock/spektate:latest",
+  org: "testOrg",
+  project: "testProject",
+  key: "fakeKey",
+  accountName: "fakeAccount",
+  tableName: "fakeTable",
+  partitionKey: "fakePartitionKey",
+  accessToken: "accessToken",
+  sourceRepoAccessToken: "test_token",
+};
 
 beforeAll(() => {
   enableVerboseLogging();
@@ -37,6 +52,10 @@ const mockConfig = (): void => {
       project: uuid(),
     },
     introspection: {
+      dashboard: {
+        image: "mcr.microsoft.com/k8s/bedrock/spektate:latest",
+        name: "spektate",
+      },
       azure: {
         account_name: uuid(),
         key: uuid(),
@@ -81,8 +100,7 @@ describe("Test validateValues function", () => {
   });
   it("positive test", () => {
     mockConfig();
-    const config = Config();
-    validateValues(config, {
+    validateValues(Config(), {
       port: "4000",
       removeAll: false,
     });
@@ -96,7 +114,7 @@ describe("Test execute function", () => {
     jest
       .spyOn(dashboard, "launchDashboard")
       .mockReturnValueOnce(Promise.resolve(uuid()));
-    jest.spyOn(dashboard, "validateValues").mockReturnValueOnce();
+    jest.spyOn(dashboard, "validateValues").mockReturnValueOnce(dashboardConf);
     (open as jest.Mock).mockReturnValueOnce(Promise.resolve());
     await execute(
       {
@@ -125,16 +143,13 @@ describe("Test execute function", () => {
 describe("Validate dashboard container pull", () => {
   test("Pull dashboard container if docker is installed", async () => {
     try {
-      mockConfig();
-      const config = Config();
-      const dashboardContainerId = await launchDashboard(config, 2020, false);
+      const dashboardContainerId = await launchDashboard(dashboardConf, false);
       const dockerInstalled = validatePrereqs(["docker"], false);
       if (dockerInstalled) {
         const dockerId = await exec("docker", [
           "images",
           "-q",
-          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-          config.introspection!.dashboard!.image!,
+          dashboardConf.image,
         ]);
         expect(dockerId).toBeDefined();
         expect(dashboardContainerId).not.toBe("");
@@ -152,22 +167,22 @@ describe("Validate dashboard container pull", () => {
 describe("Validate dashboard clean up", () => {
   test("Launch the dashboard two times", async () => {
     try {
-      mockConfig();
-      const config = Config();
-      const dashboardContainerId = await launchDashboard(config, 2020, true);
+      const dashboardContainerId = await launchDashboard(dashboardConf, true);
       const dockerInstalled = validatePrereqs(["docker"], false);
       if (dockerInstalled) {
         const dockerId = await exec("docker", [
           "images",
           "-q",
-          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-          config.introspection!.dashboard!.image!,
+          dashboardConf.image,
         ]);
 
         expect(dockerId).toBeDefined();
         expect(dashboardContainerId).not.toBe("");
         logger.info("Verified that docker image has been pulled.");
-        const dashboardContainerId2 = await launchDashboard(config, 2020, true);
+        const dashboardContainerId2 = await launchDashboard(
+          dashboardConf,
+          true
+        );
         expect(dashboardContainerId).not.toBe(dashboardContainerId2);
         await exec("docker", ["container", "stop", dashboardContainerId2]);
       } else {
@@ -183,7 +198,7 @@ describe("Fallback to azure devops access token", () => {
   test("Has repo_access_token specified", async () => {
     mockConfig();
     const config = Config();
-    const envVars = (await getEnvVars(config)).toString();
+    const envVars = (await getEnvVars(dashboardConf)).toString();
     logger.info(
       `spin: ${envVars}, act: ${
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -195,41 +210,33 @@ describe("Fallback to azure devops access token", () => {
   });
 
   it("No repo_access_token was specified", async () => {
-    mockConfig();
-    const config = Config();
-    const envVars = (await getEnvVars(config)).toString();
-    const expectedSubstring =
-      "REACT_APP_SOURCE_REPO_ACCESS_TOKEN=" +
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      config.introspection!.azure!.source_repo_access_token!;
+    const envVars = (await getEnvVars(dashboardConf)).toString();
+    const expectedSubstring = `REACT_APP_SOURCE_REPO_ACCESS_TOKEN=${dashboardConf.sourceRepoAccessToken}`;
     expect(envVars.includes(expectedSubstring)).toBeTruthy();
   });
 });
 
 describe("Extract manifest repository information", () => {
   test("Manifest repository information is successfully extracted", () => {
-    (Config as jest.Mock).mockReturnValue({
-      azure_devops: {
-        manifest_repository:
-          "https://dev.azure.com/bhnook/fabrikam/_git/materialized",
-      },
-    });
-    const config = Config();
+    const config = deepClone(dashboardConf);
+    config.manifestRepository =
+      "https://dev.azure.com/bhnook/fabrikam/_git/materialized";
+
     let manifestInfo = extractManifestRepositoryInformation(config);
     expect(manifestInfo).toBeDefined();
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    expect(manifestInfo!.githubUsername).toBeUndefined();
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    expect(manifestInfo!.manifestRepoName).toBe("materialized");
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    config.azure_devops!["manifest_repository"] =
-      "https://github.com/username/manifest";
+    if (manifestInfo) {
+      expect(manifestInfo.githubUsername).toBeUndefined();
+      expect(manifestInfo.manifestRepoName).toBe("materialized");
+    }
+
+    config.manifestRepository = "https://github.com/username/manifest";
     manifestInfo = extractManifestRepositoryInformation(config);
+
     expect(manifestInfo).toBeDefined();
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    expect(manifestInfo!.githubUsername).toBe("username");
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    expect(manifestInfo!.manifestRepoName).toBe("manifest");
+    if (manifestInfo) {
+      expect(manifestInfo.githubUsername).toBe("username");
+      expect(manifestInfo.manifestRepoName).toBe("manifest");
+    }
 
     logger.info("Verified that manifest repository extraction works");
   });