Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix workload overview status sorting #3486

Merged
merged 3 commits into from
Jul 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/renderer/api/kube-json-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ export interface KubeJsonApiMetadata {
annotations?: {
[annotation: string]: string;
};
[key: string]: any;
}

export interface KubeJsonApiData extends JsonApiData {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export class CronJobStore extends KubeObjectStore<CronJob> {
}

getStatuses(cronJobs?: CronJob[]) {
const status = { suspended: 0, scheduled: 0 };
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does the order matter?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an object, so I think we should specify the order by extracting to an array. Or at least add a comment above all of these saying that the order is important.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we're decided to put all "green" statuses on top (show them first), I've moved scheduled to be first one since it's "green".

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still think that should be something that is commented or specified somewhere else. Since objects are key/value structures which don't really have a conceptual ordering.

Copy link
Contributor Author

@aleksfront aleksfront Jul 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, objects didn't have conceptual ordering, but they're actually have an order for now. The results are always the same + we have tests now checking ordering.

Here's mentions about object ordering https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map#objects_vs._maps

As an alternative, I've converted statuses to use Maps, but this looks more messy and verbose without visible benefits.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I was thinking more of having a defined ordering in overview-workload-status.tsx but that might be a bit too much. Maybe something for the future.

I don't particularly like the fact that this ordering is required to be static but I concur that should be for the future.

const status = { scheduled: 0, suspended: 0 };

cronJobs.forEach(cronJob => {
if (cronJob.spec.suspend) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export class DaemonSetStore extends KubeObjectStore<DaemonSet> {
}

getStatuses(daemonSets?: DaemonSet[]) {
const status = { failed: 0, pending: 0, running: 0 };
const status = { running: 0, failed: 0, pending: 0 };

daemonSets.forEach(daemonSet => {
const pods = this.getChildPods(daemonSet);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export class DeploymentStore extends KubeObjectStore<Deployment> {
}

getStatuses(deployments?: Deployment[]) {
const status = { failed: 0, pending: 0, running: 0 };
const status = { running: 0, failed: 0, pending: 0 };

deployments.forEach(deployment => {
const pods = this.getChildPods(deployment);
Expand Down
2 changes: 1 addition & 1 deletion src/renderer/components/+workloads-jobs/job.store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export class JobStore extends KubeObjectStore<Job> {
}

getStatuses(jobs?: Job[]) {
const status = { failed: 0, pending: 0, running: 0, succeeded: 0 };
const status = { succeeded: 0, running: 0, failed: 0, pending: 0 };

jobs.forEach(job => {
const pods = this.getChildPods(job);
Expand Down
2 changes: 1 addition & 1 deletion src/renderer/components/+workloads-pods/pods.store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ export class PodsStore extends KubeObjectStore<Pod> {
}

getStatuses(pods: Pod[]) {
return countBy(pods.map(pod => pod.getStatus()));
return countBy(pods.map(pod => pod.getStatus()).sort().reverse());
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will automatically sort statuses in a needed order:

Succeeded -> Running -> Pending -> Failed -> Evicted

}

getPodKubeMetrics(pod: Pod) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export class ReplicaSetStore extends KubeObjectStore<ReplicaSet> {
}

getStatuses(replicaSets: ReplicaSet[]) {
const status = { failed: 0, pending: 0, running: 0 };
const status = { running: 0, failed: 0, pending: 0 };

replicaSets.forEach(replicaSet => {
const pods = this.getChildPods(replicaSet);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export class StatefulSetStore extends KubeObjectStore<StatefulSet> {
}

getStatuses(statefulSets: StatefulSet[]) {
const status = { failed: 0, pending: 0, running: 0 };
const status = { running: 0, failed: 0, pending: 0 };

statefulSets.forEach(statefulSet => {
const pods = this.getChildPods(statefulSet);
Expand Down
115 changes: 115 additions & 0 deletions src/renderer/components/__tests__/cronjob.store.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
/**
Copy link
Contributor Author

@aleksfront aleksfront Jul 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All tests sit in parent /components/ folder until this #3481 won't be resolved. Otherwise it's hard run (read impossible) tests locally.

* Copyright (c) 2021 OpenLens Authors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
import { cronJobStore } from "../+workloads-cronjobs/cronjob.store";
import { CronJob } from "../../api/endpoints";

const spec = {
schedule: "test",
concurrencyPolicy: "test",
suspend: true,
jobTemplate: {
metadata: {},
spec: {
template: {
metadata: {},
spec: {
containers: [] as any,
restartPolicy: "restart",
terminationGracePeriodSeconds: 1,
dnsPolicy: "no",
hostPID: true,
schedulerName: "string"
}
}
}
},
successfulJobsHistoryLimit: 1,
failedJobsHistoryLimit: 1
};

const scheduledCronJob = new CronJob({
apiVersion: "foo",
kind: "CronJob",
metadata: {
name: "scheduledCronJob",
resourceVersion: "scheduledCronJob",
uid: "scheduledCronJob",
namespace: "default",
},
});

const suspendedCronJob = new CronJob({
apiVersion: "foo",
kind: "CronJob",
metadata: {
name: "suspendedCronJob",
resourceVersion: "suspendedCronJob",
uid: "suspendedCronJob",
namespace: "default",
}
});

const otherSuspendedCronJob = new CronJob({
apiVersion: "foo",
kind: "CronJob",
metadata: {
name: "otherSuspendedCronJob",
resourceVersion: "otherSuspendedCronJob",
uid: "otherSuspendedCronJob",
namespace: "default",
},
});

scheduledCronJob.spec = { ...spec };
suspendedCronJob.spec = { ...spec };
otherSuspendedCronJob.spec = { ...spec };
scheduledCronJob.spec.suspend = false;

describe("CronJob Store tests", () => {
it("gets CronJob statuses in proper sorting order", () => {
const statuses = Object.entries(cronJobStore.getStatuses([
suspendedCronJob,
otherSuspendedCronJob,
scheduledCronJob
]));

expect(statuses).toEqual([
["scheduled", 1],
["suspended", 2],
]);
});

it("returns 0 for other statuses", () => {
let statuses = Object.entries(cronJobStore.getStatuses([scheduledCronJob]));

expect(statuses).toEqual([
["scheduled", 1],
["suspended", 0],
]);

statuses = Object.entries(cronJobStore.getStatuses([suspendedCronJob]));

expect(statuses).toEqual([
["scheduled", 0],
["suspended", 1],
]);
});
});
181 changes: 181 additions & 0 deletions src/renderer/components/__tests__/daemonset.store.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
/**
* Copyright (c) 2021 OpenLens Authors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

import { observable } from "mobx";
import { daemonSetStore } from "../+workloads-daemonsets/daemonsets.store";
import { podsStore } from "../+workloads-pods/pods.store";
import { DaemonSet, Pod } from "../../api/endpoints";

const runningDaemonSet = new DaemonSet({
apiVersion: "foo",
kind: "DaemonSet",
metadata: {
name: "runningDaemonSet",
resourceVersion: "runningDaemonSet",
uid: "runningDaemonSet",
namespace: "default",
},
});

const failedDaemonSet = new DaemonSet({
apiVersion: "foo",
kind: "DaemonSet",
metadata: {
name: "failedDaemonSet",
resourceVersion: "failedDaemonSet",
uid: "failedDaemonSet",
namespace: "default",
},
});

const pendingDaemonSet = new DaemonSet({
apiVersion: "foo",
kind: "DaemonSet",
metadata: {
name: "pendingDaemonSet",
resourceVersion: "pendingDaemonSet",
uid: "pendingDaemonSet",
namespace: "default",
},
});

const runningPod = new Pod({
apiVersion: "foo",
kind: "Pod",
metadata: {
name: "foobar",
resourceVersion: "foobar",
uid: "foobar",
ownerReferences: [{
uid: "runningDaemonSet",
}],
namespace: "default"
},
});

runningPod.status = {
phase: "Running",
conditions: [
{
type: "Initialized",
status: "True",
lastProbeTime: 1,
lastTransitionTime: "1",
},
{
type: "Ready",
status: "True",
lastProbeTime: 1,
lastTransitionTime: "1",
}
],
hostIP: "10.0.0.1",
podIP: "10.0.0.1",
startTime: "now",
containerStatuses: [],
initContainerStatuses: [],
};

const pendingPod = new Pod({
apiVersion: "foo",
kind: "Pod",
metadata: {
name: "foobar-pending",
resourceVersion: "foobar",
uid: "foobar-pending",
ownerReferences: [{
uid: "pendingDaemonSet",
}],
namespace: "default"
},
});

const failedPod = new Pod({
apiVersion: "foo",
kind: "Pod",
metadata: {
name: "foobar-failed",
resourceVersion: "foobar",
uid: "foobar-failed",
ownerReferences: [{
uid: "failedDaemonSet",
}],
namespace: "default"
},
});

failedPod.status = {
phase: "Failed",
conditions: [],
hostIP: "10.0.0.1",
podIP: "10.0.0.1",
startTime: "now",
};

describe("DaemonSet Store tests", () => {
beforeAll(() => {
podsStore.items = observable.array([
runningPod,
failedPod,
pendingPod
]);
});

it("gets DaemonSet statuses in proper sorting order", () => {
const statuses = Object.entries(daemonSetStore.getStatuses([
failedDaemonSet,
runningDaemonSet,
pendingDaemonSet
]));

expect(statuses).toEqual([
["running", 1],
["failed", 1],
["pending", 1],
]);
});

it("returns 0 for other statuses", () => {
let statuses = Object.entries(daemonSetStore.getStatuses([runningDaemonSet]));

expect(statuses).toEqual([
["running", 1],
["failed", 0],
["pending", 0],
]);

statuses = Object.entries(daemonSetStore.getStatuses([failedDaemonSet]));

expect(statuses).toEqual([
["running", 0],
["failed", 1],
["pending", 0],
]);

statuses = Object.entries(daemonSetStore.getStatuses([pendingDaemonSet]));

expect(statuses).toEqual([
["running", 0],
["failed", 0],
["pending", 1],
]);
});
});
Loading