chore: add function to test for required env vars in tests

Allows to bail early if we forgot to set up a required environment variables for certain test environments.

Author: ivanstanev

test/setup/index.ts

@@ -106,6 +106,8 @@ export async function deployMonitor(): Promise<string> {
   console.log('Begin deploying the snyk-monitor...');
 
   try {
+    await platforms[testPlatform].validateRequiredEnvironment();
+
     const imageNameAndTag = getEnvVariableOrDefault(
       'KUBERNETES_MONITOR_IMAGE_NAME_AND_TAG',
       // the default, determined by ./script/build-image.sh

test/setup/platforms/eks.ts

@@ -1,6 +1,17 @@
 import { exec } from 'child-process-promise';
+
+import { throwIfEnvironmentVariableUnset } from './helpers';
 import * as kubectl from '../../helpers/kubectl';
 
+export async function validateRequiredEnvironment(): Promise<void> {
+  console.log(
+    'Checking for the required environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION',
+  );
+  throwIfEnvironmentVariableUnset('AWS_ACCESS_KEY_ID');
+  throwIfEnvironmentVariableUnset('AWS_SECRET_ACCESS_KEY');
+  throwIfEnvironmentVariableUnset('AWS_REGION');
+}
+
 export async function setupTester(): Promise<void> {
   // update the `aws` CLI, the one in CircleCI's default image is outdated and doens't support eks
   await exec('pip install awscli --ignore-installed six');

test/setup/platforms/helpers.ts

@@ -0,0 +1,5 @@
+export function throwIfEnvironmentVariableUnset(variableName: string) {
+  if (!process.env[variableName]) {
+    throw new Error(`Missing required environment variable ${variableName}`);
+  }
+}

test/setup/platforms/index.ts

@@ -14,6 +14,8 @@ interface IPlatformSetup {
   config: () => Promise<void>;
   // clean up whatever we littered an existing cluster with
   clean: () => Promise<void>;
+  // ensure the environment is configured properly for the platform setup; can throw
+  validateRequiredEnvironment: () => Promise<void>;
   // set up host requirements specific to this platform
   setupTester: () => Promise<void>;
 }
@@ -25,6 +27,7 @@ const kindSetup: IPlatformSetup = {
   config: kind.exportKubeConfig,
   clean: kind.clean,
   setupTester: kind.setupTester,
+  validateRequiredEnvironment: () => Promise.resolve(),
 };
 
 const eksSetup: IPlatformSetup = {
@@ -34,6 +37,7 @@ const eksSetup: IPlatformSetup = {
   config: eks.exportKubeConfig,
   clean: eks.clean,
   setupTester: eks.setupTester,
+  validateRequiredEnvironment: eks.validateRequiredEnvironment,
 };
 
 // Use a kind cluster pinned to a specific Kubernetes version to mimic OS3.
@@ -44,6 +48,7 @@ const openshift3Setup: IPlatformSetup = {
   config: kind.exportKubeConfig,
   clean: kind.clean,
   setupTester: openshift3.setupTester,
+  validateRequiredEnvironment: () => Promise.resolve(),
 };
 
 const openshift4Setup: IPlatformSetup = {
@@ -53,6 +58,7 @@ const openshift4Setup: IPlatformSetup = {
   config: openshift4.exportKubeConfig,
   clean: openshift4.clean,
   setupTester: openshift4.setupTester,
+  validateRequiredEnvironment: openshift4.validateRequiredEnvironment,
 };
 
 export function getKubernetesVersionForPlatform(testPlatform: string): string {

test/setup/platforms/openshift4.ts

@@ -5,10 +5,20 @@ import { platform, tmpdir } from 'os';
 import { resolve } from 'path';
 import * as needle from 'needle';
 
+import { throwIfEnvironmentVariableUnset } from './helpers';
 import * as kubectl from '../../helpers/kubectl';
 
 const OPENSHIFT_CLI_VERSION = '4.3.0';
 
+export async function validateRequiredEnvironment(): Promise<void> {
+  console.log(
+    'Checking for the required environment variables: OPENSHIFT4_USER, OPENSHIFT4_PASSWORD, OPENSHIFT4_CLUSTER_URL',
+  );
+  throwIfEnvironmentVariableUnset('OPENSHIFT4_USER');
+  throwIfEnvironmentVariableUnset('OPENSHIFT4_PASSWORD');
+  throwIfEnvironmentVariableUnset('OPENSHIFT4_CLUSTER_URL');
+}
+
 export async function setupTester(): Promise<void> {
   if (existsSync(resolve(process.cwd(), 'oc'))) {
     console.log('OpenShift CLI exists locally, skipping download');