cumulusci-plus 5.0.0__py3-none-any.whl

cumulusci/tasks/marketing_cloud/tests/test_api_soap_envelopes.py

@@ -0,0 +1,145 @@
+CREATE_SUBSCRIBER_ATTRIBUTE_EXPECTED_SOAP_RESPONSE = """<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
+    xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
+    xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+    <env:Header xmlns:env="http://www.w3.org/2003/05/soap-envelope">
+        <wsa:Action>ConfigureResponse</wsa:Action>
+        <wsa:MessageID>urn:uuid:9be492dc-a0b9-4cf9-908b-e02a11d623c3</wsa:MessageID>
+        <wsa:RelatesTo>urn:uuid:b7df082c-4ddb-4a62-8cda-de290f42b9c0</wsa:RelatesTo>
+        <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
+        <wsse:Security>
+            <wsu:Timestamp wsu:Id="Timestamp-61ba3507-784d-4084-bdf0-0ca052fc29ec">
+                <wsu:Created>2021-08-30T19:24:48Z</wsu:Created>
+                <wsu:Expires>2021-08-30T19:29:48Z</wsu:Expires>
+            </wsu:Timestamp>
+        </wsse:Security>
+    </env:Header>
+    <soap:Body>
+        <ConfigureResponseMsg xmlns="http://exacttarget.com/wsdl/partnerAPI">
+            <Results>
+                <Result>
+                    <StatusCode>OK</StatusCode>
+                    <StatusMessage>Success</StatusMessage>
+                    <OrdinalID>0</OrdinalID>
+                    <Object xsi:type="PropertyDefinition">
+                        <PartnerKey xsi:nil="true" />
+                        <ID>126713</ID>
+                        <ObjectID xsi:nil="true" />
+                        <Name>Test Subscriber Attribute</Name>
+                        <PropertyType>string</PropertyType>
+                    </Object>
+                </Result>
+            </Results>
+            <OverallStatus>OK</OverallStatus>
+            <OverallStatusMessage />
+            <RequestID>ef959dde-a21d-46ac-b2de-98d9e656ed6f</RequestID>
+        </ConfigureResponseMsg>
+    </soap:Body>
+</soap:Envelope>"""
+
+CREATE_USER_EXPECTED_SOAP_RESPONSE = """<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+    <env:Header xmlns:env="http://www.w3.org/2003/05/soap-envelope">
+        <wsa:Action>CreateResponse</wsa:Action>
+        <wsa:MessageID>urn:uuid:73668493-d031-493c-b291-7fffe3bf46d0</wsa:MessageID>
+        <wsa:RelatesTo>urn:uuid:9367afcb-c4ec-48f8-9a6f-2d0de4e37dff</wsa:RelatesTo>
+        <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
+        <wsse:Security>
+            <wsu:Timestamp wsu:Id="Timestamp-c58859fa-815f-4ecb-b278-d8df5249e0e6">
+                <wsu:Created>2021-08-31T06:10:52Z</wsu:Created>
+                <wsu:Expires>2021-08-31T06:15:52Z</wsu:Expires>
+            </wsu:Timestamp>
+        </wsse:Security>
+    </env:Header>
+    <soap:Body>
+        <CreateResponse xmlns="http://exacttarget.com/wsdl/partnerAPI">
+            <Results>
+                <StatusCode>OK</StatusCode>
+                <StatusMessage>Account User Updated / Created</StatusMessage>
+                <OrdinalID>0</OrdinalID>
+                <NewID>0</NewID>
+                <Object xsi:type="AccountUser">
+                    <Client>
+                        <ID>523005197</ID>
+                    </Client>
+                    <PartnerKey xsi:nil="true" />
+                    <ID>722602484</ID>
+                    <ObjectID xsi:nil="true" />
+                    <CustomerKey>Don_Draper_Key_1926</CustomerKey>
+                    <UserID>sterling-don</UserID>
+                    <Password />
+                    <Name>Don Draper</Name>
+                    <Email>don.draper@sterlingcooper.com</Email>
+                    <UserPermissions>
+                        <PartnerKey xsi:nil="true" />
+                        <ID>31</ID>
+                        <ObjectID xsi:nil="true" />
+                        <Name xsi:nil="true" />
+                        <Value xsi:nil="true" />
+                        <Description xsi:nil="true" />
+                        <Delete>0</Delete>
+                    </UserPermissions>
+                    <Delete>0</Delete>
+                    <IsAPIUser>true</IsAPIUser>
+                    <DefaultBusinessUnit>523008403</DefaultBusinessUnit>
+                </Object>
+            </Results>
+            <RequestID>09647ed9-38d4-4431-9fa2-ae29df011a5a</RequestID>
+            <OverallStatus>OK</OverallStatus>
+        </CreateResponse>
+    </soap:Body>
+</soap:Envelope>"""
+
+UPDATE_USER_ROLE_EXPECTED_SOAP_RESPONSE = """<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+    <env:Header xmlns:env="http://www.w3.org/2003/05/soap-envelope">
+        <wsa:Action>CreateResponse</wsa:Action>
+        <wsa:MessageID>urn:uuid:ed9644d9-3258-4799-899a-0fef9503d6b9</wsa:MessageID>
+        <wsa:RelatesTo>urn:uuid:eaea2d53-ecf4-4ddc-b0c6-aa690d4141b1</wsa:RelatesTo>
+        <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
+        <wsse:Security>
+            <wsu:Timestamp wsu:Id="Timestamp-ee6031ae-b715-4ea0-a246-7607c807b830">
+                <wsu:Created>2021-08-31T06:03:37Z</wsu:Created>
+                <wsu:Expires>2021-08-31T06:08:37Z</wsu:Expires>
+            </wsu:Timestamp>
+        </wsse:Security>
+    </env:Header>
+    <soap:Body>
+        <UpdateResponse xmlns="http://exacttarget.com/wsdl/partnerAPI">
+            <Results>
+                <StatusCode>OK</StatusCode>
+                <StatusMessage>Account User Updated / Created</StatusMessage>
+                <OrdinalID>0</OrdinalID>
+                <Object xsi:type="AccountUser">
+                    <Client>
+                        <ID>523005197</ID>
+                    </Client>
+                    <PartnerKey xsi:nil="true" />
+                    <ID>722602484</ID>
+                    <ObjectID xsi:nil="true" />
+                    <CustomerKey>Don_Draper_Key_1926</CustomerKey>
+                    <AccountUserID>722602484</AccountUserID>
+                    <Password />
+                    <Name>Partner Don Draper</Name>
+                    <Email>don.draper@sterlingcooper.com</Email>
+                    <UserPermissions>
+                        <PartnerKey xsi:nil="true" />
+                        <ID>31</ID>
+                        <ObjectID xsi:nil="true" />
+                        <Name xsi:nil="true" />
+                        <Value xsi:nil="true" />
+                        <Description xsi:nil="true" />
+                        <Delete>0</Delete>
+                    </UserPermissions>
+                    <Delete>0</Delete>
+                    <IsAPIUser>true</IsAPIUser>
+                </Object>
+            </Results>
+            <RequestID>37ee797a-12ae-4d99-8294-c9f3451c5cd5</RequestID>
+            <OverallStatus>OK</OverallStatus>
+        </UpdateResponse>
+    </soap:Body>
+</soap:Envelope>"""

