class CommentTest in Drupal 9
Same name in this branch
- 9 core/modules/jsonapi/tests/src/Functional/CommentTest.php \Drupal\Tests\jsonapi\Functional\CommentTest
- 9 core/modules/comment/tests/src/Kernel/Plugin/migrate/source/d6/CommentTest.php \Drupal\Tests\comment\Kernel\Plugin\migrate\source\d6\CommentTest
- 9 core/modules/comment/tests/src/Kernel/Plugin/migrate/source/d7/CommentTest.php \Drupal\Tests\comment\Kernel\Plugin\migrate\source\d7\CommentTest
Same name and namespace in other branches
- 8 core/modules/jsonapi/tests/src/Functional/CommentTest.php \Drupal\Tests\jsonapi\Functional\CommentTest
JSON:API integration test for the "Comment" 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\CommentTest uses CommentTestTrait, CommonCollectionFilterAccessTestPatternsTrait
- class \Drupal\Tests\jsonapi\Functional\ResourceTestBase uses ContentModerationTestTrait, JsonApiRequestTestTrait, ResourceResponseTestTrait
Expanded class hierarchy of CommentTest
File
- core/
modules/ jsonapi/ tests/ src/ Functional/ CommentTest.php, line 24
Namespace
Drupal\Tests\jsonapi\FunctionalView source
class CommentTest extends ResourceTestBase {
use CommentTestTrait;
use CommonCollectionFilterAccessTestPatternsTrait;
/**
* {@inheritdoc}
*/
protected static $modules = [
'comment',
'entity_test',
];
/**
* {@inheritdoc}
*/
protected static $entityTypeId = 'comment';
/**
* {@inheritdoc}
*/
protected static $resourceTypeName = 'comment--comment';
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* {@inheritdoc}
*/
protected static $patchProtectedFieldNames = [
'status' => "The 'administer comments' permission is required.",
'name' => "The 'administer comments' permission is required.",
'homepage' => "The 'administer comments' permission is required.",
'created' => "The 'administer comments' permission is required.",
'changed' => NULL,
'thread' => NULL,
'entity_type' => NULL,
'field_name' => NULL,
// @todo Uncomment this after https://www.drupal.org/project/drupal/issues/1847608 lands. Until then, it's impossible to test this.
// 'pid' => NULL,
'uid' => "The 'administer comments' permission is required.",
'entity_id' => NULL,
];
/**
* {@inheritdoc}
*
* @var \Drupal\comment\CommentInterface
*/
protected $entity;
/**
* @var \Drupal\entity_test\Entity\EntityTest
*/
private $commented_entity;
/**
* {@inheritdoc}
*/
protected function setUpAuthorization($method) {
switch ($method) {
case 'GET':
$this
->grantPermissionsToTestedRole([
'access comments',
'view test entity',
]);
break;
case 'POST':
$this
->grantPermissionsToTestedRole([
'post comments',
]);
break;
case 'PATCH':
$this
->grantPermissionsToTestedRole([
'edit own comments',
]);
break;
case 'DELETE':
$this
->grantPermissionsToTestedRole([
'administer comments',
]);
break;
}
}
/**
* {@inheritdoc}
*/
protected function createEntity() {
// Create a "bar" bundle for the "entity_test" entity type and create.
$bundle = 'bar';
entity_test_create_bundle($bundle, NULL, 'entity_test');
// Create a comment field on this bundle.
$this
->addDefaultCommentField('entity_test', 'bar', 'comment');
// Create a "Camelids" test entity that the comment will be assigned to.
$this->commented_entity = EntityTest::create([
'name' => 'Camelids',
'type' => 'bar',
]);
$this->commented_entity
->save();
// Create a "Llama" comment.
$comment = Comment::create([
'comment_body' => [
'value' => 'The name "llama" was adopted by European settlers from native Peruvians.',
'format' => 'plain_text',
],
'entity_id' => $this->commented_entity
->id(),
'entity_type' => 'entity_test',
'field_name' => 'comment',
]);
$comment
->setSubject('Llama')
->setOwnerId($this->account
->id())
->setPublished()
->setCreatedTime(123456789)
->setChangedTime(123456789);
$comment
->save();
return $comment;
}
/**
* {@inheritdoc}
*/
protected function getExpectedDocument() {
$self_url = Url::fromUri('base:/jsonapi/comment/comment/' . $this->entity
->uuid())
->setAbsolute()
->toString(TRUE)
->getGeneratedUrl();
$author = User::load($this->entity
->getOwnerId());
return [
'jsonapi' => [
'meta' => [
'links' => [
'self' => [
'href' => 'http://jsonapi.org/format/1.0/',
],
],
],
'version' => '1.0',
],
'links' => [
'self' => [
'href' => $self_url,
],
],
'data' => [
'id' => $this->entity
->uuid(),
'type' => 'comment--comment',
'links' => [
'self' => [
'href' => $self_url,
],
],
'attributes' => [
'created' => '1973-11-29T21:33:09+00:00',
'changed' => (new \DateTime())
->setTimestamp($this->entity
->getChangedTime())
->setTimezone(new \DateTimeZone('UTC'))
->format(\DateTime::RFC3339),
'comment_body' => [
'value' => 'The name "llama" was adopted by European settlers from native Peruvians.',
'format' => 'plain_text',
'processed' => "<p>The name "llama" was adopted by European settlers from native Peruvians.</p>\n",
],
'default_langcode' => TRUE,
'entity_type' => 'entity_test',
'field_name' => 'comment',
'homepage' => NULL,
'langcode' => 'en',
'name' => NULL,
'status' => TRUE,
'subject' => 'Llama',
'thread' => '01/',
'drupal_internal__cid' => (int) $this->entity
->id(),
],
'relationships' => [
'uid' => [
'data' => [
'id' => $author
->uuid(),
'meta' => [
'drupal_internal__target_id' => (int) $author
->id(),
],
'type' => 'user--user',
],
'links' => [
'related' => [
'href' => $self_url . '/uid',
],
'self' => [
'href' => $self_url . '/relationships/uid',
],
],
],
'comment_type' => [
'data' => [
'id' => CommentType::load('comment')
->uuid(),
'meta' => [
'drupal_internal__target_id' => 'comment',
],
'type' => 'comment_type--comment_type',
],
'links' => [
'related' => [
'href' => $self_url . '/comment_type',
],
'self' => [
'href' => $self_url . '/relationships/comment_type',
],
],
],
'entity_id' => [
'data' => [
'id' => $this->commented_entity
->uuid(),
'meta' => [
'drupal_internal__target_id' => (int) $this->commented_entity
->id(),
],
'type' => 'entity_test--bar',
],
'links' => [
'related' => [
'href' => $self_url . '/entity_id',
],
'self' => [
'href' => $self_url . '/relationships/entity_id',
],
],
],
'pid' => [
'data' => NULL,
'links' => [
'related' => [
'href' => $self_url . '/pid',
],
'self' => [
'href' => $self_url . '/relationships/pid',
],
],
],
],
],
];
}
/**
* {@inheritdoc}
*/
protected function getPostDocument() {
return [
'data' => [
'type' => 'comment--comment',
'attributes' => [
'entity_type' => 'entity_test',
'field_name' => 'comment',
'subject' => 'Dramallama',
'comment_body' => [
'value' => 'Llamas are awesome.',
'format' => 'plain_text',
],
],
'relationships' => [
'entity_id' => [
'data' => [
'type' => 'entity_test--bar',
'meta' => [
'drupal_internal__target_id' => 1,
],
'id' => EntityTest::load(1)
->uuid(),
],
],
],
],
];
}
/**
* {@inheritdoc}
*/
protected function getExpectedCacheTags(array $sparse_fieldset = NULL) {
$tags = parent::getExpectedCacheTags($sparse_fieldset);
if ($sparse_fieldset === NULL || in_array('comment_body', $sparse_fieldset)) {
$tags = Cache::mergeTags($tags, [
'config:filter.format.plain_text',
]);
}
return $tags;
}
/**
* {@inheritdoc}
*/
protected function getExpectedCacheContexts(array $sparse_fieldset = NULL) {
$contexts = parent::getExpectedCacheContexts($sparse_fieldset);
if ($sparse_fieldset === NULL || in_array('comment_body', $sparse_fieldset)) {
$contexts = Cache::mergeContexts($contexts, [
'languages:language_interface',
'theme',
]);
}
return $contexts;
}
/**
* {@inheritdoc}
*/
protected function getExpectedUnauthorizedAccessMessage($method) {
switch ($method) {
case 'GET':
return "The 'access comments' permission is required and the comment must be published.";
case 'POST':
return "The 'post comments' permission is required.";
case 'PATCH':
return "The 'edit own comments' permission is required, the user must be the comment author, and the comment must be published.";
default:
return parent::getExpectedUnauthorizedAccessMessage($method);
}
}
/**
* Tests POSTing a comment without critical base fields.
*
* Note that testPostIndividual() is testing with the most minimal
* normalization possible: the one returned by ::getNormalizedPostEntity().
*
* But Comment entities have some very special edge cases:
* - base fields that are not marked as required in
* \Drupal\comment\Entity\Comment::baseFieldDefinitions() yet in fact are
* required.
* - base fields that are marked as required, but yet can still result in
* validation errors other than "missing required field".
*/
public function testPostIndividualDxWithoutCriticalBaseFields() {
$this
->setUpAuthorization('POST');
$this
->config('jsonapi.settings')
->set('read_only', FALSE)
->save(TRUE);
$url = Url::fromRoute(sprintf('jsonapi.%s.collection.post', static::$resourceTypeName));
$request_options = [];
$request_options[RequestOptions::HEADERS]['Accept'] = 'application/vnd.api+json';
$request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';
$request_options = NestedArray::mergeDeep($request_options, $this
->getAuthenticationRequestOptions());
$remove_field = function (array $normalization, $type, $attribute_name) {
unset($normalization['data'][$type][$attribute_name]);
return $normalization;
};
// DX: 422 when missing 'entity_type' field.
$request_options[RequestOptions::BODY] = Json::encode($remove_field($this
->getPostDocument(), 'attributes', 'entity_type'));
$response = $this
->request('POST', $url, $request_options);
$this
->assertResourceErrorResponse(422, 'entity_type: This value should not be null.', NULL, $response, '/data/attributes/entity_type');
// DX: 422 when missing 'entity_id' field.
$request_options[RequestOptions::BODY] = Json::encode($remove_field($this
->getPostDocument(), 'relationships', 'entity_id'));
// @todo Remove the try/catch in https://www.drupal.org/node/2820364.
try {
$response = $this
->request('POST', $url, $request_options);
$this
->assertResourceErrorResponse(422, 'entity_id: This value should not be null.', NULL, $response, '/data/attributes/entity_id');
} catch (\Exception $e) {
$this
->assertSame("Error: Call to a member function get() on null\nDrupal\\comment\\Plugin\\Validation\\Constraint\\CommentNameConstraintValidator->getAnonymousContactDetailsSetting()() (Line: 96)\n", $e
->getMessage());
}
// DX: 422 when missing 'field_name' field.
$request_options[RequestOptions::BODY] = Json::encode($remove_field($this
->getPostDocument(), 'attributes', 'field_name'));
$response = $this
->request('POST', $url, $request_options);
$this
->assertResourceErrorResponse(422, 'field_name: This value should not be null.', NULL, $response, '/data/attributes/field_name');
}
/**
* Tests POSTing a comment with and without 'skip comment approval'.
*/
public function testPostIndividualSkipCommentApproval() {
$this
->setUpAuthorization('POST');
$this
->config('jsonapi.settings')
->set('read_only', FALSE)
->save(TRUE);
// Create request.
$request_options = [];
$request_options[RequestOptions::HEADERS]['Accept'] = 'application/vnd.api+json';
$request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';
$request_options = NestedArray::mergeDeep($request_options, $this
->getAuthenticationRequestOptions());
$request_options[RequestOptions::BODY] = Json::encode($this
->getPostDocument());
$url = Url::fromRoute('jsonapi.comment--comment.collection.post');
// Status should be FALSE when posting as anonymous.
$response = $this
->request('POST', $url, $request_options);
$this
->assertResourceResponse(201, FALSE, $response);
$this
->assertFalse(Json::decode((string) $response
->getBody())['data']['attributes']['status']);
$this
->assertFalse($this->entityStorage
->loadUnchanged(2)
->isPublished());
// Grant anonymous permission to skip comment approval.
$this
->grantPermissionsToTestedRole([
'skip comment approval',
]);
// Status must be TRUE when posting as anonymous and skip comment approval.
$response = $this
->request('POST', $url, $request_options);
$this
->assertResourceResponse(201, FALSE, $response);
$this
->assertTrue(Json::decode((string) $response
->getBody())['data']['attributes']['status']);
$this
->assertTrue($this->entityStorage
->loadUnchanged(3)
->isPublished());
}
/**
* {@inheritdoc}
*/
protected function getExpectedUnauthorizedAccessCacheability() {
// @see \Drupal\comment\CommentAccessControlHandler::checkAccess()
return parent::getExpectedUnauthorizedAccessCacheability()
->addCacheTags([
'comment:1',
]);
}
/**
* {@inheritdoc}
*/
protected static function entityAccess(EntityInterface $entity, $operation, AccountInterface $account) {
// Also reset the 'entity_test' entity access control handler because
// comment access also depends on access to the commented entity type.
\Drupal::entityTypeManager()
->getAccessControlHandler('entity_test')
->resetCache();
return parent::entityAccess($entity, $operation, $account);
}
/**
* {@inheritdoc}
*/
protected static function getIncludePermissions() {
return [
'type' => [
'administer comment types',
],
'uid' => [
'access user profiles',
],
];
}
/**
* {@inheritdoc}
*/
public function testCollectionFilterAccess() {
// Verify the expected behavior in the common case.
$this
->doTestCollectionFilterAccessForPublishableEntities('subject', 'access comments', 'administer comments');
$collection_url = Url::fromRoute('jsonapi.entity_test--bar.collection');
$request_options = [];
$request_options[RequestOptions::HEADERS]['Accept'] = 'application/vnd.api+json';
$request_options = NestedArray::mergeDeep($request_options, $this
->getAuthenticationRequestOptions());
// Go back to a simpler scenario: revoke the admin permission, publish the
// comment and uninstall the query access test module.
$this
->revokePermissionsFromTestedRole([
'administer comments',
]);
$this->entity
->setPublished()
->save();
$this
->assertTrue($this->container
->get('module_installer')
->uninstall([
'jsonapi_test_field_filter_access',
], TRUE), 'Uninstalled modules.');
// ?filter[spotlight.LABEL]: 1 result. Just as already tested above in
// ::doTestCollectionFilterAccessForPublishableEntities().
$collection_filter_url = $collection_url
->setOption('query', [
"filter[spotlight.subject]" => $this->entity
->label(),
]);
$response = $this
->request('GET', $collection_filter_url, $request_options);
$doc = Json::decode((string) $response
->getBody());
$this
->assertCount(1, $doc['data']);
// Mark the commented entity as inaccessible.
\Drupal::state()
->set('jsonapi__entity_test_filter_access_blacklist', [
$this->entity
->getCommentedEntityId(),
]);
Cache::invalidateTags([
'state:jsonapi__entity_test_filter_access_blacklist',
]);
// ?filter[spotlight.LABEL]: 0 results.
$response = $this
->request('GET', $collection_filter_url, $request_options);
$doc = Json::decode((string) $response
->getBody());
$this
->assertCount(0, $doc['data']);
}
/**
* {@inheritdoc}
*/
protected static function getExpectedCollectionCacheability(AccountInterface $account, array $collection, array $sparse_fieldset = NULL, $filtered = FALSE) {
$cacheability = parent::getExpectedCollectionCacheability($account, $collection, $sparse_fieldset, $filtered);
if ($filtered) {
$cacheability
->addCacheTags([
'state:jsonapi__entity_test_filter_access_blacklist',
]);
}
return $cacheability;
}
/**
* {@inheritdoc}
*/
public function testPatchIndividual() {
// Ensure ::getModifiedEntityForPatchTesting() can pick an alternative value
// for the 'entity_id' field.
EntityTest::create([
'name' => $this
->randomString(),
'type' => 'bar',
])
->save();
return parent::testPatchIndividual();
}
}
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. | |
CommentTest:: |
private | property | ||
CommentTest:: |
protected | property |
The theme to install as the default for testing. Overrides BrowserTestBase:: |
|
CommentTest:: |
protected | property |
Overrides ResourceTestBase:: |
|
CommentTest:: |
protected static | property |
The tested entity type. Overrides ResourceTestBase:: |
|
CommentTest:: |
protected static | property |
Modules to enable. Overrides ResourceTestBase:: |
|
CommentTest:: |
protected static | property |
The fields that are protected against modification during PATCH requests. Overrides ResourceTestBase:: |
|
CommentTest:: |
protected static | property |
The name of the tested JSON:API resource type. Overrides ResourceTestBase:: |
|
CommentTest:: |
protected | function |
Creates the entity to be tested. Overrides ResourceTestBase:: |
|
CommentTest:: |
protected static | function |
Checks access for the given operation on the given entity. Overrides ResourceTestBase:: |
|
CommentTest:: |
protected | function |
The expected cache contexts for the GET/HEAD response of the test entity. Overrides ResourceTestBase:: |
|
CommentTest:: |
protected | function |
The expected cache tags for the GET/HEAD response of the test entity. Overrides ResourceTestBase:: |
|
CommentTest:: |
protected static | function |
Computes the cacheability for a given entity collection. Overrides ResourceTestBase:: |
|
CommentTest:: |
protected | function |
Returns the expected JSON:API document for the entity. Overrides ResourceTestBase:: |
|
CommentTest:: |
protected | function |
Returns the expected cacheability for an unauthorized response. Overrides ResourceTestBase:: |
|
CommentTest:: |
protected | function |
Return the expected error message. Overrides ResourceTestBase:: |
|
CommentTest:: |
protected static | function |
Authorize the user under test with additional permissions to view includes. Overrides ResourceTestBase:: |
|
CommentTest:: |
protected | function |
Returns the JSON:API POST document. Overrides ResourceTestBase:: |
|
CommentTest:: |
protected | function |
Sets up the necessary authorization. Overrides ResourceTestBase:: |
|
CommentTest:: |
public | function | ||
CommentTest:: |
public | function |
Tests PATCHing an individual resource, plus edge cases to ensure good DX. Overrides ResourceTestBase:: |
|
CommentTest:: |
public | function | Tests POSTing a comment without critical base fields. | |
CommentTest:: |
public | function | Tests POSTing a comment with and without 'skip comment approval'. | |
CommentTestTrait:: |
public | function | Adds the default comment field to an entity. | |
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 | |
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 static | property | Whether new revisions of updated entities should be created by default. | 1 |
ResourceTestBase:: |
protected | property | The JSON:API resource type for the tested entity type plus bundle. | |
ResourceTestBase:: |
protected static | property | Whether the tested JSON:API resource is versionable. | 2 |
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 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 | 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 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:: |
protected | function | Sets up the necessary authorization for handling revisions. | 2 |
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 GETting 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. |