@contrast/config 1.0.0 → 1.1.0

package/lib/util.js

@@ -179,6 +179,32 @@ function getAutoEnv(name) {
     : process.env[`CONTRAST__${envName}`] || process.env[envName];
 }
 
+/**
+ * When you run an application with pm2 on cluster mode, pm2 attaches the
+ * process.env to a property pm2_env(only for the agent since we start it with -r flag), so
+ * the function checks if there is a pm2_env property and merge contrast
+ * related properties to process.env
+ */
+function mergePM2Envs() {
+  if (!process.env.pm2_env) return;
+
+  const pm2_env = JSON.parse(process.env.pm2_env);
+
+  const objectEntries = Object.entries(pm2_env.env).concat(Object.entries(pm2_env));
+
+  const cfgPath = 'CONTRAST_CONFIG_PATH';
+  const pm2CfgPath = pm2_env.env[cfgPath] || pm2_env[cfgPath];
+  if (pm2CfgPath) process.env[cfgPath] = pm2CfgPath;
+
+  objectEntries.forEach(([key, value]) => {
+    if (
+      !process.env[key] && key.toLocaleLowerCase().includes('contrast')
+    ) {
+      process.env[key] = value;
+    }
+  });
+}
+
 /**
  * @return {Config} merged options
  */
