cumulusci-plus 5.0.0__py3-none-any.whl

cumulusci/robotframework/tests/salesforce/ui.robot

@@ -0,0 +1,361 @@
+** Settings ***
+
+Resource        cumulusci/robotframework/Salesforce.robot
+Library         cumulusci.robotframework.PageObjects
+Suite Setup     Run keywords  Create test data  AND  Open Test Browser
+Suite Teardown  Delete Records and Close Browser
+Library         Dialogs
+Library         cumulusci/robotframework/tests/salesforce/TestListener.py
+
+*** Keywords ***
+
+Create Account
+    [Arguments]      &{fields}
+    ${name} =        Get fake data  name
+    ${account_id} =  Salesforce Insert  Account
+    ...                Name=${name}
+    ...                &{fields}
+    &{account} =     Salesforce Get  Account  ${account_id}
+    [return]  &{account}
+
+Create Contact
+    [Arguments]      &{fields}
+    ${first_name} =  Get fake data  first_name
+    ${last_name} =   Get fake data  last_name
+    ${contact_id} =  Salesforce Insert  Contact
+    ...                FirstName=${first_name}
+    ...                LastName=${last_name}
+    ...                &{fields}
+    &{contact} =     Salesforce Get  Contact  ${contact_id}
+    [return]  &{contact}
+
+Create test data
+    # This was added well after 'Create Account' and
+    # 'Create Contact'
+    ${CONTACT ID}=      Salesforce Insert  Contact
+    ...                 FirstName=Eleanor
+    ...                 LastName=Rigby
+    Set suite variable  ${CONTACT ID}
+
+    ${ACCOUNT ID}=      Salesforce Insert  Account
+    ...                 Name=Big Money Account
+    Set suite variable  ${ACCOUNT ID}
+
+    ${OPPORTUNITY ID}=  Salesforce Insert  Opportunity
+    ...                 CloseDate=2020-01-27
+    ...                 Name=Big Opportunity!
+    ...                 StageName=Prospecting
+    ...                 AccountId=${ACCOUNT ID}
+    ...                 ContactId=${CONTACT ID}
+    Set suite variable  ${OPPORTUNITY ID}
+
+    # add several more opportunities and cases
+    # this, so that related lists get pushed down
+    FOR  ${i}  IN RANGE  4
+        Salesforce Insert  Opportunity
+    ...    CloseDate=2020-01-27
+    ...    Name=Big Opportunity!
+    ...    StageName=Prospecting
+    ...    AccountId=${ACCOUNT ID}
+    ...    ContactId=${CONTACT ID}
+    END
+
+    FOR  ${i}  IN RANGE  4
+         Salesforce Insert  Case
+    ...    Subject=Something bad happened!
+    ...    Status=New
+    ...    Origin=Web
+    ...    ContactId=${CONTACT ID}
+    END
+
+Object field should be
+    [Arguments]       ${obj name}  ${obj id}  ${field}  ${expected_value}
+    [Documentation]
+    ...  Fetches the object using the API, and verifies that the
+    ...  given field has the expected value
+
+    # it may take salesforce a second or two for the data
+    # to be saved and visible to the API, so we'll try this
+    # in a short loop
+    FOR  ${i}  IN RANGE  3
+        &{obj} =          Salesforce Get  ${obj name}  ${obj id}
+        ${actual_value}=  Set variable  ${obj}[${field}]
+
+        Return from keyword if  $expected_value == $actual_value
+        log  Retrying API call...  WARN
+        Sleep  1 second
+    END
+    Fail  Expected ${obj name} field ${field} to be '${expected_value}' but it was '${actual_value}'
+
+*** Test Cases ***
+
+Click Modal Button
+    Go To Object Home            Contact
+    Click Object Button          New
+    Click Modal Button           Save
+    ${locator} =                 Get Locator  modal.has_error
+    Page Should Contain Element  ${locator}
+
+Click Object Button
+    Go To Object Home    Contact
+    Click Object Button  New
+    Page Should Contain  New Contact
+
+Click Related List Button
+    &{contact} =               Create Contact
+    Go To Record Home          ${contact}[Id]
+    Click Related List Button  Opportunities  New
+    Wait Until Modal Is Open
+    Wait Until Page Contains   New Opportunity
+
+Click related item link
+    [Documentation]
+    ...  Verify that 'Click related item link' works
+    [Setup]  Create test data
+
+    Salesforce Insert  Note
+    ...  Title=This is the title of the note
+    ...  Body=This is the body of the note
+    ...  ParentId=${CONTACT ID}
+
+    Go to page  Detail  Contact  ${CONTACT ID}
+    Load related list   Notes & Attachments
+    Click related item link
+    ...  Notes & Attachments
+    ...  This is the title of the note
+
+    Current page should be   Detail  Note
+
+Click related item link exception
+    [Documentation]
+    ...  Verify that 'Click related item link' throws a useful error
+
+    [Setup]  Create test data
+
+    Go to page  Detail  Contact  ${CONTACT ID}
+    Run keyword and expect error
+    ...  Unable to find related link under heading 'Notes & Attachments' with the text 'Bogus'
+    ...  Click related item link  Notes & Attachments  Bogus
+
+Load related list
+    [Setup]  run keywords
+    ...  Go to page  Detail  Contact  ${CONTACT ID}
+    ...  AND  set test variable  ${OLD LOG LEVEL}  ${LOG LEVEL}
+    [Teardown]  Set log level  ${OLD LOG LEVEL}
+
+    # These should all work
+    Load related list  Cases
+    Load related list  Opportunities
+    Load related list  Campaign History
+    Load related list  Notes & Attachments
+
+    # This one s hould fail.
+    # We'll use the robot log to make sure we attempted to scroll.
+    Set log level  DEBUG
+    Run keyword and expect error  Timed out waiting for related list 'Bogus' to load.
+    ...  Load related list  Bogus  tries=2
+    Assert robot log  related list 'Bogus' not found; scrolling...  DEBUG
+
+Click related item popup link
+    [Setup]  Create test data
+
+    Go to page  Detail  Contact  ${CONTACT ID}
+    Click Related item popup link
+    ...  Opportunities
+    ...  Big Opportunity!
+    ...  Edit
+
+    Wait for modal        Edit  Opportunity  expected_heading=Edit Big Opportunity!
+    Click modal button    Cancel
+
+Close Modal
+    Go To Object Home        Contact
+    Open App Launcher
+    Close Modal
+    Wait Until Modal Is Closed
+    Page Should Not Contain  All Apps
+
+Current App Should Be
+    Go To Object Home        Contact
+    Select App Launcher App  Service
+    Current App Should Be    Service
+
+Select App Launcher Tab
+    [Documentation]  Verify that 'Select App Launcher Tab' works
+    [Setup]  run keywords
+    ...  load page object  Listing  User
+    ...  AND  load page object  Home  Event
+
+    Select App Launcher Tab  People
+    Current page should be   Listing  User
+
+    # Just for good measure, let's switch to another page
+    # to make sure it's not a fluke and we really did
+    # switch to a different page.
+    Select App Launcher Tab  Calendar
+    Current page should be   Home  Event
+
+Get Current Record Id
+    &{contact} =       Create Contact
+    Go To Record Home  ${contact}[Id]
+    ${contact_id} =    Get Current Record Id
+    Should Be Equal    ${contact}[Id]  ${contact_id}
+
+Get Related List Count
+    &{account} =       Create Account
+    &{fields} =        Create Dictionary
+    ...                  AccountId=${account}[Id]
+    &{contact} =       Create Contact  &{fields}
+    Go To Record Home  ${account}[Id]
+    ${count} =         Get Related List Count  Contacts
+    Should Be Equal    ${count}  ${1}
+
+Go To Setup Home
+    Go To Setup Home
+
+Go To Setup Object Manager
+    Go To Setup Object Manager
+
+Go To Object Home
+    [Tags]  smoke
+    Go To Object List  Contact
+
+Go To Object List
+    [Tags]  smoke
+    Go To Object List  Contact
+
+Go To Object List With Filter
+    [Tags]  smoke
+    Go To Object List  Contact  filter=Recent
+
+Go To Record Home
+    [Tags]  smoke
+    &{contact} =       Create Contact
+    Go To Record Home  ${contact}[Id]
+
+Header Field Should Have Value
+    &{fields} =                     Create Dictionary
+    ...                               Phone=1234567890
+    &{account} =                    Create Account  &{fields}
+    Go To Record Home               ${account}[Id]
+    Header Field Should Have Value  Phone
+
+Header Field Should Not Have Value
+    &{account} =                        Create Account
+    Go To Record Home                   ${account}[Id]
+    Header Field Should Not Have Value  Phone
+
+Header Field Should Have Link
+    &{fields} =                    Create Dictionary
+    ...                              Website=http://www.test.com
+    &{account} =                   Create Account  &{fields}
+    Go To Record Home              ${account}[Id]
+    Header Field Should Have Link  Website
+
+Header Field Should Not Have Link
+    &{account} =                       Create Account
+    Go To Record Home                  ${account}[Id]
+    Header Field Should Not Have Link  Website
+
+Click Header Field Link
+    &{contact} =                       Create Contact
+    Go To Record Home                  ${contact}[Id]
+    Click Header Field Link            Contact Owner
+    Wait for page object               Detail  User
+
+Open App Launcher
+    Go To Object Home    Contact
+    Open App Launcher
+    Page Should Contain  All Apps
+
+Populate Field
+    [Setup]     Run keywords
+    ...  Go to object home  Account
+    ...  AND  Click Object Button  New
+    [Teardown]  Run keywords
+    ...  Click modal button  Cancel
+    ...  AND  Wait Until Modal Is Closed
+
+    ${account_name} =    Get fake data  company
+    Populate Field       Account Name  ${account_name}
+    ${locator} =         Get Locator  object.field  Account Name
+    ${value} =           Get Value  ${locator}
+    Should Be Equal      ${value}  ${account_name}
+    Populate Field       Account Name  ${account_name}
+    ${value} =           Get Value  ${locator}
+    Should Be Equal      ${value}  ${account_name}
+
+Populate Lookup Field
+    [Setup]     Run keywords
+    ...  Go to object home  Contact
+    ...  AND  Click Object Button  New
+    [Teardown]  Run keywords
+    ...  Click modal button  Cancel
+    ...  AND  Wait Until Modal Is Closed
+
+    &{account} =           Create Account
+    Populate Lookup Field  Account Name  ${account}[Name]
+    Field value should be  Account Name  ${account}[Name]
+
+Populate Form
+    [Setup]     Run keywords
+    ...  Go to object home  Account
+    ...  AND  Click Object Button  New
+    [Teardown]  Run keywords
+    ...  Click modal button  Cancel
+    ...  AND  Wait Until Modal Is Closed
+
+    ${account_name} =    Get fake data  company
+    Populate Form
+    ...  Ticker Symbol=CASH
+    ...  Account Name=${account_name}
+
+    Field value should be  Ticker Symbol  CASH
+    Field value should be  Account Name  ${account_name}
+
+Select Dropdown Value
+    [Documentation]  Select Dropdown Value happy path tests
+    [Setup]   Run keywords
+    ...  Go to page  Home  Contact
+    ...  AND  Click object button   New
+    ...  AND  Wait for modal        New   Contact
+
+    # required field
+    populate field  Last Name   ${faker.last_name()}
+
+    # these two fields look and act identical, but they are
+    # implemented differently in the DOM *sigh*
+    Select dropdown value  Salutation   Dr.
+
+    Select dropdown value  Lead Source  Purchased List
+
+    Click Modal Button           Save
+    Wait Until Modal Is Closed
+
+    ${contact id} =       Get Current Record Id
+    Store Session Record  Contact  ${contact id}
+
+    # Without waiting, this will sometimes fail. I guess there can be
+    # a bit of a delay for the data to be saved such that the API
+    # can retrieve it.
+    Wait until keyword succeeds  5 seconds  2 seconds
+    ...    Object field should be  Contact  ${contact id}  LeadSource  Purchased List
+    Wait until keyword succeeds  5 seconds  2 seconds
+    ...    Object field should be  Contact  ${contact id}  Salutation  Dr.
+
+Select Dropdown Value exceptions
+    [Documentation]  Verify that the keyword throws appropriate errors
+    [Setup]   Run keywords
+    ...  Go to page  Home  Contact
+    ...  AND  Click object button   New
+    ...  AND  Wait for modal        New   Contact
+
+    # Bad input field name
+    Run keyword and continue on failure
+    ...  Run keyword and expect error  Form element with label 'Bogus' was not found
+    ...    Select dropdown value  Bogus   Mr.
+
+    # Bad value
+    Run keyword and continue on failure
+    ...  Run keyword and expect error  Dropdown value 'Bogus' not found
+    ...    Select dropdown value  Lead Source  Bogus

