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

Author: talik077

src/kube-scanner/index.ts

@@ -10,7 +10,7 @@ import { pullImages } from '../images';
 import { scanImages, IScanResult } from './image-scanner';
 import { deleteHomebaseWorkload, sendDepGraph } from '../transmitter';
 import { constructHomebaseDeleteWorkloadPayload, constructHomebaseWorkloadPayloads } from '../transmitter/payload';
-import { IDepGraphPayload, IKubeImage, ILocalWorkloadLocator } from '../transmitter/types';
+import { IDepGraphPayload, IWorkload, ILocalWorkloadLocator } from '../transmitter/types';
 
 export = class WorkloadWorker {
   private readonly name: string;
@@ -19,7 +19,7 @@ export = class WorkloadWorker {
     this.name = name;
   }
 
-  public async process(workloadMetadata: IKubeImage[]) {
+  public async process(workloadMetadata: IWorkload[]) {
     const workloadName = this.name;
     const allImages = workloadMetadata.map((meta) => meta.imageName);
     logger.info({workloadName, imageCount: allImages.length}, 'Queried workloads');

src/kube-scanner/metadata-extractor.ts

@@ -1,5 +1,5 @@
 import { V1OwnerReference, V1Pod, V1Container, V1ContainerStatus } from '@kubernetes/client-node';
-import { IKubeImage, ILocalWorkloadLocator } from '../transmitter/types';
+import { IWorkload, ILocalWorkloadLocator } from '../transmitter/types';
 import { currentClusterName } from './cluster';
 import { KubeObjectMetadata } from './types';
 import { getSupportedWorkload, getWorkloadReader } from './workload-reader';
@@ -12,7 +12,7 @@ const loopingThreshold = 20;
 export function buildImageMetadata(
   workloadMeta: KubeObjectMetadata,
   containerStatuses: V1ContainerStatus[],
-  ): IKubeImage[] {
+  ): IWorkload[] {
   const { kind, objectMeta, specMeta, containers } = workloadMeta;
   const { name, namespace, labels, annotations, uid } = objectMeta;
 
@@ -39,7 +39,7 @@ export function buildImageMetadata(
       imageName: containerNameToSpec[containerName].image,
       imageId: containerNameToStatus[containerName].imageID,
       cluster: currentClusterName,
-    } as IKubeImage),
+    } as IWorkload),
   );
   return images;
 }
@@ -88,7 +88,7 @@ export function buildWorkloadMetadata(kubernetesMetadata: KubeObjectMetadata): I
   };
 }
 
-export async function buildMetadataForWorkload(pod: V1Pod): Promise<IKubeImage[] | undefined> {
+export async function buildMetadataForWorkload(pod: V1Pod): Promise<IWorkload[] | undefined> {
   const isAssociatedWithParent = isPodAssociatedWithParent(pod);
 
   if (!pod.metadata || pod.metadata.namespace === undefined || !pod.spec) {

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

@@ -3,7 +3,7 @@ import async = require('async');
 import config = require('../../../common/config');
 import logger = require('../../../common/logger');
 import WorkloadWorker = require('../../../kube-scanner');
-import { IKubeImage } from '../../../transmitter/types';
+import { IWorkload } from '../../../transmitter/types';
 import { buildMetadataForWorkload } from '../../metadata-extractor';
 import { PodPhase } from '../types';
 import state = require('../../../state');
@@ -25,8 +25,8 @@ workloadsToScanQueue.error(function(err, task) {
   logger.error({err, task}, 'error processing a workload in the pod handler 1');
 });
 
-async function handleReadyPod(workloadWorker: WorkloadWorker, workloadMetadata: IKubeImage[]) {
-  const imagesToScan: IKubeImage[] = [];
+async function handleReadyPod(workloadWorker: WorkloadWorker, workloadMetadata: IWorkload[]) {
+  const imagesToScan: IWorkload[] = [];
   const imageKeys: string[] = [];
   for (const image of workloadMetadata) {
     const imageKey = `${image.namespace}/${image.type}/${image.name}/${image.imageId}`;

src/transmitter/payload.ts

@@ -1,16 +1,16 @@
 import config = require('../common/config');
 import { currentClusterName } from '../kube-scanner/cluster';
 import { IScanResult } from '../kube-scanner/image-scanner';
-import { IDeleteWorkloadPayload, IDepGraphPayload, IKubeImage, ILocalWorkloadLocator, IImageLocator } from './types';
+import { IDeleteWorkloadPayload, IDepGraphPayload, IWorkload, ILocalWorkloadLocator, IImageLocator } from './types';
 
 export function constructHomebaseWorkloadPayloads(
     scannedImages: IScanResult[],
-    workloadMetadata: IKubeImage[],
+    workloadMetadata: IWorkload[],
 ): IDepGraphPayload[] {
   const results = scannedImages.map((scannedImage) => {
-    const kubeImage: IKubeImage = workloadMetadata.find((meta) => meta.imageName === scannedImage.imageWithTag)!;
+    const kubeWorkload: IWorkload = workloadMetadata.find((meta) => meta.imageName === scannedImage.imageWithTag)!;
 
-    const { cluster, namespace, type, name } = kubeImage;
+    const { cluster, namespace, type, name } = kubeWorkload;
 
     const imageLocator: IImageLocator = {
       userLocator: config.INTEGRATION_ID,

src/transmitter/types.ts

@@ -32,15 +32,15 @@ export interface IDeleteWorkloadPayload {
   agentId: string;
 }
 
-export interface IKubeImage {
+export interface IWorkload {
   type: string;
   name: string;
   namespace: string;
   labels: StringMap | undefined;
-  annotations: StringMap  | undefined;
+  annotations: StringMap | undefined;
   uid: string;
-  specLabels: StringMap  | undefined;
-  specAnnotations: StringMap  | undefined;
+  specLabels: StringMap | undefined;
+  specAnnotations: StringMap | undefined;
   containerName: string;
   imageName: string;
   imageId: string;

test/unit/transmitter-payload.test.ts

@@ -18,7 +18,7 @@ tap.test('constructHomebaseWorkloadPayloads breaks when workloadMetadata is miss
     },
   ];
 
-  const workloadMetadata: transmitterTypes.IKubeImage[] = [
+  const workloadMetadata: transmitterTypes.IWorkload[] = [
     {
       type: 'type',
       name: 'workloadName',
@@ -48,7 +48,7 @@ tap.test('constructHomebaseWorkloadPayloads happy flow', async (t) => {
     },
   ];
 
-  const workloadMetadata: transmitterTypes.IKubeImage[] = [
+  const workloadMetadata: transmitterTypes.IWorkload[] = [
     {
       type: 'type',
       name: 'workloadName',