chore: rename KubeObjectMetadata to IKubeObjectMetadata

the convention for interface naming we use includes starting their name with a capital I.

Author: Shesekino

src/kube-scanner/metadata-extractor.ts

@@ -1,7 +1,7 @@
 import { V1OwnerReference, V1Pod, V1Container, V1ContainerStatus } from '@kubernetes/client-node';
 import { IWorkload, ILocalWorkloadLocator } from '../transmitter/types';
 import { currentClusterName } from './cluster';
-import { KubeObjectMetadata } from './types';
+import { IKubeObjectMetadata } from './types';
 import { getSupportedWorkload, getWorkloadReader } from './workload-reader';
 import logger = require('../common/logger');
 
@@ -10,7 +10,7 @@ const loopingThreshold = 20;
 // Constructs the workload metadata based on a variety of k8s properties.
 // https://www.notion.so/snyk/Kubernetes-workload-fields-we-should-collect-c60c8f0395f241978282173f4c133a34
 export function buildImageMetadata(
-  workloadMeta: KubeObjectMetadata,
+  workloadMeta: IKubeObjectMetadata,
   containerStatuses: V1ContainerStatus[],
   ): IWorkload[] {
   const { kind, objectMeta, specMeta, revision, podSpec } = workloadMeta;
@@ -49,9 +49,9 @@ export function buildImageMetadata(
 async function findParentWorkload(
   ownerRefs: V1OwnerReference[] | undefined,
   namespace: string,
-): Promise<KubeObjectMetadata | undefined> {
+): Promise<IKubeObjectMetadata | undefined> {
   let ownerReferences = ownerRefs;
-  let parentMetadata: KubeObjectMetadata | undefined;
+  let parentMetadata: IKubeObjectMetadata | undefined;
 
   for (let i = 0; i < loopingThreshold; i++) {
     // We are interested only in a subset of all workloads.
@@ -76,7 +76,7 @@ async function findParentWorkload(
   return undefined;
 }
 
-export function buildWorkloadMetadata(kubernetesMetadata: KubeObjectMetadata): ILocalWorkloadLocator {
+export function buildWorkloadMetadata(kubernetesMetadata: IKubeObjectMetadata): ILocalWorkloadLocator {
   if (!kubernetesMetadata.objectMeta ||
     kubernetesMetadata.objectMeta.namespace === undefined ||
     kubernetesMetadata.objectMeta.name === undefined) {
@@ -126,7 +126,7 @@ export async function buildMetadataForWorkload(pod: V1Pod): Promise<IWorkload[]
     );
   }
 
-  const podOwner: KubeObjectMetadata | undefined = await findParentWorkload(
+  const podOwner: IKubeObjectMetadata | undefined = await findParentWorkload(
     pod.metadata.ownerReferences, pod.metadata.namespace);
 
   return podOwner === undefined

src/kube-scanner/types.ts

@@ -32,7 +32,7 @@ export interface IStaticAnalysisOptions {
   tmpDirPath: string;
 }
 
-export interface KubeObjectMetadata {
+export interface IKubeObjectMetadata {
   kind: string;
   objectMeta: V1ObjectMeta;
   specMeta: V1ObjectMeta;

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

@@ -1,9 +1,9 @@
-import { KubeObjectMetadata } from '../../types';
+import { IKubeObjectMetadata } from '../../types';
 import { buildWorkloadMetadata } from '../../metadata-extractor';
 import WorkloadWorker = require('../..');
 import logger = require('../../../common/logger');
 
-export async function deleteWorkload(kubernetesMetadata: KubeObjectMetadata, workloadName: string): Promise<void> {
+export async function deleteWorkload(kubernetesMetadata: IKubeObjectMetadata, workloadName: string): Promise<void> {
   try {
     if (kubernetesMetadata.ownerRefs !== undefined && kubernetesMetadata.ownerRefs.length > 0) {
       return;

src/kube-scanner/workload-reader.ts

@@ -1,11 +1,11 @@
 import { V1OwnerReference } from '@kubernetes/client-node';
 import { k8sApi } from './cluster';
-import { KubeObjectMetadata, WorkloadKind } from './types';
+import { IKubeObjectMetadata, WorkloadKind } from './types';
 
 type IWorkloadReaderFunc = (
   workloadName: string,
   namespace: string,
-) => Promise<KubeObjectMetadata | undefined>;
+) => Promise<IKubeObjectMetadata | undefined>;
 
 const deploymentReader: IWorkloadReaderFunc = async (workloadName, namespace) => {
   const deploymentResult = await k8sApi.appsClient.readNamespacedDeployment(