MDL-58462 mod_data: Generate users with different names
[moodle.git] / mod / data / tests / externallib_test.php
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/>.
17 /**
18  * Database module external functions tests
19  *
20  * @package    mod_data
21  * @category   external
22  * @copyright  2015 Juan Leyva <juan@moodle.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  * @since      Moodle 2.9
25  */
27 defined('MOODLE_INTERNAL') || die();
29 global $CFG;
31 require_once($CFG->dirroot . '/webservice/tests/helpers.php');
33 /**
34  * Database module external functions tests
35  *
36  * @package    mod_data
37  * @category   external
38  * @copyright  2015 Juan Leyva <juan@moodle.com>
39  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  * @since      Moodle 2.9
41  */
42 class mod_data_external_testcase extends externallib_advanced_testcase {
44     /** @var stdClass Test module context. */
45     protected $context;
47     /** @var stdClass Test course.*/
48     protected $course;
50     /** @var stdClass Test course module. */
51     protected $cm;
53     /** @var  stdClass Test database activity. */
54     protected $database;
56     /** @var stdClass Test group 1. */
57     protected $group1;
59     /** @var stdClass Test group 2. */
60     protected $group2;
62     /** @var stdClass Test student 1. */
63     protected $student1;
65     /** @var stdClass Test student 2. */
66     protected $student2;
68     /** @var stdClass Test student 3. */
69     protected $student3;
71     /** @var stdClass Test student 4. */
72     protected $student4;
74     /** @var stdClass Student role. */
75     protected $studentrole;
77     /** @var stdClass Test teacher. */
78     protected $teacher;
80     /** @var stdClass Teacher role. */
81     protected $teacherrole;
83     /**
84      * Set up for every test
85      */
86     public function setUp() {
87         global $DB;
88         $this->resetAfterTest();
89         $this->setAdminUser();
91         // Setup test data.
92         $course = new stdClass();
93         $course->groupmode = SEPARATEGROUPS;
94         $course->groupmodeforce = true;
95         $this->course = $this->getDataGenerator()->create_course($course);
96         $this->database = $this->getDataGenerator()->create_module('data', array('course' => $this->course->id));
97         $this->context = context_module::instance($this->database->cmid);
98         $this->cm = get_coursemodule_from_instance('data', $this->database->id);
100         // Create users.
101         $this->student1 = self::getDataGenerator()->create_user(['firstname' => 'Olivia', 'lastname' => 'Smith']);
102         $this->student2 = self::getDataGenerator()->create_user(['firstname' => 'Ezra', 'lastname' => 'Johnson']);
103         $this->student3 = self::getDataGenerator()->create_user(['firstname' => 'Amelia', 'lastname' => 'Williams']);
104         $this->teacher = self::getDataGenerator()->create_user(['firstname' => 'Asher', 'lastname' => 'Jones']);
106         // Users enrolments.
107         $this->studentrole = $DB->get_record('role', array('shortname' => 'student'));
108         $this->teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));
109         $this->getDataGenerator()->enrol_user($this->student1->id, $this->course->id, $this->studentrole->id, 'manual');
110         $this->getDataGenerator()->enrol_user($this->student2->id, $this->course->id, $this->studentrole->id, 'manual');
111         $this->getDataGenerator()->enrol_user($this->student3->id, $this->course->id, $this->studentrole->id, 'manual');
112         $this->getDataGenerator()->enrol_user($this->teacher->id, $this->course->id, $this->teacherrole->id, 'manual');
114         $this->group1 = $this->getDataGenerator()->create_group(array('courseid' => $this->course->id));
115         $this->group2 = $this->getDataGenerator()->create_group(array('courseid' => $this->course->id));
116         groups_add_member($this->group1, $this->student1);
117         groups_add_member($this->group1, $this->student2);
118         groups_add_member($this->group2, $this->student3);
119     }
121     /**
122      * Test get databases by courses
123      */
124     public function test_mod_data_get_databases_by_courses() {
125         global $DB;
127         $this->resetAfterTest(true);
129         // Create users.
130         $student = self::getDataGenerator()->create_user();
131         $teacher = self::getDataGenerator()->create_user();
133         // Set to the student user.
134         self::setUser($student);
136         // Create courses to add the modules.
137         $course1 = self::getDataGenerator()->create_course();
138         $course2 = self::getDataGenerator()->create_course();
140         // First database.
141         $record = new stdClass();
142         $record->introformat = FORMAT_HTML;
143         $record->course = $course1->id;
144         $database1 = self::getDataGenerator()->create_module('data', $record);
146         // Second database.
147         $record = new stdClass();
148         $record->introformat = FORMAT_HTML;
149         $record->course = $course2->id;
150         $database2 = self::getDataGenerator()->create_module('data', $record);
152         $studentrole = $DB->get_record('role', array('shortname' => 'student'));
153         $teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));
155         // Users enrolments.
156         $this->getDataGenerator()->enrol_user($student->id, $course1->id, $studentrole->id, 'manual');
157         $this->getDataGenerator()->enrol_user($teacher->id, $course1->id, $teacherrole->id, 'manual');
159         // Execute real Moodle enrolment as we'll call unenrol() method on the instance later.
160         $enrol = enrol_get_plugin('manual');
161         $enrolinstances = enrol_get_instances($course2->id, true);
162         foreach ($enrolinstances as $courseenrolinstance) {
163             if ($courseenrolinstance->enrol == "manual") {
164                 $instance2 = $courseenrolinstance;
165                 break;
166             }
167         }
168         $enrol->enrol_user($instance2, $student->id, $studentrole->id);
170         // Create what we expect to be returned when querying the two courses.
171         // First for the student user.
172         $expectedfields = array('id', 'coursemodule', 'course', 'name', 'comments', 'timeavailablefrom',
173                             'timeavailableto', 'timeviewfrom', 'timeviewto', 'requiredentries', 'requiredentriestoview',
174                             'intro', 'introformat', 'introfiles', 'maxentries', 'rssarticles', 'singletemplate', 'listtemplate',
175                             'listtemplateheader', 'listtemplatefooter', 'addtemplate', 'rsstemplate', 'rsstitletemplate',
176                             'csstemplate', 'jstemplate', 'asearchtemplate', 'approval', 'defaultsort', 'defaultsortdir', 'manageapproved');
178         // Add expected coursemodule.
179         $database1->coursemodule = $database1->cmid;
180         $database1->introfiles = [];
181         $database2->coursemodule = $database2->cmid;
182         $database2->introfiles = [];
184         $expected1 = array();
185         $expected2 = array();
186         foreach ($expectedfields as $field) {
187             if ($field == 'approval' or $field == 'manageapproved') {
188                 $database1->{$field} = (bool) $database1->{$field};
189                 $database2->{$field} = (bool) $database2->{$field};
190             }
191             $expected1[$field] = $database1->{$field};
192             $expected2[$field] = $database2->{$field};
193         }
194         $expected1['comments'] = (bool) $expected1['comments'];
195         $expected2['comments'] = (bool) $expected2['comments'];
197         $expecteddatabases = array();
198         $expecteddatabases[] = $expected2;
199         $expecteddatabases[] = $expected1;
201         // Call the external function passing course ids.
202         $result = mod_data_external::get_databases_by_courses(array($course2->id, $course1->id));
203         $result = external_api::clean_returnvalue(mod_data_external::get_databases_by_courses_returns(), $result);
204         $this->assertEquals($expecteddatabases, $result['databases']);
206         // Call the external function without passing course id.
207         $result = mod_data_external::get_databases_by_courses();
208         $result = external_api::clean_returnvalue(mod_data_external::get_databases_by_courses_returns(), $result);
209         $this->assertEquals($expecteddatabases, $result['databases']);
211         // Unenrol user from second course and alter expected databases.
212         $enrol->unenrol_user($instance2, $student->id);
213         array_shift($expecteddatabases);
215         // Call the external function without passing course id.
216         $result = mod_data_external::get_databases_by_courses();
217         $result = external_api::clean_returnvalue(mod_data_external::get_databases_by_courses_returns(), $result);
218         $this->assertEquals($expecteddatabases, $result['databases']);
220         // Call for the second course we unenrolled the user from, expected warning.
221         $result = mod_data_external::get_databases_by_courses(array($course2->id));
222         $this->assertCount(1, $result['warnings']);
223         $this->assertEquals('1', $result['warnings'][0]['warningcode']);
224         $this->assertEquals($course2->id, $result['warnings'][0]['itemid']);
226         // Now, try as a teacher for getting all the additional fields.
227         self::setUser($teacher);
229         $additionalfields = array('scale', 'assessed', 'assesstimestart', 'assesstimefinish', 'editany', 'notification', 'timemodified');
231         foreach ($additionalfields as $field) {
232             if ($field == 'editany') {
233                 $database1->{$field} = (bool) $database1->{$field};
234             }
235             $expecteddatabases[0][$field] = $database1->{$field};
236         }
237         $result = mod_data_external::get_databases_by_courses();
238         $result = external_api::clean_returnvalue(mod_data_external::get_databases_by_courses_returns(), $result);
239         $this->assertEquals($expecteddatabases, $result['databases']);
241         // Admin should get all the information.
242         self::setAdminUser();
244         $result = mod_data_external::get_databases_by_courses(array($course1->id));
245         $result = external_api::clean_returnvalue(mod_data_external::get_databases_by_courses_returns(), $result);
246         $this->assertEquals($expecteddatabases, $result['databases']);
247     }
249     /**
250      * Test view_database invalid id.
251      */
252     public function test_view_database_invalid_id() {
254         // Test invalid instance id.
255         $this->expectException('moodle_exception');
256         mod_data_external::view_database(0);
257     }
259     /**
260      * Test view_database not enrolled user.
261      */
262     public function test_view_database_not_enrolled_user() {
264         $usernotenrolled = self::getDataGenerator()->create_user();
265         $this->setUser($usernotenrolled);
267         $this->expectException('moodle_exception');
268         mod_data_external::view_database(0);
269     }
271     /**
272      * Test view_database no capabilities.
273      */
274     public function test_view_database_no_capabilities() {
275         // Test user with no capabilities.
276         // We need a explicit prohibit since this capability is allowed for students by default.
277         assign_capability('mod/data:viewpage', CAP_PROHIBIT, $this->studentrole->id, $this->context->id);
278         accesslib_clear_all_caches_for_unit_testing();
280         $this->expectException('moodle_exception');
281         mod_data_external::view_database(0);
282     }
284     /**
285      * Test view_database.
286      */
287     public function test_view_database() {
289         // Test user with full capabilities.
290         $this->setUser($this->student1);
292         // Trigger and capture the event.
293         $sink = $this->redirectEvents();
295         $result = mod_data_external::view_database($this->database->id);
296         $result = external_api::clean_returnvalue(mod_data_external::view_database_returns(), $result);
298         $events = $sink->get_events();
299         $this->assertCount(1, $events);
300         $event = array_shift($events);
302         // Checking that the event contains the expected values.
303         $this->assertInstanceOf('\mod_data\event\course_module_viewed', $event);
304         $this->assertEquals($this->context, $event->get_context());
305         $moodledata = new \moodle_url('/mod/data/view.php', array('id' => $this->cm->id));
306         $this->assertEquals($moodledata, $event->get_url());
307         $this->assertEventContextNotUsed($event);
308         $this->assertNotEmpty($event->get_name());
309     }
311     /**
312      * Test get_data_access_information for student.
313      */
314     public function test_get_data_access_information_student() {
315         global $DB;
316         // Modify the database to add access restrictions.
317         $this->database->timeavailablefrom = time() + DAYSECS;
318         $this->database->requiredentries = 2;
319         $this->database->requiredentriestoview = 2;
320         $DB->update_record('data', $this->database);
322         // Test user with full capabilities.
323         $this->setUser($this->student1);
325         $result = mod_data_external::get_data_access_information($this->database->id);
326         $result = external_api::clean_returnvalue(mod_data_external::get_data_access_information_returns(), $result);
328         $this->assertEquals($this->group1->id, $result['groupid']);
330         $this->assertFalse($result['canmanageentries']);
331         $this->assertFalse($result['canapprove']);
332         $this->assertTrue($result['canaddentry']);  // It return true because it doen't check time restrictions.
333         $this->assertFalse($result['timeavailable']);
334         $this->assertFalse($result['inreadonlyperiod']);
335         $this->assertEquals(0, $result['numentries']);
336         $this->assertEquals($this->database->requiredentries, $result['entrieslefttoadd']);
337         $this->assertEquals($this->database->requiredentriestoview, $result['entrieslefttoview']);
338     }
340     /**
341      * Test get_data_access_information for teacher.
342      */
343     public function test_get_data_access_information_teacher() {
344         global $DB;
345         // Modify the database to add access restrictions.
346         $this->database->timeavailablefrom = time() + DAYSECS;
347         $this->database->requiredentries = 2;
348         $this->database->requiredentriestoview = 2;
349         $DB->update_record('data', $this->database);
351         // Test user with full capabilities.
352         $this->setUser($this->teacher);
354         $result = mod_data_external::get_data_access_information($this->database->id);
355         $result = external_api::clean_returnvalue(mod_data_external::get_data_access_information_returns(), $result);
357         $this->assertEquals(0, $result['groupid']);
359         $this->assertTrue($result['canmanageentries']);
360         $this->assertTrue($result['canapprove']);
361         $this->assertTrue($result['canaddentry']);  // It return true because it doen't check time restrictions.
362         $this->assertTrue($result['timeavailable']);
363         $this->assertFalse($result['inreadonlyperiod']);
364         $this->assertEquals(0, $result['numentries']);
365         $this->assertEquals(0, $result['entrieslefttoadd']);
366         $this->assertEquals(0, $result['entrieslefttoview']);
367     }
369     /**
370      * Helper method to populate the database with some entries.
371      *
372      * @return array the entry ids created
373      */
374     public function populate_database_with_entries() {
375         global $DB;
377         // Force approval.
378         $DB->set_field('data', 'approval', 1, array('id' => $this->database->id));
379         $generator = $this->getDataGenerator()->get_plugin_generator('mod_data');
380         $fieldtypes = array('checkbox', 'date', 'menu', 'multimenu', 'number', 'radiobutton', 'text', 'textarea', 'url');
382         $count = 1;
383         // Creating test Fields with default parameter values.
384         foreach ($fieldtypes as $fieldtype) {
385             $fieldname = 'field-' . $count;
386             $record = new StdClass();
387             $record->name = $fieldname;
388             $record->type = $fieldtype;
389             $record->required = 1;
391             $generator->create_field($record, $this->database);
392             $count++;
393         }
394         // Get all the fields created.
395         $fields = $DB->get_records('data_fields', array('dataid' => $this->database->id), 'id');
397         // Populate with contents, creating a new entry.
398         $contents = array();
399         $contents[] = array('opt1', 'opt2', 'opt3', 'opt4');
400         $contents[] = '01-01-2037'; // It should be lower than 2038, to avoid failing on 32-bit windows.
401         $contents[] = 'menu1';
402         $contents[] = array('multimenu1', 'multimenu2', 'multimenu3', 'multimenu4');
403         $contents[] = '12345';
404         $contents[] = 'radioopt1';
405         $contents[] = 'text for testing';
406         $contents[] = '<p>text area testing<br /></p>';
407         $contents[] = array('example.url', 'sampleurl');
408         $count = 0;
409         $fieldcontents = array();
410         foreach ($fields as $fieldrecord) {
411             $fieldcontents[$fieldrecord->id] = $contents[$count++];
412         }
414         $this->setUser($this->student1);
415         $entry11 = $generator->create_entry($this->database, $fieldcontents, $this->group1->id);
416         $this->setUser($this->student2);
417         $entry12 = $generator->create_entry($this->database, $fieldcontents, $this->group1->id);
418         $entry13 = $generator->create_entry($this->database, $fieldcontents, $this->group1->id);
420         $this->setUser($this->student3);
421         $entry21 = $generator->create_entry($this->database, $fieldcontents, $this->group2->id);
423         // Approve all except $entry13.
424         $DB->set_field('data_records', 'approved', 1, ['id' => $entry11]);
425         $DB->set_field('data_records', 'approved', 1, ['id' => $entry12]);
426         $DB->set_field('data_records', 'approved', 1, ['id' => $entry21]);
428         return [$entry11, $entry12, $entry13, $entry21];
429     }
431     /**
432      * Test get_entries
433      */
434     public function test_get_entries() {
435         global $DB;
436         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
438         // First of all, expect to see only my group entries (not other users in other groups ones).
439         $this->setUser($this->student1);
440         $result = mod_data_external::get_entries($this->database->id);
441         $result = external_api::clean_returnvalue(mod_data_external::get_entries_returns(), $result);
442         $this->assertCount(0, $result['warnings']);
443         $this->assertCount(2, $result['entries']);
444         $this->assertEquals(2, $result['totalcount']);
445         $this->assertEquals($entry11, $result['entries'][0]['id']);
446         $this->assertEquals($this->student1->id, $result['entries'][0]['userid']);
447         $this->assertEquals($this->group1->id, $result['entries'][0]['groupid']);
448         $this->assertEquals($this->database->id, $result['entries'][0]['dataid']);
449         $this->assertEquals($entry12, $result['entries'][1]['id']);
450         $this->assertEquals($this->student2->id, $result['entries'][1]['userid']);
451         $this->assertEquals($this->group1->id, $result['entries'][1]['groupid']);
452         $this->assertEquals($this->database->id, $result['entries'][1]['dataid']);
453         // Other user in same group.
454         $this->setUser($this->student2);
455         $result = mod_data_external::get_entries($this->database->id);
456         $result = external_api::clean_returnvalue(mod_data_external::get_entries_returns(), $result);
457         $this->assertCount(0, $result['warnings']);
458         $this->assertCount(3, $result['entries']);  // I can see my entry not approved yet.
459         $this->assertEquals(3, $result['totalcount']);
461         // Now try with the user in the second group that must see only one entry.
462         $this->setUser($this->student3);
463         $result = mod_data_external::get_entries($this->database->id);
464         $result = external_api::clean_returnvalue(mod_data_external::get_entries_returns(), $result);
465         $this->assertCount(0, $result['warnings']);
466         $this->assertCount(1, $result['entries']);
467         $this->assertEquals(1, $result['totalcount']);
468         $this->assertEquals($entry21, $result['entries'][0]['id']);
469         $this->assertEquals($this->student3->id, $result['entries'][0]['userid']);
470         $this->assertEquals($this->group2->id, $result['entries'][0]['groupid']);
471         $this->assertEquals($this->database->id, $result['entries'][0]['dataid']);
473         // Now, as teacher we should see all (we have permissions to view all groups).
474         $this->setUser($this->teacher);
475         $result = mod_data_external::get_entries($this->database->id);
476         $result = external_api::clean_returnvalue(mod_data_external::get_entries_returns(), $result);
477         $this->assertCount(0, $result['warnings']);
478         $this->assertCount(4, $result['entries']);  // I can see the not approved one.
479         $this->assertEquals(4, $result['totalcount']);
481         $entries = $DB->get_records('data_records', array('dataid' => $this->database->id), 'id');
482         $this->assertCount(4, $entries);
483         $count = 0;
484         foreach ($entries as $entry) {
485             $this->assertEquals($entry->id, $result['entries'][$count]['id']);
486             $count++;
487         }
489         // Basic test passing the parameter (instead having to calculate it).
490         $this->setUser($this->student1);
491         $result = mod_data_external::get_entries($this->database->id, $this->group1->id);
492         $result = external_api::clean_returnvalue(mod_data_external::get_entries_returns(), $result);
493         $this->assertCount(0, $result['warnings']);
494         $this->assertCount(2, $result['entries']);
495         $this->assertEquals(2, $result['totalcount']);
497         // Test ordering (reverse).
498         $this->setUser($this->student1);
499         $result = mod_data_external::get_entries($this->database->id, $this->group1->id, false, null, 'DESC');
500         $result = external_api::clean_returnvalue(mod_data_external::get_entries_returns(), $result);
501         $this->assertCount(0, $result['warnings']);
502         $this->assertCount(2, $result['entries']);
503         $this->assertEquals(2, $result['totalcount']);
504         $this->assertEquals($entry12, $result['entries'][0]['id']);
506         // Test pagination.
507         $this->setUser($this->student1);
508         $result = mod_data_external::get_entries($this->database->id, $this->group1->id, false, null, null, 0, 1);
509         $result = external_api::clean_returnvalue(mod_data_external::get_entries_returns(), $result);
510         $this->assertCount(0, $result['warnings']);
511         $this->assertCount(1, $result['entries']);
512         $this->assertEquals(2, $result['totalcount']);
513         $this->assertEquals($entry11, $result['entries'][0]['id']);
515         $result = mod_data_external::get_entries($this->database->id, $this->group1->id, false, null, null, 1, 1);
516         $result = external_api::clean_returnvalue(mod_data_external::get_entries_returns(), $result);
517         $this->assertCount(0, $result['warnings']);
518         $this->assertCount(1, $result['entries']);
519         $this->assertEquals(2, $result['totalcount']);
520         $this->assertEquals($entry12, $result['entries'][0]['id']);
522         // Now test the return contents.
523         data_generate_default_template($this->database, 'listtemplate', 0, false, true); // Generate a default list template.
524         $result = mod_data_external::get_entries($this->database->id, $this->group1->id, true, null, null, 0, 2);
525         $result = external_api::clean_returnvalue(mod_data_external::get_entries_returns(), $result);
526         $this->assertCount(0, $result['warnings']);
527         $this->assertCount(2, $result['entries']);
528         $this->assertEquals(2, $result['totalcount']);
529         $this->assertCount(9, $result['entries'][0]['contents']);
530         $this->assertCount(9, $result['entries'][1]['contents']);
531         // Search for some content.
532         $this->assertTrue(strpos($result['listviewcontents'], 'opt1') !== false);
533         $this->assertTrue(strpos($result['listviewcontents'], 'January') !== false);
534         $this->assertTrue(strpos($result['listviewcontents'], 'menu1') !== false);
535         $this->assertTrue(strpos($result['listviewcontents'], 'text for testing') !== false);
536         $this->assertTrue(strpos($result['listviewcontents'], 'sampleurl') !== false);
537     }
539     /**
540      * Test get_entry_visible_groups.
541      */
542     public function test_get_entry_visible_groups() {
543         global $DB;
545         $DB->set_field('course', 'groupmode', VISIBLEGROUPS, ['id' => $this->course->id]);
546         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
548         // Check I can see my approved group entries.
549         $this->setUser($this->student1);
550         $result = mod_data_external::get_entry($entry11);
551         $result = external_api::clean_returnvalue(mod_data_external::get_entry_returns(), $result);
552         $this->assertCount(0, $result['warnings']);
553         $this->assertEquals($entry11, $result['entry']['id']);
554         $this->assertTrue($result['entry']['approved']);
555         $this->assertTrue($result['entry']['canmanageentry']); // Is mine, I can manage it.
557         // Entry from other group.
558         $result = mod_data_external::get_entry($entry21);
559         $result = external_api::clean_returnvalue(mod_data_external::get_entry_returns(), $result);
560         $this->assertCount(0, $result['warnings']);
561         $this->assertEquals($entry21, $result['entry']['id']);
562     }
564     /**
565      * Test get_entry_separated_groups.
566      */
567     public function test_get_entry_separated_groups() {
568         global $DB;
569         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
571         // Check I can see my approved group entries.
572         $this->setUser($this->student1);
573         $result = mod_data_external::get_entry($entry11);
574         $result = external_api::clean_returnvalue(mod_data_external::get_entry_returns(), $result);
575         $this->assertCount(0, $result['warnings']);
576         $this->assertEquals($entry11, $result['entry']['id']);
577         $this->assertTrue($result['entry']['approved']);
578         $this->assertTrue($result['entry']['canmanageentry']); // Is mine, I can manage it.
580         // Retrieve contents.
581         data_generate_default_template($this->database, 'singletemplate', 0, false, true);
582         $result = mod_data_external::get_entry($entry11, true);
583         $result = external_api::clean_returnvalue(mod_data_external::get_entry_returns(), $result);
584         $this->assertCount(0, $result['warnings']);
585         $this->assertCount(9, $result['entry']['contents']);
586         $this->assertTrue(strpos($result['entryviewcontents'], 'opt1') !== false);
587         $this->assertTrue(strpos($result['entryviewcontents'], 'January') !== false);
588         $this->assertTrue(strpos($result['entryviewcontents'], 'menu1') !== false);
589         $this->assertTrue(strpos($result['entryviewcontents'], 'text for testing') !== false);
590         $this->assertTrue(strpos($result['entryviewcontents'], 'sampleurl') !== false);
592         // This is in my group but I'm not the author.
593         $result = mod_data_external::get_entry($entry12);
594         $result = external_api::clean_returnvalue(mod_data_external::get_entry_returns(), $result);
595         $this->assertCount(0, $result['warnings']);
596         $this->assertEquals($entry12, $result['entry']['id']);
597         $this->assertTrue($result['entry']['approved']);
598         $this->assertFalse($result['entry']['canmanageentry']); // Not mine.
600         $this->setUser($this->student3);
601         $result = mod_data_external::get_entry($entry21);
602         $result = external_api::clean_returnvalue(mod_data_external::get_entry_returns(), $result);
603         $this->assertCount(0, $result['warnings']);
604         $this->assertEquals($entry21, $result['entry']['id']);
605         $this->assertTrue($result['entry']['approved']);
606         $this->assertTrue($result['entry']['canmanageentry']); // Is mine, I can manage it.
608         // As teacher I should be able to see all the entries.
609         $this->setUser($this->teacher);
610         $result = mod_data_external::get_entry($entry11);
611         $result = external_api::clean_returnvalue(mod_data_external::get_entry_returns(), $result);
612         $this->assertEquals($entry11, $result['entry']['id']);
614         $result = mod_data_external::get_entry($entry12);
615         $result = external_api::clean_returnvalue(mod_data_external::get_entry_returns(), $result);
616         $this->assertEquals($entry12, $result['entry']['id']);
617         // This is the not approved one.
618         $result = mod_data_external::get_entry($entry13);
619         $result = external_api::clean_returnvalue(mod_data_external::get_entry_returns(), $result);
620         $this->assertEquals($entry13, $result['entry']['id']);
622         $result = mod_data_external::get_entry($entry21);
623         $result = external_api::clean_returnvalue(mod_data_external::get_entry_returns(), $result);
624         $this->assertEquals($entry21, $result['entry']['id']);
626         // Now, try to get an entry not approved yet.
627         $this->setUser($this->student1);
628         $this->expectException('moodle_exception');
629         $result = mod_data_external::get_entry($entry13);
630     }
632     /**
633      * Test get_entry from other group in separated groups.
634      */
635     public function test_get_entry_other_group_separated_groups() {
636         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
638         // We should not be able to view other gropu entries (in separated groups).
639         $this->setUser($this->student1);
640         $this->expectException('moodle_exception');
641         $result = mod_data_external::get_entry($entry21);
642     }
644     /**
645      * Test get_fields.
646      */
647     public function test_get_fields() {
648         global $DB;
649         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
651         $this->setUser($this->student1);
652         $result = mod_data_external::get_fields($this->database->id);
653         $result = external_api::clean_returnvalue(mod_data_external::get_fields_returns(), $result);
655         // Basically compare we retrieve all the fields and the correct values.
656         $fields = $DB->get_records('data_fields', array('dataid' => $this->database->id), 'id');
657         foreach ($result['fields'] as $field) {
658             $this->assertEquals($field, (array) $fields[$field['id']]);
659         }
660     }
662     /**
663      * Test search_entries.
664      */
665     public function test_search_entries() {
666         global $DB;
667         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
669         // First do a normal text search as student 1. I should see my two group entries.
670         $this->setUser($this->student1);
671         $result = mod_data_external::search_entries($this->database->id, 0, false, 'text');
672         $result = external_api::clean_returnvalue(mod_data_external::search_entries_returns(), $result);
673         $this->assertCount(2, $result['entries']);
674         $this->assertEquals(2, $result['totalcount']);
676         // Now as the other student I should receive my not approved entry. Apply ordering here.
677         $this->setUser($this->student2);
678         $result = mod_data_external::search_entries($this->database->id, 0, false, 'text', [], DATA_APPROVED, 'ASC');
679         $result = external_api::clean_returnvalue(mod_data_external::search_entries_returns(), $result);
680         $this->assertCount(3, $result['entries']);
681         $this->assertEquals(3, $result['totalcount']);
682         // The not approved one should be the first.
683         $this->assertEquals($entry13, $result['entries'][0]['id']);
685         // Now as the other group student.
686         $this->setUser($this->student3);
687         $result = mod_data_external::search_entries($this->database->id, 0, false, 'text');
688         $result = external_api::clean_returnvalue(mod_data_external::search_entries_returns(), $result);
689         $this->assertCount(1, $result['entries']);
690         $this->assertEquals(1, $result['totalcount']);
691         $this->assertEquals($this->student3->id, $result['entries'][0]['userid']);
693         // Same normal text search as teacher.
694         $this->setUser($this->teacher);
695         $result = mod_data_external::search_entries($this->database->id, 0, false, 'text');
696         $result = external_api::clean_returnvalue(mod_data_external::search_entries_returns(), $result);
697         $this->assertCount(4, $result['entries']);  // I can see all groups and non approved.
698         $this->assertEquals(4, $result['totalcount']);
700         // Pagination.
701         $this->setUser($this->teacher);
702         $result = mod_data_external::search_entries($this->database->id, 0, false, 'text', [], DATA_TIMEADDED, 'ASC', 0, 2);
703         $result = external_api::clean_returnvalue(mod_data_external::search_entries_returns(), $result);
704         $this->assertCount(2, $result['entries']);  // Only 2 per page.
705         $this->assertEquals(4, $result['totalcount']);
707         // Now advanced search or not dinamic fields (user firstname for example).
708         $this->setUser($this->student1);
709         $advsearch = [
710             ['name' => 'fn', 'value' => json_encode($this->student2->firstname)]
711         ];
712         $result = mod_data_external::search_entries($this->database->id, 0, false, '', $advsearch);
713         $result = external_api::clean_returnvalue(mod_data_external::search_entries_returns(), $result);
714         $this->assertCount(1, $result['entries']);
715         $this->assertEquals(1, $result['totalcount']);
716         $this->assertEquals($this->student2->id, $result['entries'][0]['userid']);  // I only found mine!
718         // Advanced search for fields.
719         $field = $DB->get_record('data_fields', array('type' => 'url'));
720         $advsearch = [
721             ['name' => 'f_' . $field->id , 'value' => 'sampleurl']
722         ];
723         $result = mod_data_external::search_entries($this->database->id, 0, false, '', $advsearch);
724         $result = external_api::clean_returnvalue(mod_data_external::search_entries_returns(), $result);
725         $this->assertCount(2, $result['entries']);  // Found two entries matching this.
726         $this->assertEquals(2, $result['totalcount']);
728         // Combined search.
729         $field2 = $DB->get_record('data_fields', array('type' => 'number'));
730         $advsearch = [
731             ['name' => 'f_' . $field->id , 'value' => 'sampleurl'],
732             ['name' => 'f_' . $field2->id , 'value' => '12345'],
733             ['name' => 'ln', 'value' => json_encode($this->student2->lastname)]
734         ];
735         $result = mod_data_external::search_entries($this->database->id, 0, false, '', $advsearch);
736         $result = external_api::clean_returnvalue(mod_data_external::search_entries_returns(), $result);
737         $this->assertCount(1, $result['entries']);  // Only one matching everything.
738         $this->assertEquals(1, $result['totalcount']);
740         // Combined search (no results).
741         $field2 = $DB->get_record('data_fields', array('type' => 'number'));
742         $advsearch = [
743             ['name' => 'f_' . $field->id , 'value' => 'sampleurl'],
744             ['name' => 'f_' . $field2->id , 'value' => '98780333'], // Non existent number.
745         ];
746         $result = mod_data_external::search_entries($this->database->id, 0, false, '', $advsearch);
747         $result = external_api::clean_returnvalue(mod_data_external::search_entries_returns(), $result);
748         $this->assertCount(0, $result['entries']);  // Only one matching everything.
749         $this->assertEquals(0, $result['totalcount']);
750     }
752     /**
753      * Test approve_entry.
754      */
755     public function test_approve_entry() {
756         global $DB;
757         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
759         $this->setUser($this->teacher);
760         $this->assertEquals(0, $DB->get_field('data_records', 'approved', array('id' => $entry13)));
761         $result = mod_data_external::approve_entry($entry13);
762         $result = external_api::clean_returnvalue(mod_data_external::approve_entry_returns(), $result);
763         $this->assertEquals(1, $DB->get_field('data_records', 'approved', array('id' => $entry13)));
764     }
766     /**
767      * Test unapprove_entry.
768      */
769     public function test_unapprove_entry() {
770         global $DB;
771         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
773         $this->setUser($this->teacher);
774         $this->assertEquals(1, $DB->get_field('data_records', 'approved', array('id' => $entry11)));
775         $result = mod_data_external::approve_entry($entry11, false);
776         $result = external_api::clean_returnvalue(mod_data_external::approve_entry_returns(), $result);
777         $this->assertEquals(0, $DB->get_field('data_records', 'approved', array('id' => $entry11)));
778     }
780     /**
781      * Test approve_entry missing permissions.
782      */
783     public function test_approve_entry_missing_permissions() {
784         global $DB;
785         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
787         $this->setUser($this->student1);
788         $this->expectException('moodle_exception');
789         mod_data_external::approve_entry($entry13);
790     }
792     /**
793      * Test delete_entry as teacher. Check I can delete any entry.
794      */
795     public function test_delete_entry_as_teacher() {
796         global $DB;
797         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
799         $this->setUser($this->teacher);
800         $result = mod_data_external::delete_entry($entry11);
801         $result = external_api::clean_returnvalue(mod_data_external::delete_entry_returns(), $result);
802         $this->assertEquals(0, $DB->count_records('data_records', array('id' => $entry11)));
804         // Entry in other group.
805         $result = mod_data_external::delete_entry($entry21);
806         $result = external_api::clean_returnvalue(mod_data_external::delete_entry_returns(), $result);
807         $this->assertEquals(0, $DB->count_records('data_records', array('id' => $entry21)));
808     }
810     /**
811      * Test delete_entry as student. Check I can delete my own entries.
812      */
813     public function test_delete_entry_as_student() {
814         global $DB;
815         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
817         $this->setUser($this->student1);
818         $result = mod_data_external::delete_entry($entry11);
819         $result = external_api::clean_returnvalue(mod_data_external::delete_entry_returns(), $result);
820         $this->assertEquals(0, $DB->count_records('data_records', array('id' => $entry11)));
821     }
823     /**
824      * Test delete_entry as student in read only mode period. Check I cannot delete my own entries in that period.
825      */
826     public function test_delete_entry_as_student_in_read_only_period() {
827         global $DB;
828         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
829         // Set a time period.
830         $this->database->timeviewfrom = time() - HOURSECS;
831         $this->database->timeviewto = time() + HOURSECS;
832         $DB->update_record('data', $this->database);
834         $this->setUser($this->student1);
835         $this->expectException('moodle_exception');
836         mod_data_external::delete_entry($entry11);
837     }
839     /**
840      * Test delete_entry with an user missing permissions.
841      */
842     public function test_delete_entry_missing_permissions() {
843         global $DB;
844         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
846         $this->setUser($this->student1);
847         $this->expectException('moodle_exception');
848         mod_data_external::delete_entry($entry21);
849     }
851     /**
852      * Test add_entry.
853      */
854     public function test_add_entry() {
855         global $DB;
856         // First create the record structure and add some entries.
857         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
859         $this->setUser($this->student1);
860         $newentrydata = [];
861         $fields = $DB->get_records('data_fields', array('dataid' => $this->database->id), 'id');
862         // Prepare the new entry data.
863         foreach ($fields as $field) {
864             $subfield = $value = '';
866             switch ($field->type) {
867                 case 'checkbox':
868                     $value = ['opt1', 'opt2'];
869                     break;
870                 case 'date':
871                     // Add two extra.
872                     $newentrydata[] = [
873                         'fieldid' => $field->id,
874                         'subfield' => 'day',
875                         'value' => json_encode('5')
876                     ];
877                     $newentrydata[] = [
878                         'fieldid' => $field->id,
879                         'subfield' => 'month',
880                         'value' => json_encode('1')
881                     ];
882                     $subfield = 'year';
883                     $value = '1981';
884                     break;
885                 case 'menu':
886                     $value = 'menu1';
887                     break;
888                 case 'multimenu':
889                     $value = ['multimenu1', 'multimenu4'];
890                     break;
891                 case 'number':
892                     $value = 6;
893                     break;
894                 case 'radiobutton':
895                     $value = 'radioopt1';
896                     break;
897                 case 'text':
898                     $value = 'some text';
899                     break;
900                 case 'textarea':
901                     $newentrydata[] = [
902                         'fieldid' => $field->id,
903                         'subfield' => 'content1',
904                         'value' => json_encode(FORMAT_MOODLE)
905                     ];
906                     $newentrydata[] = [
907                         'fieldid' => $field->id,
908                         'subfield' => 'itemid',
909                         'value' => json_encode(0)
910                     ];
911                     $value = 'more text';
912                     break;
913                 case 'url':
914                     $value = 'https://moodle.org';
915                     $subfield = 0;
916                     break;
917             }
919             $newentrydata[] = [
920                 'fieldid' => $field->id,
921                 'subfield' => $subfield,
922                 'value' => json_encode($value)
923             ];
924         }
925         $result = mod_data_external::add_entry($this->database->id, 0, $newentrydata);
926         $result = external_api::clean_returnvalue(mod_data_external::add_entry_returns(), $result);
928         $newentryid = $result['newentryid'];
929         $result = mod_data_external::get_entry($newentryid, true);
930         $result = external_api::clean_returnvalue(mod_data_external::get_entry_returns(), $result);
931         $this->assertEquals($this->student1->id, $result['entry']['userid']);
932         $this->assertCount(9, $result['entry']['contents']);
933         foreach ($result['entry']['contents'] as $content) {
934             $field = $fields[$content['fieldid']];
935             // Stored content same that the one retrieved by WS.
936             $dbcontent = $DB->get_record('data_content', array('fieldid' => $field->id, 'recordid' => $newentryid));
937             $this->assertEquals($dbcontent->content, $content['content']);
939             // Now double check everything stored is correct.
940             if ($field->type == 'checkbox') {
941                 $this->assertEquals('opt1##opt2', $content['content']);
942                 continue;
943             }
944             if ($field->type == 'date') {
945                 $this->assertEquals(347500800, $content['content']); // Date in gregorian format.
946                 continue;
947             }
948             if ($field->type == 'menu') {
949                 $this->assertEquals('menu1', $content['content']);
950                 continue;
951             }
952             if ($field->type == 'multimenu') {
953                 $this->assertEquals('multimenu1##multimenu4', $content['content']);
954                 continue;
955             }
956             if ($field->type == 'number') {
957                 $this->assertEquals(6, $content['content']);
958                 continue;
959             }
960             if ($field->type == 'radiobutton') {
961                 $this->assertEquals('radioopt1', $content['content']);
962                 continue;
963             }
964             if ($field->type == 'text') {
965                 $this->assertEquals('some text', $content['content']);
966                 continue;
967             }
968             if ($field->type == 'textarea') {
969                 $this->assertEquals('more text', $content['content']);
970                 $this->assertEquals(FORMAT_MOODLE, $content['content1']);
971                 continue;
972             }
973             if ($field->type == 'url') {
974                 $this->assertEquals('https://moodle.org', $content['content']);
975                 continue;
976             }
977             $this->assertEquals('multimenu1##multimenu4', $content['content']);
978         }
980         // Now, try to add another entry but removing some required data.
981         unset($newentrydata[0]);
982         $result = mod_data_external::add_entry($this->database->id, 0, $newentrydata);
983         $result = external_api::clean_returnvalue(mod_data_external::add_entry_returns(), $result);
984         $this->assertEquals(0, $result['newentryid']);
985         $this->assertCount(0, $result['generalnotifications']);
986         $this->assertCount(1, $result['fieldnotifications']);
987         $this->assertEquals('field-1', $result['fieldnotifications'][0]['fieldname']);
988         $this->assertEquals(get_string('errormustsupplyvalue', 'data'), $result['fieldnotifications'][0]['notification']);
989     }
991     /**
992      * Test add_entry empty_form.
993      */
994     public function test_add_entry_empty_form() {
995         $result = mod_data_external::add_entry($this->database->id, 0, []);
996         $result = external_api::clean_returnvalue(mod_data_external::add_entry_returns(), $result);
997         $this->assertEquals(0, $result['newentryid']);
998         $this->assertCount(1, $result['generalnotifications']);
999         $this->assertCount(0, $result['fieldnotifications']);
1000         $this->assertEquals(get_string('emptyaddform', 'data'), $result['generalnotifications'][0]);
1001     }
1003     /**
1004      * Test add_entry read_only_period.
1005      */
1006     public function test_add_entry_read_only_period() {
1007         global $DB;
1008         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
1009         // Set a time period.
1010         $this->database->timeviewfrom = time() - HOURSECS;
1011         $this->database->timeviewto = time() + HOURSECS;
1012         $DB->update_record('data', $this->database);
1014         $this->setUser($this->student1);
1015         $this->expectExceptionMessage(get_string('noaccess', 'data'));
1016         $this->expectException('moodle_exception');
1017         mod_data_external::add_entry($this->database->id, 0, []);
1018     }
1020     /**
1021      * Test add_entry max_num_entries.
1022      */
1023     public function test_add_entry_max_num_entries() {
1024         global $DB;
1025         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
1026         // Set a time period.
1027         $this->database->maxentries = 1;
1028         $DB->update_record('data', $this->database);
1030         $this->setUser($this->student1);
1031         $this->expectExceptionMessage(get_string('noaccess', 'data'));
1032         $this->expectException('moodle_exception');
1033         mod_data_external::add_entry($this->database->id, 0, []);
1034     }
1036     /**
1037      * Test update_entry.
1038      */
1039     public function test_update_entry() {
1040         global $DB;
1041         // First create the record structure and add some entries.
1042         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
1044         $this->setUser($this->student1);
1045         $newentrydata = [];
1046         $fields = $DB->get_records('data_fields', array('dataid' => $this->database->id), 'id');
1047         // Prepare the new entry data.
1048         foreach ($fields as $field) {
1049             $subfield = $value = '';
1051             switch ($field->type) {
1052                 case 'checkbox':
1053                     $value = ['opt1', 'opt2'];
1054                     break;
1055                 case 'date':
1056                     // Add two extra.
1057                     $newentrydata[] = [
1058                         'fieldid' => $field->id,
1059                         'subfield' => 'day',
1060                         'value' => json_encode('5')
1061                     ];
1062                     $newentrydata[] = [
1063                         'fieldid' => $field->id,
1064                         'subfield' => 'month',
1065                         'value' => json_encode('1')
1066                     ];
1067                     $subfield = 'year';
1068                     $value = '1981';
1069                     break;
1070                 case 'menu':
1071                     $value = 'menu1';
1072                     break;
1073                 case 'multimenu':
1074                     $value = ['multimenu1', 'multimenu4'];
1075                     break;
1076                 case 'number':
1077                     $value = 6;
1078                     break;
1079                 case 'radiobutton':
1080                     $value = 'radioopt2';
1081                     break;
1082                 case 'text':
1083                     $value = 'some text';
1084                     break;
1085                 case 'textarea':
1086                     $newentrydata[] = [
1087                         'fieldid' => $field->id,
1088                         'subfield' => 'content1',
1089                         'value' => json_encode(FORMAT_MOODLE)
1090                     ];
1091                     $newentrydata[] = [
1092                         'fieldid' => $field->id,
1093                         'subfield' => 'itemid',
1094                         'value' => json_encode(0)
1095                     ];
1096                     $value = 'more text';
1097                     break;
1098                 case 'url':
1099                     $value = 'https://moodle.org';
1100                     $subfield = 0;
1101                     break;
1102             }
1104             $newentrydata[] = [
1105                 'fieldid' => $field->id,
1106                 'subfield' => $subfield,
1107                 'value' => json_encode($value)
1108             ];
1109         }
1110         $result = mod_data_external::update_entry($entry11, $newentrydata);
1111         $result = external_api::clean_returnvalue(mod_data_external::update_entry_returns(), $result);
1112         $this->assertTrue($result['updated']);
1113         $this->assertCount(0, $result['generalnotifications']);
1114         $this->assertCount(0, $result['fieldnotifications']);
1116         $result = mod_data_external::get_entry($entry11, true);
1117         $result = external_api::clean_returnvalue(mod_data_external::get_entry_returns(), $result);
1118         $this->assertEquals($this->student1->id, $result['entry']['userid']);
1119         $this->assertCount(9, $result['entry']['contents']);
1120         foreach ($result['entry']['contents'] as $content) {
1121             $field = $fields[$content['fieldid']];
1122             // Stored content same that the one retrieved by WS.
1123             $dbcontent = $DB->get_record('data_content', array('fieldid' => $field->id, 'recordid' => $entry11));
1124             $this->assertEquals($dbcontent->content, $content['content']);
1126             // Now double check everything stored is correct.
1127             if ($field->type == 'checkbox') {
1128                 $this->assertEquals('opt1##opt2', $content['content']);
1129                 continue;
1130             }
1131             if ($field->type == 'date') {
1132                 $this->assertEquals(347500800, $content['content']); // Date in gregorian format.
1133                 continue;
1134             }
1135             if ($field->type == 'menu') {
1136                 $this->assertEquals('menu1', $content['content']);
1137                 continue;
1138             }
1139             if ($field->type == 'multimenu') {
1140                 $this->assertEquals('multimenu1##multimenu4', $content['content']);
1141                 continue;
1142             }
1143             if ($field->type == 'number') {
1144                 $this->assertEquals(6, $content['content']);
1145                 continue;
1146             }
1147             if ($field->type == 'radiobutton') {
1148                 $this->assertEquals('radioopt2', $content['content']);
1149                 continue;
1150             }
1151             if ($field->type == 'text') {
1152                 $this->assertEquals('some text', $content['content']);
1153                 continue;
1154             }
1155             if ($field->type == 'textarea') {
1156                 $this->assertEquals('more text', $content['content']);
1157                 $this->assertEquals(FORMAT_MOODLE, $content['content1']);
1158                 continue;
1159             }
1160             if ($field->type == 'url') {
1161                 $this->assertEquals('https://moodle.org', $content['content']);
1162                 continue;
1163             }
1164             $this->assertEquals('multimenu1##multimenu4', $content['content']);
1165         }
1167         // Now, try to update the entry but removing some required data.
1168         unset($newentrydata[0]);
1169         $result = mod_data_external::update_entry($entry11, $newentrydata);
1170         $result = external_api::clean_returnvalue(mod_data_external::update_entry_returns(), $result);
1171         $this->assertFalse($result['updated']);
1172         $this->assertCount(0, $result['generalnotifications']);
1173         $this->assertCount(1, $result['fieldnotifications']);
1174         $this->assertEquals('field-1', $result['fieldnotifications'][0]['fieldname']);
1175         $this->assertEquals(get_string('errormustsupplyvalue', 'data'), $result['fieldnotifications'][0]['notification']);
1176     }
1178     /**
1179      * Test update_entry sending empty data.
1180      */
1181     public function test_update_entry_empty_data() {
1182         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
1184         $this->setUser($this->student1);
1185         $result = mod_data_external::update_entry($entry11, []);
1186         $result = external_api::clean_returnvalue(mod_data_external::update_entry_returns(), $result);
1187         $this->assertFalse($result['updated']);
1188         $this->assertCount(1, $result['generalnotifications']);
1189         $this->assertCount(9, $result['fieldnotifications']);
1190         $this->assertEquals(get_string('emptyaddform', 'data'), $result['generalnotifications'][0]);
1191     }
1193     /**
1194      * Test update_entry in read only period.
1195      */
1196     public function test_update_entry_read_only_period() {
1197         global $DB;
1198         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
1199         // Set a time period.
1200         $this->database->timeviewfrom = time() - HOURSECS;
1201         $this->database->timeviewto = time() + HOURSECS;
1202         $DB->update_record('data', $this->database);
1204         $this->setUser($this->student1);
1205         $this->expectExceptionMessage(get_string('noaccess', 'data'));
1206         $this->expectException('moodle_exception');
1207         mod_data_external::update_entry($entry11, []);
1208     }
1210     /**
1211      * Test update_entry other_user.
1212      */
1213     public function test_update_entry_other_user() {
1214         // Try to update other user entry.
1215         list($entry11, $entry12, $entry13, $entry21) = self::populate_database_with_entries();
1216         $this->setUser($this->student2);
1217         $this->expectExceptionMessage(get_string('noaccess', 'data'));
1218         $this->expectException('moodle_exception');
1219         mod_data_external::update_entry($entry11, []);
1220     }