cumulusci.yml

minimum_cumulusci_version: 3.23.0
project:
    name: Athena
    package:
        name: K-12 Architecture Kit
        api_version: "48.0"
        namespace: k12kit
        install_class: STG_InstallScript
    git:
        default_branch: main
        prefix_feature: feature/
        prefix_beta: beta/
        prefix_release: release/
        repo_url: https://github.com/SalesforceFoundation/k12-architecture-kit
    dependencies:
        - github: "https://github.com/SalesforceFoundation/EDA"
    source_format: sfdx

sources:
    eda:
        github: https://github.com/SalesforceFoundation/EDA
        release: latest
    latest_release:
        github: https://github.com/SalesforceFoundation/k12-architecture-kit
        release: latest

tasks:
    add_application_type_picklist_values:
        description: Adds additional picklist values to the Type field.
        class_path: cumulusci.tasks.metadata_etl.picklists.AddPicklistEntries
        group: "K-12: Metadata"
        options:
            picklists: hed__Application__c.hed__Application_Type__c
            entries:
                - fullName: "High School"
                  label: "High School"
                  add_before: "Transfer"
                - fullName: "Middle School"
                  label: "Middle School"
                  add_before: "Transfer"
                - fullName: "Elementary School"
                  label: "Elementary School"
                  add_before: "Graduate"

    add_behavior_response_type_values:
        description: Adds additional picklist values to the Type field.
        class_path: cumulusci.tasks.metadata_etl.picklists.AddPicklistEntries
        group: "K-12: Metadata"
        options:
            picklists: hed__Behavior_Response__c.hed__Type__c
            entries:
                - fullName: "Other"
                  label: "Other"
                - fullName: "Expulsion"
                  label: "Expulsion"
                  add_before: "Other"
                - fullName: "Academic Probation"
                  label: "Academic Probation"
                  add_before: "Expulsion"
                - fullName: "Award"
                  label: "Award"
                  add_before: "Expulsion"
                - fullName: "Detention"
                  label: "Detention"
                  add_before: "Expulsion"
                - fullName: "Expulsion with Services"
                  label: "Expulsion with Services"
                  add_before: "Other"
                - fullName: "In-School Suspension"
                  label: "In-School Suspension"
                  add_before: "Other"
                - fullName: "Out-of-School Suspension"
                  label: "Out-of-School Suspension"
                  add_before: "Other"
                - fullName: "Removal from Classroom"
                  label: "Removal from Classroom"
                  add_before: "Other"
                - fullName: "Verbal Recognition"
                  label: "Verbal Recognition"
                  add_before: "Other"

    add_case_category_values:
        description: Adds additional picklist values to the Category field.
        class_path: cumulusci.tasks.metadata_etl.picklists.AddPicklistEntries
        group: "K-12: Metadata"
        options:
            picklists: Case.hed__Category__c
            entries:
                - fullName: "Other"
                  label: "Other"
                - fullName: "State Offense"
                  label: "State Offense"
                  add_before: "Other"
                - fullName: "School Violation"
                  label: "School Violation"
                  add_before: "State Offense"
                - fullName: "School Code of Conduct"
                  label: "School Code of Conduct"
                  add_before: "School Violation"
                - fullName: "Cooperation"
                  label: "Cooperation"
                  add_before: "School Code of Conduct"
                - fullName: "Integrity"
                  label: "Integrity"
                  add_before: "School Code of Conduct"
                - fullName: "Leadership"
                  label: "Leadership"
                  add_before: "School Code of Conduct"
                - fullName: "Respect"
                  label: "Respect"
                  add_before: "School Code of Conduct"
                - fullName: "Teamwork"
                  label: "Teamwork"
                  add_before: "Other"
                - fullName: "Verbal Recognition"
                  label: "Verbal Recognition"
                  add_before: "Other"

    add_case_location_values:
        description: Adds additional picklist values to the Location field.
        class_path: cumulusci.tasks.metadata_etl.picklists.AddPicklistEntries
        group: "K-12: Metadata"
        options:
            picklists: Case.hed__Location__c
            entries:
                - fullName: "Other"
                  label: "Other"
                - fullName: "On Campus"
                  label: "On Campus"
                  add_before: "Other"
                - fullName: "Off Campus"
                  label: "Off Campus"
                  add_before: "On Campus"
                - fullName: "Administrative Offices Area"
                  label: "Administrative Offices Area"
                  add_before: "Off Campus"
                - fullName: "Athletic Field or Playground"
                  label: "Athletic Field or Playground"
                  add_before: "Off Campus"
                - fullName: "Auditorium"
                  label: "Auditorium"
                  add_before: "Off Campus"
                - fullName: "Bus Stop"
                  label: "Bus Stop"
                  add_before: "Off Campus"
                - fullName: "Cafeteria Area"
                  label: "Cafeteria Area"
                  add_before: "Off Campus"
                - fullName: "Classroom"
                  label: "Classroom"
                  add_before: "Off Campus"
                - fullName: "Computer Lab"
                  label: "Computer Lab"
                  add_before: "Off Campus"
                - fullName: "Hallway or Stairs"
                  label: "Hallway or Stairs"
                  add_before: "Off Campus"
                - fullName: "Library/Media Center"
                  label: "Library/Media Center"
                  add_before: "Off Campus"
                - fullName: "Locker Room or Gym Areas"
                  label: "Locker Room or Gym Areas"
                  add_before: "Off Campus"
                - fullName: "Online"
                  label: "Online"
                  add_before: "On Campus"
                - fullName: "Parking Lot"
                  label: "Parking Lot"
                  add_before: "Other"
                - fullName: "Restroom"
                  label: "Restroom"
                  add_before: "Other"
                - fullName: "School Bus"
                  label: "School Bus"
                  add_before: "Other"
                - fullName: "Stadium"
                  label: "Stadium"
                  add_before: "Other"
                - fullName: "Unknown"
                  label: "Unknown"
                  add_before: "Other"
                - fullName: "Walking to or from School"
                  label: "Walking to or from School"
                  add_before: "Other"
    add_behavior_involvement_values:
        description: Adds additional picklist values to the Role field.
        class_path: cumulusci.tasks.metadata_etl.picklists.AddPicklistEntries
        group: "K-12: Metadata"
        options:
            picklists: hed__Behavior_Involvement__c.hed__Role__c
            entries:
                - fullName: "Other"
                  label: "Other"
                - fullName: "Witness"
                  label: "Witness"
                  add_before: "Other"
                - fullName: "Victim"
                  label: "Victim"
                  add_before: "Witness"
                - fullName: "Reporter"
                  label: "Reporter"
                  add_before: "Victim"
                - fullName: "Perpetrator"
                  label: "Perpetrator"
                  add_before: "Reporter"
                - fullName: "Participant"
                  label: "Participant"
                  add_before: "Perpetrator"

    add_relationship_picklist_values:
        description: Adds additional picklist values to the Type field on the Relationship object.
        class_path: cumulusci.tasks.metadata_etl.picklists.AddPicklistEntries
        group: "K-12: Metadata"
        options:
            picklists: hed__Relationship__c.hed__Type__c
            entries:
                - fullName: "Guardian"
                  label: "Guardian"
                - fullName: "Dependent"
                  label: "Dependent"
                - fullName: "Stepfather"
                  label: "Stepfather"
                - fullName: "Stepmother"
                  label: "Stepmother"
                - fullName: "Stepparent"
                  label: "Stepparent"
                - fullName: "Stepdaughter"
                  label: "Stepdaughter"
                - fullName: "Stepson"
                  label: "Stepson"
                - fullName: "Stepchild"
                  label: "Stepchild"
                - fullName: "Foster Parent"
                  label: "Foster Parent"
                - fullName: "Foster Daughter"
                  label: "Foster Daughter"
                - fullName: "Foster Son"
                  label: "Foster Son"
                - fullName: "Foster Child"
                  label: "Foster Child"
                - fullName: "Parent's Sibling"
                  label: "Parent's Sibling"
                  add_before: "Cousin"
                - fullName: "Niece"
                  label: "Niece"
                  add_before: "Cousin"
                - fullName: "Nephew"
                  label: "Nephew"
                  add_before: "Cousin"
                - fullName: "Sibling's Child"
                  label: "Sibiling's Child"
                  add_before: "Cousin"

    add_contact_gender_picklist_values:
        description: Adds additional picklist and record values to the gender field on the Contact object.
        class_path: cumulusci.tasks.metadata_etl.picklists.AddPicklistEntries
        group: "K-12: Metadata"
        options:
            picklists: Contact.hed__Gender__c
            entries:
                - fullName: "Decline to State"
                  label: "Decline to State"
            record_types:
                - "Faculty"
                - "Guardian"
                - "Student"

    correct_affiliation_mappings:
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        options:
            apex: >
                delete [SELECT Id From hed__Affl_Mappings__c];
                hed.STG_InstallScript.insertMappings();

    correct_reciprocal_relationships:
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        options:
            apex: >
                delete [SELECT Id From hed__Relationship_Lookup__c]; 
                hed.STG_InstallScript.insertRelationshipLookups();

    deploy_k12_kit_settings:
        description: Configure the default K-12 Architecture Kit Settings
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        group: "K-12: Custom Settings"
        options:
            path: scripts/configure_k12_kit.cls
            apex: initializeK12KitSettings();

    deploy_k12_app:
        description: Deploys the K12 Kit App for those who use the installer rather than the trial
        class_path: cumulusci.tasks.salesforce.Deploy
        group: "K-12: Installer Tasks"
        ui_options:
            name: Deploy K12 Architecture Kit app tile
        options:
            path: unpackaged/config/installer

    deploy_unpackaged_objects:
        description: Deploys the K12 Kit Unpackaged Objects
        class_path: cumulusci.tasks.salesforce.Deploy
        group: "K-12: Installer Tasks"
        ui_options:
            name: Deploy K12 Architecture Kit Unpackaged Objects
        options:
            path: unpackaged/config/objects

    deploy_trial_config:
        description: Deploys metadata and configuration for TSOs.
        class_path: cumulusci.tasks.salesforce.Deploy
        group: "K-12: Trial"
        ui_options:
            name: Deploy Trial Metadata
        options:
            namespace_inject: $project_config.project__package__namespace
            path: unpackaged/config/trial

    enable_course_connections:
        description: Enables course connections and sets default record types
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        group: "K-12: Custom Settings"
        options:
            path: scripts/configure_k12_kit.cls
            apex: enableCourseConnections();

    execute_k12_install_apex:
        description: Runs most of the install script methods from the STG_InstallScript class
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        group: "K-12: Custom Settings"
        options:
            path: scripts/configure_k12_kit.cls
            apex: executeK12InstallApex();

    execute_eda_install_apex:
        description: Runs most of the install script methods from the EDA STG_InstallScript class
        class_path: cumulusci.tasks.apex.anon.AnonymousApexTask
        group: "K-12: Custom Settings"
        options:
            path: scripts/configure_k12_kit.cls
            apex: executeEDAInstallApex();

    github_release_notes:
        options:
            trial_info: "`TBD`"

    retrieve_postinstall_config:
        description: Retrieves the current changes in a scratch org into unpackaged/post/config
        class_path: cumulusci.tasks.salesforce.sourcetracking.RetrieveChanges
        group: Salesforce Metadata
        options:
            path: unpackaged/post/config
            namespace_tokenize: $project_config.project__package__namespace

    retrieve_trial_config:
        description: Retrieves the current changes in a scratch org into unpackaged/post/trial
        class_path: cumulusci.tasks.salesforce.sourcetracking.RetrieveChanges
        group: Salesforce Metadata
        options:
            path: unpackaged/config/trial
            namespace_tokenize: $project_config.project__package__namespace

    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:
                    - LogACall
                    - NewCase
                    - NewContact
                    - NewEvent
                    - NewLead
                    - NewNote
                    - NewTask
                    - SendEmail

    update_admin_profile:
        description: Retrieves, edits, and redeploys the Admin.profile with full FLS perms for all objects/fields
        class_path: tasks.salesforce.UpdateAdminProfile

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

    robot_testdoc:
        # description: Generates html documentation of your Robot test suite and writes to tests/test_suite.
        options:
            path: robot/K12/tests/browsers/
            output: robot/K12/doc/K12_tests.html

    robot_libdoc:
        # description: Generates documentation for project keyword files.
        options:
            output: robot/K12/doc/Keywords.html
            path:
                - robot/K12/resources/*PageObject.py
                - robot/K12/resources/K12.py
                - robot/K12/resources/K12.robot

flows:
    add_k12_picklist_values:
        steps:
            1:
                task: add_application_type_picklist_values
                ui_options:
                    name: K-12 Architecture Kit - Add Application Type Picklist Values
            2:
                task: add_behavior_response_type_values
                ui_options:
                    name: K-12 Architecture Kit - Add Behavior Response Type Picklist Values
            3:
                task: add_case_category_values
                ui_options:
                    name: K-12 Architecture Kit - Add Case Category Type Picklist Values
            4:
                task: add_case_location_values
                ui_options:
                    name: K-12 Architecture Kit - Add Case Location Type Picklist Values
            5:
                task: add_behavior_involvement_values
                ui_options:
                    name: K-12 Architecture Kit - Add Behavior Involvement Role Picklist Values
            6:
                task: add_relationship_picklist_values
                ui_options:
                    name: K-12 Architecture Kit - Add Relationship Type Picklist Values
            7:
                task: add_contact_gender_picklist_values
                ui_options:
                    name: K-12 Architecture Kit - Add Contact Gender Picklist and RecordType Values

    ci_feature_eda:
        steps:
            1:
                flow: dependencies
                options:
                    update_dependencies:
                        include_beta: True
            2:
                flow: deploy_unmanaged
            3:
                flow: config_apextest
            4:
                task: run_tests
                options:
                    managed: True
                    namespace: hed

    config_2gp:
        steps:
            1:
                task: update_admin_profile
            2:
                task: execute_eda_install_apex
            3:
                task: execute_k12_install_apex
            4:
                flow: config_unmanaged
            5:
                flow: config_regression

    config_managed:
        steps:
            3:
                task: deploy_k12_kit_settings

    config_regression:
        steps:
            1:
                flow: None
            2:
                task: deploy_post
                when: "'k12kit' in org_config.installed_packages"
            3:
                task: deploy_k12_kit_settings
                when: "'k12kit' in org_config.installed_packages"
            4:
                task: enable_course_connections
                when: "'k12kit' in org_config.installed_packages"
            5:
                task: deploy_trial_config
                when: "'k12kit' in org_config.installed_packages"
            6:
                task: deploy_k12_app
                when: "'k12kit' in org_config.installed_packages"
            7:
                task: update_admin_profile
                when: "'k12kit' in org_config.installed_packages"

    dependencies:
        steps:
            2:
                task: None
            3:
                flow: add_k12_picklist_values
            4:
                task: deploy_pre

    config_unmanaged:
        steps:
            1:
                task: execute_k12_install_apex
                when: "'k12kit' not in org_config.installed_packages"
            2:
                task: enable_course_connections
                when: "'k12kit' not in org_config.installed_packages"
            3:
                task: deploy_trial_config
                when: "'k12kit' not in org_config.installed_packages"
            4:
                task: deploy_k12_kit_settings
                when: "'k12kit' not in org_config.installed_packages"

    config_dev:
        steps:
            3:
                flow: config_unmanaged

    config_qa:
        steps:
            3:
                flow: config_unmanaged
            4:
                flow: config_regression

    dev_org_namespaced:
        description: Set up a namespaced scratch org as a development environment for unmanaged metadata
        steps:
            1:
                flow: dependencies
            2:
                flow: deploy_unmanaged
            3:
                flow: config_dev
            8:
                task: snapshot_changes

    net_new_org:
        description: Simulates an K12 installation for a new customer. Installs the latest beta and dependencies.
        steps:
            1:
                flow: dependencies
                options:
                    update_dependencies:
                        include_beta: True
            2:
                task: install_managed_beta
            3:
                flow: config_managed
            4:
                task: enable_course_connections
            5:
                task: deploy_trial_config

    qa_org_2gp:
        steps:
            2:
                flow: config_2gp

    trial_org:
        description: Deploy trial configuration to an org.
        group: "K-12: Trial"
        steps:
            1:
                flow: dependencies
            2:
                task: install_managed
            3:
                flow: config_managed
            4:
                flow: eda:eda_settings
                options:
                    execute_enable_course_connections:
                        apex: >
                            Schema.DescribeSObjectResult courseEnrollmentSchema = Schema.SObjectType.hed__Course_Enrollment__c;
                            Map<String,Schema.RecordTypeInfo> rtInfosByDeveloperName = courseEnrollmentSchema.getRecordTypeInfosByDeveloperName();
                            hed__Hierarchy_Settings__c settings = hed__Hierarchy_Settings__c.getOrgDefaults();
                            settings.put('hed__Enable_Course_Connections__c', true);
                            settings.put('hed__Student_RecType__c', rtInfosByDeveloperName.get('Student').getRecordTypeId());
                            settings.put('hed__Faculty_RecType__c', rtInfosByDeveloperName.get('Faculty').getRecordTypeId());
                            upsert settings;
            5:
                task: eda:add_citizenship_status_values
            6:
                task: deploy_trial_config
            7:
                task: correct_reciprocal_relationships
            8:
                task: correct_affiliation_mappings

    upgraded_org:
        description: Simulate an existing org. Used to test the state of a customer's org after a push upgrade.
        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
            6:
                task: snapshot_changes

    customer_org:
        steps:
            1:
                task: update_dependencies
                ui_options:
                    1:
                        name: EDA - Account Record Types
                    2:
                        name: EDA - Contact Key Affiliation Fields
                    4:
                        name: EDA - Deploy Case Behavior Record Types
                    5:
                        name: EDA - Deploy Course Connection Record Types
                    6:
                        name: EDA - Education Data Architecture App
                    7:
                        name: EDA - Facility Display Name Formula Field

            2:
                flow: add_k12_picklist_values
            3:
                task: deploy_pre
                options:
                    unmanaged: False
                ui_options:
                    recordtypes:
                        name: K-12 Architecture Kit - Account and Contact Record Types
            4:
                task: install_managed
            5:
                task: deploy_post
                options:
                    unmanaged: False
                ui_options:
                    config:
                        name: K-12 Architecture Kit Metadata and Configuration
            6:
                task: deploy_unpackaged_objects
                ui_options:
                    name: Deploy K-12 Architecture Kit Unpackaged Objects
                    is_required: False
                    is_recommended: False
            7:
                task: deploy_k12_app
                ui_options:
                    name: Deploy K-12 Architecture Kit App Tile

plans:
    install:
        slug: install
        title: Install K-12 Architecture Kit
        tier: primary
        checks:
            - when: "not tasks.check_my_domain_active()"
              action: error
              message: "Please enable My Domain in your org prior to installing."
            - when: "not tasks.check_chatter_enabled()"
              action: error
              message: "Please enable Chatter in your org prior to installing."
        steps:
            1:
                flow: customer_org
    upgrade:
        slug: upgrade
        title: Product Upgrade
        tier: additional
        is_listed: False
        preflight_message: "This installer upgrades this package and any required dependencies to the latest version in your org. This installer isn't supported and has risks. Please don't run this installer unless you're aware of its specific use cases and considerations."
        post_install_message: "Installation complete and package is on the latest version."
        steps:
            1:
                task: update_dependencies
                options:
                    security_type: PUSH
                    packages_only: True
            2:
                task: install_managed
                options:
                    security_type: PUSH

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
        regression:
            config_file: orgs/regression.json
        trial:
            config_file: orgs/trial.json