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
@@ -13,17 +13,14 @@ import { cssNames } from "../../utils";
 import { Notifications } from "../notifications";
 import { Button } from "../button";
 import type { ForwardedPort } from "../../port-forward";
-import {
-  aboutPortForwarding,
-  notifyErrorPortForwarding, openPortForward,
-  PortForwardStore,
-  predictProtocol,
-} from "../../port-forward";
+import { openPortForward, PortForwardStore, predictProtocol } from "../../port-forward";
 import { Spinner } from "../spinner";
 import { withInjectables } from "@ogre-tools/injectable-react";
 import portForwardStoreInjectable from "../../port-forward/port-forward-store/port-forward-store.injectable";
 import portForwardDialogModelInjectable from "../../port-forward/port-forward-dialog-model/port-forward-dialog-model.injectable";
 import logger from "../../../common/logger";
+import aboutPortForwardingInjectable from "../../port-forward/about-port-forwarding.injectable";
+import notifyErrorPortForwardingInjectable from "../../port-forward/notify-error-port-forwarding.injectable";

 export interface ServicePortComponentProps {
  service: Service;
@@ -33,6 +30,8 @@ export interface ServicePortComponentProps {
 interface Dependencies {
  portForwardStore: PortForwardStore;
  openPortForwardDialog: (item: ForwardedPort, options: { openInBrowser: boolean; onClose: () => void }) => void;
+  aboutPortForwarding: () => void;
+  notifyErrorPortForwarding: (message: string) => void;
 }

@observer
@@ -115,10 +114,10 @@ class NonInjectedServicePortComponent extends React.Component<ServicePortCompone

        // if this is the first port-forward show the about notification
        if (!length) {
-          aboutPortForwarding();
+          this.props.aboutPortForwarding();
        }
      } else {
-        notifyErrorPortForwarding(`Error occurred starting port-forward, the local port may not be available or the ${portForward.kind} ${portForward.name} may not be reachable`);
+        this.props.notifyErrorPortForwarding(`Error occurred starting port-forward, the local port may not be available or the ${portForward.kind} ${portForward.name} may not be reachable`);
      }
    } catch (error) {
      logger.error("[SERVICE-PORT-COMPONENT]:", error, portForward);
@@ -193,6 +192,8 @@ export const ServicePortComponent = withInjectables<Dependencies, ServicePortCom
    getProps: (di, props) => ({
      portForwardStore: di.inject(portForwardStoreInjectable),
      openPortForwardDialog: di.inject(portForwardDialogModelInjectable).open,
+      aboutPortForwarding: di.inject(aboutPortForwardingInjectable),
+      notifyErrorPortForwarding: di.inject(notifyErrorPortForwardingInjectable),
      ...props,
    }),
  },
@@ -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 { Services } from "./services";
+import servicesRouteInjectable from "../../../common/front-end-routing/routes/cluster/network/services/services-route.injectable";
+import { routeSpecificComponentInjectionToken } from "../../routes/route-specific-component-injection-token";
+
+const servicesRouteComponentInjectable = getInjectable({
+  id: "services-route-component",
+
+  instantiate: (di) => ({
+    route: di.inject(servicesRouteInjectable),
+    Component: Services,
+  }),
+
+  injectionToken: routeSpecificComponentInjectionToken,
+});
+
+export default servicesRouteComponentInjectable;
@@ -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 servicesRouteInjectable from "../../../common/front-end-routing/routes/cluster/network/services/services-route.injectable";
+import { networkSidebarItemId } from "../+network/network-sidebar-items.injectable";
+import { sidebarItemsInjectionToken } from "../layout/sidebar-items.injectable";
+import routeIsActiveInjectable from "../../routes/route-is-active.injectable";
+import navigateToServicesInjectable from "../../../common/front-end-routing/routes/cluster/network/services/navigate-to-services.injectable";
+
+const servicesSidebarItemsInjectable = getInjectable({
+  id: "services-sidebar-items",
+
+  instantiate: (di) => {
+    const route = di.inject(servicesRouteInjectable);
+    const navigateToServices = di.inject(navigateToServicesInjectable);
+    const routeIsActive = di.inject(routeIsActiveInjectable, route);
+
+    return computed(() => [
+      {
+        id: "services",
+        parentId: networkSidebarItemId,
+        title: "Services",
+        onClick: navigateToServices,
+        isActive: routeIsActive,
+        isVisible: route.isEnabled,
+        orderNumber: 10,
+      },
+    ]);
+  },
+
+  injectionToken: sidebarItemsInjectionToken,
+});
+
+export default servicesSidebarItemsInjectable;
@@ -7,12 +7,11 @@ import "./services.scss";

 import React from "react";
 import { observer } from "mobx-react";
-import type { RouteComponentProps } from "react-router";
 import { KubeObjectListLayout } from "../kube-object-list-layout";
 import { Badge } from "../badge";
 import { serviceStore } from "./services.store";
 import { KubeObjectStatusIcon } from "../kube-object-status-icon";
