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 mod_bigbluebuttonbn\local;

use backup;

use backup_controller;

use mod_bigbluebuttonbn\broker;

use mod_bigbluebuttonbn\completion\custom_completion;

use mod_bigbluebuttonbn\extension;

use mod_bigbluebuttonbn\instance;

use mod_bigbluebuttonbn\local\extension\mod_instance_helper;

use mod_bigbluebuttonbn\meeting;

use mod_bigbluebuttonbn\test\subplugins_test_helper_trait;

use mod_bigbluebuttonbn\test\testcase_helper_trait;

use restore_controller;

use restore_dbops;

/**

 * Extension helper class test

 *

 * @package   mod_bigbluebuttonbn

 * @copyright 2023 - present, Blindside Networks Inc

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

 * @author    Laurent David (laurent@call-learning.fr)

 * @coversDefaultClass \mod_bigbluebuttonbn\extension

 */

final class extension_test extends \advanced_testcase {

    use subplugins_test_helper_trait;

    use testcase_helper_trait;

    /**

     * Setup our fake plugin

     *

     * @return void

     */

    public function setUp(): void {

        parent::setUp();

        $this->resetAfterTest(true);

        $this->setup_fake_plugin('simple');

        $this->resetDebugging(); // We might have debugging messages issued from setup_fake_plugin here that we need to get rid of.

    }

    /**

     * Setup our fake plugin

     *

     * @return void

     */

    public function tearDown(): void {

        $this->uninstall_fake_plugin('simple');

        parent::tearDown();

    }

    /**

     * Test for the type_text provider.

     *

     * @param bool $bbbenabled

     * @param string $apiclass

     * @param array $extensionclasses

     *

     * @dataProvider classes_implementing_class

     * @covers       \mod_bigbluebuttonbn\extension::get_instances_implementing

     */

    public function test_get_class_implementing(bool $bbbenabled, string $apiclass, array $extensionclasses): void {

        $this->enable_plugins($bbbenabled);

        // Make the method public so we can test it.

        $reflectionextension = new \ReflectionClass(extension::class);

        $getclassimplementing = $reflectionextension->getMethod('get_instances_implementing');

        $allfoundinstances = $getclassimplementing->invoke(null, $apiclass);

        $foundclasses = array_map(

            function($instance) {

                return get_class($instance);

            },

            $allfoundinstances

        );

        $this->assertEquals($extensionclasses, $foundclasses);

    }

    /**

     * Test the add module callback

     *

     * @return void

     * @covers \mod_bigbluebuttonbn\local\extension\mod_instance_helper

     */

    public function test_mod_instance_helper_add(): void {

        global $DB;

        // Enable plugin.

        $this->enable_plugins(true);

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

        $record = $this->getDataGenerator()->create_module(

            'bigbluebuttonbn',

            ['course' => $course->id, 'newfield' => 2]

        );

        $this->assertEquals(2, $DB->get_field('bbbext_simple', 'newfield', ['bigbluebuttonbnid' => $record->id]));

    }

    /**

     * Test the update module callback

     *

     * @return void

     * @covers \mod_bigbluebuttonbn\local\extension\mod_instance_helper

     */

    public function test_mod_instance_helper_update(): void {

        global $DB;

        $this->setAdminUser();

        // Enable plugin.

        $this->enable_plugins(true);

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

        $record = $this->getDataGenerator()->create_module('bigbluebuttonbn', ['course' => $course->id, 'newfield' => 2]);

        $cm = get_fast_modinfo($course)->instances['bigbluebuttonbn'][$record->id];

        [$cm, $context, $moduleinfo, $data] = get_moduleinfo_data($cm, $course);

        $data->newfield = 3;

        bigbluebuttonbn_update_instance($data);

        $this->assertEquals(3, $DB->get_field('bbbext_simple', 'newfield', ['bigbluebuttonbnid' => $record->id]));

    }

    /**

     * Test delete module callback

     *

     * @return void

     * @covers \mod_bigbluebuttonbn\local\extension\mod_instance_helper

     */

