Fix unit tests and make tests fail if a promise rejects after the test harness is finishes (#2034)

Makefile

@@ -1,3 +1,8 @@
+CMD_ARGS = $(filter-out $@,$(MAKECMDGOALS))
+
+%:
+  @:
+
 EXTENSIONS_DIR = ./extensions
 extensions = $(foreach dir, $(wildcard $(EXTENSIONS_DIR)/*), ${dir})
 extension_node_modules = $(foreach dir, $(wildcard $(EXTENSIONS_DIR)/*), ${dir}/node_modules)
@@ -16,16 +21,16 @@ node_modules: yarn.lock
 	yarn install --frozen-lockfile
 	yarn check --verify-tree --integrity
 
-static/build/LensDev.html:
+static/build/LensDev.html: node_modules
 	yarn compile:renderer
 
 .PHONY: compile-dev
-compile-dev:
+compile-dev: node_modules
 	yarn compile:main --cache
 	yarn compile:renderer --cache
 
 .PHONY: dev
-dev: node_modules binaries/client build-extensions static/build/LensDev.html
+dev: binaries/client build-extensions static/build/LensDev.html
 	yarn dev
 
 .PHONY: lint
@@ -34,7 +39,7 @@ lint:
 
 .PHONY: test
 test: binaries/client
-	yarn test
+	yarn run jest $(or $(CMD_ARGS), "src")
 
 .PHONY: integration-linux
 integration-linux: binaries/client build-extension-types build-extensions
@@ -58,10 +63,6 @@ integration-win: binaries/client build-extension-types build-extensions
 	yarn build:win
 	yarn integration
 
-.PHONY: test-app
-test-app:
-	yarn test
-
 .PHONY: build
 build: node_modules binaries/client build-extensions
 ifeq "$(DETECTED_OS)" "Windows"
@@ -77,7 +78,7 @@ $(extension_dists): src/extensions/npm/extensions/dist
 	cd $(@:/dist=) && npm run build
 
 .PHONY: build-extensions
-build-extensions: $(extension_node_modules) $(extension_dists)
+build-extensions: node_modules $(extension_node_modules) $(extension_dists)
 
 .PHONY: test-extensions
 test-extensions: $(extension_node_modules)

integration/__tests__/app.tests.ts

@@ -1,3 +1,13 @@
+/**
+ * @jest-environment node
+ */
+
+/*
+  Cluster tests are run if there is a pre-existing minikube cluster. Before running cluster tests the TEST_NAMESPACE
+  namespace is removed, if it exists, from the minikube cluster. Resources are created as part of the cluster tests in the
+  TEST_NAMESPACE namespace. This is done to minimize destructive impact of the cluster tests on an existing minikube
+  cluster and vice versa.
+*/
 import { Application } from "spectron";
 import * as utils from "../helpers/utils";
 import { listHelmRepositories } from "../helpers/utils";

package.json

@@ -26,7 +26,6 @@
     "build:linux": "yarn run compile && electron-builder --linux --dir -c.productName=Lens",
     "build:mac": "yarn run compile && electron-builder --mac --dir -c.productName=Lens",
     "build:win": "yarn run compile && electron-builder --win --dir -c.productName=Lens",
-    "test": "scripts/test.sh",
     "integration": "jest --runInBand integration",
     "dist": "yarn run compile && electron-builder --publish onTag",
     "dist:win": "yarn run compile && electron-builder --publish onTag --x64 --ia32",
@@ -36,7 +35,7 @@
     "download:kubectl": "yarn run ts-node build/download_kubectl.ts",
     "download:helm": "yarn run ts-node build/download_helm.ts",
     "build:tray-icons": "yarn run ts-node build/build_tray_icon.ts",
-    "lint": "yarn run eslint $@ --ext js,ts,tsx --max-warnings=0 .",
+    "lint": "yarn run eslint --ext js,ts,tsx --max-warnings=0 .",
     "lint:fix": "yarn run lint --fix",
     "mkdocs-serve-local": "docker build -t mkdocs-serve-local:latest mkdocs/ && docker run --rm -it -p 8000:8000 -v ${PWD}:/docs mkdocs-serve-local:latest",
     "verify-docs": "docker build -t mkdocs-serve-local:latest mkdocs/ && docker run --rm -v ${PWD}:/docs mkdocs-serve-local:latest build --strict",
@@ -52,7 +51,6 @@
   "jest": {
     "collectCoverage": false,
     "verbose": true,
-    "testEnvironment": "node",
     "transform": {
       "^.+\\.tsx?$": "ts-jest"
     },

scripts/test.sh

@@ -1 +0,0 @@
-jest --env=jsdom ${1:-src}

src/common/__tests__/cluster-store.test.ts

@@ -35,7 +35,8 @@ jest.mock("electron", () => {
     app: {
       getVersion: () => "99.99.99",
       getPath: () => "tmp",
-      getLocale: () => "en"
+      getLocale: () => "en",
+      setLoginItemSettings: jest.fn(),
     },
     ipcMain: {
       handle: jest.fn(),

src/common/__tests__/search-store.test.ts

@@ -1,7 +1,3 @@
-/**
- * @jest-environment jsdom
- */
-
 import { SearchStore } from "../search-store";
 
 let searchStore: SearchStore = null;

src/common/__tests__/user-store.test.ts

@@ -1,3 +1,7 @@
+import { Console } from "console";
+
+console = new Console(process.stdout, process.stderr);
+
 import mockFs from "mock-fs";
 
 jest.mock("electron", () => {
@@ -5,7 +9,8 @@ jest.mock("electron", () => {
     app: {
       getVersion: () => "99.99.99",
       getPath: () => "tmp",
-      getLocale: () => "en"
+      getLocale: () => "en",
+      setLoginItemSettings: jest.fn(),
     }
   };
 });

src/common/__tests__/workspace-store.test.ts

@@ -5,7 +5,8 @@ jest.mock("electron", () => {
     app: {
       getVersion: () => "99.99.99",
       getPath: () => "tmp",
-      getLocale: () => "en"
+      getLocale: () => "en",
+      setLoginItemSettings: jest.fn(),
     },
     ipcMain: {
       handle: jest.fn(),

src/common/base-store.ts

@@ -19,7 +19,7 @@ export interface BaseStoreParams<T = any> extends ConfOptions<T> {
  * Note: T should only contain base JSON serializable types.
  */
 export abstract class BaseStore<T = any> extends Singleton {
-  protected storeConfig: Config<T>;
+  protected storeConfig?: Config<T>;
   protected syncDisposers: Function[] = [];
 
   whenLoaded = when(() => this.isLoaded);
@@ -36,7 +36,7 @@ export abstract class BaseStore<T = any> extends Singleton {
   }
 
   get name() {
-    return path.basename(this.storeConfig.path);
+    return path.basename(this.path);
   }
 
   protected get syncRendererChannel() {
@@ -48,7 +48,7 @@ export abstract class BaseStore<T = any> extends Singleton {
   }
 
   get path() {
-    return this.storeConfig.path;
+    return this.storeConfig?.path || "";
   }
 
   protected async init() {
@@ -82,10 +82,13 @@ export abstract class BaseStore<T = any> extends Singleton {
 
   protected async saveToFile(model: T) {
     logger.info(`[STORE]: SAVING ${this.path}`);
+
     // todo: update when fixed https://github.com/sindresorhus/conf/issues/114
-    Object.entries(model).forEach(([key, value]) => {
-      this.storeConfig.set(key, value);
-    });
+    if (this.storeConfig) {
+      for (const [key, value] of Object.entries(model)) {
+        this.storeConfig.set(key, value);
+      }
+    }
   }
 
   enableSync() {

src/jest.setup.ts

@@ -4,3 +4,7 @@ fetchMock.enableMocks();
 
 // Mock __non_webpack_require__ for tests
 globalThis.__non_webpack_require__ = jest.fn();
+
+process.on("unhandledRejection", (err) => {
+  fail(err);
+});

src/renderer/api/__tests__/kube-api-parse.test.ts

@@ -1,134 +1,115 @@
+jest.mock("../kube-object");
+jest.mock("../kube-api");
+jest.mock("../api-manager", () => ({
+  apiManager() {
+    return {
+      registerStore: jest.fn(),
+    };
+  }
+}));
+
 import { IKubeApiParsed, parseKubeApi } from "../kube-api-parse";
 
-interface KubeApiParseTestData {
-  url: string;
-  expected: Required<IKubeApiParsed>;
-}
+/**
+ * [<input-url>, <expected-result>]
+ */
+type KubeApiParseTestData = [string, Required<IKubeApiParsed>];
 
 const tests: KubeApiParseTestData[] = [
-  {
-    url: "/apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/prometheuses.monitoring.coreos.com",
-    expected: {
-      apiBase: "/apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions",
-      apiPrefix: "/apis",
-      apiGroup: "apiextensions.k8s.io",
-      apiVersion: "v1beta1",
-      apiVersionWithGroup: "apiextensions.k8s.io/v1beta1",
-      namespace: undefined,
-      resource: "customresourcedefinitions",
-      name: "prometheuses.monitoring.coreos.com"
-    },
-  },
-  {
-    url: "/api/v1/namespaces/kube-system/pods/coredns-6955765f44-v8p27",
-    expected: {
-      apiBase: "/api/v1/pods",
-      apiPrefix: "/api",
-      apiGroup: "",
-      apiVersion: "v1",
-      apiVersionWithGroup: "v1",
-      namespace: "kube-system",
-      resource: "pods",
-      name: "coredns-6955765f44-v8p27"
-    },
-  },
-  {
-    url: "/apis/stable.example.com/foo1/crontabs",
-    expected: {
-      apiBase: "/apis/stable.example.com/foo1/crontabs",
-      apiPrefix: "/apis",
-      apiGroup: "stable.example.com",
-      apiVersion: "foo1",
-      apiVersionWithGroup: "stable.example.com/foo1",
-      resource: "crontabs",
-      name: undefined,
-      namespace: undefined,
-    },
-  },
-  {
-    url: "/apis/cluster.k8s.io/v1alpha1/clusters",
-    expected: {
-      apiBase: "/apis/cluster.k8s.io/v1alpha1/clusters",
-      apiPrefix: "/apis",
-      apiGroup: "cluster.k8s.io",
-      apiVersion: "v1alpha1",
-      apiVersionWithGroup: "cluster.k8s.io/v1alpha1",
-      resource: "clusters",
-      name: undefined,
-      namespace: undefined,
-    },
-  },
-  {
-    url: "/api/v1/namespaces",
-    expected: {
-      apiBase: "/api/v1/namespaces",
-      apiPrefix: "/api",
-      apiGroup: "",
-      apiVersion: "v1",
-      apiVersionWithGroup: "v1",
-      resource: "namespaces",
-      name: undefined,
-      namespace: undefined,
-    },
-  },
-  {
-    url: "/api/v1/secrets",
-    expected: {
-      apiBase: "/api/v1/secrets",
-      apiPrefix: "/api",
-      apiGroup: "",
-      apiVersion: "v1",
-      apiVersionWithGroup: "v1",
-      resource: "secrets",
-      name: undefined,
-      namespace: undefined,
-    },
-  },
-  {
-    url: "/api/v1/nodes/minikube",
-    expected: {
-      apiBase: "/api/v1/nodes",
-      apiPrefix: "/api",
-      apiGroup: "",
-      apiVersion: "v1",
-      apiVersionWithGroup: "v1",
-      resource: "nodes",
-      name: "minikube",
-      namespace: undefined,
-    },
-  },
-  {
-    url: "/api/foo-bar/nodes/minikube",
-    expected: {
-      apiBase: "/api/foo-bar/nodes",
-      apiPrefix: "/api",
-      apiGroup: "",
-      apiVersion: "foo-bar",
-      apiVersionWithGroup: "foo-bar",
-      resource: "nodes",
-      name: "minikube",
-      namespace: undefined,
-    },
-  },
-  {
-    url: "/api/v1/namespaces/kube-public",
-    expected: {
-      apiBase: "/api/v1/namespaces",
-      apiPrefix: "/api",
-      apiGroup: "",
-      apiVersion: "v1",
-      apiVersionWithGroup: "v1",
-      resource: "namespaces",
-      name: "kube-public",
-      namespace: undefined,
-    },
-  },
+  ["/apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/prometheuses.monitoring.coreos.com", {
+    apiBase: "/apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions",
+    apiPrefix: "/apis",
+    apiGroup: "apiextensions.k8s.io",
+    apiVersion: "v1beta1",
+    apiVersionWithGroup: "apiextensions.k8s.io/v1beta1",
+    namespace: undefined,
+    resource: "customresourcedefinitions",
+    name: "prometheuses.monitoring.coreos.com"
+  }],
+  ["/api/v1/namespaces/kube-system/pods/coredns-6955765f44-v8p27", {
+    apiBase: "/api/v1/pods",
+    apiPrefix: "/api",
+    apiGroup: "",
+    apiVersion: "v1",
+    apiVersionWithGroup: "v1",
+    namespace: "kube-system",
+    resource: "pods",
+    name: "coredns-6955765f44-v8p27"
+  }],
+  ["/apis/stable.example.com/foo1/crontabs", {
+    apiBase: "/apis/stable.example.com/foo1/crontabs",
+    apiPrefix: "/apis",
+    apiGroup: "stable.example.com",
+    apiVersion: "foo1",
+    apiVersionWithGroup: "stable.example.com/foo1",
+    resource: "crontabs",
+    name: undefined,
+    namespace: undefined,
+  }],
+  ["/apis/cluster.k8s.io/v1alpha1/clusters", {
+    apiBase: "/apis/cluster.k8s.io/v1alpha1/clusters",
+    apiPrefix: "/apis",
+    apiGroup: "cluster.k8s.io",
+    apiVersion: "v1alpha1",
+    apiVersionWithGroup: "cluster.k8s.io/v1alpha1",
+    resource: "clusters",
+    name: undefined,
+    namespace: undefined,
+  }],
+  ["/api/v1/namespaces", {
+    apiBase: "/api/v1/namespaces",
+    apiPrefix: "/api",
+    apiGroup: "",
+    apiVersion: "v1",
+    apiVersionWithGroup: "v1",
+    resource: "namespaces",
+    name: undefined,
+    namespace: undefined,
+  }],
+  ["/api/v1/secrets", {
+    apiBase: "/api/v1/secrets",
+    apiPrefix: "/api",
+    apiGroup: "",
+    apiVersion: "v1",
+    apiVersionWithGroup: "v1",
+    resource: "secrets",
+    name: undefined,
+    namespace: undefined,
+  }],
+  ["/api/v1/nodes/minikube", {
+    apiBase: "/api/v1/nodes",
+    apiPrefix: "/api",
+    apiGroup: "",
+    apiVersion: "v1",
+    apiVersionWithGroup: "v1",
+    resource: "nodes",
+    name: "minikube",
+    namespace: undefined,
+  }],
+  ["/api/foo-bar/nodes/minikube", {
+    apiBase: "/api/foo-bar/nodes",
+    apiPrefix: "/api",
+    apiGroup: "",
+    apiVersion: "foo-bar",
+    apiVersionWithGroup: "foo-bar",
+    resource: "nodes",
+    name: "minikube",
+    namespace: undefined,
+  }],
+  ["/api/v1/namespaces/kube-public", {
+    apiBase: "/api/v1/namespaces",
+    apiPrefix: "/api",
+    apiGroup: "",
+    apiVersion: "v1",
+    apiVersionWithGroup: "v1",
+    resource: "namespaces",
+    name: "kube-public",
+    namespace: undefined,
+  }],
 ];
 
 describe("parseApi unit tests", () => {
-  for (const { url, expected } of tests) {
-    test(`testing "${url}"`, () => {
-      expect(parseKubeApi(url)).toStrictEqual(expected);
-    });
-  }
+  it.each(tests)("testing %s", (url, expected) => {
+    expect(parseKubeApi(url)).toStrictEqual(expected);
+  });
 });

src/renderer/components/+workloads-pods/__tests__/pod-tolerations.test.tsx

@@ -1,7 +1,3 @@
-/**
- * @jest-environment jsdom
- */
-
 import React from "react";
 import "@testing-library/jest-dom/extend-expect";
 import { fireEvent, render } from "@testing-library/react";

src/renderer/components/dock/__test__/log-resource-selector.test.tsx

@@ -1,7 +1,3 @@
-/**
- * @jest-environment jsdom
- */
-
 import React from "react";
 import "@testing-library/jest-dom/extend-expect";
 import { render } from "@testing-library/react";

src/renderer/components/dock/__test__/log-tab.store.test.ts

@@ -1,7 +1,3 @@
-/**
- * @jest-environment jsdom
- */
-
 import { podsStore } from "../../+workloads-pods/pods.store";
 import { Pod } from "../../../api/endpoints";
 import { dockStore } from "../dock.store";