cumulusci.yml

project:
    name: CumulusCI-Test
    package:
        name: CumulusCI Test
        namespace: ccitest
        api_version: 48.0
    git:
        default_branch: main
        repo_url: https://github.com/SalesforceFoundation/CumulusCI-Test
    source_format: sfdx
    dependencies:
        - namespace: pub
          version: 1.5

tasks:
    github_automerge_feature:
        options:
            update_future_releases: false
    named_sleep:
        description: sleeps, and has a name
        class_path: tasks.example.StaticSleep

    preflight:
        description: returns static preflight result
        class_path: tasks.example.StaticPreflightTask

    preflight_error:
        description: blows up with a NotImplementedError
        class_path: cumulusci.core.tasks.BaseTask

    example_task:
        description: An example project-level task that does nothing
        class_path: tasks.example.ExampleTask

    update_admin_profile:
        options:
            record_types:
                - record_type: Account.HH_Account
                - record_type: Account.Organization
                  default: true
                  person_account_default: true
                - record_type: Opportunity.NPSP_Default
                  default: true

    account_record_types:
        description: Dummy task for UX testing
        class_path: cumulusci.tasks.util.Sleep
        options:
            seconds: 3
    opportunity_record_types:
        description: Dummy task for UX testing
        class_path: cumulusci.tasks.util.Sleep
        options:
            seconds: 3
    contacts_and_organizations:
        description: Dummy task for UX testing
        class_path: cumulusci.tasks.util.Sleep
        options:
            seconds: 7
    households:
        description: Dummy task for UX testing
        class_path: cumulusci.tasks.util.Sleep
        options:
            seconds: 7
    recurring_donations:
        description: Dummy task for UX testing
        class_path: cumulusci.tasks.util.Sleep
        options:
            seconds: 5
    relationships:
        description: Dummy task for UX testing
        class_path: cumulusci.tasks.util.Sleep
        options:
            seconds: 4
    affiliations:
        description: Dummy task for UX testing
        class_path: cumulusci.tasks.util.Sleep
        options:
            seconds: 3
    npsp:
        description: Dummy task for UX testing
        class_path: cumulusci.tasks.util.Sleep
        options:
            seconds: 10
    outbound_funds:
        description: Dummy task for UX testing
        class_path: cumulusci.tasks.util.Sleep
        options:
            seconds: 5
    install_vbt:
        description: Install VBT Package (for migrating OmniStudio components)
        class_path: cumulusci.tasks.salesforce.InstallPackageVersion
        group: OmniStudio
        options:
            namespace: vbtapp
            version: "1.3"
            name: VBT App
    install_omnistudio:
        description: Install OmniStudio
        class_path: cumulusci.tasks.salesforce.InstallPackageVersion
        group: OmniStudio
        options:
            namespace: omnistudio
            version: "234.4"
            name: OmniStudio

