1
0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00

Add behavioural tests

Signed-off-by: Sebastian Malton <sebastian@malton.name>
This commit is contained in:
Sebastian Malton 2022-11-17 13:01:39 -05:00
parent e4e0c30da2
commit a0a9fc5e4a
19 changed files with 1372 additions and 77 deletions

View File

@ -0,0 +1,226 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import type { DiContainer } from "@ogre-tools/injectable";
import type { RenderResult } from "@testing-library/react";
import { KubernetesCluster, WebLink } from "../../common/catalog-entities";
import getClusterByIdInjectable from "../../common/cluster-store/get-by-id.injectable";
import type { Cluster } from "../../common/cluster/cluster";
import navigateToEntitySettingsInjectable from "../../common/front-end-routing/routes/entity-settings/navigate-to-entity-settings.injectable";
import catalogEntityRegistryInjectable from "../../renderer/api/catalog/entity/registry.injectable";
import { type ApplicationBuilder, getApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
import createClusterInjectable from "../../renderer/create-cluster/create-cluster.injectable";
describe("Showing correct entity settings", () => {
let builder: ApplicationBuilder;
let rendered: RenderResult;
let windowDi: DiContainer;
let clusterEntity: KubernetesCluster;
let localClusterEntity: KubernetesCluster;
let otherEntity: WebLink;
let cluster: Cluster;
beforeEach(async () => {
builder = getApplicationBuilder();
builder.afterWindowStart((windowDi) => {
const createCluster = windowDi.inject(createClusterInjectable);
clusterEntity = new KubernetesCluster({
metadata: {
labels: {},
name: "some-kubernetes-cluster",
uid: "some-entity-id",
},
spec: {
kubeconfigContext: "some-context",
kubeconfigPath: "/some/path/to/kubeconfig",
},
status: {
phase: "connecting",
},
});
localClusterEntity = new KubernetesCluster({
metadata: {
labels: {},
name: "some-local-kubernetes-cluster",
uid: "some-entity-id-2",
source: "local",
},
spec: {
kubeconfigContext: "some-context",
kubeconfigPath: "/some/path/to/local/kubeconfig",
},
status: {
phase: "connecting",
},
});
otherEntity = new WebLink({
metadata: {
labels: {},
name: "some-weblink",
uid: "some-weblink-id",
},
spec: {
url: "https://my-websome.com",
},
status: {
phase: "available",
},
});
cluster = createCluster({
contextName: clusterEntity.spec.kubeconfigContext,
id: clusterEntity.getId(),
kubeConfigPath: clusterEntity.spec.kubeconfigPath,
}, {
clusterServerUrl: "https://localhost:9999",
});
// TODO: remove once ClusterStore can be used without overriding it
windowDi.override(getClusterByIdInjectable, () => (clusterId) => {
if (clusterId === cluster.id) {
return cluster;
}
return undefined;
});
// TODO: replace with proper entity source once syncing entities between main and windows is injectable
const catalogEntityRegistry = windowDi.inject(catalogEntityRegistryInjectable);
catalogEntityRegistry.updateItems([clusterEntity, otherEntity, localClusterEntity]);
});
rendered = await builder.render();
windowDi = builder.applicationWindow.only.di;
});
it("renders", () => {
expect(rendered.baseElement).toMatchSnapshot();
});
it("does not show entity settings page yet", () => {
expect(rendered.queryByTestId("entity-settings")).not.toBeInTheDocument();
});
describe("when navigating to non-local cluster entity settings", () => {
beforeEach(() => {
const navigateToEntitySettings = windowDi.inject(navigateToEntitySettingsInjectable);
navigateToEntitySettings(clusterEntity.getId());
});
it("renders", () => {
expect(rendered.baseElement).toMatchSnapshot();
});
it("shows entity settings page", () => {
expect(rendered.queryByTestId("entity-settings")).toBeInTheDocument();
});
it("does not show the General setting tab header for non-local cluster", () => {
expect(rendered.queryByTestId("general-tab")).not.toBeInTheDocument();
});
it("shows Proxy setting tab header", () => {
expect(rendered.queryByTestId("proxy-tab")).toBeInTheDocument();
});
it("shows Terminal setting tab header", () => {
expect(rendered.queryByTestId("terminal-tab")).toBeInTheDocument();
});
it("shows Namespaces setting tab header", () => {
expect(rendered.queryByTestId("namespace-tab")).toBeInTheDocument();
});
it("shows Metrics setting tab header", () => {
expect(rendered.queryByTestId("metrics-tab")).toBeInTheDocument();
});
it("shows Node Shell setting tab header", () => {
expect(rendered.queryByTestId("node-shell-tab")).toBeInTheDocument();
});
it("shows the setting tabs in the correct order", () => {
expect(rendered.getByTestId("proxy-tab").nextSibling).toHaveAttribute("data-testid", "terminal-tab");
expect(rendered.getByTestId("terminal-tab").nextSibling).toHaveAttribute("data-testid", "namespace-tab");
expect(rendered.getByTestId("namespace-tab").nextSibling).toHaveAttribute("data-testid", "metrics-tab");
expect(rendered.getByTestId("metrics-tab").nextSibling).toHaveAttribute("data-testid", "node-shell-tab");
});
});
describe("when navigating to local cluster entity settings", () => {
beforeEach(() => {
const navigateToEntitySettings = windowDi.inject(navigateToEntitySettingsInjectable);
navigateToEntitySettings(localClusterEntity.getId());
});
it("renders", () => {
expect(rendered.baseElement).toMatchSnapshot();
});
it("shows entity settings page", () => {
expect(rendered.queryByTestId("entity-settings")).toBeInTheDocument();
});
it("shows the General setting tab header", () => {
expect(rendered.queryByTestId("general-tab")).toBeInTheDocument();
});
it("shows Proxy setting tab header", () => {
expect(rendered.queryByTestId("proxy-tab")).toBeInTheDocument();
});
it("shows Terminal setting tab header", () => {
expect(rendered.queryByTestId("terminal-tab")).toBeInTheDocument();
});
it("shows Namespaces setting tab header", () => {
expect(rendered.queryByTestId("namespace-tab")).toBeInTheDocument();
});
it("shows Metrics setting tab header", () => {
expect(rendered.queryByTestId("metrics-tab")).toBeInTheDocument();
});
it("shows Node Shell setting tab header", () => {
expect(rendered.queryByTestId("node-shell-tab")).toBeInTheDocument();
});
it("shows the setting tabs in the correct order", () => {
expect(rendered.getByTestId("general-tab").nextSibling).toHaveAttribute("data-testid", "proxy-tab");
expect(rendered.getByTestId("proxy-tab").nextSibling).toHaveAttribute("data-testid", "terminal-tab");
expect(rendered.getByTestId("terminal-tab").nextSibling).toHaveAttribute("data-testid", "namespace-tab");
expect(rendered.getByTestId("namespace-tab").nextSibling).toHaveAttribute("data-testid", "metrics-tab");
expect(rendered.getByTestId("metrics-tab").nextSibling).toHaveAttribute("data-testid", "node-shell-tab");
});
});
describe("when navigating to weblink entity settings", () => {
beforeEach(() => {
const navigateToEntitySettings = windowDi.inject(navigateToEntitySettingsInjectable);
navigateToEntitySettings(otherEntity.getId());
});
it("renders", () => {
expect(rendered.baseElement).toMatchSnapshot();
});
it("shows entity settings page", () => {
expect(rendered.queryByTestId("entity-settings")).toBeInTheDocument();
});
it("does not show the unrelated settings", () => {
expect(rendered.queryByTestId("general-tab")).not.toBeInTheDocument();
});
it("shows no settings page info", () => {
expect(rendered.baseElement.querySelector("[data-preference-page-does-not-exist-test='true']")).toBeInTheDocument();
});
});
});

View File

@ -98,16 +98,30 @@ const NonInjectedCatalogEntitySettings = observer((props: CatalogEntitySettingsP
<SettingLayout
navigation={renderNavigation()}
contentGaps={false}
data-testid="entity-settings"
>
{
(tabId && setting) && (
<section>
<h2 data-testid={`${tabId}-header`}>{setting.title}</h2>
tabId && setting
? (
<section>
<setting.components.View entity={entity} />
<h2 data-testid={`${tabId}-header`}>{setting.title}</h2>
<section>
<setting.components.View entity={entity} />
</section>
</section>
</section>
)
)
: (
<div
className="flex items-center"
data-preference-page-does-not-exist-test={true}
>
No settings found for
{" "}
{entity.apiVersion}
/
{entity.kind}
</div>
)
}
</SettingLayout>
);

View File

@ -54,13 +54,13 @@ const GeneralKubernetesClusterSettings = withInjectables<Dependencies, EntitySet
const generalKubernetesClusterEntitySettingsInjectable = getInjectable({
id: "general-kubernetes-cluster-entity-settings",
instantiate: () => ({
apiVersions: ["entity.k8slens.dev/v1alpha1"],
apiVersions: new Set(["entity.k8slens.dev/v1alpha1"]),
kind: "KubernetesCluster",
source: "local",
title: "General",
group: "Settings",
id: "general",
priority: 40,
orderNumber: 0,
components: {
View: GeneralKubernetesClusterSettings,
},

View File

@ -48,12 +48,12 @@ const MetricsKubernetesClusterSettings = withInjectables<Dependencies, EntitySet
const metricsKubernetesClusterEntitySettingsInjectable = getInjectable({
id: "metrics-kubernetes-cluster-entity-settings",
instantiate: () => ({
apiVersions: ["entity.k8slens.dev/v1alpha1"],
apiVersions: new Set(["entity.k8slens.dev/v1alpha1"]),
kind: "KubernetesCluster",
title: "Metrics",
group: "Settings",
id: "metrics",
priority: 40,
orderNumber: 40,
components: {
View: MetricsKubernetesClusterSettings,
},

View File

@ -39,12 +39,12 @@ const NamespaceKubernetesClusterSettings = withInjectables<Dependencies, EntityS
const namespaceKubernetesClusterEntitySettingsInjectable = getInjectable({
id: "namespace-kubernetes-cluster-entity-settings",
instantiate: () => ({
apiVersions: ["entity.k8slens.dev/v1alpha1"],
apiVersions: new Set(["entity.k8slens.dev/v1alpha1"]),
kind: "KubernetesCluster",
title: "Namespace",
group: "Settings",
id: "namespace",
priority: 40,
orderNumber: 30,
components: {
View: NamespaceKubernetesClusterSettings,
},

View File

@ -39,12 +39,12 @@ const NodeShellKubernetesClusterSettings = withInjectables<Dependencies, EntityS
const nodeShellKubernetesClusterEntitySettingsInjectable = getInjectable({
id: "node-shell-kubernetes-cluster-entity-settings",
instantiate: () => ({
apiVersions: ["entity.k8slens.dev/v1alpha1"],
apiVersions: new Set(["entity.k8slens.dev/v1alpha1"]),
kind: "KubernetesCluster",
title: "Node Shell",
group: "Settings",
id: "node-shell",
priority: 40,
orderNumber: 45,
components: {
View: NodeShellKubernetesClusterSettings,
},

View File

@ -39,12 +39,12 @@ const ProxyKubernetesClusterSettings = withInjectables<Dependencies, EntitySetti
const proxyKubernetesClusterEntitySettingsInjectable = getInjectable({
id: "proxy-kubernetes-cluster-entity-settings",
instantiate: () => ({
apiVersions: ["entity.k8slens.dev/v1alpha1"],
apiVersions: new Set(["entity.k8slens.dev/v1alpha1"]),
kind: "KubernetesCluster",
title: "Proxy",
group: "Settings",
id: "proxy",
priority: 40,
orderNumber: 10,
components: {
View: ProxyKubernetesClusterSettings,
},

View File

@ -39,12 +39,12 @@ const TerminalKubernetesClusterSettings = withInjectables<Dependencies, EntitySe
const terminalKubernetesClusterEntitySettingsInjectable = getInjectable({
id: "terminal-kubernetes-cluster-entity-settings",
instantiate: () => ({
apiVersions: ["entity.k8slens.dev/v1alpha1"],
apiVersions: new Set(["entity.k8slens.dev/v1alpha1"]),
kind: "KubernetesCluster",
title: "Terminal",
group: "Settings",
id: "terminal",
priority: 40,
orderNumber: 20,
components: {
View: TerminalKubernetesClusterSettings,
},

View File

@ -4,14 +4,14 @@
*/
import React from "react";
import type { Cluster } from "../../../../common/cluster/cluster";
import { autoBind } from "../../../utils";
import type { Cluster } from "../../../common/cluster/cluster";
import { autoBind } from "../../utils";
import { observable } from "mobx";
import { observer } from "mobx-react";
import type { KubernetesCluster } from "../../../../common/catalog-entities";
import { FilePicker, OverSizeLimitStyle } from "../../file-picker";
import { MenuActions, MenuItem } from "../../menu";
import { Avatar } from "../../avatar";
import type { KubernetesCluster } from "../../../common/catalog-entities";
import { FilePicker, OverSizeLimitStyle } from "../file-picker";
import { MenuActions, MenuItem } from "../menu";
import { Avatar } from "../avatar";
enum GeneralInputStatus {
CLEAN = "clean",

View File

@ -4,11 +4,11 @@
*/
import React from "react";
import type { Cluster } from "../../../../common/cluster/cluster";
import type { Cluster } from "../../../common/cluster/cluster";
import { observer } from "mobx-react";
import { SubTitle } from "../../layout/sub-title";
import { SubTitle } from "../layout/sub-title";
import { shell } from "electron";
import { Notice } from "../../+extensions/notice";
import { Notice } from "../+extensions/notice";
export interface ClusterKubeconfigProps {
cluster: Cluster;

View File

@ -5,20 +5,20 @@
import React, { useEffect, useState } from "react";
import { observer } from "mobx-react";
import type { Cluster } from "../../../../common/cluster/cluster";
import { Input } from "../../input";
import { SubTitle } from "../../layout/sub-title";
import type { ShowNotification } from "../../notifications";
import { Icon } from "../../icon";
import { PathPicker } from "../../path-picker";
import { isWindows } from "../../../../common/vars";
import type { Cluster } from "../../../common/cluster/cluster";
import { Input } from "../input";
import { SubTitle } from "../layout/sub-title";
import type { ShowNotification } from "../notifications";
import { Icon } from "../icon";
import { PathPicker } from "../path-picker";
import { withInjectables } from "@ogre-tools/injectable-react";
import showErrorNotificationInjectable from "../../notifications/show-error-notification.injectable";
import type { ValidateDirectory } from "../../../../common/fs/validate-directory.injectable";
import validateDirectoryInjectable from "../../../../common/fs/validate-directory.injectable";
import type { ResolveTilde } from "../../../../common/path/resolve-tilde.injectable";
import resolveTildeInjectable from "../../../../common/path/resolve-tilde.injectable";
import Gutter from "../../gutter/gutter";
import showErrorNotificationInjectable from "../notifications/show-error-notification.injectable";
import type { ValidateDirectory } from "../../../common/fs/validate-directory.injectable";
import validateDirectoryInjectable from "../../../common/fs/validate-directory.injectable";
import type { ResolveTilde } from "../../../common/path/resolve-tilde.injectable";
import resolveTildeInjectable from "../../../common/path/resolve-tilde.injectable";
import Gutter from "../gutter/gutter";
import isWindowsInjectable from "../../../common/vars/is-windows.injectable";
export interface ClusterLocalTerminalSettingProps {
cluster: Cluster;
@ -27,6 +27,7 @@ interface Dependencies {
showErrorNotification: ShowNotification;
validateDirectory: ValidateDirectory;
resolveTilde: ResolveTilde;
isWindows: boolean;
}
const NonInjectedClusterLocalTerminalSetting = observer(({
@ -34,6 +35,7 @@ const NonInjectedClusterLocalTerminalSetting = observer(({
showErrorNotification,
validateDirectory,
resolveTilde,
isWindows,
}: Dependencies & ClusterLocalTerminalSettingProps) => {
if (!cluster) {
return null;
@ -165,5 +167,6 @@ export const ClusterLocalTerminalSetting = withInjectables<Dependencies, Cluster
showErrorNotification: di.inject(showErrorNotificationInjectable),
validateDirectory: di.inject(validateDirectoryInjectable),
resolveTilde: di.inject(resolveTildeInjectable),
isWindows: di.inject(isWindowsInjectable),
}),
});

View File

@ -5,13 +5,13 @@
import React from "react";
import { disposeOnUnmount, observer } from "mobx-react";
import { onMultiSelectFor, Select } from "../../select/select";
import { Icon } from "../../icon/icon";
import { Button } from "../../button/button";
import { SubTitle } from "../../layout/sub-title";
import type { Cluster } from "../../../../common/cluster/cluster";
import { onMultiSelectFor, Select } from "../select/select";
import { Icon } from "../icon/icon";
import { Button } from "../button/button";
import { SubTitle } from "../layout/sub-title";
import type { Cluster } from "../../../common/cluster/cluster";
import { observable, reaction, makeObservable } from "mobx";
import { ClusterMetricsResourceType } from "../../../../common/cluster-types";
import { ClusterMetricsResourceType } from "../../../common/cluster-types";
export interface ClusterMetricsSettingProps {
cluster: Cluster;

View File

@ -4,13 +4,13 @@
*/
import React from "react";
import type { Cluster } from "../../../../common/cluster/cluster";
import { Input } from "../../input";
import type { Cluster } from "../../../common/cluster/cluster";
import { Input } from "../input";
import { observable, autorun, makeObservable } from "mobx";
import { observer, disposeOnUnmount } from "mobx-react";
import { SubTitle } from "../../layout/sub-title";
import { isRequired } from "../../input/input_validators";
import type { KubernetesCluster } from "../../../../common/catalog-entities";
import { SubTitle } from "../layout/sub-title";
import { isRequired } from "../input/input_validators";
import type { KubernetesCluster } from "../../../common/catalog-entities";
export interface ClusterNameSettingProps {
cluster: Cluster;

View File

@ -3,15 +3,15 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import type { Cluster } from "../../../../common/cluster/cluster";
import type { Cluster } from "../../../common/cluster/cluster";
import { makeObservable, observable } from "mobx";
import { SubTitle } from "../../layout/sub-title";
import { SubTitle } from "../layout/sub-title";
import React from "react";
import { Input } from "../../input/input";
import { Input } from "../input/input";
import { observer } from "mobx-react";
import { Icon } from "../../icon/icon";
import { initialNodeShellImage } from "../../../../common/cluster-types";
import Gutter from "../../gutter/gutter";
import { Icon } from "../icon/icon";
import { initialNodeShellImage } from "../../../common/cluster-types";
import Gutter from "../gutter/gutter";
export interface ClusterNodeShellSettingProps {
cluster: Cluster;

View File

@ -5,17 +5,17 @@
import React from "react";
import { observer, disposeOnUnmount } from "mobx-react";
import type { Cluster } from "../../../../common/cluster/cluster";
import { SubTitle } from "../../layout/sub-title";
import type { SelectOption } from "../../select";
import { Select } from "../../select";
import { Input } from "../../input";
import type { Cluster } from "../../../common/cluster/cluster";
import { SubTitle } from "../layout/sub-title";
import type { SelectOption } from "../select";
import { Select } from "../select";
import { Input } from "../input";
import { observable, computed, autorun, makeObservable } from "mobx";
import { Spinner } from "../../spinner";
import type { MetricProviderInfo, RequestMetricsProviders } from "../../../../common/k8s-api/endpoints/metrics.api/request-providers.injectable";
import { Spinner } from "../spinner";
import type { MetricProviderInfo, RequestMetricsProviders } from "../../../common/k8s-api/endpoints/metrics.api/request-providers.injectable";
import { withInjectables } from "@ogre-tools/injectable-react";
import requestMetricsProvidersInjectable from "../../../../common/k8s-api/endpoints/metrics.api/request-providers.injectable";
import productNameInjectable from "../../../../common/vars/product-name.injectable";
import requestMetricsProvidersInjectable from "../../../common/k8s-api/endpoints/metrics.api/request-providers.injectable";
import productNameInjectable from "../../../common/vars/product-name.injectable";
export interface ClusterPrometheusSettingProps {
cluster: Cluster;

View File

@ -6,9 +6,9 @@
import React from "react";
import { observable, autorun, makeObservable } from "mobx";
import { observer, disposeOnUnmount } from "mobx-react";
import type { Cluster } from "../../../../common/cluster/cluster";
import { Input, InputValidators } from "../../input";
import { SubTitle } from "../../layout/sub-title";
import type { Cluster } from "../../../common/cluster/cluster";
import { Input, InputValidators } from "../input";
import { SubTitle } from "../layout/sub-title";
export interface ClusterProxySettingProps {
cluster: Cluster;

View File

@ -5,11 +5,11 @@
import React from "react";
import { disposeOnUnmount, observer } from "mobx-react";
import type { Cluster } from "../../../../common/cluster/cluster";
import type { Cluster } from "../../../common/cluster/cluster";
import { observable, reaction, makeObservable } from "mobx";
import { Badge } from "../../badge/badge";
import { Icon } from "../../icon/icon";
import { Notice } from "../../+extensions/notice";
import { Badge } from "../badge/badge";
import { Icon } from "../icon/icon";
import { Notice } from "../+extensions/notice";
export interface ShowMetricsSettingProps {
cluster: Cluster;

View File

@ -47,7 +47,6 @@ import setupSystemCaInjectable from "./frames/root-frame/setup-system-ca.injecta
import extensionShouldBeEnabledForClusterFrameInjectable from "./extension-loader/extension-should-be-enabled-for-cluster-frame.injectable";
import { asyncComputed } from "@ogre-tools/injectable-react";
import legacyOnChannelListenInjectable from "./ipc/legacy-channel-listen.injectable";
import getEntitySettingCommandsInjectable from "./components/command-palette/registered-commands/get-entity-setting-commands.injectable";
import storageSaveDelayInjectable from "./utils/create-storage/storage-save-delay.injectable";
import environmentVariablesInjectable from "../common/utils/environment-variables.injectable";
import type { GlobalOverride } from "../common/test-utils/get-global-override";
@ -113,9 +112,6 @@ export const getDiForUnitTesting = (
di.override(requestAnimationFrameInjectable, () => (callback) => callback());
di.override(lensResourcesDirInjectable, () => "/irrelevant");
// TODO: remove when entity settings registry is refactored
di.override(getEntitySettingCommandsInjectable, () => () => []);
// TODO: Remove after "LensRendererExtension.isEnabledForCluster" is removed
di.override(extensionShouldBeEnabledForClusterFrameInjectable, () =>
asyncComputed({ getValueFromObservedPromise: async () => true, valueWhenPending: true }),