Merge pull request #771 from snyk/feat/rename_workload_events_policy

[RUN-1559] Rename workload-auto-import policy to workload-events

Author: KatieArmstr

src/common/policy.ts

@@ -3,31 +3,31 @@ import { resolve as resolvePath } from 'path';
 import { promisify } from 'util';
 
 import { logger } from './logger';
-import { constructWorkloadAutoImportPolicy } from '../transmitter/payload';
-import { sendWorkloadAutoImportPolicy } from '../transmitter';
+import { constructWorkloadEventsPolicy } from '../transmitter/payload';
+import { sendWorkloadEventsPolicy } from '../transmitter';
 import { config } from './config';
 
 const readFileAsync = promisify(readFile);
 
-export async function loadAndSendWorkloadAutoImportPolicy(): Promise<void> {
+export async function loadAndSendWorkloadEventsPolicy(): Promise<void> {
   try {
     /** This path is set in snyk-monitor during installation/deployment and is defined in the Helm chart. */
     const userProvidedRegoPolicyPath = resolvePath(
       config.POLICIES_STORAGE_ROOT,
-      'workload-auto-import.rego',
+      'workload-events.rego',
     );
     if (!existsSync(userProvidedRegoPolicyPath)) {
       logger.info({}, 'Rego policy file does not exist, skipping loading');
       return;
     }
 
     const regoPolicy = await readFileAsync(userProvidedRegoPolicyPath, 'utf8');
-    const payload = constructWorkloadAutoImportPolicy(regoPolicy);
-    await sendWorkloadAutoImportPolicy(payload);
+    const payload = constructWorkloadEventsPolicy(regoPolicy);
+    await sendWorkloadEventsPolicy(payload);
   } catch (err) {
     logger.error(
       { err },
-      'Unexpected error occurred while loading workload auto-import policy',
+      'Unexpected error occurred while loading workload events policy',
     );
   }
 }

src/index.ts

@@ -7,7 +7,7 @@ import { config } from './common/config';
 import { logger } from './common/logger';
 import { currentClusterName } from './supervisor/cluster';
 import { beginWatchingWorkloads } from './supervisor/watchers';
-import { loadAndSendWorkloadAutoImportPolicy } from './common/policy';
+import { loadAndSendWorkloadEventsPolicy } from './common/policy';
 
 process.on('uncaughtException', (err) => {
   if (state.shutdownInProgress) {
@@ -62,6 +62,6 @@ cleanUpTempStorage();
 
 // Allow running in an async context
 setImmediate(async function setUpAndMonitor(): Promise<void> {
-  await loadAndSendWorkloadAutoImportPolicy();
+  await loadAndSendWorkloadEventsPolicy();
   await monitor();
 });

src/transmitter/index.ts

@@ -15,7 +15,7 @@ import {
   IRequestError,
   ScanResultsPayload,
   IDependencyGraphPayload,
-  WorkloadAutoImportPolicyPayload,
+  WorkloadEventsPolicyPayload,
 } from './types';
 import { getProxyAgent } from './proxy';
 
@@ -147,8 +147,8 @@ export async function sendWorkloadMetadata(
   }
 }
 
-export async function sendWorkloadAutoImportPolicy(
-  payload: WorkloadAutoImportPolicyPayload,
+export async function sendWorkloadEventsPolicy(
+  payload: WorkloadEventsPolicyPayload,
 ): Promise<void> {
   try {
     logger.info(

src/transmitter/payload.ts

@@ -12,7 +12,7 @@ import {
   IKubernetesMonitorMetadata,
   ScanResultsPayload,
   IDependencyGraphPayload,
-  WorkloadAutoImportPolicyPayload,
+  WorkloadEventsPolicyPayload,
 } from './types';
 
 export function constructDepGraph(
@@ -135,9 +135,9 @@ export function constructDeleteWorkload(
   };
 }
 
-export function constructWorkloadAutoImportPolicy(
+export function constructWorkloadEventsPolicy(
   policy: string,
-): WorkloadAutoImportPolicyPayload {
+): WorkloadEventsPolicyPayload {
   return {
     policy,
     userLocator: config.INTEGRATION_ID,

src/transmitter/types.ts

@@ -63,7 +63,7 @@ export interface IDeleteWorkloadPayload {
   agentId: string;
 }
 
-export interface WorkloadAutoImportPolicyPayload {
+export interface WorkloadEventsPolicyPayload {
   userLocator: string;
   cluster: string;
   agentId: string;

test/fixtures/workload-auto-import.rego renamed to test/fixtures/workload-events.rego

@@ -81,15 +81,15 @@ test('Kubernetes-Monitor with KinD', async (jestDoneCallback) => {
 
   // Create a copy of the policy file fixture in the location that snyk-monitor is expecting to load it from.
   const regoPolicyFixturePath = resolvePath(
-    './test/fixtures/workload-auto-import.rego',
+    './test/fixtures/workload-events.rego',
   );
   const expectedPoliciesPath = resolvePath('/tmp/policies');
   if (!(await existsAsync(expectedPoliciesPath))) {
     await mkdirAsync(expectedPoliciesPath);
   }
   await copyFileAsync(
     regoPolicyFixturePath,
-    resolvePath(expectedPoliciesPath, 'workload-auto-import.rego'),
+    resolvePath(expectedPoliciesPath, 'workload-events.rego'),
   );
 
   const regoPolicyContents = await readFileAsync(regoPolicyFixturePath, 'utf8');
@@ -98,11 +98,11 @@ test('Kubernetes-Monitor with KinD', async (jestDoneCallback) => {
     .times(1)
     .reply(
       200,
-      (uri, requestBody: transmitterTypes.WorkloadAutoImportPolicyPayload) => {
+      (uri, requestBody: transmitterTypes.WorkloadEventsPolicyPayload) => {
         try {
           expect(
             requestBody,
-          ).toEqual<transmitterTypes.WorkloadAutoImportPolicyPayload>({
+          ).toEqual<transmitterTypes.WorkloadEventsPolicyPayload>({
             agentId: expect.any(String),
             cluster: expect.any(String),
             userLocator: expect.any(String),