MDL-57898 core_customfield: Custom fields API
[moodle.git] / customfield / field / select / 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_select
19  *
20  * @package    customfield_select
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_select\field_controller;
28 use customfield_select\data_controller;
30 /**
31  * Functional test for customfield_select
32  *
33  * @package    customfield_select
34  * @copyright  2019 Marina Glancy
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class customfield_select_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' => 'select',
58                 'configdata' => ['options' => "a\nb\nc"]]);
59         $this->cfields[2] = $this->get_generator()->create_field(
60             ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield2', 'type' => 'select',
61                 'configdata' => ['required' => 1, 'options' => "a\nb\nc"]]);
62         $this->cfields[3] = $this->get_generator()->create_field(
63             ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield3', 'type' => 'select',
64                 'configdata' => ['defaultvalue' => 'b', 'options' => "a\nb\nc"]]);
66         $this->courses[1] = $this->getDataGenerator()->create_course();
67         $this->courses[2] = $this->getDataGenerator()->create_course();
68         $this->courses[3] = $this->getDataGenerator()->create_course();
70         $this->cfdata[1] = $this->get_generator()->add_instance_data($this->cfields[1], $this->courses[1]->id, 1);
71         $this->cfdata[2] = $this->get_generator()->add_instance_data($this->cfields[1], $this->courses[2]->id, 1);
73         $this->setUser($this->getDataGenerator()->create_user());
74     }
76     /**
77      * Get generator
78      * @return core_customfield_generator
79      */
80     protected function get_generator(): core_customfield_generator {
81         return $this->getDataGenerator()->get_plugin_generator('core_customfield');
82     }
84     /**
85      * Test for initialising field and data controllers
86      */
87     public function test_initialise() {
88         $f = \core_customfield\field_controller::create($this->cfields[1]->get('id'));
89         $this->assertTrue($f instanceof field_controller);
91         $f = \core_customfield\field_controller::create(0, (object)['type' => 'select'], $this->cfcat);
92         $this->assertTrue($f instanceof field_controller);
94         $d = \core_customfield\data_controller::create($this->cfdata[1]->get('id'));
95         $this->assertTrue($d instanceof data_controller);
97         $d = \core_customfield\data_controller::create(0, null, $this->cfields[1]);
98         $this->assertTrue($d instanceof data_controller);
99     }
101     /**
102      * Test for configuration form functions
103      *
104      * Create a configuration form and submit it with the same values as in the field
105      */
106     public function test_config_form() {
107         $submitdata = (array)$this->cfields[1]->to_record();
108         $submitdata['configdata'] = $this->cfields[1]->get('configdata');
110         \core_customfield\field_config_form::mock_submit($submitdata, []);
111         $handler = $this->cfcat->get_handler();
112         $form = $handler->get_field_config_form($this->cfields[1]);
113         $this->assertTrue($form->is_validated());
114         $data = $form->get_data();
115         $handler->save_field_configuration($this->cfields[1], $data);
116     }
118     /**
119      * Test for instance form functions
120      */
121     public function test_instance_form() {
122         global $CFG;
123         require_once($CFG->dirroot . '/customfield/tests/fixtures/test_instance_form.php');
124         $this->setAdminUser();
125         $handler = $this->cfcat->get_handler();
127         // First try to submit without required field.
128         $submitdata = (array)$this->courses[1];
129         core_customfield_test_instance_form::mock_submit($submitdata, []);
130         $form = new core_customfield_test_instance_form('POST',
131             ['handler' => $handler, 'instance' => $this->courses[1]]);
132         $this->assertFalse($form->is_validated());
134         // Now with required field.
135         $submitdata['customfield_myfield2'] = 1;
136         core_customfield_test_instance_form::mock_submit($submitdata, []);
137         $form = new core_customfield_test_instance_form('POST',
138             ['handler' => $handler, 'instance' => $this->courses[1]]);
139         $this->assertTrue($form->is_validated());
141         $data = $form->get_data();
142         $this->assertNotEmpty($data->customfield_myfield1);
143         $this->assertNotEmpty($data->customfield_myfield2);
144         $handler->instance_form_save($data);
145     }
147     /**
148      * Test for data_controller::get_value and export_value
149      */
150     public function test_get_export_value() {
151         $this->assertEquals(1, $this->cfdata[1]->get_value());
152         $this->assertEquals('a', $this->cfdata[1]->export_value());
154         // Field without data but with a default value.
155         $d = core_customfield\data_controller::create(0, null, $this->cfields[3]);
156         $this->assertEquals(2, $d->get_value());
157         $this->assertEquals('b', $d->export_value());
158     }
160     /**
161      * Deleting fields and data
162      */
163     public function test_delete() {
164         $this->cfcat->get_handler()->delete_all();
165     }