cumulusci/robotframework/tests/test_cumulusci_library.py

@@ -0,0 +1,304 @@
+import logging
+from pathlib import Path
+from unittest import mock
+
+import pytest
+import robot.api.logger
+
+from cumulusci.core.config import BaseProjectConfig, UniversalConfig
+from cumulusci.core.exceptions import TaskNotFoundError
+from cumulusci.core.tests.utils import MockLoggerMixin
+from cumulusci.robotframework.CumulusCI import CumulusCI
+from cumulusci.tests.util import DummyKeychain, DummyOrgConfig
+from cumulusci.utils import temporary_dir
+
+
+class TestCumulusCILibrary(MockLoggerMixin):
+    def setup_method(self):
+        self.universal_config = UniversalConfig()
+        self.project_config = BaseProjectConfig(
+            self.universal_config,
+            {
+                "project": {"name": "Test"},
+                "tasks": {
+                    "get_pwd": {
+                        "class_path": "cumulusci.tasks.command.Command",
+                        "options": {
+                            "command": "pwd",
+                        },
+                    },
+                },
+                "sources": {
+                    "example": {"path": "/tmp"},
+                },
+            },
+            repo_info={"root": Path(__file__).parent.absolute()},
+        )
+        self.project_config.set_keychain(DummyKeychain())
+
+        self.cumulusci = CumulusCI()
+        self.cumulusci._project_config = self.project_config
+        self.cumulusci._org = mock.Mock()
+        self.cumulusci._org.name = "mock org"
+        self.cumulusci._org.instance_url = "https://test.example.com"
+
+        self._task_log_handler.reset()
+        self.task_log = self._task_log_handler.messages
+
+    def test_run_task(self):
+        """Smoke test; can we run the command task?"""
+        result = self.cumulusci.run_task("get_pwd")
+        assert result["returncode"] == 0
+
+    def test_run_task_robot_logger(self):
+        """Verify that 'run task' uses the robot logger"""
+        with mock.patch.object(self.cumulusci, "_run_task"):
+            self.cumulusci.run_task("get_pwd")
+            args, kwargs = self.cumulusci._run_task.call_args
+            task = args[0]
+            assert task.logger == robot.api.logger
+
+    def test_robot_logger_supports_warning(self):
+        """Verify that 'run task' uses a logger that supports .warning()
+
+        Python deprecated the logger method "warn" in favor of
+        "warning". Robot didn't get the memo and has "warn" instead of
+        "warning".  Since our tasks use "warning", this verifies that
+        we've patched the robot logger before passing it to the task
+        constructor.
+
+        """
+        with mock.patch.object(self.cumulusci, "_run_task"):
+            self.cumulusci.run_task("get_pwd")
+            args, kwargs = self.cumulusci._run_task.call_args
+            task = args[0]
+            assert hasattr(
+                task.logger, "warning"
+            ), "robot logger should have a warning method but doesn't"
+
+    def test_robot_logger_supports_log(self):
+        """Verify that 'run task' uses a logger that supports .log()
+
+        log() normally will be passed a predefined log level (eg:
+        logging.INFO, logging.DEBUG, etc), but it can take any integer
+        which get mapped to a robot log level as a string. This attempts
+        to catch all of the various mappings.
+        """
+        with mock.patch.object(self.cumulusci, "_run_task"):
+            self.cumulusci.run_task("get_pwd")
+            args, kwargs = self.cumulusci._run_task.call_args
+            task = args[0]
+            with mock.patch.object(task.logger, "write") as logger_write:
+
+                task.logger.log(logging.CRITICAL, "a critical message")
+                task.logger.log(logging.ERROR, "an error message")
+                task.logger.log(logging.WARN, "a warning message")
+                task.logger.log(logging.INFO, "an info message")
+                task.logger.log(logging.DEBUG, "a debug message")
+
+                task.logger.log(0, "a message with level 0")
+                task.logger.log(1, "a message with level 1")
+                task.logger.log(11, "a message with level 11")
+                task.logger.log(21, "a message with level 21")
+                task.logger.log(31, "a message with level 31")
+                task.logger.log(41, "a message with level 41")
+
+                logger_write.assert_has_calls(
+                    (
+                        mock.call("a critical message", "ERROR"),
+                        mock.call("an error message", "ERROR"),
+                        mock.call("a warning message", "WARN"),
+                        mock.call("an info message", "INFO"),
+                        mock.call("a debug message", "DEBUG"),
+                        mock.call("a message with level 0", "DEBUG"),
+                        mock.call("a message with level 1", "DEBUG"),
+                        mock.call("a message with level 11", "DEBUG"),
+                        mock.call("a message with level 21", "INFO"),
+                        mock.call("a message with level 31", "WARN"),
+                        mock.call("a message with level 41", "ERROR"),
+                    )
+                )
+
+    def test_run_task_class_robot_logger(self):
+        """Verify that 'run task class' uses the robot logger"""
+        with mock.patch.object(self.cumulusci, "_run_task"):
+            self.cumulusci.run_task_class(
+                "cumulusci.tasks.command.Command", command="ls -l"
+            )
+            args, kwargs = self.cumulusci._run_task.call_args
+            task = args[0]
+            assert task.logger == robot.api.logger
+
+    def test_run_unknown_task(self):
+        with pytest.raises(TaskNotFoundError):
+            self.cumulusci.run_task("bogus")
+
+    def test_cross_project_task(self):
+        """Verify that the cross-project task runs with the project config of the task
+        See W-8891667
+        """
+        with temporary_dir() as tmpdir:
+            tmpdir = Path(tmpdir).resolve()
+            cumulusci_yml_path = tmpdir / "cumulusci.yml"
+            with open(cumulusci_yml_path, "w+") as cumulusci_yml:
+                self.project_config.sources["example"] = {"path": tmpdir}
+                cumulusci_yml.write(
+                    """
+                    tasks:
+                        whatever:
+                            class_path: cumulusci.tasks.command.Command
+                            options:
+                                command: pwd
+                    """
+                )
+
+            with mock.patch.object(self.cumulusci, "_run_task"):
+                self.cumulusci.run_task("example:whatever")
+
+                args, kwargs = self.cumulusci._run_task.call_args
+                assert len(args) == 1
+
+                # make sure it's not using the current project config
+                # for the task, and that the config it _is_ using is
+                # rooted in the directory we created
+                task = args[0]
+                assert task.project_config != self.cumulusci.project_config
+                assert tmpdir == Path(task.project_config.repo_root)
+
+    def test_find_access_token_alias_connected_orgs_multiple_users(self):
+        """Verify exception when more than one username matches the criteria"""
+
+        self.cumulusci.org.salesforce_client.query.side_effect = lambda query: {
+            "records": [
+                {"Username": "tester1@example.com"},
+                {"Username": "tester2@example.com"},
+            ]
+        }
+        with pytest.raises(
+            Exception,
+            match=(
+                "More than one user matched the search critiera "
+                "for org mock org "
+                r"\(tester1@example.com, tester2@example.com\)."
+            ),
+        ):
+            self.cumulusci._find_access_token(
+                base_org=self.cumulusci.org, alias="tester1"
+            )
+            expected_query = "SELECT Username FROM User WHERE alias='tester1'"
+            self.cumulusci.org.salesforce_client.query.assert_called_once_with(
+                expected_query
+            )
+
+    def test_find_access_token_alias_connected_orgs_no_users(self):
+        """Verify exception when no username matches the criteria"""
+
+        self.cumulusci.org.salesforce_client.query.side_effect = lambda query: {
+            "records": []
+        }
+        with pytest.raises(
+            Exception,
+            match=r"Couldn't find a username in org mock org for the specified user \(alias='tester1'\).",
+        ):
+            self.cumulusci._find_access_token(
+                base_org=self.cumulusci.org, alias="tester1"
+            )
+            expected_query = "SELECT Username FROM User WHERE alias='tester1'"
+            self.cumulusci.org.salesforce_client.query.assert_called_once_with(
+                expected_query
+            )
+
+    def test_find_access_token_alias_connected_orgs_no_matching_org(self):
+        self.cumulusci.org.salesforce_client.query.side_effect = lambda query: {
+            "records": [
+                {"Username": "tester1@example.com"},
+            ]
+        }
+
+        token = self.cumulusci._find_access_token(
+            base_org=self.cumulusci.org, alias="tester1"
+        )
+        assert token is None
+
+    def test_find_access_token_happy_path(self):
+        self.cumulusci.org.salesforce_client.query.side_effect = lambda query: {
+            "records": [
+                {"Username": "tester1@example.com"},
+            ]
+        }
+
+        def get_org(org_name):
+            configs = {
+                "org1": DummyOrgConfig(
+                    config={
+                        "access_token": "super-secret-token-1",
+                        "userinfo": {"preferred_username": "tester1@example.com"},
+                    }
+                ),
+                "org2": DummyOrgConfig(
+                    config={
+                        "access_token": "super-secret-token-2",
+                        "userinfo": {"preferred_username": "tester2@example.com"},
+                    }
+                ),
+            }
+            return configs.get(org_name, None)
+
+        def list_orgs():
+            return ["org1", "org2"]
+
+        self.cumulusci.keychain.get_org = mock.Mock(wraps=get_org)
+        self.cumulusci.keychain.list_orgs = mock.Mock(wraps=list_orgs)
+
+        token = self.cumulusci._find_access_token(
+            base_org=self.cumulusci.org, alias="tester1"
+        )
+        assert token == "super-secret-token-1"
+
+    def test_login_url(self):
+        """Verify that login_url by default returns the `start_url` of the org"""
+        url = self.cumulusci.login_url()
+        assert url == self.cumulusci.org.start_url
+
+    def test_login_url_user_org_with_get_access_token(self):
+        """Verify login_url branch when org has a get_access_token method
+
+        This tests a specific branch were we're getting a url for a specific
+        user and the org has a `get_access_token` method.
+        """
+        with mock.patch.object(
+            self.cumulusci.org, "get_access_token", return_value="super-secret-token"
+        ):
+
+            url = self.cumulusci.login_url(username="test@example.com")
+            self.cumulusci.org.get_access_token.assert_called_once_with(
+                username="test@example.com"
+            )
+            assert (
+                url
+                == "https://test.example.com/secur/frontdoor.jsp?sid=super-secret-token"
+            )
+
+    def test_login_url_user_org_without_get_access_token(self):
+        """Verify login_url branch when org DOES NOT have a get_access_token method
+
+        This tests a specific branch were we're getting a url for a specific
+        user and the org is missing the `get_access_token` method.
+        """
+
+        with mock.patch.object(self.cumulusci.org, "get_access_token"):
+            self.cumulusci.org.get_access_token = None
+
+            with mock.patch.object(
+                self.cumulusci, "_find_access_token", return_value="super-secret-token"
+            ):
+                self.cumulusci._find_access_token.return_value = "super-secret-token"
+
+                url = self.cumulusci.login_url(username="test@example.com")
+                self.cumulusci._find_access_token.assert_called_with(
+                    self.cumulusci.org, username="test@example.com"
+                )
+                assert (
+                    url
+                    == "https://test.example.com/secur/frontdoor.jsp?sid=super-secret-token"
+                )