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

/**

 * Course related unit tests

 *

 * @package    core_course

 * @copyright  2014 Marina Glancy

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

 * @covers     \core_courseformat\base

 * @coversDefaultClass \core_courseformat\base

 */

class base_test extends advanced_testcase {

    /**

     * Setup to ensure that fixtures are loaded.

     */

    public static function setupBeforeClass(): void {

        global $CFG;

        require_once($CFG->dirroot . '/course/lib.php');

        require_once($CFG->dirroot . '/course/format/tests/fixtures/format_theunittest.php');

        require_once($CFG->dirroot . '/course/format/tests/fixtures/format_theunittest_output_course_format_state.php');

        require_once($CFG->dirroot . '/course/format/tests/fixtures/format_theunittest_output_course_format_invalidoutput.php');

    }

    /**

     * Tests the save and load functionality.

     *

     * @author Jason den Dulk

     * @covers \core_courseformat

     */

    public function test_courseformat_saveandload(): void {

        $this->resetAfterTest();

        $courseformatoptiondata = (object) [

            "hideoddsections" => 1,

            'summary_editor' => [

                'text' => '<p>Somewhere over the rainbow</p><p>The <b>quick</b> brown fox jumpos over the lazy dog.</p>',

                'format' => 1

            ]

        ];

        $generator = $this->getDataGenerator();

        $course1 = $generator->create_course(array('format' => 'theunittest'));

        $this->assertEquals('theunittest', $course1->format);

        course_create_sections_if_missing($course1, array(0, 1));

        $courseformat = course_get_format($course1);

        $courseformat->update_course_format_options($courseformatoptiondata);

        $savedcourseformatoptiondata = $courseformat->get_format_options();

        $this->assertEqualsCanonicalizing($courseformatoptiondata, (object) $savedcourseformatoptiondata);

    }

