going crazy with configs

davidhyman · davidhyman · commit 3bdeb2ec0198 · 2018-03-28T21:09:23.000+01:00
diff --git a/src/snippet/cli.py b/src/snippet/cli.py
@@ -1,18 +1,29 @@
 import argparse
+import os
+import logging
 
 import snippet
 
 
 def get_cli_opts():
     parser = argparse.ArgumentParser()
-    parser.add_argument('--config', type=str, help='path to config file')
+    parser.add_argument('--config', type=str,
+                        help='path to config file')
+    parser.add_argument('dir', nargs='?', default=os.getcwd(),
+                        help='path to project root, used by relative paths in config [cwd]')
+    parser.add_argument('-v', '--verbosity', action='count', default=0,
+                        help='increase output verbosity')
     return parser
 
 
 def run_from_cli():
-    parser = get_cli_opts()
-    config_path = parser.parse_args().config
-    snippet.main(snippet.config.get_config(config_path))
+    args = get_cli_opts().parse_args()
+    log_level = logging.WARNING - 10 * args.verbosity
+    logging.basicConfig(level=log_level)
+    snippet.main(snippet.config.get_config(
+        config_path=args.config,
+        project_root=args.dir,
+    ))
 
 
 if __name__ == '__main__':
diff --git a/src/snippet/config.py b/src/snippet/config.py
@@ -1,3 +1,4 @@
+import glob
 import logging
 import os
 
@@ -6,10 +7,11 @@
 
 class Config:
     # IO
+    project_root = '.'  # the project root used for relative IO paths (set by commandline)
     input_glob = 'tests/example/*.py'
     output_template = '```python\n# example: {{{name}}}\n{{{code}}}\n```\n'  # a mustache template for each file
     output_append = False  # if the output file exists, append to it
-    output_dir = None
+    output_dir = '.'
     output_file_ext = 'md'
 
     # Logging
@@ -31,15 +33,41 @@ class Config:
     stop_on_first_failure = False  # fail early
 
 
+def find_config(root):
+    return (
+        glob.glob(os.path.join(root, '**\*.toml'), recursive=True) +
+        glob.glob(os.path.join(root, '**\*.cfg'), recursive=True)
+    )
+
+
 def get_config(config_path=None, **options):
+    config = Config()
+    project_root = os.path.abspath(options.get('project_root', config.project_root))
+
     new_options = {}
-    if config_path or os.environ.get('SNIPPET_CONFIG_PATH'):
-        with open(config_path) as f:
-            config_file_contents = toml.load(f)
-            snippet_config = config_file_contents['snippet']
-            new_options.update(snippet_config)
+    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:
+        logging.debug('trying config from %s', toml_file)
+        with open(toml_file) as f:
+            try:
+                config_file_contents = toml.load(f)
+            except toml.TomlDecodeError as e:
+                logging.debug('failed to load %s: %s', toml_file, e)
+                continue
+            snippet_config = config_file_contents.get('snippet')
+            if snippet_config:
+                logging.info('loading config from %s', toml_file)
+                new_options.update(snippet_config)
+
+    # passed keyword args override other parameters
     new_options.update(options)
-    config = Config()
+
+    # update the config object
     for k, v in new_options.items():
         setattr(config, k, v)
+
+    # validate and set IO directories that are relative to project root
+    config.input_glob = os.path.abspath(os.path.join(config.project_root, config.input_glob))
+    config.output_dir = os.path.abspath(os.path.join(config.project_root, config.output_dir))
     return config
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -1,3 +1,4 @@
 import os
 tmp_test_dirname = 'tmp_test_dir'
-tmp_test_dir = os.path.join(os.path.dirname(os.path.dirname(__file__)), tmp_test_dirname)
+tmp_test_dir = os.path.join(os.path.dirname(__file__), tmp_test_dirname)
+sample_input_dir = os.path.join(os.path.dirname(__file__), 'samples')
diff --git a/tests/samples/config_fixture.md b/tests/samples/config_fixture.md
@@ -0,0 +1,6 @@
+```python
+# example: this config is itself an example
+input_glob = '*'
+
+stop_on_first_failure = true
+```
diff --git a/tests/test_config.py b/tests/test_config.py
@@ -1,5 +1,6 @@
 import os
 import shutil
