Technical requirements for behavioural unit tests (#5084)

* Implement a lot of technical requirements for behavioural unit tests

Note: the crux of this was to make routing env-agnostic, and not based on URLs as magic strings, but instead something type-enforced.

Note: extension-based routes comply to same exact interface by "late-registering" their routes when installed. Routes are just injectables.

Note: another chunk of global shared state is no more.

Note: a lot of explicit side effects have been cornered to injectables.

Note: a lot of stuff has become reactive as part if this.

Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com>

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Make a directory commonly available

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Require id for <Select /> to prevent non-deterministic renders

This was caused by global state in a 3rd party lib: "react-select".

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Specify id for all <Select /> to satisfy previous commit

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Prevent explicit side effect in component by using existing dependency instead

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Extract instantiation of "conf" as injectables for causing side effects

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Introduce a legacy-helper to make gradual refactoring of inheritors of Singleton easier

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Make legacy unit tests for hotbar green and more simple by using the new legacy helper

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Temporarily kludge all unit tests green with a disclaimer about allowing side-effects

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Remove kludge in previous commit by explicitly permitting specific side effects where old unit tests require it

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Prevent old unit test with side effects from accessing file system

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Migrate to actual typing for di.permitSideEffects

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Prevent unit tests from failing because of non-standard method of HTML-element not present in js-dom

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Adapt integration tests to recent changes

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Fix code style

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Fix artifact from bad rebase

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Add a deprecation from a review comment

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Remove change that is not required

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Remove redundant comment

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Fix code style

Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com>

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Remove redundant file

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Fix bad merge

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Improve variable name

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Tweak logger interface to be more descriptive

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Make injecting legacy singleton always provide new instance

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Remove conditional typing when not needed

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Improve naming of variable

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Remove unnecessary code style changes

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Remove flag for causing side effects from too broad scope

Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com>

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Override side-effects in unit test using injectable instead of monkey patching

Co-authored-by: Janne Savolainen <janne.savolainen@live.fi>

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Flag some side-effects and add general overrides

Co-authored-by: Janne Savolainen <janne.savolainen@live.fi>

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Fix unit tests in CI by removing explicit side-effect

Co-authored-by: Janne Savolainen <janne.savolainen@live.fi>

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Remove explicit side-effect from getting default shell

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Introduce abstraction for getting absolute paths

Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com>

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Switch to using abstraction for getting absolute path to control explicit side effect

Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com>

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Introduce abstraction for joining paths

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Switch to using abstraction for joining paths to control explicit side effect

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Fix fake implementation for join paths

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Fix test after removing explicit side effect

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Remove explicit side effects from kubeconfig-syncs

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Fix arguments after removing explicit side effect

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Make registrators not async for not being needed anymore

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Make generalCatalogEntities non-observable, as there is no requirement

Co-authored-by: Janne Savolainen <janne.savolainen@live.fi>

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Remove redundant code

Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com>

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>

* Simplify logic for registering general catalog entity sources

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Add TODO

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Replace function for getting application menu items with reactive solution

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Fix typo in interface name

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Remove global shared state usages of hot bar store

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

* Remove redundant enum

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

Co-authored-by: Janne Savolainen <janne.savolainen@live.fi>

src/renderer/components/+config/config-sidebar-items.injectable.tsx

@@ -0,0 +1,35 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectable } from "@ogre-tools/injectable";
+import { Icon } from "../icon";
+import React from "react";
+import {
+  SidebarItemRegistration,
+  sidebarItemsInjectionToken,
+} from "../layout/sidebar-items.injectable";
+import { computed } from "mobx";
+import { noop } from "lodash/fp";
+
+export const configSidebarItemId = "config";
+
+const configSidebarItemsInjectable = getInjectable({
+  id: "config-sidebar-items",
+
+  instantiate: () =>
+    computed((): SidebarItemRegistration[] => [
+      {
+        id: configSidebarItemId,
+        parentId: null,
+        title: "Config",
+        getIcon: () => <Icon material="list" />,
+        onClick: noop,
+        orderNumber: 40,
+      },
+    ]),
+
+  injectionToken: sidebarItemsInjectionToken,
+});
+
+export default configSidebarItemsInjectable;

src/renderer/components/+config/route-tabs.injectable.ts

