From 487bc1b6273a7202735c09a42bc1b5aa631de17f Mon Sep 17 00:00:00 2001 From: Jerome Mouneyrac Date: Fri, 26 Apr 2013 15:13:03 +0800 Subject: [PATCH] MDL-38440 WebService get_contents doesn't return the full text of labels --- course/externallib.php | 6 ++- course/tests/externallib_test.php | 42 +++++++++++++---- mod/label/tests/generator/lib.php | 72 ++++++++++++++++++++++++++++++ mod/label/tests/generator_test.php | 65 +++++++++++++++++++++++++++ 4 files changed, 175 insertions(+), 10 deletions(-) create mode 100644 mod/label/tests/generator/lib.php create mode 100644 mod/label/tests/generator_test.php diff --git a/course/externallib.php b/course/externallib.php index 72d62dca7e308..6b772419839d5 100644 --- a/course/externallib.php +++ b/course/externallib.php @@ -145,8 +145,10 @@ public static function get_course_contents($courseid, $options = array()) { $modcontext = context_module::instance($cm->id); - if (!empty($cm->showdescription)) { - $module['description'] = $cm->get_content(); + if (!empty($cm->showdescription) or $cm->modname == 'label') { + // We want to use the external format. However from reading get_formatted_content(), get_content() format is always FORMAT_HTML. + list($module['description'], $descriptionformat) = external_format_text($cm->get_content(), + FORMAT_HTML, $modcontext->id, $cm->modname, 'intro', $cm->id); } //url of the module diff --git a/course/tests/externallib_test.php b/course/tests/externallib_test.php index b6d9286fbbe30..59e0c608a7877 100644 --- a/course/tests/externallib_test.php +++ b/course/tests/externallib_test.php @@ -568,28 +568,54 @@ public function test_get_course_contents() { $this->resetAfterTest(true); $course = self::getDataGenerator()->create_course(); - $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course->id)); + $forumdescription = 'This is the forum description'; + $forum = $this->getDataGenerator()->create_module('forum', + array('course'=>$course->id, 'intro' => $forumdescription), + array('showdescription' => true)); $forumcm = get_coursemodule_from_id('forum', $forum->cmid); - $forumcontext = context_module::instance($forum->cmid); $data = $this->getDataGenerator()->create_module('data', array('assessed'=>1, 'scale'=>100, 'course'=>$course->id)); - $datacontext = context_module::instance($data->cmid); $datacm = get_coursemodule_from_instance('page', $data->id); $page = $this->getDataGenerator()->create_module('page', array('course'=>$course->id)); - $pagecontext = context_module::instance($page->cmid); $pagecm = get_coursemodule_from_instance('page', $page->id); + $labeldescription = 'This is a very long label to test if more than 50 characters are returned. + So bla bla bla bla bold bold bold bla bla bla bla.'; + $label = $this->getDataGenerator()->create_module('label', array('course' => $course->id, + 'intro' => $labeldescription)); + $labelcm = get_coursemodule_from_instance('label', $label->id); // Set the required capabilities by the external function. $context = context_course::instance($course->id); $roleid = $this->assignUserCapability('moodle/course:view', $context->id); $this->assignUserCapability('moodle/course:update', $context->id, $roleid); - $courses = core_course_external::get_course_contents($course->id, array()); + $sections = core_course_external::get_course_contents($course->id, array()); // We need to execute the return values cleaning process to simulate the web service server. - $courses = external_api::clean_returnvalue(core_course_external::get_course_contents_returns(), $courses); + $sections = external_api::clean_returnvalue(core_course_external::get_course_contents_returns(), $sections); + + // Check that forum and label descriptions are correctly returned. + $firstsection = array_pop($sections); + $modinfo = get_fast_modinfo($course); + $testexecuted = 0; + foreach($firstsection['modules'] as $module) { + if ($module['id'] == $forumcm->id and $module['modname'] == 'forum') { + $cm = $modinfo->cms[$forumcm->id]; + $formattedtext = format_text($cm->get_content(), FORMAT_HTML, + array('noclean' => true, 'para' => false, 'filter' => false)); + $this->assertEquals($formattedtext, $module['description']); + $testexecuted = $testexecuted + 1; + } else if ($module['id'] == $labelcm->id and $module['modname'] == 'label') { + $cm = $modinfo->cms[$labelcm->id]; + $formattedtext = format_text($cm->get_content(), FORMAT_HTML, + array('noclean' => true, 'para' => false, 'filter' => false)); + $this->assertEquals($formattedtext, $module['description']); + $testexecuted = $testexecuted + 1; + } + } + $this->assertEquals(2, $testexecuted); - // Check that the course has the 3 created modules - $this->assertEquals(3, count($courses[0]['modules'])); + // Check that the only return section has the 4 created modules + $this->assertEquals(4, count($firstsection['modules'])); } /** diff --git a/mod/label/tests/generator/lib.php b/mod/label/tests/generator/lib.php new file mode 100644 index 0000000000000..311dafa66c67e --- /dev/null +++ b/mod/label/tests/generator/lib.php @@ -0,0 +1,72 @@ +. + +/** + * mod_label data generator + * + * @package mod_label + * @category test + * @copyright 2013 Jerome Mouneyrac + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +defined('MOODLE_INTERNAL') || die(); + + +/** + * Label module data generator class + * + * @package mod_label + * @category test + * @copyright 2013 Jerome Mouneyrac + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class mod_label_generator extends testing_module_generator { + + /** + * Create new label module instance + * @param array|stdClass $record + * @param array $options + * @return stdClass activity record with extra cmid field + */ + public function create_instance($record = null, array $options = null) { + global $CFG; + require_once("$CFG->dirroot/mod/label/lib.php"); + + $this->instancecount++; + $i = $this->instancecount; + + $record = (object)(array)$record; + $options = (array)$options; + + if (empty($record->course)) { + throw new coding_exception('module generator requires $record->course'); + } + if (!isset($record->name)) { + $record->name = get_string('pluginname', 'label').' '.$i; + } + if (!isset($record->intro)) { + $record->intro = 'Test label '.$i; + } + if (!isset($record->introformat)) { + $record->introformat = FORMAT_MOODLE; + } + + $record->coursemodule = $this->precreate_course_module($record->course, $options); + $id = label_add_instance($record, null); + return $this->post_add_instance($id, $record->coursemodule); + } +} diff --git a/mod/label/tests/generator_test.php b/mod/label/tests/generator_test.php new file mode 100644 index 0000000000000..71582d965d0bb --- /dev/null +++ b/mod/label/tests/generator_test.php @@ -0,0 +1,65 @@ +. + +/** + * PHPUnit label generator tests + * + * @package mod_label + * @category phpunit + * @copyright 2013 Jerome Mouneyrac + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +defined('MOODLE_INTERNAL') || die(); + + +/** + * PHPUnit label generator testcase + * + * @package mod_label + * @category phpunit + * @copyright 2013 Jerome Mouneyrac + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class mod_label_generator_testcase extends advanced_testcase { + public function test_generator() { + global $DB; + + $this->resetAfterTest(true); + + $this->assertEquals(0, $DB->count_records('label')); + + $course = $this->getDataGenerator()->create_course(); + + /** @var mod_label_generator $generator */ + $generator = $this->getDataGenerator()->get_plugin_generator('mod_label'); + $this->assertInstanceOf('mod_label_generator', $generator); + $this->assertEquals('label', $generator->get_modulename()); + + $generator->create_instance(array('course'=>$course->id)); + $generator->create_instance(array('course'=>$course->id)); + $label = $generator->create_instance(array('course'=>$course->id)); + $this->assertEquals(3, $DB->count_records('label')); + + $cm = get_coursemodule_from_instance('label', $label->id); + $this->assertEquals($label->id, $cm->instance); + $this->assertEquals('label', $cm->modname); + $this->assertEquals($course->id, $cm->course); + + $context = context_module::instance($cm->id); + $this->assertEquals($label->cmid, $context->instanceid); + } +}