You are here

public function EntityQueryAggregateTest::testAggregation in Drupal 8

Same name and namespace in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Entity/EntityQueryAggregateTest.php \Drupal\KernelTests\Core\Entity\EntityQueryAggregateTest::testAggregation()

Test aggregation support.

File

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

Class

EntityQueryAggregateTest
Tests the Entity Query Aggregation API.

Namespace

Drupal\KernelTests\Core\Entity

Code

public function testAggregation() {

  // Apply a simple groupby.
  $this->queryResult = $this->entityStorage
    ->getAggregateQuery()
    ->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) {
    $this->queryResult = $this->entityStorage
      ->getAggregateQuery()
      ->aggregate('id', $aggregation_function)
      ->execute();
    $this
      ->assertEqual($this->queryResult, $expected);
  }

  // Apply aggregation and groupby on the same query.
  $this->queryResult = $this->entityStorage
    ->getAggregateQuery()
    ->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()
    ->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()
    ->groupBy('id')
    ->conditionAggregate('id', 'COUNT', 8)
    ->execute();
  $this
    ->assertResults([]);

  // Apply aggregation and a condition which matches.
  $this->queryResult = $this->entityStorage
    ->getAggregateQuery()
    ->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()
    ->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()
    ->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()
    ->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()
    ->sortAggregate('id', 'COUNT')
    ->execute();
  $this
    ->assertSortedResults([
    [
      'id_count' => 6,
    ],
  ]);

  // Apply aggregation, groupby and a sort descending.
  $this->queryResult = $this->entityStorage
    ->getAggregateQuery()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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')
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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()
    ->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,
    ],
  ]);

  // Groupby and aggregate by fieldapi field, and sort by the aggregated
  // field.
  $this->queryResult = $this->entityStorage
    ->getAggregateQuery()
    ->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()
    ->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,
    ],
  ]);
}