Eloy Lafuente (stronk7)
5c884e835e
Applied the following changes to various testcase classes: - Namespaced with component[\level2-API] - Moved to level2-API subdirectory when required. - Fixed incorrect use statements with leading backslash. - Remove file phpdoc block - Remove MOODLE_INTERNAL if not needed. - Changed code to point to global scope when needed. - Fix some relative paths and comments here and there. - All them passing individually. - Complete runs passing too. Special mention to: - The following task tests have been moved within the level2 directory: - \core\adhoc_task_test => \core\task\adhoc_task_test - \core\scheduled_task_test => \core\task\scheduled_task_test - \core\calendar_cron_task_test => \core\task\calendar_cron_task_test - \core\h5p_get_content_types_task_test => \core\task\h5p_get_content_types_task_test - \core\task_database_logger_test => \core\task\database_logger_test - \core\task_logging_test => \core\task\logging_test - The following event tests have been moved within level2 directory: - \core\event_context_locked_test => \core\event\context_locked_test - \core\event_deprecated_test => \core\event\deprecated_test - \core\event_grade_deleted_test => \core\event\grade_deleted_test - \core\event_profile_field_test => \core\event\profile_field_test - \core\event_unknown_logged_test => \core\event\unknown_logged_test - \core\event_user_graded_test => \core\event\user_graded_test - \core\event_user_password_updated_test => \core\event\user_password_updated_test - The following output tests have been moved within level2 directory: - \core\mustache_template_finder_test => \core\output\mustache_template_finder_test - \core\mustache_template_source_loader_test => \core\output\mustache_template_source_loader_test - \core\output_mustache_helper_collection_test => \core\output\mustache_helper_collection_test - The following tests have been moved to their correct tests directories: - lib/tests/time_splittings_test.php => analytics/tests/time_splittings_test.php - All the classes and tests under lib/filebrowser and lib/filestorage belong to core, not to core_files. Some day we should move them to their correct subsystem. - All the classes and tests under lib/grade belong to core, not to core_grades. Some day we should move them to their correct subsystem. - The core_grades_external class and its \core\grades_external_test unit test should belong to the grades subsystem or, alternatively, to \core\external, they both should be moved together. - The core_grading_external class and its \core\grading_external_test unit test should belong to the grading subsystem or, alternatively, to \core\external, they both should be moved together. - The \core\message\message and \core\message\inbound (may be others) classes, and their associated tests should go to the core_message subsystem. - The core_user class, and its associated tests should go to the core_user subsystem. - The \core\update namespace is plain wrong (update is not valid API) and needs action 1) create it or 2) move elsewhere.
519 lines
18 KiB
PHP
519 lines
18 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
namespace core\output;
|
|
|
|
/**
|
|
* Unit tests for the Mustache source loader class.
|
|
*
|
|
* Unit tests for lib/classes/output/mustache_template_source_loader.php
|
|
*
|
|
* @package core
|
|
* @copyright 2018 Ryan Wyllie <ryan@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class mustache_template_source_loader_test extends \advanced_testcase {
|
|
/**
|
|
* Ensure that stripping comments from templates does not mutilate the template body.
|
|
*/
|
|
public function test_strip_template_comments() {
|
|
|
|
$templatebody = <<<'TBD'
|
|
<h1>{{# str }} pluginname, mod_lemmings {{/ str }}</h1>
|
|
<div>{{test}}</div>
|
|
<div>{{{unescapedtest}}}</div>
|
|
{{#lemmings}}
|
|
<div>
|
|
<h2>{{name}}</h2>
|
|
{{> mod_lemmings/lemmingprofile }}
|
|
{{# pix }} t/edit, core, Edit Lemming {{/ pix }}
|
|
</div>
|
|
{{/lemmings}}
|
|
{{^lemmings}}Sorry, no lemmings today{{/lemmings}}
|
|
<div id="{{ uniqid }}-tab-container">
|
|
{{# tabheader }}
|
|
<ul role="tablist" class="nav nav-tabs">
|
|
{{# iconlist }}
|
|
{{# icons }}
|
|
{{> core/pix_icon }}
|
|
{{/ icons }}
|
|
{{/ iconlist }}
|
|
</ul>
|
|
{{/ tabheader }}
|
|
{{# tabbody }}
|
|
<div class="tab-content">
|
|
{{# tabcontent }}
|
|
{{# tabs }}
|
|
{{> core/notification_info}}
|
|
{{/ tabs }}
|
|
{{/ tabcontent }}
|
|
</div>
|
|
{{/ tabbody }}
|
|
</div>
|
|
{{#js}}
|
|
require(['jquery','core/tabs'], function($, tabs) {
|
|
|
|
var container = $("#{{ uniqid }}-tab-container");
|
|
tabs.create(container);
|
|
});
|
|
{{/js}}
|
|
TBD;
|
|
$templatewithcomment = <<<TBC
|
|
{{!
|
|
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/>.
|
|
}}
|
|
{{!
|
|
@template mod_lemmings/lemmings
|
|
|
|
Lemmings template.
|
|
|
|
The purpose of this template is to render a lot of lemmings.
|
|
|
|
Classes required for JS:
|
|
* none
|
|
|
|
Data attributes required for JS:
|
|
* none
|
|
|
|
Context variables required for this template:
|
|
* attributes Array of name / value pairs.
|
|
|
|
Example context (json):
|
|
{
|
|
"lemmings": [
|
|
{ "name": "Lemmy Winks", "age" : 1, "size" : "big" },
|
|
{ "name": "Rocky", "age" : 2, "size" : "small" }
|
|
]
|
|
}
|
|
|
|
}}
|
|
$templatebody
|
|
{{!
|
|
Here's some more comment text
|
|
Note, there is no need to test bracketed variables inside comments as gherkin does not support that!
|
|
See this issue: https://github.com/mustache/spec/issues/8
|
|
}}
|
|
TBC;
|
|
|
|
$loader = new mustache_template_source_loader();
|
|
$actual = \phpunit_util::call_internal_method(
|
|
$loader,
|
|
'strip_template_comments',
|
|
[$templatewithcomment],
|
|
\core\output\mustache_template_source_loader::class
|
|
);
|
|
$this->assertEquals(trim($templatebody), trim($actual));
|
|
}
|
|
|
|
/**
|
|
* Data provider for the test_load function.
|
|
*/
|
|
public function test_load_test_cases() {
|
|
$cache = [
|
|
'core' => [
|
|
'test' => '{{! a comment }}The rest of the template'
|
|
]
|
|
];
|
|
$loader = $this->build_loader_from_static_cache($cache);
|
|
|
|
return [
|
|
'with comments' => [
|
|
'loader' => $loader,
|
|
'component' => 'core',
|
|
'name' => 'test',
|
|
'includecomments' => true,
|
|
'expected' => '{{! a comment }}The rest of the template'
|
|
],
|
|
'without comments' => [
|
|
'loader' => $loader,
|
|
'component' => 'core',
|
|
'name' => 'test',
|
|
'includecomments' => false,
|
|
'expected' => 'The rest of the template'
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Test the load function.
|
|
*
|
|
* @dataProvider test_load_test_cases()
|
|
* @param mustache_template_source_loader $loader The loader
|
|
* @param string $component The moodle component
|
|
* @param string $name The template name
|
|
* @param bool $includecomments Whether to strip comments
|
|
* @param string $expected The expected output
|
|
*/
|
|
public function test_load($loader, $component, $name, $includecomments, $expected) {
|
|
$this->assertEquals($expected, $loader->load($component, $name, 'boost', $includecomments));
|
|
}
|
|
|
|
/**
|
|
* Data provider for the load_with_dependencies function.
|
|
*/
|
|
public function test_load_with_dependencies_test_cases() {
|
|
// Create a bunch of templates that include one another in various ways. There is
|
|
// multiple instances of recursive inclusions to test that the code doensn't get
|
|
// stuck in an infinite loop.
|
|
$foo = '{{! a comment }}{{> core/bar }}{{< test/bop }}{{/ test/bop}}{{#str}} help, core {{/str}}';
|
|
$foo2 = '{{! a comment }}hello';
|
|
$bar = '{{! a comment }}{{> core/baz }}';
|
|
$baz = '{{! a comment }}{{#str}} hide, core {{/str}}';
|
|
$bop = '{{! a comment }}{{< test/bim }}{{/ test/bim }}{{> core/foo }}';
|
|
$bim = '{{! a comment }}{{< core/foo }}{{/ core/foo}}{{> test/foo }}';
|
|
$foonocomment = '{{> core/bar }}{{< test/bop }}{{/ test/bop}}{{#str}} help, core {{/str}}';
|
|
$foo2nocomment = 'hello';
|
|
$barnocomment = '{{> core/baz }}';
|
|
$baznocomment = '{{#str}} hide, core {{/str}}';
|
|
$bopnocomment = '{{< test/bim }}{{/ test/bim }}{{> core/foo }}';
|
|
$bimnocomment = '{{< core/foo }}{{/ core/foo}}{{> test/foo }}';
|
|
$cache = [
|
|
'core' => [
|
|
'foo' => $foo,
|
|
'bar' => $bar,
|
|
'baz' => $baz,
|
|
],
|
|
'test' => [
|
|
'foo' => $foo2,
|
|
'bop' => $bop,
|
|
'bim' => $bim
|
|
]
|
|
];
|
|
$loader = $this->build_loader_from_static_cache($cache);
|
|
|
|
return [
|
|
'no template includes w comments' => [
|
|
'loader' => $loader,
|
|
'component' => 'test',
|
|
'name' => 'foo',
|
|
'includecomments' => true,
|
|
'expected' => [
|
|
'templates' => [
|
|
'test' => [
|
|
'foo' => $foo2
|
|
]
|
|
],
|
|
'strings' => []
|
|
]
|
|
],
|
|
'no template includes w/o comments' => [
|
|
'loader' => $loader,
|
|
'component' => 'test',
|
|
'name' => 'foo',
|
|
'includecomments' => false,
|
|
'expected' => [
|
|
'templates' => [
|
|
'test' => [
|
|
'foo' => $foo2nocomment
|
|
]
|
|
],
|
|
'strings' => []
|
|
]
|
|
],
|
|
'no template includes with string w comments' => [
|
|
'loader' => $loader,
|
|
'component' => 'core',
|
|
'name' => 'baz',
|
|
'includecomments' => true,
|
|
'expected' => [
|
|
'templates' => [
|
|
'core' => [
|
|
'baz' => $baz
|
|
]
|
|
],
|
|
'strings' => [
|
|
'core' => [
|
|
'hide' => 'Hide'
|
|
]
|
|
]
|
|
]
|
|
],
|
|
'no template includes with string w/o comments' => [
|
|
'loader' => $loader,
|
|
'component' => 'core',
|
|
'name' => 'baz',
|
|
'includecomments' => false,
|
|
'expected' => [
|
|
'templates' => [
|
|
'core' => [
|
|
'baz' => $baznocomment
|
|
]
|
|
],
|
|
'strings' => [
|
|
'core' => [
|
|
'hide' => 'Hide'
|
|
]
|
|
]
|
|
]
|
|
],
|
|
'full with comments' => [
|
|
'loader' => $loader,
|
|
'component' => 'core',
|
|
'name' => 'foo',
|
|
'includecomments' => true,
|
|
'expected' => [
|
|
'templates' => [
|
|
'core' => [
|
|
'foo' => $foo,
|
|
'bar' => $bar,
|
|
'baz' => $baz
|
|
],
|
|
'test' => [
|
|
'foo' => $foo2,
|
|
'bop' => $bop,
|
|
'bim' => $bim
|
|
]
|
|
],
|
|
'strings' => [
|
|
'core' => [
|
|
'help' => 'Help',
|
|
'hide' => 'Hide'
|
|
]
|
|
]
|
|
]
|
|
],
|
|
'full without comments' => [
|
|
'loader' => $loader,
|
|
'component' => 'core',
|
|
'name' => 'foo',
|
|
'includecomments' => false,
|
|
'expected' => [
|
|
'templates' => [
|
|
'core' => [
|
|
'foo' => $foonocomment,
|
|
'bar' => $barnocomment,
|
|
'baz' => $baznocomment
|
|
],
|
|
'test' => [
|
|
'foo' => $foo2nocomment,
|
|
'bop' => $bopnocomment,
|
|
'bim' => $bimnocomment
|
|
]
|
|
],
|
|
'strings' => [
|
|
'core' => [
|
|
'help' => 'Help',
|
|
'hide' => 'Hide'
|
|
]
|
|
]
|
|
]
|
|
]
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Test the load_with_dependencies function.
|
|
*
|
|
* @dataProvider test_load_with_dependencies_test_cases()
|
|
* @param mustache_template_source_loader $loader The loader
|
|
* @param string $component The moodle component
|
|
* @param string $name The template name
|
|
* @param bool $includecomments Whether to strip comments
|
|
* @param string $expected The expected output
|
|
*/
|
|
public function test_load_with_dependencies($loader, $component, $name, $includecomments, $expected) {
|
|
$actual = $loader->load_with_dependencies($component, $name, 'boost', $includecomments);
|
|
$this->assertEquals($expected, $actual);
|
|
}
|
|
/**
|
|
* Data provider for the test_load function.
|
|
*/
|
|
public function test_scan_template_source_for_dependencies_test_cases() {
|
|
$foo = '{{! a comment }}{{> core/bar }}{{< test/bop }}{{/ test/bop}}{{#str}} help, core {{/str}}';
|
|
$bar = '{{! a comment }}{{> core/baz }}';
|
|
$baz = '{{! a comment }}{{#str}} hide, core {{/str}}';
|
|
$bop = '{{! a comment }}hello';
|
|
$multiline1 = <<<TEMPLATE
|
|
{{! a comment }}{{#str}} authorreplyingprivatelytoauthor,
|
|
mod_forum {{/str}}
|
|
TEMPLATE;
|
|
$multiline2 = <<<TEMPLATE
|
|
{{! a comment }}{{#str}}
|
|
authorreplyingprivatelytoauthor,
|
|
mod_forum {{/str}}
|
|
TEMPLATE;
|
|
$multiline3 = <<<TEMPLATE
|
|
{{! a comment }}{{#str}}
|
|
authorreplyingprivatelytoauthor,
|
|
mod_forum
|
|
{{/str}}
|
|
TEMPLATE;
|
|
$multiline4 = <<<TEMPLATE
|
|
{{! a comment }}{{#str}}
|
|
authorreplyingprivatelytoauthor, mod_forum
|
|
{{/str}}
|
|
TEMPLATE;
|
|
$multiline5 = <<<TEMPLATE
|
|
{{! a comment }}{{#str}}
|
|
hide
|
|
{{/str}}
|
|
TEMPLATE;
|
|
|
|
$cache = [
|
|
'core' => [
|
|
'foo' => $foo,
|
|
'bar' => $bar,
|
|
'baz' => $baz,
|
|
'bop' => $bop,
|
|
'multiline1' => $multiline1,
|
|
'multiline2' => $multiline2,
|
|
'multiline3' => $multiline3,
|
|
'multiline4' => $multiline4,
|
|
'multiline5' => $multiline5,
|
|
]
|
|
];
|
|
$loader = $this->build_loader_from_static_cache($cache);
|
|
|
|
return [
|
|
'single template include' => [
|
|
'loader' => $loader,
|
|
'source' => $bar,
|
|
'expected' => [
|
|
'templates' => [
|
|
'core' => ['baz']
|
|
],
|
|
'strings' => []
|
|
]
|
|
],
|
|
'single string include' => [
|
|
'loader' => $loader,
|
|
'source' => $baz,
|
|
'expected' => [
|
|
'templates' => [],
|
|
'strings' => [
|
|
'core' => ['hide']
|
|
]
|
|
]
|
|
],
|
|
'no include' => [
|
|
'loader' => $loader,
|
|
'source' => $bop,
|
|
'expected' => [
|
|
'templates' => [],
|
|
'strings' => []
|
|
]
|
|
],
|
|
'all include' => [
|
|
'loader' => $loader,
|
|
'source' => $foo,
|
|
'expected' => [
|
|
'templates' => [
|
|
'core' => ['bar'],
|
|
'test' => ['bop']
|
|
],
|
|
'strings' => [
|
|
'core' => ['help']
|
|
]
|
|
]
|
|
],
|
|
'string: component on new line' => [
|
|
'loader' => $loader,
|
|
'source' => $multiline1,
|
|
'expected' => [
|
|
'templates' => [],
|
|
'strings' => [
|
|
'mod_forum' => ['authorreplyingprivatelytoauthor']
|
|
]
|
|
]
|
|
],
|
|
'string: identifier on own line' => [
|
|
'loader' => $loader,
|
|
'source' => $multiline2,
|
|
'expected' => [
|
|
'templates' => [],
|
|
'strings' => [
|
|
'mod_forum' => ['authorreplyingprivatelytoauthor']
|
|
]
|
|
]
|
|
],
|
|
'string: all parts on new lines' => [
|
|
'loader' => $loader,
|
|
'source' => $multiline3,
|
|
'expected' => [
|
|
'templates' => [],
|
|
'strings' => [
|
|
'mod_forum' => ['authorreplyingprivatelytoauthor']
|
|
]
|
|
]
|
|
],
|
|
'string: id and component on own line' => [
|
|
'loader' => $loader,
|
|
'source' => $multiline4,
|
|
'expected' => [
|
|
'templates' => [],
|
|
'strings' => [
|
|
'mod_forum' => ['authorreplyingprivatelytoauthor']
|
|
]
|
|
]
|
|
],
|
|
'string: no component' => [
|
|
'loader' => $loader,
|
|
'source' => $multiline5,
|
|
'expected' => [
|
|
'templates' => [],
|
|
'strings' => [
|
|
'core' => ['hide']
|
|
]
|
|
]
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Test the scan_template_source_for_dependencies function.
|
|
*
|
|
* @dataProvider test_scan_template_source_for_dependencies_test_cases()
|
|
* @param mustache_template_source_loader $loader The loader
|
|
* @param string $source The template to test
|
|
* @param string $expected The expected output
|
|
*/
|
|
public function test_scan_template_source_for_dependencies($loader, $source, $expected) {
|
|
$actual = \phpunit_util::call_internal_method(
|
|
$loader,
|
|
'scan_template_source_for_dependencies',
|
|
[$source],
|
|
\core\output\mustache_template_source_loader::class
|
|
);
|
|
$this->assertEquals($expected, $actual);
|
|
}
|
|
|
|
/**
|
|
* Create an instance of mustache_template_source_loader which loads its templates
|
|
* from the given cache rather than disk.
|
|
*
|
|
* @param array $cache A cache of templates
|
|
* @return mustache_template_source_loader
|
|
*/
|
|
private function build_loader_from_static_cache(array $cache) : mustache_template_source_loader {
|
|
return new mustache_template_source_loader(function($component, $name, $themename) use ($cache) {
|
|
return $cache[$component][$name];
|
|
});
|
|
}
|
|
}
|