first commit

customfield/field/text/tests/behat/field.feature

@@ -0,0 +1,140 @@
+@customfield @customfield_text @javascript
+Feature: Managers can manage course custom fields text
+  In order to have additional data on the course
+  As a manager
+  I need to create, edit, remove and sort custom fields
+
+  Background:
+    Given the following "custom field categories" exist:
+      | name              | component   | area   | itemid |
+      | Category for test | core_course | course | 0      |
+    And I log in as "admin"
+    And I navigate to "Courses > Default settings > Course custom fields" in site administration
+
+  Scenario: Create a custom course text field
+    When I click on "Add a new custom field" "link"
+    And I click on "Short text" "link"
+    And I set the following fields to these values:
+      | Name       | Test field |
+      | Short name | testfield  |
+    And I click on "Save changes" "button" in the "Adding a new Short text" "dialogue"
+    Then I should see "Test field"
+    And I log out
+
+  Scenario: Edit a custom course text field
+    When I click on "Add a new custom field" "link"
+    And I click on "Short text" "link"
+    And I set the following fields to these values:
+      | Name       | Test field |
+      | Short name | testfield  |
+    And I click on "Save changes" "button" in the "Adding a new Short text" "dialogue"
+    And I click on "Edit" "link" in the "Test field" "table_row"
+    And I set the following fields to these values:
+      | Name | Edited field |
+    And I click on "Save changes" "button" in the "Updating Test field" "dialogue"
+    Then I should see "Edited field"
+    And I navigate to "Reports > Logs" in site administration
+    And I press "Get these logs"
+    And I log out
+
+  Scenario: Delete a custom course text field
+    When I click on "Add a new custom field" "link"
+    And I click on "Short text" "link"
+    And I set the following fields to these values:
+      | Name       | Test field |
+      | Short name | testfield  |
+    And I click on "Save changes" "button" in the "Adding a new Short text" "dialogue"
+    And I click on "Delete" "link" in the "Test field" "table_row"
+    And I click on "Yes" "button" in the "Confirm" "dialogue"
+    And I wait until the page is ready
+    And I wait until "Test field" "text" does not exist
+    Then I should not see "Test field"
+    And I log out
+
+  Scenario: A text field with a link setting must show link on course listing
+    Given the following "users" exist:
+      | username | firstname | lastname  | email                |
+      | teacher1 | Teacher   | Example 1 | teacher1@example.com |
+    And the following "courses" exist:
+      | fullname | shortname | format |
+      | Course 1 | C1        | topics |
+    And the following "course enrolments" exist:
+      | user     | course | role           |
+      | teacher1 | C1     | editingteacher |
+    And I navigate to "Courses > Default settings > Course custom fields" in site administration
+    And I click on "Add a new custom field" "link"
+    And I click on "Short text" "link"
+    And I set the following fields to these values:
+      | Name       | See more on website       |
+      | Short name | testfield                 |
+      | Visible to | Everyone                  |
+      | Link       | https://www.moodle.org/$$ |
+    And I click on "Save changes" "button" in the "Adding a new Short text" "dialogue"
+    And I log out
+    Then I log in as "teacher1"
+    And I am on "Course 1" course homepage
+    And I navigate to "Settings" in current page administration
+    And I set the following fields to these values:
+      | See more on website | course/view.php?id=35 |
+    And I press "Save and display"
+    And I am on site homepage
+    Then I should see "course/view.php?id=35" in the ".customfields-container .customfieldvalue a" "css_element"
+    Then I should see "See more on website" in the ".customfields-container .customfieldname" "css_element"
+
+  Scenario: A text field with a max length must validate it on course edit form
+    Given the following "users" exist:
+      | username | firstname | lastname  | email                |
+      | teacher1 | Teacher   | Example 1 | teacher1@example.com |
+    And the following "courses" exist:
+      | fullname | shortname | format |
+      | Course 1 | C1        | topics |
+    And the following "course enrolments" exist:
+      | user     | course | role           |
+      | teacher1 | C1     | editingteacher |
+    And I navigate to "Courses > Default settings > Course custom fields" in site administration
+    And I click on "Add a new custom field" "link"
+    And I click on "Short text" "link"
+    And I set the following fields to these values:
+      | Name       | Test field |
+      | Short name | testfield  |
+      | Maximum number of characters | 3          |
+    And I click on "Save changes" "button" in the "Adding a new Short text" "dialogue"
+    And I log out
+    Then I log in as "teacher1"
+    And I am on "Course 1" course homepage
+    And I navigate to "Settings" in current page administration
+    And I set the following fields to these values:
+      | Test field | 1234 |
+    And I press "Save and display"
+    Then I should see "The maximum number of characters allowed in this field is 3."
+
+  Scenario: A text field with a default value must be shown on listing but allow empty values that will not be shown
+    Given the following "users" exist:
+      | username | firstname | lastname  | email                |
+      | teacher1 | Teacher   | Example 1 | teacher1@example.com |
+    And the following "courses" exist:
+      | fullname | shortname | format |
+      | Course 1 | C1        | topics |
+    And the following "course enrolments" exist:
+      | user     | course | role           |
+      | teacher1 | C1     | editingteacher |
+    And I navigate to "Courses > Default settings > Course custom fields" in site administration
+    And I click on "Add a new custom field" "link"
+    And I click on "Short text" "link"
+    And I set the following fields to these values:
+      | Name          | Test field  |
+      | Short name    | testfield   |
+      | Default value | testdefault |
+    And I click on "Save changes" "button" in the "Adding a new Short text" "dialogue"
+    And I log out
+    Then I log in as "teacher1"
+    When I am on site homepage
+    Then I should see "Test field: testdefault"
+    When I am on "Course 1" course homepage
+    And I navigate to "Settings" in current page administration
+    Then the "value" attribute of "#id_customfield_testfield" "css_element" should contain "testdefault"
+    When I set the following fields to these values:
+      | Test field |  |
+    And I press "Save and display"
+    And I am on site homepage
+    And I should not see "Test field"

