Proyectos de Subversion Moodle

<?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 core;

use core_phpunit\exception\test_exception;

/**

 * Test advanced_testcase extra features.

 *

 * @package    core

 * @category   test

 * @copyright  2012 Petr Skoda {@link http://skodak.org}

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 * @coversDefaultClass \advanced_testcase

 */

final class advanced_test extends \advanced_testcase {

    public static function setUpBeforeClass(): void {

        global $CFG;

        require_once(__DIR__ . '/fixtures/adhoc_test_task.php');

        parent::setUpBeforeClass();

    }

    public function test_debugging(): void {

        global $CFG;

        $this->resetAfterTest();

        debugging('hokus');

        $this->assertDebuggingCalled();

        debugging('pokus');

        $this->assertDebuggingCalled('pokus');

        debugging('pokus', DEBUG_MINIMAL);

        $this->assertDebuggingCalled('pokus', DEBUG_MINIMAL);

        $this->assertDebuggingNotCalled();

        debugging('a');

        debugging('b', DEBUG_MINIMAL);

        debugging('c', DEBUG_DEVELOPER);

        $debuggings = $this->getDebuggingMessages();

        $this->assertCount(3, $debuggings);

        $this->assertSame('a', $debuggings[0]->message);

        $this->assertSame(DEBUG_NORMAL, $debuggings[0]->level);

        $this->assertSame('b', $debuggings[1]->message);

        $this->assertSame(DEBUG_MINIMAL, $debuggings[1]->level);

        $this->assertSame('c', $debuggings[2]->message);

        $this->assertSame(DEBUG_DEVELOPER, $debuggings[2]->level);

        $this->resetDebugging();

        $this->assertDebuggingNotCalled();

        $debuggings = $this->getDebuggingMessages();

        $this->assertCount(0, $debuggings);

        set_debugging(DEBUG_NONE);

        debugging('hokus');

        $this->assertDebuggingNotCalled();

        set_debugging(DEBUG_DEVELOPER);

    }

    /**

     * @test

     *

     * Annotations are a valid PHPUnit method for running tests.  Debugging needs to support them.

     */

    public function debugging_called_with_annotation() {

        debugging('pokus', DEBUG_MINIMAL);

        $this->assertDebuggingCalled('pokus', DEBUG_MINIMAL);

    }

    public function test_set_user(): void {

        global $USER, $DB, $SESSION;

        $this->resetAfterTest();

        $this->assertEquals(0, $USER->id);

        $this->assertSame($_SESSION['USER'], $USER);

        $this->assertSame($GLOBALS['USER'], $USER);

        $user = $DB->get_record('user', array('id'=>2));

        $this->assertNotEmpty($user);

        $this->setUser($user);

        $this->assertEquals(2, $USER->id);

        $this->assertEquals(2, $_SESSION['USER']->id);

        $this->assertSame($_SESSION['USER'], $USER);

        $this->assertSame($GLOBALS['USER'], $USER);

        $USER->id = 3;

        $this->assertEquals(3, $USER->id);

        $this->assertEquals(3, $_SESSION['USER']->id);

        $this->assertSame($_SESSION['USER'], $USER);

        $this->assertSame($GLOBALS['USER'], $USER);

        \core\session\manager::set_user($user);

        $this->assertEquals(2, $USER->id);

        $this->assertEquals(2, $_SESSION['USER']->id);

        $this->assertSame($_SESSION['USER'], $USER);

        $this->assertSame($GLOBALS['USER'], $USER);

        $USER = $DB->get_record('user', array('id'=>1));

        $this->assertNotEmpty($USER);

        $this->assertEquals(1, $USER->id);

        $this->assertEquals(1, $_SESSION['USER']->id);

        $this->assertSame($_SESSION['USER'], $USER);

        $this->assertSame($GLOBALS['USER'], $USER);

        $this->setUser(null);

        $this->assertEquals(0, $USER->id);

        $this->assertSame($_SESSION['USER'], $USER);

        $this->assertSame($GLOBALS['USER'], $USER);

        // Ensure session is reset after setUser, as it may contain extra info.

        $SESSION->sometestvalue = true;

        $this->setUser($user);

        $this->assertObjectNotHasProperty('sometestvalue', $SESSION);

    }

    public function test_set_admin_user(): void {

        global $USER;

        $this->resetAfterTest();

        $this->setAdminUser();

        $this->assertEquals($USER->id, 2);

        $this->assertTrue(is_siteadmin());

    }