    public function test_available_hook(): void {

        global $DB;

        $this->resetAfterTest();

        // Generate a course with two sections (0 and 1) and two modules. Course format is set to 'theunittest'.

        $generator = $this->getDataGenerator();

        $course1 = $generator->create_course(array('format' => 'theunittest'));

        $this->assertEquals('theunittest', $course1->format);

        course_create_sections_if_missing($course1, array(0, 1));

        $assign0 = $generator->create_module('assign', array('course' => $course1, 'section' => 0));

        $assign1 = $generator->create_module('assign', array('course' => $course1, 'section' => 1));

        $assign2 = $generator->create_module('assign', array('course' => $course1, 'section' => 0, 'visible' => 0));

        // Create a courseoverview role based on the student role.

        $roleattr = array('name' => 'courseoverview', 'shortname' => 'courseoverview', 'archetype' => 'student');

        $generator->create_role($roleattr);

        // Create user student, editingteacher, teacher and courseoverview.

        $student = $generator->create_user();

        $teacher = $generator->create_user();

        $editingteacher = $generator->create_user();

        $courseoverviewuser = $generator->create_user();

        // Enrol users into their roles.

        $roleids = $DB->get_records_menu('role', null, '', 'shortname, id');

        $generator->enrol_user($student->id, $course1->id, $roleids['student']);

        $generator->enrol_user($teacher->id, $course1->id, $roleids['teacher']);

        $generator->enrol_user($editingteacher->id, $course1->id, $roleids['editingteacher']);

        $generator->enrol_user($courseoverviewuser->id, $course1->id, $roleids['courseoverview']);

        // Remove the ignoreavailabilityrestrictions from the teacher role.

        role_change_permission($roleids['teacher'], context_system::instance(0),

                'moodle/course:ignoreavailabilityrestrictions', CAP_PREVENT);

        // Allow the courseoverview role to ingore available restriction.

        role_change_permission($roleids['courseoverview'], context_system::instance(0),

                'moodle/course:ignoreavailabilityrestrictions', CAP_ALLOW);

        // Make sure that initially both sections and both modules are available and visible for a student.

        $modinfostudent = get_fast_modinfo($course1, $student->id);

        $this->assertTrue($modinfostudent->get_section_info(1)->available);

        $this->assertTrue($modinfostudent->get_cm($assign0->cmid)->available);

        $this->assertTrue($modinfostudent->get_cm($assign0->cmid)->uservisible);

        $this->assertTrue($modinfostudent->get_cm($assign1->cmid)->available);

        $this->assertTrue($modinfostudent->get_cm($assign1->cmid)->uservisible);

        $this->assertFalse($modinfostudent->get_cm($assign2->cmid)->uservisible);

        // Set 'hideoddsections' for the course to 1.

        // Section1 and assign1 will be unavailable, uservisible will be false for student and true for teacher.

        $data = (object)array('id' => $course1->id, 'hideoddsections' => 1);

        course_get_format($course1)->update_course_format_options($data);

        $modinfostudent = get_fast_modinfo($course1, $student->id);

        $this->assertFalse($modinfostudent->get_section_info(1)->available);

        $this->assertEmpty($modinfostudent->get_section_info(1)->availableinfo);

        $this->assertFalse($modinfostudent->get_section_info(1)->uservisible);

        $this->assertTrue($modinfostudent->get_cm($assign0->cmid)->available);

        $this->assertTrue($modinfostudent->get_cm($assign0->cmid)->uservisible);

        $this->assertFalse($modinfostudent->get_cm($assign1->cmid)->available);

        $this->assertFalse($modinfostudent->get_cm($assign1->cmid)->uservisible);

        $this->assertFalse($modinfostudent->get_cm($assign2->cmid)->uservisible);

        $modinfoteacher = get_fast_modinfo($course1, $teacher->id);

        $this->assertFalse($modinfoteacher->get_section_info(1)->available);

        $this->assertEmpty($modinfoteacher->get_section_info(1)->availableinfo);

        $this->assertFalse($modinfoteacher->get_section_info(1)->uservisible);

        $this->assertTrue($modinfoteacher->get_cm($assign0->cmid)->available);

        $this->assertTrue($modinfoteacher->get_cm($assign0->cmid)->uservisible);

        $this->assertFalse($modinfoteacher->get_cm($assign1->cmid)->available);

        $this->assertFalse($modinfoteacher->get_cm($assign1->cmid)->uservisible);

        $this->assertTrue($modinfoteacher->get_cm($assign2->cmid)->available);

        $this->assertTrue($modinfoteacher->get_cm($assign2->cmid)->uservisible);

        $modinfoteacher = get_fast_modinfo($course1, $editingteacher->id);

        $this->assertFalse($modinfoteacher->get_section_info(1)->available);

        $this->assertEmpty($modinfoteacher->get_section_info(1)->availableinfo);

        $this->assertTrue($modinfoteacher->get_section_info(1)->uservisible);

        $this->assertTrue($modinfoteacher->get_cm($assign0->cmid)->available);

        $this->assertTrue($modinfoteacher->get_cm($assign0->cmid)->uservisible);

        $this->assertFalse($modinfoteacher->get_cm($assign1->cmid)->available);

        $this->assertTrue($modinfoteacher->get_cm($assign1->cmid)->uservisible);

        $this->assertTrue($modinfoteacher->get_cm($assign2->cmid)->uservisible);

        $modinfocourseoverview = get_fast_modinfo($course1, $courseoverviewuser->id);

        $this->assertFalse($modinfocourseoverview->get_section_info(1)->available);

        $this->assertEmpty($modinfocourseoverview->get_section_info(1)->availableinfo);

        $this->assertTrue($modinfocourseoverview->get_section_info(1)->uservisible);

        $this->assertTrue($modinfocourseoverview->get_cm($assign0->cmid)->available);

        $this->assertTrue($modinfocourseoverview->get_cm($assign0->cmid)->uservisible);

        $this->assertFalse($modinfocourseoverview->get_cm($assign1->cmid)->available);

        $this->assertTrue($modinfocourseoverview->get_cm($assign1->cmid)->uservisible);

        $this->assertFalse($modinfocourseoverview->get_cm($assign2->cmid)->uservisible);

        // Set 'hideoddsections' for the course to 2.

        // Section1 and assign1 will be unavailable, uservisible will be false for student and true for teacher.

        // Property availableinfo will be not empty.

        $data = (object)array('id' => $course1->id, 'hideoddsections' => 2);

        course_get_format($course1)->update_course_format_options($data);

        $modinfostudent = get_fast_modinfo($course1, $student->id);

        $this->assertFalse($modinfostudent->get_section_info(1)->available);

        $this->assertNotEmpty($modinfostudent->get_section_info(1)->availableinfo);

        $this->assertFalse($modinfostudent->get_section_info(1)->uservisible);

        $this->assertTrue($modinfostudent->get_cm($assign0->cmid)->available);

        $this->assertTrue($modinfostudent->get_cm($assign0->cmid)->uservisible);

        $this->assertFalse($modinfostudent->get_cm($assign1->cmid)->available);

        $this->assertFalse($modinfostudent->get_cm($assign1->cmid)->uservisible);

        $modinfoteacher = get_fast_modinfo($course1, $editingteacher->id);

        $this->assertFalse($modinfoteacher->get_section_info(1)->available);

        $this->assertNotEmpty($modinfoteacher->get_section_info(1)->availableinfo);

        $this->assertTrue($modinfoteacher->get_section_info(1)->uservisible);

        $this->assertTrue($modinfoteacher->get_cm($assign0->cmid)->available);

        $this->assertTrue($modinfoteacher->get_cm($assign0->cmid)->uservisible);

        $this->assertFalse($modinfoteacher->get_cm($assign1->cmid)->available);

        $this->assertTrue($modinfoteacher->get_cm($assign1->cmid)->uservisible);

    }

