cumulusci-plus 5.0.0__py3-none-any.whl

cumulusci/tasks/salesforce/tests/test_org_settings.py

@@ -0,0 +1,407 @@
+import base64
+import io
+import json
+import os
+import pathlib
+import zipfile
+from unittest.mock import Mock
+
+import pytest
+
+from cumulusci.tasks.salesforce.org_settings import (
+    DeployOrgSettings,
+    build_settings_package,
+)
+from cumulusci.utils import temporary_dir
+
+from .util import create_task
+
+
+class TestDeployOrgSettings:
+    def test_run_task__json_only(self):
+        with temporary_dir() as d:
+            with open("dev.json", "w") as f:
+                json.dump(
+                    {
+                        "settings": {
+                            "orgPreferenceSettings": {"s1DesktopEnabled": True},
+                            "otherSettings": {
+                                "nestedDict": {
+                                    "boolValue": True,
+                                    "stringValue": "string",
+                                },
+                                "nestedList": [
+                                    {
+                                        "boolValue": True,
+                                        "stringValue": "foo",
+                                    },
+                                    {
+                                        "boolValue": False,
+                                        "stringValue": "bar",
+                                    },
+                                ],
+                            },
+                        },
+                    },
+                    f,
+                )
+            path = os.path.join(d, "dev.json")
+            task_options = {"definition_file": path, "api_version": "48.0"}
+            task = create_task(DeployOrgSettings, task_options)
+            task.api_class = Mock()
+            task()
+
+        package_zip = task.api_class.call_args[0][1]
+        zf = zipfile.ZipFile(io.BytesIO(base64.b64decode(package_zip)), "r")
+        assert (
+            readtext(zf, "package.xml")
+            == """<?xml version="1.0" encoding="UTF-8"?>
+<Package xmlns="http://soap.sforce.com/2006/04/metadata">
+    <types>
+        <members>OrgPreference</members>
+        <members>Other</members>
+        <name>Settings</name>
+    </types>
+    <version>48.0</version>
+</Package>"""
+        )
+        assert (
+            readtext(zf, "settings/OrgPreference.settings")
+            == """<?xml version="1.0" encoding="UTF-8"?>
+<OrgPreferenceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
+    <preferences>
+        <settingName>S1DesktopEnabled</settingName>
+        <settingValue>True</settingValue>
+    </preferences>
+</OrgPreferenceSettings>"""
+        )
+        assert (
+            readtext(zf, "settings/Other.settings")
+            == """<?xml version="1.0" encoding="UTF-8"?>
+<OtherSettings xmlns="http://soap.sforce.com/2006/04/metadata">
+    <nestedDict>
+        <boolValue>true</boolValue>
+        <stringValue>string</stringValue>
+    </nestedDict>
+    <nestedList>
+        <boolValue>true</boolValue>
+        <stringValue>foo</stringValue>
+    </nestedList>
+    <nestedList>
+        <boolValue>false</boolValue>
+        <stringValue>bar</stringValue>
+    </nestedList>
+</OtherSettings>"""
+        )
+        zf.close()
+
+    def test_run_task__json_only__with_org_settings(self):
+        with temporary_dir() as d:
+            with open("dev.json", "w") as f:
+                json.dump(
+                    {
+                        "settings": {
+                            "orgPreferenceSettings": {"s1DesktopEnabled": True},
+                            "otherSettings": {
+                                "nested": {
+                                    "boolValue": True,
+                                    "stringValue": "string",
+                                },
+                            },
+                        },
+                        "objectSettings": {"foo__c": {"sharingModel": "Private"}},
+                    },
+                    f,
+                )
+            path = os.path.join(d, "dev.json")
+            task_options = {"definition_file": path, "api_version": "48.0"}
+            task = create_task(DeployOrgSettings, task_options)
+            task.api_class = Mock()
+            task()
+
+        package_zip = task.api_class.call_args[0][1]
+        zf = zipfile.ZipFile(io.BytesIO(base64.b64decode(package_zip)), "r")
+        # The context manager's output is tested separately, below.
+        assert (
+            readtext(zf, "package.xml")
+            == """<?xml version="1.0" encoding="UTF-8"?>
+<Package xmlns="http://soap.sforce.com/2006/04/metadata">
+    <types>
+        <members>Foo__c</members>
+        <name>CustomObject</name>
+    </types>
+    <types>
+        <members>OrgPreference</members>
+        <members>Other</members>
+        <name>Settings</name>
+    </types>
+    <version>48.0</version>
+</Package>"""
+        )
+        zf.close()
+
+    def test_run_task__settings_only(self):
+        settings = {
+            "orgPreferenceSettings": {"s1DesktopEnabled": True},
+            "otherSettings": {
+                "nested": {
+                    "boolValue": True,
+                    "stringValue": "string",
+                },
+            },
+        }
+        task_options = {"settings": settings, "api_version": "48.0"}
+        task = create_task(DeployOrgSettings, task_options)
+        task.api_class = Mock()
+        task()
+
+        package_zip = task.api_class.call_args[0][1]
+        zf = zipfile.ZipFile(io.BytesIO(base64.b64decode(package_zip)), "r")
+        assert (
+            readtext(zf, "package.xml")
+            == """<?xml version="1.0" encoding="UTF-8"?>
+<Package xmlns="http://soap.sforce.com/2006/04/metadata">
+    <types>
+        <members>OrgPreference</members>
+        <members>Other</members>
+        <name>Settings</name>
+    </types>
+    <version>48.0</version>
+</Package>"""
+        )
+        assert (
+            readtext(zf, "settings/OrgPreference.settings")
+            == """<?xml version="1.0" encoding="UTF-8"?>
+<OrgPreferenceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
+    <preferences>
+        <settingName>S1DesktopEnabled</settingName>
+        <settingValue>True</settingValue>
+    </preferences>
+</OrgPreferenceSettings>"""
+        )
+        assert (
+            readtext(zf, "settings/Other.settings")
+            == """<?xml version="1.0" encoding="UTF-8"?>
+<OtherSettings xmlns="http://soap.sforce.com/2006/04/metadata">
+    <nested>
+        <boolValue>true</boolValue>
+        <stringValue>string</stringValue>
+    </nested>
+</OtherSettings>"""
+        )
+        zf.close()
+
+    def test_run_task__json_and_settings(self):
+        with temporary_dir() as d:
+            with open("dev.json", "w") as f:
+                json.dump(
+                    {
+                        "settings": {
+                            "orgPreferenceSettings": {"s1DesktopEnabled": True},
+                        },
+                    },
+                    f,
+                )
+            path = os.path.join(d, "dev.json")
+            settings = {
+                "otherSettings": {
+                    "nested": {
+                        "boolValue": True,
+                        "stringValue": "string",
+                    },
+                },
+            }
+            task_options = {
+                "definition_file": path,
+                "settings": settings,
+                "api_version": "48.0",
+            }
+            task = create_task(DeployOrgSettings, task_options)
+            task.api_class = Mock()
+            task()
+
+        package_zip = task.api_class.call_args[0][1]
+        zf = zipfile.ZipFile(io.BytesIO(base64.b64decode(package_zip)), "r")
+        assert (
+            readtext(zf, "package.xml")
+            == """<?xml version="1.0" encoding="UTF-8"?>
+<Package xmlns="http://soap.sforce.com/2006/04/metadata">
+    <types>
+        <members>OrgPreference</members>
+        <members>Other</members>
+        <name>Settings</name>
+    </types>
+    <version>48.0</version>
+</Package>"""
+        )
+        assert (
+            readtext(zf, "settings/OrgPreference.settings")
+            == """<?xml version="1.0" encoding="UTF-8"?>
+<OrgPreferenceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
+    <preferences>
+        <settingName>S1DesktopEnabled</settingName>
+        <settingValue>True</settingValue>
+    </preferences>
+</OrgPreferenceSettings>"""
+        )
+        assert (
+            readtext(zf, "settings/Other.settings")
+            == """<?xml version="1.0" encoding="UTF-8"?>
+<OtherSettings xmlns="http://soap.sforce.com/2006/04/metadata">
+    <nested>
+        <boolValue>true</boolValue>
+        <stringValue>string</stringValue>
+    </nested>
+</OtherSettings>"""
+        )
+        zf.close()
+
+    def test_run_task__no_settings(self):
+        with temporary_dir() as d:
+            with open("dev.json", "w") as f:
+                f.write("{}")
+            path = os.path.join(d, "dev.json")
+            task_options = {"definition_file": path}
+            task = create_task(DeployOrgSettings, task_options)
+            task.api_class = Mock()
+            task()
+            assert not task.api_class.called
+
+    def test_run_task_bad_settings_type(self):
+        with temporary_dir() as d:
+            with open("dev.json", "w") as f:
+                json.dump(
+                    {
+                        "settings": {
+                            "otherSettings": {
+                                "none": None,
+                            },
+                        },
+                    },
+                    f,
+                )
+            path = os.path.join(d, "dev.json")
+            task_options = {"definition_file": path, "api_version": "48.0"}
+            task = create_task(DeployOrgSettings, task_options)
+            task.api_class = Mock()
+            with pytest.raises(TypeError):
+                task()
+
+    def test_run_task_bad_nested_list_settings_type(self):
+        with temporary_dir() as d:
+            with open("dev.json", "w") as f:
+                json.dump(
+                    {
+                        "settings": {
+                            "otherSettings": {
+                                "nestedList": ["foo"],
+                            },
+                        },
+                    },
+                    f,
+                )
+            path = os.path.join(d, "dev.json")
+            task_options = {"definition_file": path, "api_version": "48.0"}
+            task = create_task(DeployOrgSettings, task_options)
+            task.api_class = Mock()
+            with pytest.raises(TypeError):
+                task()
+
+
+def readtext(zf, name):
+    with zf.open(name, "r") as f:
+        return io.TextIOWrapper(f).read()
+
+
+class TestBuildSettingsPackage:
+    def test_build_settings_package(self):
+        settings = {
+            "otherSettings": {
+                "nested": {
+                    "boolValue": True,
+                    "stringValue": "string",
+                },
+            }
+        }
+        object_settings = {
+            "account": {
+                "defaultRecordType": "Default",
+                "sharingModel": "Public",
+            },
+            "solution": {"defaultRecordType": "Default"},
+        }
+        with build_settings_package(settings, object_settings, "48.0") as path:
+            assert (
+                (pathlib.Path(path) / "package.xml").read_text()
+                == """<?xml version="1.0" encoding="UTF-8"?>
+<Package xmlns="http://soap.sforce.com/2006/04/metadata">
+    <types>
+        <members>Solution.DefaultSolution</members>
+        <name>BusinessProcess</name>
+    </types>
+    <types>
+        <members>Account.Default</members>
+        <members>Solution.Default</members>
+        <name>RecordType</name>
+    </types>
+    <types>
+        <members>Other</members>
+        <name>Settings</name>
+    </types>
+    <version>48.0</version>
+</Package>"""
+            )
+            assert (
+                (pathlib.Path(path) / "settings" / "Other.settings").read_text()
+                == """<?xml version="1.0" encoding="UTF-8"?>
+<OtherSettings xmlns="http://soap.sforce.com/2006/04/metadata">
+    <nested>
+        <boolValue>true</boolValue>
+        <stringValue>string</stringValue>
+    </nested>
+</OtherSettings>"""
+            )
+
+            rm_ws = "".maketrans("", "", " \t \n")
+
+            assert (
+                (pathlib.Path(path) / "objects" / "Account.object")
+                .read_text()
+                .translate(rm_ws)
+                == """<?xml version="1.0" encoding="UTF-8"?>
+<Object xmlns="http://soap.sforce.com/2006/04/metadata">
+    <sharingModel>Public</sharingModel>
+    <recordTypes>
+        <fullName>Default</fullName>
+        <label>Default</label>
+        <active>true</active>
+    </recordTypes>
+</Object>""".translate(
+                    rm_ws
+                )
+            )
+            assert (
+                (pathlib.Path(path) / "objects" / "Solution.object")
+                .read_text()
+                .translate(rm_ws)
+                == """<?xml version="1.0" encoding="UTF-8"?>
+<Object xmlns="http://soap.sforce.com/2006/04/metadata">
+
+    <recordTypes>
+        <fullName>Default</fullName>
+        <label>Default</label>
+        <active>true</active>
+        <businessProcess>DefaultSolution</businessProcess>
+    </recordTypes>
+
+    <businessProcesses>
+        <fullName>DefaultSolution</fullName>
+        <isActive>true</isActive>
+        <values>
+            <fullName>Draft</fullName>
+        </values>
+    </businessProcesses>
+</Object>""".translate(
+                    rm_ws
+                )
+            )

