SWAMPy

✎ CARVE FLESH

EDITING: gradebook_uploadsSpec.js

/*
 * Copyright (C) 2017 - 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/>.
 */

import $ from 'jquery'
import gradebook_uploads from 'ui/features/gradebook_uploads/jquery/index'
import GradeFormatHelper from '@canvas/grading/GradeFormatHelper'
import * as waitForProcessing from 'ui/features/gradebook_uploads/jquery/wait_for_processing'

const fixtures = document.getElementById('fixtures')

QUnit.module('gradebook_uploads#createGeneralFormatter', hooks => {
  let formatter

hooks.beforeEach(() => {
    formatter = gradebook_uploads.createGeneralFormatter('foo')
  })

test('formatter returns expected lookup value', () => {
    const formatted = formatter(null, null, {foo: 'bar'})
    equal(formatted, 'bar')
  })

test('formatter returns empty string when lookup value missing', () => {
    const formatted = formatter(null, null, null)
    equal(formatted, '')
  })

test('formatter escapes passed-in HTML', () => {
    const formatted = formatter(null, null, {foo: 'bar & <baz>'})
    equal(formatted, 'bar &amp; &lt;baz&gt;')
  })
})

QUnit.module('gradebook_uploads#handleThingsNeedingToBeResolved', hooks => {
  let defaultUploadedGradebook

hooks.beforeEach(() => {
    fixtures.innerHTML = `
      <form id='gradebook_importer_resolution_section'>
        <select name='assignment_-1'>
          <option>73</option>
        </select>
      </form>
      <div id='gradebook_grid'>
        <div id='gradebook_grid_header'></div>
      </div>
      <div id='no_changes_detected' style='display:none;'></div>
    `

hooks.afterEach(() => {
    fixtures.innerHTML = ''
  })

test('recognizes that there are no changed assignments when the grades are the same', async () => {
    const uploadedGradebook = {
      ...defaultUploadedGradebook,
      original_submissions: [{assignment_id: '73', gradeable: true, score: '0.0', user_id: '1'}],
    }
    const waitForProcessingStub = sinon
      .stub(waitForProcessing, 'waitForProcessing')
      .resolves(uploadedGradebook)

await gradebook_uploads.handleThingsNeedingToBeResolved()
    $('#gradebook_importer_resolution_section').submit()
    strictEqual($('#no_changes_detected:visible').length, 1)

waitForProcessingStub.restore()
  })

test('recognizes that there are changed assignments when original grade was ungraded', async () => {
    const uploadedGradebook = {
      ...defaultUploadedGradebook,
      original_submissions: [{assignment_id: '73', gradeable: true, score: '', user_id: '1'}],
    }
    const waitForProcessingStub = sinon
      .stub(waitForProcessing, 'waitForProcessing')
      .resolves(uploadedGradebook)

await gradebook_uploads.handleThingsNeedingToBeResolved()
    $('#gradebook_importer_resolution_section').submit()
    strictEqual($('#no_changes_detected:visible').length, 0)

waitForProcessingStub.restore()
  })
})

QUnit.module('grade_summary#createNumberFormatter')

test('number formatter returns empty string when value missing', () => {
  const formatter = gradebook_uploads.createNumberFormatter('foo')
  const formatted = formatter(null, null, null)
  equal(formatted, '')
})

test('number formatter delegates to GradeFormatHelper#formatGrade', () => {
  const formatGradeSpy = sandbox.spy(GradeFormatHelper, 'formatGrade')
  const formatter = gradebook_uploads.createNumberFormatter('foo')
  formatter(null, null, {})
  ok(formatGradeSpy.calledOnce)
})

QUnit.module('override score changes', hooks => {
  let gridStub
  let headerGridArgs
  let mainGridArgs
  let gradeReviewRow

let defaultUploadedGradebook

hooks.beforeEach(() => {
    fixtures.innerHTML = `
      <div id='gradebook_grid'>
      </div>
      <div id='gradebook_grid_header'>
      </div>
    `

defaultUploadedGradebook = {
      assignments: [
        {grading_type: null, id: '-1', points_possible: 10, previous_id: null, title: 'imported'},
      ],
      custom_columns: [],
      missing_objects: {
        assignments: [
          {
            grading_type: 'points',
            id: '73',
            points_possible: 10,
            previous_id: null,
            title: 'existing',
          },
        ],
        students: [],
      },
      original_submissions: [{assignment_id: '73', gradeable: true, score: '', user_id: '1'}],
      override_scores: {
        grading_periods: [
          {id: 1, title: 'first GP'},
          {id: 2, title: 'second GP'},
          {id: 3, title: 'third GP'},
        ],
        includes_course_scores: false,
      },
      students: [
        {
          custom_column_data: [],
          id: '1',
          last_name_first: 'Efron, Zac',
          name: 'Zac Efron',
          override_scores: [
            {
              current_score: '70',
              grading_period_id: '1',
              new_score: '80',
            },
            {
              current_score: '71',
              grading_period_id: '2',
              new_score: '61',
            },
            {
              current_score: '50',
              new_score: null,
            },
          ],
          previous_id: '1',
          submissions: [{assignment_id: '-1', grade: '0.0', gradeable: true, original_grade: null}],
        },
      ],
      warning_messages: {
        prevented_grading_ungradeable_submission: false,
        prevented_new_assignment_creation_in_closed_period: false,
      },
    }

gridStub = sinon.stub(gradebook_uploads, 'createGrid')

// Creation of the actual grid, including "From" and "To" headers
    gridStub.onFirstCall().callsFake((_, {data, columns, options}) => {
      mainGridArgs = {data, columns, options}
      return {
        invalidateRow: () => {},
        render: () => {},
        setCellCssStyles: (_style, reviewRow) => {
          gradeReviewRow = reviewRow
        },
      }
    })

// Creation of the ersatz grid containing headers, which is not
    // referenced after being created
    gridStub.onSecondCall().callsFake((_, {data, columns, options}) => {
      headerGridArgs = {data, columns, options}
      return {}
    })
  })

hooks.afterEach(() => {
    gridStub.restore()
  })

const initGradebook = function (uploadedGradebook = defaultUploadedGradebook) {
    gradebook_uploads.init(uploadedGradebook)
  }

QUnit.module('column creation', () => {
    test('creates a pair of columns for each grading period in the grading_periods hash', () => {
      initGradebook()

const columnIds = mainGridArgs.columns
        .map(column => column.id)
        .filter(id => id.includes('override_score'))

deepEqual(columnIds, [
        'override_score_1_conflicting',
        'override_score_1',
        'override_score_2_conflicting',
        'override_score_2',
        'override_score_3_conflicting',
        'override_score_3',
      ])
    })

test('adds a header for each grading period including the title of the grading period', () => {
      initGradebook()

const headers = headerGridArgs.columns
        .map(column => column.name)
        .filter(name => name.includes('Override Score'))

deepEqual(headers, [
        'Override Score (first GP)',
        'Override Score (second GP)',
        'Override Score (third GP)',
      ])
    })

test('creates a column for course scores if includes_course_scores is true', () => {
      defaultUploadedGradebook.override_scores.includes_course_scores = true
      defaultUploadedGradebook.override_scores.grading_periods = []

initGradebook()

const gradingPeriodColumn = mainGridArgs.columns.find(
        column => column.id === 'override_score_course'
      )
      ok(gradingPeriodColumn)
    })

test('adds a header for course scores with the label of plain old "Override Grade"', () => {
      defaultUploadedGradebook.override_scores.includes_course_scores = true
      defaultUploadedGradebook.override_scores.grading_periods = []

initGradebook()

const gradingPeriodColumn = headerGridArgs.columns.find(
        column => column.name === 'Override Score'
      )
      ok(gradingPeriodColumn)
    })

test('does not create a column for course scores if includes_course_scores is false', () => {
      initGradebook()

const gradingPeriodColumn = mainGridArgs.columns.find(
        column => column.id === 'override_score_course'
      )
      notOk(gradingPeriodColumn)
    })
  })

QUnit.module('value population', () => {
    test('populates the grid data with course override scores for each student', () => {
      initGradebook()

const dataForStudent = mainGridArgs.data.find(datum => datum.id === '1')
      deepEqual(dataForStudent.override_score_course, {
        current_score: '50',
        new_score: null,
      })
    })

test('populates the grid data with grading period override scores for each student', () => {
      initGradebook()

const dataForStudent = mainGridArgs.data.find(datum => datum.id === '1')
      deepEqual(dataForStudent.override_score_1, {
        current_score: '70',
        grading_period_id: '1',
        new_score: '80',
      })
    })

test('highlights cells if the override score has gone down', () => {
      initGradebook()

const firstStudentRow = gradeReviewRow[0]
      strictEqual(
        firstStudentRow.override_score_2_conflicting,
        'left-highlight',
        'current score is highlighted'
      )
      strictEqual(
        firstStudentRow.override_score_2,
        'right-highlight',
        'updated (lowered) score is highlighted'
      )
    })

test('highlights cells if the override score has been removed', () => {
      initGradebook()

const firstStudentRow = gradeReviewRow[0]
      strictEqual(
        firstStudentRow.override_score_course_conflicting,
        'left-highlight',
        'current score is highlighted'
      )
      strictEqual(
        firstStudentRow.override_score_course,
        'right-highlight',
        'updated (removed) score is highlighted'
      )
    })

test('does not highlight cells if the override score has gone up', () => {
      initGradebook()

const firstStudentRow = gradeReviewRow[0]
      notOk(firstStudentRow.override_score_1_conflicting, 'current score is not highlighted')
      notOk(firstStudentRow.override_score_1, 'updated (increased) score is not highlighted')
    })

test('does not highlight cells if the override score has not changed', () => {
      defaultUploadedGradebook.students[0].override_scores = [
        {
          current_score: '70',
          grading_period_id: '1',
          new_score: '70',
        },
      ]
      initGradebook()

// setCellCssStyles should be called with an empty hash since nothing to
      // highlight
      deepEqual(gradeReviewRow, {}, 'no highlightable changes')
    })

test('does not highlight cells if the override score is newly added', () => {
      defaultUploadedGradebook.students[0].override_scores = [
        {
          current_score: null,
          grading_period_id: '1',
          new_score: '70',
        },
      ]
      initGradebook()

// setCellCssStyles should be called with an empty hash since nothing to
      // highlight
      deepEqual(gradeReviewRow, {}, 'no highlightable changes')
    })
  })
})

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 a_force_failure/	DIR	—	2023-09-24 03:36
📁 account_course_user_search/	DIR	—	2023-09-24 03:39
📁 accounts/	DIR	—	2023-09-24 03:36
📁 add_people/	DIR	—	2023-09-24 03:39
📁 announcements/	DIR	—	2023-09-24 03:39
📁 assignments/	DIR	—	2023-09-24 03:39
📁 authentication_providers/	DIR	—	2023-09-24 03:39
📁 behaviors/	DIR	—	2023-09-24 03:39
📁 blueprint_courses/	DIR	—	2023-09-24 03:39
📁 calendar/	DIR	—	2023-09-24 03:39
📁 canvas_cropper/	DIR	—	2023-09-24 03:39
📁 choose_mastery_path/	DIR	—	2023-09-24 03:39
📁 collaborations/	DIR	—	2023-09-24 03:39
📁 conditional_release_stats/	DIR	—	2023-09-24 03:39
📁 conferences/	DIR	—	2023-09-24 03:36
📁 context_cards/	DIR	—	2023-09-24 03:39
📁 context_modules/	DIR	—	2023-09-24 03:39
📁 conversations/	DIR	—	2023-09-24 03:36
📁 course_settings/	DIR	—	2023-09-24 03:39
📁 courses/	DIR	—	2023-09-24 03:39
📁 dashboard/	DIR	—	2023-09-24 03:39
📁 dashboard_card/	DIR	—	2023-09-24 03:39
📁 developer_keys/	DIR	—	2023-09-24 03:39
📁 discussions/	DIR	—	2023-09-24 03:36
📁 due_dates/	DIR	—	2023-09-24 03:39
📁 editor/	DIR	—	2023-09-24 03:39
📁 eportfolios/	DIR	—	2023-09-24 03:39
📁 examples/	DIR	—	2023-09-24 03:36
📁 external_apps/	DIR	—	2023-09-24 03:39
📁 files/	DIR	—	2023-09-24 03:39
📁 fn/	DIR	—	2023-09-24 03:36
📁 g_force_failure/	DIR	—	2023-09-24 03:36
📁 grade_summary/	DIR	—	2023-09-24 03:39
📁 gradebook/	DIR	—	2023-09-24 03:39
📁 gradebook-history/	DIR	—	2023-09-24 03:39
📁 grading/	DIR	—	2023-09-24 03:39
📁 h_force_failure/	DIR	—	2023-09-24 03:36
📁 jquery/	DIR	—	2023-09-24 03:36
📁 learning-mastery/	DIR	—	2023-09-24 03:36
📁 login/	DIR	—	2023-09-24 03:36
📁 lti/	DIR	—	2023-09-24 03:39
📁 mediaelement/	DIR	—	2023-09-24 03:36
📁 modules/	DIR	—	2023-09-24 03:36
📁 move_item/	DIR	—	2023-09-24 03:39
📁 new_user_tutorial/	DIR	—	2023-09-24 03:39
📁 outcomes/	DIR	—	2023-09-24 03:39
📁 quizzes/	DIR	—	2023-09-24 03:36
📁 rubrics/	DIR	—	2023-09-24 03:39
📁 shared/	DIR	—	2023-09-24 03:39
📁 spec-support/	DIR	—	2023-09-24 03:36
📁 speed_grader/	DIR	—	2023-09-24 03:39
📁 subnav_menu/	DIR	—	2023-09-24 03:36
📁 support/	DIR	—	2023-09-24 03:36
📁 theme_editor/	DIR	—	2023-09-24 03:39
📁 util/	DIR	—	2023-09-24 03:36
📁 views/	DIR	—	2023-09-24 03:36
📁 webzip_export/	DIR	—	2023-09-24 03:39
📄 AuthenticationProvidersSpec.js	JS	2.9 KB	2023-09-24 03:36	EDIT
📄 axiosSpec.js	JS	1.5 KB	2023-09-24 03:36	EDIT
📄 gradebook_uploadsSpec.js	JS	12.6 KB	2023-09-24 03:39	EDIT
📄 moment_formatsSpec.js	JS	1.7 KB	2023-09-24 03:36	EDIT
📄 momentSpec.js	JS	1 KB	2023-09-24 03:36	EDIT
📄 railsFlashNotificationsHelperSpec.js	JS	12.9 KB	2023-09-24 03:36	EDIT
📄 rubric_assessmentSpec.js	JS	8.8 KB	2023-09-24 03:36	EDIT
📄 slickgrid.long_text_editorSpec.js	JS	4.1 KB	2023-09-24 03:36	EDIT
📄 speed_graderSpec.js	JS	291.8 KB	2023-09-24 03:39	EDIT
📄 SubmissionDetailsDialogSpec.js	JS	3.7 KB	2023-09-24 03:36	EDIT
📄 submissionsSpec.js	JS	5.3 KB	2023-09-24 03:36	EDIT