Proyectos de Subversion Moodle

Rev

Rev 11 | | Comparar con el anterior | Ultima modificación | Ver Log |

Rev Autor Línea Nro. Línea
1 efrain 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
namespace mod_feedback\external;
18
 
19
use core_external\external_api;
20
use externallib_advanced_testcase;
21
use feedback_item_multichoice;
22
use mod_feedback_external;
23
use moodle_exception;
24
 
25
defined('MOODLE_INTERNAL') || die();
26
 
27
global $CFG;
28
 
29
require_once($CFG->dirroot . '/webservice/tests/helpers.php');
30
require_once($CFG->dirroot . '/mod/feedback/lib.php');
31
 
32
/**
33
 * Feedback module external functions tests
34
 *
35
 * @package    mod_feedback
36
 * @category   external
37
 * @copyright  2017 Juan Leyva <juan@moodle.com>
38
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39
 * @since      Moodle 3.3
40
 * @covers     \mod_feedback_external
41
 */
11 efrain 42
final class external_test extends externallib_advanced_testcase {
1 efrain 43
 
44
    // TODO These should be removed.
45
    // Testcase classes should not have any properties or store state.
46
    protected $course;
47
    protected $feedback;
48
    protected $context;
49
    protected $cm;
50
    protected $student;
51
    protected $teacher;
52
    protected $studentrole;
53
    protected $teacherrole;
54
 
55
    /**
56
     * Set up for every test
57
     */
58
    public function setUp(): void {
59
        global $DB;
1441 ariadna 60
        parent::setUp();
1 efrain 61
        $this->resetAfterTest();
62
        $this->setAdminUser();
63
 
64
        // Setup test data.
65
        $this->course = $this->getDataGenerator()->create_course();
66
        $this->feedback = $this->getDataGenerator()->create_module('feedback',
67
            array('course' => $this->course->id, 'email_notification' => 1));
68
        $this->context = \context_module::instance($this->feedback->cmid);
69
        $this->cm = get_coursemodule_from_instance('feedback', $this->feedback->id);
70
 
71
        // Create users.
72
        $this->student = self::getDataGenerator()->create_user();
73
        $this->teacher = self::getDataGenerator()->create_user();
74
 
75
        // Users enrolments.
76
        $this->studentrole = $DB->get_record('role', array('shortname' => 'student'));
77
        $this->teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));
78
        $this->getDataGenerator()->enrol_user($this->student->id, $this->course->id, $this->studentrole->id, 'manual');
79
        $this->getDataGenerator()->enrol_user($this->teacher->id, $this->course->id, $this->teacherrole->id, 'manual');
80
    }
81
 
82
    /**
83
     * Helper method to add items to an existing feedback.
84
     *
85
     * @param \stdClass $feedback feedback instance
86
     * @param integer $pagescount the number of pages we want in the feedback
87
     * @return array list of items created
88
     */
89
    public function populate_feedback($feedback, $pagescount = 1) {
90
        $feedbackgenerator = $this->getDataGenerator()->get_plugin_generator('mod_feedback');
91
        $itemscreated = [];
92
 
93
        // Create at least one page.
94
        $itemscreated[] = $feedbackgenerator->create_item_label($feedback);
95
        $itemscreated[] = $feedbackgenerator->create_item_info($feedback);
96
        $itemscreated[] = $feedbackgenerator->create_item_numeric($feedback);
97
 
98
        // Check if we want more pages.
99
        for ($i = 1; $i < $pagescount; $i++) {
100
            $itemscreated[] = $feedbackgenerator->create_item_pagebreak($feedback);
101
            $itemscreated[] = $feedbackgenerator->create_item_multichoice($feedback);
102
            $itemscreated[] = $feedbackgenerator->create_item_multichoicerated($feedback);
103
            $itemscreated[] = $feedbackgenerator->create_item_textarea($feedback);
104
            $itemscreated[] = $feedbackgenerator->create_item_textfield($feedback);
105
            $itemscreated[] = $feedbackgenerator->create_item_numeric($feedback);
106
        }
107
        return $itemscreated;
108
    }
109
 
110
 
111
    /**
112
     * Test test_mod_feedback_get_feedbacks_by_courses
113
     */
11 efrain 114
    public function test_mod_feedback_get_feedbacks_by_courses(): void {
1 efrain 115
 
116
        // Create additional course.
117
        $course2 = self::getDataGenerator()->create_course();
118
 
119
        // Second feedback.
120
        $record = new \stdClass();
121
        $record->course = $course2->id;
122
        $feedback2 = self::getDataGenerator()->create_module('feedback', $record);
123
 
124
        // Execute real Moodle enrolment as we'll call unenrol() method on the instance later.
125
        $enrol = enrol_get_plugin('manual');
126
        $enrolinstances = enrol_get_instances($course2->id, true);
127
        $instance2 = (object) [];
128
        foreach ($enrolinstances as $courseenrolinstance) {
129
            if ($courseenrolinstance->enrol == "manual") {
130
                $instance2 = $courseenrolinstance;
131
                break;
132
            }
133
        }
134
 
135
        $enrol->enrol_user($instance2, $this->student->id, $this->studentrole->id);
136
 
137
        self::setUser($this->student);
138
 
139
        $returndescription = mod_feedback_external::get_feedbacks_by_courses_returns();
140
 
141
        // Create what we expect to be returned when querying the two courses.
142
        // First for the student user.
143
        $expectedfields = array('id', 'coursemodule', 'course', 'name', 'intro', 'introformat', 'introfiles', 'lang', 'anonymous',
144
            'multiple_submit', 'autonumbering', 'page_after_submitformat', 'publish_stats', 'completionsubmit');
145
 
146
        $properties = feedback_summary_exporter::read_properties_definition();
147
 
148
        // Add expected coursemodule and data.
149
        $feedback1 = $this->feedback;
150
        $feedback1->coursemodule = $feedback1->cmid;
151
        $feedback1->introformat = 1;
152
        $feedback1->introfiles = [];
153
        $feedback1->lang = '';
154
 
155
        $feedback2->coursemodule = $feedback2->cmid;
156
        $feedback2->introformat = 1;
157
        $feedback2->introfiles = [];
158
        $feedback2->lang = '';
159
 
160
        foreach ($expectedfields as $field) {
161
            if (!empty($properties[$field]) && $properties[$field]['type'] == PARAM_BOOL) {
162
                $feedback1->{$field} = (bool) $feedback1->{$field};
163
                $feedback2->{$field} = (bool) $feedback2->{$field};
164
            }
165
            $expected1[$field] = $feedback1->{$field};
166
            $expected2[$field] = $feedback2->{$field};
167
        }
168
 
169
        $expectedfeedbacks = array($expected2, $expected1);
170
 
171
        // Call the external function passing course ids.
172
        $result = mod_feedback_external::get_feedbacks_by_courses(array($course2->id, $this->course->id));
173
        $result = external_api::clean_returnvalue($returndescription, $result);
174
 
175
        $this->assertEquals($expectedfeedbacks, $result['feedbacks']);
176
        $this->assertCount(0, $result['warnings']);
177
 
178
        // Call the external function without passing course id.
179
        $result = mod_feedback_external::get_feedbacks_by_courses();
180
        $result = external_api::clean_returnvalue($returndescription, $result);
181
        $this->assertEquals($expectedfeedbacks, $result['feedbacks']);
182
        $this->assertCount(0, $result['warnings']);
183
 
184
        // Unenrol user from second course and alter expected feedbacks.
185
        $enrol->unenrol_user($instance2, $this->student->id);
186
        array_shift($expectedfeedbacks);
187
 
188
        // Call the external function without passing course id.
189
        $result = mod_feedback_external::get_feedbacks_by_courses();
190
        $result = external_api::clean_returnvalue($returndescription, $result);
191
        $this->assertEquals($expectedfeedbacks, $result['feedbacks']);
192
 
193
        // Call for the second course we unenrolled the user from, expected warning.
194
        $result = mod_feedback_external::get_feedbacks_by_courses(array($course2->id));
195
        $this->assertCount(1, $result['warnings']);
196
        $this->assertEquals('1', $result['warnings'][0]['warningcode']);
197
        $this->assertEquals($course2->id, $result['warnings'][0]['itemid']);
198
 
199
        // Now, try as a teacher for getting all the additional fields.
200
        self::setUser($this->teacher);
201
 
202
        $additionalfields = array('email_notification', 'site_after_submit', 'page_after_submit', 'timeopen', 'timeclose',
203
            'timemodified', 'pageaftersubmitfiles');
204
 
205
        $feedback1->pageaftersubmitfiles = [];
206
 
207
        foreach ($additionalfields as $field) {
208
            if (!empty($properties[$field]) && $properties[$field]['type'] == PARAM_BOOL) {
209
                $feedback1->{$field} = (bool) $feedback1->{$field};
210
            }
211
            $expectedfeedbacks[0][$field] = $feedback1->{$field};
212
        }
213
        $expectedfeedbacks[0]['page_after_submitformat'] = 1;
214
 
215
        $result = mod_feedback_external::get_feedbacks_by_courses();
216
        $result = external_api::clean_returnvalue($returndescription, $result);
217
        $this->assertEquals($expectedfeedbacks, $result['feedbacks']);
218
 
219
        // Admin also should get all the information.
220
        self::setAdminUser();
221
 
222
        $result = mod_feedback_external::get_feedbacks_by_courses(array($this->course->id));
223
        $result = external_api::clean_returnvalue($returndescription, $result);
224
        $this->assertEquals($expectedfeedbacks, $result['feedbacks']);
225
    }
