feat(configuration): Add core.configuration.extra to include addition…

…al configuration files

Close #123

CHANGELOG.md

@@ -4,7 +4,8 @@ History
 1.2.4 (unreleased)
 ------------------
 
-- JSonnet: Add XDebug Version 3 support.
+- Jsonnet: Add XDebug Version 3 support.
+- Configuration: Add `core.configuration.extra` to load additional configuration files.
 
 1.2.3 (2020-11-13)
 ------------------

ddb/config/config.py

@@ -119,7 +119,10 @@ def files(self):
                 continue
             for basename in self.filenames:
                 for ext in self.extensions:
-                    file = os.path.join(path, basename + '.' + ext)
+                    if basename.endswith('.' + ext) and os.path.exists(os.path.join(path, basename)):
+                        file = os.path.join(path, basename)
+                    else:
+                        file = os.path.join(path, basename + '.' + ext)
                     ret.append(file)
         return ret
 

ddb/feature/core/__init__.py

@@ -92,7 +92,12 @@ def _load_environment_configuration(self):
         current = config.data.get('core.env.current')
 
         filenames = list(config.filenames)
-        filenames.insert(1, filenames[0] + '.' + current)
+        filenames.insert(len(filenames) - 1, filenames[0] + '.' + current)
+
+        extra = config.data.get('core.configuration.extra')
+        if extra:
+            for extra_item in extra:
+                filenames.insert(len(filenames) - 1, extra_item)
 
         config.clear()
         config.filenames = tuple(filenames)

ddb/feature/core/schema.py

@@ -47,6 +47,13 @@ class ProcessSchema(Schema):
     append = fields.Raw(required=False, allow_none=True, default=None)  # List[str] or str splitted with shlex
 
 
+class ConfigurationSchema(Schema):
+    """
+    Process settings for core feature schema.
+    """
+    extra = fields.List(fields.String(), required=False)
+
+
 class CoreFeatureSchema(FeatureSchema):
     """
     Core feature schema.
@@ -57,3 +64,4 @@ class CoreFeatureSchema(FeatureSchema):
     os = fields.String(required=True, default=os.name)
     path = fields.Nested(PathSchema(), default=PathSchema())
     process = fields.Dict(fields.String(), fields.Nested(ProcessSchema()), default={})  # Process binary mappings
+    configuration = fields.Nested(ConfigurationSchema(), default=ConfigurationSchema())

docs/configuration.md

@@ -102,7 +102,20 @@ configuration settings, please check the documentation of related feature.
 
     When activating the environment `$(ddb activate)` with [shell feature (Environment activation)](#environment-activation), 
     the whole configuration is also exported as environment variables using the same naming convention.
-
+
+!!! info "Extra configuration files"
+    You may add additional configuration files using core.configuration.extra_files configuration property into default 
+    configuration files.
+
+    ```yml
+    core:
+      configuration:
+        extra: ['ddb.custom.yml']
+    ```
+
+    This will load `ddb.custom.yml` configuration file from each supported configuration directories. `ddb.local.yml` 
+    still has the priority other those extra configuration files.
+
 !!! abstract "Default configuration"
     ```ddb config``` can provide default configuration if `ddb.yml` configuration file is empty.
 

tests/it/test_config_it.data/extra-filenames/another.config.file.yaml

@@ -0,0 +1,3 @@
+another: true
+app:
+  value: config

tests/it/test_config_it.data/extra-filenames/ddb.local.yml

@@ -0,0 +1,2 @@
+app:
+  value: local

tests/it/test_config_it.data/extra-filenames/ddb.yml

@@ -0,0 +1,5 @@
+core:
+  configuration:
+    extra: [ 'some.custom.yml', 'another.config.file' ]
+app:
+  value: default

tests/it/test_config_it.data/extra-filenames/some.custom.yml

@@ -0,0 +1,3 @@
+some: true
+app:
+  value: custom

tests/it/test_config_it.py

@@ -55,3 +55,14 @@ def test_config_env_ddb2(self, project_loader):
         assert not os.path.islink("ddb.yml")
 
         reset()
+
+    def test_config_extra_filenames(self, project_loader):
+        project_loader("extra-filenames")
+
+        main(["configure"], reset_disabled=True)
+
+        assert config.data.get('another') is True
+        assert config.data.get('some') is True
+        assert config.data.get('app.value') == 'local'
+
+        reset()