SWAMPy

✎ CARVE FLESH

EDITING: gradebook_history_spec.rb

# frozen_string_literal: true

#
# Copyright (C) 2013 - 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/>.
#

class GradebookHistoryHarness
  include Api::V1::GradebookHistory

def course_assignment_url(*)
    "http://www.example.com"
  end

def course_assignment_submissions_url(*)
    "http://www.example.com"
  end

def course_assignment_submission_url(*)
    "http://www.example.com"
  end

def params
    {}
  end
end

describe Api::V1::GradebookHistory do
  subject(:gradebook_history) { GradebookHistoryHarness.new }

let(:course) { double }
  let(:controller) do
    double(
      params: {},
      request: double(query_parameters: {}),
      response: double(headers: {})
    )
  end
  let(:path) { "" }
  let(:user) { User.new }
  let(:session) { double }
  let(:api_context) { Api::V1::ApiContext.new(controller, path, user, session) }
  let(:now) { Time.now.in_time_zone }
  let(:yesterday) { (now - 24.hours).in_time_zone }

before do
    allow_any_instance_of(Submission).to receive(:user_can_read_grade?).with(user, session).and_return(true)
  end

def submit(assignment, student, day, grader)
    bare_submission_model(assignment, student, graded_at: day, grader_id: grader.try(:id))
  end

describe "#days_json" do
    let_once(:course) { Course.create! }

before :once do
      students = (1..3).map do |_idx|
        student = User.create!
        course.enroll_student(student)
        student
      end
      @grader1 = User.create!(name: "grader 1")
      @grader2 = User.create!(name: "grader 2")
      @assignment1 = course.assignments.create!(title: "some assignment")
      @assignment2 = course.assignments.create!(title: "another assignment")
      submit(@assignment1, students[0], now, @grader1)
      submit(@assignment1, students[1], now, @grader2)
      submit(@assignment1, students[2], yesterday, @grader2)
      submit(@assignment2, students[0], yesterday, @grader2)
    end

before do
      harness = GradebookHistoryHarness.new
      harness.instance_variable_set(:@domain_root_account, Account.default)
      @days = harness.days_json(course, api_context)
    end

it "has a top level key for each day represented" do
      dates = @days.pluck(:date)
      expect(dates.size).to eq 2
      expect(dates).to include(now.to_date.as_json)
      expect(dates).to include(24.hours.ago.in_time_zone.to_date.as_json)
    end

it "has a hash of graders for each day keyed by id" do
      graders_hash = @days.find { |d| d[:date] == yesterday.to_date.as_json }[:graders]
      grader = graders_hash.first
      expect(grader[:id]).to eq @grader2.id
      expect(grader[:name]).to eq @grader2.name
    end

it "puts an assignment list under each grader" do
      graders = @days.find { |d| d[:date] == yesterday.to_date.as_json }[:graders]
      grader2_assignments = graders.find { |g| g[:id] == @grader2.id }[:assignments]
      ids = grader2_assignments.pluck("id")
      expect(ids).to include(@assignment1.id)
      expect(ids).to include(@assignment2.id)
    end

it "paginates" do
      api_context.per_page = 2
      api_context.page = 2
      harness = GradebookHistoryHarness.new
      harness.instance_variable_set(:@domain_root_account, Account.default)
      days = harness.days_json(course, api_context)
      expect(days.pluck(:date).first).to eq yesterday.to_date.as_json
    end
  end

describe "#json_for_date" do
    let_once(:course) { Course.create! }

before :once do
      student1 = User.create!
      course.enroll_student(student1)
      student2 = User.create!
      course.enroll_student(student2)
      @grader1 = User.create!(name: "grader 1")
      @grader2 = User.create!(name: "grader 2")
      @assignment = course.assignments.create!(title: "some assignment")
      submit(@assignment, student1, now, @grader1)
      submit(@assignment, student2, now, @grader2)
    end

before do
      harness = GradebookHistoryHarness.new
      harness.instance_variable_set(:@domain_root_account, Account.default)
      @day_hash = harness.json_for_date(now, course, api_context)
    end