    public function test_mod_instance_helper_delete(): void {

        global $DB;

        $this->initialise_mock_server();

        // Enable plugin.

        $this->enable_plugins(true);

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

        $record = $this->getDataGenerator()->create_module('bigbluebuttonbn', ['course' => $course->id, 'newfield' => 2]);

        $cm = get_fast_modinfo($course)->instances['bigbluebuttonbn'][$record->id];

        course_delete_module($cm->id, false);

        $this->assertFalse($DB->get_field('bbbext_simple', 'newfield', ['bigbluebuttonbnid' => $record->id]));

    }

    /**

     * Test the action_url_addons with plugin enabled

     *

     * @return void

     * @covers \mod_bigbluebuttonbn\extension::action_url_addons

     */

    public function test_action_url_addons(): void {

        // Enable plugin.

        $this->enable_plugins(true);

        $course = $this->get_course();

        [$cm, $cminfo, $bbactivity] = $this->create_instance($course);

        $bbactivity->newfield = 4;

        extension::update_instance($bbactivity);

        ['data' => $additionalvar1, 'metadata' => $additionalvar2] =

            extension::action_url_addons('create', [], ['bbb-meta' => 'Test'], $bbactivity->id);

        $this->assertEmpty($additionalvar1);

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

        $this->assertEquals($additionalvar2['newfield'], 4);

        ['data' => $additionalvar1, 'metadata' => $additionalvar2] = extension::action_url_addons('delete');

        $this->assertEmpty($additionalvar1);

        $this->assertEmpty($additionalvar2);

    }

    /**

     * Test the action_url_addons with plugin enabled

     *

     * @return void

     * @covers \mod_bigbluebuttonbn\extension::action_url_addons

     */

    public function test_join_url_with_additional_field(): void {

        $this->initialise_mock_server();

        // Enable plugin.

        $this->enable_plugins(true);

        $course = $this->get_course();

        [$cm, $cminfo, $bbactivity] = $this->create_instance($course);

        $bbactivity->newfield = 4;

        extension::update_instance($bbactivity);

        $instance = instance::get_from_instanceid($bbactivity->id);

        $meeting = new meeting($instance);

        $meetingjoinurl = $meeting->get_join_url();

        $this->assertStringContainsString('newfield=4', $meetingjoinurl);

    }

    /**

     * Test backup restore (with extension)

     *

     * @covers       \backup_bigbluebuttonbn_activity_task

     */

    public function test_backup_restore(): void {

        global $DB, $CFG, $USER;

        require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');

        require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php');

        $this->resetAfterTest();

        $course = $this->get_course();

        [$cm, $cminfo, $bbactivity] = $this->create_instance($course);

        $bbactivity->newfield = 4;

        extension::update_instance($bbactivity);

        $this->setAdminUser();

        $CFG->backup_file_logger_level = backup::LOG_NONE;

        // Do backup with default settings.

        set_config('backup_general_users', 1, 'backup');

        $bc = new backup_controller(backup::TYPE_1COURSE, $course->id,

            backup::FORMAT_MOODLE, backup::INTERACTIVE_NO, backup::MODE_GENERAL,

            $USER->id);

        $bc->execute_plan();

        $results = $bc->get_results();

        $file = $results['backup_destination'];

        $fp = get_file_packer('application/vnd.moodle.backup');

        $filepath = $CFG->dataroot . '/temp/backup/test-restore-course';

        $file->extract_to_pathname($fp, $filepath);

        $bc->destroy();

        // Do restore to new course with default settings.

        $newcourseid = restore_dbops::create_new_course(

            $course->fullname, $course->shortname . '_2', $course->category);

        $rc = new restore_controller('test-restore-course', $newcourseid,

            backup::INTERACTIVE_NO, backup::MODE_GENERAL, $USER->id,

            backup::TARGET_NEW_COURSE);

        $rc->execute_precheck();

        $rc->execute_plan();

        $rc->destroy();

        $cms = get_fast_modinfo($newcourseid)->get_cms();

        $newmoduleid = null;

        foreach ($cms as $id => $cm) {

            if ($cm->modname == 'bigbluebuttonbn') {

                $newmoduleid = $cm->instance;

            }

        }

        // Check instance has been copied.

        $this->assertNotNull($newmoduleid);

        // Change the original instance value (this makes sure we are not looking at the same value in the

        // original and copy).

        $bbactivity->newfield = 5;

        extension::update_instance($bbactivity);

        // Now check the copied instance.

        $newfieldrecord = $DB->get_record('bbbext_simple', [

            'bigbluebuttonbnid' => $newmoduleid,

        ]);

        $this->assertNotNull($newfieldrecord);

        $this->assertEquals(4, $newfieldrecord->newfield);

        // And the original.

        $oldfieldrecord = $DB->get_record('bbbext_simple', [

            'bigbluebuttonbnid' => $bbactivity->id,

        ]);

        $this->assertNotNull($oldfieldrecord);

        $this->assertEquals(5, $oldfieldrecord->newfield);

    }

