Added unit tests for testing config file for correct values and if not check the env variables.

seasoned_api/test/unit/config/testConfig.js

@@ -0,0 +1,63 @@
+const assert = require('assert');
+const Config = require('src/config/configuration.js');
+
+describe('Config', () => {
+  before(() => {
+    this.backedUpEnvironmentVariables = Object.assign({}, process.env);
+    this.backedUpConfigFields = Object.assign({}, Config.getInstance().fields);
+  });
+
+  after(() => {
+    process.env = this.backedUpEnvironmentVariables;
+    Config.getInstance().fields = this.backedUpConfigFields;
+  });
+
+  it('should retrieve section and option from config file', () => {
+    Config.getInstance().fields = { 'webserver': { 'port': 1337 } };
+    assert.equal(Config.getInstance().get('webserver', 'port'), 1337);
+  });
+
+  it('should resolve to environment variables if option is filtered with env', () => {
+    Config.getInstance().fields = { 'webserver': { 'port': 'env|SEASONED_WEBSERVER_PORT' } };
+    process.env.SEASONED_WEBSERVER_PORT = '1338';
+    assert.equal(Config.getInstance().get('webserver', 'port'), 1338);
+  });
+
+  it('raises an exception if the environment variable does not exist', () => {
+    Config.getInstance().fields = { 'webserver': { 'port': 'env|DOES_NOT_EXIST' } };
+    process.env.SEASONED_WEBSERVER_PORT = '1338';
+    assert.throws(() => Config.getInstance().get('webserver', 'port'), /empty/);
+  });
+
+  it('raises an exception if the environment variable is empty', () => {
+    Config.getInstance().fields = { 'webserver': { 'port': 'env|SEASONED_WEBSERVER_PORT' } };
+    process.env.SEASONED_WEBSERVER_PORT = '';
+    assert.throws(() => Config.getInstance().get('webserver', 'port'), /empty/);
+  });
+
+  it('raises an exception if the section does not exist in the file', () => {
+    Config.getInstance().fields = { 'webserver': { 'port': '1338' } };
+    assert.throws(() => Config.getInstance().get('woops', 'port'), /does not exist/);
+  });
+
+  it('raises an exception if the option does not exist in the file', () => {
+    Config.getInstance().fields = { 'webserver': { 'port': '1338' } };
+    assert.throws(() => Config.getInstance().get('webserver', 'woops'), /does not exist/);
+  });
+
+  it('returns an array if field is an array', () => {
+    Config.getInstance().fields = { 'bouncer': { 'whitelist': [1, 2, 3] } };
+    assert.deepEqual(Config.getInstance().get('bouncer', 'whitelist'), [1, 2, 3]);
+  });
+
+  it('decodes field as base64 if base64| is before the variable', () => {
+    Config.getInstance().fields = { 'webserver': { 'port': 'base64|MTMzOA==' } };
+    assert.equal(Config.getInstance().get('webserver', 'port'), 1338);
+  });
+
+  it('decodes environment variable as base64 if BASE64= is before the variable', () => {
+    Config.getInstance().fields = { 'webserver': { 'port': 'env|base64|SEASONED_WEBSERVER_PORT' } };
+    process.env.SEASONED_WEBSERVER_PORT = 'MTMzOA==';
+    assert.equal(Config.getInstance().get('webserver', 'port'), 1338);
+  });
+});

seasoned_api/test/unit/config/testField.js

