kubevirt: add tests for Wrappers, EnhancedK8sMethods and utility classes #4696

atiratree · 2020-03-09T16:41:25Z

also fixes few bugs which were found by the testing

@vojtechszocs @glekner @irosenzw @mareklibra @yaacov @pcbailey

atiratree · 2020-03-09T16:43:33Z

frontend/packages/kubevirt-plugin/src/k8s/wrapper/common/__tests__/mocks/test-wrapper.ts

@@ -0,0 +1,12 @@
+import { Wrapper } from '../../wrapper';


this file is a simple example of a Wrapper

atiratree · 2020-03-09T16:43:51Z

frontend/packages/kubevirt-plugin/src/k8s/wrapper/common/__tests__/mocks/smoothie-wrapper.ts

@@ -0,0 +1,85 @@
+import { ObjectEnum } from '../../../../../constants';


this file is a simple example of ObjectWithTypePropertyWrapper

atiratree · 2020-03-09T18:10:58Z

/retest

atiratree · 2020-03-10T11:36:21Z

/retest

glekner

Great tests @suomiy

glekner · 2020-03-10T14:25:56Z

frontend/packages/kubevirt-plugin/src/k8s/wrapper/vm/vm-wrapper.ts

-    if (_.isEmpty(this.getDataVolumeTemplates())) {
-      delete this.data.spec.dataVolumeTemplates;
-    }
+    this.clearIfEmpty('spec.template.spec.domain.devices.disks');


can't we merge ensureStorages and ensureStorageConsistency into one method?

no, one is called before the change of data occurs and the other is called after the change of data - please see prependStorage method

glekner · 2020-03-10T14:28:18Z

...end/packages/kubevirt-plugin/src/k8s/enhancedK8sMethods/__tests__/enhancedK8sMethods.spec.ts

+    await methods.k8sPatch(VirtualMachineModel, testVM, [testPatch]);
+    const actualState = methods.getActualState();
+
+    expect(actualState).toHaveLength(2);


can you destruct actualState for readability? or add a comment? I have no idea whats inside.

added a better comment to the getActualState method

and returns K8sResourceKind[]

glekner · 2020-03-10T14:29:41Z

...end/packages/kubevirt-plugin/src/k8s/enhancedK8sMethods/__tests__/enhancedK8sMethods.spec.ts

+    expect(methodsUnchecked.history).toHaveLength(0);
+
+    await methods.k8sCreate(VirtualMachineModel, testVM);
+    expect(methods.getHistory()).toHaveLength(1);


can you swap the expects? so first we check that there is history and then we actually test that there isn't

the other way is better - otherwise it could happend that some object overwrites the first one we checked and we wouldn't know a difference

glekner · 2020-03-10T14:30:36Z

...end/packages/kubevirt-plugin/src/k8s/enhancedK8sMethods/__tests__/enhancedK8sMethods.spec.ts

+    const results = await methods.rollback();
+
+    expect(results).toHaveLength(2);
+    expect(methods.getActualState()).toHaveLength(0);


why is getActualState() empty? just to understand..

because the rollback worked and there are no living objects we created before on the cluster

glekner · 2020-03-10T14:31:28Z

frontend/packages/kubevirt-plugin/src/k8s/wrapper/common/__tests__/mocks/smoothie-wrapper.ts

+      blueberry?: {
+        color?: string;
+      };
+      strawberry?: {


where is 🍍 ?
😅

glekner · 2020-03-10T14:32:09Z

...s/kubevirt-plugin/src/k8s/wrapper/common/__tests__/object-with-type-property-wrapper.spec.ts

+    expect(emptySmoothie.hasType()).toBe(false);
+    expect(emptySmoothie.asResource()).toEqual({});
+  });
+  //


empty comment

glekner · 2020-03-10T14:34:05Z

...s/kubevirt-plugin/src/k8s/wrapper/common/__tests__/object-with-type-property-wrapper.spec.ts

