class QueryGroupByTest in Drupal 8
Same name and namespace in other branches
- 9 core/modules/views/tests/src/Kernel/QueryGroupByTest.php \Drupal\Tests\views\Kernel\QueryGroupByTest
Tests aggregate functionality of views, for example count.
@group views
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\views\Kernel\ViewsKernelTestBase uses ViewResultAssertionTrait
- class \Drupal\Tests\views\Kernel\QueryGroupByTest
- class \Drupal\Tests\views\Kernel\ViewsKernelTestBase uses ViewResultAssertionTrait
Expanded class hierarchy of QueryGroupByTest
File
- core/
modules/ views/ tests/ src/ Kernel/ QueryGroupByTest.php, line 17
Namespace
Drupal\Tests\views\KernelView source
class QueryGroupByTest extends ViewsKernelTestBase {
/**
* Views used by this test.
*
* @var array
*/
public static $testViews = [
'test_group_by_in_filters',
'test_aggregate_count',
'test_group_by_count',
'test_group_by_count_multicardinality',
'test_group_by_field_not_within_bundle',
];
/**
* Modules to enable.
*
* @var array
*/
public static $modules = [
'entity_test',
'system',
'field',
'user',
'language',
];
/**
* The storage for the test entity type.
*
* @var \Drupal\Core\Entity\Sql\SqlContentEntityStorage
*/
public $storage;
/**
* {@inheritdoc}
*/
protected function setUp($import_test_views = TRUE) {
parent::setUp();
$this
->installEntitySchema('user');
$this
->installEntitySchema('entity_test');
$this
->installEntitySchema('entity_test_mul');
$this->storage = $this->container
->get('entity_type.manager')
->getStorage('entity_test');
ConfigurableLanguage::createFromLangcode('it')
->save();
}
/**
* Tests aggregate count feature.
*/
public function testAggregateCount() {
$this
->setupTestEntities();
$view = Views::getView('test_aggregate_count');
$this
->executeView($view);
$this
->assertCount(2, $view->result, 'Make sure the count of items is right.');
$types = [];
foreach ($view->result as $item) {
// num_records is a alias for id.
$types[$item->entity_test_name] = $item->num_records;
}
$this
->assertEqual($types['name1'], 4, 'Groupby the name: name1 returned the expected amount of results.');
$this
->assertEqual($types['name2'], 3, 'Groupby the name: name2 returned the expected amount of results.');
}
/**
* Provides a test helper which runs a view with some aggregation function.
*
* @param string|null $aggregation_function
* Which aggregation function should be used, for example sum or count. If
* NULL is passed the aggregation will be tested with no function.
* @param array $values
* The expected views result.
*/
public function groupByTestHelper($aggregation_function, $values) {
$this
->setupTestEntities();
$view = Views::getView('test_group_by_count');
$view
->setDisplay();
// There is no need for a function in order to have aggregation.
if (empty($aggregation_function)) {
// The test table has 2 fields ('id' and 'name'). We'll remove 'id'
// because it's unique and will test aggregation on 'name'.
unset($view->displayHandlers
->get('default')->options['fields']['id']);
}
else {
$view->displayHandlers
->get('default')->options['fields']['id']['group_type'] = $aggregation_function;
}
$this
->executeView($view);
$this
->assertCount(2, $view->result, 'Make sure the count of items is right.');
// Group by name to identify the right count.
$results = [];
foreach ($view->result as $item) {
$results[$item->entity_test_name] = $item->id;
}
$this
->assertEqual($results['name1'], $values[0], new FormattableMarkup('Aggregation with @aggregation_function and groupby name: name1 returned the expected amount of results', [
'@aggregation_function' => $aggregation_function,
]));
$this
->assertEqual($results['name2'], $values[1], new FormattableMarkup('Aggregation with @aggregation_function and groupby name: name2 returned the expected amount of results', [
'@aggregation_function' => $aggregation_function,
]));
}
/**
* Helper method that creates some test entities.
*/
protected function setupTestEntities() {
// Create 4 entities with name1 and 3 entities with name2.
$entity_1 = [
'name' => 'name1',
];
$this->storage
->create($entity_1)
->save();
$this->storage
->create($entity_1)
->save();
$this->storage
->create($entity_1)
->save();
$this->storage
->create($entity_1)
->save();
$entity_2 = [
'name' => 'name2',
];
$this->storage
->create($entity_2)
->save();
$this->storage
->create($entity_2)
->save();
$this->storage
->create($entity_2)
->save();
}
/**
* Tests the count aggregation function.
*/
public function testGroupByCount() {
$this
->groupByTestHelper('count', [
4,
3,
]);
}
/**
* Tests the sum aggregation function.
*/
public function testGroupBySum() {
$this
->groupByTestHelper('sum', [
10,
18,
]);
}
/**
* Tests the average aggregation function.
*/
public function testGroupByAverage() {
$this
->groupByTestHelper('avg', [
2.5,
6,
]);
}
/**
* Tests the min aggregation function.
*/
public function testGroupByMin() {
$this
->groupByTestHelper('min', [
1,
5,
]);
}
/**
* Tests the max aggregation function.
*/
public function testGroupByMax() {
$this
->groupByTestHelper('max', [
4,
7,
]);
}
/**
* Tests aggregation with no specific function.
*/
public function testGroupByNone() {
$this
->groupByTestHelper(NULL, [
1,
5,
]);
}
/**
* Tests groupby with filters.
*/
public function testGroupByCountOnlyFilters() {
// Check if GROUP BY and HAVING are included when a view
// doesn't display SUM, COUNT, MAX, etc. functions in SELECT statement.
for ($x = 0; $x < 10; $x++) {
$this->storage
->create([
'name' => 'name1',
])
->save();
}
$view = Views::getView('test_group_by_in_filters');
$this
->executeView($view);
$this
->assertStringContainsString('GROUP BY', (string) $view->build_info['query'], 'Make sure that GROUP BY is in the query');
$this
->assertStringContainsString('HAVING', (string) $view->build_info['query'], 'Make sure that HAVING is in the query');
}
/**
* Tests grouping on base field.
*/
public function testGroupByBaseField() {
$this
->setupTestEntities();
$view = Views::getView('test_group_by_count');
$view
->setDisplay();
// This tests that the GROUP BY portion of the query is properly formatted
// to include the base table to avoid ambiguous field errors.
$view->displayHandlers
->get('default')->options['fields']['name']['group_type'] = 'min';
unset($view->displayHandlers
->get('default')->options['fields']['id']['group_type']);
$this
->executeView($view);
$this
->assertStringContainsString('GROUP BY entity_test.id', (string) $view->build_info['query'], 'GROUP BY field includes the base table name when grouping on the base field.');
}
/**
* Tests grouping a field with cardinality > 1.
*/
public function testGroupByFieldWithCardinality() {
$field_storage = FieldStorageConfig::create([
'type' => 'integer',
'field_name' => 'field_test',
'cardinality' => 4,
'entity_type' => 'entity_test_mul',
]);
$field_storage
->save();
$field = FieldConfig::create([
'field_name' => 'field_test',
'entity_type' => 'entity_test_mul',
'bundle' => 'entity_test_mul',
]);
$field
->save();
$entities = [];
$entity = EntityTestMul::create([
'field_test' => [
1,
1,
1,
],
]);
$entity
->save();
$entities[] = $entity;
$entity = EntityTestMul::create([
'field_test' => [
2,
2,
2,
],
]);
$entity
->save();
$entities[] = $entity;
$entity = EntityTestMul::create([
'field_test' => [
2,
2,
2,
],
]);
$entity
->save();
$entities[] = $entity;
$view = Views::getView('test_group_by_count_multicardinality');
$this
->executeView($view);
$this
->assertCount(2, $view->result);
$this
->assertEqual('3', $view
->getStyle()
->getField(0, 'id'));
$this
->assertEqual('1', $view
->getStyle()
->getField(0, 'field_test'));
$this
->assertEqual('6', $view
->getStyle()
->getField(1, 'id'));
$this
->assertEqual('2', $view
->getStyle()
->getField(1, 'field_test'));
$entities[2]->field_test[0]->value = 3;
$entities[2]->field_test[1]->value = 4;
$entities[2]->field_test[2]->value = 5;
$entities[2]
->save();
$view = Views::getView('test_group_by_count_multicardinality');
$this
->executeView($view);
$this
->assertCount(5, $view->result);
$this
->assertEqual('3', $view
->getStyle()
->getField(0, 'id'));
$this
->assertEqual('1', $view
->getStyle()
->getField(0, 'field_test'));
$this
->assertEqual('3', $view
->getStyle()
->getField(1, 'id'));
$this
->assertEqual('2', $view
->getStyle()
->getField(1, 'field_test'));
$this
->assertEqual('1', $view
->getStyle()
->getField(2, 'id'));
$this
->assertEqual('3', $view
->getStyle()
->getField(2, 'field_test'));
$this
->assertEqual('1', $view
->getStyle()
->getField(3, 'id'));
$this
->assertEqual('4', $view
->getStyle()
->getField(3, 'field_test'));
$this
->assertEqual('1', $view
->getStyle()
->getField(4, 'id'));
$this
->assertEqual('5', $view
->getStyle()
->getField(4, 'field_test'));
// Check that translated values are correctly retrieved and are not grouped
// into the original entity.
$translation = $entity
->addTranslation('it');
$translation->field_test = [
6,
6,
6,
];
$translation
->save();
$view = Views::getView('test_group_by_count_multicardinality');
$this
->executeView($view);
$this
->assertCount(6, $view->result);
$this
->assertEqual('3', $view
->getStyle()
->getField(5, 'id'));
$this
->assertEqual('6', $view
->getStyle()
->getField(5, 'field_test'));
}
/**
* Tests groupby with a field not existing on some bundle.
*/
public function testGroupByWithFieldsNotExistingOnBundle() {
$field_storage = FieldStorageConfig::create([
'type' => 'integer',
'field_name' => 'field_test',
'cardinality' => 4,
'entity_type' => 'entity_test_mul',
]);
$field_storage
->save();
$field = FieldConfig::create([
'field_name' => 'field_test',
'entity_type' => 'entity_test_mul',
'bundle' => 'entity_test_mul',
]);
$field
->save();
$entities = [];
$entity = EntityTestMul::create([
'field_test' => [
1,
],
'type' => 'entity_test_mul',
]);
$entity
->save();
$entities[] = $entity;
$entity = EntityTestMul::create([
'type' => 'entity_test_mul2',
]);
$entity
->save();
$entities[] = $entity;
$view = Views::getView('test_group_by_field_not_within_bundle');
$this
->executeView($view);
$this
->assertCount(2, $view->result);
// The first result is coming from entity_test_mul2, so no field could be
// rendered.
$this
->assertEqual('', $view
->getStyle()
->getField(0, 'field_test'));
// The second result is coming from entity_test_mul, so its field value
// could be rendered.
$this
->assertEqual('1', $view
->getStyle()
->getField(1, 'field_test'));
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertHelperTrait:: |
protected static | function | Casts MarkupInterface objects into strings. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
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:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 1 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | Returns whether the current test method is running in a separate process. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
26 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 6 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | BC: Automatically resolve former KernelTestBase class properties. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpunitCompatibilityTrait:: |
public | function | Returns a mock object for the specified class using the available method. | |
PhpunitCompatibilityTrait:: |
public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | |
QueryGroupByTest:: |
public static | property |
Modules to enable. Overrides ViewsKernelTestBase:: |
|
QueryGroupByTest:: |
public | property | The storage for the test entity type. | |
QueryGroupByTest:: |
public static | property |
Views used by this test. Overrides ViewsKernelTestBase:: |
|
QueryGroupByTest:: |
public | function | Provides a test helper which runs a view with some aggregation function. | |
QueryGroupByTest:: |
protected | function |
Overrides ViewsKernelTestBase:: |
|
QueryGroupByTest:: |
protected | function | Helper method that creates some test entities. | |
QueryGroupByTest:: |
public | function | Tests aggregate count feature. | |
QueryGroupByTest:: |
public | function | Tests the average aggregation function. | |
QueryGroupByTest:: |
public | function | Tests grouping on base field. | |
QueryGroupByTest:: |
public | function | Tests the count aggregation function. | |
QueryGroupByTest:: |
public | function | Tests groupby with filters. | |
QueryGroupByTest:: |
public | function | Tests grouping a field with cardinality > 1. | |
QueryGroupByTest:: |
public | function | Tests the max aggregation function. | |
QueryGroupByTest:: |
public | function | Tests the min aggregation function. | |
QueryGroupByTest:: |
public | function | Tests aggregation with no specific function. | |
QueryGroupByTest:: |
public | function | Tests the sum aggregation function. | |
QueryGroupByTest:: |
public | function | Tests groupby with a field not existing on some bundle. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
ViewResultAssertionTrait:: |
protected | function | Verifies that a result set returned by a View matches expected values. | |
ViewResultAssertionTrait:: |
protected | function | Performs View result assertions. | |
ViewResultAssertionTrait:: |
protected | function | Verifies that a result set returned by a View differs from certain values. | |
ViewsKernelTestBase:: |
protected | function | Returns a very simple test dataset. | 8 |
ViewsKernelTestBase:: |
protected | function | Executes a view with debugging. | |
ViewsKernelTestBase:: |
protected | function | Orders a nested array containing a result set based on a given column. | |
ViewsKernelTestBase:: |
protected | function | Returns the schema definition. | 6 |
ViewsKernelTestBase:: |
protected | function | Sets up the configuration and schema of views and views_test_data modules. | 7 |
ViewsKernelTestBase:: |
protected | function | Returns the views data definition. | 22 |