226
 
227
    /**
228
     * Test get_feedback_access_information function with basic defaults for student.
229
     */
11 efrain 230
    public function test_get_feedback_access_information_student(): void {
1 efrain 231
 
232
        self::setUser($this->student);
233
        $result = mod_feedback_external::get_feedback_access_information($this->feedback->id);
234
        $result = external_api::clean_returnvalue(mod_feedback_external::get_feedback_access_information_returns(), $result);
235
 
236
        $this->assertFalse($result['canviewanalysis']);
237
        $this->assertFalse($result['candeletesubmissions']);
238
        $this->assertFalse($result['canviewreports']);
239
        $this->assertFalse($result['canedititems']);
240
        $this->assertTrue($result['cancomplete']);
241
        $this->assertTrue($result['cansubmit']);
242
        $this->assertTrue($result['isempty']);
243
        $this->assertTrue($result['isopen']);
244
        $this->assertTrue($result['isanonymous']);
245
        $this->assertFalse($result['isalreadysubmitted']);
246
    }
247
 
248
    /**
249
     * Test get_feedback_access_information function with basic defaults for teacher.
250
     */
11 efrain 251
    public function test_get_feedback_access_information_teacher(): void {
1 efrain 252
 
253
        self::setUser($this->teacher);
254
        $result = mod_feedback_external::get_feedback_access_information($this->feedback->id);
255
        $result = external_api::clean_returnvalue(mod_feedback_external::get_feedback_access_information_returns(), $result);
256
 
257
        $this->assertTrue($result['canviewanalysis']);
258
        $this->assertTrue($result['canviewreports']);
259
        $this->assertTrue($result['canedititems']);
260
        $this->assertTrue($result['candeletesubmissions']);
261
        $this->assertFalse($result['cancomplete']);
262
        $this->assertTrue($result['cansubmit']);
263
        $this->assertTrue($result['isempty']);
264
        $this->assertTrue($result['isopen']);
265
        $this->assertTrue($result['isanonymous']);
266
        $this->assertFalse($result['isalreadysubmitted']);
267
 
268
        // Add some items to the feedback and check is not empty any more.
269
        self::populate_feedback($this->feedback);
270
        $result = mod_feedback_external::get_feedback_access_information($this->feedback->id);
271
        $result = external_api::clean_returnvalue(mod_feedback_external::get_feedback_access_information_returns(), $result);
272
        $this->assertFalse($result['isempty']);
273
    }
274
 
275
    /**
276
     * Test view_feedback invalid id.
277
     */
11 efrain 278
    public function test_view_feedback_invalid_id(): void {
1 efrain 279
        // Test invalid instance id.
280
        $this->expectException(moodle_exception::class);
281
        mod_feedback_external::view_feedback(0);
282
    }
283
    /**
284
     * Test view_feedback not enrolled user.
285
     */
11 efrain 286
    public function test_view_feedback_not_enrolled_user(): void {
1 efrain 287
        $usernotenrolled = self::getDataGenerator()->create_user();
288
        $this->setUser($usernotenrolled);
289
        $this->expectException(moodle_exception::class);
290
        mod_feedback_external::view_feedback(0);
291
    }
292
    /**
293
     * Test view_feedback no capabilities.
294
     */
11 efrain 295
    public function test_view_feedback_no_capabilities(): void {
1 efrain 296
        // Test user with no capabilities.
297
        // We need a explicit prohibit since this capability is allowed for students by default.
298
        assign_capability('mod/feedback:view', CAP_PROHIBIT, $this->studentrole->id, $this->context->id);
299
        accesslib_clear_all_caches_for_unit_testing();
300
        $this->expectException(moodle_exception::class);
301
        mod_feedback_external::view_feedback(0);
302
    }
303
    /**
304
     * Test view_feedback.
305
     */
11 efrain 306
    public function test_view_feedback(): void {
1 efrain 307
        // Test user with full capabilities.
308
        $this->setUser($this->student);
309
        // Trigger and capture the event.
310
        $sink = $this->redirectEvents();
311
        $result = mod_feedback_external::view_feedback($this->feedback->id);
312
        $result = external_api::clean_returnvalue(mod_feedback_external::view_feedback_returns(), $result);
313
        $events = $sink->get_events();
314
        $this->assertCount(1, $events);
315
        $event = array_shift($events);
316
        // Checking that the event contains the expected values.
317
        $this->assertInstanceOf('\mod_feedback\event\course_module_viewed', $event);
318
        $this->assertEquals($this->context, $event->get_context());
319
        $moodledata = new \moodle_url('/mod/feedback/view.php', array('id' => $this->cm->id));
320
        $this->assertEquals($moodledata, $event->get_url());
321
        $this->assertEventContextNotUsed($event);
322
        $this->assertNotEmpty($event->get_name());
323
    }
324
 
325
    /**
326
     * Test get_current_completed_tmp.
327
     */
