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
@@ -18,6 +18,10 @@ import type { DiRender } from "../../test-utils/renderFor";
 import { renderFor } from "../../test-utils/renderFor";
 import directoryForUserDataInjectable
  from "../../../../common/app-paths/directory-for-user-data/directory-for-user-data.injectable";
+import getConfigurationFileModelInjectable
+  from "../../../../common/get-configuration-file-model/get-configuration-file-model.injectable";
+import appVersionInjectable
+  from "../../../../common/get-configuration-file-model/app-version/app-version.injectable";

 jest.mock("electron", () => ({
  app: {
@@ -73,7 +77,6 @@ describe("<DockTabs />", () => {
  beforeEach(async () => {
    const di = getDiForUnitTesting({ doGeneralOverrides: true });

-
    render = renderFor(di);

    di.override(
@@ -81,6 +84,9 @@ describe("<DockTabs />", () => {
      () => "some-test-suite-specific-directory-for-user-data",
    );

+    di.permitSideEffects(getConfigurationFileModelInjectable);
+    di.permitSideEffects(appVersionInjectable);
+
    await di.runSetups();

    dockStore = di.inject(dockStoreInjectable);
@@ -9,14 +9,16 @@ import "../../../../common/vars";
 import readFileInjectable from "../../../../common/fs/read-file.injectable";
 import readDirInjectable from "../../../../common/fs/read-dir.injectable";
 import type { RawTemplates } from "./create-resource-templates.injectable";
+import getAbsolutePathInjectable, { GetAbsolutePath } from "../../../../common/path/get-absolute-path.injectable";

 interface Dependencies {
  readDir: (dirPath: string) => Promise<string[]>;
-  readFile: (filePath: string, encoding: "utf-8") => Promise<string>;
+  readFile: (filePath: string) => Promise<string>;
+  getAbsolutePath: GetAbsolutePath;
 }

-async function getTemplates({ readDir, readFile }: Dependencies) {
-  const templatesFolder = path.resolve(__static, "../templates/create-resource");
+async function getTemplates({ readDir, readFile, getAbsolutePath }: Dependencies) {
+  const templatesFolder = getAbsolutePath(__static, "../templates/create-resource");

  /**
   * Mapping between file names and their contents
@@ -25,7 +27,7 @@ async function getTemplates({ readDir, readFile }: Dependencies) {

  for (const dirEntry of await readDir(templatesFolder)) {
    if (hasCorrectExtension(dirEntry)) {
-      templates.push([path.parse(dirEntry).name, await readFile(path.join(templatesFolder, dirEntry), "utf-8")]);
+      templates.push([path.parse(dirEntry).name, await readFile(path.join(templatesFolder, dirEntry))]);
    }
  }

@@ -39,6 +41,7 @@ const lensCreateResourceTemplatesInjectable = getInjectable({
    const templates = await getTemplates({
      readFile: di.inject(readFileInjectable),
      readDir: di.inject(readDirInjectable),
+      getAbsolutePath: di.inject(getAbsolutePathInjectable),
    });

    return ["lens", templates];
@@ -106,6 +106,7 @@ class NonInjectedCreateResource extends React.Component<CreateResourceProps & De
    return (
      <div className="flex gaps align-center">
        <Select
+          id="create-resource-resource-templates-input"
          autoConvertOptions={false}
          controlShouldRenderValue={false} // always keep initial placeholder
          className="TemplateSelect"
@@ -21,14 +21,14 @@ import { LogsDialog } from "../../dialog/logs-dialog";
 import { Select, SelectOption } from "../../select";
 import { Input } from "../../input";
 import { EditorPanel } from "../editor-panel";
-import { navigate } from "../../../navigation";
-import { releaseURL } from "../../../../common/routes";
 import type { IReleaseCreatePayload, IReleaseUpdateDetails } from "../../../../common/k8s-api/endpoints/helm-releases.api";
 import { withInjectables } from "@ogre-tools/injectable-react";
 import installChartTabStoreInjectable from "./store.injectable";
 import dockStoreInjectable from "../dock/store.injectable";
 import createReleaseInjectable from "../../+helm-releases/create-release/create-release.injectable";
 import { Notifications } from "../../notifications";
+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";

 export interface InstallCharProps {
  tab: DockTab;
@@ -38,6 +38,7 @@ interface Dependencies {
  createRelease: (payload: IReleaseCreatePayload) => Promise<IReleaseUpdateDetails>;
  installChartStore: InstallChartTabStore;
  dockStore: DockStore;
+  navigateToHelmReleases: NavigateToHelmReleases;
 }

@observer
@@ -74,12 +75,11 @@ class NonInjectedInstallChart extends Component<InstallCharProps & Dependencies>
  viewRelease = () => {
    const { release } = this.releaseDetails;

-    navigate(releaseURL({
-      params: {
-        name: release.name,
-        namespace: release.namespace,
-      },
-    }));
+    this.props.navigateToHelmReleases({
+      name: release.name,
+      namespace: release.namespace,
+    });
+
    this.props.dockStore.closeTab(this.tabId);
  };

@@ -171,6 +171,7 @@ class NonInjectedInstallChart extends Component<InstallCharProps & Dependencies>
        <Badge label={`${repo}/${name}`} title="Repo/Name"/>
        <span>Version</span>
        <Select
+          id="chart-version-input"
          className="chart-version"
          value={version}
          options={versions}
@@ -180,6 +181,7 @@ class NonInjectedInstallChart extends Component<InstallCharProps & Dependencies>
        />
        <span>Namespace</span>
        <NamespaceSelect
+          id="install-chart-namespace-select-input"
          showIcons={false}
          menuPlacement="top"
          themeName="outlined"
@@ -226,6 +228,7 @@ export const InstallChart = withInjectables<Dependencies, InstallCharProps>(
      createRelease: di.inject(createReleaseInjectable),
      installChartStore: di.inject(installChartTabStoreInjectable),
      dockStore: di.inject(dockStoreInjectable),
+      navigateToHelmReleases: di.inject(navigateToHelmReleasesInjectable),
      ...props,
    }),
  },
@@ -21,6 +21,10 @@ import { LogTabViewModel, LogTabViewModelDependencies } from "../logs-view-model
 import type { TabId } from "../../dock/store";
 import userEvent from "@testing-library/user-event";
 import { SearchStore } from "../../../../search-store/search-store";
+import getConfigurationFileModelInjectable
+  from "../../../../../common/get-configuration-file-model/get-configuration-file-model.injectable";
+import appVersionInjectable
+  from "../../../../../common/get-configuration-file-model/app-version/app-version.injectable";

 jest.mock("electron", () => ({
  app: {
@@ -131,6 +135,9 @@ describe("<LogResourceSelector />", () => {
    di.override(directoryForUserDataInjectable, () => "some-directory-for-user-data");
    di.override(callForLogsInjectable, () => () => Promise.resolve("some-logs"));

+    di.permitSideEffects(getConfigurationFileModelInjectable);
+    di.permitSideEffects(appVersionInjectable);
+
    render = renderFor(di);

    await di.runSetups();
@@ -83,6 +83,7 @@ export const LogResourceSelector = observer(({ model }: LogResourceSelectorProps
      }
      <span>Pod</span>
      <Select
+        id="pod-selection-input"
        options={podSelectOptions}
        value={podSelectOptions.find(opt => opt.value === pod)}
        formatOptionLabel={option => option.label}
@@ -93,6 +94,7 @@ export const LogResourceSelector = observer(({ model }: LogResourceSelectorProps
      />
      <span>Container</span>
      <Select
+        id="container-selector-input"
        options={containerSelectOptions}
        value={{ label: selectedContainer, value: selectedContainer }}
        onChange={onContainerChange}
@@ -57,9 +57,9 @@ const NonInjectedLogsDockTab = observer(({ className, tab, model, subscribeStore
    setTimeout(() => {
      const overlay = document.querySelector(".PodLogs .list span.active");

-      if (typeof overlay?.scrollIntoViewIfNeeded === "function") {
-        overlay.scrollIntoViewIfNeeded();
-      }
+      if (!overlay) return;
+      // Note: .scrollIntoViewIfNeeded() is non-standard and thus not present in js-dom.
+      overlay?.scrollIntoViewIfNeeded?.();
    }, 100);
  };

@@ -147,6 +147,7 @@ export class NonInjectedUpgradeChart extends React.Component<UpgradeChartProps &
        <span>Version</span> <Badge label={currentVersion}/>
        <span>Upgrade version</span>
        <Select
+          id="char-version-input"
          className="chart-version"
          menuPlacement="top"
          themeName="outlined"