it "includes assignment data" do
      assignment_hash = @day_hash.find { |g| g[:id] == @grader1.id }[:assignments].first
      expect(assignment_hash["id"]).to eq @assignment.id
      expect(assignment_hash["name"]).to eq @assignment.title
    end

it "returns a grader hash for that day" do
      expect(@day_hash.pluck(:id).sort).to eq [@grader1.id, @grader2.id].sort
    end
  end

describe "#versions_json" do
    let(:grader) { User.create!(name: "grader") }
    let(:student) { User.create! }
    let(:assignment) { course.assignments.create!(title: "some assignment") }
    let(:versions) { [Version.create!(versionable: submission, model: submission)] }
    let(:harness) {  GradebookHistoryHarness.new }
    let(:submission) do
      s = assignment.submit_homework(student)
      s.update(graded_at: now, score: 90, grade: "90", grader:)
      s
    end
    let(:course) do
      c = Course.create!
      c.enroll_student(student)
      c.enroll_teacher(grader)
      c
    end

it "does preloads originality reports" do
      submission.reload
      harness.versions_json(course, versions, api_context)
      expect(versions.first.model.association(:originality_reports).loaded?).to be true
    end

it "handles versions without an associated 'versionable' object" do
      version = Version.create!(versionable: submission, model: submission)
      version.update_column(:versionable_id, nil)
      submission.reload
      expect { harness.versions_json(course, [version], api_context) }.not_to raise_error
    end
  end

describe "#submissions_for" do
    before :once do
      @course = Course.create!
      student1 = User.create!
      @course.enroll_student(student1)
      @grader1 = User.create!(name: "grader 1")
      @grader2 = User.create!(name: "grader 2")
      @course.enroll_teacher(@grader2)
      @assignment = @course.assignments.create!(title: "some assignment")
      @submission = @assignment.submit_homework(student1)
      @submission.update(graded_at: now, grader_id: @grader1.id)
      @submission.score = 90
      @submission.grade = "90"
      @submission.grader = @grader2
      @submission.save!
    end

it "is an array of submissions" do
      harness = GradebookHistoryHarness.new
      submissions_hash = harness.submissions_for(@course, api_context, now, @grader2.id, @assignment.id)
      expect(submissions_hash.first[:submission_id]).to eq @submission.id
    end

it "has the version hash" do
      harness = GradebookHistoryHarness.new
      submissions_hash = harness.submissions_for(@course, api_context, now, @grader2.id, @assignment.id)
      version1 = submissions_hash.first[:versions].first
      expect(version1[:assignment_id]).to eq @assignment.id
      expect(version1[:current_grade]).to eq "90"
      expect(version1[:current_grader]).to eq "grader 2"
      expect(version1[:new_grade]).to eq "90"
    end

it "can find submissions with no grader" do
      student2 = User.create!
      @course.enroll_student(student2)
      submission = submit(@assignment, student2, now, nil)
      # yes, this is crazy.  autograded submissions have the grader_id of (quiz_id x -1)
      submission.grader_id = -987
      submission.save!

submissions = GradebookHistoryHarness.new.submissions_for(@course, api_context, now, 0, @assignment.id)
      expect(submissions.first[:submission_id]).to eq submission.id
    end

it "properly sets pervious_* attributes" do
      # regrade to get a second version
      @submission.score = "80"
      @submission.with_versioning(explicit: true) { @submission.save! }

harness = GradebookHistoryHarness.new
      submissions = harness.submissions_for(@course, api_context, now, @grader2.id, @assignment.id)
      expect(submissions.first[:versions][0][:grade]).to eq "80"
      expect(submissions.first[:versions][0][:previous_grade]).to eq "90"
      expect(submissions.first[:versions][1][:grade]).to eq "90"
      expect(submissions.first[:versions][1][:previous_grade]).to be_nil
    end
  end

describe "#day_string_for" do
    it "builds a formatted date" do
      submission = double(graded_at: now)
      expect(gradebook_history.day_string_for(submission)).to match(/\d{4}-\d{2}-\d{2}/)
    end