    /**

     * Test for supports_news() with a course format plugin that doesn't define 'news_items' in default blocks.

     */

    public function test_supports_news(): void {

        $this->resetAfterTest();

        $format = course_get_format((object)['format' => 'testformat']);

        $this->assertFalse($format->supports_news());

    }

    /**

     * Test for supports_news() for old course format plugins that defines 'news_items' in default blocks.

     */

    public function test_supports_news_legacy(): void {

        $this->resetAfterTest();

        $format = course_get_format((object)['format' => 'testlegacy']);

        $this->assertTrue($format->supports_news());

    }

    /**

     * Test for get_view_url().

     *

     * @covers ::get_view_url

     */

    public function test_get_view_url(): void {

        global $CFG;

        $this->resetAfterTest();

        // Generate a course with two sections (0 and 1) and two modules. Course format is set to 'testformat'.

        // This will allow us to test the default implementation of get_view_url.

        $generator = $this->getDataGenerator();

        $course1 = $generator->create_course(array('format' => 'testformat'));

        course_create_sections_if_missing($course1, array(0, 1));

        $data = (object)['id' => $course1->id];

        $format = course_get_format($course1);

        $format->update_course_format_options($data);

        // In page.

        $this->assertNotEmpty($format->get_view_url(null));

        $this->assertNotEmpty($format->get_view_url(0));

        $this->assertNotEmpty($format->get_view_url(1));

        // Navigation.

        $this->assertStringContainsString('course/view.php', $format->get_view_url(0));

        $this->assertStringContainsString('course/view.php', $format->get_view_url(1));

        $this->assertStringContainsString('course/section.php', $format->get_view_url(0, ['navigation' => 1]));

        $this->assertStringContainsString('course/section.php', $format->get_view_url(1, ['navigation' => 1]));

        // When sr parameter is defined, the section.php page should be returned.

        $this->assertStringContainsString('course/section.php', $format->get_view_url(0, ['sr' => 1]));

        $this->assertStringContainsString('course/section.php', $format->get_view_url(1, ['sr' => 1]));

        $this->assertStringContainsString('course/section.php', $format->get_view_url(0, ['sr' => 0]));

        $this->assertStringContainsString('course/section.php', $format->get_view_url(1, ['sr' => 0]));

        // Expand section.

        // The current course format $format uses the format 'testformat' which does not use sections.

        // Thus, the 'expanded' parameter does not do anything.

        $viewurl = $format->get_view_url(1);

        $this->assertNull($viewurl->get_param('expandsection'));

        $viewurl = $format->get_view_url(1, ['expanded' => 1]);

        $this->assertNull($viewurl->get_param('expandsection'));

        $viewurl = $format->get_view_url(1, ['expanded' => 0]);

        $this->assertNull($viewurl->get_param('expandsection'));

        // We now use a course format which uses sections.

        $course2 = $generator->create_course(['format' => 'testformatsections']);

        course_create_sections_if_missing($course1, [0, 2]);

        $formatwithsections = course_get_format($course2);

        $viewurl = $formatwithsections->get_view_url(2);

        $this->assertEquals(2, $viewurl->get_param('expandsection'));

        $viewurl = $formatwithsections->get_view_url(2, ['expanded' => 1]);

        $this->assertEquals(2, $viewurl->get_param('expandsection'));

        $viewurl = $formatwithsections->get_view_url(2, ['expanded' => 0]);

        $this->assertNull($viewurl->get_param('expandsection'));

    }