    public function test_set_guest_user(): void {

        global $USER;

        $this->resetAfterTest();

        $this->setGuestUser();

        $this->assertEquals($USER->id, 1);

        $this->assertTrue(isguestuser());

    }

    public function test_database_reset(): void {

        global $DB;

        $this->resetAfterTest();

        $this->preventResetByRollback();

        $this->assertEquals(1, $DB->count_records('course')); // Only frontpage in new site.

        // This is weird table - id is NOT a sequence here.

        $this->assertEquals(0, $DB->count_records('context_temp'));

        $DB->import_record('context_temp', array('id'=>5, 'path'=>'/1/2', 'depth'=>2));

        $record = $DB->get_record('context_temp', array());

        $this->assertEquals(5, $record->id);

        $this->assertEquals(0, $DB->count_records('user_preferences'));

        $originaldisplayid = $DB->insert_record('user_preferences', array('userid'=>2, 'name'=> 'phpunittest', 'value'=>'x'));

        $this->assertEquals(1, $DB->count_records('user_preferences'));

        $numcourses = $DB->count_records('course');

        $course = $this->getDataGenerator()->create_course();

        $this->assertEquals($numcourses + 1, $DB->count_records('course'));

        $this->assertEquals(2, $DB->count_records('user'));

        $DB->delete_records('user', array('id'=>1));

        $this->assertEquals(1, $DB->count_records('user'));

        $this->resetAllData();

        $this->assertEquals(1, $DB->count_records('course')); // Only frontpage in new site.

        $this->assertEquals(0, $DB->count_records('context_temp')); // Only frontpage in new site.

        $numcourses = $DB->count_records('course');

        $course = $this->getDataGenerator()->create_course();

        $this->assertEquals($numcourses + 1, $DB->count_records('course'));

        $displayid = $DB->insert_record('user_preferences', array('userid'=>2, 'name'=> 'phpunittest', 'value'=>'x'));

        $this->assertEquals($originaldisplayid, $displayid);

        $this->assertEquals(2, $DB->count_records('user'));

        $DB->delete_records('user', array('id'=>2));

        $user = $this->getDataGenerator()->create_user();

        $this->assertEquals(2, $DB->count_records('user'));

        $this->assertGreaterThan(2, $user->id);

        $this->resetAllData();

        $numcourses = $DB->count_records('course');

        $course = $this->getDataGenerator()->create_course();

        $this->assertEquals($numcourses + 1, $DB->count_records('course'));

        $this->assertEquals(2, $DB->count_records('user'));

        $DB->delete_records('user', array('id'=>2));

        $this->resetAllData();

        $numcourses = $DB->count_records('course');

        $course = $this->getDataGenerator()->create_course();

        $this->assertEquals($numcourses + 1, $DB->count_records('course'));

        $this->assertEquals(2, $DB->count_records('user'));

    }

    public function test_change_detection(): void {

        global $DB, $CFG, $COURSE, $SITE, $USER;

        $this->preventResetByRollback();

        self::resetAllData(true);

        // Database change.

        $this->assertEquals(1, $DB->get_field('user', 'confirmed', array('id'=>2)));

        $DB->set_field('user', 'confirmed', 0, array('id'=>2));

        try {

            self::resetAllData(true);

        } catch (test_exception $e) {

            $this->assertStringContainsString('unexpected database modification', $e->getMessage());

        }

        $this->assertEquals(1, $DB->get_field('user', 'confirmed', array('id'=>2)));

        // Config change.

        $CFG->xx = 'yy';

        unset($CFG->admin);

        $CFG->rolesactive = 0;

        try {

            self::resetAllData(true);

        } catch (test_exception $e) {

            $this->assertStringContainsString('xx', $e->getMessage());

            $this->assertStringContainsString('admin', $e->getMessage());

            $this->assertStringContainsString('rolesactive', $e->getMessage());

            $this->assertFalse(isset($CFG->xx));

            $this->assertTrue(isset($CFG->admin));

            $this->assertEquals(1, $CFG->rolesactive);

        }

        // _GET change.

        $_GET['__somethingthatwillnotnormallybepresent__'] = 'yy';

        self::resetAllData(true);

        $this->assertEquals(array(), $_GET);

        // _POST change.

        $_POST['__somethingthatwillnotnormallybepresent2__'] = 'yy';

        self::resetAllData(true);

        $this->assertEquals(array(), $_POST);

        // _FILES change.

        $_FILES['__somethingthatwillnotnormallybepresent3__'] = 'yy';

        self::resetAllData(true);

        $this->assertEquals(array(), $_FILES);

        // _REQUEST change.

        $_REQUEST['__somethingthatwillnotnormallybepresent4__'] = 'yy';

        self::resetAllData(true);

        $this->assertEquals(array(), $_REQUEST);

        // Silent changes.

        $_SERVER['xx'] = 'yy';

        self::resetAllData(true);

        $this->assertFalse(isset($_SERVER['xx']));

        // COURSE change.

        $SITE->id = 10;

        $COURSE = new \stdClass();

        $COURSE->id = 7;

        try {

            self::resetAllData(true);

        } catch (test_exception $e) {

            $this->assertStringContainsString('unexpected change of $COURSE', $e->getMessage());

        }

        $this->assertEquals(1, $SITE->id);

        $this->assertSame($SITE, $COURSE);

        $this->assertSame($SITE, $COURSE);

        // USER change.

        $this->setUser(2);

        try {

            self::resetAllData(true);

        } catch (test_exception $e) {

            $this->assertStringContainsString('unexpected change of $USER', $e->getMessage());

        }

        $this->assertEquals(0, $USER->id);

    }

