class CommentResourceTestBase

Same name in other branches
  1. 9 core/modules/comment/tests/src/Functional/Rest/CommentResourceTestBase.php \Drupal\Tests\comment\Functional\Rest\CommentResourceTestBase
  2. 8.9.x core/modules/rest/tests/src/Functional/EntityResource/Comment/CommentResourceTestBase.php \Drupal\Tests\rest\Functional\EntityResource\Comment\CommentResourceTestBase
  3. 8.9.x core/modules/comment/tests/src/Functional/Rest/CommentResourceTestBase.php \Drupal\Tests\comment\Functional\Rest\CommentResourceTestBase
  4. 10 core/modules/comment/tests/src/Functional/Rest/CommentResourceTestBase.php \Drupal\Tests\comment\Functional\Rest\CommentResourceTestBase

Hierarchy

Expanded class hierarchy of CommentResourceTestBase

File

core/modules/comment/tests/src/Functional/Rest/CommentResourceTestBase.php, line 18

Namespace

Drupal\Tests\comment\Functional\Rest
View source
abstract class CommentResourceTestBase extends EntityResourceTestBase {
    use CommentTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'comment',
        'entity_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected static $entityTypeId = 'comment';
    
    /**
     * {@inheritdoc}
     */
    protected static $patchProtectedFieldNames = [
        'status' => "The 'administer comments' permission is required.",
        'uid' => "The 'administer comments' permission is required.",
        'pid' => NULL,
        'entity_id' => NULL,
        '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,
    ];
    
    /**
     * @var \Drupal\comment\CommentInterface
     */
    protected $entity;
    
    /**
     * Marks some tests as skipped because XML cannot be deserialized.
     */
    public function commentResourceTestBaseSkipTests() : void {
        if (static::$format === 'xml' && in_array($this->name(), [
            'testPostDxWithoutCriticalBaseFields',
            'testPostSkipCommentApproval',
        ], TRUE)) {
            $this->markTestSkipped('Deserialization of the XML format is not supported.');
        }
    }
    
