first commit

reportbuilder/tests/external/conditions/add_test.php

@@ -0,0 +1,88 @@
+<?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/>.
+
+declare(strict_types=1);
+
+namespace core_reportbuilder\external\conditions;
+
+use core_reportbuilder_generator;
+use core_external\external_api;
+use externallib_advanced_testcase;
+use core_reportbuilder\report_access_exception;
+use core_reportbuilder\local\models\filter;
+use core_user\reportbuilder\datasource\users;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once("{$CFG->dirroot}/webservice/tests/helpers.php");
+
+/**
+ * Unit tests of external class for adding report conditions
+ *
+ * @package     core_reportbuilder
+ * @covers      \core_reportbuilder\external\conditions\add
+ * @copyright   2021 Paul Holden <paulh@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class add_test extends externallib_advanced_testcase {
+
+    /**
+     * Text execute method
+     */
+    public function test_execute(): void {
+        $this->resetAfterTest();
+        $this->setAdminUser();
+
+        /** @var core_reportbuilder_generator $generator */
+        $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
+
+        $report = $generator->create_report([
+            'name' => 'My report',
+            'source' => users::class,
+            'default' => false,
+        ]);
+
+        // Add condition.
+        $result = add::execute($report->get('id'), 'user:fullname');
+        $result = external_api::clean_returnvalue(add::execute_returns(), $result);
+        $this->assertTrue($result['hasactiveconditions']);
+        $this->assertNotEmpty($result['activeconditionsform']);
+
+        // Assert report conditions.
+        $conditions = filter::get_condition_records($report->get('id'));
+        $this->assertCount(1, $conditions);
+        $this->assertEquals('user:fullname', reset($conditions)->get('uniqueidentifier'));
+    }
+
+    /**
+     * Test execute method for a user without permission to edit reports
+     */
+    public function test_execute_access_exception(): void {
+        $this->resetAfterTest();
+
+        /** @var core_reportbuilder_generator $generator */
+        $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
+        $report = $generator->create_report(['name' => 'My report', 'source' => users::class]);
+
+        $user = $this->getDataGenerator()->create_user();
+        $this->setUser($user);
+
+        $this->expectException(report_access_exception::class);
+        $this->expectExceptionMessage('You cannot edit this report');
+        add::execute($report->get('id'), 'user:fullname');
+    }
+}

reportbuilder/tests/external/conditions/delete_test.php

@@ -0,0 +1,97 @@
+<?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/>.
+
+declare(strict_types=1);
+
+namespace core_reportbuilder\external\conditions;
+
+use core_reportbuilder_generator;
+use core_external\external_api;
+use externallib_advanced_testcase;
+use core_reportbuilder\report_access_exception;
+use core_reportbuilder\local\models\filter;
+use core_user\reportbuilder\datasource\users;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once("{$CFG->dirroot}/webservice/tests/helpers.php");
+
+/**
+ * Unit tests of external class for deleting report conditions
+ *
+ * @package     core_reportbuilder
+ * @covers      \core_reportbuilder\external\conditions\delete
+ * @copyright   2021 Paul Holden <paulh@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class delete_test extends externallib_advanced_testcase {
+
+    /**
+     * Text execute method
+     */
+    public function test_execute(): void {
+        $this->resetAfterTest();
+        $this->setAdminUser();
+
+        /** @var core_reportbuilder_generator $generator */
+        $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
+
+        $report = $generator->create_report([
+            'name' => 'My report',
+            'source' => users::class,
+            'default' => false,
+        ]);
+
+        // Add two conditions.
+        $conditionfullname = $generator->create_condition([
+            'reportid' => $report->get('id'),
+            'uniqueidentifier' => 'user:fullname',
+        ]);
+        $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']);
+
+        // Delete the first condition.
+        $result = delete::execute($report->get('id'), $conditionfullname->get('id'));
+        $result = external_api::clean_returnvalue(delete::execute_returns(), $result);
+        $this->assertTrue($result['hasactiveconditions']);
+        $this->assertNotEmpty($result['activeconditionsform']);
+
+        // Assert report conditions.
+        $conditions = filter::get_condition_records($report->get('id'));
+        $this->assertCount(1, $conditions);
+        $this->assertEquals('user:email', reset($conditions)->get('uniqueidentifier'));
+    }
+
+    /**
+     * Test execute method for a user without permission to edit reports
+     */
+    public function test_execute_access_exception(): void {
+        $this->resetAfterTest();
+
+        /** @var core_reportbuilder_generator $generator */
+        $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
+
+        $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]);
+        $condition = $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']);
+
+        $user = $this->getDataGenerator()->create_user();
+        $this->setUser($user);
+
+        $this->expectException(report_access_exception::class);
+        $this->expectExceptionMessage('You cannot edit this report');
+        delete::execute($report->get('id'), $condition->get('id'));
+    }
+}

