Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?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_comment\reportbuilder\datasource;

< use comment;
use context_course;
> use core_comment_generator;
use core_reportbuilder_generator; use core_reportbuilder_testcase; use core_reportbuilder\local\filters\{date, text}; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/helpers.php"); /** * Unit tests for comments datasource * * @package core_comment * @covers \core_comment\reportbuilder\datasource\comments * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class comments_test extends core_reportbuilder_testcase { /**
< * Require test libraries < */ < public static function setUpBeforeClass(): void { < global $CFG; < require_once("{$CFG->dirroot}/comment/lib.php"); < } < < /**
* Test default datasource */ public function test_datasource_default(): void { $this->resetAfterTest(); $this->setAdminUser(); $course = $this->getDataGenerator()->create_course(); $coursecontext = context_course::instance($course->id);
< $comment = new comment((object) [
> /** @var core_comment_generator $generator */ > $generator = $this->getDataGenerator()->get_plugin_generator('core_comment'); > $generator->create_comment([
'context' => $coursecontext, 'component' => 'block_comments', 'area' => 'page_comments',
> 'content' => 'Cool',
]);
< $comment->add('Cool');
/** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Blogs', 'source' => comments::class, 'default' => 1]); $content = $this->get_custom_report_content($report->get('id')); $this->assertCount(1, $content); // Default columns are context, content, user, time created. [$contextname, $content, $userfullname, $timecreated] = array_values($content[0]); $this->assertEquals($coursecontext->get_context_name(), $contextname); $this->assertEquals(format_text('Cool'), $content); $this->assertEquals(fullname(get_admin()), $userfullname); $this->assertNotEmpty($timecreated); } /** * Test datasource columns that aren't added by default */ public function test_datasource_non_default_columns(): void { $this->resetAfterTest(); $this->setAdminUser(); $course = $this->getDataGenerator()->create_course(); $courseurl = course_get_url($course); $coursecontext = context_course::instance($course->id);
< $comment = new comment((object) [
> /** @var core_comment_generator $generator */ > $generator = $this->getDataGenerator()->get_plugin_generator('core_comment'); > $generator->create_comment([
'context' => $coursecontext, 'component' => 'block_comments', 'area' => 'page_comments',
> 'content' => 'Cool',
]);
< $comment->add('Cool');
/** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Blogs', 'source' => comments::class, 'default' => 0]); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'comment:contexturl']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'comment:component']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'comment:area']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'comment:itemid']); $content = $this->get_custom_report_content($report->get('id')); $this->assertCount(1, $content); $this->assertEquals([ "<a href=\"{$courseurl}\">{$coursecontext->get_context_name()}</a>", 'block_comments', 'page_comments', 0, ], array_values($content[0])); } /** * Data provider for {@see test_datasource_filters} * * @return array[] */ public function datasource_filters_provider(): array { return [ // Comment. 'Filter content' => ['comment:content', [ 'comment:content_operator' => text::CONTAINS, 'comment:content_value' => 'Cool', ], true], 'Filter content (no match)' => ['comment:content', [ 'comment:content_operator' => text::IS_EQUAL_TO, 'comment:content_value' => 'Beans', ], false], 'Filter time created' => ['comment:timecreated', [ 'comment:timecreated_operator' => date::DATE_RANGE, 'comment:timecreated_from' => 1622502000, ], true], 'Filter time created (no match)' => ['comment:timecreated', [ 'comment:timecreated_operator' => date::DATE_RANGE, 'comment:timecreated_to' => 1622502000, ], false], // User (just to check the join). 'Filter user' => ['user:username', [ 'user:username_operator' => text::IS_EQUAL_TO, 'user:username_value' => 'admin', ], true], 'Filter user (no match)' => ['user:username', [ 'user:username_operator' => text::IS_EQUAL_TO, 'user:username_value' => 'lionel', ], false], ]; } /** * Test datasource filters * * @param string $filtername * @param array $filtervalues * @param bool $expectmatch * * @dataProvider datasource_filters_provider */ public function test_datasource_filters( string $filtername, array $filtervalues, bool $expectmatch ): void { $this->resetAfterTest(); $this->setAdminUser(); $course = $this->getDataGenerator()->create_course(); $coursecontext = context_course::instance($course->id);
< $comment = new comment((object) [
> /** @var core_comment_generator $generator */ > $generator = $this->getDataGenerator()->get_plugin_generator('core_comment'); > $generator->create_comment([
'context' => $coursecontext, 'component' => 'block_comments', 'area' => 'page_comments',
> 'content' => 'Cool',
]);
< $comment->add('Cool');
/** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Create report containing single column, and given filter. $report = $generator->create_report(['name' => 'Tasks', 'source' => comments::class, 'default' => 0]); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'comment:component']); // 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) { $this->assertCount(1, $content); $this->assertEquals('block_comments', reset($content[0])); } else { $this->assertEmpty($content); } } /** * Stress test datasource * * In order to execute this test PHPUNIT_LONGTEST should be defined as true in phpunit.xml or directly in config.php */ public function test_stress_datasource(): void { if (!PHPUNIT_LONGTEST) { $this->markTestSkipped('PHPUNIT_LONGTEST is not defined'); } $this->resetAfterTest(); $this->setAdminUser(); $course = $this->getDataGenerator()->create_course(); $coursecontext = context_course::instance($course->id);
< $comment = new comment((object) [
> /** @var core_comment_generator $generator */ > $generator = $this->getDataGenerator()->get_plugin_generator('core_comment'); > $generator->create_comment([
'context' => $coursecontext, 'component' => 'block_comments', 'area' => 'page_comments',
> 'content' => 'Cool',
]);
< $comment->add('Cool');
$this->datasource_stress_test_columns(comments::class); $this->datasource_stress_test_columns_aggregation(comments::class); $this->datasource_stress_test_conditions(comments::class, 'comment:component'); } }