WebSVN – Moodle – Diff – /reportbuilder/tests/local/helpers/custom_fields_test.php

 namespace core_reportbuilder\local\helpers;
-use core_customfield_generator;
-use core_reportbuilder_generator;
+use core_customfield_generator;
-use core_reportbuilder_testcase;
+use core_reportbuilder_generator;
-use core_reportbuilder\local\entities\course;
-use core_reportbuilder\local\filters\boolean_select;
-use core_reportbuilder\local\filters\date;
-use core_reportbuilder\local\filters\select;
+use core_reportbuilder\local\entities\course;
-use core_reportbuilder\local\filters\text;
+use core_reportbuilder\local\filters\{boolean_select, date, number, select, text};
-use core_reportbuilder\local\report\column;
+use core_reportbuilder\local\report\{column, filter};
-use core_reportbuilder\local\report\filter;
-use core_course\reportbuilder\datasource\{categories, courses};
-defined('MOODLE_INTERNAL') || die();
-global $CFG;
+use core_reportbuilder\tests\core_reportbuilder_testcase;
-require_once("{$CFG->dirroot}/reportbuilder/tests/helpers.php");
+use core_course\reportbuilder\datasource\{categories, courses};
 /**
  * Unit tests for custom fields helper
+ *
  * @package     core_reportbuilder
  * @covers      \core_reportbuilder\local\helpers\custom_fields
  * @copyright   2021 David Matamoros <davidmc@moodle.com>
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class custom_fields_test extends core_reportbuilder_testcase {
+final class custom_fields_test extends core_reportbuilder_testcase {
             'itemid' => 0,
             'contextid' => \context_system::instance()->id
         ]);
         $generator->create_field(
+            ['categoryid' => $category->get('id'), 'type' => 'text', 'name' => 'Text', 'shortname' => 'text',
-            ['categoryid' => $category->get('id'), 'type' => 'text', 'name' => 'Text', 'shortname' => 'text']);
+                'configdata' => ['defaultvalue' => 'default']]);
+        $generator->create_field(
+            ['categoryid' => $category->get('id'), 'type' => 'textarea', 'name' => 'Textarea', 'shortname' => 'textarea',
-        $generator->create_field(
+                'configdata' => ['defaultvalue' => 'Default']]);
-            ['categoryid' => $category->get('id'), 'type' => 'textarea', 'name' => 'Textarea', 'shortname' => 'textarea']);
+        // This field is available only to course teachers.
         $generator->create_field(
-        $generator->create_field(
+            ['categoryid' => $category->get('id'), 'type' => 'checkbox', 'name' => 'Checkbox', 'shortname' => 'checkbox',
-            ['categoryid' => $category->get('id'), 'type' => 'checkbox', 'name' => 'Checkbox', 'shortname' => 'checkbox']);
+                'configdata' => ['checkbydefault' => 1, 'visibility' => 1]]);
         $generator->create_field(
+            ['categoryid' => $category->get('id'), 'type' => 'date', 'name' => 'Date', 'shortname' => 'date']);
+        $generator->create_field(
+            ['categoryid' => $category->get('id'), 'type' => 'select', 'name' => 'Select', 'shortname' => 'select',
-            ['categoryid' => $category->get('id'), 'type' => 'date', 'name' => 'Date', 'shortname' => 'date']);
+                'configdata' => ['options' => "Cat\nDog\nFish", 'defaultvalue' => 'Cat']]);
         $generator->create_field(
-            ['categoryid' => $category->get('id'), 'type' => 'select', 'name' => 'Select', 'shortname' => 'select',
+            ['categoryid' => $category->get('id'), 'type' => 'number', 'name' => 'Number', 'shortname' => 'number',
-                'configdata' => ['options' => "Cat\nDog", 'defaultvalue' => 'Cat']]);
                 'configdata' => ['defaultvalue' => 1]]);
         $courseentity = new course();
-        $coursealias = $courseentity->get_table_alias('course');
+        $courseentity = new course();
         $coursealias = $courseentity->get_table_alias('course');
         // Create an instance of the customfields helper.
-        return new custom_fields($coursealias . '.id', $courseentity->get_entity_name(),
+        // Create an instance of the customfields helper.
+        return new custom_fields("{$coursealias}.id", $courseentity->get_entity_name(), 'core_course', 'course');
             'core_course', 'course');
-    }
+    /**
-    /**
+     * Test for get_columns
-     * Test for get_columns
+     */
-     */
+    public function test_get_columns(): void {
+        $this->resetAfterTest();
+        $this->setAdminUser();
-    public function test_get_columns(): void {
+        $customfields = $this->generate_customfields();
+        $columns = $customfields->get_columns();
+        $this->assertCount(6, $columns);
-        $this->resetAfterTest();
+        $this->assertContainsOnlyInstancesOf(column::class, $columns);
+        // Column titles.
-        $customfields = $this->generate_customfields();
+        $this->assertEquals([
-        $columns = $customfields->get_columns();
+            'Text',
+            'Textarea',
+            'Checkbox',
+            'Date',
+            'Select',
+            'Number',
+        ], array_map(
+            fn(column $column) => $column->get_title(),
-        $this->assertCount(5, $columns);
+            $columns,
+        ));
-        $this->assertContainsOnlyInstancesOf(column::class, $columns);
         // Column types.
-        // Column titles.
+        $this->assertEquals([
+            column::TYPE_TEXT,
+            column::TYPE_LONGTEXT,
+            column::TYPE_BOOLEAN,
+            column::TYPE_TIMESTAMP,
+            column::TYPE_TEXT,
+            column::TYPE_FLOAT,
+        ], array_map(
+            fn(column $column) => $column->get_type(),
+            $columns,
+        ));
+        // Column sortable.
+        $this->assertEquals([
+            true,
+            true,
+            true,
+            true,
+            true,
+            true,
+        ], array_map(
+            fn(column $column) => $column->get_is_sortable(),
+            $columns,
+        ));
-        $this->assertEquals(
+        // Column available.
+        $this->assertEquals([
+            true,
+            true,
+            true,
+            true,
+            true,
+            true,
+        ], array_map(
+            fn(column $column) => $column->get_is_available(),
-            ['Text', 'Textarea', 'Checkbox', 'Date', 'Select'],
+            $columns,
+        ));
-            array_map(fn(column $column) => $column->get_title(), $columns)
-        );
+        // Column available, for non-privileged user.
         $this->setUser(null);
-        // Column types.
+        $this->assertEquals([
-        $this->assertEquals(
+            true,
-            [column::TYPE_TEXT, column::TYPE_LONGTEXT, column::TYPE_BOOLEAN, column::TYPE_TIMESTAMP, column::TYPE_TEXT],
+            true,
-            array_map(fn(column $column) => $column->get_type(), $columns)
+            false,
-        );
+            true,
+            true,
-        // Column sortable.
+            true,
-        $this->assertEquals(
+        ], array_map(
+            fn(column $column) => $column->get_is_available(),
-            [true, false, true, true, true],
+            $customfields->get_columns(),
+        ));
-            array_map(fn(column $column) => $column->get_is_sortable(), $columns)
+    }
-        );
     /**
      * Test that joins added to the custom fields helper are present in its columns/filters
-    /**
+     */
-     * Test for add_join
-     */
     public function test_add_join(): void {
         $this->resetAfterTest();
-        $customfields = $this->generate_customfields();
-        // By default, we always join on the customfield data table.
-        $columns = $customfields->get_columns();
-        $joins = $columns[0]->get_joins();
-        $this->assertCount(1, $joins);
-        $this->assertStringStartsWith('LEFT JOIN {customfield_data}', $joins[0]);
-        // Add additional join.
-        $customfields->add_join('JOIN {test} t ON t.id = id');
-        $columns = $customfields->get_columns();
+        $customfields = $this->generate_customfields();
-        $joins = $columns[0]->get_joins();
-        $this->assertCount(2, $joins);
-        $this->assertEquals('JOIN {test} t ON t.id = id', $joins[0]);
+        // We always join on the customfield data table.
-        $this->assertStringStartsWith('LEFT JOIN {customfield_data}', $joins[1]);
+        $columnjoins = $customfields->get_columns()[0]->get_joins();
-    }
+        $this->assertCount(1, $columnjoins);
-    /**
+        $this->assertStringStartsWith('LEFT JOIN {customfield_data}', $columnjoins[0]);
      * Test for add_joins
-     */
+        $filterjoins = $customfields->get_filters()[0]->get_joins();
-    public function test_add_joins(): void {
+        $this->assertCount(1, $filterjoins);
-        $this->resetAfterTest();
+        $this->assertStringStartsWith('LEFT JOIN {customfield_data}', $filterjoins[0]);
+        // Add additional join.
-        $customfields = $this->generate_customfields();
+        $customfields->add_join('JOIN {test} t ON t.id = id');
-        // Add additional joins.
+        $columnjoins = $customfields->get_columns()[0]->get_joins();
-        $customfields->add_joins(['JOIN {test} t ON t.id = id', 'JOIN {test2} t2 ON t2.id = id']);
+        $this->assertCount(2, $columnjoins);
+        $this->assertEquals('JOIN {test} t ON t.id = id', $columnjoins[0]);
+        $this->assertStringStartsWith('LEFT JOIN {customfield_data}', $columnjoins[1]);
+        $filterjoins = $customfields->get_filters()[0]->get_joins();
+        $this->assertCount(2, $filterjoins);
+        $this->assertEquals('JOIN {test} t ON t.id = id', $filterjoins[0]);
+        $this->assertStringStartsWith('LEFT JOIN {customfield_data}', $filterjoins[1]);
+    }
+    /**
+     * Test for get_filters
+     */
+    public function test_get_filters(): void {
+        $this->resetAfterTest();
+        $this->setAdminUser();
+        $customfields = $this->generate_customfields();
+        $filters = $customfields->get_filters();
+        $this->assertCount(6, $filters);
+        $this->assertContainsOnlyInstancesOf(filter::class, $filters);
+        // Filter headers.
+        $this->assertEquals([
+            'Text',
+            'Textarea',
+            'Checkbox',
-        $columns = $customfields->get_columns();
+            'Date',
+            'Select',
+            'Number',
+        ], array_map(
+            fn(filter $filter) => $filter->get_header(),
+            $filters,
+        ));
-        $joins = $columns[0]->get_joins();
+        // Filter types.
+        $this->assertEquals([
+            text::class,
+            text::class,
+            boolean_select::class,
+            date::class,
+            select::class,
+            number::class,
+        ], array_map(
+            fn(filter $filter) => $filter->get_filter_class(),
+            $filters,
+        ));
+        // Filter available.
+        $this->assertEquals([
+            true,
-        $this->assertCount(3, $joins);
+            true,
-        $this->assertEquals('JOIN {test} t ON t.id = id', $joins[0]);
+            true,
-        $this->assertEquals('JOIN {test2} t2 ON t2.id = id', $joins[1]);
+            true,
-        $this->assertStringStartsWith('LEFT JOIN {customfield_data}', $joins[2]);
+            true,
             true,
         ], array_map(
-    /**
+            fn(filter $filter) => $filter->get_is_available(),
+            $filters,
-     * Test for get_filters
+        ));
+        // Filter available, for non-privileged user.
+        $this->setUser(null);
-     */
+        $this->assertEquals([
-    public function test_get_filters(): void {
+            true,
-        $this->resetAfterTest();
+            true,
+            false,
-        $customfields = $this->generate_customfields();
+            true,
-        $filters = $customfields->get_filters();
+            true,
+            true,
         ], array_map(
-        $this->assertCount(5, $filters);
+            fn(filter $filter) => $filter->get_is_available(),
-        $this->assertContainsOnlyInstancesOf(filter::class, $filters);
+            $customfields->get_filters(),
+        ));
         // Filter titles.
+    /**
-        $this->assertEquals(
+     * Test that adding custom field columns to a report returns expected values
+     */
-            ['Text', 'Textarea', 'Checkbox', 'Date', 'Select'],
+    public function test_custom_report_content(): void {
-            array_map(fn(filter $filter) => $filter->get_header(), $filters)
+        $this->resetAfterTest();
-        );
+        $this->setAdminUser();
         $category = $this->getDataGenerator()->create_category(['name' => 'Zebras']);
+        $courseone = $this->getDataGenerator()->create_course(['category' => $category->id, 'fullname' => 'C1']);
     /**
-     * Test that adding custom field columns to a report returns expected values
-     */
+        // Second course will populate each custom field.
+        $this->generate_customfields();
-    public function test_custom_report_content(): void {
+        $coursetwo = $this->getDataGenerator()->create_course(['category' => $category->id, 'fullname' => 'C2', 'customfields' => [
-        $this->resetAfterTest();
+            ['shortname' => 'text', 'value' => 'Hello'],
+            ['shortname' => 'textarea_editor', 'value' => ['text' => 'Goodbye', 'format' => FORMAT_MOODLE]],
-        $this->generate_customfields();
+            ['shortname' => 'checkbox', 'value' => 0],
+            ['shortname' => 'date', 'value' => 1669852800],
-        $course = $this->getDataGenerator()->create_course(['customfields' => [
+            ['shortname' => 'select', 'value' => 2],
-            ['shortname' => 'text', 'value' => 'Hello'],
+            ['shortname' => 'number', 'value' => 42],
-            ['shortname' => 'textarea_editor', 'value' => ['text' => 'Goodbye', 'format' => FORMAT_MOODLE]],
+        ]]);
-            ['shortname' => 'checkbox', 'value' => true],
-            ['shortname' => 'date', 'value' => 1669852800],
-            ['shortname' => 'select', 'value' => 2],
-        ]]);
+        /** @var core_reportbuilder_generator $generator */
+        $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
-        /** @var core_reportbuilder_generator $generator */
+        $report = $generator->create_report(['name' => 'Categories', 'source' => categories::class, 'default' => 0]);
-        $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
-        $report = $generator->create_report(['name' => 'Courses', 'source' => courses::class, 'default' => 0]);
         // Add custom field columns to the report.
-        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:fullname']);
+        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course_category:name',
-        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_text']);
-        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_textarea']);
+            'sortenabled' => 1]);
-        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_checkbox']);
+        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:fullname',
-        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_date']);
+            'sortenabled' => 1]);
+        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_text']);
-        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_select']);
+        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_textarea']);
+        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_checkbox']);
-        $content = $this->get_custom_report_content($report->get('id'));
+        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_date']);
+        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_select']);
-        $this->assertEquals([
+        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_number']);
-            $course->fullname,
-            'Hello',
-            '<div class="text_to_html">Goodbye</div>',
+        $content = $this->get_custom_report_content($report->get('id'));
-            'Yes',
+        $this->assertEquals([
-            userdate(1669852800),
+            [
-            'Dog'
+                'Category 1',
-        ], array_values($content[0]));
+                '',
                 '',
                 '',
-    /**
+                '',
-     * Test that adding custom field columns to report returns expected default values for fields
+                '',
-     */
+                '',
-    public function test_custom_report_content_column_defaults(): void {
+                '',
-        $this->resetAfterTest();
+            ],
+            [
-        $this->generate_customfields();
+                $category->name,
                 $courseone->fullname,
-        $category = $this->getDataGenerator()->create_category(['name' => 'Zebras']);
+                'default',
-        $course = $this->getDataGenerator()->create_course(['category' => $category->id]);
+                format_text('Default'),
+                'Yes',
+                '',
+                'Cat',
+,
             ],
         /** @var core_reportbuilder_generator $generator */
-        $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
+                $category->name,
-        $report = $generator->create_report(['name' => 'Categories', 'source' => categories::class, 'default' => 0]);
+                $coursetwo->fullname,
                 'Hello',
-        // Add custom field columns to the report.
+                format_text('Goodbye'),
-        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course_category:name',
+                'No',
-            'sortenabled' => 1]);
+                userdate(1669852800),
+                'Dog',
+,
+            ],
+        ], array_map('array_values', $content));
         $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:fullname']);
         $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_select']);
     /**
-        $content = $this->get_custom_report_content($report->get('id'));
+     * Data provider for {@see test_custom_report_filter}
         $this->assertEquals([
-            ['Category 1', '', ''],
-            [$category->name, $course->fullname, 'Cat'],
-        ], array_map('array_values', $content));
      * @return array[]
+     */
+    public static function custom_report_filter_provider(): array {
+        return [
+            'Filter by text custom field' => ['course:customfield_text', [
-    /**
+                'course:customfield_text_operator' => text::IS_EQUAL_TO,
-     * Data provider for {@see test_custom_report_filter}
+                'course:customfield_text_value' => 'Hello',
             ], 'C2'],
-     * @return array[]
+            'Filter by text custom field (default)' => ['course:customfield_text', [
-     */
+                'course:customfield_text_operator' => text::IS_EQUAL_TO,
-    public function custom_report_filter_provider(): array {
+                'course:customfield_text_value' => 'default',
-        return [
+            ], 'C1'],
-            'Filter by text custom field' => ['course:customfield_text', [
+            'Filter by text custom field (no match)' => ['course:customfield_text', [
                 'course:customfield_text_operator' => text::IS_EQUAL_TO,
-                'course:customfield_text_value' => 'Hello',
+                'course:customfield_text_value' => 'Goodbye',
-            ], true],
+            ]],
-            'Filter by text custom field (no match)' => ['course:customfield_text', [
+            'Filter by textarea custom field' => ['course:customfield_textarea', [
-                'course:customfield_text_operator' => text::IS_EQUAL_TO,
+                'course:customfield_textarea_operator' => text::IS_EQUAL_TO,
-                'course:customfield_text_value' => 'Goodbye',
+                'course:customfield_textarea_value' => 'Goodbye',
-            ], false],
+            ], 'C2'],
-            'Filter by textarea custom field' => ['course:customfield_textarea', [
+            'Filter by textarea custom field (default)' => ['course:customfield_textarea', [
+                'course:customfield_textarea_operator' => text::IS_EQUAL_TO,
+                'course:customfield_textarea_value' => 'Default',
+            ], 'C1'],
+            'Filter by textarea custom field (no match)' => ['course:customfield_textarea', [
+                'course:customfield_textarea_operator' => text::IS_EQUAL_TO,
+                'course:customfield_textarea_value' => 'Hello',
+            ]],
+            'Filter by checkbox custom field' => ['course:customfield_checkbox', [
+                'course:customfield_checkbox_operator' => boolean_select::NOT_CHECKED,
+            ], 'C2'],
+            'Filter by checkbox custom field (default)' => ['course:customfield_checkbox', [
+                'course:customfield_checkbox_operator' => boolean_select::CHECKED,
+            ], 'C1'],
+            'Filter by date custom field' => ['course:customfield_date', [
+                'course:customfield_date_operator' => date::DATE_RANGE,
+                'course:customfield_date_from' => 1622502000,
-                'course:customfield_textarea_operator' => text::IS_EQUAL_TO,
+            ], 'C2'],
-                'course:customfield_textarea_value' => 'Goodbye',
+            'Filter by date custom field (no match)' => ['course:customfield_date', [
-            ], true],
+                'course:customfield_date_operator' => date::DATE_RANGE,
-            'Filter by textarea custom field (no match)' => ['course:customfield_textarea', [
+                'course:customfield_date_from' => 1672531200,
-                'course:customfield_textarea_operator' => text::IS_EQUAL_TO,
+            ]],
-                'course:customfield_textarea_value' => 'Hello',
+            'Filter by select custom field' => ['course:customfield_select', [
-            ], false],
+                'course:customfield_select_operator' => select::EQUAL_TO,
-            'Filter by checkbox custom field' => ['course:customfield_checkbox', [
+                'course:customfield_select_value' => 2,
-                'course:customfield_checkbox_operator' => boolean_select::CHECKED,
+            ], 'C2'],
-            ], true],
+            'Filter by select custom field (default)' => ['course:customfield_select', [
-            'Filter by checkbox custom field (no match)' => ['course:customfield_checkbox', [
+                'course:customfield_select_operator' => select::EQUAL_TO,
-                'course:customfield_checkbox_operator' => boolean_select::NOT_CHECKED,
+                'course:customfield_select_value' => 1,
-            ], false],
+            ], 'C1'],
+            'Filter by select custom field (no match)' => ['course:customfield_select', [
-            'Filter by date custom field' => ['course:customfield_date', [
+                'course:customfield_select_operator' => select::EQUAL_TO,
+                'course:customfield_select_value' => 3,
+            ]],
-                'course:customfield_date_operator' => date::DATE_RANGE,
+            'Filter by number custom field' => ['course:customfield_number', [
-                'course:customfield_date_from' => 1622502000,
+                'course:customfield_number_operator' => number::EQUAL_TO,
-            ], true],
+                'course:customfield_number_value1' => 42,
-            'Filter by date custom field (no match)' => ['course:customfield_date', [
+            ], 'C2'],
-                'course:customfield_date_operator' => date::DATE_RANGE,
+            'Filter by number custom field (default)' => ['course:customfield_number', [
-                'course:customfield_date_to' => 1622502000,
+                'course:customfield_number_operator' => number::EQUAL_TO,
+                'course:customfield_number_value1' => 1,
-            ], false],
+            ], 'C1'],
-            'Filter by select custom field' => ['course:customfield_select', [
+            'Filter by number custom field (no match)' => ['course:customfield_number', [
-                'course:customfield_select_operator' => select::EQUAL_TO,
+                'course:customfield_number_operator' => number::EQUAL_TO,
         // Add filter, set it's values.
         $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => $filtername]);
         $content = $this->get_custom_report_content($report->get('id'), 0, $filtervalues);
-        if ($expectmatch) {
+        if ($expectmatch !== null) {
             $this->assertCount(1, $content);
-            $this->assertEquals($course->fullname, reset($content[0]));
+            $this->assertEquals($expectmatch, reset($content[0]));
         } else {
             $this->assertEmpty($content);
+        }
         $this->resetAfterTest();
         $this->generate_customfields();
-        $course = $this->getDataGenerator()->create_course(['customfields' => [
+        $this->getDataGenerator()->create_course(['customfields' => [
             ['shortname' => 'text', 'value' => 'Hello'],
             ['shortname' => 'textarea_editor', 'value' => ['text' => 'Goodbye', 'format' => FORMAT_MOODLE]],
             ['shortname' => 'checkbox', 'value' => true],

Proyectos de Subversion Moodle

(root)/reportbuilder/tests/local/helpers/custom_fields_test.php – Rev 1 → 1441