first commit

grade/report/overview/tests/behat/suspended.feature

@@ -0,0 +1,31 @@
+@gradereport @gradereport_overview
+Feature: Grade overview report should be hidden from suspended enrolments
+  While viewing the grade overview report
+  As a student
+  I should only see courses I am active in
+
+  Background:
+    Given the following "courses" exist:
+      | fullname         | shortname |
+      | Active course    | C1        |
+      | Suspended course | C2        |
+    And the following "users" exist:
+      | username | firstname | lastname | email                |
+      | student1 | Student   | 1        | student1@example.com |
+    And the following "course enrolments" exist:
+      | user     | course | role    | status |
+      | student1 | C1     | student | 0      |
+      | student1 | C2     | student | 1      |
+
+  Scenario: Students should not see grades for courses with suspended enrolments
+    Given I am on the "Active course" "grades > Overview report > View" page logged in as "student1"
+    Then I should not see "Suspended course" in the "overview-grade" "table"
+    And I should see "Active course" in the "overview-grade" "table"
+
+  Scenario: Admins should see courses with suspended enrolments
+    Given I log in as "admin"
+    And I navigate to "Users > Accounts > Browse list of users" in site administration
+    And I follow "Student 1"
+    When I click on "Grades overview" "link"
+    Then I should see "Suspended course" in the "overview-grade" "table"
+    And I should see "Active course" in the "overview-grade" "table"

grade/report/overview/tests/externallib_test.php

