test to show config priority behaves correctly

davidhyman · davidhyman · commit 81231a4c60d1 · 2018-06-12T12:19:53.000+01:00
diff --git a/src/snippet/cli.py b/src/snippet/cli.py
@@ -7,10 +7,10 @@
 
 def get_cli_opts():
     parser = argparse.ArgumentParser()
-    parser.add_argument('--config', type=str,
-                        help='path to config file')
+    parser.add_argument('--config', type=str, action='append',
+                        help='paths (or globs) to config files')
     parser.add_argument('dir', nargs='?', default=os.getcwd(),
-                        help='path to project root, used by relative paths in config [cwd]')
+                        help='path to project root, used by any relative paths in loaded configs [cwd]')
     parser.add_argument('-v', '--verbosity', action='count', default=0,
                         help='increase output verbosity')
     return parser
@@ -21,7 +21,7 @@ def run_from_cli():
     log_level = logging.WARNING - 10 * args.verbosity
     logging.basicConfig(level=log_level)
     snippet.main(snippet.config.get_config(
-        config_path=args.config,
+        config_paths=args.config,
         project_root=args.dir,
     ))
 
diff --git a/src/snippet/config.py b/src/snippet/config.py
@@ -39,18 +39,32 @@ class Config:
     stop_on_first_failure = False  # fail early
 
 
-def find_config(root):
-    return glob.glob(os.path.join(root, '**', '*.toml'), recursive=True)
+def find_configs(glob_patterns):
+    configs = []
+    for glob_pattern in glob_patterns:
+        configs.extend(glob.glob(glob_pattern, recursive=True))
+    return configs
 
 
-def get_config(config_path=None, **options):
+def config_paths_from_env():
+    env_var = os.environ.get('SNIPPET_CONFIG_PATH')
+    return list(env_var) if env_var else []
+
+
+def get_config(config_paths=None, **options):
     config = Config()
     project_root = os.path.abspath(options.get('project_root', config.project_root))
 
     new_options = {}
-    config_path = config_path or os.environ.get('SNIPPET_CONFIG_PATH')
-    toml_files = [config_path] if config_path else find_config(root=project_root)
-    for toml_file in toml_files:
+
+    config_paths = config_paths or []
+    config_paths.extend(config_paths_from_env())
+
+    # fallback option - search the project directory
+    if not config_paths:
+        config_paths.append(os.path.join(project_root, '**', '*.toml'))
+
+    for toml_file in find_configs(glob_patterns=config_paths):
         logging.debug('trying config from %s', toml_file)
         with open(toml_file) as f:
             try:
diff --git a/tests/samples/config_fixture.md b/tests/samples/config_fixture.md
@@ -1,6 +1,6 @@
 ```python
 # example: this config is itself an example
-input_glob = '*'
+input_glob = 'does not match anything'
 
 stop_on_first_failure = true
 ```
diff --git a/tests/test_config.py b/tests/test_config.py
@@ -23,12 +23,22 @@ def setUpClass(cls):
             fh.write(textwrap.dedent("""
             [snippet]
             # an example: this config is itself an example
-            input_glob = '*'
+            input_glob = 'does not match anything'
             
             stop_on_first_failure = true
             end_flag = 'custom value'
             
             foo = 'bar'
+            fizz = 'buzz'
+            """).lstrip())
+
+        cls.tmp_fp_2 = os.path.join(tmp_test_dir, 'config2.toml')
+        with open(cls.tmp_fp_2, 'w') as fh:
+            fh.write(textwrap.dedent("""
+            [snippet]
+            input_glob = 'config.toml'
+
+            foo = 'baz'
             """).lstrip())
 
     @classmethod
@@ -37,14 +47,21 @@ def tearDownClass(cls):
 
     def test_config_from_file(self):
         # explicitly load config from a file
-        config = snippet.config.get_config(config_path=self.tmp_fp)
+        config = snippet.config.get_config(config_paths=[self.tmp_fp])
         self.assertEqual(config.end_flag, 'custom value')
         self.assertEqual(config.foo, 'bar')
+        self.assertEqual(config.fizz, 'buzz')
+
+    def test_config_from_multi_globs(self):
+        # explicitly load from two files
+        config = snippet.config.get_config(config_paths=[self.tmp_fp, self.tmp_fp_2])
+        self.assertEqual(config.foo, 'baz')
+        self.assertEqual(config.fizz, 'buzz')
 
     def test_config_from_cli(self):
         # load config when run as a module
         subprocess.check_call(
-            [sys.executable, '-m', 'snippet', tmp_test_dir, '--config', self.tmp_fp],
+            [sys.executable, '-m', 'snippet', tmp_test_dir, '--config', self.tmp_fp, '--config', self.tmp_fp_2],
             stderr=subprocess.STDOUT
         )
 
@@ -58,4 +75,4 @@ def test_auto_config(self):
         # load config, without explicitly setting the config path
         config = snippet.config.get_config()
         self.assertEqual(config.end_flag, 'custom value')
-        self.assertEqual(config.foo, 'bar')
+        self.assertEqual(config.fizz, 'buzz')
