<?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/>.
/**
* Testing the H5P core methods.
*
* @package core_h5p
* @category test
* @copyright 2019 Victor Deniz <victor@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core_h5p;
use core_h5p\local\library\autoloader;
defined('MOODLE_INTERNAL') || die();
/**
* Test class covering the H5PFileStorage interface implementation.
*
* @package core_h5p
* @copyright 2019 Victor Deniz <victor@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*
* @runTestsInSeparateProcesses
*/
< class h5p_core_testcase extends \advanced_testcase {
> class h5p_core_test extends \advanced_testcase {
>
> /** @var core */
> protected $core;
protected function setUp(): void {
global $CFG;
parent::setUp();
autoloader::register();
require_once($CFG->libdir . '/tests/fixtures/testable_core_h5p.php');
$factory = new h5p_test_factory();
$this->core = $factory->get_core();
$this->core->set_endpoint($this->getExternalTestFileUrl(''));
}
/**
* Check that given an H5P content type machine name, the required library are fetched and installed from the official H5P
* repository.
*/
public function test_fetch_content_type(): void {
global $DB;
if (!PHPUNIT_LONGTEST) {
$this->markTestSkipped('PHPUNIT_LONGTEST is not defined');
}
$this->resetAfterTest(true);
// Get info of latest content types versions.
$contenttypes = $this->core->get_latest_content_types()->contentTypes;
// We are installing the first content type with tutorial and example fields (or the first one if none has them).
$librarydata = $contenttypes[0];
foreach ($contenttypes as $contentype) {
if (isset($contenttype->tutorial) && isset($contenttype->example)) {
$librarydata = $contenttype;
break;
}
}
$library = [
'machineName' => $librarydata->id,
'majorVersion' => $librarydata->version->major,
'minorVersion' => $librarydata->version->minor,
'patchVersion' => $librarydata->version->patch,
];
// Add example and tutorial to the library.
if (isset($librarydata->example)) {
$library['example'] = $librarydata->example;
}
if (isset($librarydata->tutorial)) {
$library['tutorial'] = $librarydata->tutorial;
}
// Verify that the content type is not yet installed.
$conditions['machinename'] = $library['machineName'];
$typeinstalled = $DB->count_records('h5p_libraries', $conditions);
$this->assertEquals(0, $typeinstalled);
// Fetch the content type.
$this->core->fetch_content_type($library);
// Check that the content type is now installed.
$typeinstalled = $DB->get_record('h5p_libraries', $conditions);
$this->assertEquals($librarydata->id, $typeinstalled->machinename);
$this->assertEquals($librarydata->coreApiVersionNeeded->major, $typeinstalled->coremajor);
$this->assertEquals($librarydata->coreApiVersionNeeded->minor, $typeinstalled->coreminor);
if (isset($librarydata->tutorial)) {
$this->assertEquals($librarydata->tutorial, $typeinstalled->tutorial);
$this->assertEquals($librarydata->example, $typeinstalled->example);
}
}
/**
* Test that latest version of non installed H5P content type libraries are fetched and installed from the
* official H5P repository. To speed up the test, only if checked that one content type is installed.
*/
public function test_fetch_latest_content_types(): void {
global $DB;
if (!PHPUNIT_LONGTEST) {
$this->markTestSkipped('PHPUNIT_LONGTEST is not defined');
}
$this->resetAfterTest(true);
$contentfiles = $DB->count_records('h5p_libraries');
// Initially there are no h5p records in database.
$this->assertEquals(0, $contentfiles);
$contenttypespending = ['H5P.Accordion'];
// Fetch generator.
$generator = \testing_util::get_data_generator();
$h5pgenerator = $generator->get_plugin_generator('core_h5p');
// Get info of latest content types versions.
[$installedtypes, $typesnotinstalled] = $h5pgenerator->create_content_types($contenttypespending, $this->core);
// Number of H5P content types.
$numcontenttypes = $installedtypes + $typesnotinstalled;
// Content type libraries has runnable set to 1.
$conditions = ['runnable' => 1];
$contentfiles = $DB->get_records('h5p_libraries', $conditions, '', 'machinename');
// There is a record for each installed content type, except the one that was hold for later.
$this->assertEquals($numcontenttypes - 1, count($contentfiles));
$this->assertArrayNotHasKey($contenttypespending[0], $contentfiles);
$result = $this->core->fetch_latest_content_types();
$contentfiles = $DB->get_records('h5p_libraries', $conditions, '', 'machinename');
// There is a new record for the new installed content type.
$this->assertCount($numcontenttypes, $contentfiles);
$this->assertArrayHasKey($contenttypespending[0], $contentfiles);
$this->assertCount(1, $result->typesinstalled);
$this->assertStringStartsWith($contenttypespending[0], $result->typesinstalled[0]['name']);
// New execution doesn't install any content type.
$result = $this->core->fetch_latest_content_types();
$contentfiles = $DB->get_records('h5p_libraries', $conditions, '', 'machinename');
$this->assertEquals($numcontenttypes, count($contentfiles));
$this->assertCount(0, $result->typesinstalled);
}
/**
* Test that if site_uuid is not set, the site is registered and site_uuid is set.
*
*/
public function test_get_site_uuid(): void {
$this->resetAfterTest(true);
if (!PHPUNIT_LONGTEST) {
$this->markTestSkipped('PHPUNIT_LONGTEST is not defined');
}
// Check that site_uuid does not have a value.
$this->assertFalse(get_config('core_h5p', 'site_uuid'));
$siteuuid = $this->core->get_site_uuid();
$this->assertSame($siteuuid, get_config('core_h5p', 'site_uuid'));
// Check that after a new request the site_uuid remains the same.
$siteuuid2 = $this->core->get_site_uuid();
$this->assertEquals( $siteuuid, $siteuuid2);
}
/**
* Test if no handler has been defined.
*/
public function test_get_default_handler() {
global $CFG;
$this->resetAfterTest(true);
// Emtpy the h5plibraryhandler setting.
$CFG->h5plibraryhandler = '';
// Get the default habdler library to use in the settings h5p page.
// For instance, h5plib_v124.
$handlerlib = autoloader::get_default_handler_library();
$this->assertNotNull($handlerlib);
$this->assertStringNotContainsString($handlerlib, '\local\library\handler');
// Get the default handler class.
// For instance, \h5plib_v124\local\library\handler.
$handlerclass = autoloader::get_default_handler();
$this->assertStringEndsWith('\local\library\handler', $handlerclass);
}
}