class CommentExtrasTest

Same name in other branches
  1. 10 core/modules/jsonapi/tests/src/Functional/CommentExtrasTest.php \Drupal\Tests\jsonapi\Functional\CommentExtrasTest

JSON:API integration test for the "Comment" content entity type.

@group jsonapi

Hierarchy

Expanded class hierarchy of CommentExtrasTest

File

core/modules/jsonapi/tests/src/Functional/CommentExtrasTest.php, line 17

Namespace

Drupal\Tests\jsonapi\Functional
View source
class CommentExtrasTest extends CommentTest {
    public function setUp() : void {
        // Don't run any test methods from CommentTest because those will get run
        // for CommentTest itself.
        if (method_exists(parent::class, $this->name())) {
            $this->markTestSkipped();
        }
        parent::setUp();
    }
    
    /**
     * 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() : void {
        $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() : void {
        $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);
        $document = $this->getDocumentFromResponse($response);
        $this->assertResourceResponse(201, FALSE, $response);
        $this->assertFalse($document['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);
        $document = $this->getDocumentFromResponse($response);
        $this->assertResourceResponse(201, FALSE, $response);
        $this->assertTrue($document['data']['attributes']['status']);
        $this->assertTrue($this->entityStorage
            ->loadUnchanged(3)
            ->isPublished());
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 41
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
CommentExtrasTest::setUp public function Overrides ResourceTestBase::setUp
CommentExtrasTest::testPostIndividualDxWithoutCriticalBaseFields public function Tests POSTing a comment without critical base fields.
CommentExtrasTest::testPostIndividualSkipCommentApproval public function Tests POSTing a comment with and without 'skip comment approval'.
CommentTest::$commentedEntity private property
CommentTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
CommentTest::$entity protected property Overrides ResourceTestBase::$entity
CommentTest::$entityTypeId protected static property The tested entity type. Overrides ResourceTestBase::$entityTypeId
CommentTest::$modules protected static property Modules to install. Overrides ResourceTestBase::$modules
CommentTest::$patchProtectedFieldNames protected static property The fields that are protected against modification during PATCH requests. Overrides ResourceTestBase::$patchProtectedFieldNames
CommentTest::$resourceTypeName protected static property The name of the tested JSON:API resource type. Overrides ResourceTestBase::$resourceTypeName
CommentTest::createEntity protected function Creates the entity to be tested. Overrides ResourceTestBase::createEntity
CommentTest::doTestPatchIndividual protected function Tests PATCHing an individual resource, plus edge cases to ensure good DX. Overrides ResourceTestBase::doTestPatchIndividual
CommentTest::entityAccess protected static function Checks access for the given operation on the given entity. Overrides ResourceTestBase::entityAccess
CommentTest::getExpectedCacheContexts protected function The expected cache contexts for the GET/HEAD response of the test entity. Overrides ResourceTestBase::getExpectedCacheContexts
CommentTest::getExpectedCacheTags protected function The expected cache tags for the GET/HEAD response of the test entity. Overrides ResourceTestBase::getExpectedCacheTags
CommentTest::getExpectedCollectionCacheability protected static function Computes the cacheability for a given entity collection. Overrides ResourceTestBase::getExpectedCollectionCacheability
CommentTest::getExpectedDocument protected function Returns the expected JSON:API document for the entity. Overrides ResourceTestBase::getExpectedDocument
CommentTest::getExpectedUnauthorizedAccessCacheability protected function Returns the expected cacheability for an unauthorized response. Overrides ResourceTestBase::getExpectedUnauthorizedAccessCacheability
CommentTest::getExpectedUnauthorizedAccessMessage protected function Return the expected error message. Overrides ResourceTestBase::getExpectedUnauthorizedAccessMessage
CommentTest::getIncludePermissions protected static function Authorize the user under test with additional permissions to view includes. Overrides ResourceTestBase::getIncludePermissions
CommentTest::getPostDocument protected function Returns the JSON:API POST document. Overrides ResourceTestBase::getPostDocument
CommentTest::setUpAuthorization protected function Sets up the necessary authorization. Overrides ResourceTestBase::setUpAuthorization
CommentTest::testCollectionFilterAccess public function
CommentTestTrait::addDefaultCommentField protected function Adds the default comment field to an entity.
CommonCollectionFilterAccessTestPatternsTrait::doTestCollectionFilterAccessBasedOnPermissions public function Implements ::testCollectionFilterAccess() for pure permission-based access.
CommonCollectionFilterAccessTestPatternsTrait::doTestCollectionFilterAccessForPublishableEntities public function Implements ::testCollectionFilterAccess() for permission + status access.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentModerationTestTrait::addEntityTypeAndBundleToWorkflow protected function Adds an entity type ID / bundle ID to the given workflow. 1
ContentModerationTestTrait::createEditorialWorkflow protected function Creates the editorial workflow. 1
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
EntityReferenceFieldCreationTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 3
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 29
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
GetDocumentFromResponseTrait::getDocumentFromResponse protected function Retrieve document from response, with basic validation.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
ResourceResponseTestTrait::addOmittedObject protected static function Add the omitted object to the document or merges it if one already exists.
ResourceResponseTestTrait::collectionHasResourceIdentifier protected static function Determines if a given resource exists in a list of resources.
ResourceResponseTestTrait::errorsToOmittedObject protected static function Maps error objects into an omitted object.
ResourceResponseTestTrait::extractLinks protected static function Extracts links from a document using a list of relationship field names.
ResourceResponseTestTrait::getAccessDeniedResponse protected static function Gets a generic forbidden response.
ResourceResponseTestTrait::getEmptyCollectionResponse protected function Gets a generic empty collection response.
ResourceResponseTestTrait::getExpectedIncludedResourceResponse protected function Gets an array of expected ResourceResponses for the given include paths.
ResourceResponseTestTrait::getLinkPaths protected static function Turns a list of relationship field names into an array of link paths.
ResourceResponseTestTrait::getRelatedLink protected static function Creates a related resource link for a given resource identifier and field.
ResourceResponseTestTrait::getRelatedResponses protected function Gets an array of related responses for the given field names.
ResourceResponseTestTrait::getRelationshipLink protected static function Creates a relationship link for a given resource identifier and field.
ResourceResponseTestTrait::getRelationshipResponses protected function Gets an array of relationship responses for the given field names.
ResourceResponseTestTrait::getResourceLink protected static function Creates an individual resource link for a given resource identifier.
ResourceResponseTestTrait::getResourceLinks protected static function Creates individual resource links for a list of resource identifiers.
ResourceResponseTestTrait::getResponses protected function Gets responses from an array of links.
ResourceResponseTestTrait::isResourceIdentifier protected static function Checks if a given array is a resource identifier.
ResourceResponseTestTrait::mergeOmittedObjects protected static function Merges the links of two omitted objects and returns a new omitted object.
ResourceResponseTestTrait::resetOmittedLinkKeys protected static function Resets omitted link keys.
ResourceResponseTestTrait::sortOmittedLinks protected static function Sorts an omitted link object array by href.
ResourceResponseTestTrait::sortResourceCollection protected static function Sorts a collection of resources or resource identifiers.
ResourceResponseTestTrait::toCollectionResourceResponse protected static function Merges individual responses into a collection response.
ResourceResponseTestTrait::toResourceIdentifier protected static function Maps an entity to a resource identifier.
ResourceResponseTestTrait::toResourceResponse protected static function Maps a response object to a JSON:API ResourceResponse.
ResourceResponseTestTrait::toResourceResponses protected static function Maps an array of PSR responses to JSON:API ResourceResponses.
ResourceTestBase::$account protected property The account to use for authentication.
ResourceTestBase::$anonymousUsersCanViewLabels protected static property Whether anonymous users can view labels of this resource type. 3
ResourceTestBase::$anotherEntity protected property Another entity of the same type used for testing.
ResourceTestBase::$entityStorage protected property The entity storage.
ResourceTestBase::$firstCreatedEntityId protected static property The entity ID for the first created entity in testPost(). 2
ResourceTestBase::$jsonApiMember protected static property The standard `jsonapi` top-level document member.
ResourceTestBase::$labelFieldName protected static property Specify which field is the 'label' field for testing a POST edge case. 2
ResourceTestBase::$newRevisionsShouldBeAutomatic protected static property Whether new revisions of updated entities should be created by default. 2
ResourceTestBase::$resourceType protected property The JSON:API resource type for the tested entity type plus bundle.
ResourceTestBase::$resourceTypeIsVersionable protected static property Whether the tested JSON:API resource is versionable. 7
ResourceTestBase::$secondCreatedEntityId protected static property The entity ID for the second created entity in testPost(). 2
ResourceTestBase::$serializer protected property The serializer service.
ResourceTestBase::$uniqueFieldNames protected static property Fields that need unique values. 1
ResourceTestBase::$uuidKey protected property The UUID key.
ResourceTestBase::alterExpectedDocumentForRevision protected function Alters the expected JSON:API document for revisions.
ResourceTestBase::assertResourceErrorResponse protected function Asserts that a resource error response has the given message.
ResourceTestBase::assertResourceResponse protected function Asserts that a resource response has the given status code and body.
ResourceTestBase::assertSameDocument protected function Asserts that an expected document matches the response body.
ResourceTestBase::createAnotherEntity protected function Creates another entity to be tested. 8
ResourceTestBase::decorateExpectedResponseForIncludedFields protected static function Decorates the expected response with included data and cache metadata.
ResourceTestBase::decorateResourceIdentifierWithDrupalInternalTargetId protected static function Adds drupal_internal__target_id to the meta of a resource identifier.
ResourceTestBase::doTestDeleteIndividual protected function Tests DELETEing an individual resource, plus edge cases to ensure good DX. 2
ResourceTestBase::doTestIncluded protected function Tests included resources.
ResourceTestBase::doTestPostIndividual protected function Tests POSTing an individual resource, plus edge cases to ensure good DX. 1
ResourceTestBase::doTestRelated protected function Performs one round of related route testing.
ResourceTestBase::doTestRelationshipGet protected function Performs one round of relationship route testing.
ResourceTestBase::doTestRelationshipMutation protected function Performs one round of relationship POST, PATCH and DELETE route testing. 1
ResourceTestBase::doTestSparseFieldSets protected function Tests sparse field sets.
ResourceTestBase::entityFieldAccess protected static function Checks access for the given field operation on the given entity.
ResourceTestBase::entityLoadUnchanged protected function Loads an entity in the test container, ignoring the static cache.
ResourceTestBase::getAuthenticationRequestOptions protected function Returns Guzzle request options for authentication.
ResourceTestBase::getData protected function Sets up a collection of entities of the same type for testing.
ResourceTestBase::getEditorialPermissions protected function Gets an array of permissions required to view and update any tested entity. 1
ResourceTestBase::getEntityDuplicate protected function
ResourceTestBase::getExpectedCollectionResponse protected function Returns a JSON:API collection document for the expected entities.
ResourceTestBase::getExpectedGetIndividualResourceResponse protected function Gets the expected individual ResourceResponse for GET.
ResourceTestBase::getExpectedGetRelationshipDocument protected function Gets an expected document for the given relationship.
ResourceTestBase::getExpectedGetRelationshipDocumentData protected function Gets the expected document data for the given relationship. 2
ResourceTestBase::getExpectedGetRelationshipResponse protected function Gets an expected ResourceResponse for the given relationship.
ResourceTestBase::getExpectedRelatedResponse protected function Builds an expected related ResourceResponse for the given field.
ResourceTestBase::getExpectedRelatedResponses protected function Builds an array of expected related ResourceResponses, keyed by field name.
ResourceTestBase::getExtraRevisionCacheTags protected function The expected cache tags when checking revision responses.
ResourceTestBase::getModifiedEntityForPatchTesting protected static function Clones the given entity and modifies all PATCH-protected fields.
ResourceTestBase::getModifiedEntityForPostTesting protected function Gets the normalized POST entity with random values for its unique fields. 2
ResourceTestBase::getNestedIncludePaths protected function Gets an array of all nested include paths to be tested.
ResourceTestBase::getPatchDocument protected function Returns the JSON:API PATCH document. 2
ResourceTestBase::getRelationshipFieldNames protected function Gets a list of public relationship names for the resource type under test.
ResourceTestBase::getSparseFieldSets protected function Returns an array of sparse fields sets to test. 4
ResourceTestBase::grantIncludedPermissions protected function Grants authorization to view includes.
ResourceTestBase::grantPermissionsToTestedRole protected function Grants permissions to the authenticated role.
ResourceTestBase::isReferenceFieldDefinition protected static function Determines if a given field definition is a reference field.
ResourceTestBase::makeNormalizationInvalid protected function Makes the given JSON:API document invalid. 1
ResourceTestBase::normalize protected function Generates a JSON:API normalization for the given entity.
ResourceTestBase::recursiveKsort protected static function Recursively sorts an array by key.
ResourceTestBase::removeResourceTypeFromDocument protected function Makes the JSON:API document violate the spec by omitting the resource type.
ResourceTestBase::resaveEntity protected function
ResourceTestBase::revokePermissions protected function Ensure the anonymous and authenticated roles have no permissions at all.
ResourceTestBase::revokePermissionsFromTestedRole protected function Revokes permissions from the authenticated role.
ResourceTestBase::setUpFields protected function Sets up additional fields for testing.
ResourceTestBase::setUpRevisionAuthorization protected function Sets up the necessary authorization for handling revisions. 4
ResourceTestBase::testCollection public function Tests GETting a collection of resources. 1
ResourceTestBase::testGetIndividual public function Tests GETting an individual resource, plus edge cases to ensure good DX. 2
ResourceTestBase::testIndividual public function Tests POST/PATCH/DELETE for an individual resource. 1
ResourceTestBase::testRelated public function Tests GET of the related resource of an individual resource. 2
ResourceTestBase::testRelationships public function Tests CRUD of individual resource relationship data. 1
ResourceTestBase::testRevisions public function Tests individual and collection revisions. 1
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.