class EntityQueryAggregateTest in Drupal 9

Same name and namespace in other branches

8 core/tests/Drupal/KernelTests/Core/Entity/EntityQueryAggregateTest.php \Drupal\KernelTests\Core\Entity\EntityQueryAggregateTest

Tests the Entity Query Aggregation API.

@group Entity

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase uses UserCreationTrait
  - class \Drupal\KernelTests\Core\Entity\EntityQueryAggregateTest

Expanded class hierarchy of EntityQueryAggregateTest

File

core/tests/Drupal/KernelTests/Core/Entity/EntityQueryAggregateTest.php, line 14

Namespace

Drupal\KernelTests\Core\Entity

View source

class EntityQueryAggregateTest extends EntityKernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [];

  /**
   * The entity_test storage to create the test entities.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $entityStorage;

  /**
   * The actual query result, to compare later.
   *
   * @var array
   */
  protected $queryResult;
  protected function setUp() : void {
    parent::setUp();
    $this->entityStorage = $this->entityTypeManager
      ->getStorage('entity_test');

    // Add some fieldapi fields to be used in the test.
    for ($i = 1; $i <= 2; $i++) {
      $field_name = 'field_test_' . $i;
      FieldStorageConfig::create([
        'field_name' => $field_name,
        'entity_type' => 'entity_test',
        'type' => 'integer',
        'cardinality' => 2,
      ])
        ->save();
      FieldConfig::create([
        'field_name' => $field_name,
        'entity_type' => 'entity_test',
        'bundle' => 'entity_test',
      ])
        ->save();
    }
    $entity = $this->entityStorage
      ->create([
      'id' => 1,
      'user_id' => 1,
      'field_test_1' => 1,
      'field_test_2' => 2,
    ]);
    $entity
      ->enforceIsNew();
    $entity
      ->save();
    $entity = $this->entityStorage
      ->create([
      'id' => 2,
      'user_id' => 2,
      'field_test_1' => 1,
      'field_test_2' => 7,
    ]);
    $entity
      ->enforceIsNew();
    $entity
      ->save();
    $entity = $this->entityStorage
      ->create([
      'id' => 3,
      'user_id' => 2,
      'field_test_1' => 2,
      'field_test_2' => 1,
    ]);
    $entity
      ->enforceIsNew();
    $entity
      ->save();
    $entity = $this->entityStorage
      ->create([
      'id' => 4,
      'user_id' => 2,
      'field_test_1' => 2,
      'field_test_2' => 8,
    ]);
    $entity
      ->enforceIsNew();
    $entity
      ->save();
    $entity = $this->entityStorage
      ->create([
      'id' => 5,
      'user_id' => 3,
      'field_test_1' => 2,
      'field_test_2' => 2,
    ]);
    $entity
      ->enforceIsNew();
    $entity
      ->save();
    $entity = $this->entityStorage
      ->create([
      'id' => 6,
      'user_id' => 3,
      'field_test_1' => 3,
      'field_test_2' => 8,
    ]);
    $entity
      ->enforceIsNew();
    $entity
      ->save();
  }

  /**
   * Tests aggregation support.
   */
  public function testAggregation() {

    // Apply a simple groupby.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->groupBy('user_id')
      ->execute();
    $this
      ->assertResults([
      [
        'user_id' => 1,
      ],
      [
        'user_id' => 2,
      ],
      [
        'user_id' => 3,
      ],
    ]);
    $function_expected = [];
    $function_expected['count'] = [
      [
        'id_count' => 6,
      ],
    ];
    $function_expected['min'] = [
      [
        'id_min' => 1,
      ],
    ];
    $function_expected['max'] = [
      [
        'id_max' => 6,
      ],
    ];
    $function_expected['sum'] = [
      [
        'id_sum' => 21,
      ],
    ];
    $function_expected['avg'] = [
      [
        'id_avg' => 21.0 / 6.0,
      ],
    ];

    // Apply a simple aggregation for different aggregation functions.
    foreach ($function_expected as $aggregation_function => $expected) {
      $query = $this->entityStorage
        ->getAggregateQuery()
        ->accessCheck(FALSE)
        ->aggregate('id', $aggregation_function);
      $this->queryResult = $query
        ->execute();

      // We need to check that a character exists before and after the table,
      // column and alias identifiers. These would be the quote characters
      // specific for each database system.
      $this
        ->assertMatchesRegularExpression('/' . $aggregation_function . '\\(.entity_test.\\..id.\\) AS .id_' . $aggregation_function . './', (string) $query, 'The argument to the aggregation function should be a quoted field.');
      $this
        ->assertEquals($expected, $this->queryResult);
    }

    // Apply aggregation and groupby on the same query.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('id', 'COUNT')
      ->groupBy('user_id')
      ->execute();
    $this
      ->assertResults([
      [
        'user_id' => 1,
        'id_count' => 1,
      ],
      [
        'user_id' => 2,
        'id_count' => 3,
      ],
      [
        'user_id' => 3,
        'id_count' => 2,
      ],
    ]);

    // Apply aggregation and a condition which matches.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('id', 'COUNT')
      ->groupBy('id')
      ->conditionAggregate('id', 'COUNT', 8)
      ->execute();
    $this
      ->assertResults([]);

    // Don't call aggregate to test the implicit aggregate call.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->groupBy('id')
      ->conditionAggregate('id', 'COUNT', 8)
      ->execute();
    $this
      ->assertResults([]);

    // Apply aggregation and a condition which matches.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('id', 'count')
      ->groupBy('id')
      ->conditionAggregate('id', 'COUNT', 6)
      ->execute();
    $this
      ->assertResults([
      [
        'id_count' => 6,
      ],
    ]);

    // Apply aggregation, a groupby and a condition which matches partially via
    // the operator '='.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('id', 'count')
      ->conditionAggregate('id', 'count', 2)
      ->groupBy('user_id')
      ->execute();
    $this
      ->assertResults([
      [
        'id_count' => 2,
        'user_id' => 3,
      ],
    ]);

    // Apply aggregation, a groupby and a condition which matches partially via
    // the operator '>'.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('id', 'count')
      ->conditionAggregate('id', 'COUNT', 1, '>')
      ->groupBy('user_id')
      ->execute();
    $this
      ->assertResults([
      [
        'id_count' => 2,
        'user_id' => 3,
      ],
      [
        'id_count' => 3,
        'user_id' => 2,
      ],
    ]);

    // Apply aggregation and a sort. This might not be useful, but have a proper
    // test coverage.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('id', 'COUNT')
      ->sortAggregate('id', 'COUNT')
      ->execute();
    $this
      ->assertSortedResults([
      [
        'id_count' => 6,
      ],
    ]);

    // Don't call aggregate to test the implicit aggregate call.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->sortAggregate('id', 'COUNT')
      ->execute();
    $this
      ->assertSortedResults([
      [
        'id_count' => 6,
      ],
    ]);

    // Apply aggregation, groupby and a sort descending.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('id', 'COUNT')
      ->groupBy('user_id')
      ->sortAggregate('id', 'COUNT', 'DESC')
      ->execute();
    $this
      ->assertSortedResults([
      [
        'user_id' => 2,
        'id_count' => 3,
      ],
      [
        'user_id' => 3,
        'id_count' => 2,
      ],
      [
        'user_id' => 1,
        'id_count' => 1,
      ],
    ]);

    // Apply aggregation, groupby and a sort ascending.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('id', 'COUNT')
      ->groupBy('user_id')
      ->sortAggregate('id', 'COUNT', 'ASC')
      ->execute();
    $this
      ->assertSortedResults([
      [
        'user_id' => 1,
        'id_count' => 1,
      ],
      [
        'user_id' => 3,
        'id_count' => 2,
      ],
      [
        'user_id' => 2,
        'id_count' => 3,
      ],
    ]);

    // Apply aggregation, groupby, an aggregation condition and a sort with the
    // operator '='.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('id', 'COUNT')
      ->groupBy('user_id')
      ->sortAggregate('id', 'COUNT')
      ->conditionAggregate('id', 'COUNT', 2)
      ->execute();
    $this
      ->assertSortedResults([
      [
        'id_count' => 2,
        'user_id' => 3,
      ],
    ]);

    // Apply aggregation, groupby, an aggregation condition and a sort with the
    // operator '<' and order ASC.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('id', 'COUNT')
      ->groupBy('user_id')
      ->sortAggregate('id', 'COUNT', 'ASC')
      ->conditionAggregate('id', 'COUNT', 3, '<')
      ->execute();
    $this
      ->assertSortedResults([
      [
        'id_count' => 1,
        'user_id' => 1,
      ],
      [
        'id_count' => 2,
        'user_id' => 3,
      ],
    ]);

    // Apply aggregation, groupby, an aggregation condition and a sort with the
    // operator '<' and order DESC.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('id', 'COUNT')
      ->groupBy('user_id')
      ->sortAggregate('id', 'COUNT', 'DESC')
      ->conditionAggregate('id', 'COUNT', 3, '<')
      ->execute();
    $this
      ->assertSortedResults([
      [
        'id_count' => 2,
        'user_id' => 3,
      ],
      [
        'id_count' => 1,
        'user_id' => 1,
      ],
    ]);

    // Test aggregation/groupby support for fieldapi fields.
    // Just group by a fieldapi field.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->groupBy('field_test_1')
      ->execute();
    $this
      ->assertResults([
      [
        'field_test_1' => 1,
      ],
      [
        'field_test_1' => 2,
      ],
      [
        'field_test_1' => 3,
      ],
    ]);

    // Group by a fieldapi field and aggregate a normal property.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('user_id', 'COUNT')
      ->groupBy('field_test_1')
      ->execute();
    $this
      ->assertResults([
      [
        'field_test_1' => 1,
        'user_id_count' => 2,
      ],
      [
        'field_test_1' => 2,
        'user_id_count' => 3,
      ],
      [
        'field_test_1' => 3,
        'user_id_count' => 1,
      ],
    ]);

    // Group by a normal property and aggregate a fieldapi field.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('field_test_1', 'COUNT')
      ->groupBy('user_id')
      ->execute();
    $this
      ->assertResults([
      [
        'user_id' => 1,
        'field_test_1_count' => 1,
      ],
      [
        'user_id' => 2,
        'field_test_1_count' => 3,
      ],
      [
        'user_id' => 3,
        'field_test_1_count' => 2,
      ],
    ]);
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('field_test_1', 'SUM')
      ->groupBy('user_id')
      ->execute();
    $this
      ->assertResults([
      [
        'user_id' => 1,
        'field_test_1_sum' => 1,
      ],
      [
        'user_id' => 2,
        'field_test_1_sum' => 5,
      ],
      [
        'user_id' => 3,
        'field_test_1_sum' => 5,
      ],
    ]);

    // Aggregate by two different fieldapi fields.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('field_test_1', 'SUM')
      ->aggregate('field_test_2', 'SUM')
      ->groupBy('user_id')
      ->execute();
    $this
      ->assertResults([
      [
        'user_id' => 1,
        'field_test_1_sum' => 1,
        'field_test_2_sum' => 2,
      ],
      [
        'user_id' => 2,
        'field_test_1_sum' => 5,
        'field_test_2_sum' => 16,
      ],
      [
        'user_id' => 3,
        'field_test_1_sum' => 5,
        'field_test_2_sum' => 10,
      ],
    ]);

    // This time aggregate the same field twice.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('field_test_1', 'SUM')
      ->aggregate('field_test_1', 'COUNT')
      ->groupBy('user_id')
      ->execute();
    $this
      ->assertResults([
      [
        'user_id' => 1,
        'field_test_1_sum' => 1,
        'field_test_1_count' => 1,
      ],
      [
        'user_id' => 2,
        'field_test_1_sum' => 5,
        'field_test_1_count' => 3,
      ],
      [
        'user_id' => 3,
        'field_test_1_sum' => 5,
        'field_test_1_count' => 2,
      ],
    ]);

    // Group by and aggregate by a fieldapi field.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->groupBy('field_test_1')
      ->aggregate('field_test_2', 'COUNT')
      ->execute();
    $this
      ->assertResults([
      [
        'field_test_1' => 1,
        'field_test_2_count' => 2,
      ],
      [
        'field_test_1' => 2,
        'field_test_2_count' => 3,
      ],
      [
        'field_test_1' => 3,
        'field_test_2_count' => 1,
      ],
    ]);

    // Group by and aggregate by a fieldapi field and use multiple aggregate
    // functions.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->groupBy('field_test_1')
      ->aggregate('field_test_2', 'COUNT')
      ->aggregate('field_test_2', 'SUM')
      ->execute();
    $this
      ->assertResults([
      [
        'field_test_1' => 1,
        'field_test_2_count' => 2,
        'field_test_2_sum' => 9,
      ],
      [
        'field_test_1' => 2,
        'field_test_2_count' => 3,
        'field_test_2_sum' => 11,
      ],
      [
        'field_test_1' => 3,
        'field_test_2_count' => 1,
        'field_test_2_sum' => 8,
      ],
    ]);

    // Apply an aggregate condition for a fieldapi field and group by a simple
    // property.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->conditionAggregate('field_test_1', 'COUNT', 3)
      ->groupBy('user_id')
      ->execute();
    $this
      ->assertResults([
      [
        'user_id' => 2,
        'field_test_1_count' => 3,
      ],
      [
        'user_id' => 3,
        'field_test_1_count' => 2,
      ],
    ]);
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('field_test_1', 'SUM')
      ->conditionAggregate('field_test_1', 'COUNT', 2, '>')
      ->groupBy('user_id')
      ->execute();
    $this
      ->assertResults([
      [
        'user_id' => 2,
        'field_test_1_sum' => 5,
        'field_test_1_count' => 3,
      ],
      [
        'user_id' => 3,
        'field_test_1_sum' => 5,
        'field_test_1_count' => 2,
      ],
    ]);

    // Apply an aggregate condition for a simple property and a group by a
    // fieldapi field.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->conditionAggregate('user_id', 'COUNT', 2)
      ->groupBy('field_test_1')
      ->execute();
    $this
      ->assertResults([
      [
        'field_test_1' => 1,
        'user_id_count' => 2,
      ],
    ]);
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->conditionAggregate('user_id', 'COUNT', 2, '>')
      ->groupBy('field_test_1')
      ->execute();
    $this
      ->assertResults([
      [
        'field_test_1' => 1,
        'user_id_count' => 2,
      ],
      [
        'field_test_1' => 2,
        'user_id_count' => 3,
      ],
    ]);

    // Apply an aggregate condition and a group by fieldapi fields.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->groupBy('field_test_1')
      ->conditionAggregate('field_test_2', 'COUNT', 2)
      ->execute();
    $this
      ->assertResults([
      [
        'field_test_1' => 1,
        'field_test_2_count' => 2,
      ],
    ]);
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->groupBy('field_test_1')
      ->conditionAggregate('field_test_2', 'COUNT', 2, '>')
      ->execute();
    $this
      ->assertResults([
      [
        'field_test_1' => 1,
        'field_test_2_count' => 2,
      ],
      [
        'field_test_1' => 2,
        'field_test_2_count' => 3,
      ],
    ]);

    // Apply an aggregate condition and a group by fieldapi fields with multiple
    // conditions via AND.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->groupBy('field_test_1')
      ->conditionAggregate('field_test_2', 'COUNT', 2)
      ->conditionAggregate('field_test_2', 'SUM', 8)
      ->execute();
    $this
      ->assertResults([]);

    // Apply an aggregate condition and a group by fieldapi fields with multiple
    // conditions via OR.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery('OR')
      ->accessCheck(FALSE)
      ->groupBy('field_test_1')
      ->conditionAggregate('field_test_2', 'COUNT', 2)
      ->conditionAggregate('field_test_2', 'SUM', 8)
      ->execute();
    $this
      ->assertResults([
      [
        'field_test_1' => 1,
        'field_test_2_count' => 2,
        'field_test_2_sum' => 9,
      ],
      [
        'field_test_1' => 3,
        'field_test_2_count' => 1,
        'field_test_2_sum' => 8,
      ],
    ]);

    // Group by a normal property and aggregate a fieldapi field and sort by the
    // groupby field.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('field_test_1', 'COUNT')
      ->groupBy('user_id')
      ->sort('user_id', 'DESC')
      ->execute();
    $this
      ->assertSortedResults([
      [
        'user_id' => 3,
        'field_test_1_count' => 2,
      ],
      [
        'user_id' => 2,
        'field_test_1_count' => 3,
      ],
      [
        'user_id' => 1,
        'field_test_1_count' => 1,
      ],
    ]);
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->aggregate('field_test_1', 'COUNT')
      ->groupBy('user_id')
      ->sort('user_id', 'ASC')
      ->execute();
    $this
      ->assertSortedResults([
      [
        'user_id' => 1,
        'field_test_1_count' => 1,
      ],
      [
        'user_id' => 2,
        'field_test_1_count' => 3,
      ],
      [
        'user_id' => 3,
        'field_test_1_count' => 2,
      ],
    ]);
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->conditionAggregate('field_test_1', 'COUNT', 2, '>')
      ->groupBy('user_id')
      ->sort('user_id', 'ASC')
      ->execute();
    $this
      ->assertSortedResults([
      [
        'user_id' => 2,
        'field_test_1_count' => 3,
      ],
      [
        'user_id' => 3,
        'field_test_1_count' => 2,
      ],
    ]);

    // Group by a normal property, aggregate a fieldapi field, and sort by the
    // aggregated field.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->sortAggregate('field_test_1', 'COUNT', 'DESC')
      ->groupBy('user_id')
      ->execute();
    $this
      ->assertSortedResults([
      [
        'user_id' => 2,
        'field_test_1_count' => 3,
      ],
      [
        'user_id' => 3,
        'field_test_1_count' => 2,
      ],
      [
        'user_id' => 1,
        'field_test_1_count' => 1,
      ],
    ]);
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->sortAggregate('field_test_1', 'COUNT', 'ASC')
      ->groupBy('user_id')
      ->execute();
    $this
      ->assertSortedResults([
      [
        'user_id' => 1,
        'field_test_1_count' => 1,
      ],
      [
        'user_id' => 3,
        'field_test_1_count' => 2,
      ],
      [
        'user_id' => 2,
        'field_test_1_count' => 3,
      ],
    ]);

    // Group by and aggregate by fieldapi field, and sort by the groupby field.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->groupBy('field_test_1')
      ->aggregate('field_test_2', 'COUNT')
      ->sort('field_test_1', 'ASC')
      ->execute();
    $this
      ->assertSortedResults([
      [
        'field_test_1' => 1,
        'field_test_2_count' => 2,
      ],
      [
        'field_test_1' => 2,
        'field_test_2_count' => 3,
      ],
      [
        'field_test_1' => 3,
        'field_test_2_count' => 1,
      ],
    ]);
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->groupBy('field_test_1')
      ->aggregate('field_test_2', 'COUNT')
      ->sort('field_test_1', 'DESC')
      ->execute();
    $this
      ->assertSortedResults([
      [
        'field_test_1' => 3,
        'field_test_2_count' => 1,
      ],
      [
        'field_test_1' => 2,
        'field_test_2_count' => 3,
      ],
      [
        'field_test_1' => 1,
        'field_test_2_count' => 2,
      ],
    ]);

    // Group by and aggregate by Field API field, and sort by the aggregated
    // field.
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->groupBy('field_test_1')
      ->sortAggregate('field_test_2', 'COUNT', 'DESC')
      ->execute();
    $this
      ->assertSortedResults([
      [
        'field_test_1' => 2,
        'field_test_2_count' => 3,
      ],
      [
        'field_test_1' => 1,
        'field_test_2_count' => 2,
      ],
      [
        'field_test_1' => 3,
        'field_test_2_count' => 1,
      ],
    ]);
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->groupBy('field_test_1')
      ->sortAggregate('field_test_2', 'COUNT', 'ASC')
      ->execute();
    $this
      ->assertSortedResults([
      [
        'field_test_1' => 3,
        'field_test_2_count' => 1,
      ],
      [
        'field_test_1' => 1,
        'field_test_2_count' => 2,
      ],
      [
        'field_test_1' => 2,
        'field_test_2_count' => 3,
      ],
    ]);
  }

  /**
   * Tests preparing a query and executing twice.
   */
  public function testRepeatedExecution() {
    $query = $this->entityStorage
      ->getAggregateQuery()
      ->accessCheck(FALSE)
      ->groupBy('user_id');
    $this->queryResult = $query
      ->execute();
    $this
      ->assertResults([
      [
        'user_id' => 1,
      ],
      [
        'user_id' => 2,
      ],
      [
        'user_id' => 3,
      ],
    ]);
    $entity = $this->entityStorage
      ->create([
      'id' => 7,
      'user_id' => 4,
      'field_test_1' => 42,
      'field_test_2' => 68,
    ]);
    $entity
      ->enforceIsNew();
    $entity
      ->save();
    $this->queryResult = $query
      ->execute();
    $this
      ->assertResults([
      [
        'user_id' => 1,
      ],
      [
        'user_id' => 2,
      ],
      [
        'user_id' => 3,
      ],
      [
        'user_id' => 4,
      ],
    ]);
  }

  /**
   * Asserts the results as expected regardless of order between and in rows.
   *
   * @param array $expected
   *   An array of the expected results.
   * @param bool $sorted
   */
  protected function assertResults($expected, $sorted = FALSE) {
    $found = TRUE;
    $expected_keys = array_keys($expected);
    foreach ($this->queryResult as $key => $row) {
      $keys = $sorted ? [
        $key,
      ] : $expected_keys;
      foreach ($keys as $key) {
        $expected_row = $expected[$key];
        if (!array_diff_assoc($row, $expected_row) && !array_diff_assoc($expected_row, $row)) {
          continue 2;
        }
      }
      $found = FALSE;
      break;
    }
    $this
      ->assertTrue($found, strtr('!expected expected, !found found', [
      '!expected' => print_r($expected, TRUE),
      '!found' => print_r($this->queryResult, TRUE),
    ]));
  }

  /**
   * Asserts the results as expected regardless of order in rows.
   *
   * @param array $expected
   *   An array of the expected results.
   */
  protected function assertSortedResults($expected) {
    return $this
      ->assertResults($expected, TRUE);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertContentTrait::$content	protected	property	The current raw content.
AssertContentTrait::$drupalSettings	protected	property	The drupalSettings value from the current raw $content.
AssertContentTrait::$elements	protected	property	The XML structure parsed from the current raw $content.	1
AssertContentTrait::$plainTextContent	protected	property	The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds	protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped	protected	function	Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion	protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption	protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected	protected	function	Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern	protected	function	Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw	protected	function	Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle	protected	function	Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText	protected	function	Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern	protected	function	Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput	protected	function	Asserts themed output.
AssertContentTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertContentTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper	protected	function	Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertContentTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings	protected	function	Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent	protected	function	Gets the current raw content.
AssertContentTrait::getSelectedItem	protected	function	Get the selected value from a select field.
AssertContentTrait::getTextContent	protected	function	Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl	protected	function	Get the current URL from the cURL handler.	1
AssertContentTrait::parse	protected	function	Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace	protected	function	Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings	protected	function	Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent	protected	function	Sets the raw content (e.g. HTML).
AssertContentTrait::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	protected	function
ConfigTestTrait::configImporter	protected	function	Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig	protected	function	Copies configuration objects from source storage to target storage.
EntityKernelTestBase::$entityTypeManager	protected	property	The entity type manager service.	1
EntityKernelTestBase::$generatedIds	protected	property	A list of generated identifiers.
EntityKernelTestBase::$state	protected	property	The state service.
EntityKernelTestBase::createUser	protected	function	Creates a user.
EntityKernelTestBase::generateRandomEntityId	protected	function	Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo	protected	function	Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule	protected	function	Installs a module and refreshes services.
EntityKernelTestBase::refreshServices	protected	function	Refresh services.	1
EntityKernelTestBase::reloadEntity	protected	function	Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule	protected	function	Uninstalls a module and refreshes services.
EntityQueryAggregateTest::$entityStorage	protected	property	The entity_test storage to create the test entities.
EntityQueryAggregateTest::$modules	protected static	property	Modules to enable. Overrides EntityKernelTestBase::$modules
EntityQueryAggregateTest::$queryResult	protected	property	The actual query result, to compare later.
EntityQueryAggregateTest::assertResults	protected	function	Asserts the results as expected regardless of order between and in rows.
EntityQueryAggregateTest::assertSortedResults	protected	function	Asserts the results as expected regardless of order in rows.
EntityQueryAggregateTest::setUp	protected	function	Overrides EntityKernelTestBase::setUp
EntityQueryAggregateTest::testAggregation	public	function	Tests aggregation support.
EntityQueryAggregateTest::testRepeatedExecution	public	function	Tests preparing a query and executing twice.
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
KernelTestBase::$backupGlobals	protected	property	Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes	protected	property	Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist	protected	property	Contains a few static class properties for performance.
KernelTestBase::$classLoader	protected	property
KernelTestBase::$configImporter	protected	property	@todo Move into Config test base class.	7
KernelTestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container	protected	property
KernelTestBase::$databasePrefix	protected	property
KernelTestBase::$preserveGlobalState	protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root	protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess	protected	property	Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory	protected	property
KernelTestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	6
KernelTestBase::$vfsRoot	protected	property	The virtual filesystem root directory.
KernelTestBase::assertPostConditions	protected	function		1
KernelTestBase::bootEnvironment	protected	function	Bootstraps a basic test environment.
KernelTestBase::bootKernel	private	function	Bootstraps a kernel for a test.
KernelTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo	protected	function	Returns the Database connection info to be used for this test.	3
KernelTestBase::getDatabasePrefix	public	function
KernelTestBase::getExtensionsForModules	private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable	private static	function	Returns the modules to enable for this test.
KernelTestBase::initFileCache	protected	function	Initializes the FileCache component.
KernelTestBase::installConfig	protected	function	Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema	protected	function	Installs the storage schema for a specific entity type.
KernelTestBase::installSchema	protected	function	Installs database tables from a module schema definition.
KernelTestBase::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	24
KernelTestBase::render	protected	function	Renders a render array.	1
KernelTestBase::setInstallProfile	protected	function	Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting	protected	function	Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass	public static	function		1
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	2
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		4
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
RandomGeneratorTrait::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName	protected	function	Generates a unique random string containing letters and numbers.	1
RandomGeneratorTrait::randomObject	public	function	Generates a random PHP object.
RandomGeneratorTrait::randomString	public	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.
UserCreationTrait::checkPermissions	protected	function	Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole	protected	function	Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole	protected	function	Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser	protected	function	Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions	protected	function	Grant permissions to a user role. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser	protected	function	Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser	protected	function	Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser

You are here

class EntityQueryAggregateTest in Drupal 9

Hierarchy

See also

File

Namespace

Members

API Navigation