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

Kludge "isEnabledForCluster" work again for kube object status texts

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>
This commit is contained in:
Janne Savolainen 2022-07-06 15:23:31 +03:00
parent 3759636800
commit af755dc00f
No known key found for this signature in database
GPG Key ID: 8C6CFB2FFFE8F68A
10 changed files with 1545 additions and 129 deletions

View File

@ -0,0 +1,160 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import type { AsyncFnMock } from "@async-fn/jest";
import asyncFn from "@async-fn/jest";
import type { RenderResult } from "@testing-library/react";
import type { ApplicationBuilder } from "../../../../renderer/components/test-utils/get-application-builder";
import type { KubernetesCluster } from "../../../../common/catalog-entities";
import { getApplicationBuilder } from "../../../../renderer/components/test-utils/get-application-builder";
import { getExtensionFakeFor } from "../../../../renderer/components/test-utils/get-extension-fake";
import { getInjectable } from "@ogre-tools/injectable";
import { frontEndRouteInjectionToken } from "../../../../common/front-end-routing/front-end-route-injection-token";
import { computed } from "mobx";
import React from "react";
import { navigateToRouteInjectionToken } from "../../../../common/front-end-routing/navigate-to-route-injection-token";
import { routeSpecificComponentInjectionToken } from "../../../../renderer/routes/route-specific-component-injection-token";
import { KubeObjectStatusIcon } from "../../../../renderer/components/kube-object-status-icon/kube-object-status-icon";
import { KubeObject } from "../../../../common/k8s-api/kube-object";
import { KubeObjectStatusLevel } from "../../../../common/k8s-api/kube-object-status";
import extensionShouldBeEnabledForClusterFrameInjectable from "../../../../renderer/extension-loader/extension-should-be-enabled-for-cluster-frame.injectable";
describe("disable kube object statuses when cluster is not relevant", () => {
let builder: ApplicationBuilder;
let rendered: RenderResult;
let isEnabledForClusterMock: AsyncFnMock<
(cluster: KubernetesCluster) => boolean
>;
beforeEach(async () => {
builder = getApplicationBuilder();
const rendererDi = builder.dis.rendererDi;
rendererDi.unoverride(extensionShouldBeEnabledForClusterFrameInjectable);
rendererDi.register(testRouteInjectable, testRouteComponentInjectable);
builder.setEnvironmentToClusterFrame();
const getExtensionFake = getExtensionFakeFor(builder);
isEnabledForClusterMock = asyncFn();
const testExtension = getExtensionFake({
id: "test-extension-id",
name: "test-extension",
rendererOptions: {
isEnabledForCluster: isEnabledForClusterMock,
kubeObjectStatusTexts: [
{
kind: "some-kind",
apiVersions: ["some-api-version"],
resolve: () => ({
level: KubeObjectStatusLevel.CRITICAL,
text: "some-kube-object-status-text",
}),
},
],
},
});
rendered = await builder.render();
const navigateToRoute = rendererDi.inject(navigateToRouteInjectionToken);
const testRoute = rendererDi.inject(testRouteInjectable);
navigateToRoute(testRoute);
builder.extensions.enable(testExtension);
});
describe("given not yet known if extension should be enabled for the cluster, when navigating", () => {
it("renders", () => {
expect(rendered.baseElement).toMatchSnapshot();
});
it("does not show the status", () => {
const actual = rendered.baseElement.querySelectorAll(".KubeObjectStatusIcon");
expect(actual).toHaveLength(0);
});
});
describe("given extension shouldn't be enabled for the cluster, when navigating", () => {
beforeEach(async () => {
await isEnabledForClusterMock.resolve(false);
});
it("renders", () => {
expect(rendered.baseElement).toMatchSnapshot();
});
it("does not show the status", () => {
const actual = rendered.baseElement.querySelectorAll(".KubeObjectStatusIcon");
expect(actual).toHaveLength(0);
});
});
describe("given extension should be enabled for the cluster, when navigating", () => {
beforeEach(async () => {
await isEnabledForClusterMock.resolve(true);
});
it("renders", () => {
expect(rendered.baseElement).toMatchSnapshot();
});
it("shows the status", () => {
const actual = rendered.baseElement.querySelectorAll(".KubeObjectStatusIcon");
expect(actual).toHaveLength(1);
});
});
});
const testRouteInjectable = getInjectable({
id: "test-route",
instantiate: () => ({
path: "/test-route",
clusterFrame: true,
isEnabled: computed(() => true),
}),
injectionToken: frontEndRouteInjectionToken,
});
const testRouteComponentInjectable = getInjectable({
id: "test-route-component",
instantiate: (di) => ({
route: di.inject(testRouteInjectable),
Component: () => (
<KubeObjectStatusIcon
object={getKubeObjectStub("some-kind", "some-api-version")}
/>
),
}),
injectionToken: routeSpecificComponentInjectionToken,
});
const getKubeObjectStub = (kind: string, apiVersion: string) =>
KubeObject.create({
apiVersion,
kind,
metadata: {
uid: "some-uid",
name: "some-name",
resourceVersion: "some-resource-version",
namespace: "some-namespace",
selfLink: "/foo",
},
});