    public function test_getDataGenerator(): void {

        $generator = $this->getDataGenerator();

        $this->assertInstanceOf('testing_data_generator', $generator);

    }

    /**

     * Some basic tests for the getExternalTestFileUrl() method.

     */

    public function test_external_file_url(): void {

        $url = self::getExternalTestFileUrl('testfile.txt');

        // There should only be a // after the protocol.

        $this->assertCount(2, explode('//', $url));

        if (defined('TEST_EXTERNAL_FILES_HTTP_URL')) {

            $this->assertStringContainsString(TEST_EXTERNAL_FILES_HTTP_URL, $url);

        } else {

            $this->assertStringContainsString('http://download.moodle.org/unittest', $url);

        }

        $url = self::getExternalTestFileUrl('testfile.txt', true);

        $this->assertCount(2, explode('//', $url));

        if (defined('TEST_EXTERNAL_FILES_HTTPS_URL')) {

            $this->assertStringContainsString(TEST_EXTERNAL_FILES_HTTPS_URL, $url);

        } else {

            $this->assertStringContainsString('https://download.moodle.org/unittest', $url);

        }

    }

    public function test_database_mock1(): void {

        global $DB;

        try {

            $DB->get_record('pokus', array());

            $this->fail('Exception expected when accessing non existent table');

        } catch (\moodle_exception $e) {

            $this->assertInstanceOf('dml_exception', $e);

        }

        $DB = $this->createMock(get_class($DB));

        $this->assertNull($DB->get_record('pokus', array()));

        // Rest continues after reset.

    }

    public function test_database_mock2(): void {

        global $DB;

        // Now the database should be back to normal.

        $this->assertFalse($DB->get_record('user', array('id'=>9999)));

    }

    public function test_assert_time_current(): void {

        $this->assertTimeCurrent(time());

        $this->setCurrentTimeStart();

        $this->assertTimeCurrent(time());

        $this->waitForSecond();

        $this->assertTimeCurrent(time());

        $this->assertTimeCurrent(time()-1);

        try {

            $this->setCurrentTimeStart();

            $this->assertTimeCurrent(time()+10);

            $this->fail('Failed assert expected');

        } catch (\Exception $e) {

            $this->assertInstanceOf('PHPUnit\Framework\ExpectationFailedException', $e);

        }

        try {

            $this->setCurrentTimeStart();

            $this->assertTimeCurrent(time()-10);

            $this->fail('Failed assert expected');

        } catch (\Exception $e) {

            $this->assertInstanceOf('PHPUnit\Framework\ExpectationFailedException', $e);

        }

    }

    /**

     * Test the assertEventContextNotUsed() assertion.

     *

     * Verify that events using the event context in some of their

     * methods are detected properly (will throw a warning if they are).

     *

     * To do so, we'll be using some fixture events (context_used_in_event_xxxx),

     * that, on purpose, use the event context (incorrectly) in their methods.

     *

     * Note that because we are using imported fixture classes, and because we

     * are testing for warnings, better we run the tests in a separate process.

     *

     * @param string $fixture The fixture class to use.

     * @param bool $phpwarn Whether a PHP warning is expected.

     *

     * @runInSeparateProcess

     * @dataProvider assert_event_context_not_used_provider

     * @covers ::assertEventContextNotUsed

     */