11 efrain 328
    public function test_get_current_completed_tmp(): void {
1 efrain 329
        global $DB;
330
 
331
        // Force non anonymous.
332
        $DB->set_field('feedback', 'anonymous', FEEDBACK_ANONYMOUS_NO, array('id' => $this->feedback->id));
333
        // Add a completed_tmp record.
334
        $record = [
335
            'feedback' => $this->feedback->id,
336
            'userid' => $this->student->id,
337
            'guestid' => '',
338
            'timemodified' => time() - DAYSECS,
339
            'random_response' => 0,
340
            'anonymous_response' => FEEDBACK_ANONYMOUS_NO,
341
            'courseid' => $this->course->id,
342
        ];
343
        $record['id'] = $DB->insert_record('feedback_completedtmp', (object) $record);
344
 
345
        // Test user with full capabilities.
346
        $this->setUser($this->student);
347
 
348
        $result = mod_feedback_external::get_current_completed_tmp($this->feedback->id);
349
        $result = external_api::clean_returnvalue(mod_feedback_external::get_current_completed_tmp_returns(), $result);
350
        $this->assertEquals($record['id'], $result['feedback']['id']);
351
    }
352
 
353
    /**
354
     * Test get_items.
355
     */
11 efrain 356
    public function test_get_items(): void {
1 efrain 357
        // Test user with full capabilities.
358
        $this->setUser($this->student);
359
 
360
        // Add questions to the feedback, we are adding 2 pages of questions.
361
        $itemscreated = self::populate_feedback($this->feedback, 2);
362
 
363
        $result = mod_feedback_external::get_items($this->feedback->id);
364
        $result = external_api::clean_returnvalue(mod_feedback_external::get_items_returns(), $result);
365
        $this->assertCount(count($itemscreated), $result['items']);
366
        $index = 1;
367
        foreach ($result['items'] as $key => $item) {
368
            if (is_numeric($itemscreated[$key])) {
369
                continue; // Page break.
370
            }
371
            // Cannot compare directly the exporter and the db object (exporter have more fields).
372
            $this->assertEquals($itemscreated[$key]->id, $item['id']);
373
            $this->assertEquals($itemscreated[$key]->typ, $item['typ']);
374
            $this->assertEquals($itemscreated[$key]->name, $item['name']);
375
            $this->assertEquals($itemscreated[$key]->label, $item['label']);
376
 
377
            if ($item['hasvalue']) {
378
                $this->assertEquals($index, $item['itemnumber']);
379
                $index++;
380
            }
381
        }
382
    }
383
 
384
    /**
385
     * Test get_items, to confirm validation is done too.
386
     *
387
     * @dataProvider items_provider
388
     * @param string $role Whether the current user should be a student or a teacher.
389
     * @param array $info Settings to create the feedback.
390
     * @param string|null $warning The warning message to display or null if warnings result is empty.
391
     */
392
    public function test_get_items_validation(string $role, array $info, ?string $warning): void {
393
        global $DB;
394
 
395
        // Test user with full capabilities.
396
        if ($role === 'teacher') {
397
            $this->setUser($this->teacher);
398
        } else {
399
            $this->setUser($this->student);
400
        }
401
 
402
        // Create the feedback.
403
        $data = ['course' => $this->course->id];
404
        if (array_key_exists('closed', $info) && $info['closed']) {
405
            $data['timeopen'] = time() + DAYSECS;
406
        }
407
        $feedback = $this->getDataGenerator()->create_module('feedback', $data);
408
 
409
        $empty = true;
410
        if (!array_key_exists('empty', $info) || !$info['empty']) {
411
            $empty = false;
412
            /** @var \mod_feedback_generator $feedbackgenerator */
413
            $feedbackgenerator = $this->getDataGenerator()->get_plugin_generator('mod_feedback');
414
            // Add,at least, one item to the feedback.
415
            $feedbackgenerator->create_item_label($feedback);
416
        }
417
 
418
        if (array_key_exists('complete', $info) && !$info['complete']) {
419
            $studentrole = $DB->get_record('role', array('shortname' => 'student'));
420
            $coursecontext = \context_course::instance($this->course->id);
421
            assign_capability('mod/feedback:complete', CAP_PROHIBIT, $studentrole->id, $coursecontext->id);
422
            // Empty all the caches that may be affected by this change.
423
            accesslib_clear_all_caches_for_unit_testing();
424
            \course_modinfo::clear_instance_cache();
425
        }
426
 
427
        $result = mod_feedback_external::get_items($feedback->id);
428
        $result = external_api::clean_returnvalue(mod_feedback_external::get_items_returns(), $result);
429
        if ($warning) {
430
            $this->assertEmpty($result['items']);
431
            $this->assertCount(1, $result['warnings']);
432
            $resultwarning = reset($result['warnings']);
433
            if ($warning == 'required_capability_exception') {
434
                $this->assertStringContainsString('error/nopermission', $resultwarning['message']);
435
            } else {
436
                $this->assertEquals($warning, $resultwarning['message']);
437
            }
438
        } else {
439
            if ($empty) {
440
                $this->assertEmpty($result['items']);
441
            } else {
442
                $this->assertCount(1, $result['items']);
443
            }
444
            $this->assertEmpty($result['warnings']);
445
        }
446
    }
447
 
448
    /**
449
     * Data provider for test_get_items_validation() and test_get_page_items_validation().
450
     *
451
     * @return array
452
     */
11 efrain 453
    public static function items_provider(): array {
1 efrain 454
        return [
455
            'Valid feedback (as student)' => [
456
                'role' => 'student',
457
                'info' => [],
458
                'warning' => null,
459
            ],
460
            'Closed feedback (as student)' => [
461
                'role' => 'student',
462
                'info' => ['closed' => true],
463
                'warning' => get_string('feedback_is_not_open', 'feedback'),
464
            ],
465
            'Empty feedback (as student)' => [
466
                'role' => 'student',
467
                'info' => ['empty' => true],
468
                'warning' => get_string('no_items_available_yet', 'feedback'),
469
            ],
470
            'Cannot complete feedback (as student)' => [
471
                'role' => 'student',
472
                'info' => ['complete' => false],
473
                'warning' => 'required_capability_exception',
474
            ],
475
            'Valid feedback (as teacher)' => [
476
                'role' => 'teacher',
477
                'info' => [],
478
                'warning' => null,
479
            ],
480
            'Closed feedback (as teacher)' => [
481
                'role' => 'teacher',
482
                'info' => ['closed' => true],
483
                'warning' => null,
484
            ],
485
            'Empty feedback (as teacher)' => [
486
                'role' => 'teacher',
487
                'info' => ['empty' => true],
488
                'warning' => null,
489
            ],
490
            'Cannot complete feedback (as teacher)' => [
491
                'role' => 'teacher',
492
                'info' => ['complete' => false],
493
                'warning' => null,
494
            ],
495
        ];
496
    }
497
 
498
    /**
499
     * Test launch_feedback.
500
     */