flows:
    ci_test_concurrency:
        description: A flow that does nothing but sleep for a minute.  Used to test concurrency on CI systems
        steps:
            1:
                task: util_sleep
                options:
                    seconds: 60

    slow_steps_flow:
        description: A flow that slowly goes step by step.
        steps:
            1:
                task: named_sleep
                options:
                    seconds: 5
                    task_name: quick_task
            2:
                task: named_sleep
                options:
                    seconds: 10
                    task_name: slow_task
            3:
                task: named_sleep
                options:
                    seconds: 7
                    task_name: medium_task
            4:
                task: named_sleep
                options:
                    seconds: 1
                    task_name: relationships
            5:
                task: named_sleep
                options:
                    seconds: 1
                    task_name: affiliations
            6:
                task: named_sleep
                options:
                    seconds: 1
                    task_name: update_admin_profile
            7:
                task: named_sleep
                options:
                    seconds: 1
                    task_name: install_managed
            8:
                task: named_sleep
                options:
                    seconds: 1
                    task_name: deploy_pre
            9:
                task: named_sleep
                options:
                    seconds: 1
                    task_name: deploy_post
            10:
                task: named_sleep
                options:
                    seconds: 1
                    task_name: ordered_step

    slow_steps_preflight_good:
        description: A passing preflight for the slow_steps_flow.
        steps:
            1:
                task: preflight
                options:
                    task_name: quick_task
            2:
                task: preflight
                options:
                    task_name: slow_task
            3:
                task: preflight
                options:
                    task_name: medium_task
            4:
                task: preflight
                options:
                    task_name: relationships
            5:
                task: preflight
                options:
                    task_name: affiliations
            6:
                task: preflight
                options:
                    task_name: update_admin_profile
            7:
                task: preflight
                options:
                    task_name: install_managed
            8:
                task: preflight
                options:
                    task_name: deploy_pre
            9:
                task: preflight
                options:
                    task_name: deploy_post
            10:
                task: preflight
                options:
                    task_name: ordered_step

    slow_steps_preflight_warn:
        description: A warning preflight for the slow_steps_flow.
        steps:
            1:
                task: preflight
                options:
                    task_name: quick_task
            2:
                task: preflight
                options:
                    task_name: slow_task
                    status_code: warn
                    msg: This might cause headache and eyestrain.
            3:
                task: preflight
                options:
                    task_name: medium_task
            4:
                task: preflight
                options:
                    task_name: relationships
            5:
                task: preflight
                options:
                    task_name: affiliations
            6:
                task: preflight
                options:
                    task_name: update_admin_profile
            7:
                task: preflight
                options:
                    task_name: install_managed
            8:
                task: preflight
                options:
                    task_name: deploy_pre
            9:
                task: preflight
                options:
                    task_name: deploy_post
            10:
                task: preflight
                options:
                    task_name: ordered_step

    slow_steps_preflight_bad:
        description: A failing preflight for the slow_steps_flow.
        steps:
            1:
                task: preflight
                options:
                    task_name: quick_task
            2:
                task: preflight
                options:
                    task_name: slow_task
                    status_code: error
                    msg: You never expected this to work, did you?
            3:
                task: preflight
                options:
                    task_name: medium_task
            4:
                task: preflight
                options:
                    task_name: relationships
            5:
                task: preflight
                options:
                    task_name: affiliations
            6:
                task: preflight
                options:
                    task_name: update_admin_profile
            7:
                task: preflight
                options:
                    task_name: install_managed
            8:
                task: preflight
                options:
                    task_name: deploy_pre
            9:
                task: preflight
                options:
                    task_name: deploy_post
            10:
                task: preflight
                options:
                    task_name: ordered_step

    test_npsp_install:
        description: A flow to simulate installing a production version of NPSP for UX testing
        steps:
            1:
                task: account_record_types
            2:
                task: opportunity_record_types
            3:
                task: contacts_and_organizations
            4:
                task: households
            5:
                task: recurring_donations
            6:
                task: relationships
            7:
                task: affiliations
            8:
                task: npsp

    test_npsp_install_error:
        description: A flow to simulate installing a production version of NPSP for UX testing
        steps:
            1:
                task: account_record_types
            2:
                task: deploy
                options:
                    path: does_not_exist
            3:
                task: contacts_and_organizations
            4:
                task: households
            5:
                task: recurring_donations
            6:
                task: relationships
            7:
                task: affiliations
            8:
                task: npsp

    test_npsp_preflight:
        description: A preflight flow that passes.
        steps:
            1:
                task: preflight
                options:
                    task_name: account_record_types
            2:
                task: preflight
                options:
                    task_name: opportunity_record_types
            3:
                task: preflight
                options:
                    task_name: contacts_and_organizations
            4:
                task: preflight
                options:
                    task_name: households
            5:
                task: preflight
                options:
                    task_name: recurring_donations
            6:
                task: preflight
                options:
                    task_name: relationships
            7:
                task: preflight
                options:
                    task_name: affiliations
            8:
                task: preflight
                options:
                    task_name: npsp

    test_npsp_preflight_warn:
        description: A preflight flow for test_npsp_install_error that creates a warning.
        steps:
            1:
                task: preflight
                options:
                    task_name: account_record_types
            2:
                task: preflight
                options:
                    task_name: deploy
                    status_code: warn
                    msg: The Opportunity Record Type and Business Process already exist in your org.  Are you sure you want to overwrite them?
            3:
                task: preflight
                options:
                    task_name: contacts_and_organizations
            4:
                task: preflight
                options:
                    task_name: households
            5:
                task: preflight
                options:
                    task_name: recurring_donations
            6:
                task: preflight
                options:
                    task_name: relationships
            7:
                task: preflight
                options:
                    task_name: affiliations
            8:
                task: preflight
                options:
                    task_name: npsp

    test_outboundfunds_install:
        description: A flow to simulate installing a production version of NPSP for UX testing
        steps:
            1:
                task: outbound_funds

    test_outboundfunds_preflight:
        description: A passing preflight for test_outboundfunds_install
        steps:
            1:
                task: preflight
                options:
                    task_name: outbound_funds

    static_preflight:
        description: A preflight flow that returns a static value. for Install prod...
        steps:
            1:
                task: preflight
                options:
                    task_name: update_dependencies
            2:
                task: preflight
                options:
                    task_name: deploy_pre
            3:
                task: preflight
                options:
                    task_name: install_managed
            4:
                task: preflight
                options:
                    task_name: deploy_post
            5:
                task: preflight
                options:
                    task_name: update_admin_profile

    failing_preflight:
        description: A preflight flow that fails.
        steps:
            1:
                task: preflight
                options:
                    task_name: update_dependencies
            2:
                task: preflight
                options:
                    task_name: deploy_pre
            3:
                task: preflight
                options:
                    task_name: install_managed
                    status_code: error
                    msg: You cannot install CumulusCI-Test into the CumulusCI-Test Packaging org, you goof!
            4:
                task: preflight
                options:
                    task_name: deploy_post
            5:
                task: preflight
                options:
                    task_name: update_admin_profile

    messy_preflight:
        description: A preflight flow that has all kinds of issues.
        steps:
            1:
                task: preflight
                options:
                    task_name: update_dependencies
            2:
                task: preflight
                options:
                    task_name: deploy_pre
                    status_code: warn
                    msg: You may see an error with the next task.
            3:
                task: preflight
                options:
                    task_name: install_managed
                    status_code: error
                    msg: You cannot install CumulusCI-Test into the CumulusCI-Test Packaging org, you goof!
            4:
                task: preflight
                options:
                    task_name: deploy_post
                    status_code: optional
            5:
                task: preflight
                options:
                    task_name: update_admin_profile
                    status_code: skip

    warn_preflight:
        description: A preflight flow that has warnings.
        steps:
            1:
                task: preflight
                options:
                    task_name: update_dependencies
            2:
                task: preflight
                options:
                    task_name: deploy_pre
                    status_code: warn
                    msg: This warning is an <script>evil()</script> example.
            3:
                task: preflight
                options:
                    task_name: install_managed
                    status_code: warn
                    msg: This warning is a <a href="https://www.salesforce.org/">good</a> example.

    error_preflight:
        description: A preflight flow that has a top-level error.
        steps:
            1:
                task: preflight_error
                options:
                    task_name: not_implemented

    test_metadeploy:
        description: A flow that tests happy-path MetaDeploy capabilities
        steps:
            1:
                task: install_omnistudio
            2:
                task: install_vbt
            3:
                task: deploy
                options:
                    path: force-app
            4:
                # Validate we can shell to sfdx
                task: dx_convert_from
            5:
                # Validate we can run a VBT task
                task: vlocity_pack_export
                options:
                    job_file: jobfile.yaml
            # Wait steps so we can make this plan take time if we need to test concurrency or safe restarts.
            6:
                task: util_sleep
                options:
                    seconds: 300
                ui_options:
                    is_required: false
                    is_recommended: false
            7:
                task: util_sleep
                options:
                    seconds: 300
                ui_options:
                    is_required: false
                    is_recommended: false
            8:
                task: util_sleep
                options:
                    seconds: 300
                ui_options:
                    is_required: false
                    is_recommended: false
            9:
                task: util_sleep
                options:
                    seconds: 300
                ui_options:
                    is_required: false
                    is_recommended: false
            10:
                task: util_sleep
                options:
                    seconds: 300
                ui_options:
                    is_required: false
                    is_recommended: false

orgs:
    scratch:
        e2e:
            config_file: orgs/e2e.json

plans:
    install:
        tier: primary
        slug: install
        title: Install
        allowed_org_providers:
            - devhub
            - user
        description: This is a test installation plan. Do not run this plan on a real Salesforce org.
        steps:
            1:
                flow: test_metadeploy