load_config() should load all commands. #395

Author: lemon24

src/reader/_app/legacy/wsgi.py

@@ -16,7 +16,7 @@
 import reader._cli
 
 
-config = reader._cli.load_reader_config('web')
+config = reader._cli.load_reader_config()
 app = reader._app.create_app(config)
 app.config['TRAP_BAD_REQUEST_ERRORS'] = bool(
     os.environ.get('FLASK_TRAP_BAD_REQUEST_ERRORS', '')

src/reader/_app/wsgi.py

@@ -16,7 +16,7 @@
 import reader._cli
 
 
-config = reader._cli.load_reader_config('web')
+config = reader._cli.load_reader_config()
 app = reader._app.create_app(config)
 app.config['TRAP_BAD_REQUEST_ERRORS'] = bool(
     os.environ.get('FLASK_TRAP_BAD_REQUEST_ERRORS', '')

src/reader/_cli.py

@@ -27,14 +27,14 @@
 log = logging.getLogger(__name__)
 
 
-def load_reader_config(*args, path=None, silent=False):
-    env = None
+def load_reader_config(path=None, silent=False):
+    prefix = env = None
     if path:
         if not silent:
-            args = ('--config', str(path)) + args
+            prefix = ('--config', os.fspath(path))
         else:
-            env = {'READER_CONFIG': str(path)}
-    config = load_config(cli, args, env)
+            env = {'READER_CONFIG': os.fspath(path)}
+    config = load_config(cli, prefix, env)
     config[''] = extract_args(config[''], make_reader)
     return config
 

src/reader/_config_utils.py

@@ -23,8 +23,8 @@ def config_option(*args, **kwargs):
     )
 
 
-def load_config(command, args=None, env=None):
-    """Return the parameters from invoking command with args,
+def load_config(command, prefix=None, env=None):
+    """Return the parameters from invoking command and its subcommands,
     but without actually running any (sub)command.
 
     Together with an option using load_defaults(),
@@ -38,23 +38,31 @@ def load_config(command, args=None, env=None):
 
     """
     command = copy.deepcopy(command)
-    calls = {}
+    prefix = tuple(prefix or ())
+    params = {}
+    leaves = []
 
     def callback(**kwargs):
-        calls.update(load_config_from_context())
+        params.update(load_config_from_context())
 
-    def patch_command(command):
+    def patch_command(command, path=()):
         command.callback = callback
         command.no_args_is_help = False
+        for param in list(command.params):
+            if isinstance(param, click.Argument):
+                command.params.remove(param)
         if hasattr(command, 'commands'):
             command.invoke_without_command = True
-            for subcommand in command.commands.values():
-                patch_command(subcommand)
+            for sub_name, sub in command.commands.items():
+                patch_command(sub, path + (sub_name,))
+        else:
+            leaves.append(path)
 
     patch_command(command)
     runner = click.testing.CliRunner(catch_exceptions=False)
-    runner.invoke(command, args, env=env, standalone_mode=False, prog_name='')
-    return calls
+    for args in leaves:
+        runner.invoke(command, prefix + args, env=env, standalone_mode=False)
+    return params
 
 
 def load_config_from_context():

tests/test_config_utils.py

@@ -31,37 +31,35 @@ def with_config(config):
     return with_config
 
 
-def check_all(args, expected, **kwargs):
+def invoke(cli, args=None, env=None):
     runner = CliRunner(catch_exceptions=False)
+    result = runner.invoke(cli, args, env=env, standalone_mode=False)
+    return result.return_value
 
-    result = runner.invoke(cli, args, standalone_mode=False, **kwargs)
-    assert expected == result.return_value
-
-    loaded = load_config(cli, args)
-    assert expected == loaded
-
-
-def check_error(args, strings=(), exc_type=click.BadParameter, **kwargs):
-    runner = CliRunner(catch_exceptions=False)
 
+def check_error(strings=(), exc_type=click.BadParameter):
     with pytest.raises(exc_type) as exc_info:
-        runner.invoke(cli, args, standalone_mode=False, **kwargs)
+        invoke(cli, ['sub'])
     for s in strings:
         assert s in str(exc_info.value).lower()
 
     with pytest.raises(exc_type) as exc_info:
-        loaded = load_config(cli, args)
+        loaded = load_config(cli)
     for s in strings:
         assert s in str(exc_info.value).lower()
 
 
 def test_no_config():
-    check_all(['sub'], {'': {'plugin': ()}, 'sub': {'option': 'DEFAULT'}})
+    expected = {'': {'plugin': ()}, 'sub': {'option': 'DEFAULT'}}
+    assert invoke(cli, ['sub']) == expected
+    assert load_config(cli) == expected
 
 
 def test_empty_config(with_config):
     with_config("[cli]")
-    check_all(['sub'], {'': {'plugin': ()}, 'sub': {'option': 'DEFAULT'}})
+    expected = {'': {'plugin': ()}, 'sub': {'option': 'DEFAULT'}}
+    assert invoke(cli, ['sub']) == expected
+    assert load_config(cli) == expected
 
 
 def test_config(with_config):
@@ -73,43 +71,37 @@ def test_config(with_config):
         option='config'
         """
     )
-    load_config(cli, []) == {'': {'plugin': ('CONFIG',)}}
-    check_all(
-        ['sub'],
-        {
-            '': {'plugin': ('CONFIG',)},
-            'sub': {'option': 'CONFIG'},
-        },
-    )
-    check_all(
-        ['--plugin', 'user', 'sub', '--option', 'user'],
-        {
-            '': {'plugin': ('CONFIG', 'USER')},
-            'sub': {'option': 'USER'},
-        },
-    )
+
+    expected = {'': {'plugin': ('CONFIG',)}, 'sub': {'option': 'CONFIG'}}
+    assert invoke(cli, ['sub']) == expected
+    assert load_config(cli) == expected
+
+    env = {'CLI_SUB_OPTION': 'env'}
+    expected = {'': {'plugin': ('CONFIG', 'USER')}, 'sub': {'option': 'ENV'}}
+    assert invoke(cli, ['--plugin', 'user', 'sub'], env=env)
+    assert load_config(cli, ['--plugin', 'user'], env=env)
 
 
 def test_toml_error(with_config):
     with_config("[cli")
-    check_error(['sub'], ['toml error'])
+    check_error(['toml error'])
 
 
 def test_no_section_error(with_config):
     with_config("")
-    check_error(['sub'], ['no [cli] section'])
+    check_error(['no [cli] section'])
 
 
 def test_bad_section_type_error(with_config):
     with_config("cli = 1")
-    check_error(['sub'], ['cli:', 'expected mapping'])
+    check_error(['cli:', 'expected mapping'])
 
 
 def test_unknown_option_error(with_config):
     with_config("[cli]\nunknown = 1")
-    check_error(['sub'], ['cli.unknown:', 'no such option'])
+    check_error(['cli.unknown:', 'no such option'])
 
 
 def test_unknown_command_error(with_config):
     with_config("[cli.unknown]")
-    check_error(['sub'], ['cli.unknown:', 'no such option'])
+    check_error(['cli.unknown:', 'no such option'])