it "gives a empty string if there is no time" do
      submission = double(graded_at: nil)
      expect(gradebook_history.day_string_for(submission)).to eq ""
    end
  end

describe "#submissions" do
    let_once(:course) { Course.create! }
    let_once(:assignment) { course.assignments.create! }
    let_once(:student) { User.create! }
    let(:submissions) { gradebook_history.submissions_set(course, api_context) }

before :once do
      course.enroll_student(student)
      @submission = bare_submission_model(assignment, student)
    end

context "when the submission has been graded" do
      before :once do
        @submission.graded_at = Time.now.in_time_zone
        @submission.save!
      end

def add_submission
        other_student = User.create!
        course.enroll_student(other_student)
        other_submission = bare_submission_model(assignment, other_student, graded_at: 2.hours.ago.in_time_zone)
        other_submission.save!
      end

it "includes the submission" do
        expect(submissions).to include(@submission)
      end

it "orders submissions by graded timestamp" do
        add_submission
        expect(submissions.first).to eq @submission
      end

it "accepts a date option" do
        add_submission
        expect(gradebook_history.submissions_set(course, api_context, date: 3.days.ago.in_time_zone)).to be_empty
        expect(gradebook_history.submissions_set(course, api_context, date: Time.now.in_time_zone)).not_to be_empty
      end
    end