@@ -229,6 +255,7 @@ function mergeOptions() {
 
 util.Config = Config;
 util.setup = function setup() {
+  mergePM2Envs();
   const mergedOptions = mergeOptions();
   mergedOptions.validate();
   return mergedOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/config",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "An API for discovering Contrast agent configuration data",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",

package/lib/index.test.js

@@ -1,331 +0,0 @@
-'use strict';
-
-const sinon = require('sinon');
-const mockfs = require('mock-fs');
-const { expect } = require('chai');
-const config = require('.');
-const configOptions = require('./options');
-const mocks = require('../../test/mocks');
-const AppInfo = require('../../core/lib/app-info');
-
-const {
-  getGoodConfig,
-  getBadConfig,
-  getAbsolutePath,
-  getDefaultConfig,
-  getProperties,
-  containsAllProps,
-} = require('../test/helpers');
-
-describe('config', function () {
-  beforeEach(function () {
-
-    // removing as some agent engineers have this env var set
-    delete process.env['CONTRAST_CONFIG_PATH'];
-    sinon.stub(console, 'error');
-  });
-
-  afterEach(function () {
-    mockfs.restore();
-  });
-
-  describe('default config behavior', function () {
-    it('sets all default properties in the config', function () {
-      const defaultConfigProps = getProperties(getDefaultConfig());
-      const loadConfigProps = getProperties(config());
-      expect(containsAllProps(loadConfigProps, defaultConfigProps)).to.be.true;
-    });
-
-    it('logs an error a config file path is given and no config is found', function () {
-      process.env['CONTRAST_CONFIG_PATH'] = 'fake config';
-      config();
-      expect(console.error).to.have.been.calledWith(
-        'Unable to read config file at %s: %s',
-        'fake config',
-        sinon.match('ENOENT'),
-      );
-      delete process.env['CONTRAST_CONFIG_PATH'];
-    });
-
-    it('logs an error when the config cannot be parsed', function () {
-      mockfs({
-        'contrast_security.yaml': mockfs.load(getBadConfig()),
-      });
-      config();
-      expect(console.error).to.have.been.calledWith(
-        'YAML validator found an error in %s: %s',
-        sinon.match(/contrast_security.yaml$/),
-        sinon.match(/^Tabs are not allowed as indentation/),
-      );
-    });
-
-    it('accepts overrides from env', function () {
-      process.env['CONTRAST__API__API_KEY'] = 'demo';
-      const cfg = config();
-      expect(cfg.api.api_key).to.be.equal('demo');
-      delete process.env['CONTRAST__API__API_KEY'];
-    });
-
-    it('loads and sets properties from a valid config', function () {
-      mockfs({
-        'contrast_security.yaml': mockfs.load(getGoodConfig()),
-      });
-      const cfg = config();
-      expect(console.error).to.not.have.been.called;
-      expect(cfg.api.enable).to.be.true;
-      expect(cfg.api.url).to.be.equal('http://localhost:19080/Contrast');
-      expect(cfg.api.api_key).to.be.equal('demo');
-      expect(cfg.api.service_key).to.be.equal('demo');
-      expect(cfg.api.user_name).to.be.equal('contrast_admin');
-    });
-  });
-
-  describe('config file path precedence', function () {
-    it('should set config from environment variable even with one in cwd', function () {
-      mockfs({
-        'contrast_security.yaml': mockfs.load(getGoodConfig()),
-        '/otherDir/config/contrast_security.yaml': mockfs.load(
-          getGoodConfig('2')
-        ),
-      });
-      process.env['CONTRAST_CONFIG_PATH'] =
-        '/otherDir/config/contrast_security.yaml';
-      const cfg = config();
-      expect(cfg.api.url).to.be.equal('https://localhost:9999/Contrast');
-      expect(cfg.api.api_key).to.be.equal('QWERTYUIOP');
-      expect(cfg.api.service_key).to.be.equal('ASDFGHJKL');
-      expect(cfg.api.user_name).to.be.equal('contrast_user');
-      delete process.env['CONTRAST_CONFIG_PATH'];
-    });
-
-    it('should set config from etc/contrast if envVar not set and no config in cwd', function () {
-      mockfs({
-        '/etc/contrast/contrast_security.yaml': mockfs.load(getGoodConfig()),
-      });
-      const cfg = config();
-      expect(cfg.api.url).to.be.equal('http://localhost:19080/Contrast');
-      expect(cfg.api.api_key).to.be.equal('demo');
-      expect(cfg.api.service_key).to.be.equal('demo');
-      expect(cfg.api.user_name).to.be.equal('contrast_admin');
-    });
-
-    it('should set config from cwd even when present in etc/contrast', function () {
-      mockfs({
-        '/etc/contrast/contrast_security.yaml': mockfs.load(getGoodConfig()),
-        'contrast_security.yaml': mockfs.load(getGoodConfig('2')),
-      });
-      const cfg = config();
-      expect(cfg.api.url).to.be.equal('https://localhost:9999/Contrast');
-      expect(cfg.api.api_key).to.be.equal('QWERTYUIOP');
-      expect(cfg.api.service_key).to.be.equal('ASDFGHJKL');
-      expect(cfg.api.user_name).to.be.equal('contrast_user');
-    });
-
-    it('should set from env variable even when present in cwd and etc/contrast', function () {
-      mockfs({
-        '/etc/contrast/contrast_security.yaml': mockfs.load(getGoodConfig()),
-        'contrast_security.yaml': mockfs.load(getGoodConfig('2')),
-        '/otherDir/config/contrast_security.yaml': mockfs.load(
-          getGoodConfig('3')
-        ),
-      });
-      process.env['CONTRAST_CONFIG_PATH'] =
-        '/otherDir/config/contrast_security.yaml';
-      const cfg = config();
-      expect(cfg.api.url).to.be.equal('https://localhost:8080/Contrast');
-      expect(cfg.api.api_key).to.be.equal('QAZWSX');
-      expect(cfg.api.service_key).to.be.equal('EDCRFV');
-      expect(cfg.api.user_name).to.be.equal('super_admin');
-      delete process.env['CONTRAST_CONFIG_PATH'];
-    });
-  });
-
-  describe('config value precedence', function () {
-    let options;
-
-    beforeEach(function () {
-      options = getDefaultConfig();
-      delete process.env.CONTRAST__API__API_KEY;
-    });
-
-    it('should use env var before config file value', function () {
-      process.env.CONTRAST__API__API_KEY = 'NOPE';
-      const cfg = config(options);
-      expect(cfg.api.api_key).to.be.equal('NOPE');
-    });
-  });
-
-  describe('environment variables', function () {
-    it('should support CONTRAST__ options', function () {
-      const options = getDefaultConfig();
-      process.env['CONTRAST__AGENT__NODE__ENABLE_REWRITE'] = 'f';
-      const cfg = config(options);
-
-      expect(cfg.agent.node.enable_rewrite).to.be.equal(false);
-      delete process.env['CONTRAST__AGENT__NODE__ENABLE_REWRITE'];
-    });
-    it('Should support CONTRAST__API__ options', function () {
-      const options = getDefaultConfig();
-      process.env['CONTRAST__API__API_KEY'] = 'abcdefg';
-      const cfg = config(options);
-
-      expect(cfg.api.api_key).to.equal('abcdefg');
-      delete process.env['CONTRAST__API__API_KEY'];
-    });
-  });
-
-  describe('config options functions', function () {
-    describe('clearBaseCase', function () {
-      it('should return string if defined', function () {
-        const string = 'asdf';
-        expect(configOptions.clearBaseCase(string)).to.equal(string);
-      });
-
-      it('should return undefined if string is empty', function () {
-        const string = '';
-        expect(configOptions.clearBaseCase(string)).to.be.undefined;
-      });
-
-      it('should return int if and number and defined', function () {
-        const num = 1;
-        expect(configOptions.clearBaseCase(num)).to.equal(num);
-      });
-
-      it('should return undefined if value is NaN', function () {
-        const num = NaN;
-        expect(configOptions.clearBaseCase(num)).to.be.undefined;
-      });
-    });
-
-    describe('castBoolean', function () {
-      [true, 'true', 'TRUE', 't', 'T'].forEach(val => {
-        it(`should return true if string value is ${val}`, function () {
-          expect(configOptions.castBoolean(val)).to.equal(true);
-        });
-      });
-
-      [false, 'false', 'FALSE', 'f', 'F'].forEach(val => {
-        it(`should return false if string value is ${val}`, function () {
-          expect(configOptions.castBoolean(val)).to.equal(false);
-        });
-      });
-
-      ['rando', [1, 2, 3], {}, 100, null, undefined].forEach(val => {
-        it(`should return undefined if ${val} not a boolean or string or not true/t/false/f`, function () {
-          expect(configOptions.castBoolean(val)).to.equal(undefined);
-        });
-      });
-    });
-  });
-
-  describe('enum', function () {
-    let logger_level;
-
-    beforeEach(function () {
-      logger_level = 'CONTRAST__AGENT__LOGGER__LEVEL';
-    });
-
-    afterEach(function () {
-      delete process.env[logger_level];
-    });
-
-    it('should use value from enum if there is a match', function () {
-      process.env[logger_level] = 'info';
-      const cfg = config();
-      expect(cfg.agent.logger.level).to.be.equal('info');
-    });
-
-    it('should use default when there is no match within enum', function () {
-      process.env[logger_level] = 'doggo';
-      const cfg = config();
-      expect(cfg.agent.logger.level).to.be.equal('error');
-    });
-  });
-
-  describe('uppercase, lowercase, parsenum transformations', function () {
-    it('should uppercase server.environment', function () {
-      process.env['CONTRAST__SERVER__ENVIRONMENT'] = 'qa';
-      const cfg = config();
-      expect(cfg.server.environment).to.equal('QA');
-      delete process.env['CONTRAST__SERVER__ENVIRONMENT'];
-    });
-
-    it('should lowercase logger level', function () {
-      process.env['CONTRAST__AGENT__LOGGER__LEVEL'] = 'DEBUG';
-      const cfg = config();
-      expect(cfg.agent.logger.level).to.equal('debug');
-      delete process.env['CONTRAST__AGENT__LOGGER__LEVEL'];
-    });
-
-    it('should parse stack_trace_limit into a number', function () {
-      process.env['CONTRAST__AGENT__STACK_TRACE_LIMIT'] = '25';
-      const cfg = config();
-      expect(cfg.agent.stack_trace_limit).to.equal(25);
-      delete process.env['CONTRAST__AGENT__STACK_TRACE_LIMIT'];
-    });
-
-    it('agent.stack_trace_limit (Infinity string --> number)', function () {
-      process.env['CONTRAST__AGENT__STACK_TRACE_LIMIT'] = 'Infinity';
-      const cfg = config();
-      expect(cfg.agent.stack_trace_limit).to.be.equal(Infinity);
-      delete process.env['CONTRAST__AGENT__STACK_TRACE_LIMIT'];
-    });
-  });
-
-  describe('application', function () {
-    describe('validation', function () {
-      afterEach(function () {
-        delete process.env['CONTRAST__APPLICATION__SESSION_ID'];
-        delete process.env['CONTRAST__APPLICATION__SESSION_METADATA'];
-      });
-      it('allows one to be set without error', function () {
-        process.env['CONTRAST__APPLICATION__SESSION_ID'] = 'abcd-1234';
-        expect(() => {
-          config();
-        }).to.not.throw(/Configuration Error:/);
-      });
-      it('session options are mutually exclusive', function () {
-        process.env['CONTRAST__APPLICATION__SESSION_ID'] = 'abcd-1234';
-        process.env['CONTRAST__APPLICATION__SESSION_METADATA'] = 'a=1,b=2';
-        expect(() => {
-          config();
-        }).to.throw(/Configuration Error:/);
-      });
-    });
-  });
-
-  describe('server', function () {
-    describe('environment', function () {
-      it('set from env var', function () {
-        const env = Date.now();
-        const options = getDefaultConfig();
-        process.env.SERVER__ENVIRONMENT = env;
-
-        const cfg = config(options);
-        const ai = new AppInfo({ appInfo: 'asdf', config: cfg, logger: mocks.logger() });
-        expect(ai.serverEnvironment).to.be.equal(String(env));
-      });
-    });
-  });
-
-  describe('mapping', function () {
-    describe('logger', function () {
-      it('casts logger path to absolute path', function () {
-        process.env['CONTRAST__AGENT__LOGGER__PATH'] = 'loggy.log';
-        const cfg = config();
-        expect(cfg.agent.logger.path).to.be.equal(getAbsolutePath('loggy.log'));
-        delete process.env['CONTRAST__AGENT__LOGGER__PATH'];
-      });
-
-      it('--debug does not overwrite explicitly set log level', function () {
-        process.env['DEBUG'] = 'true';
-        process.env['CONTRAST__AGENT__LOGGER__LEVEL'] = 'info';
-
-        const cfg = config();
-        expect(cfg.agent.logger.level).to.be.equal('info');
-        delete process.env['DEBUG'];
-        delete process.env['CONTRAST__AGENT__LOGGER__LEVEL'];
-      });
-    });
-  });
-});