cumulusci-plus 5.0.17__py3-none-any.whl → 5.0.19__py3-none-any.whl

cumulusci/tasks/salesforce/tests/test_SfDataCommands.py

@@ -0,0 +1,363 @@
+import json
+from unittest import mock
+
+import pytest
+import sarge
+
+from cumulusci.core.exceptions import SalesforceDXException
+from cumulusci.tasks.salesforce.SfDataCommands import (
+    DataCreateRecordTask,
+    DataDeleteRecordTask,
+    DataQueryTask,
+    SfDataCommands,
+    SfDataToolingAPISupportedCommands,
+)
+
+from . import create_task
+
+
+def create_mock_sarge_command(stdout="", stderr="", returncode=0):
+    """Create a mock sarge.Command that satisfies type checking"""
+    mock_command = mock.Mock(spec=sarge.Command)
+    mock_command.returncode = returncode
+
+    # Mock stdout_text
+    stdout_lines = stdout.split("\n") if stdout else []
+    mock_stdout_text = mock.Mock()
+    mock_stdout_text.__iter__ = mock.Mock(return_value=iter(stdout_lines))
+    mock_stdout_text.read = mock.Mock(return_value=stdout)
+    mock_command.stdout_text = mock_stdout_text
+
+    # Mock stderr_text
+    stderr_lines = stderr.split("\n") if stderr else []
+    mock_stderr_text = mock.Mock()
+    mock_stderr_text.__iter__ = mock.Mock(return_value=iter(stderr_lines))
+    mock_stderr_text.read = mock.Mock(return_value=stderr)
+    mock_command.stderr_text = mock_stderr_text
+
+    return mock_command
+
+
+@mock.patch("cumulusci.tasks.salesforce.SfDataCommands.sfdx")
+class TestSfDataCommands:
+    def test_init_options_basic(self, mock_sfdx):
+        mock_sfdx.return_value = create_mock_sarge_command()
+        task = create_task(SfDataCommands, {})
+        task()
+        assert task.data_command == "data "
+        assert task.args == []
+
+    def test_init_options_all_flags(self, mock_sfdx):
+        json_response = {"status": 0, "result": {}}
+        mock_sfdx.return_value = create_mock_sarge_command(
+            stdout=json.dumps(json_response)
+        )
+        task = create_task(
+            SfDataCommands,
+            {
+                "json_output": True,
+                "api_version": "50.0",
+                "flags_dir": "/tmp/flags",
+            },
+        )
+        task()
+        expected_args = [
+            "--flags-dir ",
+            "/tmp/flags",
+            "--json",
+            "--api_version",
+            "50.0",
+        ]
+        assert all(arg in task.args for arg in expected_args)
+
+    def test_load_json_output_success(self, mock_sfdx):
+        json_response = {"status": 0, "result": {"records": []}}
+        stdout = json.dumps(json_response)
+        mock_command = create_mock_sarge_command(stdout=stdout)
+        mock_sfdx.return_value = mock_command
+
+        task = create_task(SfDataCommands, {"json_output": True})
+        task()
+
+        assert task.return_values == json_response
+
+    def test_load_json_output_decode_error(self, mock_sfdx):
+        mock_command = create_mock_sarge_command(stdout="invalid json")
+        mock_sfdx.return_value = mock_command
+
+        task = create_task(SfDataCommands, {"json_output": True})
+
+        with pytest.raises(SalesforceDXException, match="Failed to parse the output"):
+            task()
+
+    def test_logging_stdout_and_stderr(self, mock_sfdx):
+        mock_command = create_mock_sarge_command(
+            stdout="Success: Query completed\nFound 5 records",
+            stderr="Warning: Some non-critical issue",
+        )
+        mock_sfdx.return_value = mock_command
+
+        task = create_task(SfDataCommands, {})
+        with mock.patch.object(task, "logger") as mock_logger:
+            task()
+
+            # Check that stdout lines were logged as info
+            mock_logger.info.assert_any_call("Success: Query completed")
+            mock_logger.info.assert_any_call("Found 5 records")
+
+            # Check that stderr lines were logged as error
+            mock_logger.error.assert_called_with("Warning: Some non-critical issue")
+
+
+@mock.patch("cumulusci.tasks.salesforce.SfDataCommands.sfdx")
+class TestSfDataToolingAPISupportedCommands:
+    def test_inherits_from_base(self, mock_sfdx):
+        mock_sfdx.return_value = create_mock_sarge_command()
+        task = create_task(SfDataToolingAPISupportedCommands, {})
+        assert isinstance(task, SfDataCommands)
+
+    def test_use_tooling_api_option(self, mock_sfdx):
+        mock_sfdx.return_value = create_mock_sarge_command()
+        task = create_task(SfDataToolingAPISupportedCommands, {"use_tooling_api": True})
+        # Test that the option is available (would be tested in subclasses that use it)
+        assert hasattr(task.parsed_options, "use_tooling_api")
+
+
+@mock.patch("cumulusci.tasks.salesforce.SfDataCommands.sfdx")
+class TestDataQueryTask:
+    def test_init_task_sets_command(self, mock_sfdx):
+        mock_sfdx.return_value = create_mock_sarge_command()
+        task = create_task(DataQueryTask, {"query": "SELECT Id FROM Account"})
+        task()
+        assert task.data_command == "data query"
+
+    def test_init_options_all_parameters(self, mock_sfdx):
+        json_response = {"status": 0, "result": {"records": []}}
+        mock_sfdx.return_value = create_mock_sarge_command(
+            stdout=json.dumps(json_response)
+        )
+        task = create_task(
+            DataQueryTask,
+            {
+                "query": "SELECT Id FROM Account",
+                "file": "/tmp/query.soql",
+                "all_rows": True,
+                "result_format": "csv",
+                "output_file": "/tmp/output.csv",
+                "api_version": "50.0",
+                "flags_dir": "/tmp/flags",
+                "json_output": True,
+                "use_tooling_api": True,
+            },
+        )
+        task()
+
+        call_args = mock_sfdx.call_args[1]["args"]
+        assert mock_sfdx.call_args[1]["log_note"] == "Running data command"
+        assert "--query" in call_args
+        assert "SELECT Id FROM Account" in call_args
+        assert "--file" in call_args
+        assert "/tmp/query.soql" in call_args
+        assert "--all-rows" in call_args
+        assert "--result-format" in call_args
+        assert "csv" in call_args
+        assert "--output-file" in call_args
+        assert "/tmp/output.csv" in call_args
+        assert "--api_version" in call_args
+        assert "50.0" in call_args
+        assert "--flags-dir " in call_args
+        assert "/tmp/flags" in call_args
+        assert "--json" in call_args
+
+    def test_minimal_options(self, mock_sfdx):
+        mock_sfdx.return_value = create_mock_sarge_command()
+        task = create_task(DataQueryTask, {"query": "SELECT Id FROM Account"})
+        task()
+
+        call_args = mock_sfdx.call_args[1]["args"]
+        assert "--query" in call_args
+        assert "SELECT Id FROM Account" in call_args
+
+    def test_json_output_logging(self, mock_sfdx):
+        json_response = {"status": 0, "result": {"records": [{"Id": "123"}]}}
+        stdout = json.dumps(json_response)
+        mock_sfdx.return_value = create_mock_sarge_command(stdout=stdout)
+
+        task = create_task(
+            DataQueryTask,
+            {"query": "SELECT Id FROM Account", "json_output": True},
+        )
+
+        with mock.patch.object(task, "logger") as mock_logger:
+            task()
+            mock_logger.info.assert_called_with(json_response)
+
+    def test_run_task_json_decode_error(self, mock_sfdx):
+        mock_sfdx.return_value = create_mock_sarge_command(stdout="this is not json")
+        task = create_task(
+            DataQueryTask,
+            {"query": "SELECT Id FROM Account", "json_output": True},
+        )
+        with pytest.raises(
+            SalesforceDXException,
+            match="Failed to parse the output of the data query command",
+        ):
+            task()
+
+
+@mock.patch("cumulusci.tasks.salesforce.SfDataCommands.sfdx")
+class TestDataCreateRecordTask:
+    def test_init_task_sets_command(self, mock_sfdx):
+        mock_sfdx.return_value = create_mock_sarge_command()
+        task = create_task(
+            DataCreateRecordTask,
+            {"sobject": "Account", "values": "Name='Test Account'"},
+        )
+        task()
+        assert task.data_command == "data create record"
+
+    def test_init_options_all_parameters(self, mock_sfdx):
+        json_response = {"status": 0, "result": {"id": "001000000000001"}}
+        mock_sfdx.return_value = create_mock_sarge_command(
+            stdout=json.dumps(json_response)
+        )
+        task = create_task(
+            DataCreateRecordTask,
+            {
+                "sobject": "Account",
+                "values": "Name='Test Account' Industry='Technology'",
+                "api_version": "50.0",
+                "flags_dir": "/tmp/flags",
+                "json_output": True,
+                "use_tooling_api": True,
+            },
+        )
+        task()
+
+        call_args = mock_sfdx.call_args[1]["args"]
+        assert mock_sfdx.call_args[1]["log_note"] == "Running data command"
+        assert "--sobject" in call_args
+        assert "Account" in call_args
+        assert "--values" in call_args
+        assert "Name='Test Account' Industry='Technology'" in call_args
+        assert "--api_version" in call_args
+        assert "50.0" in call_args
+        assert "--flags-dir " in call_args
+        assert "/tmp/flags" in call_args
+        assert "--json" in call_args
+
+    def test_minimal_options(self, mock_sfdx):
+        mock_sfdx.return_value = create_mock_sarge_command()
+        task = create_task(
+            DataCreateRecordTask,
+            {"sobject": "Contact", "values": "LastName='Doe'"},
+        )
+        task()
+
+        call_args = mock_sfdx.call_args[1]["args"]
+        assert "--sobject" in call_args
+        assert "Contact" in call_args
+        assert "--values" in call_args
+        assert "LastName='Doe'" in call_args
+
+    def test_missing_required_options(self, mock_sfdx):
+        # Test that required field validation works as expected
+        mock_sfdx.return_value = create_mock_sarge_command()
+        from cumulusci.core.exceptions import TaskOptionsError
+
+        with pytest.raises(TaskOptionsError, match="field required"):
+            create_task(DataCreateRecordTask, {})
+
+
+@mock.patch("cumulusci.tasks.salesforce.SfDataCommands.sfdx")
+class TestDataDeleteRecordTask:
+    def test_init_task_sets_command(self, mock_sfdx):
+        mock_sfdx.return_value = create_mock_sarge_command()
+        task = create_task(
+            DataDeleteRecordTask, {"sobject": "Account", "record_id": "001000000000001"}
+        )
+        task()
+        assert task.data_command == "data delete record"
+
+    def test_delete_by_record_id(self, mock_sfdx):
+        json_response = {"status": 0, "result": {}}
+        mock_sfdx.return_value = create_mock_sarge_command(
+            stdout=json.dumps(json_response)
+        )
+        task = create_task(
+            DataDeleteRecordTask,
+            {
+                "sobject": "Account",
+                "record_id": "001000000000001AAA",
+                "api_version": "50.0",
+                "flags_dir": "/tmp/flags",
+                "json_output": True,
+            },
+        )
+        task()
+
+        call_args = mock_sfdx.call_args[1]["args"]
+        assert mock_sfdx.call_args[1]["log_note"] == "Running data command"
+        assert "--sobject" in call_args
+        assert "Account" in call_args
+        assert "--record-id" in call_args
+        assert "001000000000001AAA" in call_args
+        assert "--api_version" in call_args
+        assert "50.0" in call_args
+        assert "--flags-dir " in call_args
+        assert "/tmp/flags" in call_args
+        assert "--json" in call_args
+
+    def test_delete_by_where_clause(self, mock_sfdx):
+        mock_sfdx.return_value = create_mock_sarge_command()
+        task = create_task(
+            DataDeleteRecordTask,
+            {
+                "sobject": "Account",
+                "where": "Name='Test Account' AND Industry='Technology'",
+                "use_tooling_api": True,
+            },
+        )
+        task()
+
+        call_args = mock_sfdx.call_args[1]["args"]
+        # Check that sfdx was called with the right log_note
+        assert mock_sfdx.call_args[1]["log_note"] == "Running data command"
+        assert "--sobject" in call_args
+        assert "Account" in call_args
+        assert "--where" in call_args
+        assert "Name='Test Account' AND Industry='Technology'" in call_args
+
+    def test_minimal_options(self, mock_sfdx):
+        mock_sfdx.return_value = create_mock_sarge_command()
+        task = create_task(
+            DataDeleteRecordTask,
+            {"sobject": "Contact"},
+        )
+        task()
+
+        call_args = mock_sfdx.call_args[1]["args"]
+        assert "--sobject" in call_args
+        assert "Contact" in call_args
+        # Should not have --record-id or --where if not provided
+        assert "--record-id" not in call_args
+        assert "--where" not in call_args
+
+    def test_both_record_id_and_where_provided(self, mock_sfdx):
+        # Test that both options can be provided (though this might not be practical)
+        mock_sfdx.return_value = create_mock_sarge_command()
+        task = create_task(
+            DataDeleteRecordTask,
+            {
+                "sobject": "Account",
+                "record_id": "001000000000001",
+                "where": "Name='Test Account'",
+            },
+        )
+        task()
+
+        call_args = mock_sfdx.call_args[1]["args"]
+        assert "--record-id" in call_args
+        assert "001000000000001" in call_args
+        assert "--where" in call_args
+        assert "Name='Test Account'" in call_args

