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>
2025-05-20 05:10:56 +00:00 · 2022-03-31 16:57:05 +03:00
1 parent ab2cd27a27
commit a277cfcf02
@@ -0,0 +1,22 @@
+/**
+ * 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 { PersistentVolumes } from "./volumes";
+
+import persistentVolumesRouteInjectable from "../../../common/front-end-routing/routes/cluster/storage/persistent-volumes/persistent-volumes-route.injectable";
+import { routeSpecificComponentInjectionToken } from "../../routes/route-specific-component-injection-token";
+
+const persistentVolumesRouteComponentInjectable = getInjectable({
+  id: "persistent-volumes-route-component",
+
+  instantiate: (di) => ({
+    route: di.inject(persistentVolumesRouteInjectable),
+    Component: PersistentVolumes,
+  }),
+
+  injectionToken: routeSpecificComponentInjectionToken,
+});
+
+export default persistentVolumesRouteComponentInjectable;
@@ -0,0 +1,38 @@
+/**
+ * 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 persistentVolumesRouteInjectable from "../../../common/front-end-routing/routes/cluster/storage/persistent-volumes/persistent-volumes-route.injectable";
+import { storageSidebarItemId } from "../+storage/storage-sidebar-items.injectable";
+import { sidebarItemsInjectionToken } from "../layout/sidebar-items.injectable";
+import routeIsActiveInjectable from "../../routes/route-is-active.injectable";
+import navigateToPersistentVolumesInjectable from "../../../common/front-end-routing/routes/cluster/storage/persistent-volumes/navigate-to-persistent-volumes.injectable";
+
+const persistentVolumesSidebarItemsInjectable = getInjectable({
+  id: "persistent-volumes-sidebar-items",
+
+  instantiate: (di) => {
+    const route = di.inject(persistentVolumesRouteInjectable);
+    const navigateToPersistentVolumes = di.inject(navigateToPersistentVolumesInjectable);
+    const routeIsActive = di.inject(routeIsActiveInjectable, route);
+
+    return computed(() => [
+      {
+        id: "persistent-volumes",
+        parentId: storageSidebarItemId,
+        title: "Persistent Volumes",
+        onClick: navigateToPersistentVolumes,
+        isActive: routeIsActive,
+        isVisible: route.isEnabled,
+        orderNumber: 20,
+      },
+    ]);
+  },
+
+  injectionToken: sidebarItemsInjectionToken,
+});
+
+export default persistentVolumesSidebarItemsInjectable;
@@ -7,14 +7,14 @@ import "./volumes.scss";

 import React from "react";
 import { observer } from "mobx-react";
-import { Link, RouteComponentProps } from "react-router-dom";
+import { Link } from "react-router-dom";
 import { KubeObjectListLayout } from "../kube-object-list-layout";
 import { getDetailsUrl } from "../kube-detail-params";
 import { stopPropagation } from "../../utils";
 import { volumesStore } from "./volumes.store";
 import { pvcApi, storageClassApi } from "../../../common/k8s-api/endpoints";
 import { KubeObjectStatusIcon } from "../kube-object-status-icon";
-import type { VolumesRouteParams } from "../../../common/routes";
+import { SiblingsInTabLayout } from "../layout/siblings-in-tab-layout";
 import { KubeObjectAge } from "../kube-object/age";

 enum columnId {
@@ -26,62 +26,61 @@ enum columnId {
  age = "age",
 }

-export interface PersistentVolumesProps extends RouteComponentProps<VolumesRouteParams> {
-}
-
@observer
-export class PersistentVolumes extends React.Component<PersistentVolumesProps> {
+export class PersistentVolumes extends React.Component {
  render() {
    return (
-      <KubeObjectListLayout
-        isConfigurable
-        tableId="storage_volumes"
-        className="PersistentVolumes"
-        store={volumesStore}
-        sortingCallbacks={{
-          [columnId.name]: volume => volume.getName(),
-          [columnId.storageClass]: volume => volume.getStorageClass(),
-          [columnId.capacity]: volume => volume.getCapacity(true),
-          [columnId.status]: volume => volume.getStatus(),
-          [columnId.age]: volume => -volume.getCreationTimestamp(),
-        }}
-        searchFilters={[
-          volume => volume.getSearchFields(),
-          volume => volume.getClaimRefName(),
-        ]}
-        renderHeaderTitle="Persistent Volumes"
-        renderTableHeader={[
-          { title: "Name", className: "name", sortBy: columnId.name, id: columnId.name },
-          { className: "warning", showWithColumn: columnId.name },
-          { title: "Storage Class", className: "storageClass", sortBy: columnId.storageClass, id: columnId.storageClass },
-          { title: "Capacity", className: "capacity", sortBy: columnId.capacity, id: columnId.capacity },
-          { title: "Claim", className: "claim", id: columnId.claim },
-          { title: "Age", className: "age", sortBy: columnId.age, id: columnId.age },
-          { title: "Status", className: "status", sortBy: columnId.status, id: columnId.status },
-        ]}
-        renderTableContents={volume => {
-          const { claimRef, storageClassName } = volume.spec;
-          const storageClassDetailsUrl = getDetailsUrl(storageClassApi.getUrl({
-            name: storageClassName,
-          }));
+      <SiblingsInTabLayout>
+        <KubeObjectListLayout
+          isConfigurable
+          tableId="storage_volumes"
+          className="PersistentVolumes"
+          store={volumesStore}
+          sortingCallbacks={{
+            [columnId.name]: volume => volume.getName(),
+            [columnId.storageClass]: volume => volume.getStorageClass(),
+            [columnId.capacity]: volume => volume.getCapacity(true),
+            [columnId.status]: volume => volume.getStatus(),
+            [columnId.age]: volume => -volume.getCreationTimestamp(),
+          }}
+          searchFilters={[
+            volume => volume.getSearchFields(),
+            volume => volume.getClaimRefName(),
+          ]}
+          renderHeaderTitle="Persistent Volumes"
+          renderTableHeader={[
+            { title: "Name", className: "name", sortBy: columnId.name, id: columnId.name },
+            { className: "warning", showWithColumn: columnId.name },
+            { title: "Storage Class", className: "storageClass", sortBy: columnId.storageClass, id: columnId.storageClass },
+            { title: "Capacity", className: "capacity", sortBy: columnId.capacity, id: columnId.capacity },
+            { title: "Claim", className: "claim", id: columnId.claim },
+            { title: "Age", className: "age", sortBy: columnId.age, id: columnId.age },
+            { title: "Status", className: "status", sortBy: columnId.status, id: columnId.status },
+          ]}
+          renderTableContents={volume => {
+            const { claimRef, storageClassName } = volume.spec;
+            const storageClassDetailsUrl = getDetailsUrl(storageClassApi.getUrl({
+              name: storageClassName,
+            }));

-          return [
-            volume.getName(),
-            <KubeObjectStatusIcon key="icon" object={volume} />,
-            <Link key="link" to={storageClassDetailsUrl} onClick={stopPropagation}>
-              {storageClassName}
-            </Link>,
-            volume.getCapacity(),
-            claimRef && (
-              <Link to={getDetailsUrl(pvcApi.getUrl(claimRef))} onClick={stopPropagation}>
-                {claimRef.name}
-              </Link>
-            ),
-            <KubeObjectAge key="age" object={volume} />,
-            { title: volume.getStatus(), className: volume.getStatus().toLowerCase() },
-          ];
-        }}
-      />
+            return [
+              volume.getName(),
+              <KubeObjectStatusIcon key="icon" object={volume} />,
+              <Link key="link" to={storageClassDetailsUrl} onClick={stopPropagation}>
+                {storageClassName}
+              </Link>,
+              volume.getCapacity(),
+              claimRef && (
+                <Link to={getDetailsUrl(pvcApi.getUrl(claimRef))} onClick={stopPropagation}>
+                  {claimRef.name}
+                </Link>
+              ),
+              <KubeObjectAge key="age" object={volume} />,
+              { title: volume.getStatus(), className: volume.getStatus().toLowerCase() },
+            ];
+          }}
+        />
+      </SiblingsInTabLayout>
    );
  }
 }