moodle/privacy/tests/contextlist_collection_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/>.

/**
 * Unit Tests for a the collection of contextlists class
 *
 * @package     core_privacy
 * @category    test
 * @copyright   2018 Andrew Nicols <andrew@nicols.co.uk>
 * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

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

global $CFG;

use \core_privacy\local\request\contextlist_collection;
use \core_privacy\local\request\contextlist;
use \core_privacy\local\request\approved_contextlist;

/**
 * Tests for the \core_privacy API's contextlist collection functionality.
 *
 * @copyright   2018 Andrew Nicols <andrew@nicols.co.uk>
 * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 * @coversDefaultClass \core_privacy\local\request\contextlist_collection
 */
class contextlist_collection_test extends advanced_testcase {
    /**
     * A contextlist_collection should support the contextlist type.
     *
     * @covers ::add_contextlist
     */
    public function test_supports_contextlist(): void {
        $uit = new contextlist_collection(1);
        $contextlist = new contextlist();
        $contextlist->set_component('core_privacy');
        $uit->add_contextlist($contextlist);

        $this->assertCount(1, $uit->get_contextlists());
    }

    /**
     * A contextlist_collection should support the approved_contextlist type.
     *
     * @covers ::add_contextlist
     */
    public function test_supports_approved_contextlist(): void {
        $uit = new contextlist_collection(1);
        $testuser = \core_user::get_user_by_username('admin');
        $contextids = [3, 2, 1];
        $uit->add_contextlist(new approved_contextlist($testuser, 'core_privacy', $contextids));

        $this->assertCount(1, $uit->get_contextlists());
    }

    /**
     * Ensure that get_contextlist_for_component returns the correct contextlist.
     *
     * @covers ::get_contextlist_for_component
     */
    public function test_get_contextlist_for_component(): void {
        $uit = new contextlist_collection(1);
        $coretests = new contextlist();
        $coretests->set_component('core_tests');
        $uit->add_contextlist($coretests);

        $coreprivacy = new contextlist();
        $coreprivacy->set_component('core_privacy');
        $uit->add_contextlist($coreprivacy);

        // Note: This uses assertSame rather than assertEquals.
        // The former checks the actual object, whilst assertEquals only checks that they look the same.
        $this->assertSame($coretests, $uit->get_contextlist_for_component('core_tests'));
        $this->assertSame($coreprivacy, $uit->get_contextlist_for_component('core_privacy'));
    }

    /**
     * Ensure that get_contextlist_for_component does not die horribly when querying a non-existent component.
     *
     * @covers ::get_contextlist_for_component
     */
    public function test_get_contextlist_for_component_not_found(): void {
        $uit = new contextlist_collection(1);

        $this->assertNull($uit->get_contextlist_for_component('core_tests'));
    }

    /**
     * Ensure that a duplicate contextlist in the collection throws an Exception.
     *
     * @covers ::add_contextlist
     */
    public function test_duplicate_addition_throws(): void {
        $uit = new contextlist_collection(1);

        $coretests = new contextlist();
        $coretests->set_component('core_tests');
        $uit->add_contextlist($coretests);

        $this->expectException('moodle_exception');
        $uit->add_contextlist($coretests);
    }

    /**
     * Ensure that the contextlist_collection is countable.
     *
     * @covers ::count
     */
    public function test_countable(): void {
        $uit = new contextlist_collection(1);

        $contextlist = new contextlist();
        $contextlist->set_component('test_example');
        $uit->add_contextlist($contextlist);

        $contextlist = new contextlist();
        $contextlist->set_component('test_another');
        $uit->add_contextlist($contextlist);

        $this->assertCount(2, $uit);
    }

    /**
     * Ensure that the contextlist_collection iterates over the set of contextlists.
     *
     * @covers ::current
     * @covers ::key
     * @covers ::next
     * @covers ::rewind
     * @covers ::valid
     */
    public function test_iteration(): void {
        $uit = new contextlist_collection(1);

        $testdata = [];

        $component = 'test_example';
        $contextlist = new contextlist();
        $contextlist->set_component($component);
        $uit->add_contextlist($contextlist);
        $testdata[$component] = $contextlist;

        $component = 'test_another';
        $contextlist = new contextlist();
        $contextlist->set_component($component);
        $uit->add_contextlist($contextlist);
        $testdata[$component] = $contextlist;

        $component = 'test_third';
        $contextlist = new contextlist();
        $contextlist->set_component($component);
        $uit->add_contextlist($contextlist);
        $testdata[$component] = $contextlist;

        foreach ($uit as $component => $list) {
            $this->assertEquals($testdata[$component], $list);
        }

        $this->assertCount(3, $uit);
    }

    /**
     * Test that the userid is correctly returned.
     *
     * @covers ::get_userid
     */
    public function test_get_userid(): void {
        $uit = new contextlist_collection(1);

        $this->assertEquals(1, $uit->get_userid());
    }

    /**
     * Test that an exception is thrown if a contextlist does not contain a component.
     */
    public function test_add_without_component(): void {
        $uit = new contextlist_collection(1);

        $this->expectException(moodle_exception::class);
        $uit->add_contextlist(new contextlist());
    }
}