class NodeTest

Same name in this branch
  1. 11.x core/modules/node/tests/src/Kernel/Plugin/migrate/source/d6/NodeTest.php \Drupal\Tests\node\Kernel\Plugin\migrate\source\d6\NodeTest
  2. 11.x core/modules/node/tests/src/Kernel/Plugin/migrate/source/d7/NodeTest.php \Drupal\Tests\node\Kernel\Plugin\migrate\source\d7\NodeTest
Same name in other branches
  1. 9 core/modules/jsonapi/tests/src/Functional/NodeTest.php \Drupal\Tests\jsonapi\Functional\NodeTest
  2. 9 core/modules/node/tests/src/Kernel/Plugin/migrate/source/d6/NodeTest.php \Drupal\Tests\node\Kernel\Plugin\migrate\source\d6\NodeTest
  3. 9 core/modules/node/tests/src/Kernel/Plugin/migrate/source/d7/NodeTest.php \Drupal\Tests\node\Kernel\Plugin\migrate\source\d7\NodeTest
  4. 8.9.x core/modules/jsonapi/tests/src/Functional/NodeTest.php \Drupal\Tests\jsonapi\Functional\NodeTest
  5. 8.9.x core/modules/node/tests/src/Kernel/Plugin/migrate/source/d6/NodeTest.php \Drupal\Tests\node\Kernel\Plugin\migrate\source\d6\NodeTest
  6. 8.9.x core/modules/node/tests/src/Kernel/Plugin/migrate/source/d7/NodeTest.php \Drupal\Tests\node\Kernel\Plugin\migrate\source\d7\NodeTest
  7. 10 core/modules/jsonapi/tests/src/Functional/NodeTest.php \Drupal\Tests\jsonapi\Functional\NodeTest
  8. 10 core/modules/node/tests/src/Kernel/Plugin/migrate/source/d6/NodeTest.php \Drupal\Tests\node\Kernel\Plugin\migrate\source\d6\NodeTest
  9. 10 core/modules/node/tests/src/Kernel/Plugin/migrate/source/d7/NodeTest.php \Drupal\Tests\node\Kernel\Plugin\migrate\source\d7\NodeTest

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

@group jsonapi

Hierarchy

Expanded class hierarchy of NodeTest

File

core/modules/jsonapi/tests/src/Functional/NodeTest.php, line 26

Namespace

Drupal\Tests\jsonapi\Functional
View source
class NodeTest extends ResourceTestBase {
    use CommonCollectionFilterAccessTestPatternsTrait;
    use WaitTerminateTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'path',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected static $entityTypeId = 'node';
    
    /**
     * {@inheritdoc}
     */
    protected static $resourceTypeName = 'node--camelids';
    
    /**
     * {@inheritdoc}
     */
    protected static $resourceTypeIsVersionable = TRUE;
    
    /**
     * {@inheritdoc}
     */
    protected static $newRevisionsShouldBeAutomatic = TRUE;
    
    /**
     * {@inheritdoc}
     *
     * @var \Drupal\node\NodeInterface
     */
    protected $entity;
    