customfield/field/text/tests/plugin_test.php

@@ -0,0 +1,169 @@
+<?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/>.
+
+namespace customfield_text;
+
+use core_customfield_generator;
+use core_customfield_test_instance_form;
+
+/**
+ * Functional test for customfield_text
+ *
+ * @package    customfield_text
+ * @copyright  2019 Marina Glancy
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class plugin_test extends \advanced_testcase {
+
+    /** @var stdClass[]  */
+    private $courses = [];
+    /** @var \core_customfield\category_controller */
+    private $cfcat;
+    /** @var \core_customfield\field_controller[] */
+    private $cfields;
+    /** @var \core_customfield\data_controller[] */
+    private $cfdata;
+
+    /**
+     * Tests set up.
+     */
+    public function setUp(): void {
+        $this->resetAfterTest();
+
+        $this->cfcat = $this->get_generator()->create_category();
+
+        $this->cfields[1] = $this->get_generator()->create_field(
+            ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield1', 'type' => 'text',
+                'configdata' => ['maxlength' => 30, 'displaysize' => 50], 'description' => null]);
+        $this->cfields[2] = $this->get_generator()->create_field(
+            ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield2', 'type' => 'text',
+                'configdata' => ['required' => 1, 'maxlength' => 30, 'displaysize' => 50]]);
+        $this->cfields[3] = $this->get_generator()->create_field(
+            ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield3', 'type' => 'text',
+                'configdata' => ['defaultvalue' => 'Defvalue', 'maxlength' => 30, 'displaysize' => 50]]);
+        $this->cfields[4] = $this->get_generator()->create_field(
+            ['categoryid' => $this->cfcat->get('id'), 'shortname' => 'myfield4', 'type' => 'text',
+                'configdata' => ['link' => 'https://twitter.com/$$', 'maxlength' => 30, 'displaysize' => 50]]);
+
+        $this->courses[1] = $this->getDataGenerator()->create_course();
+        $this->courses[2] = $this->getDataGenerator()->create_course();
+        $this->courses[3] = $this->getDataGenerator()->create_course();
+
+        $this->cfdata[1] = $this->get_generator()->add_instance_data($this->cfields[1], $this->courses[1]->id,
+            'Value1');
+        $this->cfdata[2] = $this->get_generator()->add_instance_data($this->cfields[1], $this->courses[2]->id,
+            'Value2');
+
+        $this->setUser($this->getDataGenerator()->create_user());
+    }
+
+    /**
+     * Get generator
+     * @return core_customfield_generator
+     */
+    protected function get_generator(): core_customfield_generator {
+        return $this->getDataGenerator()->get_plugin_generator('core_customfield');
+    }
+
+    /**
+     * Test for initialising field and data controllers
+     */
+    public function test_initialise(): void {
+        $f = \core_customfield\field_controller::create($this->cfields[1]->get('id'));
+        $this->assertTrue($f instanceof field_controller);
+
+        $f = \core_customfield\field_controller::create(0, (object)['type' => 'text'], $this->cfcat);
+        $this->assertTrue($f instanceof field_controller);
+
+        $d = \core_customfield\data_controller::create($this->cfdata[1]->get('id'));
+        $this->assertTrue($d instanceof data_controller);
+
+        $d = \core_customfield\data_controller::create(0, null, $this->cfields[1]);
+        $this->assertTrue($d instanceof data_controller);
+    }
+
+    /**
+     * Test for configuration form functions
+     *
+     * Create a configuration form and submit it with the same values as in the field
+     */
+    public function test_config_form(): void {
+        $this->setAdminUser();
+        $submitdata = (array)$this->cfields[1]->to_record();
+        $submitdata['configdata'] = $this->cfields[1]->get('configdata');
+
+        $submitdata = \core_customfield\field_config_form::mock_ajax_submit($submitdata);
+        $form = new \core_customfield\field_config_form(null, null, 'post', '', null, true,
+            $submitdata, true);
+        $form->set_data_for_dynamic_submission();
+        $this->assertTrue($form->is_validated());
+        $form->process_dynamic_submission();
+    }
+
+    /**
+     * Test for instance form functions
+     */
+    public function test_instance_form(): void {
+        global $CFG;
+        require_once($CFG->dirroot . '/customfield/tests/fixtures/test_instance_form.php');
+        $this->setAdminUser();
+        $handler = $this->cfcat->get_handler();
+
+        // First try to submit without required field.
+        $submitdata = (array)$this->courses[1];
+        core_customfield_test_instance_form::mock_submit($submitdata, []);
+        $form = new core_customfield_test_instance_form('POST',
+            ['handler' => $handler, 'instance' => $this->courses[1]]);
+        $this->assertFalse($form->is_validated());
+
+        // Now with required field.
+        $submitdata['customfield_myfield2'] = 'Some text';
+        core_customfield_test_instance_form::mock_submit($submitdata, []);
+        $form = new core_customfield_test_instance_form('POST',
+            ['handler' => $handler, 'instance' => $this->courses[1]]);
+        $this->assertTrue($form->is_validated());
+
+        $data = $form->get_data();
+        $this->assertNotEmpty($data->customfield_myfield1);
+        $this->assertNotEmpty($data->customfield_myfield2);
+        $handler->instance_form_save($data);
+    }
+
+    /**
+     * Test for data_controller::get_value and export_value
+     */
+    public function test_get_export_value(): void {
+        $this->assertEquals('Value1', $this->cfdata[1]->get_value());
+        $this->assertEquals('Value1', $this->cfdata[1]->export_value());
+
+        // Field without data but with a default value.
+        $d = \core_customfield\data_controller::create(0, null, $this->cfields[3]);
+        $this->assertEquals('Defvalue', $d->get_value());
+        $this->assertEquals('Defvalue', $d->export_value());
+
+        // Field with a link.
+        $d = $this->get_generator()->add_instance_data($this->cfields[4], $this->courses[1]->id, 'mynickname');
+        $this->assertEquals('mynickname', $d->get_value());
+        $this->assertEquals('<a href="https://twitter.com/mynickname">mynickname</a>', $d->export_value());
+    }
+
+    /**
+     * Deleting fields and data
+     */
+    public function test_delete(): void {
+        $this->cfcat->get_handler()->delete_all();
+    }
+}