    /**

     * Test for get_output_classname method.

     *

     * @dataProvider get_output_classname_provider

     * @param string $find the class to find

     * @param string $result the expected result classname

     * @param bool $exception if the method will raise an exception

     */

    public function test_get_output_classname($find, $result, $exception): void {

        $this->resetAfterTest();

        $course = $this->getDataGenerator()->create_course(['format' => 'theunittest']);

        $courseformat = course_get_format($course);

        if ($exception) {

            $this->expectException(coding_exception::class);

        }

        $courseclass = $courseformat->get_output_classname($find);

        $this->assertEquals($result, $courseclass);

    }

    /**

     * Data provider for test_get_output_classname.

     *

     * @return array the testing scenarios

     */

    public function get_output_classname_provider(): array {

        return [

            'overridden class' => [

                'find' => 'state\\course',

                'result' => 'format_theunittest\\output\\courseformat\\state\\course',

                'exception' => false,

            ],

            'original class' => [

                'find' => 'state\\section',

                'result' => 'core_courseformat\\output\\local\\state\\section',

                'exception' => false,

            ],

            'invalid overridden class' => [

                'find' => 'state\\invalidoutput',

                'result' => '',

                'exception' => true,

            ],

        ];

    }

    /**

     * Test for the default delete format data behaviour.

     *

     * @covers ::get_sections_preferences

     */

    public function test_get_sections_preferences(): void {

        $this->resetAfterTest();

        $generator = $this->getDataGenerator();

        $course = $generator->create_course();

        $user = $generator->create_and_enrol($course, 'student');

        // Create fake preferences generated by the frontend js module.

        $data = (object)[

            'pref1' => [1,2],

            'pref2' => [1],

        ];

        set_user_preference('coursesectionspreferences_' . $course->id, json_encode($data), $user->id);

        $format = course_get_format($course);

        // Load data from user 1.

        $this->setUser($user);

        $preferences = $format->get_sections_preferences();

        $this->assertEquals(

            (object)['pref1' => true, 'pref2' => true],

            $preferences[1]

        );

        $this->assertEquals(

            (object)['pref1' => true],

            $preferences[2]

        );

    }

    /**

     * Test for the default delete format data behaviour.

     *

     * @covers ::set_sections_preference

     */

    public function test_set_sections_preference(): void {

        $this->resetAfterTest();

        $generator = $this->getDataGenerator();

        $course = $generator->create_course();

        $user = $generator->create_and_enrol($course, 'student');

        $format = course_get_format($course);

        $this->setUser($user);

        // Load data from user 1.

        $format->set_sections_preference('pref1', [1, 2]);

        $format->set_sections_preference('pref2', [1]);

        $format->set_sections_preference('pref3', []);

        $preferences = $format->get_sections_preferences();

        $this->assertEquals(

            (object)['pref1' => true, 'pref2' => true],

            $preferences[1]

        );

        $this->assertEquals(

            (object)['pref1' => true],

            $preferences[2]

        );

    }

    /**

     * Test add_section_preference_ids() method.

     *

     * @covers \core_courseformat\base::persist_to_user_preference

     */

    public function test_add_section_preference_ids(): void {

        $this->resetAfterTest();

        // Create initial data.

        $generator = $this->getDataGenerator();

        $course = $generator->create_course();

        $user = $generator->create_and_enrol($course);

        // Get the course format.

        $format = course_get_format($course);

        // Login as the user.

        $this->setUser($user);

        // Add section preference ids.

        $format->add_section_preference_ids('pref1', [1, 2]);

        $format->add_section_preference_ids('pref1', [3]);

        $format->add_section_preference_ids('pref2', [1]);

        // Get section preferences.

        $sectionpreferences = $format->get_sections_preferences_by_preference();

        $this->assertCount(3, $sectionpreferences['pref1']);

        $this->assertContains(1, $sectionpreferences['pref1']);

        $this->assertContains(2, $sectionpreferences['pref1']);

        $this->assertContains(3, $sectionpreferences['pref1']);

        $this->assertCount(1, $sectionpreferences['pref2']);

        $this->assertContains(1, $sectionpreferences['pref1']);

    }

    /**

     * Test remove_section_preference_ids() method.

     *

     * @covers \core_courseformat\base::persist_to_user_preference

     */

