Merge branch 'MDL-65847-auth_db_error_handling' of git://github.com/leonstr/moodle...
[moodle.git] / contentbank / tests / external / rename_content_test.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Core content bank external functions tests.
19  *
20  * @package    core_contentbank
21  * @category   external
22  * @copyright  2020 Sara Arjona <sara@moodle.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  * @since      Moodle 3.9
25  */
27 namespace core_contentbank\external;
29 defined('MOODLE_INTERNAL') || die();
31 global $CFG;
32 require_once($CFG->dirroot . '/contentbank/tests/fixtures/testable_contenttype.php');
33 require_once($CFG->dirroot . '/contentbank/tests/fixtures/testable_content.php');
34 require_once($CFG->dirroot . '/webservice/tests/helpers.php');
36 use external_api;
38 /**
39  * Core content bank external functions tests.
40  *
41  * @package    core_contentbank
42  * @copyright  2020 Sara Arjona <sara@moodle.com>
43  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44  * @coversDefaultClass \core_contentbank\external
45  */
46 class rename_content_testcase extends \externallib_advanced_testcase {
48     /**
49      * Data provider for test_rename_content.
50      *
51      * @return  array
52      */
53     public function rename_content_provider() {
54         return [
55             'Standard name' => ['New name', 'New name'],
56             'Name with digits' => ['Today is 17/04/2017', 'Today is 17/04/2017'],
57             'Name with symbols' => ['Follow us: @moodle', 'Follow us: @moodle'],
58             'Name with tags' => ['This is <b>bold</b>', 'This is bold'],
59             'Long name' => [str_repeat('a', 100), str_repeat('a', 100)],
60             'Too long name' => [str_repeat('a', 300), str_repeat('a', 255)]
61         ];
62     }
64     /**
65      * Test the behaviour of rename_content() for users with permission.
66      *
67      * @dataProvider    rename_content_provider
68      * @param   string  $newname    The name to set
69      * @param   string   $expected   The name result
70      *
71      * @covers ::execute
72      */
73     public function test_rename_content_with_permission(string $newname, string $expected) {
74         global $DB;
75         $this->resetAfterTest();
77         // Create users.
78         $roleid = $DB->get_field('role', 'id', ['shortname' => 'editingteacher']);
79         $teacher = $this->getDataGenerator()->create_user();
81         $this->getDataGenerator()->role_assign($roleid, $teacher->id);
82         $this->setUser($teacher);
84         // Add some content to the content bank as teacher.
85         $generator = $this->getDataGenerator()->get_plugin_generator('core_contentbank');
86         $contents = $generator->generate_contentbank_data('contenttype_testable', 1, $teacher->id);
87         $content = array_shift($contents);
89         $oldname = $content->get_name();
91         // Call the WS and check the content is renamed as expected.
92         $result = rename_content::execute($content->get_id(), $newname);
93         $result = external_api::clean_returnvalue(rename_content::execute_returns(), $result);
94         $this->assertTrue($result['result']);
95         $record = $DB->get_record('contentbank_content', ['id' => $content->get_id()]);
96         $this->assertNotEquals($oldname, $record->name);
97         $this->assertEquals($expected, $record->name);
99         // Call the WS using an unexisting contentid and check an error is thrown.
100         $this->expectException(\invalid_response_exception::class);
101         $result = rename_content::execute_returns($content->get_id() + 1, $oldname);
102         $result = external_api::clean_returnvalue(rename_content::execute_returns(), $result);
103         $this->assertFalse($result['result']);
104     }
106     /**
107      * Test the behaviour of rename_content() for users with permission.
108      *
109      * @covers ::execute
110      */
111     public function test_rename_content_without_permission() {
112         global $DB;
113         $this->resetAfterTest();
115         // Create users.
116         $course = $this->getDataGenerator()->create_course();
117         $teacher = $this->getDataGenerator()->create_and_enrol($course, 'editingteacher');
118         $student = $this->getDataGenerator()->create_and_enrol($course, 'student');
120         // Add some content to the content bank as teacher.
121         $generator = $this->getDataGenerator()->get_plugin_generator('core_contentbank');
122         $contents = $generator->generate_contentbank_data('contenttype_testable', 1, $teacher->id);
123         $content = array_shift($contents);
125         $oldname = $content->get_name();
126         $newname = 'New name';
128         // Call the WS and check the content has not been renamed by the student.
129         $this->setUser($student);
130         $result = rename_content::execute($content->get_id(), $newname);
131         $result = external_api::clean_returnvalue(rename_content::execute_returns(), $result);
132         $this->assertFalse($result['result']);
133         $record = $DB->get_record('contentbank_content', ['id' => $content->get_id()]);
134         $this->assertEquals($oldname, $record->name);
135         $this->assertNotEquals($newname, $record->name);
136     }