    public function test_assert_event_context_not_used($fixture, $phpwarn): void {

        require(__DIR__ . '/fixtures/event_fixtures.php');

        // Create an event that uses the event context in its get_url() and get_description() methods.

        $event = $fixture::create([

            'other' => [

                'sample' => 1,

                'xx' => 10,

            ],

        ]);

        if ($phpwarn) {

            // Let's convert the warnings into an assert-able exception.

            set_error_handler(

                static function ($errno, $errstr) {

                    restore_error_handler();

                    throw new \Exception($errstr, $errno);

                },

                E_WARNING // Or any other specific E_ that we want to assert.

            );

            $this->expectException(\Exception::class);

        }

        $this->assertEventContextNotUsed($event);

    }

    /**

     * Data provider for test_assert_event_context_not_used().

     *

     * @return array

     */

    public static function assert_event_context_not_used_provider(): array {

        return [

            'correct' => ['\core\event\context_used_in_event_correct', false],

            'wrong_get_url' => ['\core\event\context_used_in_event_get_url', true],

            'wrong_get_description' => ['\core\event\context_used_in_event_get_description', true],

        ];

    }

    public function test_message_processors_reset(): void {

        global $DB;

        $this->resetAfterTest(true);

        // Get all processors first.

        $processors1 = get_message_processors();

        // Add a new message processor and get all processors again.

        $processor = new \stdClass();

        $processor->name = 'test_processor';

        $processor->enabled = 1;

        $DB->insert_record('message_processors', $processor);

        $processors2 = get_message_processors();

        // Assert that new processor still haven't been added to the list.

        $this->assertSame($processors1, $processors2);

        // Reset message processors data.

        $processors3 = get_message_processors(false, true);

        // Now, list of processors should not be the same any more,

        // And we should have one more message processor in the list.

        $this->assertNotSame($processors1, $processors3);

        $this->assertEquals(count($processors1) + 1, count($processors3));

    }