11 efrain 501
    public function test_launch_feedback(): void {
1 efrain 502
        global $DB;
503
 
504
        // Test user with full capabilities.
505
        $this->setUser($this->student);
506
 
507
        // Add questions to the feedback, we are adding 2 pages of questions.
508
        $itemscreated = self::populate_feedback($this->feedback, 2);
509
 
510
        // First try a feedback we didn't attempt.
511
        $result = mod_feedback_external::launch_feedback($this->feedback->id);
512
        $result = external_api::clean_returnvalue(mod_feedback_external::launch_feedback_returns(), $result);
513
        $this->assertEquals(0, $result['gopage']);
514
 
515
        // Now, try a feedback that we attempted.
516
        // Force non anonymous.
517
        $DB->set_field('feedback', 'anonymous', FEEDBACK_ANONYMOUS_NO, array('id' => $this->feedback->id));
518
        // Add a completed_tmp record.
519
        $record = [
520
            'feedback' => $this->feedback->id,
521
            'userid' => $this->student->id,
522
            'guestid' => '',
523
            'timemodified' => time() - DAYSECS,
524
            'random_response' => 0,
525
            'anonymous_response' => FEEDBACK_ANONYMOUS_NO,
526
            'courseid' => $this->course->id,
527
        ];
528
        $record['id'] = $DB->insert_record('feedback_completedtmp', (object) $record);
529
 
530
        // Add a response to the feedback for each question type with possible values.
531
        $response = [
532
            'course_id' => $this->course->id,
533
            'item' => $itemscreated[1]->id, // First item is the info question.
534
            'completed' => $record['id'],
535
            'tmp_completed' => $record['id'],
536
            'value' => 'A',
537
        ];
538
        $DB->insert_record('feedback_valuetmp', (object) $response);
539
        $response = [
540
            'course_id' => $this->course->id,
541
            'item' => $itemscreated[2]->id, // Second item is the numeric question.
542
            'completed' => $record['id'],
543
            'tmp_completed' => $record['id'],
544
            'value' => 5,
545
        ];
546
        $DB->insert_record('feedback_valuetmp', (object) $response);
547
 
548
        $result = mod_feedback_external::launch_feedback($this->feedback->id);
549
        $result = external_api::clean_returnvalue(mod_feedback_external::launch_feedback_returns(), $result);
550
        $this->assertEquals(1, $result['gopage']);
551
    }
552
 
553
    /**
554
     * Test get_page_items.
555
     */
11 efrain 556
    public function test_get_page_items(): void {
1 efrain 557
        // Test user with full capabilities.
558
        $this->setUser($this->student);
559
 
560
        // Add questions to the feedback, we are adding 2 pages of questions.
561
        $itemscreated = self::populate_feedback($this->feedback, 2);
562
 
563
        // Retrieve first page.
564
        $result = mod_feedback_external::get_page_items($this->feedback->id, 0);
565
        $result = external_api::clean_returnvalue(mod_feedback_external::get_page_items_returns(), $result);
566
        $this->assertCount(3, $result['items']);    // The first page has 3 items.
567
        $this->assertTrue($result['hasnextpage']);
568
        $this->assertFalse($result['hasprevpage']);
569
 
570
        // Retrieve second page.
571
        $result = mod_feedback_external::get_page_items($this->feedback->id, 1);
572
        $result = external_api::clean_returnvalue(mod_feedback_external::get_page_items_returns(), $result);
573
        $this->assertCount(5, $result['items']);    // The second page has 5 items (page break doesn't count).
574
        $this->assertFalse($result['hasnextpage']);
575
        $this->assertTrue($result['hasprevpage']);
576
    }
577
 
578
    /**
579
     * Test get_page_items, to confirm validation is done too.
580
     *
581
     * @dataProvider items_provider
582
     * @param string $role Whether the current user should be a student or a teacher.
583
     * @param array $info Settings to create the feedback.
584
     * @param string|null $warning The warning message to display or null if warnings result is empty.
585
     */
586
    public function test_get_page_items_validation(string $role, array $info, ?string $warning): void {
587
        global $DB;
588
 
589
        // Test user with full capabilities.
590
        if ($role === 'teacher') {
591
            $this->setUser($this->teacher);
592
        } else {
593
            $this->setUser($this->student);
594
        }
595
 
596
        // Create the feedback.
597
        $data = ['course' => $this->course->id];
598
        if (array_key_exists('closed', $info) && $info['closed']) {
599
            $data['timeopen'] = time() + DAYSECS;
600
        }
601
        $feedback = $this->getDataGenerator()->create_module('feedback', $data);
602
 
603
        $empty = true;
604
        if (!array_key_exists('empty', $info) || !$info['empty']) {
605
            $empty = false;
606
            /** @var \mod_feedback_generator $feedbackgenerator */
607
            $feedbackgenerator = $this->getDataGenerator()->get_plugin_generator('mod_feedback');
608
            // Add,at least, one item to the feedback.
609
            $feedbackgenerator->create_item_label($feedback);
610
        }
611
 
612
        if (array_key_exists('complete', $info) && !$info['complete']) {
613
            $studentrole = $DB->get_record('role', array('shortname' => 'student'));
614
            $coursecontext = \context_course::instance($this->course->id);
615
            assign_capability('mod/feedback:complete', CAP_PROHIBIT, $studentrole->id, $coursecontext->id);
616
            // Empty all the caches that may be affected by this change.
617
            accesslib_clear_all_caches_for_unit_testing();
618
            \course_modinfo::clear_instance_cache();
619
        }
620
 
621
        $result = mod_feedback_external::get_page_items($feedback->id, 0);
622
        $result = external_api::clean_returnvalue(mod_feedback_external::get_items_returns(), $result);
623
        if ($warning) {
624
            $this->assertEmpty($result['items']);
625
            $this->assertCount(1, $result['warnings']);
626
            $resultwarning = reset($result['warnings']);
627
            if ($warning == 'required_capability_exception') {
628
                $this->assertStringContainsString('error/nopermission', $resultwarning['message']);
629
            } else {
630
                $this->assertEquals($warning, $resultwarning['message']);
631
            }
632
        } else {
633
            if ($empty) {
634
                $this->assertEmpty($result['items']);
635
            } else {
636
                $this->assertCount(1, $result['items']);
637
            }
638
            $this->assertEmpty($result['warnings']);
639
        }
640
    }
641
 
642
    /**
643
     * Test process_page.
644
     */
11 efrain 645
    public function test_process_page(): void {
1 efrain 646
        global $DB;
647
 
648
        // Test user with full capabilities.
649
        $this->setUser($this->student);
650
        $pagecontents = 'You finished it!';
651
        $DB->set_field('feedback', 'page_after_submit', $pagecontents, array('id' => $this->feedback->id));
652
 
653
        // Add questions to the feedback, we are adding 2 pages of questions.
654
        $itemscreated = self::populate_feedback($this->feedback, 2);
655
 
656
        $data = [];
657
        foreach ($itemscreated as $item) {
658
 
659
            if (empty($item->hasvalue)) {
660
                continue;
661
            }
662
 
663
            switch ($item->typ) {
664
                case 'textarea':
665
                case 'textfield':
666
                    $value = 'Lorem ipsum';
667
                    break;
668
                case 'numeric':
669
                    $value = 5;
670
                    break;
671
                case 'multichoice':
672
                    $value = '1';
673
                    break;
674
                case 'multichoicerated':
675
                    $value = '1';
676
                    break;
677
                case 'info':
678
                    $value = format_string($this->course->shortname, true, array('context' => $this->context));
679
                    break;
680
                default:
681
                    $value = '';
682
            }
683
            $data[] = ['name' => $item->typ . '_' . $item->id, 'value' => $value];
684
        }
685
 
686
        // Process first page.
687
        $firstpagedata = [$data[0], $data[1]];
688
        $result = mod_feedback_external::process_page($this->feedback->id, 0, $firstpagedata);
689
        $result = external_api::clean_returnvalue(mod_feedback_external::process_page_returns(), $result);
690
        $this->assertEquals(1, $result['jumpto']);
691
        $this->assertFalse($result['completed']);
692
 
693
        // Now, process the second page. But first we are going back to the first page.
694
        $secondpagedata = [$data[2], $data[3], $data[4], $data[5], $data[6]];
695
        $result = mod_feedback_external::process_page($this->feedback->id, 1, $secondpagedata, true);
696
        $result = external_api::clean_returnvalue(mod_feedback_external::process_page_returns(), $result);
697
        $this->assertFalse($result['completed']);
698
        $this->assertEquals(0, $result['jumpto']);  // We jumped to the first page.
699
        // Check the values were correctly saved.
700
        $tmpitems = $DB->get_records('feedback_valuetmp');
701
        $this->assertCount(7, $tmpitems);   // 2 from the first page + 5 from the second page.
702
 
703
        // Go forward again (sending the same data).
704
        $result = mod_feedback_external::process_page($this->feedback->id, 0, $firstpagedata);
705
        $result = external_api::clean_returnvalue(mod_feedback_external::process_page_returns(), $result);
706
        $this->assertEquals(1, $result['jumpto']);
707
        $this->assertFalse($result['completed']);
708
        $tmpitems = $DB->get_records('feedback_valuetmp');
709
        $this->assertCount(7, $tmpitems);   // 2 from the first page + 5 from the second page.
710
 
711
        // And finally, save everything! We are going to modify one previous recorded value.
712
        $messagessink = $this->redirectMessages();
713
        $data[2]['value'] = 2; // 2 is value of the option 'b'.
714
        $secondpagedata = [$data[2], $data[3], $data[4], $data[5], $data[6]];
715
        $result = mod_feedback_external::process_page($this->feedback->id, 1, $secondpagedata);
716
        $result = external_api::clean_returnvalue(mod_feedback_external::process_page_returns(), $result);
717
        $this->assertTrue($result['completed']);
718
        $this->assertTrue(strpos($result['completionpagecontents'], $pagecontents) !== false);
719
        // Check all the items were saved.
720
        $items = $DB->get_records('feedback_value');
721
        $this->assertCount(7, $items);
722
        // Check if the one we modified was correctly saved.
723
        $itemid = $itemscreated[4]->id;
724
        $itemsaved = $DB->get_field('feedback_value', 'value', array('item' => $itemid));
725
        $mcitem = new feedback_item_multichoice();
726
        $itemval = $mcitem->get_printval($itemscreated[4], (object) ['value' => $itemsaved]);
727
        $this->assertEquals('b', $itemval);
728
 
729
        // Check that the answers are saved for course 0.
730
        foreach ($items as $item) {
731
            $this->assertEquals(0, $item->course_id);
732
        }
733
        $completed = $DB->get_record('feedback_completed', []);
734
        $this->assertEquals(0, $completed->courseid);
735
 
736
        // Test notifications sent.
737
        $messages = $messagessink->get_messages();
738
        $messagessink->close();
739
        // Test customdata.
740
        $customdata = json_decode($messages[0]->customdata);
741
        $this->assertEquals($this->feedback->id, $customdata->instance);
742
        $this->assertEquals($this->feedback->cmid, $customdata->cmid);
743
        $this->assertObjectHasProperty('notificationiconurl', $customdata);
744
    }
745
 
746
    /**
747
     * Test process_page for a site feedback.
748
     */
11 efrain 749
    public function test_process_page_site_feedback(): void {
1 efrain 750
        global $DB;
751
        $pagecontents = 'You finished it!';
752
        $this->feedback = $this->getDataGenerator()->create_module('feedback',
753
            array('course' => SITEID, 'page_after_submit' => $pagecontents));
754
 
755
        // Test user with full capabilities.
756
        $this->setUser($this->student);
757
 
758
        // Add questions to the feedback, we are adding 2 pages of questions.
759
        $itemscreated = self::populate_feedback($this->feedback, 2);
760
 
761
        $data = [];
762
        foreach ($itemscreated as $item) {
763
 
764
            if (empty($item->hasvalue)) {
765
                continue;
766
            }
767
 
768
            switch ($item->typ) {
769
                case 'textarea':
770
                case 'textfield':
771
                    $value = 'Lorem ipsum';
772
                    break;
773
                case 'numeric':
774
                    $value = 5;
775
                    break;
776
                case 'multichoice':
777
                    $value = '1';
778
                    break;
779
                case 'multichoicerated':
780
                    $value = '1';
781
                    break;
782
                case 'info':
783
                    $value = format_string($this->course->shortname, true, array('context' => $this->context));
784
                    break;
785
                default:
786
                    $value = '';
787
            }
788
            $data[] = ['name' => $item->typ . '_' . $item->id, 'value' => $value];
789
        }
790
 
791
        // Process first page.
792
        $firstpagedata = [$data[0], $data[1]];
793
        $result = mod_feedback_external::process_page($this->feedback->id, 0, $firstpagedata, false, $this->course->id);
794
        $result = external_api::clean_returnvalue(mod_feedback_external::process_page_returns(), $result);
795
        $this->assertEquals(1, $result['jumpto']);
796
        $this->assertFalse($result['completed']);
797
 
798
        // Process second page.
799
        $data[2]['value'] = 2; // 2 is value of the option 'b';
800
        $secondpagedata = [$data[2], $data[3], $data[4], $data[5], $data[6]];
801
        $result = mod_feedback_external::process_page($this->feedback->id, 1, $secondpagedata, false, $this->course->id);
802
        $result = external_api::clean_returnvalue(mod_feedback_external::process_page_returns(), $result);
803
        $this->assertTrue($result['completed']);
804
        $this->assertTrue(strpos($result['completionpagecontents'], $pagecontents) !== false);
805
        // Check all the items were saved.
806
        $items = $DB->get_records('feedback_value');
807
        $this->assertCount(7, $items);
808
        // Check if the one we modified was correctly saved.
809
        $itemid = $itemscreated[4]->id;
810
        $itemsaved = $DB->get_field('feedback_value', 'value', array('item' => $itemid));
811
        $mcitem = new feedback_item_multichoice();
812
        $itemval = $mcitem->get_printval($itemscreated[4], (object) ['value' => $itemsaved]);
813
        $this->assertEquals('b', $itemval);
814
 
815
        // Check that the answers are saved for the correct course.
816
        foreach ($items as $item) {
817
            $this->assertEquals($this->course->id, $item->course_id);
818
        }
819
        $completed = $DB->get_record('feedback_completed', []);
820
        $this->assertEquals($this->course->id, $completed->courseid);
821
    }
822
 
823
    /**
824
     * Test get_analysis.
825
     */
