Gecko [ admjudic.com.br ]

Name	Size	Permission
behat	[ DIR ]	drwxr-xr-x
generator	[ DIR ]	drwxr-xr-x
dates_test.php	4.24 KB	-rw-r--r--
group_completion_email_test.ph...	9.88 KB	-rw-r--r--
privacy_provider_test.php	24.57 KB	-rw-r--r--
student_comment_test.php	9.88 KB	-rw-r--r--

Code Editor : privacy_provider_test.php

<?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/>.

/**
 * Privacy provider tests
 *
 * @package   mod_checklist
 * @copyright 2018 Davo Smith
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace mod_checklist;

use core_privacy\local\metadata\collection;
use mod_checklist\local\checklist_comment_student;
use mod_checklist\privacy\provider;

/**
 * Class mod_checklist_privacy_provider_testcase
 * @covers \mod_checklist\privacy\provider
 */
class privacy_provider_test extends \core_privacy\tests\provider_testcase {
    /** @var \stdClass The student object. */
    protected $student;

/** @var \stdClass[] The checklist objects. */
    protected $checklists = [];

/** @var \stdClass The course object. */
    protected $course;

/**
     * {@inheritdoc}
     */
    protected function setUp(): void {
        $this->resetAfterTest();

global $DB;
        $gen = self::getDataGenerator();
        $this->course = $gen->create_course();

// Create 4 checklists.
        /** @var \mod_checklist_generator $plugingen */
        $plugingen = $gen->get_plugin_generator('mod_checklist');
        $params = [
            'course' => $this->course->id,
        ];
        $this->checklists = [];
        $this->checklists[] = $plugingen->create_instance($params);
        $this->checklists[] = $plugingen->create_instance($params);
        $this->checklists[] = $plugingen->create_instance($params);
        $this->checklists[] = $plugingen->create_instance($params);

$itemtexts = ['First item', 'Second item', 'Third item'];
        foreach ($this->checklists as $checklist) {
            $position = 1;
            foreach ($itemtexts as $text) {
                $item = new \mod_checklist\local\checklist_item([], false);
                $item->checklist = $checklist->id;
                $item->userid = 0;
                $item->displaytext = $text;
                $item->position = $position++;
                $item->insert();
            }
        }

// Create a student who will add data to these checklists.
        $this->student = $gen->create_user();
        $studentrole = $DB->get_record('role', ['shortname' => 'student']);
        $gen->enrol_user($this->student->id, $this->course->id, $studentrole->id);

// The first checklist includes checkmarks from the student.
        /** @var \mod_checklist\local\checklist_item[] $items */
        $items = \mod_checklist\local\checklist_item::fetch_all(['checklist' => $this->checklists[0]->id], true);
        $items = array_values($items);
        $items[0]->set_checked_student($this->student->id, true);
        $items[2]->set_checked_student($this->student->id, true);
        // Add 2 student comments to first checklist.
        $this->setUser($this->student);
        checklist_comment_student::update_or_create_student_comment($items[0]->id, 'comment 1');
        checklist_comment_student::update_or_create_student_comment($items[2]->id, 'comment 2');

// The second checklist includes custom items created by the student.
        $item = new \mod_checklist\local\checklist_item([], false);
        $item->checklist = $this->checklists[1]->id;
        $item->displaytext = 'Student private item';
        $item->position = 1;
        $item->userid = $this->student->id;
        $item->insert();

// The third checklist includes comments made by a teacher about the student.
        $items = \mod_checklist\local\checklist_item::fetch_all(['checklist' => $this->checklists[2]->id], true);
        $items = array_values($items);
        $comment = new \mod_checklist\local\checklist_comment([], false);
        $comment->itemid = $items[1]->id;
        $comment->userid = $this->student->id;
        $comment->text = 'A comment added about a student';
        $comment->insert();

// It also contains another student comment.
        checklist_comment_student::update_or_create_student_comment($items[1]->id, 'A comment added from a student');

// The fourth checklist does not include any user data for the given student.
    }

/**
     * Test for provider::get_metadata().
     */
    public function test_get_metadata(): void {
        $collection = new collection('mod_checklist');
        $newcollection = provider::get_metadata($collection);
        $itemcollection = $newcollection->get_collection();
        $this->assertCount(5, $itemcollection);

$table = array_shift($itemcollection);
        $this->assertEquals('checklist_item', $table->get_name());
        $privacyfields = $table->get_privacy_fields();
        $this->assertArrayHasKey('checklist', $privacyfields);
        $this->assertArrayHasKey('userid', $privacyfields);
        $this->assertArrayHasKey('displaytext', $privacyfields);
        $this->assertEquals('privacy:metadata:checklist_item', $table->get_summary());
        foreach ($privacyfields as $field) {
            get_string($field, 'mod_checklist');
        }
        get_string($table->get_summary(), 'mod_checklist');

$table = array_shift($itemcollection);
        $this->assertEquals('checklist_check', $table->get_name());
        $privacyfields = $table->get_privacy_fields();
        $this->assertArrayHasKey('item', $privacyfields);
        $this->assertArrayHasKey('userid', $privacyfields);
        $this->assertArrayHasKey('usertimestamp', $privacyfields);
        $this->assertArrayHasKey('teachermark', $privacyfields);
        $this->assertArrayHasKey('teachertimestamp', $privacyfields);
        $this->assertArrayHasKey('teacherid', $privacyfields);
        $this->assertEquals('privacy:metadata:checklist_check', $table->get_summary());
        foreach ($privacyfields as $field) {
            get_string($field, 'mod_checklist');
        }
        get_string($table->get_summary(), 'mod_checklist');

$table = array_shift($itemcollection);
        $this->assertEquals('checklist_comment', $table->get_name());
        $privacyfields = $table->get_privacy_fields();
        $this->assertArrayHasKey('itemid', $privacyfields);
        $this->assertArrayHasKey('userid', $privacyfields);
        $this->assertArrayHasKey('commentby', $privacyfields);
        $this->assertArrayHasKey('text', $privacyfields);
        $this->assertEquals('privacy:metadata:checklist_comment', $table->get_summary());
        foreach ($privacyfields as $field) {
            get_string($field, 'mod_checklist');
        }
        get_string($table->get_summary(), 'mod_checklist');

$table = array_shift($itemcollection);
        $this->assertEquals('checklist_comment_student', $table->get_name());
        $privacyfields = $table->get_privacy_fields();
        $this->assertArrayHasKey('itemid', $privacyfields);
        $this->assertArrayHasKey('usermodified', $privacyfields);
        $this->assertArrayHasKey('text', $privacyfields);
        $this->assertEquals('privacy:metadata:checklist_comment_student', $table->get_summary());
        foreach ($privacyfields as $field) {
            get_string($field, 'mod_checklist');
        }
        get_string($table->get_summary(), 'mod_checklist');
    }

/**
     * Test for provider::get_contexts_for_userid().
     */
    public function test_get_contexts_for_userid(): void {
        $cms = [
            get_coursemodule_from_instance('checklist', $this->checklists[0]->id),
            get_coursemodule_from_instance('checklist', $this->checklists[1]->id),
            get_coursemodule_from_instance('checklist', $this->checklists[2]->id),
            get_coursemodule_from_instance('checklist', $this->checklists[3]->id),
        ];
        $expectedctxs = [
            \context_module::instance($cms[0]->id),
            \context_module::instance($cms[1]->id),
            \context_module::instance($cms[2]->id),
        ];
        $expectedctxids = [];
        foreach ($expectedctxs as $ctx) {
            $expectedctxids[] = $ctx->id;
        }
        $contextlist = provider::get_contexts_for_userid($this->student->id);
        $this->assertCount(3, $contextlist);
        $uctxids = [];
        foreach ($contextlist as $uctx) {
            $uctxids[] = $uctx->id;
        }
        $this->assertEmpty(array_diff($expectedctxids, $uctxids));
        $this->assertEmpty(array_diff($uctxids, $expectedctxids));
    }

/**
     * Test for provider::export_user_data().
     */
    public function test_export_for_context(): void {
        $cms = [
            get_coursemodule_from_instance('checklist', $this->checklists[0]->id),
            get_coursemodule_from_instance('checklist', $this->checklists[1]->id),
            get_coursemodule_from_instance('checklist', $this->checklists[2]->id),
            get_coursemodule_from_instance('checklist', $this->checklists[3]->id),
        ];
        $ctxs = [
            \context_module::instance($cms[0]->id),
            \context_module::instance($cms[1]->id),
            \context_module::instance($cms[2]->id),
            \context_module::instance($cms[3]->id),
        ];

// Export all of the data for the context.
        $this->export_context_data_for_user($this->student->id, $ctxs[0], 'mod_checklist');
        $writer = \core_privacy\local\request\writer::with_context($ctxs[0]);
        $this->assertTrue($writer->has_any_data());

$this->export_context_data_for_user($this->student->id, $ctxs[1], 'mod_checklist');
        $writer = \core_privacy\local\request\writer::with_context($ctxs[1]);
        $this->assertTrue($writer->has_any_data());

$this->export_context_data_for_user($this->student->id, $ctxs[2], 'mod_checklist');
        $writer = \core_privacy\local\request\writer::with_context($ctxs[2]);
        $this->assertTrue($writer->has_any_data());

$this->export_context_data_for_user($this->student->id, $ctxs[3], 'mod_checklist');
        $writer = \core_privacy\local\request\writer::with_context($ctxs[3]);
        $this->assertFalse($writer->has_any_data());
    }

/**
     * Test for provider::delete_data_for_all_users_in_context().
     */
    public function test_delete_data_for_all_users_in_context(): void {
        global $DB;

$gen = self::getDataGenerator();

// Create another student who will check-off some items in the second checklist.
        $student = $gen->create_user();
        $studentrole = $DB->get_record('role', ['shortname' => 'student']);
        $gen->enrol_user($student->id, $this->course->id, $studentrole->id);

/** @var \mod_checklist\local\checklist_item[] $items */
        $items = \mod_checklist\local\checklist_item::fetch_all(['checklist' => $this->checklists[1]->id]);
        $items = array_values($items);
        $items[1]->set_checked_student($student->id, true);
        // Add one student comment to second checklist.
        checklist_comment_student::update_or_create_student_comment($items[1]->id, 'comment by another student');

// Before deletion, we should have 3 checked off items, 1 custom item, 1 comment, 3 student comments and 13 total items.
        $this->assertEquals(3, $DB->count_records_select('checklist_check', 'usertimestamp > 0'));
        $this->assertEquals(1, $DB->count_records_select('checklist_item', 'userid <> 0'));
        $this->assertEquals(1, $DB->count_records('checklist_comment', []));
        $this->assertEquals(13, $DB->count_records('checklist_item', []));
        $this->assertEquals(4, $DB->count_records('checklist_comment_student', []));

// Delete data from the first checklist.
        $cm = get_coursemodule_from_instance('checklist', $this->checklists[0]->id);
        $cmcontext = \context_module::instance($cm->id);
        provider::delete_data_for_all_users_in_context($cmcontext);
        // After deletion, there should be 1 item checked-off, 1 custom item, 1 comment, 1 student comment and 13 total items.
        $this->assertEquals(1, $DB->count_records_select('checklist_check', 'usertimestamp > 0'));
        $this->assertEquals(1, $DB->count_records_select('checklist_item', 'userid <> 0'));
        $this->assertEquals(1, $DB->count_records('checklist_comment', []));
        $this->assertEquals(13, $DB->count_records('checklist_item', []));
        $this->assertEquals(2, $DB->count_records('checklist_comment_student', []));

// Delete data from the second checklist.
        $cm = get_coursemodule_from_instance('checklist', $this->checklists[1]->id);
        $cmcontext = \context_module::instance($cm->id);
        provider::delete_data_for_all_users_in_context($cmcontext);
        // After deletion, there should be 0 items checked-off, 0 custom items, 1 comment, 0 student comments and 12 total items.
        $this->assertEquals(0, $DB->count_records_select('checklist_check', 'usertimestamp > 0'));
        $this->assertEquals(0, $DB->count_records_select('checklist_item', 'userid <> 0'));
        $this->assertEquals(1, $DB->count_records('checklist_comment', []));
        $this->assertEquals(1, $DB->count_records('checklist_comment_student', []));
        $this->assertEquals(12, $DB->count_records('checklist_item', []));

// Delete data from the third checklist.
        $cm = get_coursemodule_from_instance('checklist', $this->checklists[2]->id);
        $cmcontext = \context_module::instance($cm->id);
        provider::delete_data_for_all_users_in_context($cmcontext);
        // After deletion, there should be 0 items checked-off, 0 custom items, 0 comment and 12 total items.
        $this->assertEquals(0, $DB->count_records_select('checklist_check', 'usertimestamp > 0'));
        $this->assertEquals(0, $DB->count_records_select('checklist_item', 'userid <> 0'));
        $this->assertEquals(0, $DB->count_records('checklist_comment', []));
        $this->assertEquals(12, $DB->count_records('checklist_item', []));
        $this->assertEquals(0, $DB->count_records('checklist_comment_student', []));
    }

/**
     * Test for provider::delete_data_for_user().
     */
    public function test_delete_data_for_user(): void {
        global $DB;

$gen = self::getDataGenerator();
        $cms = [
            get_coursemodule_from_instance('checklist', $this->checklists[0]->id),
            get_coursemodule_from_instance('checklist', $this->checklists[1]->id),
            get_coursemodule_from_instance('checklist', $this->checklists[2]->id),
            get_coursemodule_from_instance('checklist', $this->checklists[3]->id),
        ];
        $ctxs = [];
        foreach ($cms as $cm) {
            $ctxs[] = \context_module::instance($cm->id);
        }

// Create a second student who will gain some check-off, custom item + comment data in the first checklist.
        $student = $gen->create_user();
        $studentrole = $DB->get_record('role', ['shortname' => 'student']);
        $gen->enrol_user($this->student->id, $this->course->id, $studentrole->id);

/** @var \mod_checklist\local\checklist_item[] $items */
        $items = \mod_checklist\local\checklist_item::fetch_all(['checklist' => $this->checklists[0]->id], true);
        $items = array_values($items);
        $items[1]->set_checked_student($student->id, true);

// Use the student id in persistent 'usermodified' key instead of the auto assigned 0 id.
        $this->setUser($student);
        checklist_comment_student::update_or_create_student_comment($items[1]->id, 'another comment by student');

$item = new \mod_checklist\local\checklist_item([], false);
        $item->checklist = $this->checklists[1]->id;
        $item->displaytext = 'Student 2\'s private item';
        $item->position = 2;
        $item->userid = $student->id;
        $item->insert();

$comment = new \mod_checklist\local\checklist_comment([], false);
        $comment->itemid = $items[1]->id;
        $comment->userid = $student->id;
        $comment->text = 'A comment added about student 2';
        $comment->insert();

// Before deletion, we should have 3 checked off items, 2 custom items, 2 comments, 4 student comments, and 14 total items.
        $this->assertEquals(3, $DB->count_records_select('checklist_check', 'usertimestamp > 0'));
        $this->assertEquals(2, $DB->count_records_select('checklist_item', 'userid <> 0'));
        $this->assertEquals(2, $DB->count_records('checklist_comment', []));
        $this->assertEquals(14, $DB->count_records('checklist_item', []));
        $this->assertEquals(4, $DB->count_records('checklist_comment_student', []));

// Delete the data for the first student, but only for the first checklist.
        $contextlist = new \core_privacy\local\request\approved_contextlist($this->student, 'checklist',
                                                                            [$ctxs[0]->id]);
        provider::delete_data_for_user($contextlist);

// After deletion, we should have 1 checked off item, 2 custom items, 2 comments, 2 student comments and 14 total items.
        $this->assertEquals(1, $DB->count_records_select('checklist_check', 'usertimestamp > 0'));
        $this->assertEquals(2, $DB->count_records_select('checklist_item', 'userid <> 0'));
        $this->assertEquals(2, $DB->count_records('checklist_comment', []));
        $this->assertEquals(14, $DB->count_records('checklist_item', []));
        $this->assertEquals(2, $DB->count_records('checklist_comment_student', []));
        // Confirm the remaining checked-off item is for the second student.
        $this->assertEquals($student->id, $DB->get_field('checklist_check', 'userid', []));
        // Confirm remaining student comments are for the second student and for the first student but in another other checklist.
        $this->assertEquals($student->id, $DB->get_field('checklist_comment_student', 'usermodified', ['itemid' => $items[1]->id]));
        $items = \mod_checklist\local\checklist_item::fetch_all(['checklist' => $this->checklists[2]->id], true);
        $item = array_slice($items, 1, 1);  // Second item is where our other student comment is.
        $this->assertEquals($this->student->id, $DB->get_field('checklist_comment_student', 'usermodified',
            ['itemid' => $item[0]->id]));

// Delete the data for the first student, for all checklists.
        $contextids = [$ctxs[0]->id, $ctxs[1]->id, $ctxs[2]->id, $ctxs[3]->id];
        $contextlist = new \core_privacy\local\request\approved_contextlist($this->student, 'checklist', $contextids);
        provider::delete_data_for_user($contextlist);

// After deletion, we should have 1 checked off item, 1 custom item, 1 comment and 13 total items.
        $this->assertEquals(1, $DB->count_records_select('checklist_check', 'usertimestamp > 0'));
        $this->assertEquals(1, $DB->count_records_select('checklist_item', 'userid <> 0'));
        $this->assertEquals(1, $DB->count_records('checklist_comment', []));
        $this->assertEquals(13, $DB->count_records('checklist_item', []));
        $this->assertEquals(1, $DB->count_records('checklist_comment_student', []));
        // Confirm the remaining data is for the second student.
        $this->assertEquals($student->id, $DB->get_field('checklist_check', 'userid', []));
        $this->assertEquals($student->id, $DB->get_field_select('checklist_item', 'userid', 'userid <> 0'));
        $this->assertEquals($student->id, $DB->get_field('checklist_comment', 'userid', []));
        $this->assertEquals($student->id, $DB->get_field('checklist_comment_student', 'usermodified', []));
    }

/**
     * Extra setup stuff.
     * @return array
     */
    private function do_some_setup_in_another_function_so_travis_stops_complaining_about_it(): array {
        global $DB;

$cms = [
            get_coursemodule_from_instance('checklist', $this->checklists[0]->id),
            get_coursemodule_from_instance('checklist', $this->checklists[1]->id),
            get_coursemodule_from_instance('checklist', $this->checklists[2]->id),
            get_coursemodule_from_instance('checklist', $this->checklists[3]->id),
        ];
        $ctxs = [
            \context_module::instance($cms[0]->id),
            \context_module::instance($cms[1]->id),
            \context_module::instance($cms[2]->id),
            \context_module::instance($cms[3]->id),
        ];

// Create another student who will check-off some items in the second checklist.
        $gen = self::getDataGenerator();
        $student = $gen->create_user();
        $studentrole = $DB->get_record('role', ['shortname' => 'student']);
        $gen->enrol_user($student->id, $this->course->id, $studentrole->id);

return $ctxs;
    }

/**
     * Test provider::get_users_in_context()
     */
    public function test_get_users_in_context(): void {
        $ctxs = $this->do_some_setup_in_another_function_so_travis_stops_complaining_about_it();

$userlist = new \core_privacy\local\request\userlist($ctxs[0], 'mod_checklist');
        provider::get_users_in_context($userlist);
        $this->assertCount(1, $userlist);

$userlist = new \core_privacy\local\request\userlist($ctxs[1], 'mod_checklist');
        provider::get_users_in_context($userlist);
        $this->assertCount(2, $userlist);

$userlist = new \core_privacy\local\request\userlist($ctxs[2], 'mod_checklist');
        provider::get_users_in_context($userlist);
        $this->assertCount(1, $userlist);

$userlist = new \core_privacy\local\request\userlist($ctxs[3], 'mod_checklist');
        provider::get_users_in_context($userlist);
        $this->assertCount(0, $userlist);
    }

/**
     * Test provider::delete_data_for_users()
     */
    public function test_delete_data_for_users(): void {
        $ctxs = $this->do_some_setup_in_another_function_so_travis_stops_complaining_about_it();

// Initial userlist counts tested in test_get_users_in_context(), above.

// Delete all data for student in checklist 0.
        $approvedlist = new \core_privacy\local\request\approved_userlist($ctxs[0], 'mod_checklist', [$this->student->id]);
        provider::delete_data_for_users($approvedlist);

// Check user list for checklist 0.
        $userlist = new \core_privacy\local\request\userlist($ctxs[0], 'mod_checklist');
        provider::get_users_in_context($userlist);
        $this->assertCount(0, $userlist);

// Check user list for checklist 1.
        $userlist = new \core_privacy\local\request\userlist($ctxs[1], 'mod_checklist');
        provider::get_users_in_context($userlist);
        $this->assertCount(2, $userlist);

// Check user list for checklist 2.
        $userlist = new \core_privacy\local\request\userlist($ctxs[2], 'mod_checklist');
        provider::get_users_in_context($userlist);
        $this->assertCount(1, $userlist);

// Check user list for checklist 3.
        $userlist = new \core_privacy\local\request\userlist($ctxs[3], 'mod_checklist');
        provider::get_users_in_context($userlist);
        $this->assertCount(0, $userlist);

// Delete all data for student in checklist 1.
        $approvedlist = new \core_privacy\local\request\approved_userlist($ctxs[1], 'mod_checklist', [$this->student->id]);
        provider::delete_data_for_users($approvedlist);

}
}

${this.title}

Code Editor : privacy_provider_test.php