Skip to content

Add testing for /readyz #2277

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 27, 2025
+151 −139
Merged

Add testing for /readyz #2277

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ff211d
Add testing for /readyz
brendandburns Feb 27, 2025
c11fd97
Address comment.
brendandburns Feb 27, 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
5 changes: 3 additions & 2 deletions src/health.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,9 @@ export class Health {
return this.healthz(opts);
}
return false;
} catch (err: unknown) {
if (err instanceof Error && err.name === 'AbortError') {
} catch (err: any) {
console.log(err);
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you please remove this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So embarrassing to leave debug printfs in the code!

done.

if (err.name === 'AbortError') {
throw err;
}
throw new Error('Error occurred in health request');
Expand Down
286 changes: 149 additions & 137 deletions src/health_test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,145 +4,157 @@ import nock from 'nock';
import { KubeConfig } from './config.js';
import { Health } from './health.js';
import { Cluster, User } from './config_types.js';
import { RequestOptions } from 'node:https';

describe('Health', () => {
describe('livez', () => {
it('should throw an error if no current active cluster', async () => {
const kc = new KubeConfig();
const health = new Health(kc);
await rejects(health.livez({}), { message: 'No currently active cluster' });
});

it('should return true if /livez returns with status 200', async () => {
const kc = new KubeConfig();
const cluster = {
name: 'foo',
server: 'https://server.com',
} as Cluster;

const user = {
name: 'my-user',
password: 'some-password',
} as User;
kc.loadFromClusterAndUser(cluster, user);

const scope = nock('https://server.com').get('/livez').reply(200);
const health = new Health(kc);

const r = await health.livez({});
strictEqual(r, true);
scope.done();
});

it('should return false if /livez returns with status 500', async () => {
const kc = new KubeConfig();
const cluster = {
name: 'foo',
server: 'https://server.com',
} as Cluster;

const user = {
name: 'my-user',
password: 'some-password',
} as User;
kc.loadFromClusterAndUser(cluster, user);

const scope = nock('https://server.com').get('/livez').reply(500);
const health = new Health(kc);

const r = await health.livez({});
strictEqual(r, false);
scope.done();
});

it('should return true if /livez returns status 404 and /healthz returns status 200', async () => {
const kc = new KubeConfig();
const cluster = {
name: 'foo',
server: 'https://server.com',
} as Cluster;

const user = {
name: 'my-user',
password: 'some-password',
} as User;
kc.loadFromClusterAndUser(cluster, user);

const scope = nock('https://server.com');
scope.get('/livez').reply(404);
scope.get('/healthz').reply(200);
const health = new Health(kc);

const r = await health.livez({});
strictEqual(r, true);
scope.done();
});

it('should return false if /livez returns status 404 and /healthz returns status 500', async () => {
const kc = new KubeConfig();
const cluster = {
name: 'foo',
server: 'https://server.com',
} as Cluster;

const user = {
name: 'my-user',
password: 'some-password',
} as User;
kc.loadFromClusterAndUser(cluster, user);

const scope = nock('https://server.com');
scope.get('/livez').reply(404);
scope.get('/healthz').reply(500);
const health = new Health(kc);

const r = await health.livez({});
strictEqual(r, false);
scope.done();
});

it('should return true if both /livez and /healthz return status 404', async () => {
const kc = new KubeConfig();
const cluster = {
name: 'foo',
server: 'https://server.com',
} as Cluster;

const user = {
name: 'my-user',
password: 'some-password',
} as User;
kc.loadFromClusterAndUser(cluster, user);

const scope = nock('https://server.com');
scope.get('/livez').reply(404);
scope.get('/healthz').reply(200);
const health = new Health(kc);

const r = await health.livez({});
strictEqual(r, true);
scope.done();
});

it('should throw an error when fetch throws an error', async () => {
const kc = new KubeConfig();
const cluster = {
name: 'foo',
server: 'https://server.com',
} as Cluster;

const user = {
name: 'my-user',
password: 'some-password',
} as User;
kc.loadFromClusterAndUser(cluster, user);

const scope = nock('https://server.com');
scope.get('/livez').replyWithError(new Error('an error'));
const health = new Health(kc);

await rejects(health.livez({}), { message: 'Error occurred in health request' });
scope.done();
[
{
path: '/livez',
method: async (health: Health, opts: RequestOptions) => health.livez(opts),
},
{
path: '/readyz',
method: async (health: Health, opts: RequestOptions) => health.readyz(opts),
},
].forEach((test) => {
describe(test.path, () => {
it('should throw an error if no current active cluster', async () => {
const kc = new KubeConfig();
const health = new Health(kc);
await rejects(test.method(health, {}), { message: 'No currently active cluster' });
});

it(`should return true if ${test.path} returns with status 200`, async () => {
const kc = new KubeConfig();
const cluster = {
name: 'foo',
server: 'https://server.com',
} as Cluster;

const user = {
name: 'my-user',
password: 'some-password',
} as User;
kc.loadFromClusterAndUser(cluster, user);

const scope = nock('https://server.com').get(test.path).reply(200);
const health = new Health(kc);

const r = await test.method(health, {});
strictEqual(r, true);
scope.done();
});

it(`should return false if ${test.path} returns with status 500`, async () => {
const kc = new KubeConfig();
const cluster = {
name: 'foo',
server: 'https://server.com',
} as Cluster;

const user = {
name: 'my-user',
password: 'some-password',
} as User;
kc.loadFromClusterAndUser(cluster, user);

const scope = nock('https://server.com').get(test.path).reply(500);
const health = new Health(kc);

const r = await test.method(health, {});
strictEqual(r, false);
scope.done();
});

it(`should return true if ${test.path} returns status 404 and /healthz returns status 200`, async () => {
const kc = new KubeConfig();
const cluster = {
name: 'foo',
server: 'https://server.com',
} as Cluster;

const user = {
name: 'my-user',
password: 'some-password',
} as User;
kc.loadFromClusterAndUser(cluster, user);

const scope = nock('https://server.com');
scope.get(test.path).reply(404);
scope.get('/healthz').reply(200);
const health = new Health(kc);

const r = await test.method(health, {});
strictEqual(r, true);
scope.done();
});

it(`should return false if ${test.path} returns status 404 and /healthz returns status 500`, async () => {
const kc = new KubeConfig();
const cluster = {
name: 'foo',
server: 'https://server.com',
} as Cluster;

const user = {
name: 'my-user',
password: 'some-password',
} as User;
kc.loadFromClusterAndUser(cluster, user);

const scope = nock('https://server.com');
scope.get(test.path).reply(404);
scope.get('/healthz').reply(500);
const health = new Health(kc);

const r = await test.method(health, {});
strictEqual(r, false);
scope.done();
});

it(`should return true if both ${test.path} and /healthz return status 404`, async () => {
const kc = new KubeConfig();
const cluster = {
name: 'foo',
server: 'https://server.com',
} as Cluster;

const user = {
name: 'my-user',
password: 'some-password',
} as User;
kc.loadFromClusterAndUser(cluster, user);

const scope = nock('https://server.com');
scope.get(test.path).reply(404);
scope.get('/healthz').reply(404);
const health = new Health(kc);

const r = await test.method(health, {});
strictEqual(r, true);
scope.done();
});

it('should throw an error when fetch throws an error', async () => {
const kc = new KubeConfig();
const cluster = {
name: 'foo',
server: 'https://server.com',
} as Cluster;

const user = {
name: 'my-user',
password: 'some-password',
} as User;
kc.loadFromClusterAndUser(cluster, user);

const scope = nock('https://server.com');
scope.get(test.path).replyWithError(new Error('an error'));
const health = new Health(kc);

await rejects(test.method(health, {}), { message: 'Error occurred in health request' });
scope.done();
});
});
});
});