MDL-47410 behat: Support date selection from the date selector element

Adds behat support for selecting a date from the date selector element.
The passed values should represent a textual date description wrapped
in '##' (e.g. '##first day of January 2020##', '##1 Jan 2020##'). Also,
the value 'disabled' is valid and can be used to disable the date
selector element.

lib/behat/form_field/behat_form_date.php

@@ -0,0 +1,101 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Date form field class.
+ *
+ * @package    core_form
+ * @category   test
+ * @copyright  2013 David Monllaó
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+// NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
+
+require_once(__DIR__  . '/behat_form_group.php');
+
+use Behat\Mink\Exception\ExpectationException;
+
+/**
+ * Date form field.
+ *
+ * This class will be refactored in case we are interested in
+ * creating more complex formats to fill date and date-time fields.
+ *
+ * @package    core_form
+ * @category   test
+ * @copyright  2013 David Monllaó
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class behat_form_date extends behat_form_group {
+
+    /**
+     * Sets the value to a date field.
+     *
+     * @param string $value The value to be assigned to the date selector field. The string value must be either
+     *                      parsable into a UNIX timestamp or equal to 'disabled' (if disabling the date selector).
+     * @return void
+     * @throws ExpectationException If the value is invalid.
+     */
+    public function set_value($value) {
+
+        if ($value === 'disabled') {
+            // Disable the given date selector field.
+            $this->set_child_field_value('enabled', false);
+        } else if (is_numeric($value)) { // The value is numeric (unix timestamp).
+            // Assign the mapped values to each form element in the date selector field.
+            foreach ($this->get_mapped_fields($value) as $childname => $childvalue) {
+                $this->set_child_field_value($childname, $childvalue);
+            }
+        } else { // Invalid value.
+            // Get the name of the field.
+            $fieldname = $this->field->find('css', 'legend')->getHtml();
+            throw new ExpectationException("Invalid value for '{$fieldname}'", $this->session);
+        }
+    }
+
+    /**
+     * Returns the date field identifiers and the values that should be assigned to them.
+     *
+     * @param int $timestamp The UNIX timestamp
+     * @return array
+     */
+    protected function get_mapped_fields(int $timestamp): array {
+        return [
+            'enabled' => true,
+            'day' => date('j', $timestamp),
+            'month' => date('n', $timestamp),
+            'year' => date('Y', $timestamp),
+        ];
+    }
+
+    /**
+     * Sets a value to a child element in the date form field.
+     *
+     * @param string $childname The name of the child field
+     * @param string|bool $childvalue The value
+     */
+    private function set_child_field_value(string $childname, $childvalue) {
+        // Find the given child form element in the date selector field.
+        $childelement = $this->field->find('css', "*[name$='[{$childname}]']");
+        if ($childelement) {
+            // Get the field instance for the given child form element.
+            $childinstance = $this->get_field_instance_for_element($childelement);
+            // Set the value to the child form element.
+            $childinstance->set_value($childvalue);
+        }
+    }
+}

lib/behat/form_field/behat_form_date_selector.php

@@ -1,42 +0,0 @@
-<?php
-// This file is part of Moodle - http://moodle.org/
-//
-// Moodle is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// Moodle is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
-
-/**
- * Date form field class.
- *
- * @package    core_form
- * @category   test
- * @copyright  2013 David Monllaó
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-// NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
-
-require_once(__DIR__  . '/behat_form_group.php');
-
-/**
- * Date form field.
- *
- * This class will be refactored in case we are interested in
- * creating more complex formats to fill date and date-time fields.
- *
- * @package    core_form
- * @category   test
- * @copyright  2013 David Monllaó
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class behat_form_date_selector extends behat_form_group {
-}

lib/form/templates/element-date_selector.mustache

@@ -1,6 +1,6 @@
 {{< core_form/element-group }}
     {{$element}}
-        <fieldset class="m-0 p-0 border-0" id="{{element.id}}">
+        <fieldset data-fieldtype="date" class="m-0 p-0 border-0" id="{{element.id}}">
             <legend class="sr-only">{{label}}</legend>
             <span class="fdate_selector d-flex align-items-center">
             {{#element.elements}}

lib/upgrade.txt

@@ -24,6 +24,9 @@ information provided here is intended especially for developers.
 * emoji-data has been upgraded to 6.0.0.
 * The final deprecation of /message/defaultoutputs.php file and admin_page_defaultmessageoutputs.
   All their settings moved to admin/message.php (see MDL-64495). Please use admin_page_managemessageoutputs class instead.
+* Behat now supports date selection from the date form element. Examples:
+    - I set the field "<field_string>" to "##15 March 2021##"
+    - I set the field "<field_string>" to "##first day of January last year##"
 
 === 3.10 ===
 * PHPUnit has been upgraded to 8.5. That comes with a few changes: