+<?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/>.
+
+/**
+ * External mod_label functions unit tests
+ *
+ * @package mod_label
+ * @category external
+ * @copyright 2017 Juan Leyva <juan@moodle.com>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 3.3
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+require_once($CFG->dirroot . '/webservice/tests/helpers.php');
+
+/**
+ * External mod_label functions unit tests
+ *
+ * @package mod_label
+ * @category external
+ * @copyright 2017 Juan Leyva <juan@moodle.com>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 3.3
+ */
+class mod_label_external_testcase extends externallib_advanced_testcase {
+
+ /**
+ * Test test_mod_label_get_labels_by_courses
+ */
+ public function test_mod_label_get_labels_by_courses() {
+ global $DB;
+
+ $this->resetAfterTest(true);
+
+ $course1 = self::getDataGenerator()->create_course();
+ $course2 = self::getDataGenerator()->create_course();
+
+ $student = self::getDataGenerator()->create_user();
+ $studentrole = $DB->get_record('role', array('shortname' => 'student'));
+ $this->getDataGenerator()->enrol_user($student->id, $course1->id, $studentrole->id);
+
+ // First label.
+ $record = new stdClass();
+ $record->course = $course1->id;
+ $label1 = self::getDataGenerator()->create_module('label', $record);
+
+ // Second label.
+ $record = new stdClass();
+ $record->course = $course2->id;
+ $label2 = self::getDataGenerator()->create_module('label', $record);
+
+ // Execute real Moodle enrolment as we'll call unenrol() method on the instance later.
+ $enrol = enrol_get_plugin('manual');
+ $enrolinstances = enrol_get_instances($course2->id, true);
+ foreach ($enrolinstances as $courseenrolinstance) {
+ if ($courseenrolinstance->enrol == "manual") {
+ $instance2 = $courseenrolinstance;
+ break;
+ }
+ }
+ $enrol->enrol_user($instance2, $student->id, $studentrole->id);
+
+ self::setUser($student);
+
+ $returndescription = mod_label_external::get_labels_by_courses_returns();
+
+ // Create what we expect to be returned when querying the two courses.
+ $expectedfields = array('id', 'course', 'name', 'intro', 'introformat', 'introfiles', 'timemodified', 'section',
+ 'visible', 'groupmode', 'groupingid');
+
+ // Add expected coursemodule and data.
+ $label1->coursemodule = $label1->cmid;
+ $label1->introformat = 1;
+ $label1->section = 0;
+ $label1->visible = true;
+ $label1->groupmode = 0;
+ $label1->groupingid = 0;
+ $label1->introfiles = [];
+
+ $label2->coursemodule = $label2->cmid;
+ $label2->introformat = 1;
+ $label2->section = 0;
+ $label2->visible = true;
+ $label2->groupmode = 0;
+ $label2->groupingid = 0;
+ $label2->introfiles = [];
+
+ foreach ($expectedfields as $field) {
+ $expected1[$field] = $label1->{$field};
+ $expected2[$field] = $label2->{$field};
+ }
+
+ $expectedlabels = array($expected2, $expected1);
+
+ // Call the external function passing course ids.
+ $result = mod_label_external::get_labels_by_courses(array($course2->id, $course1->id));
+ $result = external_api::clean_returnvalue($returndescription, $result);
+
+ $this->assertEquals($expectedlabels, $result['labels']);
+ $this->assertCount(0, $result['warnings']);
+
+ // Call the external function without passing course id.
+ $result = mod_label_external::get_labels_by_courses();
+ $result = external_api::clean_returnvalue($returndescription, $result);
+ $this->assertEquals($expectedlabels, $result['labels']);
+ $this->assertCount(0, $result['warnings']);
+
+ // Add a file to the intro.
+ $filename = "file.txt";
+ $filerecordinline = array(
+ 'contextid' => context_module::instance($label2->cmid)->id,
+ 'component' => 'mod_label',
+ 'filearea' => 'intro',
+ 'itemid' => 0,
+ 'filepath' => '/',
+ 'filename' => $filename,
+ );
+ $fs = get_file_storage();
+ $timepost = time();
+ $fs->create_file_from_string($filerecordinline, 'image contents (not really)');
+
+ $result = mod_label_external::get_labels_by_courses(array($course2->id, $course1->id));
+ $result = external_api::clean_returnvalue($returndescription, $result);
+
+ $this->assertCount(1, $result['labels'][0]['introfiles']);
+ $this->assertEquals($filename, $result['labels'][0]['introfiles'][0]['filename']);
+
+ // Unenrol user from second course.
+ $enrol->unenrol_user($instance2, $student->id);
+ array_shift($expectedlabels);
+
+ // Call the external function without passing course id.
+ $result = mod_label_external::get_labels_by_courses();
+ $result = external_api::clean_returnvalue($returndescription, $result);
+ $this->assertEquals($expectedlabels, $result['labels']);
+
+ // Call for the second course we unenrolled the user from, expected warning.
+ $result = mod_label_external::get_labels_by_courses(array($course2->id));
+ $this->assertCount(1, $result['warnings']);
+ $this->assertEquals('1', $result['warnings'][0]['warningcode']);
+ $this->assertEquals($course2->id, $result['warnings'][0]['itemid']);
+ }
+}
