MDL-64656 core_tag: Return tags in modules and blog
[moodle.git] / tag / tests / external_test.php
CommitLineData
8e355853
MG
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/>.
16
17/**
18 * Unit tests for WS in tags
19 *
20 * @package core_tag
21 * @category test
22 * @copyright 2015 Marina Glancy
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 */
25
26defined('MOODLE_INTERNAL') || die();
27
28global $CFG;
29
8e355853
MG
30require_once($CFG->libdir . '/externallib.php');
31require_once($CFG->dirroot . '/webservice/tests/helpers.php');
32
33class core_tag_external_testcase extends externallib_advanced_testcase {
34 /**
35 * Test update_categories
36 */
37 public function test_update_tags() {
38 global $DB;
39 $this->resetAfterTest();
40 $context = context_system::instance();
41
42 $originaltag = array(
e11d7380 43 'isstandard' => 0,
8e355853
MG
44 'flag' => 1,
45 'rawname' => 'test',
46 'description' => 'desc'
47 );
48 $tag = $this->getDataGenerator()->create_tag($originaltag);
49
50 $updatetag = array(
51 'id' => $tag->id,
52 'description' => 'Trying to change tag description',
53 'rawname' => 'Trying to change tag name',
54 'flag' => 0,
e11d7380 55 'isstandard' => 1,
8e355853 56 );
ef4c23cc
MG
57 $gettag = array(
58 'id' => $tag->id,
59 );
8e355853 60
ef4c23cc 61 // User without any caps can not change anything about a tag but can request [partial] tag data.
8e355853
MG
62 $this->setUser($this->getDataGenerator()->create_user());
63 $result = core_tag_external::update_tags(array($updatetag));
64 $result = external_api::clean_returnvalue(core_tag_external::update_tags_returns(), $result);
ef4c23cc
MG
65 $this->assertEquals($tag->id, $result['warnings'][0]['item']);
66 $this->assertEquals('nothingtoupdate', $result['warnings'][0]['warningcode']);
8e355853 67 $this->assertEquals($originaltag['rawname'], $DB->get_field('tag', 'rawname',
ef4c23cc 68 array('id' => $tag->id)));
8e355853 69 $this->assertEquals($originaltag['description'], $DB->get_field('tag', 'description',
ef4c23cc
MG
70 array('id' => $tag->id)));
71
72 $result = core_tag_external::get_tags(array($gettag));
73 $result = external_api::clean_returnvalue(core_tag_external::get_tags_returns(), $result);
74 $this->assertEquals($originaltag['rawname'], $result['tags'][0]['rawname']);
75 $this->assertEquals($originaltag['description'], $result['tags'][0]['description']);
76 $this->assertNotEmpty($result['tags'][0]['viewurl']);
77 $this->assertArrayNotHasKey('changetypeurl', $result['tags'][0]);
78 $this->assertArrayNotHasKey('changeflagurl', $result['tags'][0]);
79 $this->assertArrayNotHasKey('flag', $result['tags'][0]);
80 $this->assertArrayNotHasKey('official', $result['tags'][0]);
e11d7380 81 $this->assertArrayNotHasKey('isstandard', $result['tags'][0]);
8e355853
MG
82
83 // User with editing only capability can change description but not the tag name.
84 $roleid = $this->assignUserCapability('moodle/tag:edit', $context->id);
85 $result = core_tag_external::update_tags(array($updatetag));
86 $result = external_api::clean_returnvalue(core_tag_external::update_tags_returns(), $result);
87 $this->assertEmpty($result['warnings']);
ef4c23cc
MG
88
89 $result = core_tag_external::get_tags(array($gettag));
90 $result = external_api::clean_returnvalue(core_tag_external::get_tags_returns(), $result);
8e355853
MG
91 $this->assertEquals($updatetag['id'], $result['tags'][0]['id']);
92 $this->assertEquals($updatetag['description'], $result['tags'][0]['description']);
93 $this->assertEquals($originaltag['rawname'], $result['tags'][0]['rawname']);
ef4c23cc 94 $this->assertArrayNotHasKey('flag', $result['tags'][0]); // 'Flag' is not available unless 'moodle/tag:manage' cap exists.
8e355853 95 $this->assertEquals(0, $result['tags'][0]['official']);
e11d7380 96 $this->assertEquals(0, $result['tags'][0]['isstandard']);
8e355853
MG
97 $this->assertEquals($originaltag['rawname'], $DB->get_field('tag', 'rawname',
98 array('id' => $tag->id)));
99 $this->assertEquals($updatetag['description'], $DB->get_field('tag', 'description',
100 array('id' => $tag->id)));
101
102 // User with editing and manage cap can also change the tag name,
e11d7380 103 // make it standard and reset flag.
8e355853 104 assign_capability('moodle/tag:manage', CAP_ALLOW, $roleid, $context->id);
8e355853
MG
105 $this->assertTrue(has_capability('moodle/tag:manage', $context));
106 $result = core_tag_external::update_tags(array($updatetag));
107 $result = external_api::clean_returnvalue(core_tag_external::update_tags_returns(), $result);
108 $this->assertEmpty($result['warnings']);
ef4c23cc
MG
109
110 $result = core_tag_external::get_tags(array($gettag));
111 $result = external_api::clean_returnvalue(core_tag_external::get_tags_returns(), $result);
8e355853
MG
112 $this->assertEquals($updatetag['id'], $result['tags'][0]['id']);
113 $this->assertEquals($updatetag['rawname'], $result['tags'][0]['rawname']);
114 $this->assertEquals(core_text::strtolower($updatetag['rawname']), $result['tags'][0]['name']);
115 $this->assertEquals($updatetag['flag'], $result['tags'][0]['flag']);
e11d7380
MG
116 $this->assertEquals($updatetag['isstandard'], $result['tags'][0]['official']);
117 $this->assertEquals($updatetag['isstandard'], $result['tags'][0]['isstandard']);
8e355853
MG
118 $this->assertEquals($updatetag['rawname'], $DB->get_field('tag', 'rawname',
119 array('id' => $tag->id)));
e11d7380 120 $this->assertEquals(1, $DB->get_field('tag', 'isstandard', array('id' => $tag->id)));
8e355853 121
ef4c23cc 122 // Updating and getting non-existing tag.
8e355853
MG
123 $nonexistingtag = array(
124 'id' => 123,
125 'description' => 'test'
126 );
ef4c23cc
MG
127 $getnonexistingtag = array(
128 'id' => 123,
129 );
8e355853
MG
130 $result = core_tag_external::update_tags(array($nonexistingtag));
131 $result = external_api::clean_returnvalue(core_tag_external::update_tags_returns(), $result);
ef4c23cc
MG
132 $this->assertEquals(123, $result['warnings'][0]['item']);
133 $this->assertEquals('tagnotfound', $result['warnings'][0]['warningcode']);
134
135 $result = core_tag_external::get_tags(array($getnonexistingtag));
136 $result = external_api::clean_returnvalue(core_tag_external::get_tags_returns(), $result);
8e355853
MG
137 $this->assertEmpty($result['tags']);
138 $this->assertEquals(123, $result['warnings'][0]['item']);
139 $this->assertEquals('tagnotfound', $result['warnings'][0]['warningcode']);
140
141 // Attempt to update a tag to the name that is reserved.
142 $anothertag = $this->getDataGenerator()->create_tag(array('rawname' => 'Mytag'));
143 $updatetag2 = array('id' => $tag->id, 'rawname' => 'MYTAG');
144 $result = core_tag_external::update_tags(array($updatetag2));
145 $result = external_api::clean_returnvalue(core_tag_external::update_tags_returns(), $result);
8e355853
MG
146 $this->assertEquals($tag->id, $result['warnings'][0]['item']);
147 $this->assertEquals('namesalreadybeeingused', $result['warnings'][0]['warningcode']);
148 }
cdc5f978
MG
149
150 /**
151 * Test update_inplace_editable()
152 */
153 public function test_update_inplace_editable() {
154 global $CFG, $DB, $PAGE;
155 require_once($CFG->dirroot . '/lib/external/externallib.php');
156
157 $this->resetAfterTest(true);
158 $tag = $this->getDataGenerator()->create_tag();
787ec240 159 $this->setUser($this->getDataGenerator()->create_user());
cdc5f978
MG
160
161 // Call service for core_tag component without necessary permissions.
162 try {
163 core_external::update_inplace_editable('core_tag', 'tagname', $tag->id, 'new tag name');
164 $this->fail('Exception expected');
165 } catch (moodle_exception $e) {
a9245888 166 $this->assertEquals('Sorry, but you do not currently have permissions to do that (Manage all tags).',
cdc5f978
MG
167 $e->getMessage());
168 }
169
170 // Change to admin user and make sure that tag name can be updated using web service update_inplace_editable().
171 $this->setAdminUser();
172 $res = core_external::update_inplace_editable('core_tag', 'tagname', $tag->id, 'New tag name');
173 $res = external_api::clean_returnvalue(core_external::update_inplace_editable_returns(), $res);
174 $this->assertEquals('New tag name', $res['value']);
175 $this->assertEquals('New tag name', $DB->get_field('tag', 'rawname', array('id' => $tag->id)));
176
177 // Call callback core_tag_inplace_editable() directly.
178 $tmpl = component_callback('core_tag', 'inplace_editable', array('tagname', $tag->id, 'Rename me again'));
179 $this->assertInstanceOf('core\output\inplace_editable', $tmpl);
180 $res = $tmpl->export_for_template($PAGE->get_renderer('core'));
181 $this->assertEquals('Rename me again', $res['value']);
182 $this->assertEquals('Rename me again', $DB->get_field('tag', 'rawname', array('id' => $tag->id)));
183 }
8e355853 184}