MDL-52220 tool_lp: Prevent updates on a plan based on a template
[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();
bf61cd0c 191 $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
b3979696
IT
192
193 // Create a list of frameworks.
bf61cd0c
FM
194 $framework1 = $lpg->create_framework(array(
195 'shortname' => 'shortname_a',
196 'idnumber' => 'idnumber_c',
197 'description' => 'description',
198 'descriptionformat' => FORMAT_HTML,
199 'visible' => true,
200 'contextid' => context_system::instance()->id
201 ));
202
203 $framework2 = $lpg->create_framework(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
212 $framework3 = $lpg->create_framework(array(
213 'shortname' => 'shortname_c',
214 'idnumber' => 'idnumber_b',
215 'description' => 'description',
216 'descriptionformat' => FORMAT_HTML,
217 'visible' => true,
218 'contextid' => context_system::instance()->id
219 ));
b3979696
IT
220
221 // Get frameworks list order by shortname desc.
222 $result = api::list_frameworks('shortname', 'DESC', null, 3, context_system::instance());
223
1896274f
FM
224 $f = (object) array_shift($result);
225 $this->assertEquals($framework3->get_id(), $f->get_id());
226 $f = (object) array_shift($result);
227 $this->assertEquals($framework2->get_id(), $f->get_id());
228 $f = (object) array_shift($result);
229 $this->assertEquals($framework1->get_id(), $f->get_id());
b3979696
IT
230
231 // Get frameworks list order by idnumber asc.
232 $result = api::list_frameworks('idnumber', 'ASC', null, 3, context_system::instance());
233
1896274f
FM
234 $f = (object) array_shift($result);
235 $this->assertEquals($framework2->get_id(), $f->get_id());
236 $f = (object) array_shift($result);
237 $this->assertEquals($framework3->get_id(), $f->get_id());
238 $f = (object) array_shift($result);
239 $this->assertEquals($framework1->get_id(), $f->get_id());
b3979696
IT
240 }
241
c61db7bb
IT
242 /**
243 * Test duplicate a framework.
244 */
245 public function test_duplicate_framework() {
246 $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
247 $this->resetAfterTest(true);
248 $this->setAdminUser();
249
250 $syscontext = context_system::instance();
251 $params = array(
252 'shortname' => 'shortname_a',
253 'idnumber' => 'idnumber_c',
254 'description' => 'description',
255 'descriptionformat' => FORMAT_HTML,
256 'visible' => true,
257 'contextid' => $syscontext->id
258 );
259 $framework = $lpg->create_framework($params);
260 $competency1 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
261 $competency2 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
262 $competency3 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
263 $competency4 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
264 $competencyidnumbers = array($competency1->get_idnumber(),
265 $competency2->get_idnumber(),
266 $competency3->get_idnumber(),
267 $competency4->get_idnumber()
268 );
269
270 api::add_related_competency($competency1->get_id(), $competency2->get_id());
271 api::add_related_competency($competency3->get_id(), $competency4->get_id());
272
273 $frameworkduplicated1 = api::duplicate_framework($framework->get_id());
274 $frameworkduplicated2 = api::duplicate_framework($framework->get_id());
275
276 $this->assertEquals($framework->get_idnumber().'_1', $frameworkduplicated1->get_idnumber());
277 $this->assertEquals($framework->get_idnumber().'_2', $frameworkduplicated2->get_idnumber());
278
279 $competenciesfr1 = api::list_competencies(array('competencyframeworkid' => $frameworkduplicated1->get_id()));
280 $competenciesfr2 = api::list_competencies(array('competencyframeworkid' => $frameworkduplicated2->get_id()));
281
282 $competencyidsfr1 = array();
283 $competencyidsfr2 = array();
284
285 foreach ($competenciesfr1 as $cmp) {
286 $competencyidsfr1[] = $cmp->get_idnumber();
287 }
288 foreach ($competenciesfr2 as $cmp) {
289 $competencyidsfr2[] = $cmp->get_idnumber();
290 }
291
292 $this->assertEmpty(array_diff($competencyidsfr1, $competencyidnumbers));
293 $this->assertEmpty(array_diff($competencyidsfr2, $competencyidnumbers));
294 $this->assertCount(4, $competenciesfr1);
295 $this->assertCount(4, $competenciesfr2);
296
297 // Test the related competencies.
298 reset($competenciesfr1);
299 $compduplicated1 = current($competenciesfr1);
300 $relatedcompetencies = $compduplicated1->get_related_competencies();
301 $comprelated = current($relatedcompetencies);
302 $this->assertEquals($comprelated->get_idnumber(), $competency2->get_idnumber());
303 }
304
58405003
IT
305 /**
306 * Test update plan.
307 */
308 public function test_update_plan() {
309 $this->resetAfterTest(true);
310 $dg = $this->getDataGenerator();
311 $usermanageowndraft = $dg->create_user();
312 $usermanageown = $dg->create_user();
313 $usermanagedraft = $dg->create_user();
314 $usermanage = $dg->create_user();
315
316 $syscontext = context_system::instance();
317
318 // Creating specific roles.
319 $manageowndraftrole = $dg->create_role(array(
320 'name' => 'User manage own draft',
321 'shortname' => 'manage-own-draft'
322 ));
323 $manageownrole = $dg->create_role(array(
324 'name' => 'User manage own',
325 'shortname' => 'manage-own'
326 ));
327 $managedraftrole = $dg->create_role(array(
328 'name' => 'User manage draft',
329 'shortname' => 'manage-draft'
330 ));
331 $managerole = $dg->create_role(array(
332 'name' => 'User manage',
333 'shortname' => 'manage'
334 ));
335
336 assign_capability('tool/lp:planmanageowndraft', CAP_ALLOW, $manageowndraftrole, $syscontext->id);
337 assign_capability('tool/lp:planviewowndraft', CAP_ALLOW, $manageowndraftrole, $syscontext->id);
338
339 assign_capability('tool/lp:planmanageown', CAP_ALLOW, $manageownrole, $syscontext->id);
340 assign_capability('tool/lp:planviewown', CAP_ALLOW, $manageownrole, $syscontext->id);
341
342 assign_capability('tool/lp:planmanagedraft', CAP_ALLOW, $managedraftrole, $syscontext->id);
343 assign_capability('tool/lp:planviewdraft', CAP_ALLOW, $managedraftrole, $syscontext->id);
344
345 assign_capability('tool/lp:planmanage', CAP_ALLOW, $managerole, $syscontext->id);
346 assign_capability('tool/lp:planview', CAP_ALLOW, $managerole, $syscontext->id);
347
348 $dg->role_assign($manageowndraftrole, $usermanageowndraft->id, $syscontext->id);
349 $dg->role_assign($manageownrole, $usermanageown->id, $syscontext->id);
350 $dg->role_assign($managedraftrole, $usermanagedraft->id, $syscontext->id);
351 $dg->role_assign($managerole, $usermanage->id, $syscontext->id);
352
353 // Create first learning plan with user create draft.
354 $this->setUser($usermanageowndraft);
355 $plan = array (
356 'name' => 'plan own draft',
357 'description' => 'plan own draft',
358 'userid' => $usermanageowndraft->id
359 );
360 $plan = api::create_plan((object)$plan);
361 $record = $plan->to_record();
362 $record->name = 'plan own draft modified';
363
364 // Check if user create draft can edit the plan name.
365 $plan = api::update_plan($record);
366 $this->assertInstanceOf('\tool_lp\plan', $plan);
367
368 // Thrown exception when manageowndraft user try to change the status.
369 $record->status = \tool_lp\plan::STATUS_ACTIVE;
370 try {
371 $plan = api::update_plan($record);
372 $this->fail('User with manage own draft capability cannot edit the plan status.');
373 } catch (required_capability_exception $e) {
374 $this->assertTrue(true);
375 }
376
377 // Test when user with manage own plan capability try to edit other user plan.
378 $record->status = \tool_lp\plan::STATUS_DRAFT;
379 $record->name = 'plan create draft modified 2';
380 $this->setUser($usermanageown);
381 try {
382 $plan = api::update_plan($record);
383 $this->fail('User with manage own plan capability can only edit his own plan.');
384 } catch (required_capability_exception $e) {
385 $this->assertTrue(true);
386 }
387
388 // User with manage plan capability cannot edit the other user plans with status draft.
389 $this->setUser($usermanage);
390 $record->status = \tool_lp\plan::STATUS_COMPLETE;
391 try {
392 $plan = api::update_plan($record);
393 $this->fail('User with manage plan capability cannot edit the other user plans with status draft');
394 } catch (required_capability_exception $e) {
395 $this->assertTrue(true);
396 }
397
398 // User with manage draft capability can edit other user's learning plan if the status is draft.
399 $this->setUser($usermanagedraft);
400 $record->status = \tool_lp\plan::STATUS_DRAFT;
401 $record->name = 'plan manage draft modified 3';
402 $plan = api::update_plan($record);
403 $this->assertInstanceOf('\tool_lp\plan', $plan);
404
405 // User with manage plan capability can create/edit learning plan if status is active/complete.
406 $this->setUser($usermanage);
407 $plan = array (
408 'name' => 'plan create',
409 'description' => 'plan create',
410 'userid' => $usermanage->id,
411 'status' => \tool_lp\plan::STATUS_ACTIVE
412 );
413 $plan = api::create_plan((object)$plan);
5bfab685
FM
414
415 // Silently transition to complete status to avoid errors about transitioning to complete.
416 $plan->set_status(\tool_lp\plan::STATUS_COMPLETE);
417 $plan->update();
418
58405003
IT
419 $record = $plan->to_record();
420 $record->name = 'plan create own modified';
58405003
IT
421 $plan = api::update_plan($record);
422 $this->assertInstanceOf('\tool_lp\plan', $plan);
58405003
IT
423 }
424
2388d46d
FM
425 public function test_create_plan_from_template() {
426 $this->resetAfterTest(true);
427 $this->setAdminUser();
428
429 $u1 = $this->getDataGenerator()->create_user();
430 $tpl = $this->getDataGenerator()->get_plugin_generator('tool_lp')->create_template();
431
432 // Creating a new plan.
433 $plan = api::create_plan_from_template($tpl, $u1->id);
434 $record = $plan->to_record();
435 $this->assertInstanceOf('\tool_lp\plan', $plan);
436 $this->assertTrue(\tool_lp\plan::record_exists($plan->get_id()));
437 $this->assertEquals($tpl->get_id(), $plan->get_templateid());
438 $this->assertEquals($u1->id, $plan->get_userid());
439 $this->assertTrue($plan->is_based_on_template());
440
441 // Creating a plan that already exists.
442 $plan = api::create_plan_from_template($tpl, $u1->id);
443 $this->assertFalse($plan);
444
445 // Check that api::create_plan cannot be used.
446 $this->setExpectedException('coding_exception');
447 unset($record->id);
448 $plan = api::create_plan($record);
449 }
450
4de877eb
FM
451 public function test_update_plan_based_on_template() {
452 $this->resetAfterTest(true);
453 $dg = $this->getDataGenerator();
454 $lpg = $dg->get_plugin_generator('tool_lp');
455 $u1 = $dg->create_user();
456 $u2 = $dg->create_user();
457
458 $this->setAdminUser();
459 $tpl1 = $lpg->create_template();
460 $tpl2 = $lpg->create_template();
461 $up1 = $lpg->create_plan(array('userid' => $u1->id, 'templateid' => $tpl1->get_id()));
462 $up2 = $lpg->create_plan(array('userid' => $u2->id, 'templateid' => null));
463
464 try {
465 // Trying to remove the template dependency.
466 $record = $up1->to_record();
467 $record->templateid = null;
468 api::update_plan($record);
469 $this->fail('A plan cannot be unlinked using api::update_plan()');
470 } catch (coding_exception $e) {
471 }
472
473 try {
474 // Trying to switch to another template.
475 $record = $up1->to_record();
476 $record->templateid = $tpl2->get_id();
477 api::update_plan($record);
478 $this->fail('A plan cannot be moved to another template.');
479 } catch (coding_exception $e) {
480 }
481
482 try {
483 // Trying to switch to using a template.
484 $record = $up2->to_record();
485 $record->templateid = $tpl1->get_id();
486 api::update_plan($record);
487 $this->fail('A plan cannot be update to use a template.');
488 } catch (coding_exception $e) {
489 }
490 }
491
5bfab685
FM
492 /**
493 * Test that the method to complete a plan.
494 */
495 public function test_complete_plan() {
496 global $DB;
497
498 $this->resetAfterTest(true);
499 $this->setAdminUser();
500 $dg = $this->getDataGenerator();
501 $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
502 $user = $dg->create_user();
503
504 // Create a framework and assign competencies.
505 $framework = $lpg->create_framework();
506 $c1 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
507 $c2 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
508 $c3 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
509
510 // Create two plans and assign competencies.
511 $plan = $lpg->create_plan(array('userid' => $user->id));
512 $otherplan = $lpg->create_plan(array('userid' => $user->id));
513
514 $lpg->create_plan_competency(array('planid' => $plan->get_id(), 'competencyid' => $c1->get_id()));
515 $lpg->create_plan_competency(array('planid' => $plan->get_id(), 'competencyid' => $c2->get_id()));
516 $lpg->create_plan_competency(array('planid' => $plan->get_id(), 'competencyid' => $c3->get_id()));
517 $lpg->create_plan_competency(array('planid' => $otherplan->get_id(), 'competencyid' => $c1->get_id()));
518
519 $uclist = array(
520 $lpg->create_user_competency(array('userid' => $user->id, 'competencyid' => $c1->get_id(),
521 'proficiency' => true, 'grade' => 1 )),
522 $lpg->create_user_competency(array('userid' => $user->id, 'competencyid' => $c2->get_id(),
523 'proficiency' => false, 'grade' => 2 ))
524 );
525
526 $this->assertEquals(2, \tool_lp\user_competency::count_records());
527 $this->assertEquals(0, \tool_lp\user_competency_plan::count_records());
528
529 // Change status of the plan to complete.
530 api::complete_plan($plan);
531
532 // Check that user competencies are now in user_competency_plan objects and still in user_competency.
533 $this->assertEquals(2, \tool_lp\user_competency::count_records());
534 $this->assertEquals(3, \tool_lp\user_competency_plan::count_records());
535
536 $usercompetenciesplan = \tool_lp\user_competency_plan::get_records();
537
538 $this->assertEquals($uclist[0]->get_userid(), $usercompetenciesplan[0]->get_userid());
539 $this->assertEquals($uclist[0]->get_competencyid(), $usercompetenciesplan[0]->get_competencyid());
540 $this->assertEquals($uclist[0]->get_proficiency(), (bool) $usercompetenciesplan[0]->get_proficiency());
541 $this->assertEquals($uclist[0]->get_grade(), $usercompetenciesplan[0]->get_grade());
542 $this->assertEquals($plan->get_id(), $usercompetenciesplan[0]->get_planid());
543
544 $this->assertEquals($uclist[1]->get_userid(), $usercompetenciesplan[1]->get_userid());
545 $this->assertEquals($uclist[1]->get_competencyid(), $usercompetenciesplan[1]->get_competencyid());
546 $this->assertEquals($uclist[1]->get_proficiency(), (bool) $usercompetenciesplan[1]->get_proficiency());
547 $this->assertEquals($uclist[1]->get_grade(), $usercompetenciesplan[1]->get_grade());
548 $this->assertEquals($plan->get_id(), $usercompetenciesplan[1]->get_planid());
549
550 $this->assertEquals($user->id, $usercompetenciesplan[2]->get_userid());
551 $this->assertEquals($c3->get_id(), $usercompetenciesplan[2]->get_competencyid());
552 $this->assertNull($usercompetenciesplan[2]->get_proficiency());
553 $this->assertNull($usercompetenciesplan[2]->get_grade());
554 $this->assertEquals($plan->get_id(), $usercompetenciesplan[2]->get_planid());
555
556 // Completing a plan that is completed throws an exception.
557 $this->setExpectedException('coding_exception');
558 api::complete_plan($plan);
559 }
560
192569ed
JPG
561 /**
562 * Test update plan and the managing of archived user competencies.
563 */
564 public function test_update_plan_manage_archived_competencies() {
565 global $DB;
566
567 $this->resetAfterTest(true);
568 $dg = $this->getDataGenerator();
569 $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
570
571 $syscontext = context_system::instance();
572
573 // Create users and roles for the test.
574 $user = $dg->create_user();
575 $manageownrole = $dg->create_role(array(
576 'name' => 'User manage own',
577 'shortname' => 'manageown'
578 ));
579 assign_capability('tool/lp:planmanageowndraft', CAP_ALLOW, $manageownrole, $syscontext->id);
580 assign_capability('tool/lp:planviewowndraft', CAP_ALLOW, $manageownrole, $syscontext->id);
581 assign_capability('tool/lp:planmanageown', CAP_ALLOW, $manageownrole, $syscontext->id);
582 assign_capability('tool/lp:planviewown', CAP_ALLOW, $manageownrole, $syscontext->id);
583 $dg->role_assign($manageownrole, $user->id, $syscontext->id);
584 $this->setUser($user);
585
586 // Create a framework and assign competencies.
587 $framework = $lpg->create_framework();
588 $c1 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
589 $c2 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
590 $c3 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
591
592 // Create two plans and assign competencies.
593 $plan = $lpg->create_plan(array('userid' => $user->id));
594 $otherplan = $lpg->create_plan(array('userid' => $user->id));
595
596 $lpg->create_plan_competency(array('planid' => $plan->get_id(), 'competencyid' => $c1->get_id()));
597 $lpg->create_plan_competency(array('planid' => $plan->get_id(), 'competencyid' => $c2->get_id()));
598 $lpg->create_plan_competency(array('planid' => $plan->get_id(), 'competencyid' => $c3->get_id()));
599 $lpg->create_plan_competency(array('planid' => $otherplan->get_id(), 'competencyid' => $c1->get_id()));
600
601 $uclist = array(
602 $lpg->create_user_competency(array(
603 'userid' => $user->id,
604 'competencyid' => $c1->get_id(),
605 'proficiency' => true,
606 'grade' => 1
607 )),
608 $lpg->create_user_competency(array(
609 'userid' => $user->id,
610 'competencyid' => $c2->get_id(),
611 'proficiency' => false,
612 'grade' => 2
613 ))
614 );
615
616 // Change status of the plan to complete.
617 $record = $plan->to_record();
618 $record->status = \tool_lp\plan::STATUS_COMPLETE;
619
5bfab685
FM
620 try {
621 $plan = api::update_plan($record);
622 $this->fail('We cannot complete a plan using api::update_plan().');
623 } catch (coding_exception $e) {
624 }
625 api::complete_plan($plan);
192569ed
JPG
626
627 // Check that user compretencies are now in user_competency_plan objects and still in user_competency.
628 $this->assertEquals(2, \tool_lp\user_competency::count_records());
629 $this->assertEquals(3, \tool_lp\user_competency_plan::count_records());
630
631 $usercompetenciesplan = \tool_lp\user_competency_plan::get_records();
632
633 $this->assertEquals($uclist[0]->get_userid(), $usercompetenciesplan[0]->get_userid());
634 $this->assertEquals($uclist[0]->get_competencyid(), $usercompetenciesplan[0]->get_competencyid());
635 $this->assertEquals($uclist[0]->get_proficiency(), (bool) $usercompetenciesplan[0]->get_proficiency());
636 $this->assertEquals($uclist[0]->get_grade(), $usercompetenciesplan[0]->get_grade());
637 $this->assertEquals($plan->get_id(), $usercompetenciesplan[0]->get_planid());
638
639 $this->assertEquals($uclist[1]->get_userid(), $usercompetenciesplan[1]->get_userid());
640 $this->assertEquals($uclist[1]->get_competencyid(), $usercompetenciesplan[1]->get_competencyid());
641 $this->assertEquals($uclist[1]->get_proficiency(), (bool) $usercompetenciesplan[1]->get_proficiency());
642 $this->assertEquals($uclist[1]->get_grade(), $usercompetenciesplan[1]->get_grade());
643 $this->assertEquals($plan->get_id(), $usercompetenciesplan[1]->get_planid());
644
645 $this->assertEquals($user->id, $usercompetenciesplan[2]->get_userid());
646 $this->assertEquals($c3->get_id(), $usercompetenciesplan[2]->get_competencyid());
647 $this->assertNull($usercompetenciesplan[2]->get_proficiency());
648 $this->assertNull($usercompetenciesplan[2]->get_grade());
649 $this->assertEquals($plan->get_id(), $usercompetenciesplan[2]->get_planid());
650
192569ed
JPG
651 // Change status of the plan to active.
652 $record = $plan->to_record();
653 $record->status = \tool_lp\plan::STATUS_ACTIVE;
654
655 $plan = api::update_plan($record);
656
657 // Check that user_competency_plan objects are deleted if the plan status is changed to another status.
658 $this->assertEquals(2, \tool_lp\user_competency::count_records());
659 $this->assertEquals(0, \tool_lp\user_competency_plan::count_records());
660 }
661
662 /**
663 * Test remove plan and the managing of archived user competencies.
664 */
665 public function test_delete_plan_manage_archived_competencies() {
666 $this->resetAfterTest(true);
667 $dg = $this->getDataGenerator();
668 $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
669
670 $syscontext = context_system::instance();
671
672 // Create user and role for the test.
673 $user = $dg->create_user();
674 $managerole = $dg->create_role(array(
675 'name' => 'User manage own',
676 'shortname' => 'manageown'
677 ));
678 assign_capability('tool/lp:planmanageowndraft', CAP_ALLOW, $managerole, $syscontext->id);
679 assign_capability('tool/lp:planmanageown', CAP_ALLOW, $managerole, $syscontext->id);
680 $dg->role_assign($managerole, $user->id, $syscontext->id);
681 $this->setUser($user);
682
683 // Create a framework and assign competencies.
684 $framework = $lpg->create_framework();
685 $c1 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
686 $c2 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
687 $c3 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
688
689 // Create completed plan with records in user_competency.
690 $completedplan = $lpg->create_plan(array('userid' => $user->id, 'status' => \tool_lp\plan::STATUS_COMPLETE));
691
692 $lpg->create_plan_competency(array('planid' => $completedplan->get_id(), 'competencyid' => $c1->get_id()));
693 $lpg->create_plan_competency(array('planid' => $completedplan->get_id(), 'competencyid' => $c2->get_id()));
694
695 $uc1 = $lpg->create_user_competency(array('userid' => $user->id, 'competencyid' => $c1->get_id()));
696 $uc2 = $lpg->create_user_competency(array('userid' => $user->id, 'competencyid' => $c2->get_id()));
697
698 $ucp1 = $lpg->create_user_competency_plan(array('userid' => $user->id, 'competencyid' => $c1->get_id(),
699 'planid' => $completedplan->get_id()));
700 $ucp2 = $lpg->create_user_competency_plan(array('userid' => $user->id, 'competencyid' => $c2->get_id(),
701 'planid' => $completedplan->get_id()));
702
703 api::delete_plan($completedplan->get_id());
704
705 // Check that achived user competencies are deleted.
706 $this->assertEquals(0, \tool_lp\plan::count_records());
707 $this->assertEquals(2, \tool_lp\user_competency::count_records());
708 $this->assertEquals(0, \tool_lp\user_competency_plan::count_records());
709 }
710
711 /**
712 * Test listing of plan competencies.
713 */
714 public function test_list_plan_competencies_manage_archived_competencies() {
715 $this->resetAfterTest(true);
716 $dg = $this->getDataGenerator();
717 $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
718
719 $syscontext = context_system::instance();
720
721 // Create user and role for the test.
722 $user = $dg->create_user();
723 $viewrole = $dg->create_role(array(
724 'name' => 'User view',
725 'shortname' => 'view'
726 ));
727 assign_capability('tool/lp:planviewdraft', CAP_ALLOW, $viewrole, $syscontext->id);
728 assign_capability('tool/lp:planview', CAP_ALLOW, $viewrole, $syscontext->id);
729 $dg->role_assign($viewrole, $user->id, $syscontext->id);
730 $this->setUser($user);
731
732 // Create a framework and assign competencies.
733 $framework = $lpg->create_framework();
734 $c1 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
735 $c2 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
736 $c3 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
737
738 // Create draft plan with records in user_competency.
739 $draftplan = $lpg->create_plan(array('userid' => $user->id));
740
741 $lpg->create_plan_competency(array('planid' => $draftplan->get_id(), 'competencyid' => $c1->get_id()));
742 $lpg->create_plan_competency(array('planid' => $draftplan->get_id(), 'competencyid' => $c2->get_id()));
743 $lpg->create_plan_competency(array('planid' => $draftplan->get_id(), 'competencyid' => $c3->get_id()));
744
745 $uc1 = $lpg->create_user_competency(array('userid' => $user->id, 'competencyid' => $c1->get_id()));
746 $uc2 = $lpg->create_user_competency(array('userid' => $user->id, 'competencyid' => $c2->get_id()));
747
748 // Check that user_competency objects are returned when plan status is not complete.
749 $plancompetencies = api::list_plan_competencies($draftplan);
750
751 $this->assertCount(3, $plancompetencies);
752 $this->assertInstanceOf('\tool_lp\user_competency', $plancompetencies[0]->usercompetency);
753 $this->assertEquals($uc1->get_id(), $plancompetencies[0]->usercompetency->get_id());
754 $this->assertNull($plancompetencies[0]->usercompetencyplan);
755
756 $this->assertInstanceOf('\tool_lp\user_competency', $plancompetencies[1]->usercompetency);
757 $this->assertEquals($uc2->get_id(), $plancompetencies[1]->usercompetency->get_id());
758 $this->assertNull($plancompetencies[1]->usercompetencyplan);
759
760 $this->assertInstanceOf('\tool_lp\user_competency', $plancompetencies[2]->usercompetency);
761 $this->assertEquals(0, $plancompetencies[2]->usercompetency->get_id());
762 $this->assertNull($plancompetencies[2]->usercompetencyplan);
763
764 // Create completed plan with records in user_competency_plan.
765 $completedplan = $lpg->create_plan(array('userid' => $user->id, 'status' => \tool_lp\plan::STATUS_COMPLETE));
766
767 $pc1 = $lpg->create_plan_competency(array('planid' => $completedplan->get_id(), 'competencyid' => $c1->get_id()));
768 $pc2 = $lpg->create_plan_competency(array('planid' => $completedplan->get_id(), 'competencyid' => $c2->get_id()));
769 $pc3 = $lpg->create_plan_competency(array('planid' => $completedplan->get_id(), 'competencyid' => $c3->get_id()));
770
771 $ucp1 = $lpg->create_user_competency_plan(array('userid' => $user->id, 'competencyid' => $c1->get_id(),
772 'planid' => $completedplan->get_id()));
773 $ucp2 = $lpg->create_user_competency_plan(array('userid' => $user->id, 'competencyid' => $c2->get_id(),
774 'planid' => $completedplan->get_id()));
775
776 // Check that an exception is thrown when a user competency plan is missing.
777 try {
778 $plancompetencies = api::list_plan_competencies($completedplan);
779 $this->fail('All competencies in the plan must be associated to a user competency plan');
780 } catch (coding_exception $e) {
781 $this->assertTrue(true);
782 }
783
784 $ucp3 = $lpg->create_user_competency_plan(array('userid' => $user->id, 'competencyid' => $c3->get_id(),
785 'planid' => $completedplan->get_id()));
786
787 // Check that user_competency_plan objects are returned when plan status is complete.
788 $plancompetencies = api::list_plan_competencies($completedplan);
789
790 $this->assertCount(3, $plancompetencies);
791 $this->assertInstanceOf('\tool_lp\user_competency_plan', $plancompetencies[0]->usercompetencyplan);
792 $this->assertEquals($ucp1->get_id(), $plancompetencies[0]->usercompetencyplan->get_id());
793 $this->assertNull($plancompetencies[0]->usercompetency);
794 $this->assertInstanceOf('\tool_lp\user_competency_plan', $plancompetencies[1]->usercompetencyplan);
795 $this->assertEquals($ucp2->get_id(), $plancompetencies[1]->usercompetencyplan->get_id());
796 $this->assertNull($plancompetencies[1]->usercompetency);
797 $this->assertInstanceOf('\tool_lp\user_competency_plan', $plancompetencies[2]->usercompetencyplan);
798 $this->assertEquals($ucp3->get_id(), $plancompetencies[2]->usercompetencyplan->get_id());
799 $this->assertNull($plancompetencies[2]->usercompetency);
800 }
801
bee480a4
FM
802 public function test_create_template_cohort() {
803 $this->resetAfterTest(true);
804 $this->setAdminUser();
805
806 $dg = $this->getDataGenerator();
807 $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
808
809 $c1 = $dg->create_cohort();
810 $c2 = $dg->create_cohort();
811 $t1 = $lpg->create_template();
812 $t2 = $lpg->create_template();
813
814 $this->assertEquals(0, \tool_lp\template_cohort::count_records());
815
816 // Create two relations with mixed parameters.
817 $result = api::create_template_cohort($t1->get_id(), $c1->id);
818 $result = api::create_template_cohort($t1, $c2);
819
820 $this->assertEquals(2, \tool_lp\template_cohort::count_records());
821 $this->assertInstanceOf('tool_lp\template_cohort', $result);
822 $this->assertEquals($c2->id, $result->get_cohortid());
823 $this->assertEquals($t1->get_id(), $result->get_templateid());
824 $this->assertEquals(2, \tool_lp\template_cohort::count_records_select('templateid = :id', array('id' => $t1->get_id())));
825 $this->assertEquals(0, \tool_lp\template_cohort::count_records_select('templateid = :id', array('id' => $t2->get_id())));
826 }
827
828 public function test_delete_template_cohort() {
829 $this->resetAfterTest(true);
830 $this->setAdminUser();
831
832 $dg = $this->getDataGenerator();
833 $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
834
835 $c1 = $dg->create_cohort();
836 $c2 = $dg->create_cohort();
837 $t1 = $lpg->create_template();
838 $t2 = $lpg->create_template();
839 $tc1 = $lpg->create_template_cohort(array('templateid' => $t1->get_id(), 'cohortid' => $c1->id));
840 $tc1 = $lpg->create_template_cohort(array('templateid' => $t2->get_id(), 'cohortid' => $c2->id));
841
842 $this->assertEquals(2, \tool_lp\template_cohort::count_records());
843 $this->assertEquals(1, \tool_lp\template_cohort::count_records_select('templateid = :id', array('id' => $t1->get_id())));
844 $this->assertEquals(1, \tool_lp\template_cohort::count_records_select('templateid = :id', array('id' => $t2->get_id())));
845
846 // Delete existing.
847 $result = api::delete_template_cohort($t1->get_id(), $c1->id);
848 $this->assertTrue($result);
849 $this->assertEquals(1, \tool_lp\template_cohort::count_records());
850 $this->assertEquals(0, \tool_lp\template_cohort::count_records_select('templateid = :id', array('id' => $t1->get_id())));
851 $this->assertEquals(1, \tool_lp\template_cohort::count_records_select('templateid = :id', array('id' => $t2->get_id())));
852
853 // Delete non-existant.
854 $result = api::delete_template_cohort($t1->get_id(), $c1->id);
855 $this->assertTrue($result);
856 $this->assertEquals(1, \tool_lp\template_cohort::count_records());
857 $this->assertEquals(0, \tool_lp\template_cohort::count_records_select('templateid = :id', array('id' => $t1->get_id())));
858 $this->assertEquals(1, \tool_lp\template_cohort::count_records_select('templateid = :id', array('id' => $t2->get_id())));
859 }
f610a957 860}