    public function test_remove_section_preference_ids(): void {

        $this->resetAfterTest();

        // Create initial data.

        $generator = $this->getDataGenerator();

        $course = $generator->create_course();

        $user = $generator->create_and_enrol($course);

        // Get the course format.

        $format = course_get_format($course);

        // Login as the user.

        $this->setUser($user);

        // Set initial preferences.

        $format->set_sections_preference('pref1', [1, 2, 3]);

        $format->set_sections_preference('pref2', [1]);

        // Remove section with id = 3 out of the pref1.

        $format->remove_section_preference_ids('pref1', [3]);

        // Get section preferences.

        $sectionpreferences = $format->get_sections_preferences_by_preference();

        $this->assertCount(2, $sectionpreferences['pref1']);

        $this->assertCount(1, $sectionpreferences['pref2']);

        // Remove section with id = 2 out of the pref1.

        $format->remove_section_preference_ids('pref1', [2]);

        // Remove section with id = 1 out of the pref2.

        $format->remove_section_preference_ids('pref2', [1]);

        // Get section preferences.

        $sectionpreferences = $format->get_sections_preferences_by_preference();

        $this->assertCount(1, $sectionpreferences['pref1']);

        $this->assertEmpty($sectionpreferences['pref2']);

    }

    /**

     * Test that retrieving last section number for a course

     *

     * @covers ::get_last_section_number

     */

    public function test_get_last_section_number(): void {

        global $DB;

        $this->resetAfterTest();

        // Course with two additional sections.

        $courseone = $this->getDataGenerator()->create_course(['numsections' => 2]);

        $this->assertEquals(2, course_get_format($courseone)->get_last_section_number());

        // Course without additional sections, section zero is the "default" section that always exists.

        $coursetwo = $this->getDataGenerator()->create_course(['numsections' => 0]);

        $this->assertEquals(0, course_get_format($coursetwo)->get_last_section_number());

        // Course without additional sections, manually remove section zero, as "course_delete_section" prevents that. This

        // simulates course data integrity issues that previously triggered errors.

        $coursethree = $this->getDataGenerator()->create_course(['numsections' => 0]);

        $DB->delete_records('course_sections', ['course' => $coursethree->id, 'section' => 0]);

        $this->assertEquals(-1, course_get_format($coursethree)->get_last_section_number());

    }

    /**

     * Test for the default delete format data behaviour.

     *

     * @covers ::delete_format_data

     * @dataProvider delete_format_data_provider

     * @param bool $usehook if it should use course_delete to trigger $format->delete_format_data as a hook

     */

    public function test_delete_format_data(bool $usehook): void {

        global $DB;

        $this->resetAfterTest();

        $generator = $this->getDataGenerator();

        $course = $generator->create_course();

        course_create_sections_if_missing($course, [0, 1]);

        $user = $generator->create_and_enrol($course, 'student');

        // Create a coursesectionspreferences_XX preference.

        $key = 'coursesectionspreferences_' . $course->id;

        $fakevalue = 'No dark sarcasm in the classroom';

        set_user_preference($key, $fakevalue, $user->id);

        $this->assertEquals(

            $fakevalue,

            $DB->get_field('user_preferences', 'value', ['name' => $key, 'userid' => $user->id])

        );

        // Create another random user preference.

        $key2 = 'somepreference';

        $fakevalue2 = "All in all it's just another brick in the wall";

        set_user_preference($key2, $fakevalue2, $user->id);

        $this->assertEquals(

            $fakevalue2,

            $DB->get_field('user_preferences', 'value', ['name' => $key2, 'userid' => $user->id])

        );

        if ($usehook) {

            delete_course($course, false);

        } else {

            $format = course_get_format($course);

            $format->delete_format_data();

        }

        // Check which the preferences exists.

        $this->assertFalse(

            $DB->record_exists('user_preferences', ['name' => $key, 'userid' => $user->id])

        );

        set_user_preference($key2, $fakevalue2, $user->id);

        $this->assertEquals(

            $fakevalue2,

            $DB->get_field('user_preferences', 'value', ['name' => $key2, 'userid' => $user->id])

        );

    }

    /**

     * Data provider for test_delete_format_data.

     *

     * @return array the testing scenarios

     */

    public function delete_format_data_provider(): array {

        return [

            'direct call' => [

                'usehook' => false

            ],

            'use hook' => [

                'usehook' => true,

            ]

        ];

    }