11 efrain 826
    public function test_get_analysis(): void {
1 efrain 827
        // Test user with full capabilities.
828
        $this->setUser($this->student);
829
 
830
        // Create a very simple feedback.
831
        $feedbackgenerator = $this->getDataGenerator()->get_plugin_generator('mod_feedback');
832
        $numericitem = $feedbackgenerator->create_item_numeric($this->feedback);
833
        $textfielditem = $feedbackgenerator->create_item_textfield($this->feedback);
834
 
835
        $pagedata = [
836
            ['name' => $numericitem->typ .'_'. $numericitem->id, 'value' => 5],
837
            ['name' => $textfielditem->typ .'_'. $textfielditem->id, 'value' => 'abc'],
838
        ];
839
        // Process the feedback, there is only one page so the feedback will be completed.
840
        $result = mod_feedback_external::process_page($this->feedback->id, 0, $pagedata);
841
        $result = external_api::clean_returnvalue(mod_feedback_external::process_page_returns(), $result);
842
        $this->assertTrue($result['completed']);
843
 
844
        // Retrieve analysis.
845
        $this->setUser($this->teacher);
846
        $result = mod_feedback_external::get_analysis($this->feedback->id);
847
        $result = external_api::clean_returnvalue(mod_feedback_external::get_analysis_returns(), $result);
848
        $this->assertEquals(1, $result['completedcount']);  // 1 feedback completed.
849
        $this->assertEquals(2, $result['itemscount']);  // 2 items in the feedback.
850
        $this->assertCount(2, $result['itemsdata']);
851
        $this->assertCount(1, $result['itemsdata'][0]['data']); // There are 1 response per item.
852
        $this->assertCount(1, $result['itemsdata'][1]['data']);
853
        // Check we receive the info the students filled.
854
        foreach ($result['itemsdata'] as $data) {
855
            if ($data['item']['id'] == $numericitem->id) {
856
                $this->assertEquals(5, $data['data'][0]);
857
            } else {
858
                $this->assertEquals('abc', $data['data'][0]);
859
            }
860
        }
861
 
862
        // Create another user / response.
863
        $anotherstudent = self::getDataGenerator()->create_user();
864
        $this->getDataGenerator()->enrol_user($anotherstudent->id, $this->course->id, $this->studentrole->id, 'manual');
865
        $this->setUser($anotherstudent);
866
 
867
        // Process the feedback, there is only one page so the feedback will be completed.
868
        $result = mod_feedback_external::process_page($this->feedback->id, 0, $pagedata);
869
        $result = external_api::clean_returnvalue(mod_feedback_external::process_page_returns(), $result);
870
        $this->assertTrue($result['completed']);
871
 
872
        // Retrieve analysis.
873
        $this->setUser($this->teacher);
874
        $result = mod_feedback_external::get_analysis($this->feedback->id);
875
        $result = external_api::clean_returnvalue(mod_feedback_external::get_analysis_returns(), $result);
876
        $this->assertEquals(2, $result['completedcount']);  // 2 feedback completed.
877
        $this->assertEquals(2, $result['itemscount']);
878
        $this->assertCount(2, $result['itemsdata'][0]['data']); // There are 2 responses per item.
879
        $this->assertCount(2, $result['itemsdata'][1]['data']);
880
    }
881
 
882
    /**
883
     * Test get_unfinished_responses.
884
     */
11 efrain 885
    public function test_get_unfinished_responses(): void {
1 efrain 886
        // Test user with full capabilities.
887
        $this->setUser($this->student);
888
 
889
        // Create a very simple feedback.
890
        $feedbackgenerator = $this->getDataGenerator()->get_plugin_generator('mod_feedback');
891
        $numericitem = $feedbackgenerator->create_item_numeric($this->feedback);
892
        $textfielditem = $feedbackgenerator->create_item_textfield($this->feedback);
893
        $feedbackgenerator->create_item_pagebreak($this->feedback);
894
        $labelitem = $feedbackgenerator->create_item_label($this->feedback);
895
        $numericitem2 = $feedbackgenerator->create_item_numeric($this->feedback);
896
 
897
        $pagedata = [
898
            ['name' => $numericitem->typ .'_'. $numericitem->id, 'value' => 5],
899
            ['name' => $textfielditem->typ .'_'. $textfielditem->id, 'value' => 'abc'],
900
        ];
901
        // Process the feedback, there are two pages so the feedback will be unfinished yet.
902
        $result = mod_feedback_external::process_page($this->feedback->id, 0, $pagedata);
903
        $result = external_api::clean_returnvalue(mod_feedback_external::process_page_returns(), $result);
904
        $this->assertFalse($result['completed']);
905
 
906
        // Retrieve the unfinished responses.
907
        $result = mod_feedback_external::get_unfinished_responses($this->feedback->id);
908
        $result = external_api::clean_returnvalue(mod_feedback_external::get_unfinished_responses_returns(), $result);
909
        // Check that ids and responses match.
910
        foreach ($result['responses'] as $r) {
911
            if ($r['item'] == $numericitem->id) {
912
                $this->assertEquals(5, $r['value']);
913
            } else {
914
                $this->assertEquals($textfielditem->id, $r['item']);
915
                $this->assertEquals('abc', $r['value']);
916
            }
917
        }
918
    }
919
 
920
    /**
921
     * Test get_finished_responses.
922
     */
11 efrain 923
    public function test_get_finished_responses(): void {
1 efrain 924
        // Test user with full capabilities.
925
        $this->setUser($this->student);
926
 
927
        // Create a very simple feedback.
928
        $feedbackgenerator = $this->getDataGenerator()->get_plugin_generator('mod_feedback');
929
        $numericitem = $feedbackgenerator->create_item_numeric($this->feedback);
930
        $textfielditem = $feedbackgenerator->create_item_textfield($this->feedback);
931
 
932
        $pagedata = [
933
            ['name' => $numericitem->typ .'_'. $numericitem->id, 'value' => 5],
934
            ['name' => $textfielditem->typ .'_'. $textfielditem->id, 'value' => 'abc'],
935
        ];
936
 
937
        // Process the feedback, there is only one page so the feedback will be completed.
938
        $result = mod_feedback_external::process_page($this->feedback->id, 0, $pagedata);
939
        $result = external_api::clean_returnvalue(mod_feedback_external::process_page_returns(), $result);
940
        $this->assertTrue($result['completed']);
941
 
942
        // Retrieve the responses.
943
        $result = mod_feedback_external::get_finished_responses($this->feedback->id);
944
        $result = external_api::clean_returnvalue(mod_feedback_external::get_finished_responses_returns(), $result);
945
        // Check that ids and responses match.
946
        foreach ($result['responses'] as $r) {
947
            if ($r['item'] == $numericitem->id) {
948
                $this->assertEquals(5, $r['value']);
949
            } else {
950
                $this->assertEquals($textfielditem->id, $r['item']);
951
                $this->assertEquals('abc', $r['value']);
952
            }
953
        }
954
    }
955
 
956
    /**
957
     * Test get_non_respondents (student trying to get this information).
958
     */
11 efrain 959
    public function test_get_non_respondents_no_permissions(): void {
1 efrain 960
        $this->setUser($this->student);
961
        $this->expectException(moodle_exception::class);
962
        mod_feedback_external::get_non_respondents($this->feedback->id);
963
    }
964
 
965
    /**
966
     * Test get_non_respondents from an anonymous feedback.
967
     */
11 efrain 968
    public function test_get_non_respondents_from_anonymous_feedback(): void {
1 efrain 969
        $this->setUser($this->student);
970
        $this->expectException(moodle_exception::class);
971
        $this->expectExceptionMessage(get_string('anonymous', 'feedback'));
972
        mod_feedback_external::get_non_respondents($this->feedback->id);
973
    }
974
 
975
    /**
976
     * Test get_non_respondents.
977
     */
