class NodeTest in Drupal 9
Same name in this branch
- 9 core/modules/jsonapi/tests/src/Functional/NodeTest.php \Drupal\Tests\jsonapi\Functional\NodeTest
- 9 core/modules/node/tests/src/Kernel/Plugin/migrate/source/d6/NodeTest.php \Drupal\Tests\node\Kernel\Plugin\migrate\source\d6\NodeTest
- 9 core/modules/node/tests/src/Kernel/Plugin/migrate/source/d7/NodeTest.php \Drupal\Tests\node\Kernel\Plugin\migrate\source\d7\NodeTest
Same name and namespace in other branches
- 8 core/modules/jsonapi/tests/src/Functional/NodeTest.php \Drupal\Tests\jsonapi\Functional\NodeTest
- 10 core/modules/jsonapi/tests/src/Functional/NodeTest.php \Drupal\Tests\jsonapi\Functional\NodeTest
JSON:API integration test for the "Node" content entity type.
@group jsonapi
Hierarchy
- class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\jsonapi\Functional\ResourceTestBase uses ContentModerationTestTrait, JsonApiRequestTestTrait, ResourceResponseTestTrait
- class \Drupal\Tests\jsonapi\Functional\NodeTest uses CommonCollectionFilterAccessTestPatternsTrait
- class \Drupal\Tests\jsonapi\Functional\ResourceTestBase uses ContentModerationTestTrait, JsonApiRequestTestTrait, ResourceResponseTestTrait
Expanded class hierarchy of NodeTest
File
- core/
modules/ jsonapi/ tests/ src/ Functional/ NodeTest.php, line 22
Namespace
Drupal\Tests\jsonapi\FunctionalView source
class NodeTest extends ResourceTestBase {
use CommonCollectionFilterAccessTestPatternsTrait;
/**
* {@inheritdoc}
*/
protected static $modules = [
'node',
'path',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* {@inheritdoc}
*/
protected static $entityTypeId = 'node';
/**
* {@inheritdoc}
*/
protected static $resourceTypeName = 'node--camelids';
/**
* {@inheritdoc}
*/
protected static $resourceTypeIsVersionable = TRUE;
/**
* {@inheritdoc}
*/
protected static $newRevisionsShouldBeAutomatic = TRUE;
/**
* {@inheritdoc}
*
* @var \Drupal\node\NodeInterface
*/
protected $entity;
/**
* {@inheritdoc}
*/
protected static $patchProtectedFieldNames = [
'revision_timestamp' => NULL,
'created' => "The 'administer nodes' permission is required.",
'changed' => NULL,
'promote' => "The 'administer nodes' permission is required.",
'sticky' => "The 'administer nodes' permission is required.",
'path' => "The following permissions are required: 'create url aliases' OR 'administer url aliases'.",
'revision_uid' => NULL,
];
/**
* {@inheritdoc}
*/
protected function setUpAuthorization($method) {
switch ($method) {
case 'GET':
$this
->grantPermissionsToTestedRole([
'access content',
]);
break;
case 'POST':
$this
->grantPermissionsToTestedRole([
'access content',
'create camelids content',
]);
break;
case 'PATCH':
// Do not grant the 'create url aliases' permission to test the case
// when the path field is protected/not accessible, see
// \Drupal\Tests\rest\Functional\EntityResource\Term\TermResourceTestBase
// for a positive test.
$this
->grantPermissionsToTestedRole([
'access content',
'edit any camelids content',
]);
break;
case 'DELETE':
$this
->grantPermissionsToTestedRole([
'access content',
'delete any camelids content',
]);
break;
}
}
/**
* {@inheritdoc}
*/
protected function setUpRevisionAuthorization($method) {
parent::setUpRevisionAuthorization($method);
$this
->grantPermissionsToTestedRole([
'view all revisions',
]);
}
/**
* {@inheritdoc}
*/
protected function createEntity() {
if (!NodeType::load('camelids')) {
// Create a "Camelids" node type.
NodeType::create([
'name' => 'Camelids',
'type' => 'camelids',
])
->save();
}
// Create a "Llama" node.
$node = Node::create([
'type' => 'camelids',
]);
$node
->setTitle('Llama')
->setOwnerId($this->account
->id())
->setPublished()
->setCreatedTime(123456789)
->setChangedTime(123456789)
->setRevisionCreationTime(123456789)
->set('path', '/llama')
->save();
return $node;
}
/**
* {@inheritdoc}
*/
protected function getExpectedDocument() {
$author = User::load($this->entity
->getOwnerId());
$base_url = Url::fromUri('base:/jsonapi/node/camelids/' . $this->entity
->uuid())
->setAbsolute();
$self_url = clone $base_url;
$version_identifier = 'id:' . $this->entity
->getRevisionId();
$self_url = $self_url
->setOption('query', [
'resourceVersion' => $version_identifier,
]);
$version_query_string = '?resourceVersion=' . urlencode($version_identifier);
return [
'jsonapi' => [
'meta' => [
'links' => [
'self' => [
'href' => 'http://jsonapi.org/format/1.0/',
],
],
],
'version' => '1.0',
],
'links' => [
'self' => [
'href' => $base_url
->toString(),
],
],
'data' => [
'id' => $this->entity
->uuid(),
'type' => 'node--camelids',
'links' => [
'self' => [
'href' => $self_url
->toString(),
],
],
'attributes' => [
'created' => '1973-11-29T21:33:09+00:00',
'changed' => (new \DateTime())
->setTimestamp($this->entity
->getChangedTime())
->setTimezone(new \DateTimeZone('UTC'))
->format(\DateTime::RFC3339),
'default_langcode' => TRUE,
'langcode' => 'en',
'path' => [
'alias' => '/llama',
'pid' => 1,
'langcode' => 'en',
],
'promote' => TRUE,
'revision_log' => NULL,
'revision_timestamp' => '1973-11-29T21:33:09+00:00',
// @todo Attempt to remove this in https://www.drupal.org/project/drupal/issues/2933518.
'revision_translation_affected' => TRUE,
'status' => TRUE,
'sticky' => FALSE,
'title' => 'Llama',
'drupal_internal__nid' => 1,
'drupal_internal__vid' => 1,
],
'relationships' => [
'node_type' => [
'data' => [
'id' => NodeType::load('camelids')
->uuid(),
'meta' => [
'drupal_internal__target_id' => 'camelids',
],
'type' => 'node_type--node_type',
],
'links' => [
'related' => [
'href' => $base_url
->toString() . '/node_type' . $version_query_string,
],
'self' => [
'href' => $base_url
->toString() . '/relationships/node_type' . $version_query_string,
],
],
],
'uid' => [
'data' => [
'id' => $author
->uuid(),
'meta' => [
'drupal_internal__target_id' => (int) $author
->id(),
],
'type' => 'user--user',
],
'links' => [
'related' => [
'href' => $base_url
->toString() . '/uid' . $version_query_string,
],
'self' => [
'href' => $base_url
->toString() . '/relationships/uid' . $version_query_string,
],
],
],
'revision_uid' => [
'data' => [
'id' => $author
->uuid(),
'meta' => [
'drupal_internal__target_id' => (int) $author
->id(),
],
'type' => 'user--user',
],
'links' => [
'related' => [
'href' => $base_url
->toString() . '/revision_uid' . $version_query_string,
],
'self' => [
'href' => $base_url
->toString() . '/relationships/revision_uid' . $version_query_string,
],
],
],
],
],
];
}
/**
* {@inheritdoc}
*/
protected function getPostDocument() {
return [
'data' => [
'type' => 'node--camelids',
'attributes' => [
'title' => 'Dramallama',
],
],
];
}
/**
* {@inheritdoc}
*/
protected function getExpectedUnauthorizedAccessMessage($method) {
switch ($method) {
case 'GET':
case 'POST':
case 'PATCH':
case 'DELETE':
return "The 'access content' permission is required.";
}
}
/**
* Tests PATCHing a node's path with and without 'create url aliases'.
*
* For a positive test, see the similar test coverage for Term.
*
* @see \Drupal\Tests\jsonapi\Functional\TermTest::testPatchPath()
* @see \Drupal\Tests\rest\Functional\EntityResource\Term\TermResourceTestBase::testPatchPath()
*/
public function testPatchPath() {
$this
->setUpAuthorization('GET');
$this
->setUpAuthorization('PATCH');
$this
->config('jsonapi.settings')
->set('read_only', FALSE)
->save(TRUE);
// @todo Remove line below in favor of commented line in https://www.drupal.org/project/drupal/issues/2878463.
$url = Url::fromRoute(sprintf('jsonapi.%s.individual', static::$resourceTypeName), [
'entity' => $this->entity
->uuid(),
]);
// $url = $this->entity->toUrl('jsonapi');
// GET node's current normalization.
$response = $this
->request('GET', $url, $this
->getAuthenticationRequestOptions());
$normalization = Json::decode((string) $response
->getBody());
// Change node's path alias.
$normalization['data']['attributes']['path']['alias'] .= 's-rule-the-world';
// Create node PATCH request.
$request_options = $this
->getAuthenticationRequestOptions();
$request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';
$request_options[RequestOptions::BODY] = Json::encode($normalization);
// PATCH request: 403 when creating URL aliases unauthorized.
$response = $this
->request('PATCH', $url, $request_options);
$this
->assertResourceErrorResponse(403, "The current user is not allowed to PATCH the selected field (path). The following permissions are required: 'create url aliases' OR 'administer url aliases'.", $url, $response, '/data/attributes/path');
// Grant permission to create URL aliases.
$this
->grantPermissionsToTestedRole([
'create url aliases',
]);
// Repeat PATCH request: 200.
$response = $this
->request('PATCH', $url, $request_options);
$this
->assertResourceResponse(200, FALSE, $response);
$updated_normalization = Json::decode((string) $response
->getBody());
$this
->assertSame($normalization['data']['attributes']['path']['alias'], $updated_normalization['data']['attributes']['path']['alias']);
}
/**
* {@inheritdoc}
*/
public function testGetIndividual() {
parent::testGetIndividual();
$this
->assertCacheableNormalizations();
// Unpublish node.
$this->entity
->setUnpublished()
->save();
// @todo Remove line below in favor of commented line in https://www.drupal.org/project/drupal/issues/2878463.
$url = Url::fromRoute(sprintf('jsonapi.%s.individual', static::$resourceTypeName), [
'entity' => $this->entity
->uuid(),
]);
// $url = $this->entity->toUrl('jsonapi');
$request_options = $this
->getAuthenticationRequestOptions();
// 403 when accessing own unpublished node.
$response = $this
->request('GET', $url, $request_options);
// @todo Remove $expected + assertResourceResponse() in favor of the commented line below once https://www.drupal.org/project/drupal/issues/2943176 lands.
$expected_document = [
'jsonapi' => static::$jsonApiMember,
'errors' => [
[
'title' => 'Forbidden',
'status' => '403',
'detail' => 'The current user is not allowed to GET the selected resource.',
'links' => [
'info' => [
'href' => HttpExceptionNormalizer::getInfoUrl(403),
],
'via' => [
'href' => $url
->setAbsolute()
->toString(),
],
],
'source' => [
'pointer' => '/data',
],
],
],
];
$this
->assertResourceResponse(403, $expected_document, $response, [
'4xx-response',
'http_response',
'node:1',
], [
'url.query_args:resourceVersion',
'url.site',
'user.permissions',
], FALSE, 'MISS');
/* $this->assertResourceErrorResponse(403, 'The current user is not allowed to GET the selected resource.', $response, '/data'); */
// 200 after granting permission.
$this
->grantPermissionsToTestedRole([
'view own unpublished content',
]);
$response = $this
->request('GET', $url, $request_options);
// The response varies by 'user', causing the 'user.permissions' cache
// context to be optimized away.
$expected_cache_contexts = Cache::mergeContexts($this
->getExpectedCacheContexts(), [
'user',
]);
$expected_cache_contexts = array_diff($expected_cache_contexts, [
'user.permissions',
]);
$this
->assertResourceResponse(200, FALSE, $response, $this
->getExpectedCacheTags(), $expected_cache_contexts, FALSE, 'UNCACHEABLE');
}
/**
* Asserts that normalizations are cached in an incremental way.
*
* @throws \Drupal\Core\Entity\EntityStorageException
*/
protected function assertCacheableNormalizations() {
// Save the entity to invalidate caches.
$this->entity
->save();
$uuid = $this->entity
->uuid();
$cache = \Drupal::service('render_cache')
->get([
'#cache' => [
'keys' => [
'node--camelids',
$uuid,
],
'bin' => 'jsonapi_normalizations',
],
]);
// After saving the entity the normalization should not be cached.
$this
->assertFalse($cache);
// @todo Remove line below in favor of commented line in https://www.drupal.org/project/drupal/issues/2878463.
$url = Url::fromRoute(sprintf('jsonapi.%s.individual', static::$resourceTypeName), [
'entity' => $uuid,
]);
// $url = $this->entity->toUrl('jsonapi');
$request_options = $this
->getAuthenticationRequestOptions();
$request_options[RequestOptions::QUERY] = [
'fields' => [
'node--camelids' => 'title',
],
];
$this
->request('GET', $url, $request_options);
// Ensure the normalization cache is being incrementally built. After
// requesting the title, only the title is in the cache.
$this
->assertNormalizedFieldsAreCached([
'title',
]);
$request_options[RequestOptions::QUERY] = [
'fields' => [
'node--camelids' => 'field_rest_test',
],
];
$this
->request('GET', $url, $request_options);
// After requesting an additional field, then that field is in the cache and
// the old one is still there.
$this
->assertNormalizedFieldsAreCached([
'title',
'field_rest_test',
]);
}
/**
* Checks that the provided field names are the only fields in the cache.
*
* The normalization cache should only have these fields, which build up
* across responses.
*
* @param string[] $field_names
* The field names.
*/
protected function assertNormalizedFieldsAreCached($field_names) {
$cache = \Drupal::service('render_cache')
->get([
'#cache' => [
'keys' => [
'node--camelids',
$this->entity
->uuid(),
],
'bin' => 'jsonapi_normalizations',
],
]);
$cached_fields = $cache['#data']['fields'];
$this
->assertSameSize($field_names, $cached_fields);
array_walk($field_names, function ($field_name) use ($cached_fields) {
$this
->assertInstanceOf(CacheableNormalization::class, $cached_fields[$field_name]);
});
}
/**
* {@inheritdoc}
*/
protected static function getIncludePermissions() {
return [
'uid.node_type' => [
'administer users',
],
'uid.roles' => [
'administer permissions',
],
];
}
/**
* Creating relationships to missing resources should be 404 per JSON:API 1.1.
*
* @see https://github.com/json-api/json-api/issues/1033
*/
public function testPostNonExistingAuthor() {
$this
->setUpAuthorization('POST');
$this
->config('jsonapi.settings')
->set('read_only', FALSE)
->save(TRUE);
$this
->grantPermissionsToTestedRole([
'administer nodes',
]);
$random_uuid = \Drupal::service('uuid')
->generate();
$doc = $this
->getPostDocument();
$doc['data']['relationships']['uid']['data'] = [
'type' => 'user--user',
'id' => $random_uuid,
];
// Create node POST request.
$url = Url::fromRoute(sprintf('jsonapi.%s.collection.post', static::$resourceTypeName));
$request_options = $this
->getAuthenticationRequestOptions();
$request_options[RequestOptions::HEADERS]['Accept'] = 'application/vnd.api+json';
$request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';
$request_options[RequestOptions::BODY] = Json::encode($doc);
// POST request: 404 when adding relationships to non-existing resources.
$response = $this
->request('POST', $url, $request_options);
$expected_document = [
'errors' => [
0 => [
'status' => '404',
'title' => 'Not Found',
'detail' => "The resource identified by `user--user:{$random_uuid}` (given as a relationship item) could not be found.",
'links' => [
'info' => [
'href' => HttpExceptionNormalizer::getInfoUrl(404),
],
'via' => [
'href' => $url
->setAbsolute()
->toString(),
],
],
],
],
'jsonapi' => static::$jsonApiMember,
];
$this
->assertResourceResponse(404, $expected_document, $response);
}
/**
* {@inheritdoc}
*/
public function testCollectionFilterAccess() {
$label_field_name = 'title';
$this
->doTestCollectionFilterAccessForPublishableEntities($label_field_name, 'access content', 'bypass node access');
$collection_url = Url::fromRoute('jsonapi.entity_test--bar.collection');
$collection_filter_url = $collection_url
->setOption('query', [
"filter[spotlight.{$label_field_name}]" => $this->entity
->label(),
]);
$request_options = [];
$request_options[RequestOptions::HEADERS]['Accept'] = 'application/vnd.api+json';
$request_options = NestedArray::mergeDeep($request_options, $this
->getAuthenticationRequestOptions());
$this
->revokePermissionsFromTestedRole([
'bypass node access',
]);
// 0 results because the node is unpublished.
$response = $this
->request('GET', $collection_filter_url, $request_options);
$doc = Json::decode((string) $response
->getBody());
$this
->assertCount(0, $doc['data']);
$this
->grantPermissionsToTestedRole([
'view own unpublished content',
]);
// 1 result because the current user is the owner of the unpublished node.
$response = $this
->request('GET', $collection_filter_url, $request_options);
$doc = Json::decode((string) $response
->getBody());
$this
->assertCount(1, $doc['data']);
$this->entity
->setOwnerId(0)
->save();
// 0 results because the current user is no longer the owner.
$response = $this
->request('GET', $collection_filter_url, $request_options);
$doc = Json::decode((string) $response
->getBody());
$this
->assertCount(0, $doc['data']);
// Assert bubbling of cacheability from query alter hook.
$this
->assertTrue($this->container
->get('module_installer')
->install([
'node_access_test',
], TRUE), 'Installed modules.');
node_access_rebuild();
$this
->rebuildAll();
$response = $this
->request('GET', $collection_filter_url, $request_options);
$this
->assertContains('user.node_grants:view', explode(' ', $response
->getHeader('X-Drupal-Cache-Contexts')[0]));
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | Asserts whether an expected cache tag was present in the last response. | |
AssertLegacyTrait:: |
protected | function | Asserts that the element with the given CSS selector is not present. | |
AssertLegacyTrait:: |
protected | function | Asserts that the element with the given CSS selector is present. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertLegacyTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertLegacyTrait:: |
protected | function | Checks that current response header equals value. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertLegacyTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertLegacyTrait:: |
protected | function | Asserts whether an expected cache tag was absent in the last response. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text is not found escaped on the loaded page. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does NOT exist with the given name or ID. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertLegacyTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertLegacyTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertLegacyTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option does NOT exist in the current page. | |
AssertLegacyTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is not found in the raw content. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS not found on the loaded page, fail otherwise. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertLegacyTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertLegacyTrait:: |
protected | function | Asserts the page responds with the specified response code. | |
AssertLegacyTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertLegacyTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertLegacyTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertLegacyTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertLegacyTrait:: |
protected | function | Passes if the internal browser's URL matches the given path. | |
AssertLegacyTrait:: |
protected | function | Builds an XPath query. | |
AssertLegacyTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertLegacyTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertLegacyTrait:: |
protected | function | Gets the current raw content. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
BlockCreationTrait:: |
protected | function | Creates a block instance based on default settings. Aliased as: drupalPlaceBlock | |
BrowserHtmlDebugTrait:: |
protected | property | The Base URI to use for links to the output files. | |
BrowserHtmlDebugTrait:: |
protected | property | Class name for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Counter for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Counter storage for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Directory name for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | HTML output output enabled. | |
BrowserHtmlDebugTrait:: |
protected | property | The file name to write the list of URLs to. | |
BrowserHtmlDebugTrait:: |
protected | property | HTML output test ID. | |
BrowserHtmlDebugTrait:: |
protected | function | Formats HTTP headers as string for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | function | Returns headers in HTML output format. | 1 |
BrowserHtmlDebugTrait:: |
protected | function | Provides a Guzzle middleware handler to log every response received. | |
BrowserHtmlDebugTrait:: |
protected | function | Logs a HTML output message in a text file. | |
BrowserHtmlDebugTrait:: |
protected | function | Creates the directory to store browser output. | |
BrowserTestBase:: |
protected | property | The base URL. | |
BrowserTestBase:: |
protected | property | The config importer that can be used in a test. | |
BrowserTestBase:: |
protected | property | An array of custom translations suitable for drupal_rewrite_settings(). | |
BrowserTestBase:: |
protected | property | The database prefix of this test run. | |
BrowserTestBase:: |
protected | property | Mink session manager. | |
BrowserTestBase:: |
protected | property | Mink default driver params. | |
BrowserTestBase:: |
protected | property | Mink class for the default driver to use. | 1 |
BrowserTestBase:: |
protected | property | The original container. | |
BrowserTestBase:: |
protected | property | The original array of shutdown function callbacks. | |
BrowserTestBase:: |
protected | property | ||
BrowserTestBase:: |
protected | property | The profile to install as a basis for testing. | 39 |
BrowserTestBase:: |
protected | property | The app root. | |
BrowserTestBase:: |
protected | property | Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests. | |
BrowserTestBase:: |
protected | property | Time limit in seconds for the test. | |
BrowserTestBase:: |
protected | property | The translation file directory for the test environment. | |
BrowserTestBase:: |
protected | function | Clean up the Simpletest environment. | |
BrowserTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
BrowserTestBase:: |
protected | function | Gets the value of an HTTP response header. | |
BrowserTestBase:: |
public static | function | Ensures test files are deletable. | |
BrowserTestBase:: |
protected | function | Gets an instance of the default Mink driver. | |
BrowserTestBase:: |
protected | function | Gets the JavaScript drupalSettings variable for the currently-loaded page. | 1 |
BrowserTestBase:: |
protected | function | Obtain the HTTP client for the system under test. | |
BrowserTestBase:: |
protected | function | Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. | 1 |
BrowserTestBase:: |
protected | function | Helper function to get the options of select field. | |
BrowserTestBase:: |
public | function | Returns Mink session. | |
BrowserTestBase:: |
protected | function | Get session cookies from current session. | |
BrowserTestBase:: |
protected | function |
Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait:: |
|
BrowserTestBase:: |
protected | function | Visits the front page when initializing Mink. | 3 |
BrowserTestBase:: |
protected | function | Initializes Mink sessions. | 1 |
BrowserTestBase:: |
public | function | Installs Drupal into the Simpletest site. | 1 |
BrowserTestBase:: |
protected | function | Registers additional Mink sessions. | |
BrowserTestBase:: |
protected | function | Sets up the root application path. | |
BrowserTestBase:: |
public static | function | 1 | |
BrowserTestBase:: |
protected | function | 3 | |
BrowserTestBase:: |
protected | function | Transforms a nested array into a flat array suitable for submitForm(). | |
BrowserTestBase:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
BrowserTestBase:: |
public | function | Prevents serializing any properties. | |
CommonCollectionFilterAccessTestPatternsTrait:: |
public | function | Implements ::testCollectionFilterAccess() for pure permission-based access. | |
CommonCollectionFilterAccessTestPatternsTrait:: |
public | function | Implements ::testCollectionFilterAccess() for permission + status access. | |
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ContentModerationTestTrait:: |
protected | function | Adds an entity type ID / bundle ID to the given workflow. | 1 |
ContentModerationTestTrait:: |
protected | function | Creates the editorial workflow. | 1 |
ContentTypeCreationTrait:: |
protected | function | Creates a custom content type based on default settings. Aliased as: drupalCreateContentType | 1 |
EntityReferenceTestTrait:: |
protected | function | Creates a field of an entity reference field storage on the specified bundle. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
FunctionalTestSetupTrait:: |
protected | property | The flag to set 'apcu_ensure_unique_prefix' setting. | 1 |
FunctionalTestSetupTrait:: |
protected | property | The class loader to use for installation and initialization of setup. | |
FunctionalTestSetupTrait:: |
protected | property | The "#1" admin user. | |
FunctionalTestSetupTrait:: |
protected | function | Execute the non-interactive installer. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Returns all supported database driver installer objects. | |
FunctionalTestSetupTrait:: |
protected | function | Initialize various configurations post-installation. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Initializes the kernel after installation. | |
FunctionalTestSetupTrait:: |
protected | function | Initialize settings created during install. | |
FunctionalTestSetupTrait:: |
protected | function | Initializes user 1 for the site to be installed. | |
FunctionalTestSetupTrait:: |
protected | function | Installs the default theme defined by `static::$defaultTheme` when needed. | |
FunctionalTestSetupTrait:: |
protected | function | Install modules defined by `static::$modules`. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Returns the parameters that will be used when Simpletest installs Drupal. | 9 |
FunctionalTestSetupTrait:: |
protected | function | Prepares the current environment for running the test. | 20 |
FunctionalTestSetupTrait:: |
protected | function | Creates a mock request and sets it on the generator. | |
FunctionalTestSetupTrait:: |
protected | function | Prepares site settings and services before installation. | 2 |
FunctionalTestSetupTrait:: |
protected | function | Resets and rebuilds the environment after setup. | |
FunctionalTestSetupTrait:: |
protected | function | Rebuilds \Drupal::getContainer(). | |
FunctionalTestSetupTrait:: |
protected | function | Resets all data structures after having enabled new modules. | |
FunctionalTestSetupTrait:: |
protected | function | Changes parameters in the services.yml file. | |
FunctionalTestSetupTrait:: |
protected | function | Sets up the base URL based upon the environment variable. | |
FunctionalTestSetupTrait:: |
protected | function | Rewrites the settings.php file of the test site. | 1 |
JsonApiRequestTestTrait:: |
protected | function | Adds the Xdebug cookie to the request options. | |
JsonApiRequestTestTrait:: |
protected | function | Performs a HTTP request. Wraps the Guzzle HTTP client. | |
NodeCreationTrait:: |
protected | function | Creates a node based on default settings. Aliased as: drupalCreateNode | |
NodeCreationTrait:: |
public | function | Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle | |
NodeTest:: |
protected | property |
The theme to install as the default for testing. Overrides BrowserTestBase:: |
|
NodeTest:: |
protected | property |
Overrides ResourceTestBase:: |
|
NodeTest:: |
protected static | property |
The tested entity type. Overrides ResourceTestBase:: |
|
NodeTest:: |
protected static | property |
Modules to enable. Overrides ResourceTestBase:: |
|
NodeTest:: |
protected static | property |
Whether new revisions of updated entities should be created by default. Overrides ResourceTestBase:: |
|
NodeTest:: |
protected static | property |
The fields that are protected against modification during PATCH requests. Overrides ResourceTestBase:: |
|
NodeTest:: |
protected static | property |
Whether the tested JSON:API resource is versionable. Overrides ResourceTestBase:: |
|
NodeTest:: |
protected static | property |
The name of the tested JSON:API resource type. Overrides ResourceTestBase:: |
|
NodeTest:: |
protected | function | Asserts that normalizations are cached in an incremental way. | |
NodeTest:: |
protected | function | Checks that the provided field names are the only fields in the cache. | |
NodeTest:: |
protected | function |
Creates the entity to be tested. Overrides ResourceTestBase:: |
|
NodeTest:: |
protected | function |
Returns the expected JSON:API document for the entity. Overrides ResourceTestBase:: |
|
NodeTest:: |
protected | function |
Return the expected error message. Overrides ResourceTestBase:: |
|
NodeTest:: |
protected static | function |
Authorize the user under test with additional permissions to view includes. Overrides ResourceTestBase:: |
|
NodeTest:: |
protected | function |
Returns the JSON:API POST document. Overrides ResourceTestBase:: |
|
NodeTest:: |
protected | function |
Sets up the necessary authorization. Overrides ResourceTestBase:: |
|
NodeTest:: |
protected | function |
Sets up the necessary authorization for handling revisions. Overrides ResourceTestBase:: |
|
NodeTest:: |
public | function | ||
NodeTest:: |
public | function |
Tests GETting an individual resource, plus edge cases to ensure good DX. Overrides ResourceTestBase:: |
|
NodeTest:: |
public | function | Tests PATCHing a node's path with and without 'create url aliases'. | |
NodeTest:: |
public | function | Creating relationships to missing resources should be 404 per JSON:API 1.1. | |
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. | |
RefreshVariablesTrait:: |
protected | function | Refreshes in-memory configuration and state information. | 1 |
ResourceResponseTestTrait:: |
protected static | function | Add the omitted object to the document or merges it if one already exists. | |
ResourceResponseTestTrait:: |
protected static | function | Determines if a given resource exists in a list of resources. | |
ResourceResponseTestTrait:: |
protected static | function | Maps error objects into an omitted object. | |
ResourceResponseTestTrait:: |
protected static | function | Extracts links from a document using a list of relationship field names. | |
ResourceResponseTestTrait:: |
protected static | function | Gets a generic forbidden response. | |
ResourceResponseTestTrait:: |
protected | function | Gets a generic empty collection response. | |
ResourceResponseTestTrait:: |
protected | function | Gets an array of expected ResourceResponses for the given include paths. | |
ResourceResponseTestTrait:: |
protected static | function | Turns a list of relationship field names into an array of link paths. | |
ResourceResponseTestTrait:: |
protected static | function | Creates a related resource link for a given resource identifier and field. | |
ResourceResponseTestTrait:: |
protected | function | Gets an array of related responses for the given field names. | |
ResourceResponseTestTrait:: |
protected static | function | Creates a relationship link for a given resource identifier and field. | |
ResourceResponseTestTrait:: |
protected | function | Gets an array of relationship responses for the given field names. | |
ResourceResponseTestTrait:: |
protected static | function | Creates an individual resource link for a given resource identifier. | |
ResourceResponseTestTrait:: |
protected static | function | Creates individual resource links for a list of resource identifiers. | |
ResourceResponseTestTrait:: |
protected | function | Gets responses from an array of links. | |
ResourceResponseTestTrait:: |
protected static | function | Checks if a given array is a resource identifier. | |
ResourceResponseTestTrait:: |
protected static | function | Merges the links of two omitted objects and returns a new omitted object. | |
ResourceResponseTestTrait:: |
protected static | function | Resets omitted link keys. | |
ResourceResponseTestTrait:: |
protected static | function | Sorts an omitted link object array by href. | |
ResourceResponseTestTrait:: |
protected static | function | Sorts a collection of resources or resource identifiers. | |
ResourceResponseTestTrait:: |
protected static | function | Merges individual responses into a collection response. | |
ResourceResponseTestTrait:: |
protected static | function | Maps an entity to a resource identifier. | |
ResourceResponseTestTrait:: |
protected static | function | Maps a response object to a JSON:API ResourceResponse. | |
ResourceResponseTestTrait:: |
protected static | function | Maps an array of PSR responses to JSON:API ResourceResponses. | |
ResourceTestBase:: |
protected | property | The account to use for authentication. | |
ResourceTestBase:: |
protected static | property | Whether anonymous users can view labels of this resource type. | 3 |
ResourceTestBase:: |
protected | property | Another entity of the same type used for testing. | |
ResourceTestBase:: |
protected | property | The entity storage. | |
ResourceTestBase:: |
protected static | property | The entity ID for the first created entity in testPost(). | 1 |
ResourceTestBase:: |
protected static | property | The standard `jsonapi` top-level document member. | |
ResourceTestBase:: |
protected static | property | Specify which field is the 'label' field for testing a POST edge case. | 2 |
ResourceTestBase:: |
protected | property | The JSON:API resource type for the tested entity type plus bundle. | |
ResourceTestBase:: |
protected static | property | The entity ID for the second created entity in testPost(). | 1 |
ResourceTestBase:: |
protected | property | The serializer service. | |
ResourceTestBase:: |
protected static | property | Fields that need unique values. | 1 |
ResourceTestBase:: |
protected | property | The UUID key. | |
ResourceTestBase:: |
protected | function | Asserts that a resource error response has the given message. | |
ResourceTestBase:: |
protected | function | Asserts that a resource response has the given status code and body. | |
ResourceTestBase:: |
protected | function | Asserts that an expected document matches the response body. | |
ResourceTestBase:: |
protected | function | Creates another entity to be tested. | 10 |
ResourceTestBase:: |
protected static | function | Decorates the expected response with included data and cache metadata. | |
ResourceTestBase:: |
protected static | function | Adds drupal_internal__target_id to the meta of a resource identifier. | |
ResourceTestBase:: |
protected | function | Tests included resources. | |
ResourceTestBase:: |
protected | function | Performs one round of related route testing. | |
ResourceTestBase:: |
protected | function | Performs one round of relationship route testing. | |
ResourceTestBase:: |
protected | function | Performs one round of relationship POST, PATCH and DELETE route testing. | 1 |
ResourceTestBase:: |
protected | function | Tests sparse field sets. | |
ResourceTestBase:: |
protected static | function | Checks access for the given operation on the given entity. | 3 |
ResourceTestBase:: |
protected static | function | Checks access for the given field operation on the given entity. | |
ResourceTestBase:: |
protected | function | Loads an entity in the test container, ignoring the static cache. | |
ResourceTestBase:: |
protected | function | Returns Guzzle request options for authentication. | |
ResourceTestBase:: |
protected | function | Sets up a collection of entities of the same type for testing. | |
ResourceTestBase:: |
protected | function | Gets an array of permissions required to view and update any tested entity. | 1 |
ResourceTestBase:: |
protected | function | ||
ResourceTestBase:: |
protected | function | The expected cache contexts for the GET/HEAD response of the test entity. | 8 |
ResourceTestBase:: |
protected | function | The expected cache tags for the GET/HEAD response of the test entity. | 5 |
ResourceTestBase:: |
protected static | function | Computes the cacheability for a given entity collection. | 5 |
ResourceTestBase:: |
protected | function | Returns a JSON:API collection document for the expected entities. | |
ResourceTestBase:: |
protected | function | Gets the expected individual ResourceResponse for GET. | |
ResourceTestBase:: |
protected | function | Gets an expected document for the given relationship. | |
ResourceTestBase:: |
protected | function | Gets the expected document data for the given relationship. | 2 |
ResourceTestBase:: |
protected | function | Gets an expected ResourceResponse for the given relationship. | |
ResourceTestBase:: |
protected | function | Builds an expected related ResourceResponse for the given field. | |
ResourceTestBase:: |
protected | function | Builds an array of expected related ResourceResponses, keyed by field name. | |
ResourceTestBase:: |
protected | function | Returns the expected cacheability for an unauthorized response. | 13 |
ResourceTestBase:: |
protected static | function | Clones the given entity and modifies all PATCH-protected fields. | |
ResourceTestBase:: |
protected | function | Gets the normalized POST entity with random values for its unique fields. | 1 |
ResourceTestBase:: |
protected | function | Gets an array of all nested include paths to be tested. | |
ResourceTestBase:: |
protected | function | Returns the JSON:API PATCH document. | |
ResourceTestBase:: |
protected | function | Gets a list of public relationship names for the resource type under test. | |
ResourceTestBase:: |
protected | function | Returns an array of sparse fields sets to test. | 3 |
ResourceTestBase:: |
protected | function | Grants authorization to view includes. | |
ResourceTestBase:: |
protected | function | Grants permissions to the authenticated role. | |
ResourceTestBase:: |
protected static | function | Determines if a given field definition is a reference field. | |
ResourceTestBase:: |
protected | function | Makes the given JSON:API document invalid. | 1 |
ResourceTestBase:: |
protected | function | Generates a JSON:API normalization for the given entity. | |
ResourceTestBase:: |
protected static | function | Recursively sorts an array by key. | |
ResourceTestBase:: |
protected | function | Makes the JSON:API document violate the spec by omitting the resource type. | |
ResourceTestBase:: |
protected | function | Revokes permissions from the authenticated role. | |
ResourceTestBase:: |
public | function |
Overrides BrowserTestBase:: |
7 |
ResourceTestBase:: |
protected | function | Sets up additional fields for testing. | |
ResourceTestBase:: |
public | function | Tests GETting a collection of resources. | 3 |
ResourceTestBase:: |
public | function | Tests DELETEing an individual resource, plus edge cases to ensure good DX. | 3 |
ResourceTestBase:: |
public | function | Tests PATCHing an individual resource, plus edge cases to ensure good DX. | 4 |
ResourceTestBase:: |
public | function | Tests POSTing an individual resource, plus edge cases to ensure good DX. | 4 |
ResourceTestBase:: |
public | function | Tests GET of the related resource of an individual resource. | 2 |
ResourceTestBase:: |
public | function | Tests CRUD of individual resource relationship data. | 3 |
ResourceTestBase:: |
public | function | Tests individual and collection revisions. | 1 |
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. | |
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. | |
TestSetupTrait:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
TestSetupTrait:: |
protected | property | The dependency injection container used in the test. | |
TestSetupTrait:: |
protected | property | The DrupalKernel instance used in the test. | |
TestSetupTrait:: |
protected | property | The site directory of the original parent site. | |
TestSetupTrait:: |
protected | property | The private file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The public file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The site directory of this test run. | |
TestSetupTrait:: |
protected | property | Set to TRUE to strict check all configuration saved. | 1 |
TestSetupTrait:: |
protected | property | The temporary file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The test run ID. | |
TestSetupTrait:: |
protected | function | Changes the database connection to the prefixed one. | |
TestSetupTrait:: |
protected | function | Gets the config schema exclusions for this test. | |
TestSetupTrait:: |
public static | function | Returns the database connection to the site running Simpletest. | |
TestSetupTrait:: |
protected | function | Generates a database prefix for running tests. | 1 |
UiHelperTrait:: |
protected | property | The current user logged in using the Mink controlled browser. | |
UiHelperTrait:: |
protected | property | The number of meta refresh redirects to follow, or NULL if unlimited. | |
UiHelperTrait:: |
protected | property | The number of meta refresh redirects followed during ::drupalGet(). | |
UiHelperTrait:: |
public | function | Returns WebAssert object. | 1 |
UiHelperTrait:: |
protected | function | Builds an absolute URL from a system path or a URL object. | |
UiHelperTrait:: |
protected | function | Checks for meta refresh tag and if found call drupalGet() recursively. | |
UiHelperTrait:: |
protected | function | Clicks the element with the given CSS selector. | |
UiHelperTrait:: |
protected | function | Follows a link by complete name. | |
UiHelperTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
UiHelperTrait:: |
protected | function | Translates a CSS expression to its XPath equivalent. | |
UiHelperTrait:: |
protected | function | Retrieves a Drupal path or an absolute path. | 2 |
UiHelperTrait:: |
protected | function | Logs in a user using the Mink controlled browser. | |
UiHelperTrait:: |
protected | function | Logs a user out of the Mink controlled browser and confirms. | |
UiHelperTrait:: |
protected | function | Executes a form submission. | |
UiHelperTrait:: |
protected | function | Returns whether a given user account is logged in. | |
UiHelperTrait:: |
protected | function | Takes a path and returns an absolute path. | |
UiHelperTrait:: |
protected | function | Retrieves the plain-text content from the current page. | |
UiHelperTrait:: |
protected | function | Get the current URL from the browser. | |
UiHelperTrait:: |
protected | function | Determines if test is using DrupalTestBrowser. | |
UiHelperTrait:: |
protected | function | Prepare for a request to testing site. | 1 |
UiHelperTrait:: |
protected | function | Fills and submits a form. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. | |
UserCreationTrait:: |
protected | function | Creates an administrative role. | |
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. | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. | |
XdebugRequestTrait:: |
protected | function | Adds xdebug cookies, from request setup. |