    /**

     * Test duplicate_section()

     * @covers ::duplicate_section

     */

    public function test_duplicate_section(): void {

        global $DB;

        $this->setAdminUser();

        $this->resetAfterTest();

        $generator = $this->getDataGenerator();

        $course = $generator->create_course();

        $format = course_get_format($course);

        $originalsection = $DB->get_record('course_sections', ['course' => $course->id, 'section' => 1], '*', MUST_EXIST);

        $generator->create_module('page', ['course' => $course, 'section' => $originalsection->section]);

        $generator->create_module('page', ['course' => $course, 'section' => $originalsection->section]);

        $generator->create_module('page', ['course' => $course, 'section' => $originalsection->section]);

        $originalmodcount = $DB->count_records('course_modules', ['course' => $course->id, 'section' => $originalsection->id]);

        $this->assertEquals(3, $originalmodcount);

        $modinfo = get_fast_modinfo($course);

        $sectioninfo = $modinfo->get_section_info($originalsection->section, MUST_EXIST);

        $newsection = $format->duplicate_section($sectioninfo);

        // Verify properties are the same.

        foreach ($originalsection as $prop => $value) {

            if ($prop == 'id' || $prop == 'sequence' || $prop == 'section' || $prop == 'timemodified') {

                continue;

            }

            $this->assertEquals($value, $newsection->$prop);

        }

        $newmodcount = $DB->count_records('course_modules', ['course' => $course->id, 'section' => $newsection->id]);

        $this->assertEquals($originalmodcount, $newmodcount);

    }

    /**

     * Test for the default delete format data behaviour.

     *

     * @covers ::get_format_string

     * @dataProvider get_format_string_provider

     * @param string $key the string key

     * @param string|null $data any string data

     * @param array|null $expectedstring the expected string (null for exception)

     * @param string $courseformat the course format

     */

    public function test_get_format_string(

        string $key,

        ?string $data,

        ?array $expectedstring,

        string $courseformat = 'topics'

    ): void {

        global $DB;

        $this->resetAfterTest();

        $generator = $this->getDataGenerator();

        $course = $generator->create_course(['format' => $courseformat]);

        if ($expectedstring) {

            $expected = get_string($expectedstring[0], $expectedstring[1], $expectedstring[2]);

        } else {

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

        }

        $format = course_get_format($course);

        $result = $format->get_format_string($key, $data);

        $this->assertEquals($expected, $result);

    }

    /**

     * Data provider for test_get_format_string.

     *

     * @return array the testing scenarios

     */

    public function get_format_string_provider(): array {

        return [

            'Existing in format lang' => [

                'key' => 'addsection',

                'data' => null,

                'expectedstring' => ['addsection', 'format_weeks', null],

                'courseformat' => 'weeks',

            ],

            'Not existing in format lang' => [

                'key' => 'bulkedit',

                'data' => null,

                'expectedstring' => ['bulkedit', 'core_courseformat', null],

            ],

            'Existing in format lang with data' => [

                'key' => 'section_highlight_feedback',

                'data' => 'Example',

                'expectedstring' => ['section_highlight_feedback', 'format_topics', 'Example'],

            ],

            'Not existing in format lang with data' => [

                'key' => 'bulkselection',

                'data' => 'X',

                'expectedstring' => ['bulkselection', 'core_courseformat', 'X'],

            ],

            'Non existing string' => [

                'key' => '%&non_existing_string_in_lang_files$%@#',

                'data' => null,

                'expectedstring' => null,

            ],

        ];

    }

    /**

     * Test for the move_section_after method.

     *

     * @covers ::move_section_after

     * @dataProvider move_section_after_provider

     * @param string $movesection the reference of the section to move

     * @param string $destination the reference of the destination section

     * @param string[] $order the references of the final section order

     */