@@ -0,0 +1,72 @@
+const assert = require('assert');
+const Field = require('src/config/field.js');
+
+describe('Field', () => {
+  it('should return an array if it is an array', () => {
+    const field = new Field([1, 2, 3]);
+    assert.deepEqual(field.value, [1, 2, 3]);
+  });
+
+  it('should return the plain value if it is an ordinary field', () => {
+    const field = new Field('plain value');
+    assert.equal(field.value, 'plain value');
+  });
+
+  it('should return false if boolean false is field', () => {
+    const field = new Field(false);
+    assert.equal(field.value, false);
+  });
+
+  it('should not include any invalid filters', () => {
+    const field = new Field('invalid-filter|plain value');
+    assert.equal(field.value, 'plain value');
+  });
+
+  it('should return the decoded value if it is filtered through base64', () => {
+    const field = new Field('base64|ZW5jb2RlZCB2YWx1ZQ==');
+    assert.equal(field.value, 'encoded value');
+  });
+
+  it('should not decode the value if it missing the filter', () => {
+    const field = new Field('ZW5jb2RlZCB2YWx1ZQ==');
+    assert.equal(field.value, 'ZW5jb2RlZCB2YWx1ZQ==');
+  });
+
+  it('should retrieve the environment variable if env filter is used', () => {
+    const environmentVariables = { REDIS_URL: 'redis://127.0.0.1:1234' };
+    const field = new Field('env|REDIS_URL', environmentVariables);
+    assert.equal(field.value, 'redis://127.0.0.1:1234');
+  });
+
+  it('should return undefined if the environment variable does not exist', () => {
+    const environmentVariables = { HTTP_PORT: 8080 };
+    const field = new Field('env|REDIS_URL', environmentVariables);
+    assert.equal(field.value, undefined);
+  });
+
+  it('should return undefined if the environment variable is an empty string', () => {
+    const environmentVariables = { REDIS_URL: '' };
+    const field = new Field('env|REDIS_URL', environmentVariables);
+    assert.deepEqual(field.value, undefined);
+  });
+
+  describe('Multiple filters', () => {
+    it('should decode the environment variable if base64 and env filter are used', () => {
+      const environmentVariables = { REDIS_URL: 'cmVkaXM6Ly9kYWdibGFkZXQubm8vMTIzNA==' };
+      const field = new Field('env|base64|REDIS_URL', environmentVariables);
+      assert.equal(field.value, 'redis://dagbladet.no/1234');
+    });
+
+    it('should disregard the order of filters when env and base64 are used', () => {
+      const environmentVariables = { REDIS_URL: 'cmVkaXM6Ly9kYWdibGFkZXQubm8vMTIzNA==' };
+      const field = new Field('base64|env|REDIS_URL', environmentVariables);
+      assert.equal(field.value, 'redis://dagbladet.no/1234');
+    });
+
+    it('should return undefined if both filters are used and env var does not exist', () => {
+      const environmentVariables = { REDIS_URL: 'cmVkaXM6Ly9kYWdibGFkZXQubm8vMTIzNA==' };
+      const field = new Field('base64|env|REDIS_LOL', environmentVariables);
+      assert.equal(field.value, undefined);
+    });
+  });
+});

seasoned_api/test/unit/config/testFilters.js

@@ -0,0 +1,34 @@
+const assert = require('assert');
+const Filters = require('src/config/filters.js');
+
+describe('Filters', () => {
+  it('should extract base64 as filter if it is at start of string followed by pipe', () => {
+    const filters = new Filters('base64|');
+    assert.deepEqual(filters.filters, ['base64']);
+  });
+
+  it('should extract base64 and env as filters if both are separated by pipe', () => {
+    const filters = new Filters('base64|env|');
+    assert.deepEqual(filters.filters, ['base64', 'env']);
+  });
+
+  it('should not extract any filters if none are present', () => {
+    const filters = new Filters('base64');
+    assert.deepEqual(filters.filters, []);
+  });
+
+  it('should strip env filter from the value', () => {
+    const filters = new Filters('env|HELLO');
+    assert.deepEqual(filters.removeFiltersFromValue(), 'HELLO');
+  });
+
+  it('should strip env and base64 filter from the value', () => {
+    const filters = new Filters('env|base64|HELLO');
+    assert.deepEqual(filters.removeFiltersFromValue(), 'HELLO');
+  });
+
+  it('should strip no filters from the value if there are no filters', () => {
+    const filters = new Filters('HELLO');
+    assert.deepEqual(filters.removeFiltersFromValue(), 'HELLO');
+  });
+});