cumulusci/tasks/salesforce/tests/test_profiles.py

@@ -95,6 +95,15 @@ def test_run_task_success():
         json={
             "done": True,
             "totalSize": 1,
+            "records": [],
+        },
+    )
+    responses.add(
+        responses.GET,
+        query_url,
+        json={
+            "done": True,
+            "totalSize": 0,
             "records": [
                 {
                     "attributes": {
@@ -115,9 +124,12 @@ def test_run_task_success():
     result = task._run_task()
     assert result == "001R0000029IyDPIA0"
     assert responses.calls[0].request.params == {
+        "q": "SELECT Id, Name FROM Profile WHERE FullName = 'Test Profile Name' LIMIT 1"
+    }
+    assert responses.calls[1].request.params == {
         "q": "SELECT Id, Name FROM UserLicense WHERE Name = 'Foo' LIMIT 1"
     }
-    soap_body = responses.calls[1].request.body
+    soap_body = responses.calls[2].request.body
     assert "<Name>Test Profile Name</Name>" in str(soap_body)
     assert "<UserLicenseId>10056000000VGjUAAW</UserLicenseId>" in str(soap_body)
     assert "<Description>Have fun stormin da castle</Description>" in str(soap_body)
@@ -135,6 +147,15 @@ def test_run_task_fault():
     )
     task.org_config._latest_api_version = "53.0"
 
+    responses.add(
+        responses.GET,
+        "https://test.salesforce.com/services/data/v53.0/query/",
+        json={
+            "done": True,
+            "totalSize": 0,
+            "records": [],
+        },
+    )
     responses.add(
         responses.POST,
         "https://test.salesforce.com/services/Soap/u/53.0/ORG_ID",
@@ -157,6 +178,17 @@ def test_run_task_field_error():
         },
     )
     task.org_config._latest_api_version = "53.0"
+
+    responses.add(
+        responses.GET,
+        "https://test.salesforce.com/services/data/v53.0/query/",
+        json={
+            "done": True,
+            "totalSize": 0,
+            "records": [],
+        },
+    )
+
     responses.add(
         responses.POST,
         "https://test.salesforce.com/services/Soap/u/53.0/ORG_ID",
@@ -180,6 +212,16 @@ def test_run_task_error():
     )
     task.org_config._latest_api_version = "53.0"
 
+    responses.add(
+        responses.GET,
+        "https://test.salesforce.com/services/data/v53.0/query/",
+        json={
+            "done": True,
+            "totalSize": 0,
+            "records": [],
+        },
+    )
+
     responses.add(
         responses.POST,
         "https://test.salesforce.com/services/Soap/u/53.0/ORG_ID",
@@ -200,3 +242,85 @@ def test_task_options_error():
                 "description": "Foo",
             },
         )
+
+
+@responses.activate
+def test_run_task_success_with_collision_check():
+    query_url = "https://test.salesforce.com/services/data/v53.0/query/"
+
+    task = create_task(
+        CreateBlankProfile,
+        {
+            "license": "Foo",
+            "name": "Test Profile Name",
+            "description": "Have fun stormin da castle",
+        },
+    )
+    task.org_config._latest_api_version = "53.0"
+
+    responses.add(
+        responses.GET,
+        query_url,
+        json={
+            "done": True,
+            "totalSize": 1,
+            "records": [
+                {
+                    "attributes": {
+                        "type": "Profile",
+                        "url": "/services/data/v53.0/sobjects/Profile/10056000000VGjUAAW",
+                    },
+                    "Id": "10056000000VGjUAAW",
+                    "Name": "Test Profile Name",
+                }
+            ],
+        },
+    )
+
+    result = task._run_task()
+    assert result == "10056000000VGjUAAW"
+    assert responses.calls[0].request.params == {
+        "q": "SELECT Id, Name FROM Profile WHERE FullName = 'Test Profile Name' LIMIT 1"
+    }
+
+
+@responses.activate
+def test_run_task_with_invalid_license():
+    query_url = "https://test.salesforce.com/services/data/v53.0/query/"
+
+    task = create_task(
+        CreateBlankProfile,
+        {
+            "license": "Foo",
+            "name": "Test Profile Name",
+            "description": "Have fun stormin da castle",
+        },
+    )
+    task.org_config._latest_api_version = "53.0"
+
+    responses.add(
+        responses.GET,
+        query_url,
+        json={
+            "done": True,
+            "totalSize": 1,
+            "records": [],
+        },
+    )
+    responses.add(
+        responses.GET,
+        query_url,
+        json={
+            "done": True,
+            "totalSize": 0,
+            "records": [],
+        },
+    )
+    responses.add(
+        responses.POST,
+        "https://test.salesforce.com/services/Soap/u/53.0/ORG_ID",
+        RESPONSE_SUCCESS,
+    )
+    with pytest.raises(TaskOptionsError) as e:
+        task._run_task()
+    assert "License name 'Foo' was not found." in str(e)

cumulusci/tasks/salesforce/tests/test_update_dependencies.py

@@ -362,7 +362,7 @@ def test_install_dependency_installs_unmanaged():
 
     task._install_dependency(task.dependencies[0])
     task.dependencies[0].install.assert_called_once_with(
-        task.project_config, task.org_config
+        task.project_config, task.org_config, task.options
     )
 
 

cumulusci/tasks/salesforce/update_dependencies.py

@@ -64,6 +64,9 @@ class UpdateDependencies(BaseSalesforceTask):
         "base_package_url_format": {
             "description": "If `interactive` is set to True, display package Ids using a format string ({} will be replaced with the package Id)."
         },
+        "force_pre_post_install": {
+            "description": "Forces the pre-install and post-install steps to be run. Defaults to False."
+        },
         **{k: v for k, v in PACKAGE_INSTALL_TASK_OPTIONS.items() if k != "password"},
     }
 
@@ -220,8 +223,11 @@ class UpdateDependencies(BaseSalesforceTask):
             if not click.confirm("Continue to install dependencies?", default=True):
                 raise CumulusCIException("Dependency installation was canceled.")
 
-        for d in dependencies:
-            self._install_dependency(d)
+        if dependencies:
+            self.logger.info("Installing dependencies:")
+
+            for d in dependencies:
+                self._install_dependency(d)
 
         self.org_config.reset_installed_packages()
 
@@ -233,7 +239,7 @@ class UpdateDependencies(BaseSalesforceTask):
                 self.project_config, self.org_config, self.install_options
             )
         else:
-            dependency.install(self.project_config, self.org_config)
+            dependency.install(self.project_config, self.org_config, self.options)
 
     def freeze(self, step):
         if self.options["interactive"]:

cumulusci/tasks/utility/env_management.py

@@ -109,14 +109,10 @@ class EnvManagementOption(CCIOptions):
                 f"Formatting Error: {value} for datatype: {datatype} - {e}"
             )
 
-        if self.set and self.name not in os.environ:
+        if self.set:
             os.environ[self.name] = str(task_values[self.name])
 
-        if (
-            self.set
-            and self.datatype == "vcs_repo"
-            and f"{self.name}_BRANCH" not in os.environ
-        ):
+        if self.set and self.datatype == "vcs_repo":
             os.environ[f"{self.name}_BRANCH"] = str(task_values[f"{self.name}_BRANCH"])
 
 

{cumulusci_plus-5.0.17.dist-info → cumulusci_plus-5.0.19.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cumulusci-plus
-Version: 5.0.17
+Version: 5.0.19
 Summary: Build and release tools for Salesforce developers
 Project-URL: Homepage, https://github.com/jorgesolebur/CumulusCI
 Project-URL: Changelog, https://cumulusci.readthedocs.io/en/stable/history.html
@@ -127,7 +127,7 @@ license](https://github.com/SFDO-Tooling/CumulusCI/blob/main/LICENSE)
 and is not covered by the Salesforce Master Subscription Agreement.
 
 <!-- Changelog -->
-## v5.0.17 (2025-08-21)
+## v5.0.19 (2025-09-04)
 
 <!-- Release notes generated using configuration in .github/release.yml at main -->
 
@@ -135,6 +135,6 @@ and is not covered by the Salesforce Master Subscription Agreement.
 
 ### Changes
 
-- Add custom data type vcs_repo. by [@rupeshjSFDC](https://github.com/rupeshjSFDC) in [#59](https://github.com/jorgesolebur/CumulusCI/pull/59)
+- Feature/pm 2055 pre post flow by [@rupeshjSFDC](https://github.com/rupeshjSFDC) in [#63](https://github.com/jorgesolebur/CumulusCI/pull/63)
 
-**Full Changelog**: https://github.com/jorgesolebur/CumulusCI/compare/v5.0.16...v5.0.17
+**Full Changelog**: https://github.com/jorgesolebur/CumulusCI/compare/v5.0.18...v5.0.19