it "does not include ungraded submissions" do
      expect(submissions).not_to include(@submission)
    end
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 conditional_release/	DIR	—	2023-09-24 03:36
📁 live_assessments/	DIR	—	2023-09-24 03:36
📁 master_courses/	DIR	—	2023-09-24 03:36
📁 outcomes_import/	DIR	—	2023-09-24 03:36
📁 polling/	DIR	—	2023-09-24 03:36
📁 quizzes/	DIR	—	2023-09-24 03:39
📁 quizzes_next/	DIR	—	2023-09-24 03:36
📄 account_notifications_api_spec.rb	RB	15.1 KB	2023-09-24 03:36	EDIT
📄 account_reports_api_spec.rb	RB	7.7 KB	2023-09-24 03:36	EDIT
📄 accounts_api_spec.rb	RB	79.8 KB	2023-09-24 03:39	EDIT
📄 admins_api_spec.rb	RB	17.3 KB	2023-09-24 03:36	EDIT
📄 announcements_api_spec.rb	RB	18.2 KB	2023-09-24 03:36	EDIT
📄 anonymous_provisional_grades_api_spec.rb	RB	1.9 KB	2023-09-24 03:36	EDIT
📄 appointment_groups_api_spec.rb	RB	35.2 KB	2023-09-24 03:36	EDIT
📄 assignment_extensions_controller_spec.rb	RB	4.3 KB	2023-09-24 03:36	EDIT
📄 assignment_groups_api_spec.rb	RB	43.5 KB	2023-09-24 03:39	EDIT
📄 assignment_overrides_spec.rb	RB	53.3 KB	2023-09-24 03:39	EDIT
📄 assignments_api_spec.rb	RB	297.2 KB	2023-09-24 03:39	EDIT
📄 authentication_audit_api_spec.rb	RB	16.6 KB	2023-09-24 03:36	EDIT
📄 authentication_providers_api_spec.rb	RB	21 KB	2023-09-24 03:39	EDIT
📄 calendar_events_api_spec.rb	RB	221.2 KB	2023-09-24 03:39	EDIT
📄 collaboration_json_spec.rb	RB	2.7 KB	2023-09-24 03:36	EDIT
📄 collaborations_api_spec.rb	RB	8.6 KB	2023-09-24 03:36	EDIT
📄 comm_messages_api_spec.rb	RB	8.5 KB	2023-09-24 03:36	EDIT
📄 communication_channels_api_spec.rb	RB	16.3 KB	2023-09-24 03:36	EDIT
📄 conferences_api_spec.rb	RB	16.6 KB	2023-09-24 03:36	EDIT
📄 content_exports_api_spec.rb	RB	54 KB	2023-09-24 03:39	EDIT
📄 content_migrations_api_spec.rb	RB	44.7 KB	2023-09-24 03:39	EDIT
📄 content_share_spec.rb	RB	2.4 KB	2023-09-24 03:36	EDIT
📄 context_module_items_api_spec.rb	RB	102.4 KB	2023-09-24 03:39	EDIT
📄 context_modules_api_spec.rb	RB	59.7 KB	2023-09-24 03:36	EDIT
📄 conversations_api_spec.rb	RB	134.7 KB	2023-09-24 03:39	EDIT
📄 course_audit_api_spec.rb	RB	6.1 KB	2023-09-24 03:36	EDIT
📄 course_json_spec.rb	RB	29.3 KB	2023-09-24 03:36	EDIT
📄 course_nicknames_api_spec.rb	RB	7.3 KB	2023-09-24 03:36	EDIT
📄 courses_api_spec.rb	RB	240.7 KB	2023-09-24 03:39	EDIT
📄 csp_settings_spec.rb	RB	12.5 KB	2023-09-24 03:39	EDIT
📄 custom_gradebook_column_data_api_spec.rb	RB	12.4 KB	2023-09-24 03:36	EDIT
📄 custom_gradebook_columns_api_spec.rb	RB	8.3 KB	2023-09-24 03:36	EDIT
📄 developer_keys_spec.rb	RB	11.3 KB	2023-09-24 03:36	EDIT
📄 discussion_topic_users_controller_spec.rb	RB	3 KB	2023-09-24 03:39	EDIT
📄 discussion_topics_api_spec.rb	RB	179.5 KB	2023-09-24 03:39	EDIT
📄 enrollments_api_spec.rb	RB	137.8 KB	2023-09-24 03:39	EDIT
📄 eportfolios_api_spec.rb	RB	18.1 KB	2023-09-24 03:36	EDIT
📄 errors_api_spec.rb	RB	1.9 KB	2023-09-24 03:36	EDIT
📄 external_feeds_api_spec.rb	RB	6.5 KB	2023-09-24 03:36	EDIT
📄 external_tools_api_spec.rb	RB	52.3 KB	2023-09-24 03:39	EDIT
📄 favorites_api_spec.rb	RB	11.7 KB	2023-09-24 03:36	EDIT
📄 feature_flags_api_spec.rb	RB	44.6 KB	2023-09-24 03:36	EDIT
📄 files_controller_api_spec.rb	RB	74.2 KB	2023-09-24 03:39	EDIT
📄 folders_controller_api_spec.rb	RB	50.4 KB	2023-09-24 03:36	EDIT
📄 grade_change_audit_api_spec.rb	RB	21.8 KB	2023-09-24 03:36	EDIT
📄 gradebook_filters_api_controller_spec.rb	RB	8.9 KB	2023-09-24 03:36	EDIT
📄 gradebook_history_api_spec.rb	RB	13 KB	2023-09-24 03:36	EDIT
📄 gradebook_history_spec.rb	RB	10.3 KB	2023-09-24 03:36	EDIT
📄 grading_periods_api_spec.rb	RB	3.9 KB	2023-09-24 03:36	EDIT
📄 grading_standards_api_spec.rb	RB	10.4 KB	2023-09-24 03:36	EDIT
📄 group_categories_api_spec.rb	RB	37.2 KB	2023-09-24 03:36	EDIT
📄 groups_api_spec.rb	RB	48.1 KB	2023-09-24 03:39	EDIT
📄 history_api_spec.rb	RB	13.5 KB	2023-09-24 03:36	EDIT
📄 jobs_v2_api_spec.rb	RB	35.6 KB	2023-09-24 03:39	EDIT
📄 media_objects_controller_api_spec.rb	RB	3.6 KB	2023-09-24 03:36	EDIT
📄 migrations_issues_api_spec.rb	RB	4.6 KB	2023-09-24 03:36	EDIT
📄 moderation_set_api_spec.rb	RB	5.8 KB	2023-09-24 03:36	EDIT
📄 notification_preferences_api_spec.rb	RB	10.2 KB	2023-09-24 03:36	EDIT
📄 observer_alert_thresholds_api_controller_spec.rb	RB	14.2 KB	2023-09-24 03:36	EDIT
📄 observer_alerts_api_controller_spec.rb	RB	8.7 KB	2023-09-24 03:36	EDIT
📄 observer_pairing_codes_api_controller_spec.rb	RB	5.2 KB	2023-09-24 03:36	EDIT
📄 outcome_groups_api_spec.rb	RB	95.2 KB	2023-09-24 03:39	EDIT
📄 outcome_imports_api_controller_spec.rb	RB	11.7 KB	2023-09-24 03:36	EDIT
📄 outcome_proficiency_api_controller_spec.rb	RB	12.6 KB	2023-09-24 03:36	EDIT
📄 outcome_results_api_spec.rb	RB	42.2 KB	2023-09-24 03:39	EDIT
📄 outcomes_api_spec.rb	RB	63.8 KB	2023-09-24 03:39	EDIT
📄 pages_api_spec.rb	RB	92 KB	2023-09-24 03:39	EDIT
📄 peer_reviews_api_spec.rb	RB	20.9 KB	2023-09-24 03:36	EDIT
📄 profiles_api_controller_spec.rb	RB	2.7 KB	2023-09-24 03:36	EDIT
📄 progress_api_spec.rb	RB	2.1 KB	2023-09-24 03:36	EDIT
📄 provisional_grades_api_spec.rb	RB	20.7 KB	2023-09-24 03:36	EDIT
📄 pseudonyms_api_spec.rb	RB	21.4 KB	2023-09-24 03:36	EDIT
📄 roles_api_spec.rb	RB	39.6 KB	2023-09-24 03:36	EDIT
📄 rubrics_api_spec.rb	RB	23.8 KB	2023-09-24 03:36	EDIT
📄 scopes_api_controller_spec.rb	RB	3.4 KB	2023-09-24 03:39	EDIT
📄 search_api_spec.rb	RB	35.3 KB	2023-09-24 03:36	EDIT
📄 sections_api_spec.rb	RB	45.6 KB	2023-09-24 03:39	EDIT
📄 services_api_spec.rb	RB	13.7 KB	2023-09-24 03:36	EDIT
📄 shared_brand_configs_api_spec.rb	RB	4.4 KB	2023-09-24 03:36	EDIT
📄 sis_api_spec.rb	RB	13.4 KB	2023-09-24 03:36	EDIT
📄 sis_import_errors_api_spec.rb	RB	5.1 KB	2023-09-24 03:36	EDIT
📄 sis_imports_api_spec.rb	RB	47.5 KB	2023-09-24 03:39	EDIT
📄 stream_items_api_spec.rb	RB	40.1 KB	2023-09-24 03:39	EDIT
📄 submission_comments_api_spec.rb	RB	13.7 KB	2023-09-24 03:36	EDIT
📄 submissions_api_spec.rb	RB	281 KB	2023-09-24 03:39	EDIT
📄 tabs_api_spec.rb	RB	45.5 KB	2023-09-24 03:36	EDIT
📄 terms_api_spec.rb	RB	22.9 KB	2023-09-24 03:36	EDIT
📄 todo_items_api_spec.rb	RB	26.3 KB	2023-09-24 03:36	EDIT
📄 token_scoping_api_spec.rb	RB	6.4 KB	2023-09-24 03:36	EDIT
📄 upcoming_events_api_spec.rb	RB	3.8 KB	2023-09-24 03:36	EDIT
📄 usage_rights_api_spec.rb	RB	13.1 KB	2023-09-24 03:36	EDIT
📄 user_observees_api_spec.rb	RB	24.9 KB	2023-09-24 03:36	EDIT
📄 user_profiles_api_spec.rb	RB	11.6 KB	2023-09-24 03:36	EDIT
📄 users_api_spec.rb	RB	149.7 KB	2023-09-24 03:39	EDIT
📄 wiki_pages_api_spec.rb	RB	10.7 KB	2023-09-24 03:39	EDIT