[Summary view]

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403] [Versions 39 and 310]

   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  /**
  18   * Tests for class customfield_date
  19   *
  20   * @package    customfield_date
  21   * @copyright  2019 Marina Glancy
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  use customfield_date\field_controller;
  28  use customfield_date\data_controller;
  29  
  30  /**
  31   * Functional test for customfield_date
  32   *
  33   * @package    customfield_date
  34   * @copyright  2019 Marina Glancy
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class customfield_date_plugin_testcase extends advanced_testcase {
  38  
  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;
  47  
  48      /**
  49       * Tests set up.
  50       */
  51      public function setUp(): void {
  52          $this->resetAfterTest();
  53  
  54          $this->cfcat = $this->get_generator()->create_category();
  55  
  56          $this->cfields[1] = $this->get_generator()->create_field(
  57              ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield1', 'type' => 'date']);
  58          $this->cfields[2] = $this->get_generator()->create_field(
  59              ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield2', 'type' => 'date',
  60                  'configdata' => ['required' => 1, 'includetime' => 0, 'mindate' => 946684800, 'maxdate' => 1893456000]]);
  61  
  62          $this->courses[1] = $this->getDataGenerator()->create_course();
  63          $this->courses[2] = $this->getDataGenerator()->create_course();
  64          $this->courses[3] = $this->getDataGenerator()->create_course();
  65  
  66          $this->cfdata[1] = $this->get_generator()->add_instance_data($this->cfields[1], $this->courses[1]->id, 1546300800);
  67          $this->cfdata[2] = $this->get_generator()->add_instance_data($this->cfields[1], $this->courses[2]->id, 1546300800);
  68  
  69          $this->setUser($this->getDataGenerator()->create_user());
  70      }
  71  
  72      /**
  73       * Get generator
  74       * @return core_customfield_generator
  75       */
  76      protected function get_generator() : core_customfield_generator {
  77          return $this->getDataGenerator()->get_plugin_generator('core_customfield');
  78      }
  79  
  80      /**
  81       * Test for initialising field and data controllers
  82       */
  83      public function test_initialise() {
  84          $f = \core_customfield\field_controller::create($this->cfields[1]->get('id'));
  85          $this->assertTrue($f instanceof field_controller);
  86  
  87          $f = \core_customfield\field_controller::create(0, (object)['type' => 'date'], $this->cfcat);
  88          $this->assertTrue($f instanceof field_controller);
  89  
  90          $d = \core_customfield\data_controller::create($this->cfdata[1]->get('id'));
  91          $this->assertTrue($d instanceof data_controller);
  92  
  93          $d = \core_customfield\data_controller::create(0, null, $this->cfields[1]);
  94          $this->assertTrue($d instanceof data_controller);
  95      }
  96  
  97      /**
  98       * Test for configuration form functions
  99       *
 100       * Create a configuration form and submit it with the same values as in the field
 101       */
 102      public function test_config_form() {
 103          $submitdata = (array)$this->cfields[1]->to_record();
 104          $submitdata['configdata'] = $this->cfields[1]->get('configdata');
 105  
 106          \core_customfield\field_config_form::mock_submit($submitdata, []);
 107          $handler = $this->cfcat->get_handler();
 108          $form = $handler->get_field_config_form($this->cfields[1]);
 109          $this->assertTrue($form->is_validated());
 110          $data = $form->get_data();
 111          $handler->save_field_configuration($this->cfields[1], $data);
 112      }
 113  
 114      /**
 115       * Test for instance form functions
 116       */
 117      public function test_instance_form() {
 118          global $CFG;
 119          require_once($CFG->dirroot . '/customfield/tests/fixtures/test_instance_form.php');
 120          $this->setAdminUser();
 121          $handler = $this->cfcat->get_handler();
 122  
 123          // First try to submit without required field.
 124          $submitdata = (array)$this->courses[1];
 125          core_customfield_test_instance_form::mock_submit($submitdata, []);
 126          $form = new core_customfield_test_instance_form('POST',
 127              ['handler' => $handler, 'instance' => $this->courses[1]]);
 128          $this->assertFalse($form->is_validated());
 129  
 130          // Now with required field.
 131          $submitdata['customfield_myfield2'] = time();
 132          core_customfield_test_instance_form::mock_submit($submitdata, []);
 133          $form = new core_customfield_test_instance_form('POST',
 134              ['handler' => $handler, 'instance' => $this->courses[1]]);
 135          $this->assertTrue($form->is_validated());
 136  
 137          $data = $form->get_data();
 138          $this->assertEmpty($data->customfield_myfield1);
 139          $this->assertNotEmpty($data->customfield_myfield2);
 140          $handler->instance_form_save($data);
 141      }
 142  
 143      /**
 144       * Test for min/max date validation
 145       */
 146      public function test_instance_form_validation() {
 147          $this->setAdminUser();
 148          $handler = $this->cfcat->get_handler();
 149          $submitdata = (array)$this->courses[1];
 150          $data = data_controller::create(0, null, $this->cfields[2]);
 151  
 152          // Submit with date less than mindate.
 153          $submitdata['customfield_myfield2'] = 915148800;
 154          $this->assertNotEmpty($data->instance_form_validation($submitdata, []));
 155  
 156          // Submit with date more than maxdate.
 157          $submitdata['customfield_myfield2'] = 1893557000;
 158          $this->assertNotEmpty($data->instance_form_validation($submitdata, []));
 159      }
 160  
 161      /**
 162       * Test for data_controller::get_value and export_value
 163       */
 164      public function test_get_export_value() {
 165          $this->assertEquals(1546300800, $this->cfdata[1]->get_value());
 166          $this->assertStringMatchesFormat('%a 1 January 2019%a', $this->cfdata[1]->export_value());
 167  
 168          // Field without data.
 169          $d = core_customfield\data_controller::create(0, null, $this->cfields[2]);
 170          $this->assertEquals(0, $d->get_value());
 171          $this->assertEquals(null, $d->export_value());
 172      }
 173  
 174      /**
 175       * Data provider for {@see test_parse_value}
 176       *
 177       * @return array
 178       */
 179      public function parse_value_provider() : array {
 180          return [
 181              // Valid times.
 182              ['2019-10-01', strtotime('2019-10-01')],
 183              ['2019-10-01 14:00', strtotime('2019-10-01 14:00')],
 184              // Invalid times.
 185              ['ZZZZZ', 0],
 186              ['202-04-01', 0],
 187              ['2019-15-15', 0],
 188          ];
 189      }
 190      /**
 191       * Test field parse_value method
 192       *
 193       * @param string $value
 194       * @param int $expected
 195       * @return void
 196       *
 197       * @dataProvider parse_value_provider
 198       */
 199      public function test_parse_value(string $value, int $expected) {
 200          $this->assertSame($expected, $this->cfields[1]->parse_value($value));
 201      }
 202  
 203      /**
 204       * Deleting fields and data
 205       */
 206      public function test_delete() {
 207          $this->cfcat->get_handler()->delete_all();
 208      }
 209  }