feat(cli): add CliRuntime.reload_project_config for post-init overrides

Adds a method that rebuilds project_config with an additional_yaml kwarg
and re-binds the keychain. Needed because CliRuntime is constructed in
cci.main() before Click has parsed subcommand options, so flags like
--extra-yaml cannot be applied at construction time.

Author: jstvz

cumulusci/cli/runtime.py

@@ -3,6 +3,7 @@
 import sys
 from logging import getLogger
 from subprocess import call
+from typing import Optional
 
 import click
 import keyring
@@ -26,6 +27,26 @@ def __init__(self, *args, **kwargs):
         except (KeychainKeyNotFound) as e:
             raise click.UsageError(f"Keychain Error: {str(e)}")
 
+    def reload_project_config(self, additional_yaml: Optional[str] = None) -> None:
+        """Rebuild project_config with an ``additional_yaml`` override.
+
+        ``CliRuntime`` loads ``project_config`` at construction time (via
+        ``BaseCumulusCI.__init__``), but Click options are only known after
+        construction. This method rebuilds ``project_config`` with the given
+        ``additional_yaml`` string and re-binds the keychain if one is
+        attached. No-ops when ``additional_yaml`` is ``None``.
+        """
+        if additional_yaml is None:
+            return
+        try:
+            self._load_project_config(additional_yaml=additional_yaml)
+        except ConfigError as e:
+            raise click.UsageError(f"Config Error: {str(e)}")
+        if self.keychain is not None:
+            self.keychain.project_config = self.project_config
+            if self.project_config is not None:
+                self.project_config.keychain = self.keychain
+
     def get_keychain_class(self):
         default_keychain_class = (
             self.project_config.cumulusci__keychain

cumulusci/cli/tests/test_runtime.py

@@ -107,6 +107,51 @@ def test_get_org_missing(self):
         with pytest.raises(click.UsageError):
             org_name, org_config_result = config.get_org("test", fail_if_missing=True)
 
+    def test_reload_project_config__applies_additional_yaml(self):
+        config = CliRuntime()
+        assert config.project_config.config_additional_yaml == {}
+
+        config.reload_project_config(
+            additional_yaml=(
+                "tasks:\n"
+                "  injected:\n"
+                "    description: via reload\n"
+                "    class_path: cumulusci.tasks.util.Sleep\n"
+            )
+        )
+
+        assert config.project_config.config_additional_yaml != {}
+        assert config.project_config.tasks["injected"]["description"] == "via reload"
+
+    def test_reload_project_config__rebinds_keychain(self):
+        config = CliRuntime()
+        old_keychain = config.keychain
+        assert old_keychain is not None
+        old_project_config = config.project_config
+
+        config.reload_project_config(
+            additional_yaml="project:\n  custom:\n    reloaded: true\n"
+        )
+
+        assert config.keychain is old_keychain
+        assert config.project_config is not old_project_config
+        assert config.keychain.project_config is config.project_config
+        assert config.project_config.keychain is config.keychain
+
+    def test_reload_project_config__noop_when_none(self):
+        config = CliRuntime()
+        before = config.project_config
+        config.reload_project_config(additional_yaml=None)
+        assert config.project_config is before
+
+    def test_reload_project_config__wraps_config_error(self):
+        config = CliRuntime()
+
+        with mock.patch.object(
+            config, "_load_project_config", side_effect=ConfigError("boom")
+        ), pytest.raises(click.UsageError, match="Config Error: boom"):
+            config.reload_project_config(additional_yaml="project: {}\n")
+
     def test_check_org_expired(self):
         config = CliRuntime()
         config.keychain = mock.Mock()