cumulusci/tasks/salesforce/tests/test_profiles.py

@@ -0,0 +1,202 @@
+import pytest
+import responses
+
+from cumulusci.core.exceptions import TaskOptionsError
+from cumulusci.salesforce_api.exceptions import MetadataApiError
+from cumulusci.tasks.salesforce.profiles import CreateBlankProfile
+
+from .util import create_task
+
+RESPONSE_FAULT = """<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sf="urn:fault.partner.soap.sforce.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+<soapenv:Body>
+    <soapenv:Fault>
+        <faultcode>sf:INVALID_SESSION_ID</faultcode>
+        <faultstring>INVALID_SESSION_ID: Invalid Session ID found in SessionHeader: Illegal Session</faultstring>
+        <detail>
+        <sf:UnexpectedErrorFault xsi:type="sf:UnexpectedErrorFault">
+            <sf:exceptionCode>INVALID_SESSION_ID</sf:exceptionCode>
+            <sf:exceptionMessage>Invalid Session ID found in SessionHeader: Illegal Session</sf:exceptionMessage>
+        </sf:UnexpectedErrorFault>
+        </detail>
+    </soapenv:Fault>
+</soapenv:Body>
+</soapenv:Envelope>"""
+
+RESPONSE_ERROR = """<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:partner.soap.sforce.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+<soapenv:Body>
+    <createResponse>
+        <result>
+        <errors>
+            <message>insufficient access rights on cross-reference id</message>
+            <statusCode>INSUFFICIENT_ACCESS_ON_CROSS_REFERENCE_ENTITY</statusCode>
+        </errors>
+        <id xsi:nil="true"/>
+        <success>false</success>
+        </result>
+    </createResponse>
+</soapenv:Body>
+</soapenv:Envelope>"""
+
+RESPONSE_ERROR_FIELD = """<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:partner.soap.sforce.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+<soapenv:Header>
+    <LimitInfoHeader>
+        <limitInfo>
+        <current>43</current>
+        <limit>5000000</limit>
+        <type>API REQUESTS</type>
+        </limitInfo>
+    </LimitInfoHeader>
+</soapenv:Header>
+<soapenv:Body>
+    <createResponse>
+        <result>
+        <errors>
+            <fields>Name</fields>
+            <message>The profile name is already in use: Name</message>
+            <statusCode>FIELD_INTEGRITY_EXCEPTION</statusCode>
+        </errors>
+        <id xsi:nil="true" />
+        <success>false</success>
+        </result>
+    </createResponse>
+</soapenv:Body>
+</soapenv:Envelope>"""
+
+RESPONSE_SUCCESS = """<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:partner.soap.sforce.com">
+<soapenv:Body>
+    <createResponse>
+        <result>
+        <id>001R0000029IyDPIA0</id>
+        <success>true</success>
+        </result>
+    </createResponse>
+</soapenv:Body>
+</soapenv:Envelope>"""
+
+
+@responses.activate
+def test_run_task_success():
+    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": "UserLicense",
+                        "url": "/services/data/v53.0/sobjects/UserLicense/10056000000VGjUAAW",
+                    },
+                    "Id": "10056000000VGjUAAW",
+                    "Name": "Salesforce",
+                }
+            ],
+        },
+    )
+    responses.add(
+        responses.POST,
+        "https://test.salesforce.com/services/Soap/u/53.0/ORG_ID",
+        RESPONSE_SUCCESS,
+    )
+    result = task._run_task()
+    assert result == "001R0000029IyDPIA0"
+    assert responses.calls[0].request.params == {
+        "q": "SELECT Id, Name FROM UserLicense WHERE Name = 'Foo' LIMIT 1"
+    }
+    soap_body = responses.calls[1].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)
+
+
+@responses.activate
+def test_run_task_fault():
+    task = create_task(
+        CreateBlankProfile,
+        {
+            "license_id": "10056000000VGjUAAW",
+            "name": "Test Profile",
+            "description": "This is the description",
+        },
+    )
+    task.org_config._latest_api_version = "53.0"
+
+    responses.add(
+        responses.POST,
+        "https://test.salesforce.com/services/Soap/u/53.0/ORG_ID",
+        RESPONSE_FAULT,
+    )
+    with pytest.raises(MetadataApiError) as e:
+        task._run_task()
+
+    assert "Invalid Session ID found" in str(e)
+
+
+@responses.activate
+def test_run_task_field_error():
+    task = create_task(
+        CreateBlankProfile,
+        {
+            "license_id": "10056000000VGjUAAW",
+            "name": "Test Profile",
+            "description": "This is the description",
+        },
+    )
+    task.org_config._latest_api_version = "53.0"
+    responses.add(
+        responses.POST,
+        "https://test.salesforce.com/services/Soap/u/53.0/ORG_ID",
+        RESPONSE_ERROR_FIELD,
+    )
+
+    with pytest.raises(MetadataApiError) as e:
+        task._run_task()
+    assert "The profile name is already in use: Name" in str(e)
+
+
+@responses.activate
+def test_run_task_error():
+    task = create_task(
+        CreateBlankProfile,
+        {
+            "license_id": "10056000000VGjUAAW",
+            "name": "Test Profile",
+            "description": "This is the description",
+        },
+    )
+    task.org_config._latest_api_version = "53.0"
+
+    responses.add(
+        responses.POST,
+        "https://test.salesforce.com/services/Soap/u/53.0/ORG_ID",
+        RESPONSE_ERROR,
+    )
+
+    with pytest.raises(MetadataApiError) as e:
+        task._run_task()
+    assert "insufficient access rights on cross-reference id" in str(e)
+
+
+def test_task_options_error():
+    with pytest.raises(TaskOptionsError):
+        create_task(
+            CreateBlankProfile,
+            {
+                "name": "Foo",
+                "description": "Foo",
+            },
+        )