@@ -1,91 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-import { getInjectable } from "@ogre-tools/injectable";
-import { computed } from "mobx";
-import { HorizontalPodAutoscalers } from "../+config-autoscalers";
-import { LimitRanges } from "../+config-limit-ranges";
-import { ConfigMaps } from "../+config-maps";
-import { PodDisruptionBudgets } from "../+config-pod-disruption-budgets";
-import { ResourceQuotas } from "../+config-resource-quotas";
-import { Secrets } from "../+config-secrets";
-import isAllowedResourceInjectable, { IsAllowedResource } from "../../../common/utils/is-allowed-resource.injectable";
-import type { TabLayoutRoute } from "../layout/tab-layout";
-import * as routes from "../../../common/routes";
-
-interface Dependencies {
-  isAllowedResource: IsAllowedResource;
-}
-
-function getRouteTabs({ isAllowedResource }: Dependencies) {
-  return computed(() => {
-    const tabs: TabLayoutRoute[] = [];
-
-    if (isAllowedResource("configmaps")) {
-      tabs.push({
-        title: "ConfigMaps",
-        component: ConfigMaps,
-        url: routes.configMapsURL(),
-        routePath: routes.configMapsRoute.path.toString(),
-      });
-    }
-
-    if (isAllowedResource("secrets")) {
-      tabs.push({
-        title: "Secrets",
-        component: Secrets,
-        url: routes.secretsURL(),
-        routePath: routes.secretsRoute.path.toString(),
-      });
-    }
-
-    if (isAllowedResource("resourcequotas")) {
-      tabs.push({
-        title: "Resource Quotas",
-        component: ResourceQuotas,
-        url: routes.resourceQuotaURL(),
-        routePath: routes.resourceQuotaRoute.path.toString(),
-      });
-    }
-
-    if (isAllowedResource("limitranges")) {
-      tabs.push({
-        title: "Limit Ranges",
-        component: LimitRanges,
-        url: routes.limitRangeURL(),
-        routePath: routes.limitRangesRoute.path.toString(),
-      });
-    }
-
-    if (isAllowedResource("horizontalpodautoscalers")) {
-      tabs.push({
-        title: "HPA",
-        component: HorizontalPodAutoscalers,
-        url: routes.hpaURL(),
-        routePath: routes.hpaRoute.path.toString(),
-      });
-    }
-
-    if (isAllowedResource("poddisruptionbudgets")) {
-      tabs.push({
-        title: "Pod Disruption Budgets",
-        component: PodDisruptionBudgets,
-        url: routes.pdbURL(),
-        routePath: routes.pdbRoute.path.toString(),
-      });
-    }
-
-    return tabs;
-  });
-}
-
-const configRoutesInjectable = getInjectable({
-  id: "config-routes",
-
-  instantiate: (di) => getRouteTabs({
-    isAllowedResource: di.inject(isAllowedResourceInjectable),
-  }),
-});
-
-export default configRoutesInjectable;

src/renderer/components/+config/route.tsx

@@ -1,31 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-
-import React from "react";
-import { observer } from "mobx-react";
-import { TabLayout, TabLayoutRoute } from "../layout/tab-layout";
-import type { IComputedValue } from "mobx";
-import { withInjectables } from "@ogre-tools/injectable-react";
-import configRoutesInjectable from "./route-tabs.injectable";
-
-export interface ConfigRouteProps {}
-
-interface Dependencies {
-  routes: IComputedValue<TabLayoutRoute[]>;
-}
-
-const NonInjectedConfigRoute = observer(({ routes }: Dependencies & ConfigRouteProps) => (
-  <TabLayout
-    className="Config"
-    tabs={routes.get()}
-  />
-));
-
-export const ConfigRoute = withInjectables<Dependencies, ConfigRouteProps>(NonInjectedConfigRoute, {
-  getProps: (di, props) => ({
-    routes: di.inject(configRoutesInjectable),
-    ...props,
-  }),
-});

src/renderer/components/+config/sidebar-item.tsx

@@ -1,45 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-import { withInjectables } from "@ogre-tools/injectable-react";
-import type { IComputedValue } from "mobx";
-import { observer } from "mobx-react";
-import React from "react";
-import { configRoute, configURL } from "../../../common/routes";
-import { isActiveRoute } from "../../navigation";
-import { Icon } from "../icon";
-import { SidebarItem } from "../layout/sidebar-item";
-import type { TabLayoutRoute } from "../layout/tab-layout";
-import { renderTabRoutesSidebarItems } from "../layout/tab-routes-sidebar-items";
-import configRoutesInjectable from "./route-tabs.injectable";
-
-export interface ConfigSidebarItemProps {}
-
-interface Dependencies {
-  routes: IComputedValue<TabLayoutRoute[]>;
-}
-
-const NonInjectedConfigSidebarItem = observer(({ routes }: Dependencies & ConfigSidebarItemProps) => {
-  const tabRoutes = routes.get();
-
-  return (
-    <SidebarItem
-      id="config"
-      text="Configuration"
-      isActive={isActiveRoute(configRoute)}
-      isHidden={tabRoutes.length == 0}
-      url={configURL()}
-      icon={<Icon material="list"/>}
-    >
-      {renderTabRoutesSidebarItems(tabRoutes)}
-    </SidebarItem>
-  );
-});
-
-export const ConfigSidebarItem = withInjectables<Dependencies, ConfigSidebarItemProps>(NonInjectedConfigSidebarItem, {
-  getProps: (di, props) => ({
-    routes: di.inject(configRoutesInjectable),
-    ...props,
-  }),
-});