chore: validate both dep graphs are present in binaries tests

There is a possible race condition that can cause test flakiness when testing the binaries deployment with two dep graphs.

The reason is as follows:
A workload is available from Homebase when at least 1 dependency graph and its workload metadata are stored. Currently we don't do a check that asserts that both dependency graphs of a deployment are stored and the tests may fail.

This fix ensures that both graphs are stored before proceeding with the tests.

Author: ivanstanev

test/helpers/kubernetes-upstream.ts

@@ -4,7 +4,11 @@ import {
   IWorkloadLocator,
   IWorkloadMetadata,
 } from '../../src/transmitter/types';
-import { WorkloadLocatorValidator, WorkloadMetadataValidator } from './types';
+import {
+  WorkloadLocatorValidator,
+  WorkloadMetadataValidator,
+  DepGraphsValidator,
+} from './types';
 import config = require('../../src/common/config');
 
 const UPSTREAM_POLLING_CONFIGURATION = {
@@ -21,6 +25,25 @@ export async function getUpstreamResponseBody(
   return responseBody;
 }
 
+export async function validateUpstreamStoredDepGraphs(
+  validatorFn: DepGraphsValidator,
+  relativeUrl: string,
+  remainingChecks: number = UPSTREAM_POLLING_CONFIGURATION.MAXIMUM_REQUESTS,
+): Promise<boolean> {
+  while (remainingChecks > 0) {
+    console.log(`Pinging upstream for existing data (${remainingChecks} checks remaining)...`);
+    const responseBody = await getUpstreamResponseBody(relativeUrl);
+    const depGraphs = responseBody?.dependencyGraphResults;
+    const result = validatorFn(depGraphs);
+    if (result) {
+      return true;
+    }
+    await sleep(UPSTREAM_POLLING_CONFIGURATION.WAIT_BETWEEN_REQUESTS_MS);
+    remainingChecks--;
+  }
+  return false;
+}
+
 export async function validateUpstreamStoredData(
   validatorFn: WorkloadLocatorValidator,
   relativeUrl: string,

test/helpers/types.ts

@@ -3,6 +3,10 @@ import {
   IWorkloadMetadata,
 } from '../../src/transmitter/types';
 
+export type DepGraphsValidator = (depGraphs?: {
+  [name: string]: object;
+}) => boolean;
+
 export type WorkloadLocatorValidator = (
   workloads: IWorkloadLocator[] | undefined,
 ) => boolean;

test/integration/kubernetes.test.ts

@@ -8,6 +8,7 @@ import {
   validateUpstreamStoredData,
   validateUpstreamStoredMetadata,
   getUpstreamResponseBody,
+  validateUpstreamStoredDepGraphs,
 } from '../helpers/kubernetes-upstream';
 import {
   validateSecureConfiguration,
@@ -133,7 +134,7 @@ tap.test('snyk-monitor sends data to kubernetes-upstream', async (t) => {
 });
 
 tap.test('snyk-monitor sends binary hashes to kubernetes-upstream after adding another deployment', async (t) => {
-  t.plan(9);
+  t.plan(10);
 
   const deploymentName = 'binaries-deployment';
   const namespace = 'services';
@@ -143,16 +144,32 @@ tap.test('snyk-monitor sends binary hashes to kubernetes-upstream after adding a
   await kubectl.applyK8sYaml('./test/fixtures/binaries-deployment.yaml');
   console.log(`Begin polling kubernetes-upstream for the expected workloads with integration ID ${integrationId}...`);
 
-  const validatorFn: WorkloadLocatorValidator = (workloads) => {
+  const workloadLocatorValidatorFn: WorkloadLocatorValidator = (workloads) => {
     return workloads !== undefined &&
       workloads.find((workload) => workload.name === deploymentName &&
         workload.type === WorkloadKind.Deployment) !== undefined;
   };
 
+  const depGraphsValidatorFn = (depGraphs?: {
+    node?: object;
+    openjdk?: object;
+  }) => {
+    return (
+      depGraphs !== undefined &&
+      depGraphs.node !== undefined &&
+      depGraphs.openjdk !== undefined
+    );
+  };
+
   const testResult = await validateUpstreamStoredData(
-    validatorFn, `api/v2/workloads/${integrationId}/${clusterName}/${namespace}`);
+    workloadLocatorValidatorFn, `api/v2/workloads/${integrationId}/${clusterName}/${namespace}`);
   t.ok(testResult, 'snyk-monitor sent expected data to kubernetes-upstream in the expected timeframe');
 
+  const depGraphsResult = await validateUpstreamStoredDepGraphs(
+    depGraphsValidatorFn, `api/v1/dependency-graphs/${integrationId}/${clusterName}/${namespace}/${deploymentType}/${deploymentName}`
+  );
+  t.ok(depGraphsResult, 'snyk-monitor sent expected dependency graphs to kubernetes-upstream in the expected timeframe');
+
   const depGraphResult = await getUpstreamResponseBody(
     `api/v1/dependency-graphs/${integrationId}/${clusterName}/${namespace}/${deploymentType}/${deploymentName}`);
   t.ok('dependencyGraphResults' in depGraphResult,