Merge branch 'MDL-41722-master' of git://github.com/sammarshallou/moodle
[moodle.git] / calendar / tests / calendartype_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  * This file contains the class that handles testing the calendar type system.
19  *
20  * @package core_calendar
21  * @copyright 2013 Mark Nelson <markn@moodle.com>
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 global $CFG;
29 // The test calendar type.
30 require_once($CFG->dirroot . '/calendar/tests/calendartype_test_example.php');
32 // Used to test the dateselector elements.
33 require_once($CFG->libdir . '/form/dateselector.php');
34 require_once($CFG->libdir . '/form/datetimeselector.php');
36 // Used to test the user datetime profile field.
37 require_once($CFG->dirroot . '/user/profile/lib.php');
38 require_once($CFG->dirroot . '/user/profile/definelib.php');
39 require_once($CFG->dirroot . '/user/profile/index_field_form.php');
41 /**
42  * Unit tests for the calendar type system.
43  *
44  * @package core_calendar
45  * @copyright 2013 Mark Nelson <markn@moodle.com>
46  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
47  * @since Moodle 2.6
48  */
49 class core_calendar_type_testcase extends advanced_testcase {
51     /**
52      * The test user.
53      */
54     private $user;
56     /**
57      * Test set up.
58      */
59     protected function setUp() {
60         // The user we are going to test this on.
61         $this->user = self::getDataGenerator()->create_user();
62         self::setUser($this->user);
63     }
65     /**
66      * Test that setting the calendar type works.
67      */
68     public function test_calendar_type_set() {
69         // We want to reset the test data after this run.
70         $this->resetAfterTest();
72         // Test setting it as the 'Test' calendar type.
73         $this->set_calendar_type('test');
74         $this->assertEquals('test', \core_calendar\type_factory::get_calendar_type());
76         // Test setting it as the 'Gregorian' calendar type.
77         $this->set_calendar_type('gregorian');
78         $this->assertEquals('gregorian', \core_calendar\type_factory::get_calendar_type());
79     }
81     /**
82      * Test that calling core Moodle functions responsible for displaying the date
83      * have the same results as directly calling the same function in the calendar type.
84      */
85     public function test_calendar_type_core_functions() {
86         // We want to reset the test data after this run.
87         $this->resetAfterTest();
89         // Test that the core functions reproduce the same results as the Gregorian calendar.
90         $this->core_functions_test('gregorian');
92         // Test that the core functions reproduce the same results as the test calendar.
93         $this->core_functions_test('test');
94     }
96     /**
97      * Test that dates selected using the date selector elements are being saved as unixtime, and that the
98      * unixtime is being converted back to a valid date to display in the date selector elements for
99      * different calendar types.
100      */
101     public function test_calendar_type_dateselector_elements() {
102         // We want to reset the test data after this run.
103         $this->resetAfterTest();
105         // Check converting dates to Gregorian when submitting a date selector element works. Note: the test
106         // calendar is 2 years, 2 months, 2 days, 2 hours and 2 minutes ahead of the Gregorian calendar.
107         $date1 = array();
108         $date1['day'] = 4;
109         $date1['month'] = 7;
110         $date1['year'] = 2013;
111         $date1['hour'] = 0;
112         $date1['minute'] = 0;
113         $date1['timestamp'] = 1372896000;
114         $this->convert_dateselector_to_unixtime_test('dateselector', 'gregorian', $date1);
116         $date2 = array();
117         $date2['day'] = 7;
118         $date2['month'] = 9;
119         $date2['year'] = 2015;
120         $date2['hour'] = 0; // The dateselector element does not have hours.
121         $date2['minute'] = 0; // The dateselector element does not have minutes.
122         $date2['timestamp'] = 1372896000;
123         $this->convert_dateselector_to_unixtime_test('dateselector', 'test', $date2);
125         $date3 = array();
126         $date3['day'] = 4;
127         $date3['month'] = 7;
128         $date3['year'] = 2013;
129         $date3['hour'] = 23;
130         $date3['minute'] = 15;
131         $date3['timestamp'] = 1372979700;
132         $this->convert_dateselector_to_unixtime_test('datetimeselector', 'gregorian', $date3);
134         $date4 = array();
135         $date4['day'] = 7;
136         $date4['month'] = 9;
137         $date4['year'] = 2015;
138         $date4['hour'] = 1;
139         $date4['minute'] = 17;
140         $date4['timestamp'] = 1372979700;
141         $this->convert_dateselector_to_unixtime_test('datetimeselector', 'test', $date4);
143         // The date selector element values are set by using the function usergetdate, here we want to check that
144         // the unixtime passed is being successfully converted to the correct values for the calendar type.
145         $this->convert_unixtime_to_dateselector_test('gregorian', $date3);
146         $this->convert_unixtime_to_dateselector_test('test', $date4);
147     }
149     /**
150      * Test that the user profile field datetime minimum and maximum year settings are saved as the
151      * equivalent Gregorian years.
152      */
153     public function test_calendar_type_datetime_field_submission() {
154         // We want to reset the test data after this run.
155         $this->resetAfterTest();
157         // Create an array with the input values and expected values once submitted.
158         $date = array();
159         $date['inputminyear'] = '1970';
160         $date['inputmaxyear'] = '2013';
161         $date['expectedminyear'] = '1970';
162         $date['expectedmaxyear'] = '2013';
163         $this->datetime_field_submission_test('gregorian', $date);
165         // The test calendar is 2 years, 2 months, 2 days in the future, so when the year 1970 is submitted,
166         // the year 1967 should be saved in the DB, as 1/1/1970 converts to 30/10/1967 in Gregorian.
167         $date['expectedminyear'] = '1967';
168         $date['expectedmaxyear'] = '2010';
169         $this->datetime_field_submission_test('test', $date);
170     }
172     /**
173      * Test all the core functions that use the calendar type system.
174      *
175      * @param string $type the calendar type we want to test
176      */
177     private function core_functions_test($type) {
178         $this->set_calendar_type($type);
180         // Get the calendar.
181         $calendar = \core_calendar\type_factory::get_calendar_instance();
183         // Test the userdate function.
184         $this->assertEquals($calendar->timestamp_to_date_string($this->user->timecreated, '', 99, true, true),
185             userdate($this->user->timecreated));
186     }
188     /**
189      * Simulates submitting a form with a date selector element and tests that the chosen dates
190      * are converted into unixtime before being saved in DB.
191      *
192      * @param string $element the form element we are testing
193      * @param string $type the calendar type we want to test
194      * @param array $date the date variables
195      */
196     private function convert_dateselector_to_unixtime_test($element, $type, $date) {
197         $this->set_calendar_type($type);
199         if ($element == 'dateselector') {
200             $el = new MoodleQuickForm_date_selector('dateselector', null, array('timezone' => 0.0, 'step' => 1));
201         } else {
202             $el = new MoodleQuickForm_date_time_selector('dateselector', null, array('timezone' => 0.0, 'step' => 1));
203         }
204         $el->_createElements();
205         $submitvalues = array('dateselector' => $date);
207         $this->assertSame($el->exportValue($submitvalues), array('dateselector' => $date['timestamp']));
208     }
210     /**
211      * Test converting dates from unixtime to a date for the calendar type specified.
212      *
213      * @param string $type the calendar type we want to test
214      * @param array $date the date variables
215      */
216     private function convert_unixtime_to_dateselector_test($type, $date) {
217         $this->set_calendar_type($type);
219         // Get the calendar.
220         $calendar = \core_calendar\type_factory::get_calendar_instance();
222         $usergetdate = $calendar->timestamp_to_date_array($date['timestamp'], 0.0);
223         $comparedate = array(
224             'minute' => $usergetdate['minutes'],
225             'hour' => $usergetdate['hours'],
226             'day' => $usergetdate['mday'],
227             'month' => $usergetdate['mon'],
228             'year' => $usergetdate['year'],
229             'timestamp' => $date['timestamp']
230         );
232         $this->assertEquals($comparedate, $date);
233     }
235     /**
236      * Test saving the minimum and max year settings for the user datetime field.
237      *
238      * @param string $type the calendar type we want to test
239      * @param array $date the date variables
240      */
241     private function datetime_field_submission_test($type, $date) {
242         $this->set_calendar_type($type);
244         // Get the data we are submitting for the form.
245         $formdata = array();
246         $formdata['id'] = 0;
247         $formdata['shortname'] = 'Shortname';
248         $formdata['name'] = 'Name';
249         $formdata['param1'] = $date['inputminyear'];
250         $formdata['param2'] = $date['inputmaxyear'];
252         // Mock submitting this.
253         field_form::mock_submit($formdata);
255         // Create the user datetime form.
256         $form = new field_form(null, 'datetime');
258         // Get the data from the submission.
259         $submissiondata = $form->get_data();
260         // On the user profile field page after get_data, the function define_save is called
261         // in the field base class, which then calls the field's function define_save_preprocess.
262         $field = new profile_define_datetime();
263         $submissiondata = $field->define_save_preprocess($submissiondata);
265         // Create an array we want to compare with the date passed.
266         $comparedate = $date;
267         $comparedate['expectedminyear'] = $submissiondata->param1;
268         $comparedate['expectedmaxyear'] = $submissiondata->param2;
270         $this->assertEquals($comparedate, $date);
271     }
273     /**
274      * Set the calendar type for this user.
275      *
276      * @param string $type the calendar type we want to set
277      */
278     private function set_calendar_type($type) {
279         $this->user->calendartype = $type;
280         \core\session\manager::set_user($this->user);
281     }