-import type { ServicesRouteParams } from "../../../common/routes";
+import { SiblingsInTabLayout } from "../layout/siblings-in-tab-layout";
 import { KubeObjectAge } from "../kube-object/age";

 enum columnId {
@@ -27,66 +26,65 @@ enum columnId {
  status = "status",
 }

-export interface ServicesProps extends RouteComponentProps<ServicesRouteParams> {
-}
-
@observer
-export class Services extends React.Component<ServicesProps> {
+export class Services extends React.Component {
  render() {
    return (
-      <KubeObjectListLayout
-        isConfigurable
-        tableId="network_services"
-        className="Services" store={serviceStore}
-        sortingCallbacks={{
-          [columnId.name]: service => service.getName(),
-          [columnId.namespace]: service => service.getNs(),
-          [columnId.selector]: service => service.getSelector(),
-          [columnId.ports]: service => (service.spec.ports || []).map(({ port }) => port)[0],
-          [columnId.clusterIp]: service => service.getClusterIp(),
-          [columnId.type]: service => service.getType(),
-          [columnId.age]: service => -service.getCreationTimestamp(),
-          [columnId.status]: service => service.getStatus(),
-        }}
-        searchFilters={[
-          service => service.getSearchFields(),
-          service => service.getSelector().join(" "),
-          service => service.getPorts().join(" "),
-        ]}
-        renderHeaderTitle="Services"
-        renderTableHeader={[
-          { title: "Name", className: "name", sortBy: columnId.name, id: columnId.name },
-          { className: "warning", showWithColumn: columnId.name },
-          { title: "Namespace", className: "namespace", sortBy: columnId.namespace, id: columnId.namespace },
-          { title: "Type", className: "type", sortBy: columnId.type, id: columnId.type },
-          { title: "Cluster IP", className: "clusterIp", sortBy: columnId.clusterIp, id: columnId.clusterIp },
-          { title: "Ports", className: "ports", sortBy: columnId.ports, id: columnId.ports },
-          { title: "External IP", className: "externalIp", id: columnId.externalIp },
-          { title: "Selector", className: "selector", sortBy: columnId.selector, id: columnId.selector },
-          { title: "Age", className: "age", sortBy: columnId.age, id: columnId.age },
-          { title: "Status", className: "status", sortBy: columnId.status, id: columnId.status },
-        ]}
-        renderTableContents={service => {
-          const externalIps = service.getExternalIps();
+      <SiblingsInTabLayout>
+        <KubeObjectListLayout
+          isConfigurable
+          tableId="network_services"
+          className="Services" store={serviceStore}
+          sortingCallbacks={{
+            [columnId.name]: service => service.getName(),
+            [columnId.namespace]: service => service.getNs(),
+            [columnId.selector]: service => service.getSelector(),
+            [columnId.ports]: service => (service.spec.ports || []).map(({ port }) => port)[0],
+            [columnId.clusterIp]: service => service.getClusterIp(),
+            [columnId.type]: service => service.getType(),
+            [columnId.age]: service => -service.getCreationTimestamp(),
+            [columnId.status]: service => service.getStatus(),
+          }}
+          searchFilters={[
+            service => service.getSearchFields(),
+            service => service.getSelector().join(" "),
+            service => service.getPorts().join(" "),
+          ]}
+          renderHeaderTitle="Services"
+          renderTableHeader={[
+            { title: "Name", className: "name", sortBy: columnId.name, id: columnId.name },
+            { className: "warning", showWithColumn: columnId.name },
+            { title: "Namespace", className: "namespace", sortBy: columnId.namespace, id: columnId.namespace },
+            { title: "Type", className: "type", sortBy: columnId.type, id: columnId.type },
+            { title: "Cluster IP", className: "clusterIp", sortBy: columnId.clusterIp, id: columnId.clusterIp },
+            { title: "Ports", className: "ports", sortBy: columnId.ports, id: columnId.ports },
+            { title: "External IP", className: "externalIp", id: columnId.externalIp },
+            { title: "Selector", className: "selector", sortBy: columnId.selector, id: columnId.selector },
+            { title: "Age", className: "age", sortBy: columnId.age, id: columnId.age },
+            { title: "Status", className: "status", sortBy: columnId.status, id: columnId.status },
+          ]}
+          renderTableContents={service => {
+            const externalIps = service.getExternalIps();

-          if (externalIps.length === 0 && service.spec?.externalName) {
-            externalIps.push(service.spec.externalName);
-          }
+            if (externalIps.length === 0 && service.spec?.externalName) {
+              externalIps.push(service.spec.externalName);
+            }

-          return [
-            service.getName(),
-            <KubeObjectStatusIcon key="icon" object={service} />,
-            service.getNs(),
-            service.getType(),
-            service.getClusterIp(),
-            service.getPorts().join(", "),
-            externalIps.join(", ") || "-",
-            service.getSelector().map(label => <Badge key={label} label={label} />),
-            <KubeObjectAge key="age" object={service} />,
-            { title: service.getStatus(), className: service.getStatus().toLowerCase() },
-          ];
-        }}
-      />
+            return [
+              service.getName(),
+              <KubeObjectStatusIcon key="icon" object={service} />,
+              service.getNs(),
+              service.getType(),
+              service.getClusterIp(),
+              service.getPorts().join(", "),
+              externalIps.join(", ") || "-",
+              service.getSelector().map(label => <Badge key={label} label={label} />),
+              <KubeObjectAge key="age" object={service} />,
+              { title: service.getStatus(), className: service.getStatus().toLowerCase() },
+            ];
+          }}
+        />
+      </SiblingsInTabLayout>
    );
  }
 }