11 efrain 978
    public function test_get_non_respondents(): void {
1 efrain 979
        global $DB;
980
 
981
        // Force non anonymous.
982
        $DB->set_field('feedback', 'anonymous', FEEDBACK_ANONYMOUS_NO, array('id' => $this->feedback->id));
983
 
984
        // Create another student.
985
        $anotherstudent = self::getDataGenerator()->create_user();
986
        $this->getDataGenerator()->enrol_user($anotherstudent->id, $this->course->id, $this->studentrole->id, 'manual');
987
        $this->setUser($anotherstudent);
988
 
989
        // Test user with full capabilities.
990
        $this->setUser($this->student);
991
 
992
        // Create a very simple feedback.
993
        $feedbackgenerator = $this->getDataGenerator()->get_plugin_generator('mod_feedback');
994
        $numericitem = $feedbackgenerator->create_item_numeric($this->feedback);
995
 
996
        $pagedata = [
997
            ['name' => $numericitem->typ .'_'. $numericitem->id, 'value' => 5],
998
        ];
999
 
1000
        // Process the feedback, there is only one page so the feedback will be completed.
1001
        $result = mod_feedback_external::process_page($this->feedback->id, 0, $pagedata);
1002
        $result = external_api::clean_returnvalue(mod_feedback_external::process_page_returns(), $result);
1003
        $this->assertTrue($result['completed']);
1004
 
1005
        // Retrieve the non-respondent users.
1006
        $this->setUser($this->teacher);
1007
        $result = mod_feedback_external::get_non_respondents($this->feedback->id);
1008
        $result = external_api::clean_returnvalue(mod_feedback_external::get_non_respondents_returns(), $result);
1009
        $this->assertCount(0, $result['warnings']);
1010
        $this->assertCount(1, $result['users']);
1011
        $this->assertEquals($anotherstudent->id, $result['users'][0]['userid']);
1012
 
1013
        // Create another student.
1014
        $anotherstudent2 = self::getDataGenerator()->create_user();
1015
        $this->getDataGenerator()->enrol_user($anotherstudent2->id, $this->course->id, $this->studentrole->id, 'manual');
1016
        $this->setUser($anotherstudent2);
1017
        $this->setUser($this->teacher);
1018
        $result = mod_feedback_external::get_non_respondents($this->feedback->id);
1019
        $result = external_api::clean_returnvalue(mod_feedback_external::get_non_respondents_returns(), $result);
1020
        $this->assertCount(0, $result['warnings']);
1021
        $this->assertCount(2, $result['users']);
1022
 
1023
        // Test pagination.
1024
        $result = mod_feedback_external::get_non_respondents($this->feedback->id, 0, 'lastaccess', 0, 1);
1025
        $result = external_api::clean_returnvalue(mod_feedback_external::get_non_respondents_returns(), $result);
1026
        $this->assertCount(0, $result['warnings']);
1027
        $this->assertCount(1, $result['users']);
1028
    }
1029
 
1030
    /**
1031
     * Helper function that completes the feedback for two students.
1032
     */
1033
    protected function complete_basic_feedback() {
1034
        global $DB;
1035
 
1036
        $generator = $this->getDataGenerator();
1037
        // Create separated groups.
1038
        $DB->set_field('course', 'groupmode', SEPARATEGROUPS);
1039
        $DB->set_field('course', 'groupmodeforce', 1);
1040
        assign_capability('moodle/site:accessallgroups', CAP_PROHIBIT, $this->teacherrole->id, $this->context);
1041
        accesslib_clear_all_caches_for_unit_testing();
1042
 
1043
        $group1 = $generator->create_group(array('courseid' => $this->course->id));
1044
        $group2 = $generator->create_group(array('courseid' => $this->course->id));
1045
 
1046
        // Create another students.
1047
        $anotherstudent1 = self::getDataGenerator()->create_user();
1048
        $anotherstudent2 = self::getDataGenerator()->create_user();
1049
        $generator->enrol_user($anotherstudent1->id, $this->course->id, $this->studentrole->id, 'manual');
1050
        $generator->enrol_user($anotherstudent2->id, $this->course->id, $this->studentrole->id, 'manual');
1051
 
1052
        $generator->create_group_member(array('groupid' => $group1->id, 'userid' => $this->student->id));
1053
        $generator->create_group_member(array('groupid' => $group1->id, 'userid' => $this->teacher->id));
1054
        $generator->create_group_member(array('groupid' => $group1->id, 'userid' => $anotherstudent1->id));
1055
        $generator->create_group_member(array('groupid' => $group2->id, 'userid' => $anotherstudent2->id));
1056
 
1057
        // Test user with full capabilities.
1058
        $this->setUser($this->student);
1059
 
1060
        // Create a very simple feedback.
1061
        $feedbackgenerator = $generator->get_plugin_generator('mod_feedback');
1062
        $numericitem = $feedbackgenerator->create_item_numeric($this->feedback);
1063
        $textfielditem = $feedbackgenerator->create_item_textfield($this->feedback);
1064
 
1065
        $pagedata = [
1066
            ['name' => $numericitem->typ .'_'. $numericitem->id, 'value' => 5],
1067
            ['name' => $textfielditem->typ .'_'. $textfielditem->id, 'value' => 'abc'],
1068
        ];
1069
 
1070
        // Process the feedback, there is only one page so the feedback will be completed.
1071
        $result = mod_feedback_external::process_page($this->feedback->id, 0, $pagedata);
1072
        $result = external_api::clean_returnvalue(mod_feedback_external::process_page_returns(), $result);
1073
        $this->assertTrue($result['completed']);
1074
 
1075
        $this->setUser($anotherstudent1);
1076
 
1077
        $pagedata = [
1078
            ['name' => $numericitem->typ .'_'. $numericitem->id, 'value' => 10],
1079
            ['name' => $textfielditem->typ .'_'. $textfielditem->id, 'value' => 'def'],
1080
        ];
1081
 
1082
        $result = mod_feedback_external::process_page($this->feedback->id, 0, $pagedata);
1083
        $result = external_api::clean_returnvalue(mod_feedback_external::process_page_returns(), $result);
1084
        $this->assertTrue($result['completed']);
1085
 
1086
        $this->setUser($anotherstudent2);
1087
 
1088
        $pagedata = [
1089
            ['name' => $numericitem->typ .'_'. $numericitem->id, 'value' => 10],
1090
            ['name' => $textfielditem->typ .'_'. $textfielditem->id, 'value' => 'def'],
1091
        ];
1092
 
1093
        $result = mod_feedback_external::process_page($this->feedback->id, 0, $pagedata);
1094
        $result = external_api::clean_returnvalue(mod_feedback_external::process_page_returns(), $result);
1095
        $this->assertTrue($result['completed']);
1096
    }
1097
 
1098
    /**
1099
     * Test get_responses_analysis for anonymous feedback.
1100
     */
11 efrain 1101
    public function test_get_responses_analysis_anonymous(): void {
1 efrain 1102
        self::complete_basic_feedback();
1103
 
1104
        // Retrieve the responses analysis.
1105
        $this->setUser($this->teacher);
1106
        $result = mod_feedback_external::get_responses_analysis($this->feedback->id);
1107
        $result = external_api::clean_returnvalue(mod_feedback_external::get_responses_analysis_returns(), $result);
1108
        $this->assertCount(0, $result['warnings']);
1109
        $this->assertEquals(0, $result['totalattempts']);
1110
        $this->assertEquals(2, $result['totalanonattempts']);   // Only see my groups.
1111
 
1112
        foreach ($result['attempts'] as $attempt) {
1113
            $this->assertEmpty($attempt['userid']); // Is anonymous.
1114
        }
1115
    }
1116
 
1117
    /**
1118
     * Test get_responses_analysis for non-anonymous feedback.
1119
     */
11 efrain 1120
    public function test_get_responses_analysis_non_anonymous(): void {
1 efrain 1121
        global $DB;
1122
 
1123
        // Force non anonymous.
1124
        $DB->set_field('feedback', 'anonymous', FEEDBACK_ANONYMOUS_NO, array('id' => $this->feedback->id));
1125
 
1126
        self::complete_basic_feedback();
1127
        // Retrieve the responses analysis.
1128
        $this->setUser($this->teacher);
1129
        $result = mod_feedback_external::get_responses_analysis($this->feedback->id);
1130
        $result = external_api::clean_returnvalue(mod_feedback_external::get_responses_analysis_returns(), $result);
1131
        $this->assertCount(0, $result['warnings']);
1132
        $this->assertEquals(2, $result['totalattempts']);
1133
        $this->assertEquals(0, $result['totalanonattempts']);   // Only see my groups.
1134
 
1135
        foreach ($result['attempts'] as $attempt) {
1136
            $this->assertNotEmpty($attempt['userid']);  // Is not anonymous.
1137
        }
1138
    }