    public function test_message_redirection(): \phpunit_message_sink {

        $this->preventResetByRollback(); // Messaging is not compatible with transactions...

        $this->resetAfterTest(false);

        $user1 = $this->getDataGenerator()->create_user();

        $user2 = $this->getDataGenerator()->create_user();

        // Any core message will do here.

        $message1 = new \core\message\message();

        $message1->courseid          = 1;

        $message1->component         = 'moodle';

        $message1->name              = 'instantmessage';

        $message1->userfrom          = $user1;

        $message1->userto            = $user2;

        $message1->subject           = 'message subject 1';

        $message1->fullmessage       = 'message body';

        $message1->fullmessageformat = FORMAT_MARKDOWN;

        $message1->fullmessagehtml   = '<p>message body</p>';

        $message1->smallmessage      = 'small message';

        $message1->notification      = 0;

        $message2 = new \core\message\message();

        $message2->courseid          = 1;

        $message2->component         = 'moodle';

        $message2->name              = 'instantmessage';

        $message2->userfrom          = $user2;

        $message2->userto            = $user1;

        $message2->subject           = 'message subject 2';

        $message2->fullmessage       = 'message body';

        $message2->fullmessageformat = FORMAT_MARKDOWN;

        $message2->fullmessagehtml   = '<p>message body</p>';

        $message2->smallmessage      = 'small message';

        $message2->notification      = 0;

        // There should be debugging message without redirection.

        $mailsink = $this->redirectEmails();

        $mailsink->close();

        message_send($message1);

        $this->assertDebuggingCalled(null, null, 'message_send() must print debug message that messaging is disabled in phpunit tests.');

        // Sink should catch messages.

        $sink = $this->redirectMessages();

        $mid1 = message_send($message1);

        $mid2 = message_send($message2);

        $this->assertDebuggingNotCalled('message redirection must prevent debug messages from the message_send()');

        $this->assertEquals(2, $sink->count());

        $this->assertGreaterThanOrEqual(1, $mid1);

        $this->assertGreaterThanOrEqual($mid1, $mid2);

        $messages = $sink->get_messages();

        $this->assertIsArray($messages);

        $this->assertCount(2, $messages);

        $this->assertEquals($mid1, $messages[0]->id);

        $this->assertEquals($message1->userto->id, $messages[0]->useridto);

        $this->assertEquals($message1->userfrom->id, $messages[0]->useridfrom);

        $this->assertEquals($message1->smallmessage, $messages[0]->smallmessage);

        $this->assertEquals($mid2, $messages[1]->id);

        $this->assertEquals($message2->userto->id, $messages[1]->useridto);

        $this->assertEquals($message2->userfrom->id, $messages[1]->useridfrom);

        $this->assertEquals($message2->smallmessage, $messages[1]->smallmessage);

        // Test resetting.

        $sink->clear();

        $messages = $sink->get_messages();

        $this->assertIsArray($messages);

        $this->assertCount(0, $messages);

        message_send($message1);

        $messages = $sink->get_messages();

        $this->assertIsArray($messages);

        $this->assertCount(1, $messages);

        // Test closing.

        $sink->close();

        $messages = $sink->get_messages();

        $this->assertIsArray($messages);

        $this->assertCount(1, $messages, 'Messages in sink are supposed to stay there after close');

        // Test debugging is enabled again.

        message_send($message1);

        $this->assertDebuggingCalled(null, null, 'message_send() must print debug message that messaging is disabled in phpunit tests.');

        // Test invalid names and components.

        $sink = $this->redirectMessages();

        $message3 = new \core\message\message();

        $message3->courseid          = 1;

        $message3->component         = 'xxxx_yyyyy';

        $message3->name              = 'instantmessage';

        $message3->userfrom          = $user2;

        $message3->userto            = $user1;

        $message3->subject           = 'message subject 2';

        $message3->fullmessage       = 'message body';

        $message3->fullmessageformat = FORMAT_MARKDOWN;

        $message3->fullmessagehtml   = '<p>message body</p>';

        $message3->smallmessage      = 'small message';

        $message3->notification      = 0;

        $this->assertFalse(message_send($message3));

        $this->assertDebuggingCalled('Attempt to send msg from a provider xxxx_yyyyy/instantmessage '.

            'that is inactive or not allowed for the user id='.$user1->id);

        $message3->component = 'moodle';

        $message3->name      = 'yyyyyy';

        $this->assertFalse(message_send($message3));

        $this->assertDebuggingCalled('Attempt to send msg from a provider moodle/yyyyyy '.

            'that is inactive or not allowed for the user id='.$user1->id);

        message_send($message1);

        $this->assertEquals(1, $sink->count());

        // Test if sink can be carried over to next test.

        $this->assertTrue(\phpunit_util::is_redirecting_messages());

        return $sink;

    }

    /**

     * @depends test_message_redirection

     */

    public function test_message_redirection_noreset(\phpunit_message_sink $sink): void {

        if ($this->isInIsolation()) {

            $this->markTestSkipped('State cannot be carried over between tests in isolated tests');

        }

        $this->preventResetByRollback(); // Messaging is not compatible with transactions...

        $this->resetAfterTest();

        $this->assertTrue(\phpunit_util::is_redirecting_messages());

        $this->assertEquals(1, $sink->count());

        $message = new \core\message\message();

        $message->courseid          = 1;

        $message->component         = 'moodle';

        $message->name              = 'instantmessage';

        $message->userfrom          = get_admin();

        $message->userto            = get_admin();

        $message->subject           = 'message subject 1';

        $message->fullmessage       = 'message body';

        $message->fullmessageformat = FORMAT_MARKDOWN;

        $message->fullmessagehtml   = '<p>message body</p>';

        $message->smallmessage      = 'small message';

        $message->notification      = 0;

        message_send($message);

        $this->assertEquals(2, $sink->count());

    }

    /**

     * @depends test_message_redirection_noreset

     */

    public function test_message_redirection_reset(): void {

        $this->assertFalse(\phpunit_util::is_redirecting_messages(), 'Test reset must stop message redirection.');

    }