@@ -0,0 +1,252 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle 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 General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace gradereport_overview;
+
+use core_external\external_api;
+use externallib_advanced_testcase;
+use gradereport_overview_external;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+require_once($CFG->dirroot . '/webservice/tests/helpers.php');
+
+/**
+ * Overview grade report functions unit tests
+ *
+ * @package    gradereport_overview
+ * @category   external
+ * @copyright  2015 Juan Leyva <juan@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class externallib_test extends externallib_advanced_testcase {
+
+    /** @var \stdClass Course 1 record. */
+    protected $course1;
+
+    /** @var \stdClass Course 2 record. */
+    protected $course2;
+
+    /** @var \stdClass To store student user record. */
+    protected $student1;
+
+    /** @var \stdClass To store student user record. */
+    protected $student2;
+
+    /** @var \stdClass To store Teacher user record. */
+    protected $teacher;
+
+    /** @var array To store student 1 and the rawgrade 1. */
+    protected $student1grade1 = [];
+
+    /** @var array To store student 1 and the rawgrade 2. */
+    protected $student1grade2 = [];
+
+    /** @var array To store student 2 and the rawgrade. */
+    protected $student2grade = [];
+
+    /**
+     * Set up for every test
+     */
+    public function setUp(): void {
+        global $DB;
+        $this->resetAfterTest(true);
+
+        $s1grade1 = 80;
+        $s1grade2 = 40;
+        $s2grade = 60;
+
+        $this->course1 = $this->getDataGenerator()->create_course();
+        $this->course2 = $this->getDataGenerator()->create_course();
+
+        $studentrole = $DB->get_record('role', array('shortname' => 'student'));
+        $teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));
+        $this->student1 = $this->getDataGenerator()->create_user();
+        $this->teacher = $this->getDataGenerator()->create_user();
+        $this->getDataGenerator()->enrol_user($this->teacher->id, $this->course1->id, $teacherrole->id);
+        $this->getDataGenerator()->enrol_user($this->student1->id, $this->course1->id, $studentrole->id);
+        $this->getDataGenerator()->enrol_user($this->student1->id, $this->course2->id, $studentrole->id);
+
+        $this->student2 = $this->getDataGenerator()->create_user();
+        $this->getDataGenerator()->enrol_user($this->student2->id, $this->course1->id, $studentrole->id);
+        $this->getDataGenerator()->enrol_user($this->student2->id, $this->course2->id, $studentrole->id);
+
+        $assignment1 = $this->getDataGenerator()->create_module('assign', array('name' => "Test assign", 'course' => $this->course1->id));
+        $assignment2 = $this->getDataGenerator()->create_module('assign', array('name' => "Test assign", 'course' => $this->course2->id));
+        $modcontext1 = get_coursemodule_from_instance('assign', $assignment1->id, $this->course1->id);
+        $modcontext2 = get_coursemodule_from_instance('assign', $assignment2->id, $this->course2->id);
+        $assignment1->cmidnumber = $modcontext1->id;
+        $assignment2->cmidnumber = $modcontext2->id;
+
+        $this->student1grade1 = array('userid' => $this->student1->id, 'rawgrade' => $s1grade1);
+        $this->student1grade2 = array('userid' => $this->student1->id, 'rawgrade' => $s1grade2);
+        $this->student2grade = array('userid' => $this->student2->id, 'rawgrade' => $s2grade);
+        $studentgrades = array($this->student1->id => $this->student1grade1, $this->student2->id => $this->student2grade);
+        assign_grade_item_update($assignment1, $studentgrades);
+        $studentgrades = array($this->student1->id => $this->student1grade2);
+        assign_grade_item_update($assignment2, $studentgrades);
+
+        grade_get_setting($this->course1->id, 'report_overview_showrank', 1);
+    }
+
+    /**
+     * Test get_course_grades function case student
+     */
+    public function test_get_course_grades_student(): void {
+
+        // A user can see his own grades in both courses.
+        $this->setUser($this->student1);
+        $studentgrades = gradereport_overview_external::get_course_grades();
+        $studentgrades = external_api::clean_returnvalue(gradereport_overview_external::get_course_grades_returns(), $studentgrades);
+
+        $this->assertCount(0, $studentgrades['warnings']);
+        $this->assertCount(2, $studentgrades['grades']);
+        foreach ($studentgrades['grades'] as $grade) {
+            if ($grade['courseid'] == $this->course1->id) {
+                $this->assertEquals(80.00, $grade['grade']);
+                $this->assertEquals(80.0000, $grade['rawgrade']);
+                $this->assertEquals(1, $grade['rank']);
+            } else {
+                $this->assertEquals(40.00, $grade['grade']);
+                $this->assertEquals(40.0000, $grade['rawgrade']);
+                $this->assertArrayNotHasKey('rank', $grade);
+            }
+        }
+
+        // Second student, no grade in one course.
+        $this->setUser($this->student2);
+        $studentgrades = gradereport_overview_external::get_course_grades();
+        $studentgrades = external_api::clean_returnvalue(gradereport_overview_external::get_course_grades_returns(), $studentgrades);
+
+        $this->assertCount(0, $studentgrades['warnings']);
+        $this->assertCount(2, $studentgrades['grades']);
+        foreach ($studentgrades['grades'] as $grade) {
+            if ($grade['courseid'] == $this->course1->id) {
+                $this->assertEquals(60.00, $grade['grade']);
+                $this->assertEquals(60.0000, $grade['rawgrade']);
+                $this->assertEquals(2, $grade['rank']);
+            } else {
+                $this->assertEquals('-', $grade['grade']);
+                $this->assertEmpty($grade['rawgrade']);
+                $this->assertArrayNotHasKey('rank', $grade);
+            }
+        }
+    }
+
+    /**
+     * Test get_course_grades function case admin
+     */
+    public function test_get_course_grades_admin(): void {
+
+        // A admin must see all student grades.
+        $this->setAdminUser();
+
+        $studentgrades = gradereport_overview_external::get_course_grades($this->student1->id);
+        $studentgrades = external_api::clean_returnvalue(gradereport_overview_external::get_course_grades_returns(), $studentgrades);
+        $this->assertCount(0, $studentgrades['warnings']);
+        $this->assertCount(2, $studentgrades['grades']);
+        foreach ($studentgrades['grades'] as $grade) {
+            if ($grade['courseid'] == $this->course1->id) {
+                $this->assertEquals(80.00, $grade['grade']);
+                $this->assertEquals(80.0000, $grade['rawgrade']);
+            } else {
+                $this->assertEquals(40.00, $grade['grade']);
+                $this->assertEquals(40.0000, $grade['rawgrade']);
+            }
+        }
+
+        $studentgrades = gradereport_overview_external::get_course_grades($this->student2->id);
+        $studentgrades = external_api::clean_returnvalue(gradereport_overview_external::get_course_grades_returns(), $studentgrades);
+        $this->assertCount(0, $studentgrades['warnings']);
+        $this->assertCount(2, $studentgrades['grades']);
+
+        // Admins don't see grades.
+        $studentgrades = gradereport_overview_external::get_course_grades();
+        $studentgrades = external_api::clean_returnvalue(gradereport_overview_external::get_course_grades_returns(), $studentgrades);
+        $this->assertCount(0, $studentgrades['warnings']);
+        $this->assertCount(0, $studentgrades['grades']);
+    }
+
+    /**
+     * Test get_course_grades function case teacher
+     */
+    public function test_get_course_grades_teacher(): void {
+        // Teachers don't see grades.
+        $this->setUser($this->teacher);
+
+        $studentgrades = gradereport_overview_external::get_course_grades();
+        $studentgrades = external_api::clean_returnvalue(gradereport_overview_external::get_course_grades_returns(), $studentgrades);
+        $this->assertCount(0, $studentgrades['warnings']);
+        $this->assertCount(0, $studentgrades['grades']);
+    }
+
+    /**
+     * Test get_course_grades function case incorrect permissions
+     */
+    public function test_get_course_grades_permissions(): void {
+        // Student can't see other student grades.
+        $this->setUser($this->student2);
+
+        $this->expectException('required_capability_exception');
+        $studentgrade = gradereport_overview_external::get_course_grades($this->student1->id);
+    }
+
+    /**
+     * Test view_grade_report function
+     */
+    public function test_view_grade_report(): void {
+        global $USER;
+
+        // Redirect events to the sink, so we can recover them later.
+        $sink = $this->redirectEvents();
+
+        $this->setUser($this->student1);
+        $result = gradereport_overview_external::view_grade_report($this->course1->id);
+        $result = external_api::clean_returnvalue(gradereport_overview_external::view_grade_report_returns(), $result);
+        $events = $sink->get_events();
+        $this->assertCount(1, $events);
+        $event = reset($events);
+
+        // Check the event details are correct.
+        $this->assertInstanceOf('\gradereport_overview\event\grade_report_viewed', $event);
+        $this->assertEquals(\context_course::instance($this->course1->id), $event->get_context());
+        $this->assertEquals($USER->id, $event->get_data()['relateduserid']);
+
+        $this->setUser($this->teacher);
+        $result = gradereport_overview_external::view_grade_report($this->course1->id, $this->student1->id);
+        $result = external_api::clean_returnvalue(gradereport_overview_external::view_grade_report_returns(), $result);
+        $events = $sink->get_events();
+        $event = reset($events);
+        $sink->close();
+
+        // Check the event details are correct.
+        $this->assertInstanceOf('\gradereport_overview\event\grade_report_viewed', $event);
+        $this->assertEquals(\context_course::instance($this->course1->id), $event->get_context());
+        $this->assertEquals($this->student1->id, $event->get_data()['relateduserid']);
+    }
+
+    /**
+     * Test view_grade_report_permissions function
+     */
+    public function test_view_grade_report_permissions(): void {
+        $this->setUser($this->student2);
+
+        $this->expectException('moodle_exception');
+        $studentgrade = gradereport_overview_external::view_grade_report($this->course1->id, $this->student1->id);
+    }
+}

