MDL-57898 core_customfield: Custom fields API
[moodle.git] / customfield / field / checkbox / tests / plugin_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  * Tests for class customfield_checkbox
19  *
20  * @package    customfield_checkbox
21  * @copyright  2019 Marina Glancy
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 use customfield_checkbox\field_controller;
28 use customfield_checkbox\data_controller;
30 /**
31  * Functional test for customfield_checkbox
32  *
33  * @package    customfield_checkbox
34  * @copyright  2019 Marina Glancy
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class customfield_checkbox_plugin_testcase extends advanced_testcase {
39     /** @var stdClass[]  */
40     private $courses = [];
41     /** @var \core_customfield\category_controller */
42     private $cfcat;
43     /** @var \core_customfield\field_controller[] */
44     private $cfields;
45     /** @var \core_customfield\data_controller[] */
46     private $cfdata;
48     /**
49      * Tests set up.
50      */
51     public function setUp() {
52         $this->resetAfterTest();
54         $this->cfcat = $this->get_generator()->create_category();
56         $this->cfields[1] = $this->get_generator()->create_field(
57             ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield1', 'type' => 'checkbox']);
58         $this->cfields[2] = $this->get_generator()->create_field(
59             ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield2', 'type' => 'checkbox',
60                 'configdata' => ['required' => 1]]);
61         $this->cfields[3] = $this->get_generator()->create_field(
62             ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield3', 'type' => 'checkbox',
63                 'configdata' => ['checkbydefault' => 1]]);
65         $this->courses[1] = $this->getDataGenerator()->create_course();
66         $this->courses[2] = $this->getDataGenerator()->create_course();
67         $this->courses[3] = $this->getDataGenerator()->create_course();
69         $this->cfdata[1] = $this->get_generator()->add_instance_data($this->cfields[1], $this->courses[1]->id, 1);
70         $this->cfdata[2] = $this->get_generator()->add_instance_data($this->cfields[1], $this->courses[2]->id, 1);
72         $this->setUser($this->getDataGenerator()->create_user());
73     }
75     /**
76      * Get generator
77      * @return core_customfield_generator
78      */
79     protected function get_generator(): core_customfield_generator {
80         return $this->getDataGenerator()->get_plugin_generator('core_customfield');
81     }
83     /**
84      * Test for initialising field and data controllers
85      */
86     public function test_initialise() {
87         $f = \core_customfield\field_controller::create($this->cfields[1]->get('id'));
88         $this->assertTrue($f instanceof field_controller);
90         $f = \core_customfield\field_controller::create(0, (object)['type' => 'checkbox'], $this->cfcat);
91         $this->assertTrue($f instanceof field_controller);
93         $d = \core_customfield\data_controller::create($this->cfdata[1]->get('id'));
94         $this->assertTrue($d instanceof data_controller);
96         $d = \core_customfield\data_controller::create(0, null, $this->cfields[1]);
97         $this->assertTrue($d instanceof data_controller);
98     }
100     /**
101      * Test for configuration form functions
102      *
103      * Create a configuration form and submit it with the same values as in the field
104      */
105     public function test_config_form() {
106         $submitdata = (array)$this->cfields[1]->to_record();
107         $submitdata['configdata'] = $this->cfields[1]->get('configdata');
109         \core_customfield\field_config_form::mock_submit($submitdata, []);
110         $handler = $this->cfcat->get_handler();
111         $form = $handler->get_field_config_form($this->cfields[1]);
112         $this->assertTrue($form->is_validated());
113         $data = $form->get_data();
114         $handler->save_field_configuration($this->cfields[1], $data);
116         // Try submitting with 'unique values' checked.
117         $submitdata['configdata']['uniquevalues'] = 1;
118         \core_customfield\field_config_form::mock_submit($submitdata, []);
119         $handler = $this->cfcat->get_handler();
120         $form = $handler->get_field_config_form($this->cfields[1]);
121         $this->assertFalse($form->is_validated());
122     }
124     /**
125      * Test for instance form functions
126      */
127     public function test_instance_form() {
128         global $CFG;
129         require_once($CFG->dirroot . '/customfield/tests/fixtures/test_instance_form.php');
130         $this->setAdminUser();
131         $handler = $this->cfcat->get_handler();
133         // First try to submit without required field.
134         $submitdata = (array)$this->courses[1];
135         core_customfield_test_instance_form::mock_submit($submitdata, []);
136         $form = new core_customfield_test_instance_form('POST',
137             ['handler' => $handler, 'instance' => $this->courses[1]]);
138         $this->assertFalse($form->is_validated());
140         // Now with required field.
141         $submitdata['customfield_myfield2'] = 1;
142         core_customfield_test_instance_form::mock_submit($submitdata, []);
143         $form = new core_customfield_test_instance_form('POST',
144             ['handler' => $handler, 'instance' => $this->courses[1]]);
145         $this->assertTrue($form->is_validated());
147         $data = $form->get_data();
148         $this->assertNotEmpty($data->customfield_myfield1);
149         $this->assertNotEmpty($data->customfield_myfield2);
150         $handler->instance_form_save($data);
151     }
153     /**
154      * Test for data_controller::get_value and export_value
155      */
156     public function test_get_export_value() {
157         $this->assertEquals(1, $this->cfdata[1]->get_value());
158         $this->assertEquals('Yes', $this->cfdata[1]->export_value());
160         // Field without data.
161         $d = core_customfield\data_controller::create(0, null, $this->cfields[2]);
162         $this->assertEquals(0, $d->get_value());
163         $this->assertEquals('No', $d->export_value());
165         // Field without data that is checked by default.
166         $d = core_customfield\data_controller::create(0, null, $this->cfields[3]);
167         $this->assertEquals(1, $d->get_value());
168         $this->assertEquals('Yes', $d->export_value());
169     }
171     /**
172      * Deleting fields and data
173      */
174     public function test_delete() {
175         $this->cfcat->get_handler()->delete_all();
176     }