cumulusci.yml

minimum_cumulusci_version: 3.5.0
project:
    name: EDA
    package:
        name: EDA
        namespace: hed
        api_version: 45.0
        install_class: STG_InstallScript
    git:
        prefix_release: rel/
        repo_url: https://github.com/SalesforceFoundation/EDA
    apexdoc:
        homepage: ApexDocContent/homepage.htm
        banner: ApexDocContent/projectheader.htm
        branch: gh-pages
        repo_dir: ApexDocumentation

sources:
    latest_release:
        github: https://github.com/SalesforceFoundation/EDA
        release: latest

tasks:
    deploy_dev_config:
        description: Deploys configuration for Development. Assigns page layouts, compact layouts, and sets tab visibilities. Record type visibilities are set in the update_admin_profile task.
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            namespace_inject: $project_config.project__package__namespace
            path: unpackaged/config/dev
            unmanaged: True

    delete_dev_config:
        description: Removes Development configuration. Sets page layouts, compact layouts to system defaults. Removes record type visibilites.
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: unpackaged/config/dev_delete

    deploy_einstein_templates:
        group: 'EDA: Einstein Templates'
        description: Deploys Einstein Analytics Templates
        class_path: cumulusci.tasks.salesforce.Deploy
        ui_options:
            name: Deploy Einstein Analytics Templates
        options:
            path: unpackaged/config/analytics
            namespace_inject: $project_config.project__package__namespace
            unmanaged: False

    deploy_encryption_permset:
        group: 'Shield Platform Encryption'
        description: Deploys "Manage Encryption Keys" permission set.
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: unpackaged/config/spe
            namespace_inject: $project_config.project__package__namespace

    assign_encryption_permset:
        group: 'Shield Platform Encryption'
        description: Assigns the Encryption permission set to the current user for Shield Platform Encryption testing.
        class_path: cumulusci.tasks.sfdx.SFDXOrgTask
        options:
            command: 'force:user:permset:assign -n Encryption'

    create_tenant_secret:
        group: 'Shield Platform Encryption'
        description: Creates a new tenant secret for Shield Platform Encryption testing.
        class_path: cumulusci.tasks.sfdx.SFDXOrgTask
        options:
            command: 'force:data:record:create -s TenantSecret -v "Description=Testing"'

    execute_install_apex:
        description: Runs anonymous apex for dev to configure settings, insert Affiliation mappings, insert Relationship lookups and insert default tdtm trigger handlers.
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        options:
            apex: >
                UTIL_CustomSettingsFacade.getSettings();
                STG_InstallScript.insertMappings();
                STG_InstallScript.insertRelationshipLookups();
                TDTM_Global_API.setTdtmConfig(TDTM_Global_API.getDefaultTdtmConfig(), 'hed');
                STG_InstallScript.enablePreferredPhoneSync();

    execute_qa_apex:
        description: Runs anonymous apex for qa to configure settings.
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        options:
            path: scripts/setup.cls
            apex: qaSetup();

    has_einstein_licenses:
        group: 'EDA: Einstein Templates'
        description: Queries the target org for the existence of required permsets and returns true if found.
        class_path: tasks.check_einstein.CheckPermSetLicenses
        options:
            permission_sets:
                - EinsteinAnalyticsUser
                - EinsteinAnalyticsAdmin
                - EinsteinAnalyticsPlusAdmin
                - EinsteinAnalyticsPlusUser

    retrieve_config_dev:
        description: Retrieves the current changes in the scratch org into unpackaged/config/dev.
        class_path: cumulusci.tasks.salesforce.sourcetracking.RetrieveChanges
        options:
            path: unpackaged/config/dev
            namespace_tokenize: $project_config.project__package__namespace

    retrieve_config_trial:
        description: Retrieves the current changes in the scratch org into unpackaged/config/trial.
        class_path: cumulusci.tasks.salesforce.sourcetracking.RetrieveChanges
        options:
            path: unpackaged/config/trial
            namespace_tokenize: $project_config.project__package__namespace

    robot:
        # description: Runs a Robot Framework test from a .robot file.
        options:
            suites: robot/EDA/tests
            options:
                outputdir: robot/EDA/results

    robot_libdoc:
        # description: Generates documentation for project keyword files.
        options:
            path: robot/EDA/resources/EDA.py,robot/EDA/resources/EDA.robot
            output: robot/EDA/doc/Keywords.html

    update_admin_profile:
        # description: Retrieves, edits, and redeploys the System Administrator profile with full FLS perms for all objects/fields. Also sets record type visibilities.
        group: "EDA: Custom Tasks"
        class_path: tasks.salesforce.UpdateAdminProfile

