class StyleSerializerTest in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/rest/src/Tests/Views/StyleSerializerTest.php \Drupal\rest\Tests\Views\StyleSerializerTest
Tests the serializer style plugin.
@group rest
Hierarchy
- class \Drupal\simpletest\TestBase uses AssertHelperTrait, RandomGeneratorTrait, SessionTestTrait
- class \Drupal\simpletest\WebTestBase uses AssertContentTrait, UserCreationTrait
- class \Drupal\views\Tests\ViewTestBase uses ViewResultAssertionTrait
- class \Drupal\views\Tests\Plugin\PluginTestBase
- class \Drupal\rest\Tests\Views\StyleSerializerTest uses AssertPageCacheContextsAndTagsTrait
- class \Drupal\views\Tests\Plugin\PluginTestBase
- class \Drupal\views\Tests\ViewTestBase uses ViewResultAssertionTrait
- class \Drupal\simpletest\WebTestBase uses AssertContentTrait, UserCreationTrait
Expanded class hierarchy of StyleSerializerTest
See also
\Drupal\rest\Plugin\views\display\RestExport
\Drupal\rest\Plugin\views\style\Serializer
\Drupal\rest\Plugin\views\row\DataEntityRow
\Drupal\rest\Plugin\views\row\DataFieldRow
File
- core/
modules/ rest/ src/ Tests/ Views/ StyleSerializerTest.php, line 32 - Contains \Drupal\rest\Tests\Views\StyleSerializerTest.
Namespace
Drupal\rest\Tests\ViewsView source
class StyleSerializerTest extends PluginTestBase {
use AssertPageCacheContextsAndTagsTrait;
/**
* {@inheritdoc}
*/
protected $dumpHeaders = TRUE;
/**
* Modules to install.
*
* @var array
*/
public static $modules = array(
'views_ui',
'entity_test',
'hal',
'rest_test_views',
'node',
'text',
'field',
);
/**
* Views used by this test.
*
* @var array
*/
public static $testViews = array(
'test_serializer_display_field',
'test_serializer_display_entity',
'test_serializer_node_display_field',
'test_serializer_node_exposed_filter',
);
/**
* A user with administrative privileges to look at test entity and configure views.
*/
protected $adminUser;
protected function setUp() {
parent::setUp();
ViewTestData::createTestViews(get_class($this), array(
'rest_test_views',
));
$this->adminUser = $this
->drupalCreateUser(array(
'administer views',
'administer entity_test content',
'access user profiles',
'view test entity',
));
// Save some entity_test entities.
for ($i = 1; $i <= 10; $i++) {
entity_create('entity_test', array(
'name' => 'test_' . $i,
'user_id' => $this->adminUser
->id(),
))
->save();
}
$this
->enableViewsTestModule();
}
/**
* Checks the behavior of the Serializer callback paths and row plugins.
*/
public function testSerializerResponses() {
// Test the serialize callback.
$view = Views::getView('test_serializer_display_field');
$view
->initDisplay();
$this
->executeView($view);
$actual_json = $this
->drupalGetWithFormat('test/serialize/field', 'json');
$this
->assertResponse(200);
$this
->assertCacheTags($view
->getCacheTags());
$this
->assertCacheContexts([
'languages:language_interface',
'theme',
'request_format',
]);
// @todo Due to https://www.drupal.org/node/2352009 we can't yet test the
// propagation of cache max-age.
// Test the http Content-type.
$headers = $this
->drupalGetHeaders();
$this
->assertEqual($headers['content-type'], 'application/json', 'The header Content-type is correct.');
$expected = array();
foreach ($view->result as $row) {
$expected_row = array();
foreach ($view->field as $id => $field) {
$expected_row[$id] = $field
->render($row);
}
$expected[] = $expected_row;
}
$this
->assertIdentical($actual_json, json_encode($expected), 'The expected JSON output was found.');
// Test that the rendered output and the preview output are the same.
$view
->destroy();
$view
->setDisplay('rest_export_1');
// Mock the request content type by setting it on the display handler.
$view->display_handler
->setContentType('json');
$output = $view
->preview();
$this
->assertIdentical($actual_json, (string) drupal_render_root($output), 'The expected JSON preview output was found.');
// Test a 403 callback.
$this
->drupalGet('test/serialize/denied');
$this
->assertResponse(403);
// Test the entity rows.
$view = Views::getView('test_serializer_display_entity');
$view
->initDisplay();
$this
->executeView($view);
// Get the serializer service.
$serializer = $this->container
->get('serializer');
$entities = array();
foreach ($view->result as $row) {
$entities[] = $row->_entity;
}
$expected = $serializer
->serialize($entities, 'json');
$actual_json = $this
->drupalGetWithFormat('test/serialize/entity', 'json');
$this
->assertResponse(200);
$this
->assertIdentical($actual_json, $expected, 'The expected JSON output was found.');
$expected_cache_tags = $view
->getCacheTags();
$expected_cache_tags[] = 'entity_test_list';
/** @var \Drupal\Core\Entity\EntityInterface $entity */
foreach ($entities as $entity) {
$expected_cache_tags = Cache::mergeTags($expected_cache_tags, $entity
->getCacheTags());
}
$this
->assertCacheTags($expected_cache_tags);
$this
->assertCacheContexts([
'languages:language_interface',
'theme',
'entity_test_view_grants',
'request_format',
]);
$expected = $serializer
->serialize($entities, 'hal_json');
$actual_json = $this
->drupalGetWithFormat('test/serialize/entity', 'hal_json');
$this
->assertIdentical($actual_json, $expected, 'The expected HAL output was found.');
$this
->assertCacheTags($expected_cache_tags);
// Change the default format to xml.
$view
->setDisplay('rest_export_1');
$view
->getDisplay()
->setOption('style', array(
'type' => 'serializer',
'options' => array(
'uses_fields' => FALSE,
'formats' => array(
'xml' => 'xml',
),
),
));
$view
->save();
$expected = $serializer
->serialize($entities, 'xml');
$actual_xml = $this
->drupalGet('test/serialize/entity');
$this
->assertIdentical($actual_xml, $expected, 'The expected XML output was found.');
$this
->assertCacheContexts([
'languages:language_interface',
'theme',
'entity_test_view_grants',
'request_format',
]);
// Allow multiple formats.
$view
->setDisplay('rest_export_1');
$view
->getDisplay()
->setOption('style', array(
'type' => 'serializer',
'options' => array(
'uses_fields' => FALSE,
'formats' => array(
'xml' => 'xml',
'json' => 'json',
),
),
));
$view
->save();
$expected = $serializer
->serialize($entities, 'json');
$actual_json = $this
->drupalGetWithFormat('test/serialize/entity', 'json');
$this
->assertIdentical($actual_json, $expected, 'The expected JSON output was found.');
$expected = $serializer
->serialize($entities, 'xml');
$actual_xml = $this
->drupalGetWithFormat('test/serialize/entity', 'xml');
$this
->assertIdentical($actual_xml, $expected, 'The expected XML output was found.');
}
/**
* Sets up a request on the request stack with a specified format.
*
* @param string $format
* The new request format.
*/
protected function addRequestWithFormat($format) {
$request = \Drupal::request();
$request = clone $request;
$request
->setRequestFormat($format);
\Drupal::requestStack()
->push($request);
}
/**
* Tests REST export with views render caching enabled.
*/
public function testRestRenderCaching() {
$this
->drupalLogin($this->adminUser);
/** @var \Drupal\Core\Render\RenderCacheInterface $render_cache */
$render_cache = \Drupal::service('render_cache');
// Enable render caching for the views.
/** @var \Drupal\views\ViewEntityInterface $storage */
$storage = View::load('test_serializer_display_entity');
$options =& $storage
->getDisplay('default');
$options['display_options']['cache'] = [
'type' => 'tag',
];
$storage
->save();
$original = DisplayPluginBase::buildBasicRenderable('test_serializer_display_entity', 'rest_export_1');
// Ensure that there is no corresponding render cache item yet.
$original['#cache'] += [
'contexts' => [],
];
$original['#cache']['contexts'] = Cache::mergeContexts($original['#cache']['contexts'], $this->container
->getParameter('renderer.config')['required_cache_contexts']);
$cache_tags = [
'config:views.view.test_serializer_display_entity',
'entity_test:1',
'entity_test:10',
'entity_test:2',
'entity_test:3',
'entity_test:4',
'entity_test:5',
'entity_test:6',
'entity_test:7',
'entity_test:8',
'entity_test:9',
'entity_test_list',
];
$cache_contexts = [
'entity_test_view_grants',
'languages:language_interface',
'theme',
'request_format',
];
$this
->assertFalse($render_cache
->get($original));
// Request the page, once in XML and once in JSON to ensure that the caching
// varies by it.
$result1 = $this
->drupalGetJSON('test/serialize/entity');
$this
->addRequestWithFormat('json');
$this
->assertHeader('content-type', 'application/json');
$this
->assertCacheContexts($cache_contexts);
$this
->assertCacheTags($cache_tags);
$this
->assertTrue($render_cache
->get($original));
$result_xml = $this
->drupalGetWithFormat('test/serialize/entity', 'xml');
$this
->addRequestWithFormat('xml');
$this
->assertHeader('content-type', 'text/xml; charset=UTF-8');
$this
->assertCacheContexts($cache_contexts);
$this
->assertCacheTags($cache_tags);
$this
->assertTrue($render_cache
->get($original));
// Ensure that the XML output is different from the JSON one.
$this
->assertNotEqual($result1, $result_xml);
// Ensure that the cached page works.
$result2 = $this
->drupalGetJSON('test/serialize/entity');
$this
->addRequestWithFormat('json');
$this
->assertHeader('content-type', 'application/json');
$this
->assertEqual($result2, $result1);
$this
->assertCacheContexts($cache_contexts);
$this
->assertCacheTags($cache_tags);
$this
->assertTrue($render_cache
->get($original));
// Create a new entity and ensure that the cache tags are taken over.
EntityTest::create([
'name' => 'test_11',
'user_id' => $this->adminUser
->id(),
])
->save();
$result3 = $this
->drupalGetJSON('test/serialize/entity');
$this
->addRequestWithFormat('json');
$this
->assertHeader('content-type', 'application/json');
$this
->assertNotEqual($result3, $result2);
// Add the new entity cache tag and remove the first one, because we just
// show 10 items in total.
$cache_tags[] = 'entity_test:11';
unset($cache_tags[array_search('entity_test:1', $cache_tags)]);
$this
->assertCacheContexts($cache_contexts);
$this
->assertCacheTags($cache_tags);
$this
->assertTrue($render_cache
->get($original));
}
/**
* Tests the response format configuration.
*/
public function testResponseFormatConfiguration() {
$this
->drupalLogin($this->adminUser);
$style_options = 'admin/structure/views/nojs/display/test_serializer_display_field/rest_export_1/style_options';
// Select only 'xml' as an accepted format.
$this
->drupalPostForm($style_options, array(
'style_options[formats][xml]' => 'xml',
), t('Apply'));
$this
->drupalPostForm(NULL, array(), t('Save'));
// Should return a 406.
$this
->drupalGetWithFormat('test/serialize/field', 'json');
$this
->assertHeader('content-type', 'application/json');
$this
->assertResponse(406, 'A 406 response was returned when JSON was requested.');
// Should return a 200.
$this
->drupalGetWithFormat('test/serialize/field', 'xml');
$this
->assertHeader('content-type', 'text/xml; charset=UTF-8');
$this
->assertResponse(200, 'A 200 response was returned when XML was requested.');
// Add 'json' as an accepted format, so we have multiple.
$this
->drupalPostForm($style_options, array(
'style_options[formats][json]' => 'json',
), t('Apply'));
$this
->drupalPostForm(NULL, array(), t('Save'));
// Should return a 200.
// @todo This should be fixed when we have better content negotiation.
$this
->drupalGet('test/serialize/field');
$this
->assertHeader('content-type', 'application/json');
$this
->assertResponse(200, 'A 200 response was returned when any format was requested.');
// Should return a 200. Emulates a sample Firefox header.
$this
->drupalGet('test/serialize/field', array(), array(
'Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
));
$this
->assertHeader('content-type', 'application/json');
$this
->assertResponse(200, 'A 200 response was returned when a browser accept header was requested.');
// Should return a 200.
$this
->drupalGetWithFormat('test/serialize/field', 'json');
$this
->assertHeader('content-type', 'application/json');
$this
->assertResponse(200, 'A 200 response was returned when JSON was requested.');
$headers = $this
->drupalGetHeaders();
$this
->assertEqual($headers['content-type'], 'application/json', 'The header Content-type is correct.');
// Should return a 200.
$this
->drupalGetWithFormat('test/serialize/field', 'xml');
$this
->assertHeader('content-type', 'text/xml; charset=UTF-8');
$this
->assertResponse(200, 'A 200 response was returned when XML was requested');
$headers = $this
->drupalGetHeaders();
$this
->assertTrue(strpos($headers['content-type'], 'text/xml') !== FALSE, 'The header Content-type is correct.');
// Should return a 406.
$this
->drupalGetWithFormat('test/serialize/field', 'html');
// We want to show the first format by default, see
// \Drupal\rest\Plugin\views\style\Serializer::render.
$this
->assertHeader('content-type', 'application/json');
$this
->assertResponse(200, 'A 200 response was returned when HTML was requested.');
// Now configure now format, so all of them should be allowed.
$this
->drupalPostForm($style_options, array(
'style_options[formats][json]' => '0',
'style_options[formats][xml]' => '0',
), t('Apply'));
// Should return a 200.
$this
->drupalGetWithFormat('test/serialize/field', 'json');
$this
->assertHeader('content-type', 'application/json');
$this
->assertResponse(200, 'A 200 response was returned when JSON was requested.');
// Should return a 200.
$this
->drupalGetWithFormat('test/serialize/field', 'xml');
$this
->assertHeader('content-type', 'text/xml; charset=UTF-8');
$this
->assertResponse(200, 'A 200 response was returned when XML was requested');
// Should return a 200.
$this
->drupalGetWithFormat('test/serialize/field', 'html');
// We want to show the first format by default, see
// \Drupal\rest\Plugin\views\style\Serializer::render.
$this
->assertHeader('content-type', 'application/json');
$this
->assertResponse(200, 'A 200 response was returned when HTML was requested.');
}
/**
* Test the field ID alias functionality of the DataFieldRow plugin.
*/
public function testUIFieldAlias() {
$this
->drupalLogin($this->adminUser);
// Test the UI settings for adding field ID aliases.
$this
->drupalGet('admin/structure/views/view/test_serializer_display_field/edit/rest_export_1');
$row_options = 'admin/structure/views/nojs/display/test_serializer_display_field/rest_export_1/row_options';
$this
->assertLinkByHref($row_options);
// Test an empty string for an alias, this should not be used. This also
// tests that the form can be submitted with no aliases.
$this
->drupalPostForm($row_options, array(
'row_options[field_options][name][alias]' => '',
), t('Apply'));
$this
->drupalPostForm(NULL, array(), t('Save'));
$view = Views::getView('test_serializer_display_field');
$view
->setDisplay('rest_export_1');
$this
->executeView($view);
$expected = array();
foreach ($view->result as $row) {
$expected_row = array();
foreach ($view->field as $id => $field) {
$expected_row[$id] = $field
->render($row);
}
$expected[] = $expected_row;
}
$this
->assertIdentical($this
->drupalGetJSON('test/serialize/field'), $this
->castSafeStrings($expected));
// Test a random aliases for fields, they should be replaced.
$alias_map = array(
'name' => $this
->randomMachineName(),
// Use # to produce an invalid character for the validation.
'nothing' => '#' . $this
->randomMachineName(),
'created' => 'created',
);
$edit = array(
'row_options[field_options][name][alias]' => $alias_map['name'],
'row_options[field_options][nothing][alias]' => $alias_map['nothing'],
);
$this
->drupalPostForm($row_options, $edit, t('Apply'));
$this
->assertText(t('The machine-readable name must contain only letters, numbers, dashes and underscores.'));
// Change the map alias value to a valid one.
$alias_map['nothing'] = $this
->randomMachineName();
$edit = array(
'row_options[field_options][name][alias]' => $alias_map['name'],
'row_options[field_options][nothing][alias]' => $alias_map['nothing'],
);
$this
->drupalPostForm($row_options, $edit, t('Apply'));
$this
->drupalPostForm(NULL, array(), t('Save'));
$view = Views::getView('test_serializer_display_field');
$view
->setDisplay('rest_export_1');
$this
->executeView($view);
$expected = array();
foreach ($view->result as $row) {
$expected_row = array();
foreach ($view->field as $id => $field) {
$expected_row[$alias_map[$id]] = $field
->render($row);
}
$expected[] = $expected_row;
}
$this
->assertIdentical($this
->drupalGetJSON('test/serialize/field'), $this
->castSafeStrings($expected));
}
/**
* Tests the raw output options for row field rendering.
*/
public function testFieldRawOutput() {
$this
->drupalLogin($this->adminUser);
// Test the UI settings for adding field ID aliases.
$this
->drupalGet('admin/structure/views/view/test_serializer_display_field/edit/rest_export_1');
$row_options = 'admin/structure/views/nojs/display/test_serializer_display_field/rest_export_1/row_options';
$this
->assertLinkByHref($row_options);
// Test an empty string for an alias, this should not be used. This also
// tests that the form can be submitted with no aliases.
$this
->drupalPostForm($row_options, array(
'row_options[field_options][created][raw_output]' => '1',
), t('Apply'));
$this
->drupalPostForm(NULL, array(), t('Save'));
$view = Views::getView('test_serializer_display_field');
$view
->setDisplay('rest_export_1');
$this
->executeView($view);
// Just test the raw 'created' value against each row.
foreach ($this
->drupalGetJSON('test/serialize/field') as $index => $values) {
$this
->assertIdentical($values['created'], $view->result[$index]->views_test_data_created, 'Expected raw created value found.');
}
}
/**
* Tests the live preview output for json output.
*/
public function testLivePreview() {
// We set up a request so it looks like an request in the live preview.
$request = new Request();
$request
->setFormat('drupal_ajax', 'application/vnd.drupal-ajax');
$request->headers
->set('Accept', 'application/vnd.drupal-ajax');
/** @var \Symfony\Component\HttpFoundation\RequestStack $request_stack */
$request_stack = \Drupal::service('request_stack');
$request_stack
->push($request);
$view = Views::getView('test_serializer_display_entity');
$view
->setDisplay('rest_export_1');
$this
->executeView($view);
// Get the serializer service.
$serializer = $this->container
->get('serializer');
$entities = array();
foreach ($view->result as $row) {
$entities[] = $row->_entity;
}
$expected = $serializer
->serialize($entities, 'json');
$view->live_preview = TRUE;
$build = $view
->preview();
$rendered_json = $build['#plain_text'];
$this
->assertTrue(!isset($build['#markup']) && $rendered_json == $expected, 'Ensure the previewed json is escaped.');
$view
->destroy();
$expected = $serializer
->serialize($entities, 'xml');
// Change the request format to xml.
$view
->setDisplay('rest_export_1');
$view
->getDisplay()
->setOption('style', array(
'type' => 'serializer',
'options' => array(
'uses_fields' => FALSE,
'formats' => array(
'xml' => 'xml',
),
),
));
$this
->executeView($view);
$build = $view
->preview();
$rendered_xml = $build['#plain_text'];
$this
->assertEqual($rendered_xml, $expected, 'Ensure we preview xml when we change the request format.');
}
/**
* Tests the views interface for REST export displays.
*/
public function testSerializerViewsUI() {
$this
->drupalLogin($this->adminUser);
// Click the "Update preview button".
$this
->drupalPostForm('admin/structure/views/view/test_serializer_display_field/edit/rest_export_1', $edit = array(), t('Update preview'));
$this
->assertResponse(200);
// Check if we receive the expected result.
$result = $this
->xpath('//div[@id="views-live-preview"]/pre');
$this
->assertIdentical($this
->drupalGet('test/serialize/field'), (string) $result[0], 'The expected JSON preview output was found.');
}
/**
* Tests the field row style using fieldapi fields.
*/
public function testFieldapiField() {
$this
->drupalCreateContentType(array(
'type' => 'page',
));
$node = $this
->drupalCreateNode();
$result = $this
->drupalGetJSON('test/serialize/node-field');
$this
->assertEqual($result[0]['nid'], $node
->id());
$this
->assertEqual($result[0]['body'], $node->body->processed);
// Make sure that serialized fields are not exposed to XSS.
$node = $this
->drupalCreateNode();
$node->body = [
'value' => '<script type="text/javascript">alert("node-body");</script>' . $this
->randomMachineName(32),
'format' => filter_default_format(),
];
$node
->save();
$result = $this
->drupalGetJSON('test/serialize/node-field');
$this
->assertEqual($result[1]['nid'], $node
->id());
$this
->assertTrue(strpos($this
->getRawContent(), "<script") === FALSE, "No script tag is present in the raw page contents.");
}
/**
* Tests the "Grouped rows" functionality.
*/
public function testGroupRows() {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = $this->container
->get('renderer');
$this
->drupalCreateContentType([
'type' => 'page',
]);
// Create a text field with cardinality set to unlimited.
$field_name = 'field_group_rows';
$field_storage = FieldStorageConfig::create([
'field_name' => $field_name,
'entity_type' => 'node',
'type' => 'string',
'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
]);
$field_storage
->save();
// Create an instance of the text field on the content type.
$field = FieldConfig::create([
'field_storage' => $field_storage,
'bundle' => 'page',
]);
$field
->save();
$grouped_field_values = [
'a',
'b',
'c',
];
$edit = [
'title' => $this
->randomMachineName(),
$field_name => $grouped_field_values,
];
$this
->drupalCreateNode($edit);
$view = Views::getView('test_serializer_node_display_field');
$view
->setDisplay('rest_export_1');
// Override the view's fields to include the field_group_rows field, set the
// group_rows setting to true.
$fields = [
$field_name => [
'id' => $field_name,
'table' => 'node__' . $field_name,
'field' => $field_name,
'type' => 'string',
'group_rows' => TRUE,
],
];
$view->displayHandlers
->get('default')
->overrideOption('fields', $fields);
$build = $view
->preview();
// Get the serializer service.
$serializer = $this->container
->get('serializer');
// Check if the field_group_rows field is grouped.
$expected = [];
$expected[] = [
$field_name => implode(', ', $grouped_field_values),
];
$this
->assertEqual($serializer
->serialize($expected, 'json'), (string) $renderer
->renderRoot($build));
// Set the group rows setting to false.
$view = Views::getView('test_serializer_node_display_field');
$view
->setDisplay('rest_export_1');
$fields[$field_name]['group_rows'] = FALSE;
$view->displayHandlers
->get('default')
->overrideOption('fields', $fields);
$build = $view
->preview();
// Check if the field_group_rows field is ungrouped and displayed per row.
$expected = [];
foreach ($grouped_field_values as $grouped_field_value) {
$expected[] = [
$field_name => $grouped_field_value,
];
}
$this
->assertEqual($serializer
->serialize($expected, 'json'), (string) $renderer
->renderRoot($build));
}
/**
* Tests the exposed filter works.
*
* There is an exposed filter on the title field which takes a title query
* parameter. This is set to filter nodes by those whose title starts with
* the value provided.
*/
public function testRestViewExposedFilter() {
$this
->drupalCreateContentType(array(
'type' => 'page',
));
$node0 = $this
->drupalCreateNode(array(
'title' => 'Node 1',
));
$node1 = $this
->drupalCreateNode(array(
'title' => 'Node 11',
));
$node2 = $this
->drupalCreateNode(array(
'title' => 'Node 111',
));
// Test that no filter brings back all three nodes.
$result = $this
->drupalGetJSON('test/serialize/node-exposed-filter');
$expected = array(
0 => array(
'nid' => $node0
->id(),
'body' => $node0->body->processed,
),
1 => array(
'nid' => $node1
->id(),
'body' => $node1->body->processed,
),
2 => array(
'nid' => $node2
->id(),
'body' => $node2->body->processed,
),
);
$this
->assertEqual($result, $expected, 'Querying a view with no exposed filter returns all nodes.');
// Test that title starts with 'Node 11' query finds 2 of the 3 nodes.
$result = $this
->drupalGetJSON('test/serialize/node-exposed-filter', [
'query' => [
'title' => 'Node 11',
],
]);
$expected = array(
0 => array(
'nid' => $node1
->id(),
'body' => $node1->body->processed,
),
1 => array(
'nid' => $node2
->id(),
'body' => $node2->body->processed,
),
);
$cache_contexts = [
'languages:language_content',
'languages:language_interface',
'theme',
'request_format',
'user.node_grants:view',
'url',
];
$this
->assertEqual($result, $expected, 'Querying a view with a starts with exposed filter on the title returns nodes whose title starts with value provided.');
$this
->assertCacheContexts($cache_contexts);
}
}
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. | 2 |
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 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 | function | Casts MarkupInterface objects into strings. | |
AssertPageCacheContextsAndTagsTrait:: |
protected | function | Ensures that some cache contexts are present in the current response. | |
AssertPageCacheContextsAndTagsTrait:: |
protected | function | Asserts the max age header. | |
AssertPageCacheContextsAndTagsTrait:: |
protected | function | Ensures that some cache tags are present in the current response. | |
AssertPageCacheContextsAndTagsTrait:: |
protected | function | Asserts page cache miss, then hit for the given URL; checks cache headers. | |
AssertPageCacheContextsAndTagsTrait:: |
protected | function | Provides debug information for cache tags. | |
AssertPageCacheContextsAndTagsTrait:: |
protected | function | Enables page caching. | |
AssertPageCacheContextsAndTagsTrait:: |
protected | function | Gets a specific header value as array. | |
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. | |
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. | |
SessionTestTrait:: |
protected | property | The name of the session cookie. | |
SessionTestTrait:: |
protected | function | Generates a session cookie name. | |
SessionTestTrait:: |
protected | function | Returns the session name in use on the child site. | |
StyleSerializerTest:: |
protected | property | A user with administrative privileges to look at test entity and configure views. | |
StyleSerializerTest:: |
protected | property |
Indicates that headers should be dumped if verbose output is enabled. Overrides WebTestBase:: |
|
StyleSerializerTest:: |
public static | property |
Modules to install. Overrides ViewTestBase:: |
|
StyleSerializerTest:: |
public static | property | Views used by this test. | |
StyleSerializerTest:: |
protected | function | Sets up a request on the request stack with a specified format. | |
StyleSerializerTest:: |
protected | function |
Sets up a Drupal site for running functional and integration tests. Overrides ViewTestBase:: |
|
StyleSerializerTest:: |
public | function | Tests the field row style using fieldapi fields. | |
StyleSerializerTest:: |
public | function | Tests the raw output options for row field rendering. | |
StyleSerializerTest:: |
public | function | Tests the "Grouped rows" functionality. | |
StyleSerializerTest:: |
public | function | Tests the live preview output for json output. | |
StyleSerializerTest:: |
public | function | Tests the response format configuration. | |
StyleSerializerTest:: |
public | function | Tests REST export with views render caching enabled. | |
StyleSerializerTest:: |
public | function | Tests the exposed filter works. | |
StyleSerializerTest:: |
public | function | Checks the behavior of the Serializer callback paths and row plugins. | |
StyleSerializerTest:: |
public | function | Tests the views interface for REST export displays. | |
StyleSerializerTest:: |
public | function | Test the field ID alias functionality of the DataFieldRow plugin. | |
TestBase:: |
protected | property | Assertions thrown in that test case. | |
TestBase:: |
protected | property | The config importer that can used in a test. | 5 |
TestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
TestBase:: |
protected | property | The dependency injection container used in the test. | |
TestBase:: |
protected | property | The database prefix of this test run. | |
TestBase:: |
public | property | Whether to die in case any test assertion fails. | |
TestBase:: |
protected | property | HTTP authentication credentials (<username>:<password>). | |
TestBase:: |
protected | property | HTTP authentication method (specified as a CURLAUTH_* constant). | |
TestBase:: |
protected | property | The original configuration (variables), if available. | |
TestBase:: |
protected | property | The original configuration (variables). | |
TestBase:: |
protected | property | The original configuration directories. | |
TestBase:: |
protected | property | The original container. | |
TestBase:: |
protected | property | The original file directory, before it was changed for testing purposes. | |
TestBase:: |
protected | property | The original language. | |
TestBase:: |
protected | property | The original database prefix when running inside Simpletest. | |
TestBase:: |
protected | property | The original installation profile. | |
TestBase:: |
protected | property | The name of the session cookie of the test-runner. | |
TestBase:: |
protected | property | The settings array. | |
TestBase:: |
protected | property | The site directory of the original parent site. | |
TestBase:: |
protected | property | The private file directory for the test environment. | |
TestBase:: |
protected | property | The public file directory for the test environment. | |
TestBase:: |
public | property | Current results of this test case. | |
TestBase:: |
protected | property | The site directory of this test run. | |
TestBase:: |
protected | property | This class is skipped when looking for the source of an assertion. | |
TestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 4 |
TestBase:: |
protected | property | The temporary file directory for the test environment. | |
TestBase:: |
protected | property | The test run ID. | |
TestBase:: |
protected | property | Time limit for the test. | |
TestBase:: |
protected | property | The translation file directory for the test environment. | |
TestBase:: |
public | property | TRUE if verbose debugging is enabled. | |
TestBase:: |
protected | property | Safe class name for use in verbose output filenames. | |
TestBase:: |
protected | property | Directory where verbose output files are put. | |
TestBase:: |
protected | property | URL to the verbose output file directory. | |
TestBase:: |
protected | property | Incrementing identifier for verbose output filenames. | |
TestBase:: |
protected | function | Internal helper: stores the assert. | |
TestBase:: |
protected | function | Check to see if two values are equal. | |
TestBase:: |
protected | function | Asserts that a specific error has been logged to the PHP error log. | |
TestBase:: |
protected | function | Check to see if a value is false. | |
TestBase:: |
protected | function | Check to see if two values are identical. | |
TestBase:: |
protected | function | Checks to see if two objects are identical. | |
TestBase:: |
protected | function | Asserts that no errors have been logged to the PHP error.log thus far. | |
TestBase:: |
protected | function | Check to see if two values are not equal. | |
TestBase:: |
protected | function | Check to see if two values are not identical. | |
TestBase:: |
protected | function | Check to see if a value is not NULL. | |
TestBase:: |
protected | function | Check to see if a value is NULL. | |
TestBase:: |
protected | function | Check to see if a value is not false. | |
TestBase:: |
protected | function | Act on global state information before the environment is altered for a test. | 1 |
TestBase:: |
private | function | Changes the database connection to the prefixed one. | |
TestBase:: |
protected | function | Checks the matching requirements for Test. | 2 |
TestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
TestBase:: |
public | function | Returns a ConfigImporter object to import test importing of configuration. | 5 |
TestBase:: |
public | function | Copies configuration objects from source storage to target storage. | |
TestBase:: |
public static | function | Delete an assertion record by message ID. | |
TestBase:: |
protected | function | Fire an error assertion. | 3 |
TestBase:: |
public | function | Handle errors during test runs. | |
TestBase:: |
protected | function | Handle exceptions. | |
TestBase:: |
protected | function | Fire an assertion that is always negative. | |
TestBase:: |
public static | function | Ensures test files are deletable within file_unmanaged_delete_recursive(). | |
TestBase:: |
public static | function | Converts a list of possible parameters into a stack of permutations. | |
TestBase:: |
protected | function | Cycles through backtrace until the first non-assertion method is found. | |
TestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
TestBase:: |
public static | function | Returns the database connection to the site running Simpletest. | |
TestBase:: |
public | function | Gets the database prefix. | |
TestBase:: |
public | function | Gets the temporary files directory. | |
TestBase:: |
public static | function | Store an assertion from outside the testing context. | |
TestBase:: |
protected | function | Fire an assertion that is always positive. | |
TestBase:: |
private | function | Generates a database prefix for running tests. | |
TestBase:: |
private | function | Prepares the current environment for running the test. | |
TestBase:: |
private | function | Cleans up the test environment and restores the original environment. | |
TestBase:: |
public | function | Run all tests in this class. | 1 |
TestBase:: |
protected | function | Changes in memory settings. | |
TestBase:: |
protected | function | Helper method to store an assertion record in the configured database. | |
TestBase:: |
protected | function | Logs a verbose message in a text file. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. | |
UserCreationTrait:: |
protected | function | Creates an administrative role. Aliased as: drupalCreateAdminRole | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. Aliased as: drupalCreateRole | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. Aliased as: drupalCreateUser | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. | |
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. | |
ViewTestBase:: |
protected | function | Returns a very simple test dataset. | 1 |
ViewTestBase:: |
protected | function | Sets up the views_test_data.module. | |
ViewTestBase:: |
protected | function | Executes a view with debugging. | |
ViewTestBase:: |
protected | function | Asserts the existence of a button with a certain ID and label. | |
ViewTestBase:: |
protected | function | Orders a nested array containing a result set based on a given column. | |
ViewTestBase:: |
protected | function | Returns the schema definition. | 1 |
ViewTestBase:: |
protected | function | Returns the views data definition. | 8 |
WebTestBase:: |
protected | property | Additional cURL options. | |
WebTestBase:: |
protected | property | Whether or not to assert the presence of the X-Drupal-Ajax-Token. | |
WebTestBase:: |
protected | property | The class loader to use for installation and initialization of setup. | |
WebTestBase:: |
protected | property | The config directories used in this test. | |
WebTestBase:: |
protected | property | The current cookie file used by cURL. | |
WebTestBase:: |
protected | property | The cookies of the page currently loaded in the internal browser. | |
WebTestBase:: |
protected | property | Cookies to set on curl requests. | |
WebTestBase:: |
protected | property | The handle of the current cURL connection. | |
WebTestBase:: |
protected | property | An array of custom translations suitable for drupal_rewrite_settings(). | |
WebTestBase:: |
protected | property | Whether the files were copied to the test files directory. | |
WebTestBase:: |
protected | property | The headers of the page currently loaded in the internal browser. | |
WebTestBase:: |
protected | property |
The kernel used in this test. Overrides TestBase:: |
|
WebTestBase:: |
protected | property | The current user logged in using the internal browser. | |
WebTestBase:: |
protected | property | The number of meta refresh redirects to follow, or NULL if unlimited. | |
WebTestBase:: |
protected | property | The maximum number of redirects to follow when handling responses. | |
WebTestBase:: |
protected | property | The number of meta refresh redirects followed during ::drupalGet(). | |
WebTestBase:: |
protected | property | The original batch, before it was changed for testing purposes. | |
WebTestBase:: |
protected | property |
The original shutdown handlers array, before it was cleaned for testing. Overrides TestBase:: |
|
WebTestBase:: |
protected | property |
The original user, before it was changed to a clean uid = 1 for testing. Overrides TestBase:: |
|
WebTestBase:: |
protected | property | The profile to install as a basis for testing. | 30 |
WebTestBase:: |
protected | property | The number of redirects followed during the handling of a request. | |
WebTestBase:: |
protected | property | The "#1" admin user. | |
WebTestBase:: |
protected | property | The current session ID, if available. | |
WebTestBase:: |
protected | property | The URL currently loaded in the internal browser. | |
WebTestBase:: |
protected | function | Queues custom translations to be written to settings.php. | |
WebTestBase:: |
protected | function | Checks to see whether a block appears on the page. | |
WebTestBase:: |
protected | function | Asserts whether an expected cache context was present in the last response. | |
WebTestBase:: |
protected | function | Asserts whether an expected cache tag was present in the last response. | |
WebTestBase:: |
protected | function | Check if a HTTP response header exists and has the expected value. | |
WebTestBase:: |
protected | function | Asserts that the most recently sent email message has the given value. | |
WebTestBase:: |
protected | function | Asserts that the most recently sent email message has the pattern in it. | |
WebTestBase:: |
protected | function | Asserts that the most recently sent email message has the string in it. | |
WebTestBase:: |
protected | function | Checks to see whether a block does not appears on the page. | |
WebTestBase:: |
protected | function | Asserts that a cache context was not present in the last response. | |
WebTestBase:: |
protected | function | Asserts whether an expected cache tag was absent in the last response. | |
WebTestBase:: |
protected | function | Asserts the page did not return the specified response code. | |
WebTestBase:: |
protected | function | Asserts the page responds with the specified response code. | |
WebTestBase:: |
protected | function | Passes if the internal browser's URL matches the given path. | |
WebTestBase:: |
protected | function | Builds an a absolute URL from a system path or a URL object. | |
WebTestBase:: |
protected | function | Checks for meta refresh tag and if found call drupalGet() recursively. | |
WebTestBase:: |
protected | function | Follows a link by complete name. | |
WebTestBase:: |
protected | function | Provides a helper for ::clickLink() and ::clickLinkPartialName(). | |
WebTestBase:: |
protected | function | Follows a link by partial name. | |
WebTestBase:: |
protected | function | Runs cron in the Drupal installed by Simpletest. | |
WebTestBase:: |
protected | function | Close the cURL handler and unset the handler. | |
WebTestBase:: |
protected | function | Initializes and executes a cURL request. | 2 |
WebTestBase:: |
protected | function | Reads headers and registers errors received from the tested site. | |
WebTestBase:: |
protected | function | Initializes the cURL connection. | |
WebTestBase:: |
protected | function | Execute the non-interactive installer. | |
WebTestBase:: |
protected | function | Builds the renderable view of an entity. | |
WebTestBase:: |
protected | function | Compare two files based on size and file name. | |
WebTestBase:: |
protected | function | Creates a custom content type based on default settings. | |
WebTestBase:: |
protected | function | Creates a node based on default settings. | |
WebTestBase:: |
protected | function | Retrieves a Drupal path or an absolute path. | 1 |
WebTestBase:: |
protected | function | Requests a path or URL in drupal_ajax format and JSON-decodes the response. | |
WebTestBase:: |
protected | function | Gets the value of an HTTP response header. | |
WebTestBase:: |
protected | function | Gets the HTTP response headers of the requested page. | |
WebTestBase:: |
protected | function | Retrieves a Drupal path or an absolute path and JSON decodes the result. | |
WebTestBase:: |
protected | function | Gets an array containing all emails sent during this test case. | |
WebTestBase:: |
function | Get a node from the database based on its title. | ||
WebTestBase:: |
protected | function | Gets a list of files that can be used in tests. | |
WebTestBase:: |
protected | function | Retrieves a Drupal path or an absolute path for a given format. | |
WebTestBase:: |
protected | function | Requests a Drupal path or an absolute path as if it is a XMLHttpRequest. | |
WebTestBase:: |
protected | function | Retrieves only the headers for a Drupal path or an absolute path. | |
WebTestBase:: |
protected | function | Log in a user with the internal browser. | |
WebTestBase:: |
protected | function | Logs a user out of the internal browser and confirms. | |
WebTestBase:: |
protected | function | Creates a block instance based on default settings. | |
WebTestBase:: |
protected | function | Perform a POST HTTP request. | |
WebTestBase:: |
protected | function | Executes an Ajax form submission. | |
WebTestBase:: |
protected | function | Executes a form submission. | |
WebTestBase:: |
protected | function | Performs a POST HTTP request with a specific format. | |
WebTestBase:: |
protected | function | Processes an AJAX response into current content. | |
WebTestBase:: |
protected | function | Returns whether a given user account is logged in. | |
WebTestBase:: |
protected | function | Find a block instance on the page. | |
WebTestBase:: |
protected | function | Takes a path and returns an absolute path. | |
WebTestBase:: |
protected | function | Get the Ajax page state from drupalSettings and prepare it for POSTing. | |
WebTestBase:: |
protected | function | Returns all supported database driver installer objects. | |
WebTestBase:: |
protected | function | Handles form input related to drupalPostForm(). | |
WebTestBase:: |
protected | function | Initialize various configurations post-installation. | |
WebTestBase:: |
protected | function | Initializes the kernel after installation. | |
WebTestBase:: |
protected | function | Initialize settings created during install. | |
WebTestBase:: |
protected | function | Initializes user 1 for the site to be installed. | |
WebTestBase:: |
protected | function | Install modules defined by `static::$modules`. | |
WebTestBase:: |
protected | function | Returns the parameters that will be used when Simpletest installs Drupal. | 2 |
WebTestBase:: |
protected | function | Returns whether the test is being executed from within a test site. | |
WebTestBase:: |
protected | function | Creates a mock request and sets it on the generator. | |
WebTestBase:: |
protected | function | Prepares site settings and services before installation. | 1 |
WebTestBase:: |
protected | function | Reset and rebuild the environment after setup. | |
WebTestBase:: |
protected | function | Rebuilds \Drupal::getContainer(). | |
WebTestBase:: |
protected | function | Refreshes in-memory configuration and state information. | 1 |
WebTestBase:: |
protected | function | Resets all data structures after having enabled new modules. | |
WebTestBase:: |
protected | function | Restore the original batch. | |
WebTestBase:: |
protected | function | Serialize POST HTTP request values. | |
WebTestBase:: |
protected | function | Preserve the original batch, and instantiate the test batch. | |
WebTestBase:: |
protected | function | Changes parameters in the services.yml file. | |
WebTestBase:: |
protected | function | Enables/disables the cacheability headers. | |
WebTestBase:: |
protected | function |
Cleans up after testing. Overrides TestBase:: |
2 |
WebTestBase:: |
protected | function | Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm(). | |
WebTestBase:: |
protected | function | Outputs to verbose the most recent $count emails sent. | |
WebTestBase:: |
protected | function | Writes custom translations to the test site's settings.php. | |
WebTestBase:: |
protected | function | Rewrites the settings.php file of the test site. | |
WebTestBase:: |
function |
Constructor for \Drupal\simpletest\WebTestBase. Overrides TestBase:: |
1 |