Skip to content

feat: include Job and CronJob pods in service pod lookup #204

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
vigneshrajsb merged 1 commit into from
May 8, 2026
+408 −27
Merged

feat: include Job and CronJob pods in service pod lookup #204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
299 changes: 299 additions & 0 deletions src/server/lib/kubernetes/__tests__/getDeploymentPods.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,27 @@

var mockListNamespacedDeployment: jest.Mock;
var mockListNamespacedStatefulSet: jest.Mock;
var mockListNamespacedJob: jest.Mock;
var mockListNamespacedCronJob: jest.Mock;
var mockListNamespacedPod: jest.Mock;
var mockBuildFindOne: jest.Mock;

jest.mock('@kubernetes/client-node', () => {
const actual = jest.requireActual('@kubernetes/client-node');
mockListNamespacedDeployment = jest.fn();
mockListNamespacedStatefulSet = jest.fn();
mockListNamespacedJob = jest.fn();
mockListNamespacedCronJob = jest.fn();
mockListNamespacedPod = jest.fn();

const appsClient = {
listNamespacedDeployment: mockListNamespacedDeployment,
listNamespacedStatefulSet: mockListNamespacedStatefulSet,
};
const batchClient = {
listNamespacedJob: mockListNamespacedJob,
listNamespacedCronJob: mockListNamespacedCronJob,
};
const coreClient = {
listNamespacedPod: mockListNamespacedPod,
};
Expand All @@ -43,6 +51,10 @@ jest.mock('@kubernetes/client-node', () => {
return appsClient;
}

if (client === actual.BatchV1Api) {
return batchClient;
}

if (client === actual.CoreV1Api) {
return coreClient;
}
Expand Down Expand Up @@ -113,6 +125,28 @@ function buildPod({
};
}

function buildJob({
name,
matchLabels = { 'batch.kubernetes.io/controller-uid': `${name}-uid` },
ownerReferences,
}: {
name: string;
matchLabels?: Record<string, string>;
ownerReferences?: Array<Record<string, unknown>>;
}) {
return {
metadata: {
name,
ownerReferences,
},
spec: {
selector: {
matchLabels,
},
},
};
}

describe('getDeploymentPods', () => {
beforeEach(() => {
jest.clearAllMocks();
Expand All @@ -139,6 +173,12 @@ describe('getDeploymentPods', () => {
mockListNamespacedStatefulSet.mockResolvedValue({
body: { items: [] },
});
mockListNamespacedJob.mockResolvedValue({
body: { items: [] },
});
mockListNamespacedCronJob.mockResolvedValue({
body: { items: [] },
});
});

it('filters terminated pods and keeps newest active pods first', async () => {
Expand Down Expand Up @@ -261,4 +301,263 @@ describe('getDeploymentPods', () => {

await expect(getDeploymentPods('sample-service', 'sample-env')).resolves.toEqual([]);
});

it('uses a StatefulSet selector when no Deployment exists', async () => {
mockListNamespacedDeployment.mockResolvedValue({
body: { items: [] },
});
mockListNamespacedStatefulSet.mockResolvedValue({
body: {
items: [
{
spec: {
selector: {
matchLabels: {
app: 'sample-stateful-service',
},
},
},
},
],
},
});
mockListNamespacedPod.mockResolvedValue({
body: {
items: [
buildPod({
name: 'stateful-active',
createdAt: '2026-03-27T19:00:00.000Z',
}),
],
},
});

const pods = await getDeploymentPods('sample-service', 'sample-env');

expect(pods.map((pod) => pod.podName)).toEqual(['stateful-active']);
expect(mockListNamespacedPod).toHaveBeenCalledWith(
'env-sample-env',
undefined,
undefined,
undefined,
undefined,
'app=sample-stateful-service'
);
expect(mockListNamespacedJob).not.toHaveBeenCalled();
});

it('falls back to Job pods and includes terminal job pods', async () => {
mockListNamespacedDeployment.mockResolvedValue({
body: { items: [] },
});
mockListNamespacedStatefulSet.mockResolvedValue({
body: { items: [] },
});
mockListNamespacedJob.mockResolvedValue({
body: {
items: [buildJob({ name: 'sample-service-job' })],
},
});
mockListNamespacedPod.mockResolvedValue({
body: {
items: [
buildPod({
name: 'job-succeeded',
createdAt: '2026-03-27T19:00:00.000Z',
phase: 'Succeeded',
containerStatuses: [
{
name: 'app',
ready: false,
restartCount: 0,
state: { terminated: { reason: 'Completed' } },
},
],
}),
buildPod({
name: 'job-failed',
createdAt: '2026-03-27T18:00:00.000Z',
phase: 'Failed',
containerStatuses: [
{
name: 'app',
ready: false,
restartCount: 1,
state: { terminated: { reason: 'Error' } },
},
],
}),
buildPod({
name: 'job-deleting',
createdAt: '2026-03-27T17:00:00.000Z',
deletionTimestamp: '2026-03-27T19:01:00.000Z',
}),
],
},
});

const pods = await getDeploymentPods('sample-service', 'sample-env');

expect(pods.map((pod) => pod.podName)).toEqual(['job-succeeded', 'job-failed']);
expect(pods.map((pod) => pod.status)).toEqual(['Completed', 'Error']);
expect(mockListNamespacedJob).toHaveBeenCalledWith(
'env-sample-env',
undefined,
undefined,
undefined,
undefined,
'app.kubernetes.io/instance=sample-service-sample-env'
);
expect(mockListNamespacedPod).toHaveBeenCalledWith(
'env-sample-env',
undefined,
undefined,
undefined,
undefined,
'batch.kubernetes.io/controller-uid=sample-service-job-uid'
);
});

it('falls back to job-name when a Job selector is unavailable', async () => {
mockListNamespacedDeployment.mockResolvedValue({
body: { items: [] },
});
mockListNamespacedStatefulSet.mockResolvedValue({
body: { items: [] },
});
mockListNamespacedJob.mockResolvedValue({
body: {
items: [
{
metadata: {
name: 'sample-service-job',
},
},
],
},
});
mockListNamespacedPod.mockResolvedValue({
body: {
items: [
buildPod({
name: 'job-active',
createdAt: '2026-03-27T19:00:00.000Z',
}),
],
},
});

await getDeploymentPods('sample-service', 'sample-env');

expect(mockListNamespacedPod).toHaveBeenCalledWith(
'env-sample-env',
undefined,
undefined,
undefined,
undefined,
'job-name=sample-service-job'
);
});

it('returns CronJob child Job pods when no direct workload exists', async () => {
mockListNamespacedDeployment.mockResolvedValue({
body: { items: [] },
});
mockListNamespacedStatefulSet.mockResolvedValue({
body: { items: [] },
});
mockListNamespacedCronJob.mockResolvedValue({
body: {
items: [
{
metadata: {
name: 'sample-service-cron',
uid: 'cron-uid',
},
},
],
},
});
mockListNamespacedJob
.mockResolvedValueOnce({
body: { items: [] },
})
.mockResolvedValueOnce({
body: {
items: [
buildJob({
name: 'sample-service-cron-123',
ownerReferences: [
{
kind: 'CronJob',
name: 'sample-service-cron',
uid: 'cron-uid',
},
],
}),
buildJob({
name: 'unrelated-job',
ownerReferences: [
{
kind: 'CronJob',
name: 'unrelated-cron',
uid: 'unrelated-uid',
},
],
}),
],
},
});
mockListNamespacedPod.mockResolvedValue({
body: {
items: [
buildPod({
name: 'cronjob-succeeded',
createdAt: '2026-03-27T19:00:00.000Z',
phase: 'Succeeded',
containerStatuses: [
{
name: 'app',
ready: false,
restartCount: 0,
state: { terminated: { reason: 'Completed' } },
},
],
}),
],
},
});

const pods = await getDeploymentPods('sample-service', 'sample-env');

expect(pods.map((pod) => pod.podName)).toEqual(['cronjob-succeeded']);
expect(mockListNamespacedCronJob).toHaveBeenCalledWith(
'env-sample-env',
undefined,
undefined,
undefined,
undefined,
'app.kubernetes.io/instance=sample-service-sample-env'
);
expect(mockListNamespacedJob).toHaveBeenLastCalledWith('env-sample-env');
expect(mockListNamespacedPod).toHaveBeenCalledWith(
'env-sample-env',
undefined,
undefined,
undefined,
undefined,
'batch.kubernetes.io/controller-uid=sample-service-cron-123-uid'
);
});

it('returns an empty list when no supported workload exists', async () => {
mockListNamespacedDeployment.mockResolvedValue({
body: { items: [] },
});
mockListNamespacedStatefulSet.mockResolvedValue({
body: { items: [] },
});

await expect(getDeploymentPods('sample-service', 'sample-env')).resolves.toEqual([]);
});
});
Loading
Loading