+    });
+  });
+
+  it('stores inconsistent data', () => {


I don't understand this test, can you write more informative comments? thanks

added a comment few lines bellow

glekner · 2020-03-10T14:36:03Z

frontend/packages/kubevirt-plugin/src/k8s/wrapper/common/k8s-resource-wrapper.ts

@@ -4,7 +4,7 @@ import { apiVersionForModel, K8sKind, K8sResourceKind } from '@console/internal/
 import { Wrapper } from './wrapper';
 import { K8sResourceKindMethods } from '../types/types';

-export class K8sResourceWrapper<
+export abstract class K8sResourceWrapper<


are we sure there is no use case of creating an instance of K8sResourceWrapper?

It is better if the user creates its own definition if needed. Now it also requires model to be supplied.

glekner · 2020-03-10T14:38:12Z

frontend/packages/kubevirt-plugin/src/utils/common.ts

@@ -2,7 +2,16 @@ import * as _ from 'lodash';

 export const omitEmpty = (obj, justUndefined = false) => {


isn't there a lodash alternative so we can remove this code?

have not found one

_.compact(array)

Creates an array with all falsey values removed. The values false, null, 0, "", undefined, and NaN are falsey.

Alternatively, you could use _.remove or _.without.

Cannot be used very well. It should work on objects and arrays recursively with an option to switch between null x undefined

atiratree · 2020-03-10T19:40:45Z

added few changes to the wrappers since last time

each K8sResource kind stores its model
deprecated initializeFromSimpleData in favor of simple instance init. The uses of initializeFromSimpleData still need to be removed in the followup as there are many instances of this. @vojtechszocs
added a simpler method for creating wrappers into EnhancedK8sMethods

atiratree · 2020-03-10T19:42:54Z

also added mixins for our two diverged wrappers - just the more complicated methods for now

- fix bugs

vojtechszocs · 2020-03-11T13:53:36Z

...end/packages/kubevirt-plugin/src/k8s/enhancedK8sMethods/__tests__/enhancedK8sMethods.spec.ts

+    methodsUnchecked.registerKind(kind);
+    methodsUnchecked.appendHistory(new HistoryItem(HistoryType.DELETE, data), enhancedOpts);
+  };
+  return { methods, methodsUnchecked };


Why do we need to separate these two? Both should reference the same object.

Is methodsUnchecked meant to avoid further as any casts?

We could create a minimal type for methodsUnchecked (based on code that uses it) and return methods typed as e.g. BaseK8sMethods & EnhancedK8sMethods.

made a different method in the spyEnhancedK8sMethods
methods.mockK8sGet to avoid the type incompatibilities

using just methods outside of this one and using any typecasts

vojtechszocs · 2020-03-11T13:56:39Z

...end/packages/kubevirt-plugin/src/k8s/enhancedK8sMethods/__tests__/enhancedK8sMethods.spec.ts

+const expectHistory = (history, expectedHistory) => {
+  expect(history).toHaveLength(expectedHistory.length);
+
+  expectedHistory.forEach((expectHistoryItem, idx) => {


IIUC the history objects are one-dimensional arrays.

If so, isn't expect(history).toEqual(expectedHistory) enough?

you are right - this is much easier to read. It was meant to print an index which failed, but I guess it is not that useful.

vojtechszocs · 2020-03-11T15:07:49Z

...end/packages/kubevirt-plugin/src/k8s/enhancedK8sMethods/__tests__/enhancedK8sMethods.spec.ts

+    })
+    .build();
+
+  it('records history and shows actualState', async () => {


Suggested change

it('records history and shows actualState', async () => {

it('records history', async () => {

vojtechszocs · 2020-03-11T15:08:41Z

...end/packages/kubevirt-plugin/src/k8s/enhancedK8sMethods/__tests__/enhancedK8sMethods.spec.ts

+  });
+};
+
+describe('enhancedK8sMethods.js', () => {


Suggested change

describe('enhancedK8sMethods.js', () => {

describe('enhancedK8sMethods', () => {

I'd use the logical module name to describe the test suite.

vojtechszocs · 2020-03-11T15:16:19Z

...end/packages/kubevirt-plugin/src/k8s/enhancedK8sMethods/__tests__/enhancedK8sMethods.spec.ts

+    expect.assertions(4);
+    let rollbackError;
+    try {
+      await methods.rollback();


We could use the toThrowError matcher here.

expect(methods.rollback).toThrowError('rollback'); // alternatively perform equality check against provided object expect(methods.rollback).toThrowError(new Error('rollback'));

This does not work very well as the error must implement Constructable

frontend/packages/kubevirt-plugin/src/k8s/wrapper/common/util/k8s-mixin.ts

frontend/packages/kubevirt-plugin/src/k8s/wrapper/utils/__tests__/utils.spec.ts

frontend/packages/kubevirt-plugin/src/k8s/wrapper/utils/utils.ts

vojtechszocs · 2020-03-11T15:39:26Z

frontend/packages/kubevirt-plugin/src/utils/common.ts

@@ -2,7 +2,16 @@ import * as _ from 'lodash';

 export const omitEmpty = (obj, justUndefined = false) => {


_.compact(array)

Creates an array with all falsey values removed. The values false, null, 0, "", undefined, and NaN are falsey.

vojtechszocs · 2020-03-11T15:41:30Z

frontend/packages/kubevirt-plugin/src/utils/common.ts

@@ -2,7 +2,16 @@ import * as _ from 'lodash';

 export const omitEmpty = (obj, justUndefined = false) => {


Alternatively, you could use _.remove or _.without.

atiratree · 2020-03-11T18:19:21Z

fixed

atiratree · 2020-03-11T18:19:31Z

/retest

- add k8sWrapperCreate method to EnhancedK8sMethods

atiratree · 2020-03-12T14:14:19Z

added deprecated statements to all initializeFromSimpleData functions

vojtechszocs · 2020-03-13T11:23:56Z

/lgtm

openshift-ci-robot · 2020-03-13T11:24:14Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: suomiy, vojtechszocs

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~frontend/packages/kubevirt-plugin/OWNERS~~ [suomiy,vojtechszocs]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Mar 9, 2020

openshift-ci-robot requested review from jelkosz and mareklibra March 9, 2020 16:42

openshift-ci-robot added the component/kubevirt Related to kubevirt-plugin label Mar 9, 2020

atiratree commented Mar 9, 2020

View reviewed changes

atiratree force-pushed the kubevirt.wizardRefactorTests branch from 129be38 to c4c4271 Compare March 9, 2020 17:04

glekner reviewed Mar 10, 2020

View reviewed changes

atiratree force-pushed the kubevirt.wizardRefactorTests branch from c4c4271 to 314004c Compare March 10, 2020 19:29

openshift-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Mar 10, 2020

atiratree closed this Mar 10, 2020

atiratree reopened this Mar 10, 2020

kubevirt: add tests for Wrappers, EnhancedK8sMethods and utility classes

60eb000

- fix bugs

atiratree force-pushed the kubevirt.wizardRefactorTests branch from 314004c to fc77dd6 Compare March 11, 2020 13:08

vojtechszocs suggested changes Mar 11, 2020

View reviewed changes

atiratree force-pushed the kubevirt.wizardRefactorTests branch from fc77dd6 to 1e224e5 Compare March 11, 2020 18:10

kubevirt: introduce init function to K8sWrappers

d4b54a4

- add k8sWrapperCreate method to EnhancedK8sMethods

atiratree force-pushed the kubevirt.wizardRefactorTests branch from 1e224e5 to d4b54a4 Compare March 11, 2020 18:24

kubevirt: add deprecated comments

1395842

openshift-ci-robot assigned vojtechszocs Mar 13, 2020

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 13, 2020

openshift-merge-robot merged commit 3e61f17 into openshift:master Mar 13, 2020

spadgett added this to the v4.5 milestone Mar 18, 2020

atiratree mentioned this pull request Mar 25, 2020

kubevirt: move and refactor v2v requests from kubevirt-web-ui-components #4750

Merged

		@@ -0,0 +1,85 @@
		import { ObjectEnum } from '../../../../../constants';

		@@ -2,7 +2,16 @@ import * as _ from 'lodash';

		export const omitEmpty = (obj, justUndefined = false) => {

	it('records history and shows actualState', async () => {
	it('records history', async () => {

	describe('enhancedK8sMethods.js', () => {
	describe('enhancedK8sMethods', () => {

kubevirt: add tests for Wrappers, EnhancedK8sMethods and utility classes #4696

kubevirt: add tests for Wrappers, EnhancedK8sMethods and utility classes #4696

Conversation

atiratree commented Mar 9, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

atiratree commented Mar 9, 2020

atiratree commented Mar 10, 2020

glekner left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

atiratree Mar 10, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

atiratree commented Mar 10, 2020

atiratree commented Mar 10, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

atiratree commented Mar 11, 2020

atiratree commented Mar 11, 2020

atiratree commented Mar 12, 2020

vojtechszocs commented Mar 13, 2020

openshift-ci-robot commented Mar 13, 2020

atiratree Mar 10, 2020 •

edited