Implement combined config.

CHANGELOG.md

@@ -1,5 +1,15 @@
 # bedrock-config-yaml ChangeLog
 
+## 2.1.0 - TBD
+
+### Added:
+- Add support for a `combined.yaml` file that may contain both an `app` and
+  `core` section. This file may be used instead of, or in combination with
+  separate `app.yaml` and `core.yaml` files. If used in conjunction with
+  separate files, the values in the `app.yaml` and `core.yaml` files will
+  override the values in the `combined.yaml` file. The use of a single
+  `combined.yaml` file simplifies some deployment environments.
+
 ## 2.0.0 - 2020-12-09
 
 ### Changed:

lib/config.js

@@ -6,7 +6,7 @@ const {config} = bedrock;
 import path from 'path';
 
 const namespace = 'config-yaml';
-const cfg = config[namespace] = {app: {}, core: {}};
+const cfg = config[namespace] = {app: {}, combined: {}, core: {}};
 
 // The Bedrock events described below are documented here:
 // https://github.com/digitalbazaar/bedrock#bedrockevents
@@ -18,3 +18,7 @@ cfg.app.filename = 'app.yaml';
 // applied by the last handler for `bedrock-cli.parsed`
 cfg.core.path = path.join('/etc', 'bedrock-config');
 cfg.core.filename = 'core.yaml';
+
+// a combined config may include both an `app` and `core` section
+cfg.combined.path = path.join('/etc', 'bedrock-config');
+cfg.combined.filename = 'combined.yaml';

lib/main.js

@@ -20,7 +20,7 @@ bedrock.events.on('bedrock-cli.parsed', function applyConfig() {
     throw new Error('"bedrock-config-yaml" must be the last import.');
   }
 
-  _applyConfig({type: 'core'});
+  _applyConfig({configType: 'core'});
 });
 
 bedrock.events.on('bedrock.configure', function applyConfig() {
@@ -30,19 +30,29 @@ bedrock.events.on('bedrock.configure', function applyConfig() {
     throw new Error('"bedrock-config-yaml" must be the last import.');
   }
 
-  _applyConfig({type: 'app'});
+  _applyConfig({configType: 'app'});
 });
 
-function _applyConfig({type}) {
+function _applyConfig({configType}) {
+  logger.debug(`Attempting to apply the "${configType}" configuration.`);
   // attempt to load the YAML file specified by the config
-  const configFile = path.join(cfg[type].path, cfg[type].filename);
-  if(fs.existsSync(configFile)) {
-    logger.debug(`"${type}" configuration found "${configFile}".`);
-    const configYaml = jsYaml.safeLoad(fs.readFileSync(configFile, 'utf8'));
-
-    // params: deep, target, source
-    extend(true, config, configYaml);
-  } else {
-    logger.debug(`"${type}" configuration not found "${configFile}".`);
+  const types = ['combined', configType];
+  for(const type of types) {
+    const configFile = path.join(cfg[type].path, cfg[type].filename);
+    if(fs.existsSync(configFile)) {
+      logger.debug(`"${type}" configuration found "${configFile}".`);
+      let configYaml = jsYaml.safeLoad(fs.readFileSync(configFile, 'utf8'));
+
+      // apply the combined config if it contains a section
+      // that corresponds to `configType`
+      if(type === 'combined' && configYaml[configType]) {
+        configYaml = configYaml[configType];
+      }
+
+      // params: deep, target, source
+      extend(true, config, configYaml);
+    } else {
+      logger.debug(`"${type}" configuration not found "${configFile}".`);
+    }
   }
 }

test/mocha/10-api.js

@@ -10,6 +10,7 @@ describe('bedrock-config-yaml', () => {
   it('app yaml configuration should be merged into bedrock config', () => {
     const testBedrockModuleConfig = {
       bar: 'fromBedrockConfig',
+      combinedAppValue: 'hPtQMAHvzECxDRJd',
       foo: 'fromYaml',
       overwriteMe: 'fromYaml',
     };
@@ -20,5 +21,9 @@ describe('bedrock-config-yaml', () => {
     should.exist(config.loggers.console.someLoggerConfig);
     config.loggers.console.someLoggerConfig.should.be.a('string');
     config.loggers.console.someLoggerConfig.should.equal('foo');
+    should.exist(config.loggers.console.someLoggerCombinedConfig);
+    config.loggers.console.someLoggerCombinedConfig.should.be.a('string');
+    config.loggers.console.someLoggerCombinedConfig
+      .should.equal('FDRqpNJLVkgfVxPe');
   });
 });

test/mock-configs/combined.yaml

@@ -0,0 +1,7 @@
+app:
+  test-bedrock-module:
+    combinedAppValue: hPtQMAHvzECxDRJd
+core:
+  loggers:
+    console:
+      someLoggerCombinedConfig: FDRqpNJLVkgfVxPe

test/test.js

@@ -7,6 +7,7 @@ const {config} = bedrock;
 require('bedrock-config-yaml');
 
 config['config-yaml'].app.path = path.join(__dirname, 'mock-configs');
+config['config-yaml'].combined.path = path.join(__dirname, 'mock-configs');
 config['config-yaml'].core.path = path.join(__dirname, 'mock-configs');
 
 // config for mock test-bedrock-module