MDL-52220 tool_lp: API method to unlink a plan from 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
6d2c2e86
FM
492 public function test_unlink_plan_from_template() {
493 $this->resetAfterTest(true);
494 $dg = $this->getDataGenerator();
495 $lpg = $dg->get_plugin_generator('tool_lp');
496 $u1 = $dg->create_user();
497 $u2 = $dg->create_user();
498
499 $this->setAdminUser();
500 $f1 = $lpg->create_framework();
501 $f2 = $lpg->create_framework();
502 $c1a = $lpg->create_competency(array('competencyframeworkid' => $f1->get_id()));
503 $c2a = $lpg->create_competency(array('competencyframeworkid' => $f2->get_id()));
504 $c1b = $lpg->create_competency(array('competencyframeworkid' => $f1->get_id()));
505
506 $tpl1 = $lpg->create_template();
507 $tpl2 = $lpg->create_template();
508
509 $tplc1a = $lpg->create_template_competency(array('templateid' => $tpl1->get_id(), 'competencyid' => $c1a->get_id(),
510 'sortorder' => 9));
511 $tplc1b = $lpg->create_template_competency(array('templateid' => $tpl1->get_id(), 'competencyid' => $c1b->get_id(),
512 'sortorder' => 8));
513 $tplc2a = $lpg->create_template_competency(array('templateid' => $tpl2->get_id(), 'competencyid' => $c2a->get_id()));
514
515 $plan1 = $lpg->create_plan(array('userid' => $u1->id, 'templateid' => $tpl1->get_id()));
516 $plan2 = $lpg->create_plan(array('userid' => $u2->id, 'templateid' => $tpl2->get_id()));
517
518 // Check that we have what we expect at this stage.
519 $this->assertEquals(2, \tool_lp\template_competency::count_records(array('templateid' => $tpl1->get_id())));
520 $this->assertEquals(1, \tool_lp\template_competency::count_records(array('templateid' => $tpl2->get_id())));
521 $this->assertEquals(0, \tool_lp\plan_competency::count_records(array('planid' => $plan1->get_id())));
522 $this->assertEquals(0, \tool_lp\plan_competency::count_records(array('planid' => $plan2->get_id())));
523 $this->assertTrue($plan1->is_based_on_template());
524 $this->assertTrue($plan2->is_based_on_template());
525
526 // Let's do this!
527 $tpl1comps = \tool_lp\template_competency::list_competencies($tpl1->get_id(), true);
528 $tpl2comps = \tool_lp\template_competency::list_competencies($tpl2->get_id(), true);
529
530 api::unlink_plan_from_template($plan1);
531
532 $plan1->read();
533 $plan2->read();
534 $this->assertCount(2, $tpl1comps);
535 $this->assertCount(1, $tpl2comps);
536 $this->assertEquals(2, \tool_lp\template_competency::count_records(array('templateid' => $tpl1->get_id())));
537 $this->assertEquals(1, \tool_lp\template_competency::count_records(array('templateid' => $tpl2->get_id())));
538 $this->assertEquals(2, \tool_lp\plan_competency::count_records(array('planid' => $plan1->get_id())));
539 $this->assertEquals(0, \tool_lp\plan_competency::count_records(array('planid' => $plan2->get_id())));
540 $this->assertFalse($plan1->is_based_on_template());
541 $this->assertEquals($tpl1->get_id(), $plan1->get_origtemplateid());
542 $this->assertTrue($plan2->is_based_on_template());
543 $this->assertEquals(null, $plan2->get_origtemplateid());
544
545 // Even the order remains.
546 $plan1comps = \tool_lp\plan_competency::list_competencies($plan1->get_id());
547 $before = reset($tpl1comps);
548 $after = reset($plan1comps);
549 $this->assertEquals($before->get_id(), $after->get_id());
550 $this->assertEquals($before->get_sortorder(), $after->get_sortorder());
551 $before = next($tpl1comps);
552 $after = next($plan1comps);
553 $this->assertEquals($before->get_id(), $after->get_id());
554 $this->assertEquals($before->get_sortorder(), $after->get_sortorder());
555 }
556
5bfab685
FM
557 /**
558 * Test that the method to complete a plan.
559 */
560 public function test_complete_plan() {
561 global $DB;
562
563 $this->resetAfterTest(true);
564 $this->setAdminUser();
565 $dg = $this->getDataGenerator();
566 $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
567 $user = $dg->create_user();
568
569 // Create a framework and assign competencies.
570 $framework = $lpg->create_framework();
571 $c1 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
572 $c2 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
573 $c3 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
574
575 // Create two plans and assign competencies.
576 $plan = $lpg->create_plan(array('userid' => $user->id));
577 $otherplan = $lpg->create_plan(array('userid' => $user->id));
578
579 $lpg->create_plan_competency(array('planid' => $plan->get_id(), 'competencyid' => $c1->get_id()));
580 $lpg->create_plan_competency(array('planid' => $plan->get_id(), 'competencyid' => $c2->get_id()));
581 $lpg->create_plan_competency(array('planid' => $plan->get_id(), 'competencyid' => $c3->get_id()));
582 $lpg->create_plan_competency(array('planid' => $otherplan->get_id(), 'competencyid' => $c1->get_id()));
583
584 $uclist = array(
585 $lpg->create_user_competency(array('userid' => $user->id, 'competencyid' => $c1->get_id(),
586 'proficiency' => true, 'grade' => 1 )),
587 $lpg->create_user_competency(array('userid' => $user->id, 'competencyid' => $c2->get_id(),
588 'proficiency' => false, 'grade' => 2 ))
589 );
590
591 $this->assertEquals(2, \tool_lp\user_competency::count_records());
592 $this->assertEquals(0, \tool_lp\user_competency_plan::count_records());
593
594 // Change status of the plan to complete.
595 api::complete_plan($plan);
596
597 // Check that user competencies are now in user_competency_plan objects and still in user_competency.
598 $this->assertEquals(2, \tool_lp\user_competency::count_records());
599 $this->assertEquals(3, \tool_lp\user_competency_plan::count_records());
600
601 $usercompetenciesplan = \tool_lp\user_competency_plan::get_records();
602
603 $this->assertEquals($uclist[0]->get_userid(), $usercompetenciesplan[0]->get_userid());
604 $this->assertEquals($uclist[0]->get_competencyid(), $usercompetenciesplan[0]->get_competencyid());
605 $this->assertEquals($uclist[0]->get_proficiency(), (bool) $usercompetenciesplan[0]->get_proficiency());
606 $this->assertEquals($uclist[0]->get_grade(), $usercompetenciesplan[0]->get_grade());
607 $this->assertEquals($plan->get_id(), $usercompetenciesplan[0]->get_planid());
608
609 $this->assertEquals($uclist[1]->get_userid(), $usercompetenciesplan[1]->get_userid());
610 $this->assertEquals($uclist[1]->get_competencyid(), $usercompetenciesplan[1]->get_competencyid());
611 $this->assertEquals($uclist[1]->get_proficiency(), (bool) $usercompetenciesplan[1]->get_proficiency());
612 $this->assertEquals($uclist[1]->get_grade(), $usercompetenciesplan[1]->get_grade());
613 $this->assertEquals($plan->get_id(), $usercompetenciesplan[1]->get_planid());
614
615 $this->assertEquals($user->id, $usercompetenciesplan[2]->get_userid());
616 $this->assertEquals($c3->get_id(), $usercompetenciesplan[2]->get_competencyid());
617 $this->assertNull($usercompetenciesplan[2]->get_proficiency());
618 $this->assertNull($usercompetenciesplan[2]->get_grade());
619 $this->assertEquals($plan->get_id(), $usercompetenciesplan[2]->get_planid());
620
621 // Completing a plan that is completed throws an exception.
622 $this->setExpectedException('coding_exception');
623 api::complete_plan($plan);
624 }
625
192569ed
JPG
626 /**
627 * Test update plan and the managing of archived user competencies.
628 */
629 public function test_update_plan_manage_archived_competencies() {
630 global $DB;
631
632 $this->resetAfterTest(true);
633 $dg = $this->getDataGenerator();
634 $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
635
636 $syscontext = context_system::instance();
637
638 // Create users and roles for the test.
639 $user = $dg->create_user();
640 $manageownrole = $dg->create_role(array(
641 'name' => 'User manage own',
642 'shortname' => 'manageown'
643 ));
644 assign_capability('tool/lp:planmanageowndraft', CAP_ALLOW, $manageownrole, $syscontext->id);
645 assign_capability('tool/lp:planviewowndraft', CAP_ALLOW, $manageownrole, $syscontext->id);
646 assign_capability('tool/lp:planmanageown', CAP_ALLOW, $manageownrole, $syscontext->id);
647 assign_capability('tool/lp:planviewown', CAP_ALLOW, $manageownrole, $syscontext->id);
648 $dg->role_assign($manageownrole, $user->id, $syscontext->id);
649 $this->setUser($user);
650
651 // Create a framework and assign competencies.
652 $framework = $lpg->create_framework();
653 $c1 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
654 $c2 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
655 $c3 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
656
657 // Create two plans and assign competencies.
658 $plan = $lpg->create_plan(array('userid' => $user->id));
659 $otherplan = $lpg->create_plan(array('userid' => $user->id));
660
661 $lpg->create_plan_competency(array('planid' => $plan->get_id(), 'competencyid' => $c1->get_id()));
662 $lpg->create_plan_competency(array('planid' => $plan->get_id(), 'competencyid' => $c2->get_id()));
663 $lpg->create_plan_competency(array('planid' => $plan->get_id(), 'competencyid' => $c3->get_id()));
664 $lpg->create_plan_competency(array('planid' => $otherplan->get_id(), 'competencyid' => $c1->get_id()));
665
666 $uclist = array(
667 $lpg->create_user_competency(array(
668 'userid' => $user->id,
669 'competencyid' => $c1->get_id(),
670 'proficiency' => true,
671 'grade' => 1
672 )),
673 $lpg->create_user_competency(array(
674 'userid' => $user->id,
675 'competencyid' => $c2->get_id(),
676 'proficiency' => false,
677 'grade' => 2
678 ))
679 );
680
681 // Change status of the plan to complete.
682 $record = $plan->to_record();
683 $record->status = \tool_lp\plan::STATUS_COMPLETE;
684
5bfab685
FM
685 try {
686 $plan = api::update_plan($record);
687 $this->fail('We cannot complete a plan using api::update_plan().');
688 } catch (coding_exception $e) {
689 }
690 api::complete_plan($plan);
192569ed
JPG
691
692 // Check that user compretencies are now in user_competency_plan objects and still in user_competency.
693 $this->assertEquals(2, \tool_lp\user_competency::count_records());
694 $this->assertEquals(3, \tool_lp\user_competency_plan::count_records());
695
696 $usercompetenciesplan = \tool_lp\user_competency_plan::get_records();
697
698 $this->assertEquals($uclist[0]->get_userid(), $usercompetenciesplan[0]->get_userid());
699 $this->assertEquals($uclist[0]->get_competencyid(), $usercompetenciesplan[0]->get_competencyid());
700 $this->assertEquals($uclist[0]->get_proficiency(), (bool) $usercompetenciesplan[0]->get_proficiency());
701 $this->assertEquals($uclist[0]->get_grade(), $usercompetenciesplan[0]->get_grade());
702 $this->assertEquals($plan->get_id(), $usercompetenciesplan[0]->get_planid());
703
704 $this->assertEquals($uclist[1]->get_userid(), $usercompetenciesplan[1]->get_userid());
705 $this->assertEquals($uclist[1]->get_competencyid(), $usercompetenciesplan[1]->get_competencyid());
706 $this->assertEquals($uclist[1]->get_proficiency(), (bool) $usercompetenciesplan[1]->get_proficiency());
707 $this->assertEquals($uclist[1]->get_grade(), $usercompetenciesplan[1]->get_grade());
708 $this->assertEquals($plan->get_id(), $usercompetenciesplan[1]->get_planid());
709
710 $this->assertEquals($user->id, $usercompetenciesplan[2]->get_userid());
711 $this->assertEquals($c3->get_id(), $usercompetenciesplan[2]->get_competencyid());
712 $this->assertNull($usercompetenciesplan[2]->get_proficiency());
713 $this->assertNull($usercompetenciesplan[2]->get_grade());
714 $this->assertEquals($plan->get_id(), $usercompetenciesplan[2]->get_planid());
715
192569ed
JPG
716 // Change status of the plan to active.
717 $record = $plan->to_record();
718 $record->status = \tool_lp\plan::STATUS_ACTIVE;
719
720 $plan = api::update_plan($record);
721
722 // Check that user_competency_plan objects are deleted if the plan status is changed to another status.
723 $this->assertEquals(2, \tool_lp\user_competency::count_records());
724 $this->assertEquals(0, \tool_lp\user_competency_plan::count_records());
725 }
726
727 /**
728 * Test remove plan and the managing of archived user competencies.
729 */
730 public function test_delete_plan_manage_archived_competencies() {
731 $this->resetAfterTest(true);
732 $dg = $this->getDataGenerator();
733 $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
734
735 $syscontext = context_system::instance();
736
737 // Create user and role for the test.
738 $user = $dg->create_user();
739 $managerole = $dg->create_role(array(
740 'name' => 'User manage own',
741 'shortname' => 'manageown'
742 ));
743 assign_capability('tool/lp:planmanageowndraft', CAP_ALLOW, $managerole, $syscontext->id);
744 assign_capability('tool/lp:planmanageown', CAP_ALLOW, $managerole, $syscontext->id);
745 $dg->role_assign($managerole, $user->id, $syscontext->id);
746 $this->setUser($user);
747
748 // Create a framework and assign competencies.
749 $framework = $lpg->create_framework();
750 $c1 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
751 $c2 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
752 $c3 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
753
754 // Create completed plan with records in user_competency.
755 $completedplan = $lpg->create_plan(array('userid' => $user->id, 'status' => \tool_lp\plan::STATUS_COMPLETE));
756
757 $lpg->create_plan_competency(array('planid' => $completedplan->get_id(), 'competencyid' => $c1->get_id()));
758 $lpg->create_plan_competency(array('planid' => $completedplan->get_id(), 'competencyid' => $c2->get_id()));
759
760 $uc1 = $lpg->create_user_competency(array('userid' => $user->id, 'competencyid' => $c1->get_id()));
761 $uc2 = $lpg->create_user_competency(array('userid' => $user->id, 'competencyid' => $c2->get_id()));
762
763 $ucp1 = $lpg->create_user_competency_plan(array('userid' => $user->id, 'competencyid' => $c1->get_id(),
764 'planid' => $completedplan->get_id()));
765 $ucp2 = $lpg->create_user_competency_plan(array('userid' => $user->id, 'competencyid' => $c2->get_id(),
766 'planid' => $completedplan->get_id()));
767
768 api::delete_plan($completedplan->get_id());
769
770 // Check that achived user competencies are deleted.
771 $this->assertEquals(0, \tool_lp\plan::count_records());
772 $this->assertEquals(2, \tool_lp\user_competency::count_records());
773 $this->assertEquals(0, \tool_lp\user_competency_plan::count_records());
774 }
775
776 /**
777 * Test listing of plan competencies.
778 */
779 public function test_list_plan_competencies_manage_archived_competencies() {
780 $this->resetAfterTest(true);
781 $dg = $this->getDataGenerator();
782 $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
783
784 $syscontext = context_system::instance();
785
786 // Create user and role for the test.
787 $user = $dg->create_user();
788 $viewrole = $dg->create_role(array(
789 'name' => 'User view',
790 'shortname' => 'view'
791 ));
792 assign_capability('tool/lp:planviewdraft', CAP_ALLOW, $viewrole, $syscontext->id);
793 assign_capability('tool/lp:planview', CAP_ALLOW, $viewrole, $syscontext->id);
794 $dg->role_assign($viewrole, $user->id, $syscontext->id);
795 $this->setUser($user);
796
797 // Create a framework and assign competencies.
798 $framework = $lpg->create_framework();
799 $c1 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
800 $c2 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
801 $c3 = $lpg->create_competency(array('competencyframeworkid' => $framework->get_id()));
802
803 // Create draft plan with records in user_competency.
804 $draftplan = $lpg->create_plan(array('userid' => $user->id));
805
806 $lpg->create_plan_competency(array('planid' => $draftplan->get_id(), 'competencyid' => $c1->get_id()));
807 $lpg->create_plan_competency(array('planid' => $draftplan->get_id(), 'competencyid' => $c2->get_id()));
808 $lpg->create_plan_competency(array('planid' => $draftplan->get_id(), 'competencyid' => $c3->get_id()));
809
810 $uc1 = $lpg->create_user_competency(array('userid' => $user->id, 'competencyid' => $c1->get_id()));
811 $uc2 = $lpg->create_user_competency(array('userid' => $user->id, 'competencyid' => $c2->get_id()));
812
813 // Check that user_competency objects are returned when plan status is not complete.
814 $plancompetencies = api::list_plan_competencies($draftplan);
815
816 $this->assertCount(3, $plancompetencies);
817 $this->assertInstanceOf('\tool_lp\user_competency', $plancompetencies[0]->usercompetency);
818 $this->assertEquals($uc1->get_id(), $plancompetencies[0]->usercompetency->get_id());
819 $this->assertNull($plancompetencies[0]->usercompetencyplan);
820
821 $this->assertInstanceOf('\tool_lp\user_competency', $plancompetencies[1]->usercompetency);
822 $this->assertEquals($uc2->get_id(), $plancompetencies[1]->usercompetency->get_id());
823 $this->assertNull($plancompetencies[1]->usercompetencyplan);
824
825 $this->assertInstanceOf('\tool_lp\user_competency', $plancompetencies[2]->usercompetency);
826 $this->assertEquals(0, $plancompetencies[2]->usercompetency->get_id());
827 $this->assertNull($plancompetencies[2]->usercompetencyplan);
828
829 // Create completed plan with records in user_competency_plan.
830 $completedplan = $lpg->create_plan(array('userid' => $user->id, 'status' => \tool_lp\plan::STATUS_COMPLETE));
831
832 $pc1 = $lpg->create_plan_competency(array('planid' => $completedplan->get_id(), 'competencyid' => $c1->get_id()));
833 $pc2 = $lpg->create_plan_competency(array('planid' => $completedplan->get_id(), 'competencyid' => $c2->get_id()));
834 $pc3 = $lpg->create_plan_competency(array('planid' => $completedplan->get_id(), 'competencyid' => $c3->get_id()));
835
836 $ucp1 = $lpg->create_user_competency_plan(array('userid' => $user->id, 'competencyid' => $c1->get_id(),
837 'planid' => $completedplan->get_id()));
838 $ucp2 = $lpg->create_user_competency_plan(array('userid' => $user->id, 'competencyid' => $c2->get_id(),
839 'planid' => $completedplan->get_id()));
840
841 // Check that an exception is thrown when a user competency plan is missing.
842 try {
843 $plancompetencies = api::list_plan_competencies($completedplan);
844 $this->fail('All competencies in the plan must be associated to a user competency plan');
845 } catch (coding_exception $e) {
846 $this->assertTrue(true);
847 }
848
849 $ucp3 = $lpg->create_user_competency_plan(array('userid' => $user->id, 'competencyid' => $c3->get_id(),
850 'planid' => $completedplan->get_id()));
851
852 // Check that user_competency_plan objects are returned when plan status is complete.
853 $plancompetencies = api::list_plan_competencies($completedplan);
854
855 $this->assertCount(3, $plancompetencies);
856 $this->assertInstanceOf('\tool_lp\user_competency_plan', $plancompetencies[0]->usercompetencyplan);
857 $this->assertEquals($ucp1->get_id(), $plancompetencies[0]->usercompetencyplan->get_id());
858 $this->assertNull($plancompetencies[0]->usercompetency);
859 $this->assertInstanceOf('\tool_lp\user_competency_plan', $plancompetencies[1]->usercompetencyplan);
860 $this->assertEquals($ucp2->get_id(), $plancompetencies[1]->usercompetencyplan->get_id());
861 $this->assertNull($plancompetencies[1]->usercompetency);
862 $this->assertInstanceOf('\tool_lp\user_competency_plan', $plancompetencies[2]->usercompetencyplan);
863 $this->assertEquals($ucp3->get_id(), $plancompetencies[2]->usercompetencyplan->get_id());
864 $this->assertNull($plancompetencies[2]->usercompetency);
865 }
866
bee480a4
FM
867 public function test_create_template_cohort() {
868 $this->resetAfterTest(true);
869 $this->setAdminUser();
870
871 $dg = $this->getDataGenerator();
872 $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
873
874 $c1 = $dg->create_cohort();
875 $c2 = $dg->create_cohort();
876 $t1 = $lpg->create_template();
877 $t2 = $lpg->create_template();
878
879 $this->assertEquals(0, \tool_lp\template_cohort::count_records());
880
881 // Create two relations with mixed parameters.
882 $result = api::create_template_cohort($t1->get_id(), $c1->id);
883 $result = api::create_template_cohort($t1, $c2);
884
885 $this->assertEquals(2, \tool_lp\template_cohort::count_records());
886 $this->assertInstanceOf('tool_lp\template_cohort', $result);
887 $this->assertEquals($c2->id, $result->get_cohortid());
888 $this->assertEquals($t1->get_id(), $result->get_templateid());
889 $this->assertEquals(2, \tool_lp\template_cohort::count_records_select('templateid = :id', array('id' => $t1->get_id())));
890 $this->assertEquals(0, \tool_lp\template_cohort::count_records_select('templateid = :id', array('id' => $t2->get_id())));
891 }
892
893 public function test_delete_template_cohort() {
894 $this->resetAfterTest(true);
895 $this->setAdminUser();
896
897 $dg = $this->getDataGenerator();
898 $lpg = $this->getDataGenerator()->get_plugin_generator('tool_lp');
899
900 $c1 = $dg->create_cohort();
901 $c2 = $dg->create_cohort();
902 $t1 = $lpg->create_template();
903 $t2 = $lpg->create_template();
904 $tc1 = $lpg->create_template_cohort(array('templateid' => $t1->get_id(), 'cohortid' => $c1->id));
905 $tc1 = $lpg->create_template_cohort(array('templateid' => $t2->get_id(), 'cohortid' => $c2->id));
906
907 $this->assertEquals(2, \tool_lp\template_cohort::count_records());
908 $this->assertEquals(1, \tool_lp\template_cohort::count_records_select('templateid = :id', array('id' => $t1->get_id())));
909 $this->assertEquals(1, \tool_lp\template_cohort::count_records_select('templateid = :id', array('id' => $t2->get_id())));
910
911 // Delete existing.
912 $result = api::delete_template_cohort($t1->get_id(), $c1->id);
913 $this->assertTrue($result);
914 $this->assertEquals(1, \tool_lp\template_cohort::count_records());
915 $this->assertEquals(0, \tool_lp\template_cohort::count_records_select('templateid = :id', array('id' => $t1->get_id())));
916 $this->assertEquals(1, \tool_lp\template_cohort::count_records_select('templateid = :id', array('id' => $t2->get_id())));
917
918 // Delete non-existant.
919 $result = api::delete_template_cohort($t1->get_id(), $c1->id);
920 $this->assertTrue($result);
921 $this->assertEquals(1, \tool_lp\template_cohort::count_records());
922 $this->assertEquals(0, \tool_lp\template_cohort::count_records_select('templateid = :id', array('id' => $t1->get_id())));
923 $this->assertEquals(1, \tool_lp\template_cohort::count_records_select('templateid = :id', array('id' => $t2->get_id())));
924 }
f610a957 925}