Skip to content

Improve coverage for cache.ts #2231

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 23, 2025
Merged

Improve coverage for cache.ts #2231

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa658d2
Improve coverage for cache.ts
brendandburns Feb 14, 2025
85e1d2c
Address comments
brendandburns Feb 22, 2025
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
145 changes: 138 additions & 7 deletions src/cache_test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { deepStrictEqual, notStrictEqual, strictEqual, throws } from 'node:assert';
import { deepStrictEqual, deepEqual, fail, notStrictEqual, strictEqual, throws } from 'node:assert';
import mock from 'ts-mockito';

import { V1Namespace, V1NamespaceList, V1ObjectMeta, V1Pod, V1PodList, V1ListMeta } from './api.js';
Expand Down Expand Up @@ -244,11 +244,20 @@ describe('ListWatchCache', () => {
} as V1ObjectMeta,
} as V1Namespace);

watchHandler('DELETED', {
metadata: {
name: 'name2',
} as V1ObjectMeta,
} as V1Namespace);
watchHandler(
'DELETED',
{
metadata: {
name: 'name2',
resourceVersion: 'blah',
} as V1ObjectMeta,
} as V1Namespace,
{
metadata: {
resourceVersion: '54321',
},
},
);

const [addResult, updateResult, deleteResult] = await Promise.all([
addPromise,
Expand All @@ -257,7 +266,19 @@ describe('ListWatchCache', () => {
]);
deepStrictEqual(addResult.metadata, { name: 'name3' });
deepStrictEqual(updateResult.metadata, { name: 'name3', resourceVersion: 'baz' });
deepStrictEqual(deleteResult.metadata, { name: 'name2' });
deepStrictEqual(deleteResult.metadata, { name: 'name2', resourceVersion: 'blah' });
strictEqual(informer.latestResourceVersion(), '54321');

watchHandler(
'BOOKMARK',
{},
{
metadata: {
resourceVersion: '5454',
},
},
);
strictEqual(informer.latestResourceVersion(), '5454');
});

it('should handle change events correctly', async () => {
Expand Down Expand Up @@ -789,6 +810,116 @@ describe('ListWatchCache', () => {
strictEqual(addedList2.length, 1);
});

it('should unregister three verbs on "change"', async () => {
const fakeWatch = mock.mock(Watch);
const list: V1Namespace[] = [];
const listObj = {
metadata: {
resourceVersion: '12345',
} as V1ListMeta,
items: list,
} as V1NamespaceList;
const listFn: ListPromise<V1Namespace> = function (): Promise<V1NamespaceList> {
return new Promise<V1NamespaceList>((resolve) => {
resolve(listObj);
});
};
const watchCalled = new Promise((resolve) => {
mock.when(
fakeWatch.watch(mock.anything(), mock.anything(), mock.anything(), mock.anything()),
).thenCall(resolve);
});
const informer = new ListWatch('/some/path', mock.instance(fakeWatch), listFn);

const changeList1: V1Namespace[] = [];
const changeToList1Fn = function (obj?: V1Namespace) {
changeList1.push(obj!);
};
const changeList2: V1Namespace[] = [];
const changeToList2Fn = function (obj?: V1Namespace) {
changeList2.push(obj!);
};

informer.start();

await watchCalled;
const [, , watchHandler] = mock.capture(fakeWatch.watch).last();

informer.on('change', changeToList1Fn);
informer.on('change', changeToList2Fn);

['ADDED', 'DELETED', 'MODIFIED'].forEach((verb) => {
watchHandler(verb, {
metadata: {
name: 'name1',
} as V1ObjectMeta,
} as V1Namespace);
});
strictEqual(changeList1.length, 3);
strictEqual(changeList2.length, 3);

informer.off('change', changeToList2Fn);

['ADDED', 'DELETED', 'MODIFIED'].forEach((verb) => {
watchHandler(verb, {
metadata: {
name: 'name2',
} as V1ObjectMeta,
} as V1Namespace);
});

strictEqual(changeList1.length, 6);
strictEqual(changeList2.length, 3);
});

it('should throw on unknown verbs', async () => {
const fakeWatch = mock.mock(Watch);
const list: V1Namespace[] = [];
const listObj = {
metadata: {
resourceVersion: '12345',
} as V1ListMeta,
items: list,
} as V1NamespaceList;
const listFn: ListPromise<V1Namespace> = function (): Promise<V1NamespaceList> {
return new Promise<V1NamespaceList>((resolve) => {
resolve(listObj);
});
};
const informer = new ListWatch('/some/path', mock.instance(fakeWatch), listFn);
try {
informer.on('random' as any /* trick Typescript to allow this */, (obj) => {});
fail('Unexpected lack of exception');
} catch (err) {
deepEqual(err, Error('Unknown verb: random'));
}
try {
informer.off('random' as any /* trick Typescript to allow this */, (obj) => {});
fail('Unexpected lack of exception');
} catch (err) {
deepEqual(err, Error('Unknown verb: random'));
}
Copy link
Contributor

Choose a reason for hiding this comment

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

I think instead of try...catch + fail(), we want assert.throws() here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done.

});

it('should handle off with callbacks that are not registered', async () => {
const fakeWatch = mock.mock(Watch);
const list: V1Namespace[] = [];
const listObj = {
metadata: {
resourceVersion: '12345',
} as V1ListMeta,
items: list,
} as V1NamespaceList;
const listFn: ListPromise<V1Namespace> = function (): Promise<V1NamespaceList> {
return new Promise<V1NamespaceList>((resolve) => {
resolve(listObj);
});
};
const informer = new ListWatch('/some/path', mock.instance(fakeWatch), listFn);
informer.off('add', (obj) => {});
// No assertion because we're just looking to see if it throws.
});

it('mutating handlers in a callback should not affect those which remain', async () => {
const fakeWatch = mock.mock(Watch);
const list: V1Namespace[] = [];
Expand Down
Loading