+import filecmp
 import subprocess
 import sys
 import textwrap
@@ -8,39 +9,53 @@
 import snippet
 
 from tests import tmp_test_dir
+from tests import sample_input_dir
 
 
 class Test(unittest.TestCase):
-    tmpdir = tmp_test_dir
 
     @classmethod
     def setUpClass(cls):
         # use a plain directory not-really-in-tmp to avoid cross-process perms issues in windows
-        os.makedirs(cls.tmpdir)
-        cls.tmp_fp = os.path.join(cls.tmpdir, 'config.toml')
+        os.makedirs(tmp_test_dir)
+        cls.tmp_fp = os.path.join(tmp_test_dir, 'config.toml')
         with open(cls.tmp_fp, 'w') as fh:
             fh.write(textwrap.dedent("""
             [snippet]
+            # an example: this config is itself an example
             input_glob = '*'
-            end_flag = 'custom value'
+            
             stop_on_first_failure = true
-            foo = 'bar'            
+            end_flag = 'custom value'
+            
+            foo = 'bar'
             """).lstrip())
 
     @classmethod
     def tearDownClass(cls):
-        shutil.rmtree(cls.tmpdir)
+        shutil.rmtree(tmp_test_dir)
 
     def test_config_from_file(self):
+        # explicitly load config from a file
         config = snippet.config.get_config(config_path=self.tmp_fp)
         self.assertEqual(config.end_flag, 'custom value')
         self.assertEqual(config.foo, 'bar')
 
     def test_config_from_cli(self):
-        with self.assertRaises(subprocess.CalledProcessError) as ctx:
-            subprocess.check_output(
-                [sys.executable, '-m', 'snippet', '--config', self.tmp_fp],
-                cwd=self.tmpdir,
-                stderr=subprocess.STDOUT
-            )
-        self.assertIn('snippet.exceptions', str(ctx.exception.output))
+        # load config when run as a module
+        subprocess.check_call(
+            [sys.executable, '-m', 'snippet', tmp_test_dir, '--config', self.tmp_fp],
+            stderr=subprocess.STDOUT
+        )
+
+        self.assertTrue(filecmp.cmp(
+            os.path.join(tmp_test_dir, 'thisconfigisitselfanexample.md'),
+            os.path.join(sample_input_dir, 'config_fixture.md'),
+            shallow=False,
+        ))
+
+    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')
diff --git a/tests/test_direct.py b/tests/test_direct.py
@@ -5,24 +5,19 @@
 import filecmp
 
 from tests import tmp_test_dir
+from tests import sample_input_dir
 
 
 class Test(unittest.TestCase):
-    sample_input = os.path.join(os.path.dirname(__file__), 'samples')
-    sample_output_dir = os.path.join(os.path.dirname(__file__), tmp_test_dir)
-
-    def setUp(self):
-        if os.path.exists(self.sample_output_dir):
-            shutil.rmtree(self.sample_output_dir)
 
     def tearDown(self):
-        shutil.rmtree(self.sample_output_dir)
+        shutil.rmtree(tmp_test_dir)
 
     def test_run(self):
         # writing two different languages sequentially to the same file
 
         config = snippet.Config()
-        config.output_dir = self.sample_output_dir
+        config.output_dir = tmp_test_dir
         config.output_append = True
 
         # only detect the python file
@@ -35,7 +30,7 @@ def test_run(self):
         snippet.main(config=config)
 
         self.assertTrue(filecmp.cmp(
-            os.path.join(self.sample_output_dir, 'number1.md'),
-            os.path.join(self.sample_input, 'fixture.md'),
+            os.path.join(tmp_test_dir, 'number1.md'),
+            os.path.join(sample_input_dir, 'fixture.md'),
             shallow=False,
         ))
