Merge pull request #271 from snyk/chore/stop-referencing-homebase

fix: removing more references to Homebase

Author: Amir Moualem

src/kube-scanner/index.ts

@@ -1,8 +1,8 @@
 import logger = require('../common/logger');
 import { pullImages, removePulledImages, getImagesWithFileSystemPath } from '../images';
 import { scanImages } from './image';
-import { deleteHomebaseWorkload, sendDepGraph } from '../transmitter';
-import { constructHomebaseDeleteWorkloadPayload, constructDepGraph } from '../transmitter/payload';
+import { deleteWorkload, sendDepGraph } from '../transmitter';
+import { constructDeleteWorkloadPayload, constructDepGraph } from '../transmitter/payload';
 import { IWorkload, ILocalWorkloadLocator } from '../transmitter/types';
 import { IPullableImage } from '../images/types';
 
@@ -35,10 +35,10 @@ export = class WorkloadWorker {
   }
 
   public async delete(localWorkloadLocator: ILocalWorkloadLocator): Promise<void> {
-    const deletePayload = constructHomebaseDeleteWorkloadPayload(localWorkloadLocator);
+    const deletePayload = constructDeleteWorkloadPayload(localWorkloadLocator);
     logger.info({workloadName: this.name, workload: localWorkloadLocator},
-      'removing workloads from homebase');
-    await deleteHomebaseWorkload(deletePayload);
+      'removing workloads from upstream');
+    await deleteWorkload(deletePayload);
   }
 
   private async scanImagesAndSendResults(

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

@@ -5,7 +5,7 @@ import logger = require('../../../common/logger');
 import WorkloadWorker = require('../../../kube-scanner');
 import { sendWorkloadMetadata } from '../../../transmitter';
 import { IWorkload } from '../../../transmitter/types';
-import { constructHomebaseWorkloadMetadataPayload } from '../../../transmitter/payload';
+import { constructWorkloadMetadataPayload } from '../../../transmitter/payload';
 import { buildMetadataForWorkload } from '../../metadata-extractor';
 import { PodPhase } from '../types';
 import state = require('../../../state');
@@ -97,7 +97,7 @@ export async function podWatchHandler(pod: V1Pod): Promise<void> {
 
     // every element contains the workload information, so we can get it from the first one
     const workloadMember = workloadMetadata[0];
-    const workloadMetadataPayload = constructHomebaseWorkloadMetadataPayload(workloadMember);
+    const workloadMetadataPayload = constructWorkloadMetadataPayload(workloadMember);
     const workloadLocator = workloadMetadataPayload.workloadLocator;
     const workloadKey = `${workloadLocator.namespace}/${workloadLocator.type}/${workloadLocator.name}`;
     const workloadRevision = workloadMember.revision ? workloadMember.revision.toString() : ''; // this is actually the observed generation

src/transmitter/index.ts

@@ -20,7 +20,7 @@ export async function sendDepGraph(...payloads: IDepGraphPayload[]): Promise<voi
         logger.info({payload: payloadWithoutDepGraph, attempt}, 'dependency graph sent upstream successfully');
       }
     } catch (error) {
-      logger.error({error, payload: payloadWithoutDepGraph}, 'could not send the dependency scan result to Homebase');
+      logger.error({error, payload: payloadWithoutDepGraph}, 'could not send the dependency scan result upstream');
     }
   }
 }
@@ -36,15 +36,16 @@ export async function sendWorkloadMetadata(payload: IWorkloadMetadataPayload): P
         logger.info({workloadLocator: payload.workloadLocator, attempt}, 'workload metadata sent upstream successfully');
       }
     } catch (error) {
-      logger.error({error, workloadLocator: payload.workloadLocator}, 'could not send workload metadata to Homebase');
+      logger.error({error, workloadLocator: payload.workloadLocator}, 'could not send workload metadata upstream');
     }
 }
 
-export async function deleteHomebaseWorkload(payload: IDeleteWorkloadPayload): Promise<void> {
+export async function deleteWorkload(payload: IDeleteWorkloadPayload): Promise<void> {
   try {
     const {response, attempt} = await retryRequest('delete', `${upstreamUrl}/api/v1/workload`, payload);
     if (response.statusCode === 404) {
-      const msg = 'attempted to delete a workload Homebase could not find, maybe we are still building it?';
+      // TODO: maybe we're still building it?
+      const msg = 'attempted to delete a workload the Upstream service could not find';
       logger.info({payload}, msg);
       return;
     }
@@ -54,7 +55,7 @@ export async function deleteHomebaseWorkload(payload: IDeleteWorkloadPayload): P
       logger.info({workloadLocator: payload.workloadLocator, attempt}, 'workload deleted successfully');
     }
   } catch (error) {
-    logger.error({error, payload}, 'could not send workload to delete to Homebase');
+    logger.error({error, payload}, 'could not send delete a workload from the upstream');
   }
 }
 

src/transmitter/payload.ts

@@ -50,7 +50,7 @@ export function constructDepGraph(
   return results;
 }
 
-export function constructHomebaseWorkloadMetadataPayload(workload: IWorkload): IWorkloadMetadataPayload {
+export function constructWorkloadMetadataPayload(workload: IWorkload): IWorkloadMetadataPayload {
   if (!workload) {
     throw new Error('can\'t build workload metadata payload for undefined workload');
   }
@@ -73,7 +73,7 @@ export function constructHomebaseWorkloadMetadataPayload(workload: IWorkload): I
   return { workloadLocator, agentId: config.AGENT_ID, workloadMetadata };
 }
 
-export function constructHomebaseDeleteWorkloadPayload(
+export function constructDeleteWorkloadPayload(
   localWorkloadLocator: ILocalWorkloadLocator,
 ): IDeleteWorkloadPayload {
   return {

test/unit/transmitter-payload.test.ts

@@ -82,7 +82,7 @@ tap.test('constructDepGraph happy flow', async (t) => {
 
   const payloads = payload.constructDepGraph(scannedImages, workloadMetadata);
 
-  t.equals(payloads.length, 1, 'one payload to send to Homebase');
+  t.equals(payloads.length, 1, 'one payload to send upstream');
   const firstPayload = payloads[0];
   t.equals(firstPayload.dependencyGraph, JSON.stringify('whatever1'), 'dependency graph present in payload');
   t.equals(firstPayload.imageLocator.cluster, 'grapefruit', 'cluster present in payload');
@@ -104,7 +104,7 @@ tap.test('constructDepGraph happy flow', async (t) => {
   config.MONITOR_VERSION = backups.version;
 });
 
-tap.test('constructHomebaseWorkloadMetadataPayload happy flow', async (t) => {
+tap.test('constructWorkloadMetadataPayload happy flow', async (t) => {
   const workloadWithImages: transmitterTypes.IWorkload = {
     type: 'type',
     name: 'workloadName',
@@ -122,7 +122,7 @@ tap.test('constructHomebaseWorkloadMetadataPayload happy flow', async (t) => {
     podSpec: podSpecFixture,
   };
 
-  const workloadMetadataPayload = payload.constructHomebaseWorkloadMetadataPayload(workloadWithImages);
+  const workloadMetadataPayload = payload.constructWorkloadMetadataPayload(workloadWithImages);
 
   t.equals(workloadMetadataPayload.workloadLocator.cluster, 'grapefruit', 'cluster present in payload');
   t.equals(workloadMetadataPayload.workloadLocator.namespace, 'spacename', 'image ID present in payload');