    public function test_set_timezone(): void {

        global $CFG;

        $this->resetAfterTest();

        $this->assertSame('Australia/Perth', $CFG->timezone);

        $this->assertSame('Australia/Perth', date_default_timezone_get());

        $this->setTimezone('Pacific/Auckland', 'Europe/Prague');

        $this->assertSame('Pacific/Auckland', $CFG->timezone);

        $this->assertSame('Pacific/Auckland', date_default_timezone_get());

        $this->setTimezone('99', 'Europe/Prague');

        $this->assertSame('99', $CFG->timezone);

        $this->assertSame('Europe/Prague', date_default_timezone_get());

        // Catch warning for invalid 'xxx' timezone.

        set_error_handler(function ($errno, $errstr): void {

            $this->assertStringContainsString('Unknown or bad timezone', $errstr);

        }, E_WARNING);

        $this->setTimezone('xxx', 'Europe/Prague');

        restore_error_handler();

        $this->assertSame('xxx', $CFG->timezone);

        $this->assertSame('Europe/Prague', date_default_timezone_get());

        $this->setTimezone();

        $this->assertSame('Australia/Perth', $CFG->timezone);

        $this->assertSame('Australia/Perth', date_default_timezone_get());

        // Catch warnings for other invalid cases.

        $invalidtimezones = ['', 'xxxx', null];

        foreach ($invalidtimezones as $invalidtz) {

            set_error_handler(function ($errno, $errstr): void {

                $this->assertStringContainsString('Unknown or bad timezone', $errstr);

            }, E_WARNING);

            try {

                $this->setTimezone('Pacific/Auckland', $invalidtz);

            } catch (\Throwable $e) {

                $this->assertInstanceOf('PHPUnit\Framework\Error\Warning', $e);

            }

            restore_error_handler();

        }

    }

    public function test_locale_reset(): void {

        global $CFG;

        $this->resetAfterTest();

        // If this fails self::resetAllData(); must be updated.

        $this->assertSame('en_AU.UTF-8', get_string('locale', 'langconfig'));

        $this->assertSame('English_Australia.1252', get_string('localewin', 'langconfig'));

        if ($CFG->ostype === 'WINDOWS') {

            $this->assertSame('English_Australia.1252', setlocale(LC_TIME, 0));

            setlocale(LC_TIME, 'English_USA.1252');

        } else {

            $this->assertSame('en_AU.UTF-8', setlocale(LC_TIME, 0));

            setlocale(LC_TIME, 'en_US.UTF-8');

        }

        try {

            self::resetAllData(true);

        } catch (test_exception $e) {

            $this->assertStringContainsString('unexpected change of locale', $e->getMessage());

        }

        if ($CFG->ostype === 'WINDOWS') {

            $this->assertSame('English_Australia.1252', setlocale(LC_TIME, 0));

        } else {

            $this->assertSame('en_AU.UTF-8', setlocale(LC_TIME, 0));

        }

        if ($CFG->ostype === 'WINDOWS') {

            $this->assertSame('English_Australia.1252', setlocale(LC_TIME, 0));

            setlocale(LC_TIME, 'English_USA.1252');

        } else {

            $this->assertSame('en_AU.UTF-8', setlocale(LC_TIME, 0));

            setlocale(LC_TIME, 'en_US.UTF-8');

        }

        self::resetAllData(false);

        if ($CFG->ostype === 'WINDOWS') {

            $this->assertSame('English_Australia.1252', setlocale(LC_TIME, 0));

        } else {

            $this->assertSame('en_AU.UTF-8', setlocale(LC_TIME, 0));

        }

    }

    /**

     * This test sets a user agent and makes sure that it is cleared when the test is reset.

     */

    public function test_it_resets_useragent_after_test(): void {

        $this->resetAfterTest();

        $fakeagent = 'New user agent set.';

        // Sanity check: it should not be set when test begins.

        self::assertFalse(\core_useragent::get_user_agent_string(), 'It should not be set at first.');

        // Set a fake useragent and check it was set properly.

        \core_useragent::instance(true, $fakeagent);

        self::assertSame($fakeagent, \core_useragent::get_user_agent_string(), 'It should be the forced agent.');

        // Reset test data and ansure the useragent was cleaned.

        self::resetAllData(false);

        self::assertFalse(\core_useragent::get_user_agent_string(), 'It should not be set again, data was reset.');

    }

    /**

     * @covers ::runAdhocTasks

     */

    public function test_runadhoctasks_no_tasks_queued(): void {

        $this->runAdhocTasks();

        $this->expectOutputRegex('/^$/');

    }

    /**

     * @covers ::runAdhocTasks

     */

