class ViewStorageTest in Drupal 9
Same name and namespace in other branches
- 8 core/modules/views/tests/src/Kernel/ViewStorageTest.php \Drupal\Tests\views\Kernel\ViewStorageTest
Tests the CRUD functionality for a view.
@group views
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\Tests\views\Kernel\ViewsKernelTestBase uses ViewResultAssertionTrait
- class \Drupal\Tests\views\Kernel\ViewStorageTest
- class \Drupal\Tests\views\Kernel\ViewsKernelTestBase uses ViewResultAssertionTrait
Expanded class hierarchy of ViewStorageTest
See also
\Drupal\Core\Config\Entity\ConfigEntityStorage
File
- core/
modules/ views/ tests/ src/ Kernel/ ViewStorageTest.php, line 18
Namespace
Drupal\Tests\views\KernelView source
class ViewStorageTest extends ViewsKernelTestBase {
/**
* Properties that should be stored in the configuration.
*
* @var array
*/
protected $configProperties = [
'status',
'module',
'id',
'description',
'tag',
'base_table',
'label',
'display',
];
/**
* The entity type definition.
*
* @var \Drupal\Core\Entity\EntityTypeInterface
*/
protected $entityType;
/**
* The configuration entity storage.
*
* @var \Drupal\Core\Config\Entity\ConfigEntityStorage
*/
protected $controller;
/**
* Views used by this test.
*
* @var array
*/
public static $testViews = [
'test_view_storage',
];
/**
* Tests CRUD operations.
*/
public function testConfigurationEntityCRUD() {
// Get the configuration entity type and controller.
$this->entityType = \Drupal::entityTypeManager()
->getDefinition('view');
$this->controller = $this->container
->get('entity_type.manager')
->getStorage('view');
// Confirm that an info array has been returned.
$this
->assertInstanceOf(EntityTypeInterface::class, $this->entityType);
// CRUD tests.
$this
->loadTests();
$this
->createTests();
$this
->displayTests();
// Helper method tests
$this
->displayMethodTests();
}
/**
* Tests loading configuration entities.
*/
protected function loadTests() {
$view = View::load('test_view_storage');
$data = $this
->config('views.view.test_view_storage')
->get();
// Confirm that an actual view object is loaded and that it returns all of
// expected properties.
$this
->assertInstanceOf(View::class, $view);
foreach ($this->configProperties as $property) {
$this
->assertNotNull($view
->get($property), new FormattableMarkup('Property: @property loaded onto View.', [
'@property' => $property,
]));
}
// Check the displays have been loaded correctly from config display data.
$expected_displays = [
'default',
'block_1',
'page_1',
];
$this
->assertEquals($expected_displays, array_keys($view
->get('display')), 'The correct display names are present.');
// Check each ViewDisplay object and confirm that it has the correct key and
// property values.
foreach ($view
->get('display') as $key => $display) {
$this
->assertEquals($key, $display['id'], 'The display has the correct ID assigned.');
// Get original display data and confirm that the display options array
// exists.
$original_options = $data['display'][$key];
foreach ($original_options as $orig_key => $value) {
$this
->assertSame($display[$orig_key], $value, new FormattableMarkup('@key is identical to saved data', [
'@key' => $key,
]));
}
}
// Make sure that loaded default views get a UUID.
$view = Views::getView('test_view_storage');
$this
->assertNotEmpty($view->storage
->uuid());
}
/**
* Tests creating configuration entities.
*/
protected function createTests() {
// Create a new View instance with empty values.
$created = $this->controller
->create([]);
$this
->assertInstanceOf(View::class, $created);
// Check that the View contains all of the properties.
foreach ($this->configProperties as $property) {
$this
->assertTrue(property_exists($created, $property), new FormattableMarkup('Property: @property created on View.', [
'@property' => $property,
]));
}
// Create a new View instance with config values.
$values = $this
->config('views.view.test_view_storage')
->get();
$values['id'] = 'test_view_storage_new';
unset($values['uuid']);
$created = $this->controller
->create($values);
$this
->assertInstanceOf(View::class, $created);
// Check that the View contains all of the properties.
$properties = $this->configProperties;
// Remove display from list.
array_pop($properties);
// Test all properties except displays.
foreach ($properties as $property) {
$this
->assertNotNull($created
->get($property), new FormattableMarkup('Property: @property created on View.', [
'@property' => $property,
]));
$this
->assertSame($values[$property], $created
->get($property), new FormattableMarkup('Property value: @property matches configuration value.', [
'@property' => $property,
]));
}
// Check the UUID of the loaded View.
$created
->save();
$created_loaded = View::load('test_view_storage_new');
$this
->assertSame($created
->uuid(), $created_loaded
->uuid(), 'The created UUID has been saved correctly.');
}
/**
* Tests adding, saving, and loading displays on configuration entities.
*/
protected function displayTests() {
// Check whether a display can be added and saved to a View.
$view = View::load('test_view_storage_new');
$new_id = $view
->addDisplay('page', 'Test', 'test');
$display = $view
->get('display');
// Ensure the right display_plugin is created/instantiated.
$this
->assertEquals('page', $display[$new_id]['display_plugin'], 'New page display "test" uses the right display plugin.');
$executable = $view
->getExecutable();
$executable
->initDisplay();
$this
->assertInstanceOf(Page::class, $executable->displayHandlers
->get($new_id));
// To save this with a new ID, we should use createDuplicate().
$view = $view
->createDuplicate();
$view
->set('id', 'test_view_storage_new_new2');
$view
->save();
$values = $this
->config('views.view.test_view_storage_new_new2')
->get();
// Verify that the display was saved by ensuring it contains an array of
// values in the view data.
$this
->assertIsArray($values['display']['test']);
}
/**
* Tests the display related functions like getDisplaysList().
*/
protected function displayMethodTests() {
$config['display'] = [
'page_1' => [
'display_options' => [
'path' => 'test',
],
'display_plugin' => 'page',
'id' => 'page_2',
'display_title' => 'Page 1',
'position' => 1,
],
'feed_1' => [
'display_options' => [
'path' => 'test.xml',
],
'display_plugin' => 'feed',
'id' => 'feed',
'display_title' => 'Feed',
'position' => 2,
],
'page_2' => [
'display_options' => [
'path' => 'test/%/extra',
],
'display_plugin' => 'page',
'id' => 'page_2',
'display_title' => 'Page 2',
'position' => 3,
],
];
$view = $this->controller
->create($config);
// Tests Drupal\views\Entity\View::addDisplay()
$view = $this->controller
->create([]);
$random_title = $this
->randomMachineName();
$id = $view
->addDisplay('page', $random_title);
$this
->assertEquals('page_1', $id, new FormattableMarkup('Make sure the first display (%id_new) has the expected ID (%id)', [
'%id_new' => $id,
'%id' => 'page_1',
]));
$display = $view
->get('display');
$this
->assertEquals($random_title, $display[$id]['display_title']);
$random_title = $this
->randomMachineName();
$id = $view
->addDisplay('page', $random_title);
$display = $view
->get('display');
$this
->assertEquals('page_2', $id, new FormattableMarkup('Make sure the second display (%id_new) has the expected ID (%id)', [
'%id_new' => $id,
'%id' => 'page_2',
]));
$this
->assertEquals($random_title, $display[$id]['display_title']);
$id = $view
->addDisplay('page');
$display = $view
->get('display');
$this
->assertEquals('Page 3', $display[$id]['display_title']);
// Ensure the 'default' display always has position zero, regardless of when
// it was set relative to other displays. Even if the 'default' display
// exists, adding it again will overwrite it, which is asserted with the new
// title.
$view
->addDisplay('default', $random_title);
$displays = $view
->get('display');
$this
->assertEquals($random_title, $displays['default']['display_title'], 'Default display is defined with the new title');
$this
->assertEquals(0, $displays['default']['position'], 'Default displays are always in position zero');
// Tests Drupal\views\Entity\View::generateDisplayId(). Since
// generateDisplayId() is protected, we have to use reflection to unit-test
// it.
$view = $this->controller
->create([]);
$ref_generate_display_id = new \ReflectionMethod($view, 'generateDisplayId');
$ref_generate_display_id
->setAccessible(TRUE);
$this
->assertEquals('default', $ref_generate_display_id
->invoke($view, 'default'), 'The plugin ID for default is always default.');
$this
->assertEquals('feed_1', $ref_generate_display_id
->invoke($view, 'feed'), 'The generated ID for the first instance of a plugin type should have an suffix of _1.');
$view
->addDisplay('feed', 'feed title');
$this
->assertEquals('feed_2', $ref_generate_display_id
->invoke($view, 'feed'), 'The generated ID for the first instance of a plugin type should have an suffix of _2.');
// Tests item related methods().
$view = $this->controller
->create([
'base_table' => 'views_test_data',
]);
$view
->addDisplay('default');
$view = $view
->getExecutable();
$display_id = 'default';
$expected_items = [];
// Tests addHandler with getItem.
// Therefore add one item without any options and one item with some
// options.
$id1 = $view
->addHandler($display_id, 'field', 'views_test_data', 'id');
$item1 = $view
->getHandler($display_id, 'field', 'id');
$expected_items[$id1] = $expected_item = [
'id' => 'id',
'table' => 'views_test_data',
'field' => 'id',
'plugin_id' => 'numeric',
];
$this
->assertEquals($expected_item, $item1);
$options = [
'alter' => [
'text' => $this
->randomMachineName(),
],
];
$id2 = $view
->addHandler($display_id, 'field', 'views_test_data', 'name', $options);
$item2 = $view
->getHandler($display_id, 'field', 'name');
$expected_items[$id2] = $expected_item = [
'id' => 'name',
'table' => 'views_test_data',
'field' => 'name',
'plugin_id' => 'standard',
] + $options;
$this
->assertEquals($expected_item, $item2);
// Tests the expected fields from the previous additions.
$this
->assertEquals($expected_items, $view
->getHandlers('field', $display_id));
// Alter an existing item via setItem and check the result via getItem
// and getItems.
$item = [
'alter' => [
'text' => $this
->randomMachineName(),
],
] + $item1;
$expected_items[$id1] = $item;
$view
->setHandler($display_id, 'field', $id1, $item);
$this
->assertEquals($item, $view
->getHandler($display_id, 'field', 'id'));
$this
->assertEquals($expected_items, $view
->getHandlers('field', $display_id));
// Test removeItem method.
unset($expected_items[$id2]);
$view
->removeHandler($display_id, 'field', $id2);
$this
->assertEquals($expected_items, $view
->getHandlers('field', $display_id));
}
/**
* Tests the createDuplicate() View method.
*/
public function testCreateDuplicate() {
$view = Views::getView('test_view_storage');
$copy = $view->storage
->createDuplicate();
$this
->assertInstanceOf(View::class, $copy);
// Check that the original view and the copy have different UUIDs.
$this
->assertNotSame($view->storage
->uuid(), $copy
->uuid(), 'The copied view has a new UUID.');
// Check the 'name' (ID) is using the View objects default value (NULL) as it
// gets unset.
$this
->assertNull($copy
->id(), 'The ID has been reset.');
// Check the other properties.
// @todo Create a reusable property on the base test class for these?
$config_properties = [
'disabled',
'description',
'tag',
'base_table',
'label',
];
foreach ($config_properties as $property) {
$this
->assertSame($view->storage
->get($property), $copy
->get($property), new FormattableMarkup('@property property is identical.', [
'@property' => $property,
]));
}
// Check the displays are the same.
$copy_display = $copy
->get('display');
foreach ($view->storage
->get('display') as $id => $display) {
// assertIdentical will not work here.
$this
->assertEquals($copy_display[$id], $display, new FormattableMarkup('The @display display has been copied correctly.', [
'@display' => $id,
]));
}
}
}
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. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
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. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
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. | 3 |
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 | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
24 |
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 | 4 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
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 static | property |
Modules to enable. Overrides KernelTestBase:: |
92 |
ViewsKernelTestBase:: |
protected | function | Returns a very simple test dataset. | 8 |
ViewsKernelTestBase:: |
protected | function | Executes a view. | |
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 |
Overrides KernelTestBase:: |
66 |
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 |
ViewStorageTest:: |
protected | property | Properties that should be stored in the configuration. | |
ViewStorageTest:: |
protected | property | The configuration entity storage. | |
ViewStorageTest:: |
protected | property | The entity type definition. | |
ViewStorageTest:: |
public static | property |
Views used by this test. Overrides ViewsKernelTestBase:: |
|
ViewStorageTest:: |
protected | function | Tests creating configuration entities. | |
ViewStorageTest:: |
protected | function | Tests the display related functions like getDisplaysList(). | |
ViewStorageTest:: |
protected | function | Tests adding, saving, and loading displays on configuration entities. | |
ViewStorageTest:: |
protected | function | Tests loading configuration entities. | |
ViewStorageTest:: |
public | function | Tests CRUD operations. | |
ViewStorageTest:: |
public | function | Tests the createDuplicate() View method. |