cumulusci-plus 5.0.24__py3-none-any.whl → 5.0.25__py3-none-any.whl

cumulusci/__about__.py

@@ -1 +1 @@
-__version__ = "5.0.24"
+__version__ = "5.0.25"

cumulusci/cli/task.py

@@ -2,6 +2,7 @@ import json
 from pathlib import Path
 
 import click
+from dotenv import load_dotenv
 from rich.console import Console
 from rst2ansi import rst2ansi
 
@@ -126,6 +127,10 @@ class RunTaskCommand(click.MultiCommand):
             "help": "Drops into the Python debugger at task completion.",
             "is_flag": True,
         },
+        "loadenv": {
+            "help": "Loads environment variables from the .env file.",
+            "is_flag": True,
+        },
     }
 
     def list_commands(self, ctx):
@@ -151,6 +156,17 @@ class RunTaskCommand(click.MultiCommand):
 
         def run_task(*args, **kwargs):
             """Callback function that executes when the command fires."""
+            # Load environment variables FIRST, before any task processing
+            if kwargs.get("loadenv", None):
+                # Load .env file from the project root directory
+                env_path = (
+                    Path(runtime.project_config.repo_root) / ".env"
+                    if runtime.project_config
+                    else None
+                )
+                if env_path:
+                    load_dotenv(env_path)
+
             org, org_config = runtime.get_org(
                 kwargs.pop("org", None), fail_if_missing=False
             )
@@ -168,6 +184,7 @@ class RunTaskCommand(click.MultiCommand):
             task_config.config["options"].update(options)
 
             try:
+
                 task = task_class(
                     task_config.project_config, task_config, org_config=org_config
                 )

cumulusci/cli/tests/test_task.py

@@ -1,6 +1,8 @@
 import contextlib
 import io
 import json
+import tempfile
+from pathlib import Path
 from unittest.mock import Mock, patch
 
 import click
@@ -126,10 +128,10 @@ def test_format_help(runtime):
 
 def test_get_default_command_options():
     opts = task.RunTaskCommand()._get_default_command_options(is_salesforce_task=False)
-    assert len(opts) == 4
+    assert len(opts) == 5
 
     opts = task.RunTaskCommand()._get_default_command_options(is_salesforce_task=True)
-    assert len(opts) == 5
+    assert len(opts) == 6
     assert any([o.name == "org" for o in opts])
 
 
@@ -264,3 +266,87 @@ class SetTrace(Exception):
 class DummyDerivedTask(DummyTask):
     def _run_task(self):
         click.echo(f"<{self.__class__}>\n\tcolor: {self.options['color']}")
+
+
+@patch("cumulusci.cli.task.load_dotenv")
+def test_task_run__loadenv_with_project_root(load_dotenv, runtime):
+    """Test that loadenv loads .env file from project root when project exists."""
+    DummyTask._run_task = Mock()
+
+    # Create a temporary directory for the test
+    with tempfile.TemporaryDirectory() as temp_dir:
+        runtime.project_config._repo_info = {"root": temp_dir}
+
+        multi_cmd = task.RunTaskCommand()
+        with click.Context(multi_cmd, obj=runtime) as ctx:
+            cmd = multi_cmd.get_command(ctx, "dummy-task")
+            cmd.callback(runtime, "dummy-task", color="blue", loadenv=True)
+
+        # Verify load_dotenv was called with the correct path
+        expected_path = Path(temp_dir) / ".env"
+        load_dotenv.assert_called_once_with(expected_path)
+        DummyTask._run_task.assert_called_once()
+
+
+@patch("cumulusci.cli.task.load_dotenv")
+def test_task_run__loadenv_false(load_dotenv, runtime):
+    """Test that loadenv does not call load_dotenv when loadenv=False."""
+    DummyTask._run_task = Mock()
+
+    multi_cmd = task.RunTaskCommand()
+    with click.Context(multi_cmd, obj=runtime) as ctx:
+        cmd = multi_cmd.get_command(ctx, "dummy-task")
+        cmd.callback(runtime, "dummy-task", color="blue", loadenv=False)
+
+    # Verify load_dotenv was not called
+    load_dotenv.assert_not_called()
+    DummyTask._run_task.assert_called_once()
+
+
+@patch("cumulusci.cli.task.load_dotenv")
+def test_task_run__loadenv_not_provided(load_dotenv, runtime):
+    """Test that loadenv does not call load_dotenv when loadenv is not provided."""
+    DummyTask._run_task = Mock()
+
+    multi_cmd = task.RunTaskCommand()
+    with click.Context(multi_cmd, obj=runtime) as ctx:
+        cmd = multi_cmd.get_command(ctx, "dummy-task")
+        cmd.callback(runtime, "dummy-task", color="blue")
+
+    # Verify load_dotenv was not called
+    load_dotenv.assert_not_called()
+    DummyTask._run_task.assert_called_once()
+
+
+@patch("cumulusci.cli.task.load_dotenv")
+def test_task_run__loadenv_none_value(load_dotenv, runtime):
+    """Test that loadenv does not call load_dotenv when loadenv=None."""
+    DummyTask._run_task = Mock()
+
+    multi_cmd = task.RunTaskCommand()
+    with click.Context(multi_cmd, obj=runtime) as ctx:
+        cmd = multi_cmd.get_command(ctx, "dummy-task")
+        cmd.callback(runtime, "dummy-task", color="blue", loadenv=None)
+
+    # Verify load_dotenv was not called
+    load_dotenv.assert_not_called()
+    DummyTask._run_task.assert_called_once()
+
+
+def test_get_default_command_options_includes_loadenv():
+    """Test that the loadenv option is included in default command options."""
+    opts = task.RunTaskCommand()._get_default_command_options(is_salesforce_task=False)
+
+    # Should have 5 global options including loadenv
+    assert len(opts) == 5
+
+    # Find the loadenv option
+    loadenv_opt = None
+    for opt in opts:
+        if hasattr(opt, "name") and opt.name == "loadenv":
+            loadenv_opt = opt
+            break
+
+    assert loadenv_opt is not None
+    assert loadenv_opt.is_flag is True
+    assert "Loads environment variables from the .env file" in loadenv_opt.help

cumulusci/cumulusci.yml

@@ -795,6 +795,10 @@ tasks:
         description: Load Custom Settings specified in a YAML file to the target org
         class_path: cumulusci.tasks.salesforce.LoadCustomSettings
         group: "Data Operations"
+    sfdmu:
+        description: Execute SFDmu data migration with namespace injection support
+        class_path: cumulusci.tasks.sfdmu.sfdmu.SfdmuTask
+        group: "Data Operations"
     remove_metadata_xml_elements:
         description: Remove specified XML elements from one or more metadata files
         class_path: cumulusci.tasks.metadata.modify.RemoveElementsXPath
@@ -842,6 +846,14 @@ tasks:
         options:
             package_name: $project_config.project__package__name
             fail_on_error: False
+    update_named_credential:
+        class_path: cumulusci.tasks.salesforce.update_named_credential.UpdateNamedCredential
+        description: Update named credential parameters
+        group: Metadata Transformations
+    update_external_credential:
+        class_path: cumulusci.tasks.salesforce.update_external_credential.UpdateExternalCredential
+        description: Update external credential parameters
+        group: Metadata Transformations
 
 flows:
     ci_beta: