[Summary view]

   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 count distinct aggregation
  32   *
  33   * @package     core_reportbuilder
  34   * @covers      \core_reportbuilder\local\aggregation\base
  35   * @covers      \core_reportbuilder\local\aggregation\countdistinct
  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 countdistinct_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' => 'Apple']);
  49          $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Banana']);
  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' => countdistinct::get_class_name(),
  64          ]);
  65  
  66          $content = $this->get_custom_report_content($report->get('id'));
  67          $this->assertEquals([
  68              [
  69                  'c0_firstname' => 'Admin',
  70                  'c1_lastname' => 1,
  71              ],
  72              [
  73                  'c0_firstname' => 'Bob',
  74                  'c1_lastname' => 2,
  75              ],
  76          ], $content);
  77      }
  78  
  79      /**
  80       * Test aggregation when applied to column with multiple fields
  81       */
  82      public function test_column_aggregation_multiple_fields(): void {
  83          $this->resetAfterTest();
  84  
  85          // Create a user with the same firstname as existing admin.
  86          $this->getDataGenerator()->create_user(['firstname' => 'Admin', 'lastname' => 'Test']);
  87  
  88          /** @var core_reportbuilder_generator $generator */
  89          $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
  90          $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]);
  91  
  92          // This is the column we'll aggregate.
  93          $generator->create_column([
  94              'reportid' => $report->get('id'),
  95              'uniqueidentifier' => 'user:fullname',
  96              'aggregation' => countdistinct::get_class_name(),
  97          ]);
  98  
  99          $content = $this->get_custom_report_content($report->get('id'));
 100          $this->assertCount(1, $content);
 101  
 102          // There are two distinct fullnames ("Admin User" & "Admin Test").
 103          $countdistinct = reset($content[0]);
 104          $this->assertEquals(2, $countdistinct);
 105      }
 106  }