Feature/#60 normalize hyphens (#61)

* updated Pipfile.lock * check for both original and normalized keys and get whichever is found first * added test for env source * updated README * dont advertise the backwards compatible stuff in the README
markusressel · Apr 15, 2021 · 7aebc0a · 7aebc0a
1 parent e4ec0c8
commit 7aebc0a
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 14 deletions.
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -209,15 +209,14 @@ implementations are available:
 
 Since you only specify the key path of a config entry the ENV
 key is generated automatically by concatenating all key path items 
-using an underscore and converting to uppercase:
+using an underscore, converting to uppercase and replacing any remaining
+hyphens also with an underscore:
 
 ```python
-key_path = ["my_app", "example"]
-env_key = "_".join(key_path).upper()
+key_path = ["my_app", "my-example"]
 ```
 
-yields `MY_APP_EXAMPLE`.
-
+would yield `MY_APP_MY_EXAMPLE`.
 
 ### Filesystem Source
 

diff --git a/container_app_conf/source/env_source.py b/container_app_conf/source/env_source.py
@@ -31,11 +31,14 @@ class EnvSource(DataSource):
     KEY_SPLIT_CHAR = "_"
 
     def has(self, entry: ConfigEntry) -> bool:
-        return self.env_key(entry) in self.root.keys()
+        original_key = self.env_key(entry)
+        normalized_key = original_key.replace('-', '_')
+        return original_key in self.root.keys() or normalized_key in self.root.keys()
 
     def get(self, entry: ConfigEntry) -> str or None:
-        key = self.env_key(entry)
-        return self.root.get(key, None)
+        original_key = self.env_key(entry)
+        normalized_key = original_key.replace('-', '_')
+        return self.root.get(original_key, self.root.get(normalized_key, None))
 
     @staticmethod
     def env_key(entry: ConfigEntry) -> str:

diff --git a/tests/data_source/source_test.py b/tests/data_source/source_test.py
@@ -17,11 +17,14 @@
 #  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #  SOFTWARE.
+import os
 from typing import Dict
+from unittest import mock
 
 from container_app_conf import ConfigEntry
 from container_app_conf.entry.int import IntConfigEntry
 from container_app_conf.entry.string import StringConfigEntry
+from container_app_conf.source.env_source import EnvSource
 from container_app_conf.source.json_source import JsonSource
 from container_app_conf.source.toml_source import TomlSource
 from container_app_conf.source.yaml_source import YamlSource
@@ -110,3 +113,32 @@ def test_json(self):
         self.assertEqual(source.get(str_entry), "value")
         self.assertTrue(source.has(int_entry))
         self.assertEqual(source.get(int_entry), 2)
+
+    def test_env(self):
+        str_entry = StringConfigEntry(
+            key_path=["test-ing", "key1"],
+            default="value"
+        )
+        int_entry = IntConfigEntry(
+            key_path=["testing", "key2"],
+            default=2
+        )
+
+        source = EnvSource()
+        original_key = EnvSource.env_key(str_entry)
+        expected = "expected"
+        with mock.patch.dict(os.environ, {original_key: expected}, clear=True):
+            source.load()
+
+        self.assertTrue(source.has(str_entry))
+        self.assertEqual(source.get(str_entry), expected)
+        self.assertFalse(source.has(int_entry))
+
+        normalized_env_key = original_key.replace('-', '_')
+        self.assertNotEqual(original_key, normalized_env_key)
+        with mock.patch.dict(os.environ, {normalized_env_key: expected + '2'}, clear=True):
+            source.load()
+
+        self.assertTrue(source.has(str_entry))
+        self.assertEqual(source.get(str_entry), expected + '2')
+        self.assertFalse(source.has(int_entry))