    /**

     * Test completion with and without addons.

     *

     * @param array $customcompletionrules

     * @param array $events

     * @param int $expectedstate

     * @return void

     * @dataProvider custom_completion_data_provider

     * @covers \mod_bigbluebuttonbn\local\extension\custom_completion_addons

     */

    public function test_additional_completion(array $customcompletionrules, array $events, int $expectedstate): void {

        // Enable plugin.

        $this->enable_plugins(true);

        $this->initialise_mock_server();

        list($bbactivitycontext, $bbactivitycm, $bbactivity) = $this->create_instance(

            $this->get_course(),

            array_merge([

                'completion' => '2',

            ], $customcompletionrules)

        );

        $plugingenerator = $this->getDataGenerator()->get_plugin_generator('mod_bigbluebuttonbn');

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

        $this->setUser($user);

        // Now create a couple of events.

        $instance = instance::get_from_instanceid($bbactivity->id);

        set_config('bigbluebuttonbn_meetingevents_enabled', true);

        $meeting = $plugingenerator->create_meeting([

            'instanceid' => $instance->get_instance_id(),

            'groupid' => $instance->get_group_id(),

            'participants' => json_encode([$user->id]),

        ]);

        foreach ($events as $edesc) {

            $plugingenerator->add_meeting_event($user, $instance, $edesc->name, $edesc->data ?? '');

        }

        $result = $plugingenerator->send_all_events($instance);

        $this->assertNotEmpty($result->data);

        $data = json_decode(json_encode($result->data));

        meeting::meeting_events($instance, $data);

        $completion = new custom_completion($bbactivitycm, $user->id);

        $result = $completion->get_overall_completion_state();

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

    }

    /**

     * Data generator

     *

     * @return array[]

     */

    public static function custom_completion_data_provider(): array {

        global $CFG;

        require_once($CFG->libdir . '/completionlib.php');

        return [

            'simple' => [

                'customcompletionrules' => [

                    'completionengagementtalks' => 1,

                    'completionextraisehandtwice' => 1,

                ],

                'events' => [

                    (object) ['name' => 'talks'],

                    (object) ['name' => 'raisehand'],

                    (object) ['name' => 'raisehand'],

                ],

                'expectedstate' => COMPLETION_COMPLETE,

            ],

            'not right events' => [

                'customcompletionrules' => [

                    'completionextraisehandtwice' => 1,

                ],

                'events' => [

                    (object) ['name' => 'chats'],

                ],

                'expectedstate' => COMPLETION_INCOMPLETE,

            ],

            'not enough events' => [

                'customcompletionrules' => [

                    'completionextraisehandtwice' => 1,

                ],

                'events' => [

                    (object) ['name' => 'raisehand'],

                ],

                'expectedstate' => COMPLETION_INCOMPLETE,

            ],

            'more events' => [

                'customcompletionrules' => [

                    'completionengagementtalks' => 1,

                ],

                'events' => [

                    (object) ['name' => 'talks'],

                    (object) ['name' => 'talks'],

                    (object) ['name' => 'talks'],

                ],

                'expectedstate' => COMPLETION_COMPLETE,

            ],

            'basics are still working' => [

                'customcompletionrules' => [

                    'completionengagementtalks' => 1,

                ],

                'events' => [

                    (object) ['name' => 'talks'],

                ],

                'expectedstate' => COMPLETION_COMPLETE,

            ],

        ];

    }

    /**

     * Test broker meeting_events with and without addons.

     * @return void

     * @covers \mod_bigbluebuttonbn\local\extension\broker_meeting_events_addons

     */

