Anjing Webshells

Website : rimsha.abasa.com
: / var / canvas / spec / lib / lti /
Filename : substitutions_helper_spec.rb
back
# frozen_string_literal: true

#
# Copyright (C) 2014 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
#

module Lti
  describe SubstitutionsHelper do
    subject { SubstitutionsHelper.new(course, root_account, user) }

    specs_require_sharding

    let(:course) do
      Course.new.tap do |c|
        c.root_account = root_account
        c.account = account
      end
    end
    let(:root_account) { Account.create! }
    let(:account) do
      Account.create!(root_account:)
    end
    let(:course_group) { Group.new(context: course) }
    let(:account_group) { Group.new(context: account) }
    let(:user) { User.create! }

    def set_up_persistance!
      @shard1.activate { user.save! }
      @shard2.activate do
        root_account.save!

        account.save!
        course.save!
        course_group.save!
        account_group.save!
      end
    end

    def helper_with_context(type, persistence: false)
      if persistence
        set_up_persistance!
      end

      ctxt =
        case type.to_s
        when "course"
          course
        when "account"
          account
        when "course_group", "course-based group"
          course_group
        when "account_group", "account-based group"
          account_group
        when ""
          nil
        else
          raise NotImplementedError
        end

      if persistence
        ctxt.save!
      end

      SubstitutionsHelper.new(ctxt, root_account, user)
    end

    describe "#account" do
      before do
        # When we remove :lti_variable_expansions_use_group_course_as_course, we can remove
        # this (only needed to check feature flag):
        set_up_persistance!
      end

      it "returns the context when context is an account" do
        expect(helper_with_context(:account).account).to eq(account)
      end

      it "returns the account when context is a course" do
        expect(helper_with_context(:course).account).to eq(account)
      end

      it "returns the account when context is a account-based group" do
        expect(helper_with_context(:account_group, persistence: true).account).to eq(account)
      end

      it "returns the account when context is a course-based group" do
        expect(helper_with_context(:course_group, persistence: true).account).to eq(account)
      end

      context "when the feature flag lti_variable_expansions_use_group_course_as_course is disabled" do
        before do
          # NOTE: Apparently due to caching inside Account model (?), just
          # need to disable on the same model object instance (root_account).
          # e.g. Account.find(root_account.id).disable_feature!(...) won't work :(
          root_account.disable_feature!(:lti_variable_expansions_use_group_course_as_course)
        end

        it "returns the root account when context is a course-based group" do
          expect(helper_with_context(:course_group, persistence: true).account).to eq(root_account)
        end

        it "returns the root account when context is a account-based group" do
          expect(helper_with_context(:account_group, persistence: true).account).to eq(root_account)
        end
      end

      it "returns the root_account by default" do
        expect(helper_with_context(nil).account).to eq(root_account)
      end
    end

    describe "#course_or_account" do
      before do
        # When we remove :lti_variable_expansions_use_group_course_as_course, we can remove
        # this (only needed to check feature flag):
        set_up_persistance!
      end

      it { expect(subject.course_or_account).to eq course }
      it { expect(helper_with_context(:account).course_or_account).to eq account }
      it { expect(helper_with_context(:account_group).course_or_account).to eq account }
      it { expect(helper_with_context(:course_group).course_or_account).to eq course }
      it { expect(helper_with_context(nil).course_or_account).to be_nil }
    end

    describe "#course" do
      before do
        # When we remove :lti_variable_expansions_use_group_course_as_course, we can remove
        # this (only needed to check feature flag):
        set_up_persistance!
      end

      it { expect(helper_with_context(:course).course).to eq course }
      it { expect(helper_with_context(:account).course).to be_nil }
      it { expect(helper_with_context(:account_group).course).to be_nil }
      it { expect(helper_with_context(:course_group).course).to eq course }

      describe "when the lti_variable_expansions_use_group_course_as_course feature flag is disabled" do
        before do
          root_account.disable_feature!(:lti_variable_expansions_use_group_course_as_course)
        end

        it { expect(helper_with_context(:course_group).course).to be_nil }
      end
    end

    describe "#enrollments_to_lis_roles" do
      it "converts students" do
        expect(subject.enrollments_to_lis_roles([StudentEnrollment.new]).first).to eq "Learner"
      end

      it "converts teachers" do
        expect(subject.enrollments_to_lis_roles([TeacherEnrollment.new]).first).to eq "Instructor"
      end

      it "converts teacher assistants" do
        expect(subject.enrollments_to_lis_roles([TaEnrollment.new]).first).to eq "urn:lti:role:ims/lis/TeachingAssistant"
      end

      it "converts designers" do
        expect(subject.enrollments_to_lis_roles([DesignerEnrollment.new]).first).to eq "ContentDeveloper"
      end

      it "converts observers" do
        expect(subject.enrollments_to_lis_roles([ObserverEnrollment.new]).first).to eq "urn:lti:instrole:ims/lis/Observer,urn:lti:role:ims/lis/Mentor"
      end

      it "converts admins" do
        expect(subject.enrollments_to_lis_roles([AccountUser.new]).first).to eq "urn:lti:instrole:ims/lis/Administrator"
      end

      it "converts fake students" do
        expect(subject.enrollments_to_lis_roles([StudentViewEnrollment.new]).first).to eq "Learner"
      end

      it "converts multiple roles" do
        lis_roles = subject.enrollments_to_lis_roles([StudentEnrollment.new, TeacherEnrollment.new])
        expect(lis_roles).to include "Learner"
        expect(lis_roles).to include "Instructor"
      end

      it "sends at most one of each role" do
        expect(subject.enrollments_to_lis_roles([StudentEnrollment.new, StudentViewEnrollment.new])).to eq ["Learner"]
      end
    end

    describe "#all_roles" do
      it "converts multiple roles" do
        allow(subject).to receive(:course_enrollments).and_return([StudentEnrollment.new, TeacherEnrollment.new, DesignerEnrollment.new, ObserverEnrollment.new, TaEnrollment.new, AccountUser.new])
        allow(user).to receive(:roles).and_return(%w[user student teacher admin])
        roles = subject.all_roles
        expect(roles).to include LtiOutbound::LTIRoles::System::USER
        expect(roles).to include LtiOutbound::LTIRoles::Institution::STUDENT
        expect(roles).to include LtiOutbound::LTIRoles::Institution::INSTRUCTOR
        expect(roles).to include LtiOutbound::LTIRoles::Institution::ADMIN
        expect(roles).to include LtiOutbound::LTIRoles::Context::LEARNER
        expect(roles).to include LtiOutbound::LTIRoles::Context::INSTRUCTOR
        expect(roles).to include LtiOutbound::LTIRoles::Context::CONTENT_DEVELOPER
        expect(roles).to include LtiOutbound::LTIRoles::Context::OBSERVER
        expect(roles).to include LtiOutbound::LTIRoles::Context::TEACHING_ASSISTANT
      end

      it "returns none if no user" do
        helper = SubstitutionsHelper.new(course, root_account, nil)
        expect(helper.all_roles).to eq LtiOutbound::LTIRoles::System::NONE
      end

      it "converts multiple roles for lis 2" do
        allow(subject).to receive(:course_enrollments).and_return([StudentEnrollment.new, TeacherEnrollment.new, DesignerEnrollment.new, ObserverEnrollment.new, TaEnrollment.new, AccountUser.new])
        allow(user).to receive(:roles).and_return(%w[user student teacher admin])
        roles = subject.all_roles("lis2")
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/system/person#User"
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Student"
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Instructor"
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Administrator"
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/membership#Learner"
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor"
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/membership#ContentDeveloper"
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/membership#Mentor"
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/membership/instructor#TeachingAssistant"
      end

      it "returns none if no user for lis 2" do
        helper = SubstitutionsHelper.new(course, root_account, nil)
        expect(helper.all_roles("lis2")).to eq "http://purl.imsglobal.org/vocab/lis/v2/person#None"
      end

      it "includes main and subrole for TeachingAssistant" do
        allow(subject).to receive(:course_enrollments).and_return([TaEnrollment.new])
        roles = subject.all_roles("lis2")
        expected_roles = ["http://purl.imsglobal.org/vocab/lis/v2/membership/instructor#TeachingAssistant",
                          "http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor",
                          "http://purl.imsglobal.org/vocab/lis/v2/system/person#User"]
        expect(roles.split(",")).to match_array expected_roles
      end

      it "converts multiple roles for lti 1.3" do
        allow(subject).to receive(:course_enrollments).and_return([StudentEnrollment.new, TeacherEnrollment.new, DesignerEnrollment.new, ObserverEnrollment.new, TaEnrollment.new, AccountUser.new])
        allow(user).to receive(:roles).and_return(%w[user student teacher admin])
        roles = subject.all_roles("lti1_3")
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/system/person#User"
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Student"
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Instructor"
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Administrator"
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/membership#Learner"
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor"
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/membership#ContentDeveloper"
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/membership#Mentor"
        expect(roles).to include "http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#TeachingAssistant" # only difference btwn lis2 and lti1_3 modes
      end

      it "returns none if no user for lti 1.3" do
        helper = SubstitutionsHelper.new(course, root_account, nil)
        expect(helper.all_roles("lti1_3")).to eq "http://purl.imsglobal.org/vocab/lis/v2/system/person#None"
      end

      it "includes main and subrole for TeachingAssistant for lti 1.3" do
        allow(subject).to receive(:course_enrollments).and_return([TaEnrollment.new])
        roles = subject.all_roles("lti1_3")
        expected_roles = ["http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#TeachingAssistant", # only difference btwn lis2 and lti1_3 modes
                          "http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor",
                          "http://purl.imsglobal.org/vocab/lis/v2/system/person#User"]
        expect(roles.split(",")).to match_array expected_roles
      end

      it "does not include admin role if user has a sub-account admin user record in deleted account" do
        sub_account = account.sub_accounts.create!
        sub_account.account_users.create!(user:, role: admin_role)
        sub_account.destroy!
        roles = subject.all_roles
        expect(roles).not_to include "urn:lti:instrole:ims/lis/Administrator"
      end

      it "properly dedupes roles if there is overlap" do
        expect(subject).to receive(:course_enrollments).and_return([StudentViewEnrollment.new])
        allow(user).to receive(:roles).and_return(%w[user student fake_student])
        roles = subject.all_roles("lti1_3")
        expect(roles.split(",")).to match_array [
          "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Student",
          "http://purl.imsglobal.org/vocab/lis/v2/membership#Learner",
          "http://purl.imsglobal.org/vocab/lis/v2/system/person#User",
          "http://purl.imsglobal.org/vocab/lti/system/person#TestUser"
        ]
      end
    end

    describe "#course_enrollments" do
      it "returns an empty array if the context is not a course" do
        helper = SubstitutionsHelper.new(account, root_account, user)
        expect(helper.course_enrollments).to eq []
      end

      it "returns an empty array if the user is nil" do
        helper = SubstitutionsHelper.new(course, root_account, nil)
        expect(helper.course_enrollments).to eq []
      end

      ["course", "course-based group"].each do |type|
        describe "when the context is a #{type}" do
          subject { helper_with_context(type, persistence: true) }
          before do
            # AR gets confused if you don't save models before creating
            # certain other related models
            subject
          end

          it "returns the active enrollments in a course for a user" do
            student_enrollment = student_in_course(user:, course:, active_enrollment: true)
            teacher_enrollment = teacher_in_course(user:, course:, active_enrollment: true)
            inactive_enrollment = course_with_observer(user:, course:)
            inactive_enrollment.update_attribute(:workflow_state, "inactive")

            expect(subject.course_enrollments).to include student_enrollment
            expect(subject.course_enrollments).to include teacher_enrollment
            expect(subject.course_enrollments).not_to include inactive_enrollment
          end

          it "returns an empty array if there is no user" do
            helper = SubstitutionsHelper.new(account, root_account, nil)
            expect(helper.course_enrollments).to eq []
          end
        end
      end
    end

    describe "#account_enrollments" do
      subject { helper_with_context(:account) }

      it "returns enrollments in an account for a user" do
        set_up_persistance!
        enrollment = account.account_users.create!(user:)

        expect(subject.account_enrollments).to eq [enrollment]
      end

      it "does not return deleted account enrollments" do
        set_up_persistance!
        enrollment = account.account_users.create!(user:)
        enrollment.destroy

        expect(subject.account_enrollments).to eq []
      end

      it "returns enrollments in an account chain for a user" do
        set_up_persistance!
        enrollment = root_account.account_users.create!(user:)

        expect(subject.account_enrollments).to eq [enrollment]
      end

      it "returns an empty array if there is no user" do
        helper = SubstitutionsHelper.new(account, root_account, nil)
        expect(helper.account_enrollments).to eq []
      end

      context "with cross-shard account in chain" do
        let(:xshard_account) { @shard1.activate { account_model } }
        let(:xshard_enrollment) { xshard_account.account_users.create!(user:) }

        before do
          allow(account).to receive(:account_chain).and_return [account, root_account, xshard_account]
          xshard_enrollment
        end

        it "queries correct shard for enrollments" do
          expect(subject.account_enrollments).to eq [xshard_enrollment]
        end

        context "with federated parent account chain argument" do
          before do
            allow(account).to receive(:account_chain).with(include_federated_parent: true).and_return [account, root_account, xshard_account]
            allow(account).to receive(:account_chain).with(include_federated_parent: false).and_return [account, root_account]
          end

          context "with non-primary_settings_root_account" do
            before do
              allow(root_account).to receive(:primary_settings_root_account?).and_return false
            end

            it "includes federated parent account in enrollment query" do
              expect(subject.account_enrollments).to eq [xshard_enrollment]
            end
          end

          context "with primary_settings_root_account" do
            before do
              allow(root_account).to receive(:primary_settings_root_account?).and_return true
            end

            it "does not include federated parent account in enrollment query" do
              expect(subject.account_enrollments).to eq []
            end
          end
        end
      end
    end

    describe "#current_lis_roles" do
      it "returns none if the user has no roles" do
        expect(subject.current_lis_roles).to eq "urn:lti:sysrole:ims/lis/None"
      end

      it "returns the user's roles" do
        set_up_persistance!
        student_in_course(user:, course:, active_enrollment: true)
        account.account_users.create!(user:)
        lis_roles = subject.current_lis_roles

        expect(lis_roles).to include "Learner"
        expect(lis_roles).to include "urn:lti:instrole:ims/lis/Administrator"
      end

      it "returns the correct role for a site admin user" do
        Account.site_admin.account_users.create!(user:)
        lis_roles = subject.current_lis_roles
        expect(lis_roles).to eq "urn:lti:sysrole:ims/lis/SysAdmin"
      end
    end

    describe "#concluded_course_enrollments" do
      it "returns an empty array if the context is not a course/group-based course" do
        helper = SubstitutionsHelper.new(account, root_account, user)
        expect(helper.concluded_course_enrollments).to eq []
      end

      it "returns an empty array if the user is not set" do
        helper = SubstitutionsHelper.new(course, root_account, nil)
        expect(helper.concluded_course_enrollments).to eq []
      end

      ["course", "course-based group"].each do |type|
        describe "when the context is a #{type}" do
          subject { helper_with_context(type) }

          it "returns the active enrollments in a course for a user" do
            set_up_persistance!

            student_enrollment = student_in_course(user:, course:, active_enrollment: true)
            student_enrollment.conclude
            teacher_enrollment = teacher_in_course(user:, course:, active_enrollment: true)
            observer_enrollment = course_with_observer(user:, course:)
            observer_enrollment.conclude
            expect(subject.concluded_course_enrollments).to include student_enrollment
            expect(subject.concluded_course_enrollments).not_to include teacher_enrollment
            expect(subject.concluded_course_enrollments).to include observer_enrollment
          end
        end
      end
    end

    describe "#concluded_lis_roles" do
      it "returns none if the user has no roles" do
        expect(subject.concluded_lis_roles).to eq "urn:lti:sysrole:ims/lis/None"
      end

      it "returns the user's roles" do
        set_up_persistance!
        student_in_course(user:, course:, active_enrollment: true).conclude
        expect(subject.concluded_lis_roles).to eq "Learner"
      end
    end

    describe "#current_canvas_roles_lis_v2" do
      it "returns the LIS V2 role names" do
        set_up_persistance!

        teacher_in_course(user:, course:, active_enrollment: true)
        course_with_designer(user:, course:, active_enrollment: true)
        account_admin_user(user:, account:)
        roles = subject.current_canvas_roles_lis_v2

        expect(roles.split(",")).to match_array [
          "http://purl.imsglobal.org/vocab/lis/v2/membership#ContentDeveloper",
          "http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor",
          "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Administrator"
        ]
      end

      it "does not include concluded roles" do
        set_up_persistance!
        student_in_course(user:, course:, active_enrollment: true).conclude
        teacher_in_course(user:, course:, active_enrollment: true)
        roles = subject.current_canvas_roles_lis_v2

        expect(roles).to eq "http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor"
      end

      it "does not include roles from other contexts" do
        set_up_persistance!
        course_two = course_model
        student_in_course(user:, course:, active_enrollment: true)
        teacher_in_course(user:, course: course_two, active_enrollment: true)
        roles = subject.current_canvas_roles_lis_v2

        expect(roles).to eq "http://purl.imsglobal.org/vocab/lis/v2/membership#Learner"
      end

      it "can be directed to use the LIS 2 role map" do
        set_up_persistance!

        ta_in_course(user:, course:, active_enrollment: true)
        course_with_designer(user:, course:, active_enrollment: true)
        account_admin_user(user:, account:)
        roles = subject.current_canvas_roles_lis_v2("lis2")

        expect(roles.split(",")).to match_array [
          "http://purl.imsglobal.org/vocab/lis/v2/membership#ContentDeveloper",
          "http://purl.imsglobal.org/vocab/lis/v2/membership/instructor#TeachingAssistant", # only difference btwn lis2 and lti1_3 modes
          "http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor",
          "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Administrator"
        ]
      end

      it "can be directed to use the LTI 1.3 role map" do
        set_up_persistance!

        ta_in_course(user:, course:, active_enrollment: true)
        course_with_designer(user:, course:, active_enrollment: true)
        account_admin_user(user:, account:)
        roles = subject.current_canvas_roles_lis_v2("lti1_3")

        expect(roles.split(",")).to match_array [
          "http://purl.imsglobal.org/vocab/lis/v2/membership#ContentDeveloper",
          "http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#TeachingAssistant", # only difference btwn lis2 and lti1_3 modes
          "http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor",
          "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Administrator"
        ]
      end
    end

    describe "#current_canvas_roles" do
      it "returns readable names for canvas roles" do
        set_up_persistance!

        student_in_course(user:, course:, active_enrollment: true).conclude
        teacher_in_course(user:, course:, active_enrollment: true)
        course_with_designer(user:, course:, active_enrollment: true)
        account_admin_user(user:, account:)

        roles = subject.current_canvas_roles

        expect(roles).to include "TeacherEnrollment"
        expect(roles).to include "DesignerEnrollment"
        expect(roles).to include "Account Admin"
      end
    end

    describe "#enrollment_state" do
      ["course", "course-based group"].each do |type|
        context "when the context is a #{type}" do
          subject { helper_with_context(type) }

          it "is active if there are any active enrollments" do
            set_up_persistance!

            enrollment = student_in_course(user:, course:, active_enrollment: true)
            enrollment.start_at = 4.days.ago
            enrollment.end_at = 2.days.ago
            enrollment.save!

            teacher_in_course(user:, course:, active_enrollment: true)

            expect(subject.enrollment_state).to eq "active"
          end

          it "is inactive if there are no active enrollments" do
            set_up_persistance!

            enrollment = student_in_course(user:, course:, active_enrollment: true)
            enrollment.start_at = 4.days.ago
            enrollment.end_at = 2.days.ago
            enrollment.save!

            expect(subject.enrollment_state).to eq "inactive"
          end

          it "is inactive if the course is concluded" do
            set_up_persistance!

            student_in_course(user:, course:, active_enrollment: true)
            course.complete

            expect(subject.enrollment_state).to eq "inactive"
          end

          it "is blank if there are no enrollments" do
            expect(subject.enrollment_state).to eq ""
          end
        end
      end
    end

    describe "#previous_course_ids_and_context_ids" do
      ["course", "course-based group"].each do |type|
        context "when the context is a #{type}" do
          subject { helper_with_context(type) }

          before do
            course.save!
            @c1 = Course.create!
            @c1.root_account = root_account
            @c1.account = account
            @c1.lti_context_id = "abc"
            @c1.save

            course.content_migrations.create!.tap do |cm|
              cm.context = course
              cm.workflow_state = "imported"
              cm.source_course = @c1
              cm.save!
            end

            @c2 = Course.create!
            @c2.root_account = root_account
            @c2.account = account
            @c2.lti_context_id = "def"
            @c2.save!

            course.content_migrations.create!.tap do |cm|
              cm.context = course
              cm.workflow_state = "imported"
              cm.source_course = @c2
              cm.save!
            end

            @c3 = Course.create!
            @c3.root_account = root_account
            @c3.account = account
            @c3.lti_context_id = "hij"
            @c3.save!

            @c1.content_migrations.create!.tap do |cm|
              cm.context = @c1
              cm.workflow_state = "imported"
              cm.source_course = @c3
              cm.save!
            end
          end

          it "returns previous canvas course ids" do
            expect(subject.previous_course_ids).to eq [@c1.id, @c2.id].sort.join(",")
          end

          it "returns previous lti context_ids" do
            expect(subject.previous_lti_context_ids.split(",")).to match_array %w[abc def]
          end
        end
      end
    end

    describe "#recursively_fetch_previous_lti_context_ids" do
      ["course", "course-based group"].each do |type|
        context "when the context is a #{type}" do
          subject { helper_with_context(type) }

          context "without any course copies" do
            before do
              course.save!
            end

            it "returns empty (no previous lti context_ids)" do
              expect(subject.recursively_fetch_previous_lti_context_ids).to be_empty
            end
          end

          context "with course copies" do
            before do
              course.save!
              @c1 = Course.create!
              @c1.root_account = root_account
              @c1.account = account
              @c1.lti_context_id = "abc"
              @c1.save

              course.content_migrations.create!(
                workflow_state: "imported",
                source_course: @c1
              )

              @c2 = Course.create!
              @c2.root_account = root_account
              @c2.account = account
              @c2.lti_context_id = "def"
              @c2.save!

              course.content_migrations.create!(
                workflow_state: "imported",
                source_course: @c2
              )

              @c3 = Course.create!
              @c3.root_account = root_account
              @c3.account = account
              @c3.lti_context_id = "ghi"
              @c3.save!

              @c1.content_migrations.create!(
                workflow_state: "imported",
                source_course: @c3
              )
            end

            it "returns previous lti context_ids" do
              expect(subject.recursively_fetch_previous_lti_context_ids).to eq "ghi,def,abc"
            end

            it "invalidates cache on last copied migration" do
              enable_cache do
                expect(subject.recursively_fetch_previous_lti_context_ids).to eq "ghi,def,abc"
                @c4 = Course.create!(root_account:, account:, lti_context_id: "jkl")
                @c1.content_migrations.create!(workflow_state: "imported", source_course: @c4)
                expect(subject.recursively_fetch_previous_lti_context_ids).to eq "ghi,def,abc" # not copied into subject course yet

                @c5 = Course.create!(root_account:, account:, lti_context_id: "mno")
                course.content_migrations.create!(workflow_state: "imported", source_course: @c5) # direct copy
                expect(subject.recursively_fetch_previous_lti_context_ids).to eq "mno,jkl,ghi,def,abc"
              end
            end

            context "when there are multiple content migrations pointing to the same source course" do
              before do
                @c3.content_migrations.create!(
                  workflow_state: "imported",
                  source_course: @c2
                )
              end

              it "does not return duplicates but still return in chronological order" do
                expect(subject.recursively_fetch_previous_lti_context_ids).to eq "def,ghi,abc"
              end
            end

            context "when there are more than (limit=1000) content migration courses in the history" do
              it "truncates after the limit of ids" do
                4.upto(11) do
                  c = Course.create!
                  c.root_account = root_account
                  c.account = account
                  c.lti_context_id = SecureRandom.hex 3
                  c.save

                  course.content_migrations.create!(
                    workflow_state: "imported",
                    source_course: c
                  )
                end

                recursive_course_lti_ids = subject.recursively_fetch_previous_lti_context_ids(limit: 10)
                expect(recursive_course_lti_ids.split(",").length).to eq(11)
                expect(recursive_course_lti_ids).to include "truncated"
              end

              it "courses with nil lti_context_ids shouldn't block 'truncated' from showing properly" do
                [nil, "lti_context_id5"].each do |item|
                  c = Course.create!
                  c.root_account = root_account
                  c.account = account
                  c.lti_context_id = item
                  c.save

                  course.content_migrations.create!(
                    workflow_state: "imported",
                    source_course: c
                  )
                end

                recursive_course_lti_ids = subject.recursively_fetch_previous_lti_context_ids(limit: 3)
                expect(recursive_course_lti_ids).to eq "lti_context_id5,ghi,def,truncated"
              end
            end
          end

          describe "section substitutions" do
            before do
              course.save!
              @sec1 = course.course_sections.create(name: "sec1")
              @sec1.sis_source_id = "def"
              @sec1.save!
              @sec2 = course.course_sections.create!(name: "sec2")
              @sec2.sis_source_id = "abc"
              @sec2.save!
              # course.reload

              user.save!
              @e1 = multiple_student_enrollment(user, @sec1, course:)
              @e2 = multiple_student_enrollment(user, @sec2, course:)
            end

            it "returns all canvas section ids" do
              expect(subject.section_ids).to eq [@sec1.id, @sec2.id].sort.join(",")
            end

            it "returns section restricted if all enrollments are restricted" do
              [@e1, @e2].each { |e| e.update_attribute(:limit_privileges_to_course_section, true) }
              expect(subject.section_restricted).to be true
            end

            it "does not return section restricted if only one is" do
              @e1.update_attribute(:limit_privileges_to_course_section, true)
              expect(subject.section_restricted).to be false
            end

            it "returns all canvas section sis ids" do
              expect(subject.section_sis_ids).to eq [@sec1.sis_source_id, @sec2.sis_source_id].sort.join(",")
            end
          end
        end
      end
    end

    describe "#adminable_account_ids_recursive_truncated" do
      it "returns the correct string for a single subaccount" do
        AccountUser.create!(user:, account:)
        expect(subject.adminable_account_ids_recursive_truncated).to eq(account.id.to_s)
      end

      it "returns the correct string for a single subaccount sith its subaccounts" do
        sub1 = Account.create!(parent_account: account)
        sub2 = Account.create!(parent_account: account)
        sub1sub = Account.create!(parent_account: sub1)
        AccountUser.create!(user:, account:)
        ids = subject.adminable_account_ids_recursive_truncated.split(",")
        expected = [account.id.to_s, sub1.id.to_s, sub2.id.to_s, sub1sub.id.to_s]
        expect(ids).to contain_exactly(*expected)
      end

      it "returns empty for root account (need to check isRootAccountAdmin)" do
        AccountUser.create! user:, account: root_account
        expect(subject.adminable_account_ids_recursive_truncated).to eq("")
      end

      it "correctly trims strings of various lengths to always end in ',truncated' and always return <= limit_chars characters" do
        allow(user).to receive(:adminable_account_ids_recursive)
          .with(starting_root_account: root_account)
          .and_return([1, 2, 3, 4, 5, 11, 12, 13, 14, 15, 101, 102, 103, 104, 105])
        # full_list: "1,2,3,4,5,11,12,13,14,15,101,102,103,104,105"
        # indexes:    01234567890123456789012345678901234567890123
        expectations = {
          14 => "1,2,truncated",
          15 => "1,2,3,truncated",
          16 => "1,2,3,truncated",
          17 => "1,2,3,4,truncated",
          24 => "1,2,3,4,5,11,truncated",
          25 => "1,2,3,4,5,11,12,truncated",
          26 => "1,2,3,4,5,11,12,truncated",
          27 => "1,2,3,4,5,11,12,truncated",
          28 => "1,2,3,4,5,11,12,13,truncated",
          38 => "1,2,3,4,5,11,12,13,14,15,101,truncated",
          39 => "1,2,3,4,5,11,12,13,14,15,101,truncated",
          41 => "1,2,3,4,5,11,12,13,14,15,101,truncated",
          42 => "1,2,3,4,5,11,12,13,14,15,101,102,truncated",
          43 => "1,2,3,4,5,11,12,13,14,15,101,102,truncated",
          44 => "1,2,3,4,5,11,12,13,14,15,101,102,103,104,105"
        }
        expectations.each do |limit_chars, expectation|
          expect(subject.adminable_account_ids_recursive_truncated(limit_chars:)).to eq expectation
        end
      end

      it "defaults to max 40000 characters" do
        allow(user).to receive(:adminable_account_ids_recursive)
          .with(starting_root_account: root_account)
          .and_return([123_456_789] * 4001)
        expect(subject.adminable_account_ids_recursive_truncated).to eq ("123456789," * 3999) + "truncated"
      end
    end

    context "email" do
      let(:course) { Course.create!(root_account:, account:, workflow_state: "available") }

      let(:tool) do
        ContextExternalTool.create!(
          name: "test tool",
          context: course,
          consumer_key: "key",
          shared_secret: "secret",
          url: "http://exmaple.com/launch"
        )
      end

      let(:substitution_helper) { SubstitutionsHelper.new(course, root_account, user, tool) }

      let(:user) do
        user = User.create!
        user.email = "test@foo.com"
        user.save!
        user
      end

      describe "#email" do
        let(:sis_pseudonym) do
          cc = user.communication_channels.email.create!(path: sis_email)
          cc.user = user
          cc.save!
          pseudonym = cc.user.pseudonyms.build(unique_id: cc.path, account: root_account)
          pseudonym.sis_communication_channel_id = cc.id
          pseudonym.communication_channel_id = cc.id
          pseudonym.sis_user_id = "some_sis_id"
          pseudonym.save
          pseudonym
        end
        let(:sis_email) { "sis@example.com" }

        shared_examples_for "not preferring sis email" do
          it "returns the users email" do
            expect(substitution_helper.email).to eq user.email
          end
        end

        shared_examples_for "preferring sis email" do
          it "returns the sis_email" do
            sis_pseudonym
            expect(substitution_helper.email).to eq sis_email
          end

          it "returns the users email if there isn't a sis email" do
            expect(substitution_helper.email).to eq user.email
          end
        end

        it_behaves_like "not preferring sis email"

        context "if it's an LTI2 tool" do
          let(:substitution_helper) do
            tool = class_double("Lti::ToolProxy")
            SubstitutionsHelper.new(course, root_account, user, tool)
          end

          it_behaves_like "preferring sis email"
        end

        it "returns the email for the courses enrollment if there is one." do
          tool = class_double("Lti::ToolProxy")
          p = sis_pseudonym
          # moving account so that if the pseudonym was not tied to enrollment
          # it would return 'test@foo.com' instead of sis_email
          p.account = Account.create!
          p.save!
          course.enroll_user(user, "StudentEnrollment", { sis_pseudonym_id: p.id, enrollment_state: "active" })
          sub_helper = SubstitutionsHelper.new(course, root_account, user, tool)
          expect(sub_helper.email).to eq sis_email
        end

        it "only returns active logins" do
          tool = class_double("Lti::ToolProxy")
          p = sis_pseudonym
          # moving account so that if the pseudonym was not tied to enrollment
          # it would return 'test@foo.com' instead of sis_email if it was active
          p.account = Account.create!
          p.workflow_state = "deleted"
          p.save!
          course.enroll_user(user, "StudentEnrollment", { sis_pseudonym_id: p.id, enrollment_state: "active" })
          sub_helper = SubstitutionsHelper.new(course, root_account, user, tool)
          expect(sub_helper.email).to eq "test@foo.com"
        end

        [
          [:prefer_sis_email, true, true],
          [:prefer_sis_email, "true", true],
          [:tool_configuration, { prefer_sis_email: true }, true],
          [:tool_configuration, { prefer_sis_email: "true" }, true]
        ].each do |(config_key, value)|
          context "when #{config_key} is set to #{value.inspect}" do
            before do
              tool.settings[config_key] = value
              tool.save!
            end

            it_behaves_like "preferring sis email"
          end
        end

        [
          [:prefer_sis_email, false, false],
          [:prefer_sis_email, "false", false],
          [:tool_configuration, { prefer_sis_email: false }, false],
          [:tool_configuration, { prefer_sis_email: "false" }, false]
        ].each do |(config_key, value)|
          context "when #{config_key} is set to #{value.inspect}" do
            before do
              tool.settings[config_key] = value
              tool.save!
            end

            it_behaves_like "not preferring sis email"
          end
        end
      end

      describe "#sis_email" do
        it "returns the sis email" do
          sis_email = "sis@example.com"
          cc = user.communication_channels.email.create!(path: sis_email)
          cc.user = user
          cc.save!
          pseudonym = cc.user.pseudonyms.build(unique_id: cc.path, account: root_account)
          pseudonym.sis_communication_channel_id = cc.id
          pseudonym.communication_channel_id = cc.id
          pseudonym.sis_user_id = "some_sis_id"
          pseudonym.save
          expect(substitution_helper.sis_email).to eq sis_email
        end

        it "returns nil if there isn't an sis email" do
          expect(substitution_helper.sis_email).to be_nil
        end
      end
    end
  end
end