feat: exit process if config is bad

newsuk · Jun 26, 2018 · 29e1d65 · 29e1d65
1 parent 2eaaa9c
commit 29e1d65
Show file tree

Hide file tree

Showing 2 changed files with 68 additions and 7 deletions.
diff --git a/src/configValidator.js b/src/configValidator.js
@@ -11,6 +11,7 @@ function isValid(missingConfigFields) {
 
   return true;
 }
+
 function isRemoteConfigValid(config) {
   const missingConfigFields = ['remoteBucketName', 'remoteRegion'].filter(
     field => !config[field]
@@ -23,6 +24,7 @@ function isRemoteConfigValid(config) {
 
   return isValid(missingConfigFields);
 }
+
 function isLocalConfigValid(config) {
   const missingConfigFields = [
     'gridUrl',
@@ -36,11 +38,26 @@ function isLocalConfigValid(config) {
   return isValid(missingConfigFields);
 }
 
-const validateConfig = (config, isRemote) => {
-  if (isRemote) isRemoteConfigValid(config);
+const validateConfig = (config, isRemote) =>
+  new Promise(resolve => {
+    let isRemoteConfigCorrect = true;
+
+    if (isRemote) {
+      isRemoteConfigCorrect = isRemoteConfigValid(config);
+    }
 
-  isLocalConfigValid(config);
-};
+    if (isLocalConfigValid(config) && isRemoteConfigCorrect) {
+      logger.info('configValidator', 'Config validated ✅');
+      resolve();
+    }
+
+    logger.info(
+      'config Validator',
+      '❗️ Please update your config to be valid \n Exiting Aye Spy'
+    );
+    process.exitCode = 1;
+    process.exit();
+  });
 
 export default validateConfig;
 export { isLocalConfigValid, isRemoteConfigValid };
diff --git a/src/configValidator.test.js b/src/configValidator.test.js
@@ -1,4 +1,9 @@
-import { isLocalConfigValid,isRemoteConfigValid } from './configValidator';
+/* globals expect jest */
+
+import validateConfig, {
+  isLocalConfigValid,
+  isRemoteConfigValid
+} from './configValidator';
 
 describe('The Config Validator', () => {
   it('local config returns false for invalid configs', () => {
@@ -33,12 +38,51 @@ describe('The Config Validator', () => {
   });
 
   it('remote config returns true for valid configs', () => {
-    process.env.AWS_SECRET_ACCESS_KEY = 'test'
-    process.env.AWS_ACCESS_KEY_ID = 'test'
+    process.env.AWS_SECRET_ACCESS_KEY = 'test';
+    process.env.AWS_ACCESS_KEY_ID = 'test';
     const config = {
       remoteBucketName: 'aye-spy',
       remoteRegion: 'eu-west-1'
     };
     expect(isRemoteConfigValid(config)).toBe(true);
   });
+
+  it('exits if the config is invalid', () => {
+    const invalidConfig = {
+      gridUrl: 'http://selenium.com:4444/wd/hub',
+      baseline: './e2eTests/generateHtmlReport/baseline',
+      latest: './e2eTests/generateHtmlReport/latest',
+      generatedDiffs: './e2eTests/generateHtmlReport/generatedDiffs',
+      report: './e2eTests/generateHtmlReport/reports',
+      scenarios: [
+        {
+          url: 'http:/google.com/',
+          label: 'homepage'
+        }
+      ]
+    };
+
+    process.exit = jest.fn();
+    validateConfig(invalidConfig, true);
+    expect(process.exit.mock.calls.length).toBe(1);
+  });
+
+  it('resolves a correct config', done => {
+    const config = {
+      remoteBucketName: 'test',
+      remoteRegion: 'test',
+      gridUrl: 'http://selenium.com:4444/wd/hub',
+      baseline: './e2eTests/generateHtmlReport/baseline',
+      latest: './e2eTests/generateHtmlReport/latest',
+      generatedDiffs: './e2eTests/generateHtmlReport/generatedDiffs',
+      report: './e2eTests/generateHtmlReport/reports',
+      scenarios: [
+        {
+          url: 'http:/google.com/',
+          label: 'homepage'
+        }
+      ]
+    };
+    validateConfig(config, true).then(done);
+  });
 });