    public function test_broker_meeting_events_addons(): void {

        $this->resetAfterTest();

        global $DB;

        // Enable plugin.

        $this->enable_plugins(true);

        $this->initialise_mock_server();

        [$bbactivitycontext, $bbactivitycm, $bbactivity] = $this->create_instance(

            $this->get_course());

        $plugingenerator = $this->getDataGenerator()->get_plugin_generator('mod_bigbluebuttonbn');

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

        $this->setUser($user);

        // Now create a couple of events.

        $instance = instance::get_from_instanceid($bbactivity->id);

        set_config('bigbluebuttonbn_meetingevents_enabled', true);

        $meeting = $plugingenerator->create_meeting([

            'instanceid' => $instance->get_instance_id(),

            'groupid' => $instance->get_group_id(),

            'participants' => json_encode([$user->id]),

        ]);

        $events = [

            (object) ['name' => 'talks'],

            (object) ['name' => 'raisehand'],

            (object) ['name' => 'raisehand'],

        ];

        foreach ($events as $edesc) {

            $plugingenerator->add_meeting_event($user, $instance, $edesc->name, $edesc->data ?? '');

        }

        $result = $plugingenerator->send_all_events($instance);

        $this->assertNotEmpty($result->data);

        $data = json_encode($result->data);

        $reflection = new \ReflectionClass(broker::class);

        $method = $reflection->getMethod('process_extension_actions');

        $method->setAccessible(true);

        $method->invokeArgs(null, [$instance, $data]);

        $addondata = $DB->get_field('bbbext_simple', 'meetingevents', ['bigbluebuttonbnid' => $bbactivity->id]);

        $addondata = json_decode($addondata);

        // Check that the data is received.

        $this->assertEquals(json_encode($addondata), $data);

    }

    /**

     * Data provider for testing get_class_implementing

     *

     * @return array[]

     */

    public static function classes_implementing_class(): array {

        return [

            'mod_instance_helper with plugin disabled' => [

                'bbbenabled' => false,

                'apiclass' => mod_instance_helper::class,

                'extensionclasses' => [],

            ],

            'mod_instance_helper with plugin enabled' => [

                'bbbenabled' => true,

                'apiclass' => mod_instance_helper::class,

                'extensionclasses' => [

                    'bbbext_simple\\bigbluebuttonbn\\mod_instance_helper',

                ],

            ],

        ];

    }

    /**

     * Test the get_sorted_plugins_list

     * @param array $sortorders

     * @param array $expected

     * @return void

     * @dataProvider sorted_plugins_list_data_provider

     * @covers \mod_bigbluebuttonbn\extension::get_sorted_plugins_list

     */

    public function test_get_sorted_plugins_list(array $sortorders, array $expected): void {

        $this->resetAfterTest();

        // Enable plugin.

        $this->enable_plugins(true);

        // Create list of plugins we will then sort.

        $pluginlist = [

            'simpleone' => '/path/to/simpleone',

            'simpletwo' => '/path/to/simpletwo',

        ];

        // Set sortorder.

        foreach ($sortorders as $plugin => $sortorder) {

            set_config('sortorder', $sortorder, 'bbbext_' . $plugin);

        }

        $sortedlist = extension::get_sorted_plugins_list($pluginlist);

        $this->assertSame($expected, $sortedlist);

    }

    /**

     * Data provider for testing get_sorted_plugins_list

     *

     * @return array[]

     */

    public static function sorted_plugins_list_data_provider(): array {

        return [

            'no sortorder' => [

                [],

                ['simpleone', 'simpletwo'],

            ],

            'default sortorder' => [

                ['simpleone' => 0, 'simpletwo' => 1],

                ['simpleone', 'simpletwo'],

            ],

            'changed sortorder' => [

                ['simpleone' => 1, 'simpletwo' => 0],

                ['simpletwo', 'simpleone'],

            ],

        ];

    }

    /**

     * Enable plugins

     *

     * @param bool $bbbenabled

     * @return void

     */

    private function enable_plugins(bool $bbbenabled) {

        // First make sure that either BBB is enabled or not.

        \core\plugininfo\mod::enable_plugin('bigbluebuttonbn', $bbbenabled ? 1 : 0);

        $plugin = extension::BBB_EXTENSION_PLUGIN_NAME . '_simple';

        if ($bbbenabled) {

            unset_config('disabled', $plugin);

        } else {

            set_config('disabled', 'disabled', $plugin);

        }

    }

}