Merge pull request #398 from snyk/chore/transmitter-payload

Chore/transmitter payload

Author: ivanstanev

src/scanner/index.ts

@@ -1,7 +1,7 @@
 import logger = require('../common/logger');
 import { pullImages, removePulledImages, getImagesWithFileSystemPath, scanImages } from './images';
 import { deleteWorkload, sendDepGraph } from '../transmitter';
-import { constructDeleteWorkloadPayload, constructDepGraph } from '../transmitter/payload';
+import { constructDeleteWorkload, constructDepGraph } from '../transmitter/payload';
 import { IWorkload, ILocalWorkloadLocator } from '../transmitter/types';
 import { IPullableImage } from './images/types';
 
@@ -35,7 +35,7 @@ export = class WorkloadWorker {
 
   // TODO: should be extracted from here and moved to the supervisor
   public async delete(localWorkloadLocator: ILocalWorkloadLocator): Promise<void> {
-    const deletePayload = constructDeleteWorkloadPayload(localWorkloadLocator);
+    const deletePayload = constructDeleteWorkload(localWorkloadLocator);
     logger.info({workloadName: this.name, workload: localWorkloadLocator},
       'removing workloads from upstream');
     await deleteWorkload(deletePayload);

src/supervisor/watchers/handlers/pod.ts

@@ -5,7 +5,7 @@ import logger = require('../../../common/logger');
 import WorkloadWorker = require('../../../scanner');
 import { sendWorkloadMetadata } from '../../../transmitter';
 import { IWorkload } from '../../../transmitter/types';
-import { constructWorkloadMetadataPayload } from '../../../transmitter/payload';
+import { constructWorkloadMetadata } 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 = constructWorkloadMetadataPayload(workloadMember);
+    const workloadMetadataPayload = constructWorkloadMetadata(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/payload.ts

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

test/unit/transmitter-payload.test.ts

@@ -104,7 +104,7 @@ tap.test('constructDepGraph happy flow', async (t) => {
   config.MONITOR_VERSION = backups.version;
 });
 
-tap.test('constructWorkloadMetadataPayload happy flow', async (t) => {
+tap.test('constructWorkloadMetadata happy flow', async (t) => {
   const workloadWithImages: transmitterTypes.IWorkload = {
     type: 'type',
     name: 'workloadName',
@@ -122,7 +122,7 @@ tap.test('constructWorkloadMetadataPayload happy flow', async (t) => {
     podSpec: podSpecFixture,
   };
 
-  const workloadMetadataPayload = payload.constructWorkloadMetadataPayload(workloadWithImages);
+  const workloadMetadataPayload = payload.constructWorkloadMetadata(workloadWithImages);
 
   t.equals(workloadMetadataPayload.workloadLocator.cluster, 'grapefruit', 'cluster present in payload');
   t.equals(workloadMetadataPayload.workloadLocator.namespace, 'spacename', 'image ID present in payload');
@@ -139,3 +139,22 @@ tap.test('constructWorkloadMetadataPayload happy flow', async (t) => {
   t.ok('labels' in workloadMetadataPayload.workloadMetadata, 'labels present in metadata');
   t.ok('specLabels' in workloadMetadataPayload.workloadMetadata, 'specLabels present in metadata');
 });
+
+tap.test('constructDeleteWorkload happy flow', async (t) => {
+  const localWorkloadLocator: transmitterTypes.ILocalWorkloadLocator = {
+    name: 'wl-name',
+    namespace: 'wl-namespace',
+    type: 'wl-type'
+  };
+  const deleteWorkloadPayload = payload.constructDeleteWorkload(localWorkloadLocator);
+
+  t.ok('workloadLocator' in deleteWorkloadPayload, 'workloadLocator present in payload');
+  t.ok('agentId' in deleteWorkloadPayload, 'agentId present in payload');
+
+  t.ok('userLocator' in deleteWorkloadPayload.workloadLocator, 'userLocator present in workloadLocator');
+  t.ok('cluster' in deleteWorkloadPayload.workloadLocator, 'cluster present in workloadLocator');
+
+  t.equals(deleteWorkloadPayload.workloadLocator.name, 'wl-name', 'matched workload name');
+  t.equals(deleteWorkloadPayload.workloadLocator.namespace, 'wl-namespace', 'matched workload namespace');
+  t.equals(deleteWorkloadPayload.workloadLocator.type, 'wl-type', 'matched workload type');
+});