grade/report/overview/tests/lib_test.php

@@ -0,0 +1,125 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle 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 General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace gradereport_overview;
+
+/**
+ * Overview grade report lib functions unit tests
+ *
+ * @package gradereport_overview
+ * @copyright 2023 The Open University
+ * @covers \grade_report_overview
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class lib_test extends \advanced_testcase {
+
+    /**
+     * Require the library file we're about to test, and other requirements.
+     */
+    protected function setUp(): void {
+        global $CFG;
+        require_once($CFG->dirroot . '/grade/report/overview/lib.php');
+        require_once($CFG->dirroot . '/grade/querylib.php');
+    }
+
+    /**
+     * Data provider for true or false value.
+     *
+     * @return array Two options, one with true and one with false
+     */
+    public function true_or_false(): array {
+        return [
+            [true],
+            [false]
+        ];
+    }
+
+    /**
+     * Tests the regrade_all_courses_if_needed function, which is supposed to regrade all the
+     * courses that the current user is enrolled on (if they need update).
+     *
+     * This is tested with both frontend and backend - the frontend option should not actually
+     * do the progress bar/continue button (which can't be tested from here because it calls exit)
+     * because these courses are small.
+     *
+     * @dataProvider true_or_false
+     * @param bool $frontend True to use the front-end parameter to the function under test
+     */
+    public function test_regrade_all_courses_if_needed(bool $frontend): void {
+        global $DB;
+        $this->resetAfterTest(true);
+
+        $generator = $this->getDataGenerator();
+
+        // Create 3 courses and a test user. The test user belongs to 2 of them, while another user
+        // belongs to the other course.
+        $user = $generator->create_user();
+        $otheruser = $generator->create_user();
+        $course1 = $generator->create_course();
+        $generator->enrol_user($user->id, $course1->id, 'student');
+        $course2 = $generator->create_course();
+        $generator->enrol_user($otheruser->id, $course2->id, 'student');
+        $course3 = $generator->create_course();
+        $generator->enrol_user($user->id, $course3->id, 'student');
+
+        // We need permission to create grades (even though it's a data generator).
+        $this->setAdminUser();
+
+        // Set up each course grade.
+        foreach ([$course1, $course2, $course3] as $course) {
+            // Create an assignment and get its grade item.
+            $assign = $generator->create_module('assign', ['course' => $course->id]);
+            $modinfo = get_fast_modinfo($course->id);
+            $cm = $modinfo->get_cm($assign->cmid);
+            $items = grade_get_grade_items_for_activity($cm, true);
+            $item = reset($items);
+
+            // Set a grade in the assignment, either for the normal test user or the other user
+            // depending on course.
+            if ($course === $course2) {
+                $userid = $otheruser->id;
+            } else {
+                $userid = $user->id;
+            }
+            $generator->create_grade_grade([
+                'itemid' => $item->id,
+                'userid' => $userid,
+                'teamsubmission' => false,
+                'attemptnumber' => 0,
+                'grade' => 50
+            ]);
+
+            // Bodge the final grade so that it needs regrading and is set wrong.
+            $course->gradeitemid = $DB->get_field('grade_items', 'id',
+                    ['courseid' => $course->id, 'itemtype' => 'course'], MUST_EXIST);
+            $DB->set_field('grade_items', 'needsupdate', 1, ['id' => $course->gradeitemid]);
+            $DB->set_field('grade_grades', 'finalgrade', 25.0, ['itemid' => $course->gradeitemid]);
+        }
+
+        // Construct the overview report and call regrade_all_courses_if_needed.
+        $gpr = new \stdClass();
+        $report = new \grade_report_overview($user->id, $gpr, '');
+        $report->regrade_all_courses_if_needed($frontend);
+
+        // This should have regraded courses 1 and 3, but not 2 (because the user doesn't belong).
+        $this->assertEqualsWithDelta(50.0, $DB->get_field('grade_grades', 'finalgrade',
+                ['itemid' => $course1->gradeitemid]), 1.0);
+        $this->assertEqualsWithDelta(25.0, $DB->get_field('grade_grades', 'finalgrade',
+                ['itemid' => $course2->gradeitemid]), 1.0);
+        $this->assertEqualsWithDelta(50.0, $DB->get_field('grade_grades', 'finalgrade',
+                ['itemid' => $course3->gradeitemid]), 1.0);
+    }
+}