cumulusci.yml

minimum_cumulusci_version: 2.5.0
project:
    name: Cumulus
    package:
        name: Cumulus
        name_managed: Nonprofit Success Pack
        namespace: npsp
        api_version: 46.0
        install_class: STG_InstallScript
        uninstall_class: STG_UninstallScript
    git:
        repo_url: https://github.com/SalesforceFoundation/Cumulus
        prefix_beta: uat/
        prefix_release: rel/
    apexdoc:
        homepage: ApexDocContent/homepage.htm
        banner: ApexDocContent/projectheader.htm
        branch: gh-pages
        repo_dir: ApexDocumentation
    dependencies:
        # npo02 (includes npe01)
        - github: https://github.com/SalesforceFoundation/Households
        # npe03
        - github: https://github.com/SalesforceFoundation/Recurring_Donations
        # npe4
        - github: https://github.com/SalesforceFoundation/Relationships
        # npe5
        - github: https://github.com/SalesforceFoundation/Affiliations

tasks:
    download_ldv_tests:
        description: Downloads the NPSP-LDV-Tests repository
        class_path: cumulusci.tasks.util.DownloadZip
        options:
            dir: ldv_tests
            subfolder: Cumulus-LDV-Tests-master
            url: 'https://github.com/SalesforceFoundation/Cumulus-LDV-Tests/archive/master.zip'

    deploy_ldv_tests:
        description: Deploy the LDV-Tests repo to your org.
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: ldv_tests/src

    deploy_dev_config:
        description: Deploys the post-install configuration for an unmanaged DE org
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: unpackaged/config/dev

    deploy_trial_config:
        description: Deploys the post-install configuration for a trial/new org.
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: unpackaged/config/trial
            namespace_inject: $project_config.project__package__namespace

    deploy_qa_config:
        description: Deploys additional fields used for QA purposes only
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: unpackaged/config/qa
            namespace_inject: $project_config.project__package__namespace

    retrieve_qa_config:
        description: Retrieves additional fields used for QA purposes
        class_path: cumulusci.tasks.salesforce.sourcetracking.RetrieveChanges
        options:
            path: unpackaged/config/qa
            namespace_tokenize: $project_config.project__package__namespace
            snapshot: True

    deploy_qa_namespaced_config:
        description: Deploys additional configuration required for namespaced QA orgs
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: unpackaged/config/qa_namespaced
            namespace_inject: $project_config.project__package__namespace

    deploy_qa_bdi_metadata_config:
        description: Deploys Custom Metadata for BDI QA
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: unpackaged/config/qa_bdi_custom_metadata
            namespace_inject: $project_config.project__package__namespace

    deploy_regression_bdi_metadata_config:
        description: Deploys Custom Metadata for BDI Regression
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: unpackaged/config/regression_bdi_custom_metadata
            namespace_inject: $project_config.project__package__namespace

    deploy_rd2_config:
        description: Deploys updates to fully enable Enhanced Recurring Donations
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: unpackaged/config/rd2_post_config
            namespace_inject: $project_config.project__package__namespace

    deploy_reports:
        description: Deploys reports & dashboards
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: unpackaged/config/reports
            namespace_inject: $project_config.project__package__namespace

    deploy_dev_config_delete:
        description: Deploys the metadata deletions for the post-install DE org config
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: unpackaged/config/delete

    ensure_record_type:
        name: Ensure Opportunity Record Types
        description: This will ensure Record Types are enabled for the Opportunity object in your org before installing NPSP. If there are no Opportunity record types yet, it will create one called NPSP Default.
        class_path: cumulusci.tasks.salesforce.EnsureRecordTypes
        options:
            record_type_label: NPSP Default
            record_type_developer_name: NPSP_Default
            sobject: Opportunity

    is_rd2_enabled:
        description: This preflight check ensures that Enhanced Recurring Donations is enabled
        class_path: tasks.is_rd2_enabled

    robot:
        options:
            suites: robot/Cumulus/tests
            options:
                outputdir: robot/Cumulus/results

    robot_libdoc:
        options:
            path: robot/Cumulus/resources/NPSP.py,robot/Cumulus/resources/NPSP.robot,robot/Cumulus/resources/*PageObject.py
            output: robot/Cumulus/doc/Keywords.html

    update_admin_profile:
        options:
            package_xml: lib/admin_profile.xml
            record_types:
                - record_type: Account.HH_Account
                - record_type: Account.Organization
                  default: true
                  person_account_default: true
                - record_type: Opportunity.NPSP_Default
                  default: true

    test_performance:
        description: Runs Robot Framework performance tests for BDI Complex Objects
        class_path: cumulusci.tasks.robotframework.Robot
        group: Performance Tests
        options:
            suites: robot/Cumulus/perftests/
            options:
                outputdir: robot/Cumulus/results

    platformencryption_deploy_permset:
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: unpackaged/config/platformencryption_permset
            namespace_inject: $project_config.project__package__namespace

    platformencryption_assign_permset:
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        options:
            apex: >
                PermissionSet p = [
                    SELECT Id, Name
                    FROM PermissionSet
                    WHERE Name = 'Encryption'
                ];

                insert new PermissionSetAssignment(
                    PermissionSetId = p.Id,
                    AssigneeId = UserInfo.getUserId()
                );

    platformencryption_create_tenant_secret:
        description: 'Create a placeholder Tenant Secret to use Platform Encryption'
        class_path: cumulusci.tasks.sfdx.SFDXOrgTask
        options:
            command: 'force:data:record:create -s TenantSecret -v "Description=test"'

    platformencryption_deploy_field_configuration:
        class_path: cumulusci.tasks.salesforce.Deploy
        options:
            path: unpackaged/config/platformencryption_fields
            namespace_inject: $project_config.project__package__namespace

    pmd:
        description: Run Apex code analysis with PMD. This task assumes that PMD is available in PATH. On MacOS PMD is available to install in brew.
        class_path: tasks.pmd.PMDTask
        options:
            path: 'src/classes'
            output: text
            runAllApex: False
            htmlfilename: 'pmd.html'

    test_data_dev_org:
        description: 'Loads a test data set for most NPSP objects based on 100 Contacts that should fit into a scratch org or DE org'
        class_path: cumulusci.tasks.bulkdata.LoadData
        options:
            database_url: 'sqlite:///datasets/dev_org/test_data.db'
            mapping: 'datasets/mapping.yml'

    test_data_1k:
        description: 'Loads a test data set for most NPSP objects based on 1024 Contacts'
        class_path: cumulusci.tasks.bulkdata.LoadData
        options:
            database_url: 'sqlite:///datasets/1k/test_data.db'
            mapping: 'datasets/mapping.yml'

    test_data_100k:
        description: 'Loads a test data set for most NPSP objects based on 102400 Contacts.  NOTE: The sqlite data set is not included in the repo for this task so you need to load it into the correct filesystem location'
        class_path: cumulusci.tasks.bulkdata.LoadData
        options:
            database_url: 'sqlite:///datasets/100k/test_data.db'
            mapping: 'datasets/mapping.yml'

    test_data_delete:
        description: 'WARNING: Deletes all data in the objects specified in the objects option.'
        class_path: cumulusci.tasks.bulkdata.DeleteData
        options:
            objects:
                - Opportunity
                - npe03__Recurring_Donation__c
                - Case
                - Contact
                - Account
                - Allocation__c
                - General_Accounting_Unit__c
                - Campaign
                - DataImport__c

    test_data_relationships:
        description: 'Runs execute anonymous to insert the default relationships'
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        options:
            apex: >
                List<npe4__Relationship_Lookup__c> defaultRelationships = new List<npe4__Relationship_Lookup__c>{
                    new npe4__Relationship_Lookup__c(Name = 'Father',npe4__Male__c = 'Son', npe4__Female__c = 'Daughter', npe4__Neutral__c = 'Child'),
                    new npe4__Relationship_Lookup__c(Name = 'Mother',npe4__Male__c = 'Son', npe4__Female__c = 'Daughter', npe4__Neutral__c = 'Child'),
                    new npe4__Relationship_Lookup__c(Name = 'Parent',npe4__Male__c = 'Son', npe4__Female__c = 'Daughter', npe4__Neutral__c = 'Child'),
                    new npe4__Relationship_Lookup__c(Name = 'Son',npe4__Male__c = 'Father', npe4__Female__c = 'Mother', npe4__Neutral__c = 'Parent'),
                    new npe4__Relationship_Lookup__c(Name = 'Daughter',npe4__Male__c = 'Father', npe4__Female__c = 'Mother', npe4__Neutral__c = 'Parent'),
                    new npe4__Relationship_Lookup__c(Name = 'Child',npe4__Male__c = 'Father', npe4__Female__c = 'Mother', npe4__Neutral__c = 'Parent'),
                    new npe4__Relationship_Lookup__c(Name = 'Aunt',npe4__Male__c = 'Nephew', npe4__Female__c = 'Niece', npe4__Neutral__c = 'Sibling\'s Child'),
                    new npe4__Relationship_Lookup__c(Name = 'Uncle',npe4__Male__c = 'Nephew', npe4__Female__c = 'Niece', npe4__Neutral__c = 'Sibling\'s Child'),
                    new npe4__Relationship_Lookup__c(Name = 'Husband',npe4__Male__c = 'Husband', npe4__Female__c = 'Wife', npe4__Neutral__c = 'Spouse'),
                    new npe4__Relationship_Lookup__c(Name = 'Wife',npe4__Male__c = 'Husband', npe4__Female__c = 'Wife', npe4__Neutral__c = 'Spouse'),
                    new npe4__Relationship_Lookup__c(Name = 'Partner',npe4__Male__c = 'Partner', npe4__Female__c = 'Partner', npe4__Neutral__c = 'Partner'),
                    new npe4__Relationship_Lookup__c(Name = 'Cousin',npe4__Male__c = 'Cousin', npe4__Female__c = 'Cousin', npe4__Neutral__c = 'Cousin'),
                    new npe4__Relationship_Lookup__c(Name = 'Grandmother',npe4__Male__c = 'Grandson', npe4__Female__c = 'Granddaughter', npe4__Neutral__c = 'Grandchild'),
                    new npe4__Relationship_Lookup__c(Name = 'Grandfather',npe4__Male__c = 'Grandson', npe4__Female__c = 'Granddaughter', npe4__Neutral__c = 'Grandchild'),
                    new npe4__Relationship_Lookup__c(Name = 'Grandparent',npe4__Male__c = 'Grandson', npe4__Female__c = 'Granddaughter', npe4__Neutral__c = 'Grandchild'),
                    new npe4__Relationship_Lookup__c(Name = 'Grandson',npe4__Male__c = 'Grandfather', npe4__Female__c = 'Grandmother', npe4__Neutral__c = 'Grandparent'),
                    new npe4__Relationship_Lookup__c(Name = 'Granddaughter',npe4__Male__c = 'Grandfather', npe4__Female__c = 'Grandmother', npe4__Neutral__c = 'Grandparent'),
                    new npe4__Relationship_Lookup__c(Name = 'Grandchild',npe4__Male__c = 'Grandfather', npe4__Female__c = 'Grandmother', npe4__Neutral__c = 'Grandparent'),
                    new npe4__Relationship_Lookup__c(Name = 'Employer',npe4__Male__c = 'Employee', npe4__Female__c = 'Employee', npe4__Neutral__c = 'Employee'),
                    new npe4__Relationship_Lookup__c(Name = 'Employee',npe4__Male__c = 'Employer', npe4__Female__c = 'Employer', npe4__Neutral__c = 'Employer')
                };
                insert defaultRelationships;


    test_data_delete_managed:
        description: 'WARNING: Deletes all data in the objects specified in the objects option.'
        class_path: cumulusci.tasks.bulkdata.DeleteData
        options:
            objects:
                - Opportunity
                - npe03__Recurring_Donation__c
                - Case
                - Contact
                - Account
                - npsp__Allocation__c
                - npsp__General_Accounting_Unit__c
                - Campaign
                - npe01__OppPayment__c
                - npsp__DataImport__c

    npsp_default_settings:
        description: Configure the default NPSP Settings including Membership RecordType
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        options:
            path: scripts/configure_npsp_default_settings.cls
            apex: initializeNPSPSettings();

    enable_customizable_rollups:
        description: Enable the NPSP Customizable Rollups feature (unmanaged deploys only)
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        options:
            apex: new STG_PanelCustomizableRollup_CTRL().enableCRLPs();

    enable_incremental_rollups:
        description: Configure NPSP Customizable Rollups to activate Incremental Rollups (unmanaged deploys only)
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        options:
            apex: >
                STG_SettingsService.stgService.stgCRLP.AccountHardCreditNonSkew_Incremental__c = true;
                STG_SettingsService.stgService.stgCRLP.ContactHardCreditNonSkew_Incremental__c = true;
                STG_SettingsService.stgService.saveAll();

    add_second_currency:
        description: Add CAD as a 2nd currency for a multicurrency org
        class_path: tasks.multicurrency.ConfigureCAD

    uninstall_packaged_incremental:
        description: Deletes any metadata from the package in the target org not in the local workspace
        class_path: cumulusci.tasks.salesforce.UninstallPackagedIncremental
        options:
            ignore:
                QuickAction:
                    - NewEvent
                    - NewCase
                    - SendEmail
                # Unpackaged lightning record pages added by trial config
                FlexiPage:
                    - NPSP_Address_Record_Page
                    - NPSP_Deliverable
                    - NPSP_Engagement_Plan_Record_Page
                    - NPSP_GAU_Allocation
                    - NPSP_General_Accounting_Unit

    enable_pilot_in_scratch_org:
        description: Initialize the PilotEnabled Feature Parameter override in a Scratch Org environment
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        options:
            apex: >
                %%%NAMESPACE%%%Error_Settings__c errSettings = %%%NAMESPACE%%%Error_Settings__c.getOrgDefaults();
                errSettings.%%%NAMESPACE%%%OverrideFeature_PilotEnabled__c = true;
                upsert errSettings;

    run_tests:
        options:
            retry_failures:
                - "unable to obtain exclusive access to this record"
                - "UNABLE_TO_LOCK_ROW"
                - "connection was cancelled here"
            retry_always: True

flows:
    config_dev:
        steps:
            3:
                task: deploy_dev_config_delete
            4:
                task: deploy_dev_config
            5:
                task: npsp_default_settings

    config_qa:
        steps:
            2:
                task: None
            3:
                task: deploy_dev_config_delete
            4:
                task: deploy_trial_config
            5:
                task: npsp_default_settings
            6:
                task: deploy_qa_config
            7:
                task: deploy_qa_bdi_metadata_config
            8:
                task: update_admin_profile
            9:
                task: test_data_relationships
            10:
                task: deploy_reports

    config_qa_namespaced:
        steps:
            1:
                task: deploy_post
            2:
                task: None
            3:
                task: deploy_dev_config_delete
            4:
                task: deploy_trial_config
            5:
                task: npsp_default_settings
            6:
                task: deploy_qa_config
            7:
                task: deploy_qa_bdi_metadata_config
                options:
                    namespaced_org: True
                    unmanaged: False
            8:
                task: update_admin_profile
            9:
                task: test_data_relationships
            10:
                task: deploy_reports
            11:
                task: deploy_qa_namespaced_config


    qa_org_namespaced:
        description: Execute the qa_org flow against a namespaced scratch org and patch help text.
        steps:
            1:
                flow: dependencies
            2:
                flow: deploy_unmanaged
            3:
                flow: config_qa_namespaced
            4:
                task: snapshot_changes

    deploy_rollup_testing:
        description: 'Deploys custom fields and rollup definitions for testing Customizable Rollups using the Apex Anon testing script. >>> NOTE: Customizable Rollups needs to be successfully enabled before deploy_rollup_testing can be run <<<'
        steps:
            1:
                task: deploy
                options:
                    path: unpackaged/config/crlp_testing
            2:
                task: update_admin_profile

    deploy_rd2_testing:
        description: 'Configure everything for enhanced recurring donations testing in a scratch org'
        steps:
            1:
                task: enable_customizable_rollups
            2:
                task: enable_pilot_in_scratch_org
            3:
                task: execute_anon
                options:
                    apex: >
                        npe03__Recurring_Donations_Settings__c rdSettings = npe03__Recurring_Donations_Settings__c.getOrgDefaults();
                        rdSettings.%%%NAMESPACE%%%isRecurringDonations2Enabled__c = true;
                        upsert rdSettings;
            4:
                task: deploy_rd2_config

    config_managed:
        steps:
            2:
                task: deploy_dev_config_delete
            3:
                task: deploy_trial_config
                options:
                    unmanaged: False
            4:
                task: update_admin_profile
                options:
                    managed: true
            5:
                task: test_data_relationships
            6:
                task: deploy_reports
                options:
                    unmanaged: False

    config_regression:
        steps:
            2:
                task: deploy_qa_config
                options:
                    unmanaged: False
            3:
                task: deploy_regression_bdi_metadata_config
            4:
                task: update_admin_profile
                options:
                    managed: true

    config_offsetfiscal:
        description: 'Configure an offset fiscal year'
        steps:
            1:
                task: deploy
                options:
                    path: unpackaged/config/offsetfiscal

    config_multicurrency:
        description: 'Configure a second currency'
        steps:
            1:
                task: add_second_currency

    config_platformencryption:
        description: 'Configure Platform Encryption org to encrypt standard fields'
        steps:
            1:
                task: platformencryption_deploy_permset
            2:
                task: platformencryption_assign_permset
            3:
                task: platformencryption_create_tenant_secret
            4:
                task: platformencryption_deploy_field_configuration

    test_data_dev_org:
        description: 'WARNING: This flow deletes all data first, then loads the complete test data set based on 100 Contacts into the target org.'
        steps:
            1:
                task: test_data_delete
            2:
                task: test_data_dev_org

    test_data_dev_org_managed:
        description: 'WARNING: This flow deletes all data first, then loads the complete test data set based on 100 Contacts into the target org.'
        steps:
            1:
                task: test_data_delete_managed
            2:
                task: test_data_dev_org
                options:
                    mapping: datasets/mapping_managed.yml

    test_data_1k:
        description: 'WARNING: This flow deletes all data first, then loads the complete test data set based on 1,024 Contacts into the target org.'
        steps:
            1:
                task: test_data_delete
            2:
                task: test_data_1k

    ldv_tests:
        description: 'Deploys and runs LDV tests'
        steps:
            1:
                task: download_ldv_tests
            2:
                task: deploy_ldv_tests
            3:
                task: run_tests
                options:
                    test_name_match: LDV_%

    dependencies:
        steps:
            3:
                task: ensure_record_type

    test_performance_scratch:
        description: 'Creates a test org and runs BDI performance tests'
        steps:
            1:
                flow: qa_org
            3:
                task: test_performance
                options:
                    include: medium
                    vars: persistent_org:False

    test_performance_LDV:
        description: 'Runs BDI performance tests against a pre-existing org'
        steps:
            1:
                task: test_performance
                options:
                    include: ultra-long
                    vars: persistent_org:True

    beta_dependencies:
        steps:
            3:
                task: ensure_record_type

    rd2_pilot_org:
        steps:
            1:
                flow: install_prod
            2:
                task: enable_pilot_in_scratch_org
                options:
                    managed: True
            3:
                task: load_dataset
                options:
                    mapping: datasets/rd2_pilot/mapping_managed.yml
                    sql_path: datasets/rd2_pilot/data.sql
                    database_url: ""

orgs:
    scratch:
        dev_multicurrency:
            config_file: orgs/dev_multicurrency.json
            days: 7
        dev_namespaced:
            config_file: orgs/dev.json
            namespaced: True
            days: 7
        beta_middlesuffix:
            config_file: orgs/beta_middlesuffix.json
        beta_multicurrency:
            config_file: orgs/beta_multicurrency.json
        beta_personaccounts:
            config_file: orgs/beta_personaccounts.json
        beta_platformencryption:
            config_file: orgs/beta_platformencryption.json
        beta_statecountry:
            config_file: orgs/beta_statecountry.json
        prerelease:
            config_file: orgs/prerelease.json
        trial:
            config_file: orgs/trial.json
        enterprise:
            config_file: orgs/enterprise.json

plans:
    existing_org:
        slug: install
        title: Install NPSP
        tier: primary
        steps:
            1:
                task: update_dependencies
            2:
                task: deploy
                options:
                    path: unpackaged/pre/account_record_types
                ui_options:
                    name: Account Record Types
            3:
                task: ensure_record_type
                ui_options:
                    name: Opportunity Record Types
            4:
                task: install_managed
            5:
                task: deploy_post
                options:
                    unmanaged: False
                ui_options:
                    first:
                        name: NPSP Config for Salesforce Mobile App
    new_org:
        slug: trailhead
        title: Install NPSP for Trailhead Playgrounds
        tier: additional
        is_listed: False
        steps:
            1:
                task: update_dependencies
            2:
                task: deploy
                options:
                    path: unpackaged/pre/account_record_types
                ui_options:
                    name: Account Record Types
            3:
                task: ensure_record_type
                ui_options:
                    name: Opportunity Record Types
            4:
                task: install_managed
            5:
                flow: config_managed
                options:
                    deploy_reports:
                        unmanaged: False
                ui_options:
                    deploy_post:
                        first:
                            name: NPSP Config for Salesforce Mobile App
                    deploy_dev_config_delete:
                        name: Delete Developer Edition Sample Profiles
                        description: This deletes sample page layouts and profiles intended for Sales, Marketing, and Support use cases.
                        is_required: False
                    deploy_trial_config:
                        name: NPSP Trial Experience
                    test_data_relationships:
                        name: Set Default Relationship Settings
                    deploy_reports:
                        name: NPSP Reports & Dashboards
                        is_required: False
    rd2:
        slug: npsp-rd2-pilot
        title: Enhanced Recurring Donations Metadata Updates
        tier: additional
        is_listed: False
        checks:
            - when: "not tasks.is_rd2_enabled()"
              action: error
              message: "Please ensure that Enhanced Recurring Donations is enabled in your org before beginning the installation."
        steps:
            1:
                task: deploy_rd2_config
                options:
                    unmanaged: False
                ui_options:
                    name: "Enhanced Recurring Donations Metadata Updates"
    reports:
        slug: reports
        title: Install Reports & Dashboards
        tier: additional
        is_listed: True
        steps:
            1:
                task: deploy_reports
                options:
                    unmanaged: False
                ui_options:
                    name: NPSP Reports & Dashboards