    /**
     * {@inheritdoc}
     */
    protected static $patchProtectedFieldNames = [
        'revision_timestamp' => NULL,
        'created' => "The 'administer nodes' permission is required.",
        'changed' => NULL,
        'promote' => "The 'administer nodes' permission is required.",
        'sticky' => "The 'administer nodes' permission is required.",
        'path' => "The following permissions are required: 'create url aliases' OR 'administer url aliases'.",
        'revision_uid' => NULL,
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUpAuthorization($method) : void {
        switch ($method) {
            case 'GET':
                $this->grantPermissionsToTestedRole([
                    'access content',
                ]);
                break;
            case 'POST':
                $this->grantPermissionsToTestedRole([
                    'access content',
                    'create camelids content',
                ]);
                break;
            case 'PATCH':
                // Do not grant the 'create url aliases' permission to test the case
                // when the path field is protected/not accessible, see
                // \Drupal\Tests\rest\Functional\EntityResource\Term\TermResourceTestBase
                // for a positive test.
                $this->grantPermissionsToTestedRole([
                    'access content',
                    'edit any camelids content',
                ]);
                break;
            case 'DELETE':
                $this->grantPermissionsToTestedRole([
                    'access content',
                    'delete any camelids content',
                ]);
                break;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    protected function setUpRevisionAuthorization($method) : void {
        parent::setUpRevisionAuthorization($method);
        $this->grantPermissionsToTestedRole([
            'view all revisions',
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function createEntity() {
        if (!NodeType::load('camelids')) {
            // Create a "Camelids" node type.
            NodeType::create([
                'name' => 'Camelids',
                'type' => 'camelids',
            ])->save();
        }
        // Create a "Llama" node.
        $node = Node::create([
            'type' => 'camelids',
        ]);
        $node->setTitle('Llama')
            ->setOwnerId($this->account
            ->id())
            ->setPublished()
            ->setCreatedTime(123456789)
            ->setChangedTime(123456789)
            ->setRevisionCreationTime(123456789)
            ->set('path', '/llama')
            ->save();
        return $node;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getExpectedDocument() : array {
        $author = User::load($this->entity
            ->getOwnerId());
        $base_url = Url::fromUri('base:/jsonapi/node/camelids/' . $this->entity
            ->uuid())
            ->setAbsolute();
        $self_url = clone $base_url;
        $version_identifier = 'id:' . $this->entity
            ->getRevisionId();
        $self_url = $self_url->setOption('query', [
            'resourceVersion' => $version_identifier,
        ]);
        $version_query_string = '?resourceVersion=' . urlencode($version_identifier);
        return [
            'jsonapi' => [
                'meta' => [
                    'links' => [
                        'self' => [
                            'href' => 'http://jsonapi.org/format/1.0/',
                        ],
                    ],
                ],
                'version' => '1.0',
            ],
            'links' => [
                'self' => [
                    'href' => $base_url->toString(),
                ],
            ],
            'data' => [
                'id' => $this->entity
                    ->uuid(),
                'type' => 'node--camelids',
                'links' => [
                    'self' => [
                        'href' => $self_url->toString(),
                    ],
                ],
                'attributes' => [
                    'created' => '1973-11-29T21:33:09+00:00',
                    'changed' => (new \DateTime())->setTimestamp($this->entity
                        ->getChangedTime())
                        ->setTimezone(new \DateTimeZone('UTC'))
                        ->format(\DateTime::RFC3339),
                    'default_langcode' => TRUE,
                    'langcode' => 'en',
                    'path' => [
                        'alias' => '/llama',
                        'pid' => 1,
                        'langcode' => 'en',
                    ],
                    'promote' => TRUE,
                    'revision_timestamp' => '1973-11-29T21:33:09+00:00',
                    // @todo Attempt to remove this in https://www.drupal.org/project/drupal/issues/2933518.
'revision_translation_affected' => TRUE,
                    'status' => TRUE,
                    'sticky' => FALSE,
                    'title' => 'Llama',
                    'drupal_internal__nid' => 1,
                    'drupal_internal__vid' => 1,
                ],
                'relationships' => [
                    'node_type' => [
                        'data' => [
                            'id' => NodeType::load('camelids')->uuid(),
                            'meta' => [
                                'drupal_internal__target_id' => 'camelids',
                            ],
                            'type' => 'node_type--node_type',
                        ],
                        'links' => [
                            'related' => [
                                'href' => $base_url->toString() . '/node_type' . $version_query_string,
                            ],
                            'self' => [
                                'href' => $base_url->toString() . '/relationships/node_type' . $version_query_string,
                            ],
                        ],
                    ],
                    'uid' => [
                        'data' => [
                            'id' => $author->uuid(),
                            'meta' => [
                                'drupal_internal__target_id' => (int) $author->id(),
                            ],
                            'type' => 'user--user',
                        ],
                        'links' => [
                            'related' => [
                                'href' => $base_url->toString() . '/uid' . $version_query_string,
                            ],
                            'self' => [
                                'href' => $base_url->toString() . '/relationships/uid' . $version_query_string,
                            ],
                        ],
                    ],
                    'revision_uid' => [
                        'data' => [
                            'id' => $author->uuid(),
                            'meta' => [
                                'drupal_internal__target_id' => (int) $author->id(),
                            ],
                            'type' => 'user--user',
                        ],
                        'links' => [
                            'related' => [
                                'href' => $base_url->toString() . '/revision_uid' . $version_query_string,
                            ],
                            'self' => [
                                'href' => $base_url->toString() . '/relationships/revision_uid' . $version_query_string,
                            ],
                        ],
                    ],
                ],
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getPostDocument() : array {
        return [
            'data' => [
                'type' => 'node--camelids',
                'attributes' => [
                    'title' => 'Drama llama',
                ],
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getExpectedUnauthorizedAccessMessage($method) : string {
        switch ($method) {
            case 'GET':
            case 'POST':
            case 'PATCH':
            case 'DELETE':
                return "The 'access content' permission is required.";
        }
        return '';
    }
    
    /**
     * Tests PATCHing a node's path with and without 'create url aliases'.
     *
     * For a positive test, see the similar test coverage for Term.
     *
     * @see \Drupal\Tests\jsonapi\Functional\TermTest::testPatchPath()
     * @see \Drupal\Tests\rest\Functional\EntityResource\Term\TermResourceTestBase::testPatchPath()
     */
    public function testPatchPath() : void {
        $this->setUpAuthorization('GET');
        $this->setUpAuthorization('PATCH');
        $this->config('jsonapi.settings')
            ->set('read_only', FALSE)
            ->save(TRUE);
        // @todo Remove line below in favor of commented line in https://www.drupal.org/project/drupal/issues/2878463.
        $url = Url::fromRoute(sprintf('jsonapi.%s.individual', static::$resourceTypeName), [
            'entity' => $this->entity
                ->uuid(),
        ]);
        // $url = $this->entity->toUrl('jsonapi');
        // GET node's current normalization.
        $response = $this->request('GET', $url, $this->getAuthenticationRequestOptions());
        $normalization = $this->getDocumentFromResponse($response);
        // Change node's path alias.
        $normalization['data']['attributes']['path']['alias'] .= 's-rule-the-world';
        // Create node PATCH request.
        $request_options = $this->getAuthenticationRequestOptions();
        $request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';
        $request_options[RequestOptions::BODY] = Json::encode($normalization);
        // PATCH request: 403 when creating URL aliases unauthorized.
        $response = $this->request('PATCH', $url, $request_options);
        $this->assertResourceErrorResponse(403, "The current user is not allowed to PATCH the selected field (path). The following permissions are required: 'create url aliases' OR 'administer url aliases'.", $url, $response, '/data/attributes/path');
        // Grant permission to create URL aliases.
        $this->grantPermissionsToTestedRole([
            'create url aliases',
        ]);
        // Repeat PATCH request: 200.
        $response = $this->request('PATCH', $url, $request_options);
        $updated_normalization = $this->getDocumentFromResponse($response);
        $this->assertResourceResponse(200, FALSE, $response);
        $this->assertSame($normalization['data']['attributes']['path']['alias'], $updated_normalization['data']['attributes']['path']['alias']);
    }
    
    /**
     * {@inheritdoc}
     */
    public function testGetIndividual() : void {
        // Cacheable normalizations are written after the response is flushed to
        // the client. We use WaitTerminateTestTrait to wait for Drupal to perform
        // its termination work before continuing.
        $this->setWaitForTerminate();
        parent::testGetIndividual();
        $this->assertCacheableNormalizations();
        // Unpublish node.
        $this->entity
            ->setUnpublished()
            ->save();
        // @todo Remove line below in favor of commented line in https://www.drupal.org/project/drupal/issues/2878463.
        $url = Url::fromRoute(sprintf('jsonapi.%s.individual', static::$resourceTypeName), [
            'entity' => $this->entity
                ->uuid(),
        ]);
        // $url = $this->entity->toUrl('jsonapi');
        $request_options = $this->getAuthenticationRequestOptions();
        // 403 when accessing own unpublished node.
        $response = $this->request('GET', $url, $request_options);
        $this->assertResourceErrorResponse(403, 'The current user is not allowed to GET the selected resource.', $url, $response, '/data', [
            '4xx-response',
            'http_response',
            'node:1',
        ], [
            'url.query_args',
            'url.site',
            'user.permissions',
        ], 'UNCACHEABLE (request policy)', TRUE);
        // 200 after granting permission.
        $this->grantPermissionsToTestedRole([
            'view own unpublished content',
        ]);
        $response = $this->request('GET', $url, $request_options);
        $this->assertResourceResponse(200, FALSE, $response, $this->getExpectedCacheTags(), $this->getExpectedCacheContexts(), 'UNCACHEABLE (request policy)', TRUE);
    }
    
    /**
     * Asserts that normalizations are cached in an incremental way.
     *
     * @throws \Drupal\Core\Entity\EntityStorageException
     *
     * @internal
     */
    protected function assertCacheableNormalizations() : void {
        // Save the entity to invalidate caches.
        $this->entity
            ->save();
        $uuid = $this->entity
            ->uuid();
        $language = $this->entity
            ->language()
            ->getId();
        $cache = \Drupal::service('variation_cache.jsonapi_normalizations')->get([
            'node--camelids',
            $uuid,
            $language,
        ], new CacheableMetadata());
        // After saving the entity the normalization should not be cached.
        $this->assertFalse($cache);
        // @todo Remove line below in favor of commented line in https://www.drupal.org/project/drupal/issues/2878463.
        $url = Url::fromRoute(sprintf('jsonapi.%s.individual', static::$resourceTypeName), [
            'entity' => $uuid,
        ]);
        // $url = $this->entity->toUrl('jsonapi');
        $request_options = $this->getAuthenticationRequestOptions();
        $request_options[RequestOptions::QUERY] = [
            'fields' => [
                'node--camelids' => 'title',
            ],
        ];
        $this->request('GET', $url, $request_options);
        // Ensure the normalization cache is being incrementally built. After
        // requesting the title, only the title is in the cache.
        $this->assertNormalizedFieldsAreCached([
            'title',
        ]);
        $request_options[RequestOptions::QUERY] = [
            'fields' => [
                'node--camelids' => 'field_rest_test',
            ],
        ];
        $this->request('GET', $url, $request_options);
        // After requesting an additional field, then that field is in the cache and
        // the old one is still there.
        $this->assertNormalizedFieldsAreCached([
            'title',
            'field_rest_test',
        ]);
    }
    
    /**
     * Checks that the provided field names are the only fields in the cache.
     *
     * The normalization cache should only have these fields, which build up
     * across responses.
     *
     * @param string[] $field_names
     *   The field names.
     *
     * @internal
     */
    protected function assertNormalizedFieldsAreCached(array $field_names) : void {
        $cache = \Drupal::service('variation_cache.jsonapi_normalizations')->get([
            'node--camelids',
            $this->entity
                ->uuid(),
            $this->entity
                ->language()
                ->getId(),
        ], new CacheableMetadata());
        $cached_fields = $cache->data['fields'];
        $this->assertSameSize($field_names, $cached_fields);
        array_walk($field_names, function ($field_name) use ($cached_fields) {
            $this->assertInstanceOf(CacheableNormalization::class, $cached_fields[$field_name]);
        });
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getExpectedCacheContexts(?array $sparse_fieldset = NULL) {
        // \Drupal\Tests\jsonapi\Functional\ResourceTestBase::testRevisions()
        // loads different revisions via query parameters, we do our best
        // here to react to those directly, or indirectly.
        $cache_contexts = parent::getExpectedCacheContexts($sparse_fieldset);
        // This is bubbled up by
        // \Drupal\node\NodeAccessControlHandler::checkAccess() directly.
        if ($this->entity
            ->isPublished()) {
            return $cache_contexts;
        }
        if (!\Drupal::currentUser()->isAuthenticated()) {
            return Cache::mergeContexts($cache_contexts, [
                'user.roles:authenticated',
            ]);
        }
        if (\Drupal::currentUser()->hasPermission('view own unpublished content')) {
            return Cache::mergeContexts($cache_contexts, [
                'user',
            ]);
        }
        return $cache_contexts;
    }
    
    /**
     * {@inheritdoc}
     */
    protected static function getIncludePermissions() : array {
        return [
            'uid.node_type' => [
                'administer users',
            ],
            'uid.roles' => [
                'administer permissions',
            ],
        ];
    }
    
    /**
     * Creating relationships to missing resources should be 404 per JSON:API 1.1.
     *
     * @see https://github.com/json-api/json-api/issues/1033
     */
    public function testPostNonExistingAuthor() : void {
        $this->setUpAuthorization('POST');
        $this->config('jsonapi.settings')
            ->set('read_only', FALSE)
            ->save(TRUE);
        $this->grantPermissionsToTestedRole([
            'administer nodes',
        ]);
        $random_uuid = \Drupal::service('uuid')->generate();
        $doc = $this->getPostDocument();
        $doc['data']['relationships']['uid']['data'] = [
            'type' => 'user--user',
            'id' => $random_uuid,
        ];
        // Create node POST request.
        $url = Url::fromRoute(sprintf('jsonapi.%s.collection.post', static::$resourceTypeName));
        $request_options = $this->getAuthenticationRequestOptions();
        $request_options[RequestOptions::HEADERS]['Accept'] = 'application/vnd.api+json';
        $request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';
        $request_options[RequestOptions::BODY] = Json::encode($doc);
        // POST request: 404 when adding relationships to non-existing resources.
        $response = $this->request('POST', $url, $request_options);
        $expected_document = [
            'errors' => [
                0 => [
                    'status' => '404',
                    'title' => 'Not Found',
                    'detail' => "The resource identified by `user--user:{$random_uuid}` (given as a relationship item) could not be found.",
                    'links' => [
                        'info' => [
                            'href' => HttpExceptionNormalizer::getInfoUrl(404),
                        ],
                        'via' => [
                            'href' => $url->setAbsolute()
                                ->toString(),
                        ],
                    ],
                ],
            ],
            'jsonapi' => static::$jsonApiMember,
        ];
        $this->assertResourceResponse(404, $expected_document, $response);
    }
    
    /**
     * {@inheritdoc}
     */
    public function testCollectionFilterAccess() : void {
        $label_field_name = 'title';
        $this->doTestCollectionFilterAccessForPublishableEntities($label_field_name, 'access content', 'bypass node access');
        $collection_url = Url::fromRoute('jsonapi.entity_test--bar.collection');
        $collection_filter_url = $collection_url->setOption('query', [
            "filter[spotlight.{$label_field_name}]" => $this->entity
                ->label(),
        ]);
        $request_options = [];
        $request_options[RequestOptions::HEADERS]['Accept'] = 'application/vnd.api+json';
        $request_options = NestedArray::mergeDeep($request_options, $this->getAuthenticationRequestOptions());
        $this->revokePermissionsFromTestedRole([
            'bypass node access',
        ]);
        // 0 results because the node is unpublished.
        $response = $this->request('GET', $collection_filter_url, $request_options);
        $doc = $this->getDocumentFromResponse($response);
        $this->assertCount(0, $doc['data']);
        $this->grantPermissionsToTestedRole([
            'view own unpublished content',
        ]);
        // 1 result because the current user is the owner of the unpublished node.
        $response = $this->request('GET', $collection_filter_url, $request_options);
        $doc = $this->getDocumentFromResponse($response);
        $this->assertCount(1, $doc['data']);
        $this->entity
            ->setOwnerId(0)
            ->save();
        // 0 results because the current user is no longer the owner.
        $response = $this->request('GET', $collection_filter_url, $request_options);
        $doc = $this->getDocumentFromResponse($response);
        $this->assertCount(0, $doc['data']);
        // Assert bubbling of cacheability from query alter hook.
        $this->assertTrue($this->container
            ->get('module_installer')
            ->install([
            'node_access_test',
        ], TRUE), 'Installed modules.');
        node_access_rebuild();
        $this->rebuildAll();
        $response = $this->request('GET', $collection_filter_url, $request_options);
        $this->assertContains('user.node_grants:view', explode(' ', $response->getHeader('X-Drupal-Cache-Contexts')[0]));
    }

}

Members

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.
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
NodeTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
NodeTest::$entity protected property Overrides ResourceTestBase::$entity
NodeTest::$entityTypeId protected static property The tested entity type. Overrides ResourceTestBase::$entityTypeId
NodeTest::$modules protected static property Modules to install. Overrides ResourceTestBase::$modules
NodeTest::$newRevisionsShouldBeAutomatic protected static property Whether new revisions of updated entities should be created by default. Overrides ResourceTestBase::$newRevisionsShouldBeAutomatic
NodeTest::$patchProtectedFieldNames protected static property The fields that are protected against modification during PATCH requests. Overrides ResourceTestBase::$patchProtectedFieldNames
NodeTest::$resourceTypeIsVersionable protected static property Whether the tested JSON:API resource is versionable. Overrides ResourceTestBase::$resourceTypeIsVersionable
NodeTest::$resourceTypeName protected static property The name of the tested JSON:API resource type. Overrides ResourceTestBase::$resourceTypeName
NodeTest::assertCacheableNormalizations protected function Asserts that normalizations are cached in an incremental way.
NodeTest::assertNormalizedFieldsAreCached protected function Checks that the provided field names are the only fields in the cache.
NodeTest::createEntity protected function Creates the entity to be tested. Overrides ResourceTestBase::createEntity
NodeTest::getExpectedCacheContexts protected function The expected cache contexts for the GET/HEAD response of the test entity. Overrides ResourceTestBase::getExpectedCacheContexts
NodeTest::getExpectedDocument protected function Returns the expected JSON:API document for the entity. Overrides ResourceTestBase::getExpectedDocument
NodeTest::getExpectedUnauthorizedAccessMessage protected function Return the expected error message. Overrides ResourceTestBase::getExpectedUnauthorizedAccessMessage
NodeTest::getIncludePermissions protected static function Authorize the user under test with additional permissions to view includes. Overrides ResourceTestBase::getIncludePermissions
NodeTest::getPostDocument protected function Returns the JSON:API POST document. Overrides ResourceTestBase::getPostDocument
NodeTest::setUpAuthorization protected function Sets up the necessary authorization. Overrides ResourceTestBase::setUpAuthorization
NodeTest::setUpRevisionAuthorization protected function Sets up the necessary authorization for handling revisions. Overrides ResourceTestBase::setUpRevisionAuthorization
NodeTest::testCollectionFilterAccess public function
NodeTest::testGetIndividual public function Tests GETting an individual resource, plus edge cases to ensure good DX. Overrides ResourceTestBase::testGetIndividual
NodeTest::testPatchPath public function Tests PATCHing a node's path with and without 'create url aliases'.
NodeTest::testPostNonExistingAuthor public function Creating relationships to missing resources should be 404 per JSON:API 1.1.
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::$resourceType protected property The JSON:API resource type for the tested entity type plus bundle.
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::doTestPatchIndividual protected function Tests PATCHing an individual resource, plus edge cases to ensure good DX. 2
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::entityAccess protected static function Checks access for the given operation on the given entity. 3
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::generateDynamicPageCacheExpectedHeaderValue protected function Generates an X-Drupal-Dynamic-Cache header value based on cacheability.
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::getExpectedCacheTags protected function The expected cache tags for the GET/HEAD response of the test entity. 5
ResourceTestBase::getExpectedCollectionCacheability protected static function Computes the cacheability for a given entity collection. 5
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::getExpectedUnauthorizedAccessCacheability protected function Returns the expected cacheability for an unauthorized response. 8
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::setUp protected function Overrides BrowserTestBase::setUp 3
ResourceTestBase::setUpFields protected function Sets up additional fields for testing.
ResourceTestBase::testCollection public function Tests GETting a collection of resources. 1
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.
WaitTerminateTestTrait::setWaitForTerminate protected function Specify that subsequent requests must wait for the terminate event.
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.