fix(shell): Slufigy environment variable names

Close #120

CHANGELOG.md

@@ -8,6 +8,7 @@ History
 - Configuration: Add `core.configuration.extra` to load additional configuration files.
 - Configuration: Allow merging from default values
 - Configuration: Add `insert`/`insert_if_missing` strategies for 
+- Shell: Allow special characters from configuration to be properly exported in shell.
 
 1.2.3 (2020-11-13)
 ------------------

ddb/feature/shell/integrations.py

@@ -3,6 +3,7 @@
 from abc import ABC, abstractmethod
 from typing import Tuple, Iterable, Dict, Any, Optional
 
+from slugify import slugify
 from ddb.binary import Binary
 from ddb.utils.file import force_remove, write_if_different, chmod
 
@@ -89,11 +90,15 @@ class BashShellIntegration(ShellIntegration):
     def __init__(self):
         super().__init__("bash", "Bash")
 
+    @staticmethod
+    def _sanitize_key(key):
+        return slugify(key, regex_pattern=r'[^-a-zA-Z0-9_]+').upper()
+
     def set_environment_variable(self, key, value):
-        yield "export " + key + "=" + shlex.quote(value)
+        yield "export " + self._sanitize_key(key) + "=" + shlex.quote(value)
 
     def remove_environment_variable(self, key):
-        yield "unset " + key
+        yield "unset " + self._sanitize_key(key)
 
     def remove_all_binary_shims(self, shims_path: str):
         shims = []
@@ -152,12 +157,16 @@ class CmdShellIntegration(ShellIntegration):
     def __init__(self):
         super().__init__("cmd", "Windows cmd.exe")
 
+    @staticmethod
+    def _sanitize_key(key):
+        return slugify(key, regex_pattern=r'[^-a-zA-Z0-9_]+').upper()
+
     def set_environment_variable(self, key, value):
         # TODO: Maybe use subprocess.list2cmdline for Windows ?
-        yield "set " + key + "=" + value.replace('\n', '!NL! ^\n')
+        yield "set " + self._sanitize_key(key) + "=" + value.replace('\n', '!NL! ^\n')
 
     def remove_environment_variable(self, key):
-        yield "set " + key + "="
+        yield "set " + self._sanitize_key(key) + "="
 
     def remove_all_binary_shims(self, shims_path: str):
         shims = []

tests/it/test_shell_it.data/export-special-chars/ddb.yml

@@ -0,0 +1,3 @@
+permissions:
+  specs:
+    "bin/dependency-check": "+x"

tests/it/test_shell_it.py

@@ -0,0 +1,25 @@
+import re
+from pathlib import Path
+
+import pytest
+from _pytest.capture import CaptureFixture
+from ddb.__main__ import main
+
+
+@pytest.mark.skipif("os.name == 'nt'")
+class TestBashShell:
+    def test_export_special_chars(self, capsys: CaptureFixture, project_loader):
+        project_loader("export-special-chars")
+
+        main(["configure"])
+
+        main(["activate"])
+
+        outerr = capsys.readouterr()
+        script_lines = Path(outerr.out.split()[1].strip()).read_text().splitlines()
+        matches = [re.match('export (.+)=.*$', x) for x in script_lines]
+        matches = [x for x in matches if x]
+
+        for match in matches:
+            if match:
+                assert '/' not in match.group(1)