reportbuilder/tests/external/conditions/reorder_test.php

@@ -0,0 +1,105 @@
+<?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/>.
+
+declare(strict_types=1);
+
+namespace core_reportbuilder\external\conditions;
+
+use core_reportbuilder_generator;
+use core_external\external_api;
+use externallib_advanced_testcase;
+use core_reportbuilder\report_access_exception;
+use core_reportbuilder\local\models\filter;
+use core_user\reportbuilder\datasource\users;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once("{$CFG->dirroot}/webservice/tests/helpers.php");
+
+/**
+ * Unit tests of external class for re-ordering report conditions
+ *
+ * @package     core_reportbuilder
+ * @covers      \core_reportbuilder\external\conditions\reorder
+ * @copyright   2021 Paul Holden <paulh@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class reorder_test extends externallib_advanced_testcase {
+
+    /**
+     * Text execute method
+     */
+    public function test_execute(): void {
+        $this->resetAfterTest();
+        $this->setAdminUser();
+
+        /** @var core_reportbuilder_generator $generator */
+        $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
+
+        $report = $generator->create_report([
+            'name' => 'My report',
+            'source' => users::class,
+            'default' => false,
+        ]);
+
+        // Add four conditions.
+        $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']);
+        $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']);
+        $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:country']);
+        $conditioncity = $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:city']);
+
+        // Move the city condition to second position.
+        $result = reorder::execute($report->get('id'), $conditioncity->get('id'), 2);
+        $result = external_api::clean_returnvalue(reorder::execute_returns(), $result);
+        $this->assertTrue($result['hasactiveconditions']);
+        $this->assertNotEmpty($result['activeconditionsform']);
+
+        // Assert report conditions order.
+        $conditions = filter::get_condition_records($report->get('id'), 'filterorder');
+
+        $conditionidentifiers = array_map(static function(filter $condition): string {
+            return $condition->get('uniqueidentifier');
+        }, $conditions);
+
+        $this->assertEquals([
+            'user:fullname',
+            'user:city',
+            'user:email',
+            'user:country',
+        ], $conditionidentifiers);
+    }
+
+    /**
+     * Test execute method for a user without permission to edit reports
+     */
+    public function test_execute_access_exception(): void {
+        $this->resetAfterTest();
+
+        /** @var core_reportbuilder_generator $generator */
+        $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
+
+        $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]);
+        $condition = $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']);
+
+        $user = $this->getDataGenerator()->create_user();
+        $this->setUser($user);
+
+        $this->expectException(report_access_exception::class);
+        $this->expectExceptionMessage('You cannot edit this report');
+        reorder::execute($report->get('id'), $condition->get('id'), 1);
+    }
+}

reportbuilder/tests/external/conditions/reset_test.php

@@ -0,0 +1,85 @@
+<?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/>.
+
+declare(strict_types=1);
+
+namespace core_reportbuilder\external\conditions;
+
+use core_reportbuilder_generator;
+use core_external\external_api;
+use externallib_advanced_testcase;
+use core_reportbuilder\manager;
+use core_reportbuilder\report_access_exception;
+use core_user\reportbuilder\datasource\users;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once("{$CFG->dirroot}/webservice/tests/helpers.php");
+
+/**
+ * Unit tests of external class for resetting report conditions
+ *
+ * @package     core_reportbuilder
+ * @covers      \core_reportbuilder\external\conditions\reset
+ * @copyright   2021 Paul Holden <paulh@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class reset_test extends externallib_advanced_testcase {
+
+    /**
+     * Text execute method
+     */
+    public function test_execute(): void {
+        $this->resetAfterTest();
+        $this->setAdminUser();
+
+        /** @var core_reportbuilder_generator $generator */
+        $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
+        $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]);
+        $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']);
+
+        $instance = manager::get_report_from_persistent($report);
+        $instance->set_condition_values(['foo' => 'bar']);
+
+        $result = reset::execute($report->get('id'));
+        $result = external_api::clean_returnvalue(reset::execute_returns(), $result);
+        $this->assertTrue($result['hasactiveconditions']);
+        $this->assertNotEmpty($result['activeconditionsform']);
+
+        // Re-create the report instance, we should get an empty array back.
+        $secondinstance = manager::get_report_from_persistent($report->read());
+        $this->assertEquals([], $secondinstance->get_condition_values());
+    }
+
+    /**
+     * Test execute method for a user without permission to edit reports
+     */
+    public function test_execute_access_exception(): void {
+        $this->resetAfterTest();
+
+        /** @var core_reportbuilder_generator $generator */
+        $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
+        $report = $generator->create_report(['name' => 'My report', 'source' => users::class]);
+
+        $user = $this->getDataGenerator()->create_user();
+        $this->setUser($user);
+
+        $this->expectException(report_access_exception::class);
+        $this->expectExceptionMessage('You cannot edit this report');
+        reset::execute($report->get('id'));
+    }
+}