MDL-51442 tool_lp: Framework scales configuration must be mandatory
[moodle.git] / admin / tool / lp / tests / api_test.php
CommitLineData
f610a957
FM
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 * API tests.
19 *
20 * @package tool_lp
21 * @copyright 2015 Frédéric Massart - FMCorz.net
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25defined('MOODLE_INTERNAL') || die();
26global $CFG;
27
28use tool_lp\api;
29
30/**
31 * API tests.
32 *
33 * @package tool_lp
34 * @copyright 2015 Frédéric Massart - FMCorz.net
35 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36 */
37class tool_lp_api_testcase extends advanced_testcase {
38
39 public function test_get_framework_related_contexts() {
40 $this->resetAfterTest(true);
41 $dg = $this->getDataGenerator();
42 $cat1 = $dg->create_category();
43 $cat2 = $dg->create_category(array('parent' => $cat1->id));
44 $cat3 = $dg->create_category(array('parent' => $cat2->id));
f0da26a4 45 $c1 = $dg->create_course(array('category' => $cat2->id)); // This context should not be returned.
f610a957
FM
46
47 $cat1ctx = context_coursecat::instance($cat1->id);
48 $cat2ctx = context_coursecat::instance($cat2->id);
49 $cat3ctx = context_coursecat::instance($cat3->id);
50 $sysctx = context_system::instance();
51
52 $expected = array($cat1ctx->id => $cat1ctx);
f0da26a4 53 $this->assertEquals($expected, api::get_related_contexts($cat1ctx, 'self'));
f610a957
FM
54
55 $expected = array($cat1ctx->id => $cat1ctx, $cat2ctx->id => $cat2ctx, $cat3ctx->id => $cat3ctx);
f0da26a4 56 $this->assertEquals($expected, api::get_related_contexts($cat1ctx, 'children'));
f610a957
FM
57
58 $expected = array($sysctx->id => $sysctx, $cat1ctx->id => $cat1ctx, $cat2ctx->id => $cat2ctx);
f0da26a4 59 $this->assertEquals($expected, api::get_related_contexts($cat2ctx, 'parents'));
f610a957
FM
60 }
61
62 public function test_get_framework_related_contexts_with_capabilities() {
63 $this->resetAfterTest(true);
64 $dg = $this->getDataGenerator();
65 $user = $dg->create_user();
66 $cat1 = $dg->create_category();
67 $cat2 = $dg->create_category(array('parent' => $cat1->id));
68 $cat3 = $dg->create_category(array('parent' => $cat2->id));
f0da26a4 69 $c1 = $dg->create_course(array('category' => $cat2->id)); // This context should not be returned.
f610a957
FM
70
71 $cat1ctx = context_coursecat::instance($cat1->id);
72 $cat2ctx = context_coursecat::instance($cat2->id);
73 $cat3ctx = context_coursecat::instance($cat3->id);
74 $sysctx = context_system::instance();
75
76 $roleallow = create_role('Allow', 'allow', 'Allow read');
77 assign_capability('tool/lp:competencyread', CAP_ALLOW, $roleallow, $sysctx->id);
78 role_assign($roleallow, $user->id, $sysctx->id);
79
80 $roleprevent = create_role('Prevent', 'prevent', 'Prevent read');
81 assign_capability('tool/lp:competencyread', CAP_PROHIBIT, $roleprevent, $sysctx->id);
82 role_assign($roleprevent, $user->id, $cat2ctx->id);
83
84 accesslib_clear_all_caches_for_unit_testing();
85 $this->setUser($user);
86 $this->assertFalse(has_capability('tool/lp:competencyread', $cat2ctx));
87
88 $requiredcap = array('tool/lp:competencyread');
89
90 $expected = array();
f0da26a4 91 $this->assertEquals($expected, api::get_related_contexts($cat2ctx, 'self', $requiredcap));
f610a957
FM
92
93 $expected = array($cat1ctx->id => $cat1ctx);
f0da26a4 94 $this->assertEquals($expected, api::get_related_contexts($cat1ctx, 'children', $requiredcap));
f610a957
FM
95
96 $expected = array($sysctx->id => $sysctx, $cat1ctx->id => $cat1ctx);
f0da26a4 97 $this->assertEquals($expected, api::get_related_contexts($cat2ctx, 'parents', $requiredcap));
f610a957 98 }
f0da26a4
FM
99
100 public function test_get_template_related_contexts() {
101 $this->resetAfterTest(true);
102 $dg = $this->getDataGenerator();
103 $cat1 = $dg->create_category();
104 $cat2 = $dg->create_category(array('parent' => $cat1->id));
105 $cat3 = $dg->create_category(array('parent' => $cat2->id));
106 $c1 = $dg->create_course(array('category' => $cat2->id)); // This context should not be returned.
107
108 $cat1ctx = context_coursecat::instance($cat1->id);
109 $cat2ctx = context_coursecat::instance($cat2->id);
110 $cat3ctx = context_coursecat::instance($cat3->id);
111 $sysctx = context_system::instance();
112
113 $expected = array($cat1ctx->id => $cat1ctx);
114 $this->assertEquals($expected, api::get_related_contexts($cat1ctx, 'self'));
115
116 $expected = array($cat1ctx->id => $cat1ctx, $cat2ctx->id => $cat2ctx, $cat3ctx->id => $cat3ctx);
117 $this->assertEquals($expected, api::get_related_contexts($cat1ctx, 'children'));
118
119 $expected = array($sysctx->id => $sysctx, $cat1ctx->id => $cat1ctx, $cat2ctx->id => $cat2ctx);
120 $this->assertEquals($expected, api::get_related_contexts($cat2ctx, 'parents'));
121 }
122
123 public function test_get_template_related_contexts_with_capabilities() {
124 $this->resetAfterTest(true);
125 $dg = $this->getDataGenerator();
126 $user = $dg->create_user();
127 $cat1 = $dg->create_category();
128 $cat2 = $dg->create_category(array('parent' => $cat1->id));
129 $cat3 = $dg->create_category(array('parent' => $cat2->id));
130 $c1 = $dg->create_course(array('category' => $cat2->id)); // This context should not be returned.
131
132 $cat1ctx = context_coursecat::instance($cat1->id);
133 $cat2ctx = context_coursecat::instance($cat2->id);
134 $cat3ctx = context_coursecat::instance($cat3->id);
135 $sysctx = context_system::instance();
136
137 $roleallow = create_role('Allow', 'allow', 'Allow read');
138 assign_capability('tool/lp:templateread', CAP_ALLOW, $roleallow, $sysctx->id);
139 role_assign($roleallow, $user->id, $sysctx->id);
140
141 $roleprevent = create_role('Prevent', 'prevent', 'Prevent read');
142 assign_capability('tool/lp:templateread', CAP_PROHIBIT, $roleprevent, $sysctx->id);
143 role_assign($roleprevent, $user->id, $cat2ctx->id);
144
145 accesslib_clear_all_caches_for_unit_testing();
146 $this->setUser($user);
147 $this->assertFalse(has_capability('tool/lp:templateread', $cat2ctx));
148
149 $requiredcap = array('tool/lp:templateread');
150
151 $expected = array();
152 $this->assertEquals($expected, api::get_related_contexts($cat2ctx, 'self', $requiredcap));
153
154 $expected = array($cat1ctx->id => $cat1ctx);
155 $this->assertEquals($expected, api::get_related_contexts($cat1ctx, 'children', $requiredcap));
156
157 $expected = array($sysctx->id => $sysctx, $cat1ctx->id => $cat1ctx);
158 $this->assertEquals($expected, api::get_related_contexts($cat2ctx, 'parents', $requiredcap));
159 }
160
ec324dc6
FM
161 /**
162 * Test updating a template.
163 */
164 public function test_update_template() {
165 $cat = $this->getDataGenerator()->create_category();
166 $this->resetAfterTest(true);
167 $this->setAdminUser();
168
169 $syscontext = context_system::instance();
170 $template = api::create_template((object) array('shortname' => 'testing', 'contextid' => $syscontext->id));
171
172 $this->assertEquals('testing', $template->get_shortname());
173 $this->assertEquals($syscontext->id, $template->get_contextid());
174
175 // Simple update.
176 api::update_template((object) array('id' => $template->get_id(), 'shortname' => 'success'));
177 $template = api::read_template($template->get_id());
178 $this->assertEquals('success', $template->get_shortname());
179
180 // Trying to change the context.
181 $this->setExpectedException('coding_exception');
182 api::update_template((object) array('id' => $template->get_id(), 'contextid' => context_coursecat::instance($cat->id)));
183 }
184
b3979696
IT
185 /**
186 * Test listing framework with order param.
187 */
188 public function test_list_frameworks() {
189 $this->resetAfterTest(true);
190 $this->setAdminUser();
191
192 // Create a list of frameworks.
193 $params1 = array(
194 'shortname' => 'shortname_a',
195 'idnumber' => 'idnumber_c',
196 'description' => 'description',
197 'descriptionformat' => FORMAT_HTML,
198 'visible' => true,
199 'contextid' => context_system::instance()->id
200 );
201 $framework1 = api::create_framework((object) $params1);
202
203 $params2 = array(
204 'shortname' => 'shortname_b',
205 'idnumber' => 'idnumber_a',
206 'description' => 'description',
207 'descriptionformat' => FORMAT_HTML,
208 'visible' => true,
209 'contextid' => context_system::instance()->id
210 );
211 $framework2 = api::create_framework((object) $params2);
212
213 $params3 = array(
214 'shortname' => 'shortname_c',
215 'idnumber' => 'idnumber_b',
216 'description' => 'description',
217 'descriptionformat' => FORMAT_HTML,
218 'visible' => true,
219 'contextid' => context_system::instance()->id
220 );
221 $framework3 = api::create_framework((object) $params3);
222
223 // Get frameworks list order by shortname desc.
224 $result = api::list_frameworks('shortname', 'DESC', null, 3, context_system::instance());
225
226 $r1 = (object) $result[0];
227 $r2 = (object) $result[1];
228 $r3 = (object) $result[2];
229
230 $this->assertEquals($framework1->get_id(), $r3->get_id());
231 $this->assertEquals($framework2->get_id(), $r2->get_id());
232 $this->assertEquals($framework3->get_id(), $r1->get_id());
233
234 // Get frameworks list order by idnumber asc.
235 $result = api::list_frameworks('idnumber', 'ASC', null, 3, context_system::instance());
236
237 $r1 = (object) $result[0];
238 $r2 = (object) $result[1];
239 $r3 = (object) $result[2];
240
241 $this->assertEquals($framework1->get_id(), $r3->get_id());
242 $this->assertEquals($framework2->get_id(), $r1->get_id());
243 $this->assertEquals($framework3->get_id(), $r2->get_id());
244 }
245
f610a957 246}