    /**
     * {@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':
                // Anonymous users are not ever allowed to edit their own comments. To
                // be able to test PATCHing comments as the anonymous user, the more
                // permissive 'administer comments' permission must be granted.
                // @see \Drupal\comment\CommentAccessControlHandler::checkAccess
                if (static::$auth) {
                    $this->grantPermissionsToTestedRole([
                        'edit own comments',
                    ]);
                }
                else {
                    $this->grantPermissionsToTestedRole([
                        'administer 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.
        $commented_entity = EntityTest::create([
            'name' => 'Camelids',
            'type' => 'bar',
            'comment' => CommentItemInterface::OPEN,
        ]);
        $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' => $commented_entity->id(),
            'entity_type' => 'entity_test',
            'field_name' => 'comment',
        ]);
        $comment->setSubject('Llama')
            ->setOwnerId(static::$auth ? $this->account
            ->id() : 0)
            ->setPublished()
            ->setCreatedTime(123456789)
            ->setChangedTime(123456789);
        $comment->save();
        return $comment;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getExpectedNormalizedEntity() {
        $author = User::load($this->entity
            ->getOwnerId());
        return [
            'cid' => [
                [
                    'value' => 1,
                ],
            ],
            'uuid' => [
                [
                    'value' => $this->entity
                        ->uuid(),
                ],
            ],
            'langcode' => [
                [
                    'value' => 'en',
                ],
            ],
            'comment_type' => [
                [
                    'target_id' => 'comment',
                    'target_type' => 'comment_type',
                    'target_uuid' => CommentType::load('comment')->uuid(),
                ],
            ],
            'subject' => [
                [
                    'value' => 'Llama',
                ],
            ],
            'status' => [
                [
                    'value' => TRUE,
                ],
            ],
            'created' => [
                [
                    'value' => (new \DateTime())->setTimestamp(123456789)
                        ->setTimezone(new \DateTimeZone('UTC'))
                        ->format(\DateTime::RFC3339),
                    'format' => \DateTime::RFC3339,
                ],
            ],
            'changed' => [
                [
                    'value' => (new \DateTime())->setTimestamp((int) $this->entity
                        ->getChangedTime())
                        ->setTimezone(new \DateTimeZone('UTC'))
                        ->format(\DateTime::RFC3339),
                    'format' => \DateTime::RFC3339,
                ],
            ],
            'default_langcode' => [
                [
                    'value' => TRUE,
                ],
            ],
            'uid' => [
                [
                    'target_id' => (int) $author->id(),
                    'target_type' => 'user',
                    'target_uuid' => $author->uuid(),
                    'url' => base_path() . 'user/' . $author->id(),
                ],
            ],
            'pid' => [],
            'entity_type' => [
                [
                    'value' => 'entity_test',
                ],
            ],
            'entity_id' => [
                [
                    'target_id' => 1,
                    'target_type' => 'entity_test',
                    'target_uuid' => EntityTest::load(1)->uuid(),
                    'url' => base_path() . 'entity_test/1',
                ],
            ],
            'field_name' => [
                [
                    'value' => 'comment',
                ],
            ],
            'name' => [],
            'homepage' => [],
            'thread' => [
                [
                    'value' => '01/',
                ],
            ],
            'comment_body' => [
                [
                    'value' => 'The name "llama" was adopted by European settlers from native Peruvians.',
                    'format' => 'plain_text',
                    'processed' => '<p>The name &quot;llama&quot; was adopted by European settlers from native Peruvians.</p>' . "\n",
                ],
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getNormalizedPostEntity() {
        return [
            'comment_type' => [
                [
                    'target_id' => 'comment',
                ],
            ],
            'entity_type' => [
                [
                    'value' => 'entity_test',
                ],
            ],
            'entity_id' => [
                [
                    'target_id' => (int) EntityTest::load(1)->id(),
                ],
            ],
            'field_name' => [
                [
                    'value' => 'comment',
                ],
            ],
            'subject' => [
                [
                    'value' => 'Drama llama',
                ],
            ],
            'comment_body' => [
                [
                    'value' => 'Llamas are awesome.',
                    'format' => 'plain_text',
                ],
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getNormalizedPatchEntity() {
        return array_diff_key($this->getNormalizedPostEntity(), [
            'entity_type' => TRUE,
            'entity_id' => TRUE,
            'field_name' => TRUE,
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getExpectedCacheTags() {
        return Cache::mergeTags(parent::getExpectedCacheTags(), [
            'config:filter.format.plain_text',
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getExpectedCacheContexts() {
        return Cache::mergeContexts([
            'languages:language_interface',
            'theme',
        ], parent::getExpectedCacheContexts());
    }
    
    /**
     * Tests POSTing a comment without critical base fields.
     *
     * Tests 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 testPostDxWithoutCriticalBaseFields() : void {
        $this->initAuthentication();
        $this->provisionEntityResource();
        $this->setUpAuthorization('POST');
        $url = $this->getEntityResourcePostUrl()
            ->setOption('query', [
            '_format' => static::$format,
        ]);
        $request_options = [];
        $request_options[RequestOptions::HEADERS]['Accept'] = static::$mimeType;
        $request_options[RequestOptions::HEADERS]['Content-Type'] = static::$mimeType;
        $request_options = array_merge_recursive($request_options, $this->getAuthenticationRequestOptions('POST'));
        // DX: 422 when missing 'entity_type' field.
        $request_options[RequestOptions::BODY] = $this->serializer
            ->encode(array_diff_key($this->getNormalizedPostEntity(), [
            'entity_type' => TRUE,
        ]), static::$format);
        $response = $this->request('POST', $url, $request_options);
        $this->assertResourceErrorResponse(422, "Unprocessable Entity: validation failed.\nentity_type: This value should not be null.\n", $response);
        // DX: 422 when missing 'entity_id' field.
        $request_options[RequestOptions::BODY] = $this->serializer
            ->encode(array_diff_key($this->getNormalizedPostEntity(), [
            'entity_id' => TRUE,
        ]), static::$format);
        $response = $this->request('POST', $url, $request_options);
        $this->assertResourceErrorResponse(422, "Unprocessable Entity: validation failed.\nentity_id: This value should not be null.\n", $response);
        // DX: 422 when missing 'field_name' field.
        $request_options[RequestOptions::BODY] = $this->serializer
            ->encode(array_diff_key($this->getNormalizedPostEntity(), [
            'field_name' => TRUE,
        ]), static::$format);
        $response = $this->request('POST', $url, $request_options);
        $this->assertResourceErrorResponse(422, "Unprocessable Entity: validation failed.\nfield_name: This value should not be null.\n", $response);
    }
    
    /**
     * {@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.";
            case 'DELETE':
            default:
                // \Drupal\comment\CommentAccessControlHandler::checkAccess() does not
                // specify a reason for not allowing a comment to be deleted.
                return '';
        }
    }
    
    /**
     * Tests POSTing a comment with and without 'skip comment approval'.
     */
    public function testPostSkipCommentApproval() : void {
        $this->initAuthentication();
        $this->provisionEntityResource();
        $this->setUpAuthorization('POST');
        // Create request.
        $request_options = [];
        $request_options[RequestOptions::HEADERS]['Accept'] = static::$mimeType;
        $request_options[RequestOptions::HEADERS]['Content-Type'] = static::$mimeType;
        $request_options = array_merge_recursive($request_options, $this->getAuthenticationRequestOptions('POST'));
        $request_options[RequestOptions::BODY] = $this->serializer
            ->encode($this->getNormalizedPostEntity(), static::$format);
        $url = $this->getEntityResourcePostUrl()
            ->setOption('query', [
            '_format' => static::$format,
        ]);
        // Status should be FALSE when posting as anonymous.
        $response = $this->request('POST', $url, $request_options);
        $unserialized = $this->serializer
            ->deserialize((string) $response->getBody(), get_class($this->entity), static::$format);
        $this->assertResourceResponse(201, FALSE, $response);
        $this->assertFalse($unserialized->isPublished());
        // Make sure the role save below properly invalidates cache tags.
        $this->refreshVariables();
        // Grant anonymous permission to skip comment approval.
        $this->grantPermissionsToTestedRole([
            'skip comment approval',
        ]);
        // Status should be TRUE when posting as anonymous and skip comment approval.
        $response = $this->request('POST', $url, $request_options);
        $unserialized = $this->serializer
            ->deserialize((string) $response->getBody(), get_class($this->entity), static::$format);
        $this->assertResourceResponse(201, FALSE, $response);
        $this->assertTrue($unserialized->isPublished());
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getExpectedUnauthorizedEntityAccessCacheability($is_authenticated) {
        // @see \Drupal\comment\CommentAccessControlHandler::checkAccess()
        return parent::getExpectedUnauthorizedEntityAccessCacheability($is_authenticated)->addCacheTags([
            'comment:1',
        ]);
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
ApiRequestTrait::decorateWithXdebugCookie protected function Adds the Xdebug cookie to the request options.
ApiRequestTrait::makeApiRequest protected function Performs an HTTP request. Wraps the Guzzle HTTP client. Aliased as: request 1
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::$defaultTheme protected property The theme to install as the default for testing. 1581
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. 42
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.
CommentResourceTestBase::$entity protected property Overrides EntityResourceTestBase::$entity
CommentResourceTestBase::$entityTypeId protected static property The tested entity type. Overrides EntityResourceTestBase::$entityTypeId
CommentResourceTestBase::$modules protected static property Modules to install. Overrides EntityResourceTestBase::$modules 2
CommentResourceTestBase::$patchProtectedFieldNames protected static property The fields that are protected against modification during PATCH requests. Overrides EntityResourceTestBase::$patchProtectedFieldNames 2
CommentResourceTestBase::commentResourceTestBaseSkipTests public function Marks some tests as skipped because XML cannot be deserialized.
CommentResourceTestBase::createEntity protected function Creates the entity to be tested. Overrides EntityResourceTestBase::createEntity
CommentResourceTestBase::getExpectedCacheContexts protected function The expected cache contexts for the GET/HEAD response of the test entity. Overrides EntityResourceTestBase::getExpectedCacheContexts
CommentResourceTestBase::getExpectedCacheTags protected function The expected cache tags for the GET/HEAD response of the test entity. Overrides EntityResourceTestBase::getExpectedCacheTags
CommentResourceTestBase::getExpectedNormalizedEntity protected function Returns the expected normalization of the entity. Overrides EntityResourceTestBase::getExpectedNormalizedEntity
CommentResourceTestBase::getExpectedUnauthorizedAccessMessage protected function Return the expected error message. Overrides EntityResourceTestBase::getExpectedUnauthorizedAccessMessage
CommentResourceTestBase::getExpectedUnauthorizedEntityAccessCacheability protected function The cacheability of unauthorized &#039;view&#039; entity access. Overrides EntityResourceTestBase::getExpectedUnauthorizedEntityAccessCacheability
CommentResourceTestBase::getNormalizedPatchEntity protected function Returns the normalized PATCH entity. Overrides EntityResourceTestBase::getNormalizedPatchEntity
CommentResourceTestBase::getNormalizedPostEntity protected function Returns the normalized POST entity. Overrides EntityResourceTestBase::getNormalizedPostEntity
CommentResourceTestBase::setUpAuthorization protected function Sets up the necessary authorization. Overrides ResourceTestBase::setUpAuthorization
CommentResourceTestBase::testPostDxWithoutCriticalBaseFields public function Tests POSTing a comment without critical base fields.
CommentResourceTestBase::testPostSkipCommentApproval public function Tests POSTing a comment with and without &#039;skip comment approval&#039;.
CommentTestTrait::addDefaultCommentField protected function Adds the default comment field to an entity.
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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
EntityResourceTestBase::$anotherEntity protected property Another entity of the same type used for testing.
EntityResourceTestBase::$entityStorage protected property The entity storage.
EntityResourceTestBase::$firstCreatedEntityId protected static property The entity ID for the first created entity in testPost(). 4
EntityResourceTestBase::$labelFieldName protected static property Optionally specify which field is the &#039;label&#039; field. 2
EntityResourceTestBase::$secondCreatedEntityId protected static property The entity ID for the second created entity in testPost(). 4
EntityResourceTestBase::$uniqueFieldNames protected static property A list of fields that need a unique value. 2
EntityResourceTestBase::assert406Response protected function Asserts a 406 response… or in some cases a 403 response, because weirdness.
EntityResourceTestBase::assertEntityArraySubset protected function Recursively asserts that the expected items are set in the tested entity.
EntityResourceTestBase::assertNormalizationEdgeCases protected function Asserts normalization-specific edge cases. Overrides ResourceTestBase::assertNormalizationEdgeCases 3
EntityResourceTestBase::assertPatchProtectedFieldNamesStructure protected function Asserts structure of $patchProtectedFieldNames.
EntityResourceTestBase::assertResourceNotAvailable protected function Asserts that a resource is unavailable: 404, 406 if it has canonical route.
EntityResourceTestBase::assertStoredEntityMatchesSentNormalization protected function Asserts that the stored entity matches the sent normalization.
EntityResourceTestBase::castToString protected static function Transforms a normalization: casts all non-string types to strings.
EntityResourceTestBase::createAnotherEntity protected function Creates another entity to be tested. 3
EntityResourceTestBase::getEntityResourcePostUrl protected function Gets an entity resource&#039;s POST URL.
EntityResourceTestBase::getEntityResourceUrl protected function Gets an entity resource&#039;s GET/PATCH/DELETE URL.
EntityResourceTestBase::getExpectedUnauthorizedAccessCacheability protected function Returns the expected cacheability of an unauthorized access response. Overrides ResourceTestBase::getExpectedUnauthorizedAccessCacheability 1
EntityResourceTestBase::getModifiedEntityForPatchTesting protected static function Clones the given entity and modifies all PATCH-protected fields.
EntityResourceTestBase::getModifiedEntityForPostTesting protected function Gets the normalized POST entity with random values for its unique fields. 1
EntityResourceTestBase::makeNormalizationInvalid protected function Makes the given entity normalization invalid.
EntityResourceTestBase::provisionEntityResource protected function Provides an entity resource.
EntityResourceTestBase::setUp protected function Overrides ResourceTestBase::setUp 2
EntityResourceTestBase::testDelete public function Tests a DELETE request for an entity, plus edge cases to ensure good DX. 2
EntityResourceTestBase::testGet public function Tests a GET request for an entity, plus edge cases to ensure good DX. 1
EntityResourceTestBase::testPatch public function Tests a PATCH request for an entity, plus edge cases to ensure good DX. 2
EntityResourceTestBase::testPost public function Tests a POST request for an entity, plus edge cases to ensure good DX. 2
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 &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; 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
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
ResourceTestBase::$account protected property The account to use for authentication, if any.
ResourceTestBase::$auth protected static property The authentication mechanism to use in this test. 204
ResourceTestBase::$format protected static property The format to use in this test. 306
ResourceTestBase::$mimeType protected static property The MIME type that corresponds to $format. 306
ResourceTestBase::$resourceConfigId protected static property The REST Resource Config entity ID under test (i.e. a resource type). 5
ResourceTestBase::$resourceConfigStorage protected property The REST resource config entity storage.
ResourceTestBase::$serializer protected property The serializer service.
ResourceTestBase::assertAuthenticationEdgeCases abstract protected function Asserts authentication provider-specific edge cases.
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::assertResponseWhenMissingAuthentication abstract protected function Verifies the error response in case of missing authentication.
ResourceTestBase::getAuthenticationRequestOptions protected function Returns Guzzle request options for authentication.
ResourceTestBase::grantPermissionsToAnonymousRole protected function Grants permissions to the anonymous role.
ResourceTestBase::grantPermissionsToAuthenticatedRole protected function Grants permissions to the authenticated role.
ResourceTestBase::grantPermissionsToTestedRole protected function Grants permissions to the tested role: anonymous or authenticated.
ResourceTestBase::initAuthentication protected function Initializes authentication.
ResourceTestBase::provisionResource protected function Provisions the REST resource under test.
ResourceTestBase::recursiveKSort protected static function Recursively sorts an array by key.
ResourceTestBase::refreshTestStateAfterRestConfigChange protected function Refreshes the state of the tester to be in sync with the testee.
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.