Skip to content

Commit 84d3f93

Browse files
committed
chore: rename IKubeImage type
IKubeImage type name doesn't reflect the data it contains very well. the information is more about a workload rather than an image. Renaming it to IWorkload better describe the object it represents
1 parent 968b65b commit 84d3f93

File tree

6 files changed

+19
-19
lines changed

6 files changed

+19
-19
lines changed

src/kube-scanner/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { pullImages } from '../images';
1010
import { scanImages, IScanResult } from './image-scanner';
1111
import { deleteHomebaseWorkload, sendDepGraph } from '../transmitter';
1212
import { constructHomebaseDeleteWorkloadPayload, constructHomebaseWorkloadPayloads } from '../transmitter/payload';
13-
import { IDepGraphPayload, IKubeImage, ILocalWorkloadLocator } from '../transmitter/types';
13+
import { IDepGraphPayload, IWorkload, ILocalWorkloadLocator } from '../transmitter/types';
1414

1515
export = class WorkloadWorker {
1616
private readonly name: string;
@@ -19,7 +19,7 @@ export = class WorkloadWorker {
1919
this.name = name;
2020
}
2121

22-
public async process(workloadMetadata: IKubeImage[]) {
22+
public async process(workloadMetadata: IWorkload[]) {
2323
const workloadName = this.name;
2424
const allImages = workloadMetadata.map((meta) => meta.imageName);
2525
logger.info({workloadName, imageCount: allImages.length}, 'Queried workloads');

src/kube-scanner/metadata-extractor.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { V1OwnerReference, V1Pod, V1Container, V1ContainerStatus } from '@kubernetes/client-node';
2-
import { IKubeImage, ILocalWorkloadLocator } from '../transmitter/types';
2+
import { IWorkload, ILocalWorkloadLocator } from '../transmitter/types';
33
import { currentClusterName } from './cluster';
44
import { KubeObjectMetadata } from './types';
55
import { getSupportedWorkload, getWorkloadReader } from './workload-reader';
@@ -12,7 +12,7 @@ const loopingThreshold = 20;
1212
export function buildImageMetadata(
1313
workloadMeta: KubeObjectMetadata,
1414
containerStatuses: V1ContainerStatus[],
15-
): IKubeImage[] {
15+
): IWorkload[] {
1616
const { kind, objectMeta, specMeta, containers } = workloadMeta;
1717
const { name, namespace, labels, annotations, uid } = objectMeta;
1818

@@ -39,7 +39,7 @@ export function buildImageMetadata(
3939
imageName: containerNameToSpec[containerName].image,
4040
imageId: containerNameToStatus[containerName].imageID,
4141
cluster: currentClusterName,
42-
} as IKubeImage),
42+
} as IWorkload),
4343
);
4444
return images;
4545
}
@@ -88,7 +88,7 @@ export function buildWorkloadMetadata(kubernetesMetadata: KubeObjectMetadata): I
8888
};
8989
}
9090

91-
export async function buildMetadataForWorkload(pod: V1Pod): Promise<IKubeImage[] | undefined> {
91+
export async function buildMetadataForWorkload(pod: V1Pod): Promise<IWorkload[] | undefined> {
9292
const isAssociatedWithParent = isPodAssociatedWithParent(pod);
9393

9494
if (!pod.metadata || pod.metadata.namespace === undefined || !pod.spec) {

src/kube-scanner/watchers/handlers/pod.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import async = require('async');
33
import config = require('../../../common/config');
44
import logger = require('../../../common/logger');
55
import WorkloadWorker = require('../../../kube-scanner');
6-
import { IKubeImage } from '../../../transmitter/types';
6+
import { IWorkload } from '../../../transmitter/types';
77
import { buildMetadataForWorkload } from '../../metadata-extractor';
88
import { PodPhase } from '../types';
99
import state = require('../../../state');
@@ -25,8 +25,8 @@ workloadsToScanQueue.error(function(err, task) {
2525
logger.error({err, task}, 'error processing a workload in the pod handler 1');
2626
});
2727

28-
async function handleReadyPod(workloadWorker: WorkloadWorker, workloadMetadata: IKubeImage[]) {
29-
const imagesToScan: IKubeImage[] = [];
28+
async function handleReadyPod(workloadWorker: WorkloadWorker, workloadMetadata: IWorkload[]) {
29+
const imagesToScan: IWorkload[] = [];
3030
const imageKeys: string[] = [];
3131
for (const image of workloadMetadata) {
3232
const imageKey = `${image.namespace}/${image.type}/${image.name}/${image.imageId}`;

src/transmitter/payload.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
import config = require('../common/config');
22
import { currentClusterName } from '../kube-scanner/cluster';
33
import { IScanResult } from '../kube-scanner/image-scanner';
4-
import { IDeleteWorkloadPayload, IDepGraphPayload, IKubeImage, ILocalWorkloadLocator, IImageLocator } from './types';
4+
import { IDeleteWorkloadPayload, IDepGraphPayload, IWorkload, ILocalWorkloadLocator, IImageLocator } from './types';
55

66
export function constructHomebaseWorkloadPayloads(
77
scannedImages: IScanResult[],
8-
workloadMetadata: IKubeImage[],
8+
workloadMetadata: IWorkload[],
99
): IDepGraphPayload[] {
1010
const results = scannedImages.map((scannedImage) => {
11-
const kubeImage: IKubeImage = workloadMetadata.find((meta) => meta.imageName === scannedImage.imageWithTag)!;
11+
const kubeWorkload: IWorkload = workloadMetadata.find((meta) => meta.imageName === scannedImage.imageWithTag)!;
1212

13-
const { cluster, namespace, type, name } = kubeImage;
13+
const { cluster, namespace, type, name } = kubeWorkload;
1414

1515
const imageLocator: IImageLocator = {
1616
userLocator: config.INTEGRATION_ID,

src/transmitter/types.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ export interface IDeleteWorkloadPayload {
3232
agentId: string;
3333
}
3434

35-
export interface IKubeImage {
35+
export interface IWorkload {
3636
type: string;
3737
name: string;
3838
namespace: string;
3939
labels: StringMap | undefined;
40-
annotations: StringMap | undefined;
40+
annotations: StringMap | undefined;
4141
uid: string;
42-
specLabels: StringMap | undefined;
43-
specAnnotations: StringMap | undefined;
42+
specLabels: StringMap | undefined;
43+
specAnnotations: StringMap | undefined;
4444
containerName: string;
4545
imageName: string;
4646
imageId: string;

test/unit/transmitter-payload.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ tap.test('constructHomebaseWorkloadPayloads breaks when workloadMetadata is miss
1818
},
1919
];
2020

21-
const workloadMetadata: transmitterTypes.IKubeImage[] = [
21+
const workloadMetadata: transmitterTypes.IWorkload[] = [
2222
{
2323
type: 'type',
2424
name: 'workloadName',
@@ -48,7 +48,7 @@ tap.test('constructHomebaseWorkloadPayloads happy flow', async (t) => {
4848
},
4949
];
5050

51-
const workloadMetadata: transmitterTypes.IKubeImage[] = [
51+
const workloadMetadata: transmitterTypes.IWorkload[] = [
5252
{
5353
type: 'type',
5454
name: 'workloadName',

0 commit comments

Comments
 (0)