    public function test_move_section_after(string $movesection, string $destination, array $order): void {

        global $DB;

        $this->resetAfterTest();

        $generator = $this->getDataGenerator();

        $course = $generator->create_course();

        course_create_sections_if_missing($course, [0, 1, 2, 3, 4, 5]);

        $format = course_get_format($course);

        $modinfo = $format->get_modinfo();

        $sectionsinfo = $modinfo->get_section_info_all();

        $references = [];

        foreach ($sectionsinfo as $section) {

            $references["section{$section->section}"] = $section;

        }

        $result = $format->move_section_after(

            $references[$movesection],

            $references[$destination]

        );

        $this->assertEquals(true, $result);

        // Check the updated course section list.

        $modinfo = $format->get_modinfo();

        $sectionsinfo = $modinfo->get_section_info_all();

        $this->assertCount(count($order), $sectionsinfo);

        foreach ($sectionsinfo as $key => $section) {

            $sectionreference = $order[$key];

            $oldinfo = $references[$sectionreference];

            $this->assertEquals($oldinfo->id, $section->id);

        }

    }

    /**

     * Data provider for test_move_section_after.

     *

     * @return array the testing scenarios

     */

    public function move_section_after_provider(): array {

        return [

            'Move top' => [

                'movesection' => 'section3',

                'destination' => 'section0',

                'order' => [

                    'section0',

                    'section3',

                    'section1',

                    'section2',

                    'section4',

                    'section5',

                ],

            ],

            'Move up' => [

                'movesection' => 'section3',

                'destination' => 'section1',

                'order' => [

                    'section0',

                    'section1',

                    'section3',

                    'section2',

                    'section4',

                    'section5',

                ],

            ],

            'Do not move' => [

                'movesection' => 'section3',

                'destination' => 'section2',

                'order' => [

                    'section0',

                    'section1',

                    'section2',

                    'section3',

                    'section4',

                    'section5',

                ],

            ],

            'Same position' => [

                'movesection' => 'section3',

                'destination' => 'section3',

                'order' => [

                    'section0',

                    'section1',

                    'section2',

                    'section3',

                    'section4',

                    'section5',

                ],

            ],

            'Move down' => [

                'movesection' => 'section3',

                'destination' => 'section4',

                'order' => [

                    'section0',

                    'section1',

                    'section2',

                    'section4',

                    'section3',

                    'section5',

                ],

            ],

            'Move bottom' => [

                'movesection' => 'section3',

                'destination' => 'section5',

                'order' => [

                    'section0',

                    'section1',

                    'section2',

                    'section4',

                    'section5',

                    'section3',

                ],

            ],

        ];

    }

    /**

     * Test for the get_non_ajax_cm_action_url method.

     *

     * @covers ::get_non_ajax_cm_action_url

     * @dataProvider get_non_ajax_cm_action_url_provider

     * @param string $action the ajax action name

     * @param string $expectedparam the expected param to check

     * @param string $exception if an exception is expected

     */

    public function test_get_non_ajax_cm_action_url(string $action, string $expectedparam, bool $exception): void {

        global $DB;

        $this->resetAfterTest();

        $generator = $this->getDataGenerator();

        $course = $generator->create_course();

        $assign0 = $generator->create_module('assign', array('course' => $course, 'section' => 0));

        $format = course_get_format($course);

        $modinfo = $format->get_modinfo();

        $cminfo = $modinfo->get_cm($assign0->cmid);

        if ($exception) {

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

        }

        $result = $format->get_non_ajax_cm_action_url($action, $cminfo);

        $this->assertEquals($assign0->cmid, $result->param($expectedparam));

    }

    /**

     * Data provider for test_get_non_ajax_cm_action_url.

     *

     * @return array the testing scenarios

     */

    public function get_non_ajax_cm_action_url_provider(): array {

        return [

            'duplicate' => [

                'action' => 'cmDuplicate',

                'expectedparam' => 'duplicate',

                'exception' => false,

            ],

            'hide' => [

                'action' => 'cmHide',

                'expectedparam' => 'hide',

                'exception' => false,

            ],

            'show' => [

                'action' => 'cmShow',

                'expectedparam' => 'show',

                'exception' => false,

            ],

            'stealth' => [

                'action' => 'cmStealth',

                'expectedparam' => 'stealth',

                'exception' => false,

            ],

            'delete' => [

                'action' => 'cmDelete',

                'expectedparam' => 'delete',

                'exception' => false,

            ],

            'non-existent' => [

                'action' => 'nonExistent',

                'expectedparam' => '',

                'exception' => true,

            ],

        ];

    }

    /**

     * Test get_required_jsfiles().

     *

     * @covers ::get_required_jsfiles

     */

    public function test_get_required_jsfiles(): void {

        $this->resetAfterTest();

        $generator = $this->getDataGenerator();

        $course = $generator->create_course(['format' => 'testformat']);

        $format = course_get_format($course);

        $this->assertEmpty($format->get_required_jsfiles());

    }

