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,21 @@
+/**
+ * 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 { HelmReleases } from "./releases";
+import helmReleasesRouteInjectable from "../../../common/front-end-routing/routes/cluster/helm/releases/helm-releases-route.injectable";
+import { routeSpecificComponentInjectionToken } from "../../routes/route-specific-component-injection-token";
+
+const helmReleasesRouteComponentInjectable = getInjectable({
+  id: "helm-releases-route-component",
+
+  instantiate: (di) => ({
+    route: di.inject(helmReleasesRouteInjectable),
+    Component: HelmReleases,
+  }),
+
+  injectionToken: routeSpecificComponentInjectionToken,
+});
+
+export default helmReleasesRouteComponentInjectable;
@@ -0,0 +1,24 @@
+/**
+ * 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 helmReleasesRouteInjectable from "../../../common/front-end-routing/routes/cluster/helm/releases/helm-releases-route.injectable";
+import routePathParametersInjectable from "../../routes/route-path-parameters.injectable";
+
+const helmReleasesRouteParametersInjectable = getInjectable({
+  id: "helm-releases-route-parameters",
+
+  instantiate: (di) => {
+    const route = di.inject(helmReleasesRouteInjectable);
+    const pathParameters = di.inject(routePathParametersInjectable, route);
+
+    return {
+      namespace: computed(() => pathParameters.get().namespace),
+      name: computed(() => pathParameters.get().name),
+    };
+  },
+});
+
+export default helmReleasesRouteParametersInjectable;
@@ -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 helmReleasesRouteInjectable from "../../../common/front-end-routing/routes/cluster/helm/releases/helm-releases-route.injectable";
+import { helmSidebarItemId } from "../+helm/helm-sidebar-items.injectable";
+import { sidebarItemsInjectionToken } from "../layout/sidebar-items.injectable";
+import routeIsActiveInjectable from "../../routes/route-is-active.injectable";
+import navigateToHelmReleasesInjectable from "../../../common/front-end-routing/routes/cluster/helm/releases/navigate-to-helm-releases.injectable";
+
+const helmReleasesSidebarItemsInjectable = getInjectable({
+  id: "helm-releases-sidebar-items",
+
+  instantiate: (di) => {
+    const route = di.inject(helmReleasesRouteInjectable);
+    const navigateToHelmReleases = di.inject(navigateToHelmReleasesInjectable);
+    const routeIsActive = di.inject(routeIsActiveInjectable, route);
+
+    return computed(() => [
+      {
+        id: "releases",
+        parentId: helmSidebarItemId,
+        title: "Releases",
+        onClick: navigateToHelmReleases,
+        isActive: routeIsActive,
+        isVisible: route.isEnabled,
+        orderNumber: 20,
+      },
+    ]);
+  },
+
+  injectionToken: sidebarItemsInjectionToken,
+});
+
+export default helmReleasesSidebarItemsInjectable;
@@ -1,31 +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 { matchPath } from "react-router";
-import observableHistoryInjectable from "../../../navigation/observable-history.injectable";
-import { releaseRoute, ReleaseRouteParams } from "../../../../common/routes";
-
-const releaseRouteParametersInjectable = getInjectable({
-  id: "release-route-parameters",
-
-  instantiate: (di) => {
-    const observableHistory = di.inject(observableHistoryInjectable);
-
-    return computed(() => {
-      const releasePathParameters = matchPath<ReleaseRouteParams>(observableHistory.location.pathname, {
-        path: releaseRoute.path,
-      });
-
-      if (!releasePathParameters) {
-        return {};
-      }
-
-      return releasePathParameters.params;
-    });
-  },
-});
-
-export default releaseRouteParametersInjectable;
@@ -5,18 +5,19 @@
 import { getInjectable } from "@ogre-tools/injectable";
 import { matches } from "lodash/fp";
 import releasesInjectable from "../releases.injectable";
-import releaseRouteParametersInjectable from "./release-route-parameters.injectable";
 import { computed } from "mobx";
+import helmReleasesRouteParametersInjectable from "../helm-releases-route-parameters.injectable";

 const releaseInjectable = getInjectable({
  id: "release",

  instantiate: (di) => {
    const releases = di.inject(releasesInjectable);
-    const releaseRouteParameters = di.inject(releaseRouteParametersInjectable);
+    const routeParameters = di.inject(helmReleasesRouteParametersInjectable);

    return computed(() => {
-      const { name, namespace } = releaseRouteParameters.get();
+      const name = routeParameters.name.get();
+      const namespace = routeParameters.namespace.get();

      if (!name || !namespace) {
        return null;
@@ -75,6 +75,7 @@ class NonInjectedReleaseRollbackDialog extends React.Component<ReleaseRollbackDi
      <div className="flex gaps align-center">
        <b>Revision</b>
        <Select
+          id="revision-input"
          themeName="light"
          value={revision}
          options={revisions}
@@ -7,11 +7,7 @@ import "../item-object-list/item-list-layout.scss";
 import "./releases.scss";

 import React, { Component } from "react";
-import type { RouteComponentProps } from "react-router";
 import type { HelmRelease } from "../../../common/k8s-api/endpoints/helm-releases.api";
-import { navigation } from "../../navigation";
-import type { ReleaseRouteParams } from "../../../common/routes";
-import { releaseURL } from "../../../common/routes";
 import { withInjectables } from "@ogre-tools/injectable-react";
 import namespaceStoreInjectable from "../+namespaces/namespace-store/namespace-store.injectable";
 import { ItemListLayout } from "../item-object-list";
@@ -25,6 +21,10 @@ import removableReleasesInjectable from "./removable-releases.injectable";
 import type { RemovableHelmRelease } from "./removable-releases";
 import type { IComputedValue } from "mobx";
 import releasesInjectable from "./releases.injectable";
+import { SiblingsInTabLayout } from "../layout/siblings-in-tab-layout";
+import helmReleasesRouteParametersInjectable from "./helm-releases-route-parameters.injectable";
+import type { NavigateToHelmReleases } from "../../../common/front-end-routing/routes/cluster/helm/releases/navigate-to-helm-releases.injectable";
+import navigateToHelmReleasesInjectable from "../../../common/front-end-routing/routes/cluster/helm/releases/navigate-to-helm-releases.injectable";

 enum columnId {
  name = "name",
@@ -37,18 +37,18 @@ enum columnId {
  updated = "update",
 }

-export interface HelmReleasesProps extends RouteComponentProps<ReleaseRouteParams> {
-}
-
 interface Dependencies {
  releases: IComputedValue<RemovableHelmRelease[]>;
  releasesArePending: IComputedValue<boolean>;
  selectNamespace: (namespace: string) => void;
+  namespace: IComputedValue<string>;
+  navigateToHelmReleases: NavigateToHelmReleases;
 }

-class NonInjectedHelmReleases extends Component<Dependencies & HelmReleasesProps> {
+class NonInjectedHelmReleases extends Component<Dependencies> {
+  // TODO: This side-effect in mount must go.
  componentDidMount() {
-    const { match: { params: { namespace }}} = this.props;
+    const namespace = this.props.namespace.get();

    if (namespace) {
      this.props.selectNamespace(namespace);
@@ -60,16 +60,14 @@ class NonInjectedHelmReleases extends Component<Dependencies & HelmReleasesProps
  };

  showDetails = (item: HelmRelease) => {
-    navigation.push(releaseURL({
-      params: {
-        name: item.getName(),
-        namespace: item.getNs(),
-      },
-    }));
+    this.props.navigateToHelmReleases({
+      name: item.getName(),
+      namespace: item.getNs(),
+    });
  };

  hideDetails = () => {
-    navigation.push(releaseURL());
+    this.props.navigateToHelmReleases();
  };

  renderRemoveDialogMessage(selectedItems: HelmRelease[]) {
@@ -144,7 +142,7 @@ class NonInjectedHelmReleases extends Component<Dependencies & HelmReleasesProps
    } as ItemStore<RemovableHelmRelease>;

    return (
-      <>
+      <SiblingsInTabLayout>
        <ItemListLayout
          store={legacyReleaseStore}
          getItems={() => legacyReleaseStore.items}
@@ -171,7 +169,7 @@ class NonInjectedHelmReleases extends Component<Dependencies & HelmReleasesProps
            filters: (
              <>
                {filters}
-                <NamespaceSelectFilter />
+                <NamespaceSelectFilter id="namespace-select-filter" />
              </>
            ),
            searchProps: {
@@ -218,20 +216,25 @@ class NonInjectedHelmReleases extends Component<Dependencies & HelmReleasesProps
        />

        <ReleaseRollbackDialog/>
-      </>
+      </SiblingsInTabLayout>
    );
  }
 }

-export const HelmReleases = withInjectables<Dependencies, HelmReleasesProps>(
+export const HelmReleases = withInjectables<Dependencies>(
  NonInjectedHelmReleases,

  {
-    getProps: (di, props) => ({
-      releases: di.inject(removableReleasesInjectable),
-      releasesArePending: di.inject(releasesInjectable).pending,
-      selectNamespace: di.inject(namespaceStoreInjectable).selectNamespaces,
-      ...props,
-    }),
+    getProps: (di) => {
+      const routeParameters = di.inject(helmReleasesRouteParametersInjectable);
+
+      return {
+        releases: di.inject(removableReleasesInjectable),
+        releasesArePending: di.inject(releasesInjectable).pending,
+        selectNamespace: di.inject(namespaceStoreInjectable).selectNamespaces,
+        navigateToHelmReleases: di.inject(navigateToHelmReleasesInjectable),
+        namespace: routeParameters.namespace,
+      };
+    },
  },
 );