    public function test_runadhoctasks_tasks_queued(): void {

        $this->resetAfterTest(true);

        $admin = get_admin();

        \core\task\manager::queue_adhoc_task(new \core_phpunit\adhoc_test_task());

        $this->runAdhocTasks();

        $this->expectOutputRegex("/Task was run as {$admin->id}/");

    }

    /**

     * @covers ::runAdhocTasks

     */

    public function test_runadhoctasks_with_existing_user_change(): void {

        $this->resetAfterTest(true);

        $admin = get_admin();

        $this->setGuestUser();

        \core\task\manager::queue_adhoc_task(new \core_phpunit\adhoc_test_task());

        $this->runAdhocTasks();

        $this->expectOutputRegex("/Task was run as {$admin->id}/");

    }

    /**

     * @covers ::runAdhocTasks

     */

    public function test_runadhoctasks_with_existing_user_change_and_specified(): void {

        global $USER;

        $this->resetAfterTest(true);

        $user = $this->getDataGenerator()->create_user();

        $this->setGuestUser();

        $task = new \core_phpunit\adhoc_test_task();

        $task->set_userid($user->id);

        \core\task\manager::queue_adhoc_task($task);

        $this->runAdhocTasks();

        $this->expectOutputRegex("/Task was run as {$user->id}/");

    }

    /**

     * Test the incrementing mock clock.

     *

     * @covers ::mock_clock_with_incrementing

     * @covers \incrementing_clock

     */

    public function test_mock_clock_with_incrementing(): void {

        $standard = \core\di::get(\core\clock::class);

        $this->assertInstanceOf(\Psr\Clock\ClockInterface::class, $standard);

        $this->assertInstanceOf(\core\clock::class, $standard);

        $newclock = $this->mock_clock_with_incrementing(0);

        $mockedclock = \core\di::get(\core\clock::class);

        $this->assertInstanceOf(\incrementing_clock::class, $newclock);

        $this->assertSame($newclock, $mockedclock);

        // Test the functionality.

        $this->assertEquals(0, $mockedclock->now()->getTimestamp());

        $this->assertEquals(1, $newclock->now()->getTimestamp());

        $this->assertEquals(2, $mockedclock->now()->getTimestamp());

        $this->assertEquals('Australia/Perth', $newclock->now()->getTimezone()->getName());

        // Specify a specific start time.

        $newclock = $this->mock_clock_with_incrementing(12345);

        $mockedclock = \core\di::get(\core\clock::class);

        $this->assertSame($newclock, $mockedclock);

        $this->assertEquals(12345, $mockedclock->now()->getTimestamp());

        $this->assertEquals(12346, $newclock->now()->getTimestamp());

        $this->assertEquals(12347, $mockedclock->now()->getTimestamp());

        $this->assertEquals($newclock->time, $mockedclock->now()->getTimestamp());

        $this->assertEquals('Australia/Perth', $newclock->now()->getTimezone()->getName());

    }

    /**

     * Test the incrementing mock clock.

     *

     * @covers ::mock_clock_with_frozen

     * @covers \frozen_clock

     */

    public function test_mock_clock_with_frozen(): void {

        $standard = \core\di::get(\core\clock::class);

        $this->assertInstanceOf(\Psr\Clock\ClockInterface::class, $standard);

        $this->assertInstanceOf(\core\clock::class, $standard);

        $newclock = $this->mock_clock_with_frozen(0);

        $mockedclock = \core\di::get(\core\clock::class);

        $this->assertInstanceOf(\frozen_clock::class, $newclock);

        $this->assertSame($newclock, $mockedclock);

        // Test the functionality.

        $initialtime = $mockedclock->now()->getTimestamp();

        $this->assertEquals($initialtime, $newclock->now()->getTimestamp());

        $this->assertEquals($initialtime, $mockedclock->now()->getTimestamp());

        $this->assertEquals('Australia/Perth', $newclock->now()->getTimezone()->getName());

        // Specify a specific start time.

        $newclock = $this->mock_clock_with_frozen(12345);

        $mockedclock = \core\di::get(\core\clock::class);

        $this->assertSame($newclock, $mockedclock);

        $initialtime = $mockedclock->now();

        $this->assertEquals($initialtime, $mockedclock->now());

        $this->assertEquals($initialtime, $newclock->now());

        $this->assertEquals($initialtime, $mockedclock->now());

        $this->assertEquals('Australia/Perth', $newclock->now()->getTimezone()->getName());

    }

}