    /**

     * Test set_sectionid().

     *

     * @covers ::set_sectionid

     * @covers ::get_sectionid

     * @covers ::get_sectionnum

     */

    public function test_set_sectionid(): void {

        $this->resetAfterTest();

        $generator = $this->getDataGenerator();

        $course = $generator->create_course(['numsections' => 2]);

        $format = course_get_format($course);

        // No section.

        $this->assertNull($format->get_sectionid());

        $this->assertNull($format->get_sectionnum());

        // Valid section.

        $sectionnum = 1;

        $modinfo = get_fast_modinfo($course);

        $sectioninfo = $modinfo->get_section_info($sectionnum);

        $sectionid = $sectioninfo->id;

        $format->set_sectionid($sectionid);

        $this->assertEquals($sectionid, $format->get_sectionid());

        $this->assertEquals($sectionnum, $format->get_sectionnum());

        // Null section.

        $format->set_sectionid(null);

        $this->assertNull($format->get_sectionid());

        $this->assertNull($format->get_sectionnum());

        // Invalid section.

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

        $format->set_sectionid(-1);

    }

    /**

     * Test set_sectionnum().

     *

     * @dataProvider set_sectionnum_provider

     * @covers ::set_sectionnum

     * @param int|null $sectionnum The section number

     * @param bool $nullexpected If null is expected

     * @param bool $exceptionexpected If an exception is expected

     */

    public function test_set_sectionnum(?int $sectionnum, bool $nullexpected = false, bool $exceptionexpected = false): void {

        $this->resetAfterTest();

        $generator = $this->getDataGenerator();

        $course = $generator->create_course(['numsections' => 2]);

        $format = course_get_format($course);

        if ($exceptionexpected) {

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

        }

        $format->set_sectionnum($sectionnum);

        if ($nullexpected) {

            $this->assertNull($format->get_sectionid());

            $this->assertNull($format->get_sectionnum());

        } else {

            $this->assertNotNull($format->get_sectionid());

            $this->assertNotNull($format->get_sectionnum());

        }

    }

    /**

     * Data provider for test_set_sectionnum.

     *

     * @return array The testing scenarios

     */

    public static function set_sectionnum_provider(): array {

        return [

            'General sectionnumber' => [

                'sectionnum' => 0,

                'nullexpected' => false,

            ],

            'Existing sectionnumber' => [

                'sectionnum' => 1,

                'nullexpected' => false,

            ],

            'Another existing sectionnumber' => [

                'sectionnum' => 2,

                'nullexpected' => false,

            ],

            'Null sectionnumber' => [

                'sectionnum' => null,

                'nullexpected' => true,

            ],

            'Invalid sectionnumber' => [

                'sectionnum' => 3,

                'nullexpected' => true,

                'exceptionexpected' => true,

            ],

            'Another invalid sectionnumber' => [

                'sectionnum' => -1,

                'nullexpected' => true,

                'exceptionexpected' => true,

            ],

        ];

    }

    /**

     * Test can_sections_be_removed_from_navigation().

     *

     * @covers ::can_sections_be_removed_from_navigation

     */

    public function test_can_sections_be_removed_from_navigation(): void {

        $this->resetAfterTest();

        $generator = $this->getDataGenerator();

        $course = $generator->create_course();

        $format = course_get_format($course);

        $this->assertFalse($format->can_sections_be_removed_from_navigation());

        $course = $generator->create_course(['format' => 'testformatsections']);

        $format = course_get_format($course);

        $this->assertTrue($format->can_sections_be_removed_from_navigation());

    }

}

/**

 * Class format_testformat.

 *

 * A test class that simulates a course format that doesn't define 'news_items' in default blocks.

 *

 * @copyright 2016 Jun Pataleta <jun@moodle.com>

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

 */

class format_testformat extends core_courseformat\base {

    /**

     * Returns the list of blocks to be automatically added for the newly created course.

     *

     * @return array

     */

    public function get_default_blocks() {

        return [

            BLOCK_POS_RIGHT => [],

            BLOCK_POS_LEFT => []

        ];

    }

}

/**

 * Class format_testformatsections.

 *

 * A test class that simulates a course format with sections.

 *

 * @package   core_courseformat

 * @copyright 2023 ISB Bayern