1139
 
1140
    /**
1141
     * Test get_last_completed for feedback anonymous not completed.
1142
     */
11 efrain 1143
    public function test_get_last_completed_anonymous_not_completed(): void {
1 efrain 1144
        global $DB;
1145
 
1146
        // Force anonymous.
1147
        $DB->set_field('feedback', 'anonymous', FEEDBACK_ANONYMOUS_YES, array('id' => $this->feedback->id));
1148
 
1149
        // Test user with full capabilities that didn't complete the feedback.
1150
        $this->setUser($this->student);
1151
 
1152
        $this->expectExceptionMessage(get_string('anonymous', 'feedback'));
1153
        $this->expectException(moodle_exception::class);
1154
        mod_feedback_external::get_last_completed($this->feedback->id);
1155
    }
1156
 
1157
    /**
1158
     * Test get_last_completed for feedback anonymous and completed.
1159
     */
11 efrain 1160
    public function test_get_last_completed_anonymous_completed(): void {
1 efrain 1161
        global $DB;
1162
 
1163
        // Force anonymous.
1164
        $DB->set_field('feedback', 'anonymous', FEEDBACK_ANONYMOUS_YES, array('id' => $this->feedback->id));
1165
        // Add one completion record..
1166
        $record = [
1167
            'feedback' => $this->feedback->id,
1168
            'userid' => $this->student->id,
1169
            'timemodified' => time() - DAYSECS,
1170
            'random_response' => 0,
1171
            'anonymous_response' => FEEDBACK_ANONYMOUS_YES,
1172
            'courseid' => $this->course->id,
1173
        ];
1174
        $record['id'] = $DB->insert_record('feedback_completed', (object) $record);
1175
 
1176
        // Test user with full capabilities.
1177
        $this->setUser($this->student);
1178
 
1179
        $this->expectExceptionMessage(get_string('anonymous', 'feedback'));
1180
        $this->expectException(moodle_exception::class);
1181
        mod_feedback_external::get_last_completed($this->feedback->id);
1182
    }
1183
 
1184
    /**
1185
     * Test get_last_completed for feedback not anonymous and completed.
1186
     */
11 efrain 1187
    public function test_get_last_completed_not_anonymous_completed(): void {
1 efrain 1188
        global $DB;
1189
 
1190
        // Force non anonymous.
1191
        $DB->set_field('feedback', 'anonymous', FEEDBACK_ANONYMOUS_NO, array('id' => $this->feedback->id));
1192
        // Add one completion record..
1193
        $record = [
1194
            'feedback' => $this->feedback->id,
1195
            'userid' => $this->student->id,
1196
            'timemodified' => time() - DAYSECS,
1197
            'random_response' => 0,
1198
            'anonymous_response' => FEEDBACK_ANONYMOUS_NO,
1199
            'courseid' => $this->course->id,
1200
        ];
1201
        $record['id'] = $DB->insert_record('feedback_completed', (object) $record);
1202
 
1203
        // Test user with full capabilities.
1204
        $this->setUser($this->student);
1205
        $result = mod_feedback_external::get_last_completed($this->feedback->id);
1206
        $result = external_api::clean_returnvalue(mod_feedback_external::get_last_completed_returns(), $result);
1207
        $this->assertEquals($record, $result['completed']);
1208
    }
1209
 
1210
    /**
1211
     * Test get_last_completed for feedback not anonymous and not completed.
1212
     */
11 efrain 1213
    public function test_get_last_completed_not_anonymous_not_completed(): void {
1 efrain 1214
        global $DB;
1215
 
1216
        // Force anonymous.
1217
        $DB->set_field('feedback', 'anonymous', FEEDBACK_ANONYMOUS_NO, array('id' => $this->feedback->id));
1218
 
1219
        // Test user with full capabilities that didn't complete the feedback.
1220
        $this->setUser($this->student);
1221
 
1222
        $this->expectExceptionMessage(get_string('not_completed_yet', 'feedback'));
1223
        $this->expectException(moodle_exception::class);
1224
        mod_feedback_external::get_last_completed($this->feedback->id);
1225
    }
1226
 
1227
    /**
1228
     * Test get_feedback_access_information for site feedback.
1229
     */
11 efrain 1230
    public function test_get_feedback_access_information_for_site_feedback(): void {
1 efrain 1231
 
1232
        $sitefeedback = $this->getDataGenerator()->create_module('feedback', array('course' => SITEID));
1233
        $this->setUser($this->student);
1234
        // Access the site feedback via the site activity.
1235
        $result = mod_feedback_external::get_feedback_access_information($sitefeedback->id);
1236
        $result = external_api::clean_returnvalue(mod_feedback_external::get_feedback_access_information_returns(), $result);
1237
        $this->assertTrue($result['cancomplete']);
1238
        $this->assertTrue($result['cansubmit']);
1239
 
1240
        // Access the site feedback via course where I'm enrolled.
1241
        $result = mod_feedback_external::get_feedback_access_information($sitefeedback->id, $this->course->id);
1242
        $result = external_api::clean_returnvalue(mod_feedback_external::get_feedback_access_information_returns(), $result);
1243
        $this->assertTrue($result['cancomplete']);
1244
        $this->assertTrue($result['cansubmit']);
1245
 
1246
        // Access the site feedback via course where I'm not enrolled.
1247
        $othercourse = $this->getDataGenerator()->create_course();
1248
 
1249
        $this->expectException(moodle_exception::class);
1250
        mod_feedback_external::get_feedback_access_information($sitefeedback->id, $othercourse->id);
1251
    }
1252
 
1253
    /**
1254
     * Test get_feedback_access_information for site feedback mapped.
1255
     */
11 efrain 1256
    public function test_get_feedback_access_information_for_site_feedback_mapped(): void {
1 efrain 1257
        global $DB;
1258
 
1259
        $sitefeedback = $this->getDataGenerator()->create_module('feedback', array('course' => SITEID));
1260
        $this->setUser($this->student);
1261
        $DB->insert_record('feedback_sitecourse_map', array('feedbackid' => $sitefeedback->id, 'courseid' => $this->course->id));
1262
 
1263
        // Access the site feedback via course where I'm enrolled and mapped.
1264
        $result = mod_feedback_external::get_feedback_access_information($sitefeedback->id, $this->course->id);
1265
        $result = external_api::clean_returnvalue(mod_feedback_external::get_feedback_access_information_returns(), $result);
1266
        $this->assertTrue($result['cancomplete']);
1267
        $this->assertTrue($result['cansubmit']);
1268
 
1269
        // Access the site feedback via course where I'm enrolled but not mapped.
1270
        $othercourse = $this->getDataGenerator()->create_course();
1271
        $this->getDataGenerator()->enrol_user($this->student->id, $othercourse->id, $this->studentrole->id, 'manual');
1272
 
1273
        $this->expectException(moodle_exception::class);
1274
        $this->expectExceptionMessage(get_string('cannotaccess', 'mod_feedback'));
1275
        mod_feedback_external::get_feedback_access_information($sitefeedback->id, $othercourse->id);
1276
    }
1277
}