Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
<?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/>.

/**
 * Unit tests for assignfeedback_editpdf.
 *
 * @package    assignfeedback_editpdf
 * @copyright  2018 Adrian Greeve <adrian@moodle.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
namespace assignfeedback_editpdf\privacy;

defined('MOODLE_INTERNAL') || die();

global $CFG;
require_once($CFG->dirroot . '/mod/assign/locallib.php');
require_once($CFG->dirroot . '/mod/assign/tests/privacy/provider_test.php');

use assignfeedback_editpdf\page_editor;
use mod_assign\privacy\assign_plugin_request_data;

/**
 * Unit tests for mod/assign/feedback/editpdf/classes/privacy/
 *
 * @copyright  2018 Adrian Greeve <adrian@moodle.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class provider_test extends \mod_assign\privacy\provider_test {

    public function setUp(): void {
        // Skip this test if ghostscript is not supported.
        $result = \assignfeedback_editpdf\pdf::test_gs_path(false);
        if ($result->status !== \assignfeedback_editpdf\pdf::GSPATH_OK) {
            $this->markTestSkipped('Ghostscript not setup');
            return;
        }
        parent::setUp();
    }

    /**
     * Convenience function for creating feedback data.
     *
     * @param  object   $assign         assign object
< * @param stdClass $student user object < * @param stdClass $teacher user object
> * @param \stdClass $student user object > * @param \stdClass $teacher user object
* @return array Feedback plugin object and the grade object. */ protected function create_feedback($assign, $student, $teacher) { global $CFG; // Create a file submission with the test pdf. $submission = $assign->get_user_submission($student->id, true); $this->setUser($student->id); $fs = get_file_storage(); $pdfsubmission = (object) array( 'contextid' => $assign->get_context()->id, 'component' => 'assignsubmission_file', 'filearea' => ASSIGNSUBMISSION_FILE_FILEAREA, 'itemid' => $submission->id, 'filepath' => '/', 'filename' => 'submission.pdf' ); $sourcefile = $CFG->dirroot.'/mod/assign/feedback/editpdf/tests/fixtures/submission.pdf'; $fi = $fs->create_file_from_pathname($pdfsubmission, $sourcefile); $data = new \stdClass(); $plugin = $assign->get_submission_plugin_by_type('file'); $plugin->save($submission, $data); $this->setUser($teacher->id); $plugin = $assign->get_feedback_plugin_by_type('editpdf'); $grade = $assign->get_user_grade($student->id, true); $comment = new \assignfeedback_editpdf\comment(); $comment->rawtext = 'Comment text'; $comment->width = 100; $comment->x = 100; $comment->y = 100; $comment->colour = 'red'; page_editor::set_comments($grade->id, 0, [$comment]); $annotation = new \assignfeedback_editpdf\annotation(); $annotation->path = ''; $annotation->x = 100; $annotation->y = 100; $annotation->endx = 200; $annotation->endy = 200; $annotation->type = 'line'; $annotation->colour = 'red'; page_editor::set_annotations($grade->id, 0, [$annotation]); $comments = page_editor::get_comments($grade->id, 0, true); $annotations = page_editor::get_annotations($grade->id, 0, false); page_editor::release_drafts($grade->id); $storedfile = \assignfeedback_editpdf\document_services::generate_feedback_document($assign->get_instance()->id, $student->id, $grade->attemptnumber); return [$plugin, $grade, $storedfile]; } /** * Quick test to make sure that get_metadata returns something. */ public function test_get_metadata() { $collection = new \core_privacy\local\metadata\collection('assignfeedback_editpdf'); $collection = \assignfeedback_editpdf\privacy\provider::get_metadata($collection); $this->assertNotEmpty($collection); } /** * Test that feedback comments are exported for a user. */ public function test_export_feedback_user_data() { $this->resetAfterTest(); // Create course, assignment, submission, and then a feedback comment. $course = $this->getDataGenerator()->create_course(); // Student. $user1 = $this->getDataGenerator()->create_user(); // Teacher. $user2 = $this->getDataGenerator()->create_user(); $this->getDataGenerator()->enrol_user($user1->id, $course->id, 'student'); $this->getDataGenerator()->enrol_user($user2->id, $course->id, 'editingteacher'); $assign = $this->create_instance(['course' => $course, 'assignsubmission_file_enabled' => 1, 'assignsubmission_file_maxfiles' => 1, 'assignfeedback_editpdf_enabled' => 1, 'assignsubmission_file_maxsizebytes' => 1000000]); $context = $assign->get_context(); list($plugin, $grade, $storedfile) = $this->create_feedback($assign, $user1, $user2); // Check that we have data. $this->assertFalse($plugin->is_empty($grade)); $writer = \core_privacy\local\request\writer::with_context($context); $this->assertFalse($writer->has_any_data()); // The student should be able to see the teachers feedback. $exportdata = new \mod_assign\privacy\assign_plugin_request_data($context, $assign, $grade, [], $user1); \assignfeedback_editpdf\privacy\provider::export_feedback_user_data($exportdata); // print_object($writer->get_files([get_string('privacy:path', 'assignfeedback_editpdf')])); // print_object($writer->get_files(['PDF feedback', $storedfile->get_filename()])); $pdffile = $writer->get_files([get_string('privacy:path', 'assignfeedback_editpdf')])[$storedfile->get_filename()]; // The writer should have returned a stored file. $this->assertInstanceOf('stored_file', $pdffile); } /** * Test that all feedback is deleted for a context. */ public function test_delete_feedback_for_context() { $this->resetAfterTest(); // Create course, assignment, submission, and then a feedback comment. $course = $this->getDataGenerator()->create_course(); // Students. $user1 = $this->getDataGenerator()->create_user(); $user2 = $this->getDataGenerator()->create_user(); // Teacher. $user3 = $this->getDataGenerator()->create_user(); $this->getDataGenerator()->enrol_user($user1->id, $course->id, 'student'); $this->getDataGenerator()->enrol_user($user2->id, $course->id, 'student'); $this->getDataGenerator()->enrol_user($user3->id, $course->id, 'editingteacher'); $assign = $this->create_instance(['course' => $course, 'assignsubmission_file_enabled' => 1, 'assignsubmission_file_maxfiles' => 1, 'assignfeedback_editpdf_enabled' => 1, 'assignsubmission_file_maxsizebytes' => 1000000]); $context = $assign->get_context(); list($plugin1, $grade1, $storedfile1) = $this->create_feedback($assign, $user1, $user3); list($plugin2, $grade2, $storedfile2) = $this->create_feedback($assign, $user2, $user3); // Check that we have data. $this->assertFalse($plugin1->is_empty($grade1)); $this->assertFalse($plugin2->is_empty($grade2)); $requestdata = new assign_plugin_request_data($context, $assign); \assignfeedback_editpdf\privacy\provider::delete_feedback_for_context($requestdata); // Check that we now have no data. $this->assertTrue($plugin1->is_empty($grade1)); $this->assertTrue($plugin2->is_empty($grade2)); } /** * Test that a grade item is deleted for a user. */ public function test_delete_feedback_for_grade() { $this->resetAfterTest(); // Create course, assignment, submission, and then a feedback comment. $course = $this->getDataGenerator()->create_course(); // Students. $user1 = $this->getDataGenerator()->create_user(); $user2 = $this->getDataGenerator()->create_user(); // Teacher. $user3 = $this->getDataGenerator()->create_user(); $this->getDataGenerator()->enrol_user($user1->id, $course->id, 'student'); $this->getDataGenerator()->enrol_user($user2->id, $course->id, 'student'); $this->getDataGenerator()->enrol_user($user3->id, $course->id, 'editingteacher'); $assign = $this->create_instance(['course' => $course, 'assignsubmission_file_enabled' => 1, 'assignsubmission_file_maxfiles' => 1, 'assignfeedback_editpdf_enabled' => 1, 'assignsubmission_file_maxsizebytes' => 1000000]); $context = $assign->get_context(); list($plugin1, $grade1, $storedfile1) = $this->create_feedback($assign, $user1, $user3); list($plugin2, $grade2, $storedfile2) = $this->create_feedback($assign, $user2, $user3); // Check that we have data. $this->assertFalse($plugin1->is_empty($grade1)); $this->assertFalse($plugin2->is_empty($grade2)); $requestdata = new assign_plugin_request_data($context, $assign, $grade1, [], $user1); \assignfeedback_editpdf\privacy\provider::delete_feedback_for_grade($requestdata); // Check that we now have no data for user 1. $this->assertTrue($plugin1->is_empty($grade1)); // Check that user 2 data is still there. $this->assertFalse($plugin2->is_empty($grade2)); } /** * Test that a grade item is deleted for a user. */ public function test_delete_feedback_for_grades() { global $DB; $this->resetAfterTest(); // Create course, assignment, submission, and then a feedback comment. $course = $this->getDataGenerator()->create_course(); // Students. $user1 = $this->getDataGenerator()->create_user(); $user2 = $this->getDataGenerator()->create_user(); $user3 = $this->getDataGenerator()->create_user(); $user4 = $this->getDataGenerator()->create_user(); // Teacher. $user5 = $this->getDataGenerator()->create_user(); $this->getDataGenerator()->enrol_user($user1->id, $course->id, 'student'); $this->getDataGenerator()->enrol_user($user2->id, $course->id, 'student'); $this->getDataGenerator()->enrol_user($user3->id, $course->id, 'student'); $this->getDataGenerator()->enrol_user($user4->id, $course->id, 'student'); $this->getDataGenerator()->enrol_user($user5->id, $course->id, 'editingteacher'); $assign1 = $this->create_instance(['course' => $course, 'assignsubmission_file_enabled' => 1, 'assignsubmission_file_maxfiles' => 1, 'assignfeedback_editpdf_enabled' => 1, 'assignsubmission_file_maxsizebytes' => 1000000]); $assign2 = $this->create_instance(['course' => $course, 'assignsubmission_file_enabled' => 1, 'assignsubmission_file_maxfiles' => 1, 'assignfeedback_editpdf_enabled' => 1, 'assignsubmission_file_maxsizebytes' => 1000000]); $context = $assign1->get_context(); list($plugin1, $grade1, $storedfile1) = $this->create_feedback($assign1, $user1, $user5); list($plugin2, $grade2, $storedfile2) = $this->create_feedback($assign1, $user2, $user5); list($plugin3, $grade3, $storedfile3) = $this->create_feedback($assign1, $user3, $user5); list($plugin4, $grade4, $storedfile4) = $this->create_feedback($assign2, $user3, $user5); list($plugin5, $grade5, $storedfile5) = $this->create_feedback($assign2, $user4, $user5); // Check that we have data. $this->assertFalse($plugin1->is_empty($grade1)); $this->assertFalse($plugin2->is_empty($grade2)); $this->assertFalse($plugin3->is_empty($grade3)); $this->assertFalse($plugin4->is_empty($grade4)); $this->assertFalse($plugin5->is_empty($grade5)); // Check that there are also files generated. $files = $DB->get_records('files', ['component' => 'assignfeedback_editpdf', 'filearea' => 'download']); $this->assertCount(10, $files); $deletedata = new assign_plugin_request_data($context, $assign1); $deletedata->set_userids([$user1->id, $user3->id]); $deletedata->populate_submissions_and_grades(); \assignfeedback_editpdf\privacy\provider::delete_feedback_for_grades($deletedata); // Check that we now have no data for user 1. $this->assertTrue($plugin1->is_empty($grade1)); // Check that user 2 data is still there. $this->assertFalse($plugin2->is_empty($grade2)); // User 3 in assignment 1 should be gone. $this->assertTrue($plugin3->is_empty($grade3)); // User 3 in assignment 2 should still be here. $this->assertFalse($plugin4->is_empty($grade4)); // User 4 in assignment 2 should also still be here. $this->assertFalse($plugin5->is_empty($grade5)); // Check the files as well. $files = $DB->get_records('files', ['component' => 'assignfeedback_editpdf', 'filearea' => 'download']); // We should now only have six records here. $this->assertCount(6, $files); } }