View File

@ -3,38 +3,29 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getDiForUnitTesting } from "../../getDiForUnitTesting";
import rendererExtensionsInjectable from "../../../extensions/renderer-extensions.injectable";
import type { DiRender } from "../test-utils/renderFor";
import { renderFor } from "../test-utils/renderFor";
import { computed } from "mobx";
import { LensRendererExtension } from "../../../extensions/lens-renderer-extension";
import type { KubeObjectStatus } from "../../../common/k8s-api/kube-object-status";
import { KubeObjectStatusLevel } from "../../../common/k8s-api/kube-object-status";
import { KubeObject } from "../../../common/k8s-api/kube-object";
import { KubeObjectStatusIcon } from "./kube-object-status-icon";
import React from "react";
import type { KubeObjectStatusRegistration } from "./kube-object-status-registration";
import { useFakeTime } from "../../../common/test-utils/use-fake-time";
import { getInjectable } from "@ogre-tools/injectable";
import type { DiContainer } from "@ogre-tools/injectable";
import { kubeObjectStatusTextInjectionToken } from "./kube-object-status-text-injection-token";
import { computed } from "mobx";
describe("kube-object-status-icon", () => {
let render: DiRender;
let kubeObjectStatusRegistrations: KubeObjectStatusRegistration[];
let di: DiContainer;
beforeEach(() => {
// TODO: Make mocking of date in unit tests global
global.Date.now = () => new Date("2015-10-21T07:28:00Z").getTime();
useFakeTime("2015-10-21T07:28:00Z");
const di = getDiForUnitTesting({ doGeneralOverrides: true });
di = getDiForUnitTesting({ doGeneralOverrides: true });
render = renderFor(di);
kubeObjectStatusRegistrations = [];
const someTestExtension = new SomeTestExtension(
kubeObjectStatusRegistrations,
);
di.override(rendererExtensionsInjectable, () =>
computed(() => [someTestExtension]),
);
});
it("given no statuses, when rendered, renders as empty", () => {
@ -48,14 +39,14 @@ describe("kube-object-status-icon", () => {
it('given level "critical" status, when rendered, renders with status', () => {
const kubeObject = getKubeObjectStub("some-kind", "some-api-version");
const statusRegistration = getStatusRegistration(
const statusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.CRITICAL,
"critical",
"some-kind",
["some-api-version"],
);
kubeObjectStatusRegistrations.push(statusRegistration);
di.register(statusTextInjectable);
const { baseElement } = render(
<KubeObjectStatusIcon object={kubeObject} />,
@ -67,14 +58,14 @@ describe("kube-object-status-icon", () => {
it('given level "info" status, when rendered, renders with status', () => {
const kubeObject = getKubeObjectStub("some-kind", "some-api-version");
const statusRegistration = getStatusRegistration(
const statusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.INFO,
"info",
"some-kind",
["some-api-version"],
);
kubeObjectStatusRegistrations.push(statusRegistration);
di.register(statusTextInjectable);
const { baseElement } = render(
<KubeObjectStatusIcon object={kubeObject} />,
@ -86,14 +77,14 @@ describe("kube-object-status-icon", () => {
it('given level "warning" status, when rendered, renders with status', () => {
const kubeObject = getKubeObjectStub("some-kind", "some-api-version");
const statusRegistration = getStatusRegistration(
const statusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.WARNING,
"warning",
"some-kind",
["some-api-version"],
);
kubeObjectStatusRegistrations.push(statusRegistration);
di.register(statusTextInjectable);
const { baseElement } = render(
<KubeObjectStatusIcon object={kubeObject} />,
@ -105,30 +96,32 @@ describe("kube-object-status-icon", () => {
it("given status for all levels is present, when rendered, renders with statuses", () => {
const kubeObject = getKubeObjectStub("some-kind", "some-api-version");
const critical = getStatusRegistration(
const criticalStatusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.CRITICAL,
"critical",
"some-kind",
["some-api-version"],
);
const warning = getStatusRegistration(
const warningStatusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.WARNING,
"warning",
"some-kind",
["some-api-version"],
);
const info = getStatusRegistration(
const infoStatusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.INFO,
"info",
"some-kind",
["some-api-version"],
);
kubeObjectStatusRegistrations.push(critical);
kubeObjectStatusRegistrations.push(warning);
kubeObjectStatusRegistrations.push(info);
di.register(
criticalStatusTextInjectable,
warningStatusTextInjectable,
infoStatusTextInjectable,
);
const { baseElement } = render(
<KubeObjectStatusIcon object={kubeObject} />,
@ -140,22 +133,21 @@ describe("kube-object-status-icon", () => {
it("given info and warning statuses are present, when rendered, renders with statuses", () => {
const kubeObject = getKubeObjectStub("some-kind", "some-api-version");
const warning = getStatusRegistration(
const warningStatusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.WARNING,
"warning",
"some-kind",
["some-api-version"],
);
const info = getStatusRegistration(
const infoStatusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.INFO,
"info",
"some-kind",
["some-api-version"],
);
kubeObjectStatusRegistrations.push(warning);
kubeObjectStatusRegistrations.push(info);
di.register(warningStatusTextInjectable, infoStatusTextInjectable);
const { baseElement } = render(
<KubeObjectStatusIcon object={kubeObject} />,
@ -168,14 +160,14 @@ describe("kube-object-status-icon", () => {
it("given registration for wrong api version, when rendered, renders as empty", () => {
const kubeObject = getKubeObjectStub("some-kind", "some-api-version");
const statusRegistration = getStatusRegistration(
const statusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.CRITICAL,
"irrelevant",
"some-kind",
["some-other-api-version"],
);
kubeObjectStatusRegistrations.push(statusRegistration);
di.register(statusTextInjectable);
const { baseElement } = render(
<KubeObjectStatusIcon object={kubeObject} />,
@ -187,14 +179,14 @@ describe("kube-object-status-icon", () => {
it("given registration for wrong kind, when rendered, renders as empty", () => {
const kubeObject = getKubeObjectStub("some-kind", "some-api-version");
const statusRegistration = getStatusRegistration(
const statusTextInjectable = getStatusTextInjectable(
KubeObjectStatusLevel.CRITICAL,
"irrelevant",
"some-other-kind",
["some-api-version"],
);
kubeObjectStatusRegistrations.push(statusRegistration);
di.register(statusTextInjectable);
const { baseElement } = render(
<KubeObjectStatusIcon object={kubeObject} />,
@ -206,21 +198,25 @@ describe("kube-object-status-icon", () => {
it("given registration without status for exact kube object, when rendered, renders as empty", () => {
const kubeObject = getKubeObjectStub("some-kind", "some-api-version");
const statusRegistration = {
const statusTextInjectable = getInjectable({
id: "some-id",
instantiate: () => ({
apiVersions: ["some-api-version"],
kind: "some-kind",
resolve: (): void => {},
};
resolve: () => { return undefined as unknown as KubeObjectStatus; },
enabled: computed(() => true),
}),
// @ts-ignore
kubeObjectStatusRegistrations.push(statusRegistration);
injectionToken: kubeObjectStatusTextInjectionToken,
});
di.register(statusTextInjectable);
const { baseElement } = render(
<KubeObjectStatusIcon object={kubeObject} />,
);
expect(baseElement).toMatchSnapshot();
});
});
@ -236,28 +232,20 @@ const getKubeObjectStub = (kind: string, apiVersion: string) => KubeObject.creat
},
});
const getStatusRegistration = (level: KubeObjectStatusLevel, title: string, kind: string, apiVersions: string[]) => ({
const getStatusTextInjectable = (level: KubeObjectStatusLevel, title: string, kind: string, apiVersions: string[]) => getInjectable({
id: title,
instantiate: () => ({
apiVersions,
kind,
resolve: (kubeObject: KubeObject) => ({
level,
text: `Some ${title} status for ${kubeObject.getName()}`,
timestamp: "2015-10-19T07:28:00Z",
}),
});
class SomeTestExtension extends LensRendererExtension {
constructor(kubeObjectStatusTexts: KubeObjectStatusRegistration[]) {
super({
id: "some-id",
absolutePath: "irrelevant",
isBundled: false,
isCompatible: false,
isEnabled: false,
manifest: { name: "some-id", version: "some-version", engines: { lens: "^5.5.0" }},
manifestPath: "irrelevant",
});
enabled: computed(() => true),
}),
this.kubeObjectStatusTexts = kubeObjectStatusTexts;
}
}
injectionToken: kubeObjectStatusTextInjectionToken,
});

View File

@ -9,10 +9,12 @@ import React from "react";
import { Icon } from "../icon";
import { cssNames, formatDuration, getOrInsert } from "../../utils";
import { withInjectables } from "@ogre-tools/injectable-react";
import statusesForKubeObjectInjectable from "./statuses-for-kube-object.injectable";
import kubeObjectStatusTextsForObjectInjectable from "./kube-object-status-texts-for-object.injectable";
import type { KubeObject } from "../../../common/k8s-api/kube-object";
import type { KubeObjectStatus } from "../../../common/k8s-api/kube-object-status";
import { KubeObjectStatusLevel } from "../../../common/k8s-api/kube-object-status";
import type { IComputedValue } from "mobx";
import { observer } from "mobx-react";
function statusClassName(level: KubeObjectStatusLevel): string {
switch (level) {
@ -76,9 +78,10 @@ export interface KubeObjectStatusIconProps {
}
interface Dependencies {
statuses: KubeObjectStatus[];
statuses: IComputedValue<KubeObjectStatus[]>;
}
@observer
class NonInjectedKubeObjectStatusIcon extends React.Component<KubeObjectStatusIconProps & Dependencies> {
renderStatuses(statuses: KubeObjectStatus[], level: number) {
const filteredStatuses = statuses.filter((item) => item.level == level);
@ -104,7 +107,7 @@ class NonInjectedKubeObjectStatusIcon extends React.Component<KubeObjectStatusIc
}
render() {
const statuses = this.props.statuses;
const statuses = this.props.statuses.get();
if (statuses.length === 0) {
return null;
@ -135,7 +138,7 @@ export const KubeObjectStatusIcon = withInjectables<Dependencies, KubeObjectStat
{
getProps: (di, props) => ({
statuses: di.inject(statusesForKubeObjectInjectable, props.object),
statuses: di.inject(kubeObjectStatusTextsForObjectInjectable, props.object),
...props,
}),
},

View File

@ -0,0 +1,20 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getInjectionToken } from "@ogre-tools/injectable";
import type { KubeObject } from "../../../common/k8s-api/kube-object";
import type { KubeObjectStatus } from "../../../common/k8s-api/kube-object-status";
import type { IComputedValue } from "mobx";
export interface KubeObjectStatusText {
kind: string;
apiVersions: string[];
resolve: (object: KubeObject) => KubeObjectStatus;
enabled: IComputedValue<boolean>;
}
export const kubeObjectStatusTextInjectionToken =
getInjectionToken<KubeObjectStatusText>({
id: "kube-object-status-text-injection-token",
});

View File

@ -0,0 +1,55 @@
/**
* 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 { extensionRegistratorInjectionToken } from "../../../extensions/extension-loader/extension-registrator-injection-token";
import type { LensRendererExtension } from "../../../extensions/lens-renderer-extension";
import getRandomIdInjectable from "../../../common/utils/get-random-id.injectable";
import { kubeObjectStatusTextInjectionToken } from "./kube-object-status-text-injection-token";
import extensionShouldBeEnabledForClusterFrameInjectable from "../../extension-loader/extension-should-be-enabled-for-cluster-frame.injectable";
import { computed } from "mobx";
const kubeObjectStatusTextRegistratorInjectable = getInjectable({
id: "kube-object-status-text-registrator",
instantiate: (di) => {
const getRandomId = di.inject(getRandomIdInjectable);
const getExtensionShouldBeEnabledForClusterFrame = (
extension: LensRendererExtension,
) =>
di.inject(extensionShouldBeEnabledForClusterFrameInjectable, extension);
return (ext) => {
const extension = ext as LensRendererExtension;
const extensionShouldBeEnabledForClusterFrame =
getExtensionShouldBeEnabledForClusterFrame(extension);
return extension.kubeObjectStatusTexts.map((registration) => {
const id = `kube-object-status-text-registration-from-${
extension.sanitizedExtensionId
}-${getRandomId()}`;
return getInjectable({
id,
instantiate: () => ({
...registration,
enabled: computed(() =>
extensionShouldBeEnabledForClusterFrame.value.get(),
),
}),
injectionToken: kubeObjectStatusTextInjectionToken,
});
});
};
},
injectionToken: extensionRegistratorInjectionToken,
});
export default kubeObjectStatusTextRegistratorInjectable;

View File

@ -0,0 +1,42 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable";
import kubeObjectStatusTextsInjectable from "./kube-object-status-texts.injectable";
import type { KubeObject } from "../../../common/k8s-api/kube-object";
import { conforms, eq, includes } from "lodash/fp";
import type { KubeObjectStatusRegistration } from "./kube-object-status-registration";
import { computed } from "mobx";
const kubeObjectStatusTextsForObjectInjectable = getInjectable({
id: "kube-object-status-texts-for-object",
instantiate: (di, kubeObject: KubeObject) => {
const allStatusTexts = di.inject(kubeObjectStatusTextsInjectable);
return computed(() =>
allStatusTexts
.get()
.filter(toKubeObjectRelated(kubeObject))
.map(toStatus(kubeObject))
.filter(Boolean),
);
},
lifecycle: lifecycleEnum.keyedSingleton({
getInstanceKey: (di, kubeObject: KubeObject) => kubeObject.getId(),
}),
});
const toKubeObjectRelated = (kubeObject: KubeObject) =>
conforms({
kind: eq(kubeObject.kind),
apiVersions: includes(kubeObject.apiVersion),
});
const toStatus =
(kubeObject: KubeObject) => (item: KubeObjectStatusRegistration) =>
item.resolve(kubeObject);
export default kubeObjectStatusTextsForObjectInjectable;

View File

@ -0,0 +1,23 @@
/**
* 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 { computedInjectManyInjectable } from "@ogre-tools/injectable-extension-for-mobx";
import { computed } from "mobx";
import { kubeObjectStatusTextInjectionToken } from "./kube-object-status-text-injection-token";
const kubeObjectStatusTextsInjectable = getInjectable({
id: "kube-object-status-texts",
instantiate: (di) => {
const computedInjectMany = di.inject(computedInjectManyInjectable);
const statusTexts = computedInjectMany(kubeObjectStatusTextInjectionToken);
return computed(() =>
statusTexts.get().filter((statusText) => statusText.enabled.get()),
);
},
});
export default kubeObjectStatusTextsInjectable;

View File

@ -1,21 +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 rendererExtensionsInjectable from "../../../extensions/renderer-extensions.injectable";
const statusRegistrationsInjectable = getInjectable({
id: "status-registrations",
instantiate: (di) => {
const extensions = di.inject(rendererExtensionsInjectable);
return computed(() =>
extensions.get().flatMap((extension) => extension.kubeObjectStatusTexts),
);
},
});
export default statusRegistrationsInjectable;

View File

@ -1,35 +0,0 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable";
import statusRegistrationsInjectable from "./status-registrations.injectable";
import type { KubeObject } from "../../../common/k8s-api/kube-object";
import { conforms, eq, includes } from "lodash/fp";
import type { KubeObjectStatusRegistration } from "./kube-object-status-registration";
const statusesForKubeObjectInjectable = getInjectable({
id: "statuses-for-kube-object",
instantiate: (di, kubeObject: KubeObject) =>
di
.inject(statusRegistrationsInjectable)
.get()
.filter(toKubeObjectRelated(kubeObject))
.map(toStatus(kubeObject))
.filter(Boolean),
lifecycle: lifecycleEnum.transient,
});
const toKubeObjectRelated = (kubeObject: KubeObject) =>
conforms({
kind: eq(kubeObject.kind),
apiVersions: includes(kubeObject.apiVersion),
});
const toStatus =
(kubeObject: KubeObject) => (item: KubeObjectStatusRegistration) =>
item.resolve(kubeObject);
export default statusesForKubeObjectInjectable;