cumulusci/tasks/marketing_cloud/tests/test_base.py

@@ -0,0 +1,14 @@
+from unittest import mock
+
+from cumulusci.core.config import TaskConfig
+from cumulusci.tasks.marketing_cloud.base import BaseMarketingCloudTask
+
+
+class TestBaseMarketingCloudTask:
+    def test_init(self, project_config):
+        project_config.keychain.get_service = mock.Mock()
+        task_config = TaskConfig({"options": {}})
+        task = BaseMarketingCloudTask(project_config, task_config)
+        task._init_task()
+
+        assert task.mc_config is not None

cumulusci/tasks/marketing_cloud/tests/test_deploy.py

@@ -0,0 +1,400 @@
+import json
+import re
+import zipfile
+from pathlib import Path
+from unittest import mock
+
+import pytest
+import responses
+
+from cumulusci.core.config import TaskConfig
+from cumulusci.core.config.marketing_cloud_service_config import (
+    MarketingCloudServiceConfig,
+)
+from cumulusci.core.exceptions import DeploymentException
+from cumulusci.tasks.marketing_cloud.deploy import (
+    MCPM_BASE_ENDPOINT,
+    MCPM_JOB_ID_HEADER,
+    UNKNOWN_STATUS_MESSAGE,
+    MarketingCloudDeployTask,
+)
+from cumulusci.tasks.marketing_cloud.mc_constants import MC_API_VERSION
+from cumulusci.utils import temporary_dir
+
+TEST_TSSD = "asdf-qwerty"
+STACK_KEY = "S4"
+TEST_ZIPFILE = "test-mc-pkg.zip"
+PAYLOAD_FILE = "expected-payload.json"
+JOB_NAME = "foo_job"
+
+# This JSON does not necessarily include the complete data provided by Marketing Cloud
+# It is intended to exercise functionality in the class under test.
+# The response is designed to go with the content of `expected-payload.json`
+VALIDATION_RESPONSE_FILE = "validation-response.json"
+
+
+@pytest.fixture
+def task(project_config):
+    test_zip_file = Path(__file__).parent.absolute() / TEST_ZIPFILE
+    task = MarketingCloudDeployTask(
+        project_config,
+        TaskConfig(
+            {
+                "options": {
+                    "package_zip_file": test_zip_file.resolve(),
+                    "custom_inputs": "companyName:Acme",
+                    "name": JOB_NAME,
+                }
+            }
+        ),
+    )
+    task.mc_config = MarketingCloudServiceConfig(
+        {
+            "rest_instance_url": f"https://{TEST_TSSD}.rest.marketingcloudapis.com/",
+            "access_token": "foo",
+        },
+        "mc",
+        None,
+    )
+    task.poll_interval_s = 0  # Do not poll during testing
+    return task
+
+
+@pytest.fixture
+def validation_response():
+    with open(Path(__file__).parent.absolute() / VALIDATION_RESPONSE_FILE) as f:
+        return json.load(f)
+
+
+@pytest.fixture
+def expected_payload():
+    expected_payload_file = Path(__file__).parent.absolute() / PAYLOAD_FILE
+    with open(expected_payload_file, "r") as f:
+        return json.load(f)
+
+
+@pytest.fixture
+def task_without_custom_inputs(project_config):
+    test_zip_file = Path(__file__).parent.absolute() / TEST_ZIPFILE
+    task = MarketingCloudDeployTask(
+        project_config,
+        TaskConfig(
+            {
+                "options": {
+                    "package_zip_file": test_zip_file.resolve(),
+                    "custom_inputs": None,
+                    "name": JOB_NAME,
+                }
+            }
+        ),
+    )
+    task.mc_config = MarketingCloudServiceConfig(
+        {
+            "rest_instance_url": f"https://{TEST_TSSD}.rest.marketingcloudapis.com/",
+            "access_token": "foo",
+        },
+        "mc",
+        None,
+    )
+    return task
+
+
+@pytest.fixture
+def mocked_responses():
+    with responses.RequestsMock() as rsps:
+        rsps.add(
+            "GET",
+            f"https://{TEST_TSSD}.auth.marketingcloudapis.com/{MC_API_VERSION}/userinfo",
+            json={"organization": {"stack_key": STACK_KEY}},
+        )
+        yield rsps
+
+
+@pytest.fixture
+def mocked_validation_responses(mocked_responses):
+    mocked_responses.add(
+        "POST",
+        f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/validate",
+        json={"id": "0be865fe-efb2-479d-99c2-c1b608155369"},
+        match=[responses.matchers.header_matcher({MCPM_JOB_ID_HEADER: JOB_NAME})],
+    )
+    mocked_responses.add(
+        "GET",
+        f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/validate/0be865fe-efb2-479d-99c2-c1b608155369",
+        match=[responses.matchers.header_matcher({MCPM_JOB_ID_HEADER: JOB_NAME})],
+        json={"status": "DONE"},
+    )
+
+    yield mocked_responses
+
+
+@pytest.fixture
+def mocked_polling_validation_responses(mocked_responses, validation_response):
+    mocked_responses.add(
+        "POST",
+        f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/validate",
+        match=[responses.matchers.header_matcher({MCPM_JOB_ID_HEADER: JOB_NAME})],
+        json={"id": "0be865fe-efb2-479d-99c2-c1b608155369"},
+    )
+    mocked_responses.add(
+        "GET",
+        f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/validate/0be865fe-efb2-479d-99c2-c1b608155369",
+        match=[responses.matchers.header_matcher({MCPM_JOB_ID_HEADER: JOB_NAME})],
+        json={"status": "NOT_FOUND"},
+    )
+    mocked_responses.add(
+        "GET",
+        f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/validate/0be865fe-efb2-479d-99c2-c1b608155369",
+        match=[responses.matchers.header_matcher({MCPM_JOB_ID_HEADER: JOB_NAME})],
+        json={"status": "IN_PROGRESS"},
+    )
+    mocked_responses.add(
+        "GET",
+        f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/validate/0be865fe-efb2-479d-99c2-c1b608155369",
+        match=[responses.matchers.header_matcher({MCPM_JOB_ID_HEADER: JOB_NAME})],
+        json={"status": "NOT_FOUND"},
+    )
+    mocked_responses.add(
+        "GET",
+        f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/validate/0be865fe-efb2-479d-99c2-c1b608155369",
+        match=[responses.matchers.header_matcher({MCPM_JOB_ID_HEADER: JOB_NAME})],
+        json=validation_response,
+    )
+
+    yield mocked_responses
+
+
+@pytest.fixture
+def mocked_polling_validation_responses_all_not_found(mocked_responses):
+    mocked_responses.add(
+        "POST",
+        f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/validate",
+        match=[responses.matchers.header_matcher({MCPM_JOB_ID_HEADER: JOB_NAME})],
+        json={"id": "0be865fe-efb2-479d-99c2-c1b608155369"},
+    )
+    for _ in range(10):
+        mocked_responses.add(
+            "GET",
+            f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/validate/0be865fe-efb2-479d-99c2-c1b608155369",
+            match=[responses.matchers.header_matcher({MCPM_JOB_ID_HEADER: JOB_NAME})],
+            json={"status": "NOT_FOUND"},
+        )
+
+    yield mocked_responses
+
+
+class TestMarketingCloudDeployTask:
+    def test_run_task__deploy_succeeds_with_custom_inputs(
+        self, task, mocked_validation_responses
+    ):
+        mocked_validation_responses.add(
+            "POST",
+            f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/deployments",
+            json={"id": "JOBID", "status": "IN_PROGRESS"},
+        )
+        mocked_validation_responses.add(
+            "GET",
+            f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/deployments/JOBID",
+            json={"status": "DONE", "entities": {}},
+        )
+
+        task.logger = mock.Mock()
+        task._run_task()
+        task.logger.info.assert_called_with(
+            "Deployment (JOBID) completed successfully."
+        )
+        assert task.logger.error.call_count == 0
+        assert task.logger.warn.call_count == 0
+
+    def test_run_task__deploy_succeeds_without_custom_inputs(
+        self, task_without_custom_inputs, mocked_validation_responses
+    ):
+        mocked_validation_responses.add(
+            "POST",
+            f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/deployments",
+            json={"id": "JOBID", "status": "IN_PROGRESS"},
+        )
+        mocked_validation_responses.add(
+            "GET",
+            f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/deployments/JOBID",
+            json={"status": "DONE", "entities": {}},
+        )
+        task = task_without_custom_inputs
+        task.logger = mock.Mock()
+        task._run_task()
+        task.logger.info.assert_called_with(
+            "Deployment (JOBID) completed successfully."
+        )
+        assert task.logger.error.call_count == 0
+        assert task.logger.warn.call_count == 0
+
+    def test_run_task__deploy_fails(self, task, mocked_validation_responses):
+        mocked_validation_responses.add(
+            "POST",
+            f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/deployments",
+            json={"id": "JOBID", "status": "IN_PROGRESS"},
+        )
+        mocked_validation_responses.add(
+            "GET",
+            f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/deployments/JOBID",
+            json={
+                "status": "DONE",
+                "entities": {
+                    "assets": {
+                        0: {"status": "FAILED", "issues": ["A problem occurred"]},
+                        1: {"status": "SKIPPED", "issues": ["A problem occurred"]},
+                    },
+                    "categories": {},
+                },
+            },
+        )
+        task.logger = mock.Mock()
+        with pytest.raises(DeploymentException):
+            task._run_task()
+
+        assert task.logger.error.call_count == 2
+        assert (
+            task.logger.error.call_args_list[0][0][0]
+            == "Failed to deploy assets/0. Status: FAILED. Issues: ['A problem occurred']"
+        )
+        assert (
+            task.logger.error.call_args_list[1][0][0]
+            == "Failed to deploy assets/1. Status: SKIPPED. Issues: ['A problem occurred']"
+        )
+
+    def test_run_task__FATAL_ERROR_result(self, task, mocked_validation_responses):
+        mocked_validation_responses.add(
+            "POST",
+            f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/deployments",
+            json={"id": "JOBID", "status": "FATAL_ERROR"},
+        )
+        mocked_validation_responses.add(
+            "GET",
+            f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/deployments/JOBID",
+            json={
+                "status": "FATAL_ERROR",
+                "entities": {},
+            },
+        )
+        task.logger = mock.Mock()
+        with pytest.raises(DeploymentException):
+            task._run_task()
+
+    def test_run_task__unknown_deploy_status(
+        self, task, mocked_validation_responses, caplog
+    ):
+        unknown_status = "FOOBAR"
+        mocked_validation_responses.add(
+            "POST",
+            f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/deployments",
+            json={"id": "JOBID"},
+        )
+        mocked_validation_responses.add(
+            "GET",
+            f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/deployments/JOBID",
+            json={
+                "status": unknown_status,
+                "entities": {},
+            },
+        )
+        caplog.clear()
+        with pytest.raises(DeploymentException):
+            task._run_task()
+
+        logged_messages = [log.message for log in caplog.records]
+        assert UNKNOWN_STATUS_MESSAGE.format(unknown_status) in logged_messages
+
+    # NOTE: the x-mcpm-job-id header is validated implicitly by all use
+    # of Responses mocks.
+
+    def test_validate_package__validation_accepts_intermittent_not_found(
+        self, task, mocked_polling_validation_responses
+    ):
+        mocked_polling_validation_responses.add(
+            "POST",
+            f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/deployments",
+            json={"id": "JOBID", "status": "IN_PROGRESS"},
+        )
+        mocked_polling_validation_responses.add(
+            "GET",
+            f"{MCPM_BASE_ENDPOINT.format(STACK_KEY)}/deployments/JOBID",
+            json={"status": "DONE", "entities": {}},
+        )
+        task._run_task()
+        assert task.validation_response["status"] == "DONE"
+
+    def test_validate_package__validation_fails_consistent_not_found(
+        self, task, mocked_polling_validation_responses_all_not_found
+    ):
+        with pytest.raises(DeploymentException):
+            task._run_task()
+
+    def test_update_payload_entities_with_actions(
+        self, task, expected_payload, validation_response
+    ):
+        task.validation_response = validation_response
+        validated_payload = task._update_payload_entities_with_actions(expected_payload)
+
+        assert validated_payload["entities"]["assets"]["0"]["action"] == {
+            "type": "create",
+            "available": True,
+            "issues": [],
+        }
+
+    def test_action_for_entity(self, task, validation_response):
+        task.validation_response = validation_response
+
+        # We should expect to get back the first action with available == True
+        assert task.action_for_entity("assets", "0") == {
+            "type": "create",
+            "available": True,
+            "issues": [],
+        }
+        assert task.action_for_entity("foo", "0") is None
+
+    def test_zipfile_not_valid(self, task):
+        task.options["package_zip_file"] = "not-a-valid-file.zip"
+        task.logger = mock.Mock()
+        task._run_task()
+
+        task.logger.error.assert_called_once_with(
+            "Package zip file not valid: not-a-valid-file.zip"
+        )
+
+    def test_construct_payload(self, task, expected_payload):
+        task.options["name"] = "cci-deploy"
+        pkg_zip_file = Path(task.options["package_zip_file"])
+        with temporary_dir() as temp_dir:
+            with zipfile.ZipFile(pkg_zip_file) as zf:
+                zf.extractall(temp_dir)
+                actual_payload = task._construct_payload(Path(temp_dir))
+
+        assert expected_payload == actual_payload
+
+    def test_construct_payload__file_not_found(self, task):
+        """Ensure we state clearly state where expect files to be"""
+        task.options["name"] = "cci-deploy"
+        pkg_zip_file = Path(task.options["package_zip_file"])
+        with temporary_dir() as temp_dir:
+            with zipfile.ZipFile(pkg_zip_file) as zf:
+                zf.extractall(temp_dir)
+
+                expected_payload_file = Path(temp_dir + "/info.json")
+                assert expected_payload_file.is_file()
+                Path.unlink(expected_payload_file)
+
+                with pytest.raises(DeploymentException):
+                    task._construct_payload(Path(temp_dir))
+
+    def test_add_custom_inputs_to_payload__deployment_exception(self, task):
+        custom_inputs = {"foo": "bar"}
+        payload = {"input": [{"key": "baz"}]}
+        error_message = re.escape("Custom input of key foo not found in package.")
+        with pytest.raises(DeploymentException, match=error_message):
+            task._add_custom_inputs_to_payload(custom_inputs, payload)
+
+    def test_add_custom_inputs_to_payload(self, task):
+        custom_inputs = {"companyName": "Acme"}
+        payload = {"input": [{"key": "companyName"}]}
+        payload = task._add_custom_inputs_to_payload(custom_inputs, payload)
+        assert payload == {"input": [{"key": "companyName", "value": "Acme"}]}