flows:
    setup_encryption:
        description: Sets up Shield Platform Encryption in the target Org. It is recommended that this flow be run in developer scratch orgs only.
        steps:
            1:
                task: deploy_encryption_permset
            2:
                task: assign_encryption_permset
            3:
                task: create_tenant_secret

    edaectomy:
        description: Remove all the EDA metadata in the target Org.
        steps:
            1:
                task: delete_dev_config
            2:
                task: uninstall_packaged

    config_apextest:
        # description: Configure an org to run apex tests after package metadata is deployed.
        steps:
            3:
                task: execute_install_apex

    config_dev:
        # description: Configure an org for use as a dev org after package metadata is deployed.
        steps:
            3:
                task: execute_install_apex
            4:
                task: deploy_dev_config

    config_dev_namespaced:
        # description: Configure an org for use as a namespaced dev org after package metadata is deployed.
        steps:
            1:
                task: deploy_post
                options:
                    namespaced_org: True
            2:
                task: update_admin_profile
                options:
                    namespaced_org: True
            3:
                task: execute_install_apex
            4:
                task: deploy_dev_config

    config_managed:
        # description: Configure an org for use as a dev org after package metadata is deployed.
        steps:
            3:
                task: deploy_dev_config
                options:
                    unmanaged: False
            4:
                task: deploy_einstein_templates

    config_packaging:
        # description: Configure packaging org for upload after package metadata is deployed
        steps:
            1:
                # Configure update_admin_profile
                options:
                    managed: True
                    namespaced_org: True
                    skip_record_types: True

    config_qa:
        # descripton: Configure an org for use as a QA org after package metadata is deployed.
        steps:
            3:
                task: execute_install_apex
            4:
                task: deploy_dev_config
            5:
                task: execute_qa_apex
            6:
                task: deploy_qa_config

    config_regression:
        # description: Configure an org for QA regression after the package is installed.
        steps:
            2:
                task: execute_qa_apex
                options:
                    managed: True
                    namespaced: True
            3:
                task: deploy_qa_config
                options:
                    unmanaged: False

    deploy_unmanaged:
        # description: Deploy the unmanaged metadata from the package
        steps:
            4:
                # Disable uninstall_packaged_incremental
                task: None

    dev_org_namespaced:
        # description: Set up a namespaced scratch org as a development environment for unmanaged metadata
        steps:
            3:
                # Configure the config_dev flow for namespaced org
                options:
                    update_admin_profile:
                        namespaced_org: True

    upgraded_org:
        description: Simulates an existing EDA customer org that has been push-upgraded from the latest production release of EDA to the current beta, including any dependencies. Deploys the unmanaged metadata from the production release.
        steps:
            1:
                flow: latest_release:dependencies
            2:
                task: install_managed
            3:
                flow: latest_release:config_regression
            4:
                task: update_dependencies
                options:
                    include_beta: True
            5:
                task: install_managed_beta
    net_new_org:
        description: Simulates an EDA installation for a new customer. Installs the latest beta and dependencies.
        steps:
            1:
                flow: install_beta
            2:
                task: execute_qa_apex
                options:
                    managed: True
                    namespaced: True
            3:
                task: deploy_qa_config
                options:
                    unmanaged: False

services:
    mockaroo:
        description: Configure connection for Mockaroo tasks
        attributes:
            key:
                description: The API key for Mockaroo
                required: True

orgs:
    scratch:
        dev_namespaced:
            config_file: orgs/dev.json
            namespaced: True
        prerelease:
            config_file: orgs/prerelease.json
        prerelease_namespaced:
            config_file: orgs/prerelease.json
            namespaced: True
        trial:
            config_file: orgs/trial.json

plans:
    install:
        slug: install
        title: Install
        tier: primary
        steps:
            1:
                flow: dependencies
                ui_options:
                    deploy_pre:
                        acc_record_types:
                            name: EDA - Account Record Types
                        contact_key_affl_fields:
                            name: EDA - Contact Key Affiliation Fields
            2:
                task: install_managed
            3:
                task: deploy_post
                ui_options:
                    course_connection_record_types:
                        name: EDA - Course Connection Record Types
                    facility_display_name:
                        name: EDA - Facility Display Name Formula Field
                    case_behavior_record_types:
                        name: EDA - Case Behavior Record Types
                options:
                    unmanaged: False

    ra_einstein_template:
        slug: ra_template
        title: Install Education Cloud Recruiting Analytics Template
        is_listed: False
        tier: additional
        steps:
            1:
                task: deploy_einstein_templates
        checks:
            - when: "not tasks.has_einstein_licenses()"
              action: error
              message: Einstein Analytics permission sets are not available.