. /** * Unit tests for workshop api class defined in mod/workshop/locallib.php * * @package mod_workshop * @category phpunit * @copyright 2009 David Mudrak * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot . '/mod/workshop/locallib.php'); // Include the code to test require_once(__DIR__ . '/fixtures/testable.php'); /** * Test cases for the internal workshop api */ class mod_workshop_internal_api_testcase extends advanced_testcase { /** workshop instance emulation */ protected $workshop; /** setup testing environment */ protected function setUp() { parent::setUp(); $this->setAdminUser(); $course = $this->getDataGenerator()->create_course(); $workshop = $this->getDataGenerator()->create_module('workshop', array('course' => $course)); $cm = get_coursemodule_from_instance('workshop', $workshop->id, $course->id, false, MUST_EXIST); $this->workshop = new testable_workshop($workshop, $cm, $course); } protected function tearDown() { $this->workshop = null; parent::tearDown(); } public function test_aggregate_submission_grades_process_notgraded() { $this->resetAfterTest(true); // fixture set-up $batch = array(); // batch of a submission's assessments $batch[] = (object)array('submissionid' => 12, 'submissiongrade' => null, 'weight' => 1, 'grade' => null); //$DB->expectNever('update_record'); // exercise SUT $this->workshop->aggregate_submission_grades_process($batch); } public function test_aggregate_submission_grades_process_single() { $this->resetAfterTest(true); // fixture set-up $batch = array(); // batch of a submission's assessments $batch[] = (object)array('submissionid' => 12, 'submissiongrade' => null, 'weight' => 1, 'grade' => 10.12345); $expected = 10.12345; //$DB->expectOnce('update_record'); // exercise SUT $this->workshop->aggregate_submission_grades_process($batch); } public function test_aggregate_submission_grades_process_null_doesnt_influence() { $this->resetAfterTest(true); // fixture set-up $batch = array(); // batch of a submission's assessments $batch[] = (object)array('submissionid' => 12, 'submissiongrade' => null, 'weight' => 1, 'grade' => 45.54321); $batch[] = (object)array('submissionid' => 12, 'submissiongrade' => null, 'weight' => 1, 'grade' => null); $expected = 45.54321; //$DB->expectOnce('update_record'); // exercise SUT $this->workshop->aggregate_submission_grades_process($batch); } public function test_aggregate_submission_grades_process_weighted_single() { $this->resetAfterTest(true); // fixture set-up $batch = array(); // batch of a submission's assessments $batch[] = (object)array('submissionid' => 12, 'submissiongrade' => null, 'weight' => 4, 'grade' => 14.00012); $expected = 14.00012; //$DB->expectOnce('update_record'); // exercise SUT $this->workshop->aggregate_submission_grades_process($batch); } public function test_aggregate_submission_grades_process_mean() { $this->resetAfterTest(true); // fixture set-up $batch = array(); // batch of a submission's assessments $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => null, 'weight' => 1, 'grade' => 56.12000); $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => null, 'weight' => 1, 'grade' => 12.59000); $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => null, 'weight' => 1, 'grade' => 10.00000); $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => null, 'weight' => 1, 'grade' => 0.00000); $expected = 19.67750; //$DB->expectOnce('update_record'); // exercise SUT $this->workshop->aggregate_submission_grades_process($batch); } public function test_aggregate_submission_grades_process_mean_changed() { $this->resetAfterTest(true); // fixture set-up $batch = array(); // batch of a submission's assessments $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => 12.57750, 'weight' => 1, 'grade' => 56.12000); $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => 12.57750, 'weight' => 1, 'grade' => 12.59000); $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => 12.57750, 'weight' => 1, 'grade' => 10.00000); $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => 12.57750, 'weight' => 1, 'grade' => 0.00000); $expected = 19.67750; //$DB->expectOnce('update_record'); // exercise SUT $this->workshop->aggregate_submission_grades_process($batch); } public function test_aggregate_submission_grades_process_mean_nochange() { $this->resetAfterTest(true); // fixture set-up $batch = array(); // batch of a submission's assessments $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => 19.67750, 'weight' => 1, 'grade' => 56.12000); $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => 19.67750, 'weight' => 1, 'grade' => 12.59000); $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => 19.67750, 'weight' => 1, 'grade' => 10.00000); $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => 19.67750, 'weight' => 1, 'grade' => 0.00000); //$DB->expectNever('update_record'); // exercise SUT $this->workshop->aggregate_submission_grades_process($batch); } public function test_aggregate_submission_grades_process_rounding() { $this->resetAfterTest(true); // fixture set-up $batch = array(); // batch of a submission's assessments $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => null, 'weight' => 1, 'grade' => 4.00000); $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => null, 'weight' => 1, 'grade' => 2.00000); $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => null, 'weight' => 1, 'grade' => 1.00000); $expected = 2.33333; //$DB->expectOnce('update_record'); // exercise SUT $this->workshop->aggregate_submission_grades_process($batch); } public function test_aggregate_submission_grades_process_weighted_mean() { $this->resetAfterTest(true); // fixture set-up $batch = array(); // batch of a submission's assessments $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => null, 'weight' => 3, 'grade' => 12.00000); $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => null, 'weight' => 2, 'grade' => 30.00000); $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => null, 'weight' => 1, 'grade' => 10.00000); $batch[] = (object)array('submissionid' => 45, 'submissiongrade' => null, 'weight' => 0, 'grade' => 1000.00000); $expected = 17.66667; //$DB->expectOnce('update_record'); // exercise SUT $this->workshop->aggregate_submission_grades_process($batch); } public function test_aggregate_grading_grades_process_nograding() { $this->resetAfterTest(true); // fixture set-up $batch = array(); $batch[] = (object)array('reviewerid'=>2, 'gradinggrade'=>null, 'gradinggradeover'=>null, 'aggregationid'=>null, 'aggregatedgrade'=>null); // expectation //$DB->expectNever('update_record'); // excersise SUT $this->workshop->aggregate_grading_grades_process($batch); } public function test_aggregate_grading_grades_process_single_grade_new() { $this->resetAfterTest(true); // fixture set-up $batch = array(); $batch[] = (object)array('reviewerid'=>3, 'gradinggrade'=>82.87670, 'gradinggradeover'=>null, 'aggregationid'=>null, 'aggregatedgrade'=>null); // expectation $now = time(); $expected = new stdclass(); $expected->workshopid = $this->workshop->id; $expected->userid = 3; $expected->gradinggrade = 82.87670; $expected->timegraded = $now; //$DB->expectOnce('insert_record', array('workshop_aggregations', $expected)); // excersise SUT $this->workshop->aggregate_grading_grades_process($batch, $now); } public function test_aggregate_grading_grades_process_single_grade_update() { $this->resetAfterTest(true); // fixture set-up $batch = array(); $batch[] = (object)array('reviewerid'=>3, 'gradinggrade'=>90.00000, 'gradinggradeover'=>null, 'aggregationid'=>1, 'aggregatedgrade'=>82.87670); // expectation //$DB->expectOnce('update_record'); // excersise SUT $this->workshop->aggregate_grading_grades_process($batch); } public function test_aggregate_grading_grades_process_single_grade_uptodate() { $this->resetAfterTest(true); // fixture set-up $batch = array(); $batch[] = (object)array('reviewerid'=>3, 'gradinggrade'=>90.00000, 'gradinggradeover'=>null, 'aggregationid'=>1, 'aggregatedgrade'=>90.00000); // expectation //$DB->expectNever('update_record'); // excersise SUT $this->workshop->aggregate_grading_grades_process($batch); } public function test_aggregate_grading_grades_process_single_grade_overridden() { $this->resetAfterTest(true); // fixture set-up $batch = array(); $batch[] = (object)array('reviewerid'=>4, 'gradinggrade'=>91.56700, 'gradinggradeover'=>82.32105, 'aggregationid'=>2, 'aggregatedgrade'=>91.56700); // expectation //$DB->expectOnce('update_record'); // excersise SUT $this->workshop->aggregate_grading_grades_process($batch); } public function test_aggregate_grading_grades_process_multiple_grades_new() { $this->resetAfterTest(true); // fixture set-up $batch = array(); $batch[] = (object)array('reviewerid'=>5, 'gradinggrade'=>99.45670, 'gradinggradeover'=>null, 'aggregationid'=>null, 'aggregatedgrade'=>null); $batch[] = (object)array('reviewerid'=>5, 'gradinggrade'=>87.34311, 'gradinggradeover'=>null, 'aggregationid'=>null, 'aggregatedgrade'=>null); $batch[] = (object)array('reviewerid'=>5, 'gradinggrade'=>51.12000, 'gradinggradeover'=>null, 'aggregationid'=>null, 'aggregatedgrade'=>null); // expectation $now = time(); $expected = new stdclass(); $expected->workshopid = $this->workshop->id; $expected->userid = 5; $expected->gradinggrade = 79.3066; $expected->timegraded = $now; //$DB->expectOnce('insert_record', array('workshop_aggregations', $expected)); // excersise SUT $this->workshop->aggregate_grading_grades_process($batch, $now); } public function test_aggregate_grading_grades_process_multiple_grades_update() { $this->resetAfterTest(true); // fixture set-up $batch = array(); $batch[] = (object)array('reviewerid'=>5, 'gradinggrade'=>56.23400, 'gradinggradeover'=>null, 'aggregationid'=>2, 'aggregatedgrade'=>79.30660); $batch[] = (object)array('reviewerid'=>5, 'gradinggrade'=>87.34311, 'gradinggradeover'=>null, 'aggregationid'=>2, 'aggregatedgrade'=>79.30660); $batch[] = (object)array('reviewerid'=>5, 'gradinggrade'=>51.12000, 'gradinggradeover'=>null, 'aggregationid'=>2, 'aggregatedgrade'=>79.30660); // expectation //$DB->expectOnce('update_record'); // excersise SUT $this->workshop->aggregate_grading_grades_process($batch); } public function test_aggregate_grading_grades_process_multiple_grades_overriden() { $this->resetAfterTest(true); // fixture set-up $batch = array(); $batch[] = (object)array('reviewerid'=>5, 'gradinggrade'=>56.23400, 'gradinggradeover'=>99.45670, 'aggregationid'=>2, 'aggregatedgrade'=>64.89904); $batch[] = (object)array('reviewerid'=>5, 'gradinggrade'=>87.34311, 'gradinggradeover'=>null, 'aggregationid'=>2, 'aggregatedgrade'=>64.89904); $batch[] = (object)array('reviewerid'=>5, 'gradinggrade'=>51.12000, 'gradinggradeover'=>null, 'aggregationid'=>2, 'aggregatedgrade'=>64.89904); // expectation //$DB->expectOnce('update_record'); // excersise SUT $this->workshop->aggregate_grading_grades_process($batch); } public function test_aggregate_grading_grades_process_multiple_grades_one_missing() { $this->resetAfterTest(true); // fixture set-up $batch = array(); $batch[] = (object)array('reviewerid'=>6, 'gradinggrade'=>50.00000, 'gradinggradeover'=>null, 'aggregationid'=>3, 'aggregatedgrade'=>100.00000); $batch[] = (object)array('reviewerid'=>6, 'gradinggrade'=>null, 'gradinggradeover'=>null, 'aggregationid'=>3, 'aggregatedgrade'=>100.00000); $batch[] = (object)array('reviewerid'=>6, 'gradinggrade'=>52.20000, 'gradinggradeover'=>null, 'aggregationid'=>3, 'aggregatedgrade'=>100.00000); // expectation //$DB->expectOnce('update_record'); // excersise SUT $this->workshop->aggregate_grading_grades_process($batch); } public function test_aggregate_grading_grades_process_multiple_grades_missing_overridden() { $this->resetAfterTest(true); // fixture set-up $batch = array(); $batch[] = (object)array('reviewerid'=>6, 'gradinggrade'=>50.00000, 'gradinggradeover'=>null, 'aggregationid'=>3, 'aggregatedgrade'=>100.00000); $batch[] = (object)array('reviewerid'=>6, 'gradinggrade'=>null, 'gradinggradeover'=>69.00000, 'aggregationid'=>3, 'aggregatedgrade'=>100.00000); $batch[] = (object)array('reviewerid'=>6, 'gradinggrade'=>52.20000, 'gradinggradeover'=>null, 'aggregationid'=>3, 'aggregatedgrade'=>100.00000); // expectation //$DB->expectOnce('update_record'); // excersise SUT $this->workshop->aggregate_grading_grades_process($batch); } public function test_percent_to_value() { $this->resetAfterTest(true); // fixture setup $total = 185; $percent = 56.6543; // exercise SUT $part = workshop::percent_to_value($percent, $total); // verify $this->assertEquals($part, $total * $percent / 100); } public function test_percent_to_value_negative() { $this->resetAfterTest(true); // fixture setup $total = 185; $percent = -7.098; // set expectation $this->setExpectedException('coding_exception'); // exercise SUT $part = workshop::percent_to_value($percent, $total); } public function test_percent_to_value_over_hundred() { $this->resetAfterTest(true); // fixture setup $total = 185; $percent = 121.08; // set expectation $this->setExpectedException('coding_exception'); // exercise SUT $part = workshop::percent_to_value($percent, $total); } public function test_lcm() { $this->resetAfterTest(true); // fixture setup + exercise SUT + verify in one step $this->assertEquals(workshop::lcm(1,4), 4); $this->assertEquals(workshop::lcm(2,4), 4); $this->assertEquals(workshop::lcm(4,2), 4); $this->assertEquals(workshop::lcm(2,3), 6); $this->assertEquals(workshop::lcm(6,4), 12); } public function test_lcm_array() { $this->resetAfterTest(true); // fixture setup $numbers = array(5,3,15); // excersise SUT $lcm = array_reduce($numbers, 'workshop::lcm', 1); // verify $this->assertEquals($lcm, 15); } public function test_prepare_example_assessment() { $this->resetAfterTest(true); // fixture setup $fakerawrecord = (object)array( 'id' => 42, 'submissionid' => 56, 'weight' => 0, 'timecreated' => time() - 10, 'timemodified' => time() - 5, 'grade' => null, 'gradinggrade' => null, 'gradinggradeover' => null, 'feedbackauthor' => null, 'feedbackauthorformat' => 0, 'feedbackauthorattachment' => 0, ); // excersise SUT $a = $this->workshop->prepare_example_assessment($fakerawrecord); // verify $this->assertTrue($a instanceof workshop_example_assessment); $this->assertTrue($a->url instanceof moodle_url); // modify setup $fakerawrecord->weight = 1; $this->setExpectedException('coding_exception'); // excersise SUT $a = $this->workshop->prepare_example_assessment($fakerawrecord); } public function test_prepare_example_reference_assessment() { global $USER; $this->resetAfterTest(true); // fixture setup $fakerawrecord = (object)array( 'id' => 38, 'submissionid' => 56, 'weight' => 1, 'timecreated' => time() - 100, 'timemodified' => time() - 50, 'grade' => 0.75000, 'gradinggrade' => 1.00000, 'gradinggradeover' => null, 'feedbackauthor' => null, 'feedbackauthorformat' => 0, 'feedbackauthorattachment' => 0, ); // excersise SUT $a = $this->workshop->prepare_example_reference_assessment($fakerawrecord); // verify $this->assertTrue($a instanceof workshop_example_reference_assessment); // modify setup $fakerawrecord->weight = 0; $this->setExpectedException('coding_exception'); // excersise SUT $a = $this->workshop->prepare_example_reference_assessment($fakerawrecord); } /** * Tests user restrictions, as they affect lists of users returned by * core API functions. * * This includes the groupingid option (when group mode is in use), and * standard activity restrictions using the availability API. */ public function test_user_restrictions() { global $DB, $CFG; $this->resetAfterTest(); // Use existing sample course from setUp. $courseid = $this->workshop->course->id; // Make a test grouping and two groups. $generator = $this->getDataGenerator(); $grouping = $generator->create_grouping(array('courseid' => $courseid)); $group1 = $generator->create_group(array('courseid' => $courseid)); groups_assign_grouping($grouping->id, $group1->id); $group2 = $generator->create_group(array('courseid' => $courseid)); groups_assign_grouping($grouping->id, $group2->id); // Group 3 is not in the grouping. $group3 = $generator->create_group(array('courseid' => $courseid)); // Enrol some students. $roleids = $DB->get_records_menu('role', null, '', 'shortname, id'); $student1 = $generator->create_user(); $student2 = $generator->create_user(); $student3 = $generator->create_user(); $generator->enrol_user($student1->id, $courseid, $roleids['student']); $generator->enrol_user($student2->id, $courseid, $roleids['student']); $generator->enrol_user($student3->id, $courseid, $roleids['student']); // Place students in groups (except student 3). groups_add_member($group1, $student1); groups_add_member($group2, $student2); groups_add_member($group3, $student3); // The existing workshop doesn't have any restrictions, so user lists // should include all three users. $allusers = get_enrolled_users(context_course::instance($courseid)); $result = $this->workshop->get_grouped($allusers); $this->assertCount(4, $result); $users = array_keys($result[0]); sort($users); $this->assertEquals(array($student1->id, $student2->id, $student3->id), $users); $this->assertEquals(array($student1->id), array_keys($result[$group1->id])); $this->assertEquals(array($student2->id), array_keys($result[$group2->id])); $this->assertEquals(array($student3->id), array_keys($result[$group3->id])); // Test get_users_with_capability_sql (via get_potential_authors). $users = $this->workshop->get_potential_authors(false); $this->assertCount(3, $users); $users = $this->workshop->get_potential_authors(false, $group2->id); $this->assertEquals(array($student2->id), array_keys($users)); // Create another test workshop with grouping set. $workshopitem = $this->getDataGenerator()->create_module('workshop', array('course' => $courseid, 'groupmode' => SEPARATEGROUPS, 'groupingid' => $grouping->id)); $cm = get_coursemodule_from_instance('workshop', $workshopitem->id, $courseid, false, MUST_EXIST); $workshopgrouping = new testable_workshop($workshopitem, $cm, $this->workshop->course); // This time the result should only include users and groups in the // selected grouping. $result = $workshopgrouping->get_grouped($allusers); $this->assertCount(3, $result); $users = array_keys($result[0]); sort($users); $this->assertEquals(array($student1->id, $student2->id), $users); $this->assertEquals(array($student1->id), array_keys($result[$group1->id])); $this->assertEquals(array($student2->id), array_keys($result[$group2->id])); // Test get_users_with_capability_sql (via get_potential_authors). $users = $workshopgrouping->get_potential_authors(false); $userids = array_keys($users); sort($userids); $this->assertEquals(array($student1->id, $student2->id), $userids); $users = $workshopgrouping->get_potential_authors(false, $group2->id); $this->assertEquals(array($student2->id), array_keys($users)); // Enable the availability system and create another test workshop with // availability restriction on grouping. $CFG->enableavailability = true; $workshopitem = $this->getDataGenerator()->create_module('workshop', array('course' => $courseid, 'availability' => json_encode( \core_availability\tree::get_root_json(array( \availability_grouping\condition::get_json($grouping->id)), \core_availability\tree::OP_AND, false)))); $cm = get_coursemodule_from_instance('workshop', $workshopitem->id, $courseid, false, MUST_EXIST); $workshoprestricted = new testable_workshop($workshopitem, $cm, $this->workshop->course); // The get_grouped function isn't intended to apply this restriction, // so it should be the same as the base workshop. (Note: in reality, // get_grouped is always run with the parameter being the result of // one of the get_potential_xxx functions, so it works.) $result = $workshoprestricted->get_grouped($allusers); $this->assertCount(4, $result); $this->assertCount(3, $result[0]); // The get_users_with_capability_sql-based functions should apply it. $users = $workshoprestricted->get_potential_authors(false); $userids = array_keys($users); sort($userids); $this->assertEquals(array($student1->id, $student2->id), $userids); $users = $workshoprestricted->get_potential_authors(false, $group2->id); $this->assertEquals(array($student2->id), array_keys($users)); } /** * Test the workshop reset feature. */ public function test_reset_phase() { $this->resetAfterTest(true); $this->workshop->switch_phase(workshop::PHASE_CLOSED); $this->assertEquals(workshop::PHASE_CLOSED, $this->workshop->phase); $settings = (object)array( 'reset_workshop_phase' => 0, ); $status = $this->workshop->reset_userdata($settings); $this->assertEquals(workshop::PHASE_CLOSED, $this->workshop->phase); $settings = (object)array( 'reset_workshop_phase' => 1, ); $status = $this->workshop->reset_userdata($settings); $this->assertEquals(workshop::PHASE_SETUP, $this->workshop->phase); foreach ($status as $result) { $this->assertFalse($result['error']); } } /** * Test deleting assessments related data on workshop reset. */ public function test_reset_userdata_assessments() { global $DB; $this->resetAfterTest(true); $student1 = $this->getDataGenerator()->create_user(); $student2 = $this->getDataGenerator()->create_user(); $this->getDataGenerator()->enrol_user($student1->id, $this->workshop->course->id); $this->getDataGenerator()->enrol_user($student2->id, $this->workshop->course->id); $workshopgenerator = $this->getDataGenerator()->get_plugin_generator('mod_workshop'); $subid1 = $workshopgenerator->create_submission($this->workshop->id, $student1->id); $subid2 = $workshopgenerator->create_submission($this->workshop->id, $student2->id); $asid1 = $workshopgenerator->create_assessment($subid1, $student2->id); $asid2 = $workshopgenerator->create_assessment($subid2, $student1->id); $settings = (object)array( 'reset_workshop_assessments' => 1, ); $status = $this->workshop->reset_userdata($settings); foreach ($status as $result) { $this->assertFalse($result['error']); } $this->assertEquals(2, $DB->count_records('workshop_submissions', array('workshopid' => $this->workshop->id))); $this->assertEquals(0, $DB->count_records('workshop_assessments')); } /** * Test deleting submissions related data on workshop reset. */ public function test_reset_userdata_submissions() { global $DB; $this->resetAfterTest(true); $student1 = $this->getDataGenerator()->create_user(); $student2 = $this->getDataGenerator()->create_user(); $this->getDataGenerator()->enrol_user($student1->id, $this->workshop->course->id); $this->getDataGenerator()->enrol_user($student2->id, $this->workshop->course->id); $workshopgenerator = $this->getDataGenerator()->get_plugin_generator('mod_workshop'); $subid1 = $workshopgenerator->create_submission($this->workshop->id, $student1->id); $subid2 = $workshopgenerator->create_submission($this->workshop->id, $student2->id); $asid1 = $workshopgenerator->create_assessment($subid1, $student2->id); $asid2 = $workshopgenerator->create_assessment($subid2, $student1->id); $settings = (object)array( 'reset_workshop_submissions' => 1, ); $status = $this->workshop->reset_userdata($settings); foreach ($status as $result) { $this->assertFalse($result['error']); } $this->assertEquals(0, $DB->count_records('workshop_submissions', array('workshopid' => $this->workshop->id))); $this->assertEquals(0, $DB->count_records('workshop_assessments')); } }