cumulusci-plus 5.0.0__py3-none-any.whl

cumulusci/tasks/salesforce/tests/test_sourcetracking.py

@@ -0,0 +1,350 @@
+import json
+import os
+import pathlib
+from unittest import mock
+
+import pytest
+
+from cumulusci.core.config import OrgConfig
+from cumulusci.core.exceptions import ProjectConfigNotFound
+from cumulusci.tasks.salesforce.retrieve_profile import RetrieveProfile
+from cumulusci.tasks.salesforce.sourcetracking import (
+    KNOWN_BAD_MD_TYPES,
+    ListChanges,
+    RetrieveChanges,
+    SnapshotChanges,
+    _write_manifest,
+    retrieve_components,
+)
+from cumulusci.tests.util import create_project_config
+from cumulusci.utils import temporary_dir
+
+
+@pytest.fixture
+def vcr_cassette_dir():
+    return os.path.join(os.path.dirname(__file__), "cassettes")
+
+
+class TestListChanges:
+    """List the changes from a scratch org"""
+
+    def test_run_task(self, create_task_fixture):
+        task = create_task_fixture(ListChanges, {"exclude": "Ignore"})
+        task._init_task()
+        task.tooling = mock.Mock()
+        task.logger = mock.Mock()
+        task.tooling.query_all.return_value = {
+            "totalSize": 1,
+            "records": [
+                {
+                    "MemberType": "CustomObject",
+                    "MemberName": "Test__c",
+                    "RevisionCounter": 1,
+                },
+                {
+                    "MemberType": "CustomObject",
+                    "MemberName": "Ignored__c",
+                    "RevisionCounter": 2,
+                },
+            ],
+        }
+        task._run_task()
+        assert "CustomObject: Test__c" in task.logger.info.call_args[0][0]
+
+    def test_run_task__no_changes(self, create_task_fixture):
+        task = create_task_fixture(ListChanges)
+        task._init_task()
+        task.tooling = mock.Mock()
+        task.logger = mock.Mock()
+        task.tooling.query_all.return_value = {"totalSize": 0, "records": []}
+        task._run_task()
+        assert "Found no changes." in task.logger.info.call_args[0][0]
+
+    def test_run_task__snapshot(self, create_task_fixture):
+        with temporary_dir():
+            task = create_task_fixture(ListChanges, {"snapshot": True})
+            task._init_task()
+            task.tooling = mock.Mock()
+            messages = []
+            task.logger = mock.Mock()
+            task.logger.info = messages.append
+            task.tooling.query_all.return_value = {
+                "totalSize": 1,
+                "records": [
+                    {
+                        "MemberType": "CustomObject",
+                        "MemberName": "Test__c",
+                        "RevisionCounter": 1,
+                    }
+                ],
+            }
+            task._run_task()
+            assert os.path.exists(
+                os.path.join(task.project_config.cache_dir, "snapshot", "test.json")
+            )
+
+            assert "CustomObject: Test__c" in messages
+
+            task = create_task_fixture(ListChanges)
+            task._init_task()
+            task.tooling = mock.Mock()
+            task.logger = mock.Mock()
+            task.logger.info = messages.append
+            task.tooling.query_all.return_value = {
+                "totalSize": 1,
+                "records": [
+                    {
+                        "MemberType": "CustomObject",
+                        "MemberName": "Test__c",
+                        "RevisionCounter": 1,
+                    }
+                ],
+            }
+            task._run_task()
+            assert "Found no changes." in messages
+
+    def test_filter_changes__include(self, create_task_fixture):
+        foo = {
+            "MemberType": "CustomObject",
+            "MemberName": "foo__c",
+            "RevisionCounter": 1,
+        }
+        bar = {
+            "MemberType": "CustomObject",
+            "MemberName": "bar__c",
+            "RevisionCounter": 1,
+        }
+        foobar = {
+            "MemberType": "CustomObject",
+            "MemberName": "foobar__c",
+            "RevisionCounter": 1,
+        }
+        task = create_task_fixture(ListChanges, {"include": "foo", "exclude": "bar"})
+        filtered, ignored = task._filter_changes([foo, bar, foobar])
+        assert filtered == [foo]
+
+    def test_filter_changes__null_revnum(self, create_task_fixture):
+        foo = {
+            "MemberType": "CustomObject",
+            "MemberName": "foo__c",
+            "RevisionCounter": None,
+        }
+        bar = {
+            "MemberType": "CustomObject",
+            "MemberName": "bar__c",
+            "RevisionCounter": 1,
+        }
+        task = create_task_fixture(ListChanges, {})
+        filtered, ignored = task._filter_changes([foo, bar])
+        assert filtered == [foo, bar]
+
+
+@mock.patch("cumulusci.tasks.salesforce.sourcetracking.sfdx")
+class TestRetrieveChanges:
+    """Retrieve changed components from a scratch org"""
+
+    def test_init_options__sfdx_format(self, sfdx, create_task_fixture):
+        with temporary_dir():
+            project_config = create_project_config()
+            project_config.project__source_format = "sfdx"
+            with open("sfdx-project.json", "w") as f:
+                json.dump(
+                    {"packageDirectories": [{"path": "force-app", "default": True}]}, f
+                )
+            task = create_task_fixture(RetrieveChanges, {}, project_config)
+            assert not task.md_format
+            assert task.options["path"] == "force-app"
+
+    def test_run_task(self, sfdx, create_task_fixture):
+        sfdx_calls = []
+        sfdx.side_effect = lambda cmd, *args, **kw: sfdx_calls.append(cmd)
+
+        with temporary_dir():
+            task = create_task_fixture(
+                RetrieveChanges,
+                {
+                    "include": "Test",
+                    "namespace_tokenize": "ns",
+                    "retrieve_complete_profile": True,
+                },
+            )
+            task._init_task()
+            task.tooling = mock.Mock()
+            task.tooling.query_all.return_value = {
+                "totalSize": 1,
+                "records": [
+                    {
+                        "MemberType": "CustomObject",
+                        "MemberName": "Test__c",
+                        "RevisionCounter": 1,
+                    },
+                    {
+                        "MemberType": "Profile",
+                        "MemberName": "TestProfile",
+                        "RevisionCounter": 1,
+                    },
+                ],
+            }
+            with (
+                mock.patch.object(
+                    RetrieveProfile, "_run_task"
+                ) as mock_retrieve_profile,
+                mock.patch.object(pathlib.Path, "exists", return_value=True),
+                mock.patch.object(pathlib.Path, "is_dir", return_value=True),
+            ):
+                task._run_task()
+                assert sfdx_calls == [
+                    "project convert mdapi",
+                    "project retrieve start",
+                    "project convert source",
+                ]
+                assert os.path.exists(os.path.join("src", "package.xml"))
+                mock_retrieve_profile.assert_called()
+
+    def test_run_task__no_changes(self, sfdx, create_task_fixture):
+        with temporary_dir() as path:
+            task = create_task_fixture(RetrieveChanges, {"path": path})
+            task._init_task()
+            messages = []
+            task.tooling = mock.Mock()
+            task.tooling.query_all.return_value = {"totalSize": 0, "records": []}
+            task.logger = mock.Mock()
+            task.logger.info = messages.append
+            task._run_task()
+            assert "No changes to retrieve" in messages
+
+    def test_run_task_with_output_dir(self, sfdx, create_task_fixture):
+        sfdx_calls = []
+        sfdx.side_effect = lambda cmd, *args, **kw: sfdx_calls.append(cmd)
+
+        with temporary_dir():
+            task = create_task_fixture(
+                RetrieveChanges,
+                {
+                    "include": "Test",
+                    "namespace_tokenize": "ns",
+                    "retrieve_complete_profile": True,
+                    "output_dir": "output",
+                },
+            )
+            task._init_task()
+            task.tooling = mock.Mock()
+            task.tooling.query_all.return_value = {
+                "totalSize": 1,
+                "records": [
+                    {
+                        "MemberType": "CustomObject",
+                        "MemberName": "Test__c",
+                        "RevisionCounter": 1,
+                    },
+                    {
+                        "MemberType": "Profile",
+                        "MemberName": "TestProfile",
+                        "RevisionCounter": 1,
+                    },
+                ],
+            }
+            with (
+                mock.patch.object(
+                    RetrieveProfile, "_run_task"
+                ) as mock_retrieve_profile,
+                mock.patch.object(pathlib.Path, "exists", return_value=True),
+                mock.patch.object(pathlib.Path, "is_dir", return_value=True),
+            ):
+                task._run_task()
+                assert sfdx_calls == [
+                    "project convert mdapi",
+                    "project retrieve start",
+                    "project convert source",
+                ]
+                mock_retrieve_profile.assert_called()
+
+
+class TestSnapshotChanges:
+    @mock.patch("cumulusci.tasks.salesforce.sourcetracking.sfdx")
+    def test_run_task(self, sfdx, create_task_fixture):
+        with temporary_dir():
+            org_config = OrgConfig(
+                {
+                    "username": "test-cci@example.com",
+                    "scratch": True,
+                    "instance_url": "https://test.salesforce.com",
+                    "access_token": "TOKEN",
+                },
+                "test",
+            )
+            task = create_task_fixture(SnapshotChanges, org_config=org_config)
+            task._init_task()
+            task.tooling.query = mock.Mock(
+                side_effect=[
+                    {"totalSize": 0, "records": [], "done": True},
+                    {
+                        "totalSize": 1,
+                        "done": True,
+                        "records": [
+                            {
+                                "MemberType": "CustomObject",
+                                "MemberName": "Object2",
+                                "RevisionCounter": 1,
+                            }
+                        ],
+                    },
+                ]
+            )
+            task._reset_sfdx_snapshot = mock.Mock()
+            task._run_task()
+            task._reset_sfdx_snapshot.assert_called_once()
+
+    def test_freeze(self, create_task_fixture):
+        task = create_task_fixture(SnapshotChanges)
+        steps = task.freeze(None)
+        assert steps == []
+
+
+def test_write_manifest__folder():
+    with temporary_dir() as path:
+        _write_manifest(
+            [{"MemberType": "ReportFolder", "MemberName": "TestFolder"}], path, "52.0"
+        )
+        package_xml = pathlib.Path(path, "package.xml").read_text()
+        assert "<name>Report</name>" in package_xml
+
+
+def test_write_manifest__bad_md_types():
+    benign_md_type = [{"MemberType": "ReportFolder", "MemberName": "TestFolder"}]
+    bad_md_types = [
+        {"MemberType": type_name, "MemberName": "Banana"}
+        for type_name in KNOWN_BAD_MD_TYPES
+    ]
+    with temporary_dir() as path:
+        changes = benign_md_type + bad_md_types
+        _write_manifest(changes, path, "52.0")
+        package_xml = pathlib.Path(path, "package.xml").read_text()
+        assert "<name>Report</name>" in package_xml
+        for name in bad_md_types:
+            assert f"<name>{name}</name>" not in package_xml
+
+
+def test_retrieve_components_project_config_not_found():
+    components = mock.Mock()
+    org_config = mock.Mock()
+    target = "force-app/"
+    md_format = False
+    extra_package_xml_opts = {"sample": "dict"}
+    namespace_tokenize = "sample"
+    api_version = "58.0"
+    expected_error_message = (
+        "Kindly provide project_config as part of retrieve_components"
+    )
+    with pytest.raises(ProjectConfigNotFound) as e:
+        retrieve_components(
+            components=components,
+            org_config=org_config,
+            target=target,
+            md_format=md_format,
+            extra_package_xml_opts=extra_package_xml_opts,
+            namespace_tokenize=namespace_tokenize,
+            api_version=api_version,
+            retrieve_complete_profile=True,
+        )
+        assert expected_error_message == e.value.message

