[Summary view]

Differences Between: [Versions 400 and 401] [Versions 400 and 402] [Versions 400 and 403]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  declare(strict_types=1);
  18  
  19  namespace core_reportbuilder\local\aggregation;
  20  
  21  use core_reportbuilder_testcase;
  22  use core_reportbuilder_generator;
  23  use core_user\reportbuilder\datasource\users;
  24  
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  global $CFG;
  28  require_once("{$CFG->dirroot}/reportbuilder/tests/helpers.php");
  29  
  30  /**
  31   * Unit tests for group concatenation aggregation
  32   *
  33   * @package     core_reportbuilder
  34   * @covers      \core_reportbuilder\local\aggregation\base
  35   * @covers      \core_reportbuilder\local\aggregation\groupconcat
  36   * @copyright   2021 Paul Holden <paulh@moodle.com>
  37   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  38   */
  39  class groupconcat_test extends core_reportbuilder_testcase {
  40  
  41      /**
  42       * Test aggregation when applied to column
  43       */
  44      public function test_column_aggregation(): void {
  45          $this->resetAfterTest();
  46  
  47          // Test subjects.
  48          $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Banana']);
  49          $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Apple']);
  50          $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Banana']);
  51  
  52          /** @var core_reportbuilder_generator $generator */
  53          $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
  54          $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]);
  55  
  56          // First column, sorted.
  57          $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname', 'sortenabled' => 1]);
  58  
  59          // This is the column we'll aggregate.
  60          $generator->create_column([
  61              'reportid' => $report->get('id'),
  62              'uniqueidentifier' => 'user:lastname',
  63              'aggregation' => groupconcat::get_class_name(),
  64          ]);
  65  
  66          // Assert lastname column was aggregated, and sorted predictably.
  67          $content = $this->get_custom_report_content($report->get('id'));
  68          $this->assertEquals([
  69              [
  70                  'c0_firstname' => 'Admin',
  71                  'c1_lastname' => 'User',
  72              ],
  73              [
  74                  'c0_firstname' => 'Bob',
  75                  'c1_lastname' => 'Apple, Banana, Banana',
  76              ],
  77          ], $content);
  78      }
  79  
  80      /**
  81       * Test aggregation when applied to column with callback
  82       */
  83      public function test_column_aggregation_with_callback(): void {
  84          $this->resetAfterTest();
  85  
  86          // Test subjects.
  87          $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'confirmed' => 1]);
  88          $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'confirmed' => 0]);
  89          $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'confirmed' => 1]);
  90  
  91          /** @var core_reportbuilder_generator $generator */
  92          $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
  93          $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]);
  94  
  95          // First column, sorted.
  96          $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname', 'sortenabled' => 1]);
  97  
  98          // This is the column we'll aggregate.
  99          $generator->create_column([
 100              'reportid' => $report->get('id'),
 101              'uniqueidentifier' => 'user:confirmed',
 102              'aggregation' => groupconcat::get_class_name(),
 103          ]);
 104  
 105          // Assert confirmed column was aggregated, and sorted predictably with callback applied.
 106          $content = $this->get_custom_report_content($report->get('id'));
 107          $this->assertEquals([
 108              [
 109                  'c0_firstname' => 'Admin',
 110                  'c1_confirmed' => 'Yes',
 111              ],
 112              [
 113                  'c0_firstname' => 'Bob',
 114                  'c1_confirmed' => 'No, Yes, Yes',
 115              ],
 116          ], $content);
 117      }
 118  }