Merge pull request #437 from dipdup-net/fix/commented-config-lines

Stop processing commented config lines

Author: igorsereda

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog],
 and this project adheres to [Semantic Versioning].
 
+## [Unreleased]
+
+### Fixed
+
+- config: Do not perform env variable substitution in commented out lines.
+
 ## [6.0.0-rc1] - 2022-07-26
 
 ### Added

src/dipdup/config.py

@@ -1391,10 +1391,14 @@ def _load_raw_config(cls, path: str) -> str:
         _logger.debug('Loading config from %s', path)
         try:
             with open(path) as file:
-                return file.read()
+                return ''.join(filter(cls._filter_commented_lines, file.readlines()))
         except OSError as e:
             raise ConfigurationError(str(e)) from e
 
+    @classmethod
+    def _filter_commented_lines(cls, line: str) -> bool:
+        return '#' not in line or line.lstrip()[0] != '#'
+
     @classmethod
     def _substitute_env_variables(cls, raw_config: str) -> Tuple[str, Dict[str, str]]:
         _logger.debug('Substituting environment variables')

tests/test_dipdup/test_config/test_custom_config.py

@@ -111,3 +111,17 @@ def test_env_parsing_negative(self, value, dummy_config_path, tmp_path_factory)
             assert exc.args[0] == 'Environment variable `DEFINITELY_NOT_DEFINED` is not set'
         else:
             raise AssertionError('ConfigurationError not raised')
+
+    @pytest.mark.parametrize(
+        'value',
+        (
+            '${DEFINITELY_NOT_DEFINED}',
+            '${DEFINITELY_NOT_DEFINED:-}',
+        ),
+    )
+    def test_skip_commented_variables(self, value, dummy_config_path, tmp_path_factory) -> None:
+        append_raw = f"""
+  #  some commented line corresponding to ENV_VARIABLE_REGEX with {value}
+"""
+        config_path = self.appended_config_path(dummy_config_path, tmp_path_factory, append_raw)
+        DipDupConfig.load([config_path], True)