cumulusci/tasks/salesforce/tests/test_trigger_handlers.py

@@ -0,0 +1,300 @@
+from unittest import mock
+
+import pytest
+import responses
+
+from cumulusci.core.exceptions import CumulusCIException, TaskOptionsError
+from cumulusci.tasks.salesforce import SetTDTMHandlerStatus
+
+
+class TestTriggerHandlers:
+    def test_init_options(self, create_task_fixture):
+        task = create_task_fixture(
+            SetTDTMHandlerStatus, {"handlers": ["TestTDTM"], "active": False}
+        )
+
+        assert task.options["handlers"] == ["TestTDTM"]
+
+        with pytest.raises(TaskOptionsError):
+            task = create_task_fixture(
+                SetTDTMHandlerStatus,
+                {"handlers": ["TestTDTM"], "restore": True, "restore_file": False},
+            )
+
+        with pytest.raises(TaskOptionsError):
+            task = create_task_fixture(
+                SetTDTMHandlerStatus,
+                {"handlers": ["TestTDTM"], "restore": True, "restore_file": "False"},
+            )
+
+    @responses.activate
+    def test_missing_handler_object(self, create_task_fixture):
+        task = create_task_fixture(
+            SetTDTMHandlerStatus, {"handlers": ["TestTDTM"], "active": False}
+        )
+        task.api_version = "47.0"
+        responses.add(
+            method="GET",
+            url=task.org_config.instance_url + "/services/data/v47.0/sobjects",
+            json={"sobjects": [{"name": "t__c"}]},
+            status=200,
+        )
+
+        with pytest.raises(CumulusCIException):
+            task()
+
+    @responses.activate
+    def test_set_status(self, create_task_fixture):
+        task = create_task_fixture(
+            SetTDTMHandlerStatus,
+            {"handlers": ["TestTDTM"], "active": False, "namespace": "npsp"},
+        )
+        task.api_version = "47.0"
+        responses.add(
+            method="GET",
+            url=task.org_config.instance_url + "/services/data/v47.0/sobjects",
+            json={"sobjects": [{"name": "Trigger_Handler__c"}]},
+            status=200,
+        )
+        responses.add(
+            method="GET",
+            url=task.org_config.instance_url
+            + "/services/data/v47.0/query/?q=SELECT+Id%2C+Class__c%2C+Object__c%2C+Active__c+FROM+Trigger_Handler__c",
+            status=200,
+            json={
+                "records": [
+                    {
+                        "Id": "000000000000000",
+                        "Class__c": "TestTDTM",
+                        "Object__c": "Test__c",
+                        "Active__c": True,
+                    },
+                    {
+                        "Id": "000000000000001",
+                        "Class__c": "Test",
+                        "Object__c": "Test__c",
+                        "Active__c": True,
+                    },
+                ]
+            },
+        )
+        responses.add(
+            method="PATCH",
+            url=task.org_config.instance_url
+            + "/services/data/v47.0/sobjects/Trigger_Handler__c/000000000000000",
+            status=204,
+        )
+        task()
+
+        assert len(responses.calls) == 3
+
+    @responses.activate
+    def test_set_status__all_handlers(self, create_task_fixture):
+        task = create_task_fixture(
+            SetTDTMHandlerStatus, {"active": False, "namespace": "npsp"}
+        )
+        task.api_version = "47.0"
+        responses.add(
+            method="GET",
+            url=task.org_config.instance_url + "/services/data/v47.0/sobjects",
+            json={"sobjects": [{"name": "Trigger_Handler__c"}]},
+            status=200,
+        )
+        responses.add(
+            method="GET",
+            url=task.org_config.instance_url
+            + "/services/data/v47.0/query/?q=SELECT+Id%2C+Class__c%2C+Object__c%2C+Active__c+FROM+Trigger_Handler__c",
+            status=200,
+            json={
+                "records": [
+                    {
+                        "Id": "000000000000000",
+                        "Class__c": "TestTDTM",
+                        "Object__c": "Test__c",
+                        "Active__c": True,
+                    },
+                    {
+                        "Id": "000000000000001",
+                        "Class__c": "Test",
+                        "Object__c": "Test__c",
+                        "Active__c": True,
+                    },
+                ]
+            },
+        )
+        responses.add(
+            method="PATCH",
+            url=task.org_config.instance_url
+            + "/services/data/v47.0/sobjects/Trigger_Handler__c/000000000000000",
+            status=204,
+        )
+        responses.add(
+            method="PATCH",
+            url=task.org_config.instance_url
+            + "/services/data/v47.0/sobjects/Trigger_Handler__c/000000000000001",
+            status=204,
+        )
+        task()
+
+        assert len(responses.calls) == 4
+
+    @responses.activate
+    def test_set_status_namespaced(self, create_task_fixture):
+        task = create_task_fixture(
+            SetTDTMHandlerStatus,
+            {"handlers": ["Test__c:TestTDTM"], "active": False, "namespace": "npsp"},
+        )
+        task.api_version = "47.0"
+        responses.add(
+            method="GET",
+            url=task.org_config.instance_url + "/services/data/v47.0/sobjects",
+            json={"sobjects": [{"name": "npsp__Trigger_Handler__c"}]},
+            status=200,
+        )
+        responses.add(
+            method="GET",
+            url=task.org_config.instance_url
+            + "/services/data/v47.0/query/?q=SELECT+Id%2C+npsp__Class__c%2C+npsp__Object__c%2C+npsp__Active__c+FROM+npsp__Trigger_Handler__c",
+            status=200,
+            json={
+                "records": [
+                    {
+                        "Id": "000000000000000",
+                        "npsp__Class__c": "TestTDTM",
+                        "npsp__Object__c": "Test__c",
+                        "npsp__Active__c": True,
+                    },
+                    {
+                        "Id": "000000000000001",
+                        "npsp__Class__c": "Test",
+                        "npsp__Object__c": "Test__c",
+                        "npsp__Active__c": True,
+                    },
+                ]
+            },
+        )
+        responses.add(
+            method="PATCH",
+            url=task.org_config.instance_url
+            + "/services/data/v47.0/sobjects/npsp__Trigger_Handler__c/000000000000000",
+            status=204,
+        )
+        task()
+
+        assert len(responses.calls) == 3
+
+    @responses.activate
+    def test_restore(self, create_task_fixture):
+        task = create_task_fixture(
+            SetTDTMHandlerStatus,
+            {"restore": True, "restore_file": "resto.yml", "namespace": "npsp"},
+        )
+        task.api_version = "47.0"
+        responses.add(
+            method="GET",
+            url=task.org_config.instance_url + "/services/data/v47.0/sobjects",
+            json={"sobjects": [{"name": "npsp__Trigger_Handler__c"}]},
+            status=200,
+        )
+        responses.add(
+            method="GET",
+            url=task.org_config.instance_url
+            + "/services/data/v47.0/query/?q=SELECT+Id%2C+npsp__Class__c%2C+npsp__Object__c%2C+npsp__Active__c+FROM+npsp__Trigger_Handler__c",
+            status=200,
+            json={
+                "records": [
+                    {
+                        "Id": "000000000000000",
+                        "npsp__Class__c": "TestTDTM",
+                        "npsp__Object__c": "Test__c",
+                        "npsp__Active__c": False,
+                    },
+                    {
+                        "Id": "000000000000001",
+                        "npsp__Class__c": "Test",
+                        "npsp__Object__c": "Test__c",
+                        "npsp__Active__c": False,
+                    },
+                ]
+            },
+        )
+        responses.add(
+            method="PATCH",
+            url=task.org_config.instance_url
+            + "/services/data/v47.0/sobjects/npsp__Trigger_Handler__c/000000000000000",
+            status=204,
+        )
+
+        op = mock.mock_open(read_data="'Test__c:TestTDTM': True")
+        with mock.patch("cumulusci.utils.fileutils.FSResource.open", op):
+            with mock.patch("cumulusci.utils.fileutils.FSResource.unlink") as unlink:
+                task()
+
+                op.assert_any_call("r")
+                unlink.assert_called_once()
+
+        assert len(responses.calls) == 3
+
+    @responses.activate
+    def test_create_restore_file(self, create_task_fixture):
+        task = create_task_fixture(
+            SetTDTMHandlerStatus,
+            {
+                "handlers": ["Test__c"],
+                "active": False,
+                "restore_file": "resto.yml",
+                "namespace": "npsp",
+            },
+        )
+        task.api_version = "47.0"
+        responses.add(
+            method="GET",
+            url=task.org_config.instance_url + "/services/data/v47.0/sobjects",
+            json={"sobjects": [{"name": "Trigger_Handler__c"}]},
+            status=200,
+        )
+        responses.add(
+            method="GET",
+            url=task.org_config.instance_url
+            + "/services/data/v47.0/query/?q=SELECT+Id%2C+Class__c%2C+Object__c%2C+Active__c+FROM+Trigger_Handler__c",
+            status=200,
+            json={
+                "records": [
+                    {
+                        "Id": "000000000000000",
+                        "Class__c": "TestTDTM",
+                        "Object__c": "Test__c",
+                        "Active__c": True,
+                    },
+                    {
+                        "Id": "000000000000001",
+                        "Class__c": "Test",
+                        "Object__c": "Test__c",
+                        "Active__c": True,
+                    },
+                ]
+            },
+        )
+        responses.add(
+            method="PATCH",
+            url=task.org_config.instance_url
+            + "/services/data/v47.0/sobjects/Trigger_Handler__c/000000000000000",
+            status=204,
+        )
+        responses.add(
+            method="PATCH",
+            url=task.org_config.instance_url
+            + "/services/data/v47.0/sobjects/Trigger_Handler__c/000000000000001",
+            status=204,
+        )
+        op = mock.mock_open()
+        with mock.patch("cumulusci.utils.fileutils.FSResource.open", op):
+            with mock.patch("yaml.safe_dump") as yaml_mock:
+                task()
+
+            op.assert_any_call("w")
+            yaml_mock.assert_called_once_with(
+                {"Test__c:TestTDTM": True, "Test__c:Test": True}, op.return_value
+            )
+
+        assert len(responses.calls) == 4