class JsonApiRegressionTest in Drupal 9

JSON:API regression tests.

@group jsonapi

@internal

Hierarchy

• class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
  • class \Drupal\Tests\jsonapi\Functional\JsonApiFunctionalTestBase uses EntityReferenceTestTrait, ImageFieldCreationTrait
    • class \Drupal\Tests\jsonapi\Functional\JsonApiRegressionTest uses CommentTestTrait

File

core/modules/jsonapi/tests/src/Functional/JsonApiRegressionTest.php, line 37

Namespace

Drupal\Tests\jsonapi\Functional

class JsonApiRegressionTest extends JsonApiFunctionalTestBase {
  use CommentTestTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'basic_auth',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * Ensure filtering on relationships works with bundle-specific target types.
   *
   * @see https://www.drupal.org/project/drupal/issues/2953207
   */
  public function testBundleSpecificTargetEntityTypeFromIssue2953207() {

    // Set up data model.
    $this
      ->assertTrue($this->container
      ->get('module_installer')
      ->install([
      'comment',
    ], TRUE), 'Installed modules.');
    $this
      ->addDefaultCommentField('taxonomy_term', 'tags', 'comment', CommentItemInterface::OPEN, 'tcomment');
    $this
      ->rebuildAll();

    // Create data.
    Term::create([
      'name' => 'foobar',
      'vid' => 'tags',
    ])
      ->save();
    Comment::create([
      'subject' => 'Llama',
      'entity_id' => 1,
      'entity_type' => 'taxonomy_term',
      'field_name' => 'comment',
    ])
      ->save();

    // Test.
    $user = $this
      ->drupalCreateUser([
      'access comments',
    ]);
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/comment/tcomment?include=entity_id&filter[entity_id.name]=foobar'), [
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
    ]);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
  }

  /**
   * Ensure deep nested include works on multi target entity type field.
   *
   * @see https://www.drupal.org/project/drupal/issues/2973681
   */
  public function testDeepNestedIncludeMultiTargetEntityTypeFieldFromIssue2973681() {

    // Set up data model.
    $this
      ->assertTrue($this->container
      ->get('module_installer')
      ->install([
      'comment',
    ], TRUE), 'Installed modules.');
    $this
      ->addDefaultCommentField('node', 'article');
    $this
      ->addDefaultCommentField('taxonomy_term', 'tags', 'comment', CommentItemInterface::OPEN, 'tcomment');
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    $this
      ->createEntityReferenceField('node', 'page', 'field_comment', NULL, 'comment', 'default', [
      'target_bundles' => [
        'comment' => 'comment',
        'tcomment' => 'tcomment',
      ],
    ], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
    $this
      ->rebuildAll();

    // Create data.
    $node = Node::create([
      'title' => 'test article',
      'type' => 'article',
    ]);
    $node
      ->save();
    $comment = Comment::create([
      'subject' => 'Llama',
      'entity_id' => 1,
      'entity_type' => 'node',
      'field_name' => 'comment',
    ]);
    $comment
      ->save();
    $page = Node::create([
      'title' => 'test node',
      'type' => 'page',
      'field_comment' => [
        'entity' => $comment,
      ],
    ]);
    $page
      ->save();

    // Test.
    $user = $this
      ->drupalCreateUser([
      'access content',
      'access comments',
    ]);
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/node/page?include=field_comment,field_comment.entity_id,field_comment.entity_id.uid'), [
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
    ]);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
  }

  /**
   * Ensure POST and PATCH works for bundle-less relationship routes.
   *
   * @see https://www.drupal.org/project/drupal/issues/2976371
   */
  public function testBundlelessRelationshipMutationFromIssue2973681() {
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);

    // Set up data model.
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    $this
      ->createEntityReferenceField('node', 'page', 'field_test', NULL, 'user', 'default', [
      'target_bundles' => NULL,
    ], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
    $this
      ->rebuildAll();

    // Create data.
    $node = Node::create([
      'title' => 'test article',
      'type' => 'page',
    ]);
    $node
      ->save();
    $target = $this
      ->createUser();

    // Test.
    $user = $this
      ->drupalCreateUser([
      'bypass node access',
    ]);
    $url = Url::fromRoute('jsonapi.node--page.field_test.relationship.post', [
      'entity' => $node
        ->uuid(),
    ]);
    $request_options = [
      RequestOptions::HEADERS => [
        'Content-Type' => 'application/vnd.api+json',
        'Accept' => 'application/vnd.api+json',
      ],
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
      RequestOptions::JSON => [
        'data' => [
          [
            'type' => 'user--user',
            'id' => $target
              ->uuid(),
          ],
        ],
      ],
    ];
    $response = $this
      ->request('POST', $url, $request_options);
    $this
      ->assertSame(204, $response
      ->getStatusCode(), (string) $response
      ->getBody());
  }

  /**
   * Ensures GETting terms works when multiple vocabularies exist.
   *
   * @see https://www.drupal.org/project/drupal/issues/2977879
   */
  public function testGetTermWhenMultipleVocabulariesExistFromIssue2977879() {

    // Set up data model.
    $this
      ->assertTrue($this->container
      ->get('module_installer')
      ->install([
      'taxonomy',
    ], TRUE), 'Installed modules.');
    Vocabulary::create([
      'name' => 'one',
      'vid' => 'one',
    ])
      ->save();
    Vocabulary::create([
      'name' => 'two',
      'vid' => 'two',
    ])
      ->save();
    $this
      ->rebuildAll();

    // Create data.
    Term::create([
      'vid' => 'one',
    ])
      ->setName('Test')
      ->save();

    // Test.
    $user = $this
      ->drupalCreateUser([
      'access content',
    ]);
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/taxonomy_term/one'), [
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
    ]);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
  }

  /**
   * Cannot PATCH an entity with dangling references in an ER field.
   *
   * @see https://www.drupal.org/project/drupal/issues/2968972
   */
  public function testDanglingReferencesInAnEntityReferenceFieldFromIssue2968972() {
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);

    // Set up data model.
    $this
      ->drupalCreateContentType([
      'type' => 'journal_issue',
    ]);
    $this
      ->drupalCreateContentType([
      'type' => 'journal_article',
    ]);
    $this
      ->createEntityReferenceField('node', 'journal_article', 'field_issue', NULL, 'node', 'default', [
      'target_bundles' => [
        'journal_issue' => 'journal_issue',
      ],
    ], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
    $this
      ->rebuildAll();

    // Create data.
    $issue_node = Node::create([
      'title' => 'Test Journal Issue',
      'type' => 'journal_issue',
    ]);
    $issue_node
      ->save();
    $user = $this
      ->drupalCreateUser([
      'access content',
      'edit own journal_article content',
    ]);
    $article_node = Node::create([
      'title' => 'Test Journal Article',
      'type' => 'journal_article',
      'field_issue' => [
        'target_id' => $issue_node
          ->id(),
      ],
    ]);
    $article_node
      ->setOwner($user);
    $article_node
      ->save();

    // Test.
    $url = Url::fromUri(sprintf('internal:/jsonapi/node/journal_article/%s', $article_node
      ->uuid()));
    $request_options = [
      RequestOptions::HEADERS => [
        'Content-Type' => 'application/vnd.api+json',
        'Accept' => 'application/vnd.api+json',
      ],
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
      RequestOptions::JSON => [
        'data' => [
          'type' => 'node--journal_article',
          'id' => $article_node
            ->uuid(),
          'attributes' => [
            'title' => 'My New Article Title',
          ],
        ],
      ],
    ];
    $issue_node
      ->delete();
    $response = $this
      ->request('PATCH', $url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode(), (string) $response
      ->getBody());
  }

  /**
   * Ensures GETting node collection + hook_node_grants() implementations works.
   *
   * @see https://www.drupal.org/project/drupal/issues/2984964
   */
  public function testGetNodeCollectionWithHookNodeGrantsImplementationsFromIssue2984964() {

    // Set up data model.
    $this
      ->assertTrue($this->container
      ->get('module_installer')
      ->install([
      'node_access_test',
    ], TRUE), 'Installed modules.');
    node_access_rebuild();
    $this
      ->rebuildAll();

    // Create data.
    Node::create([
      'title' => 'test article',
      'type' => 'article',
    ])
      ->save();

    // Test.
    $user = $this
      ->drupalCreateUser([
      'access content',
    ]);
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/node/article'), [
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
    ]);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $this
      ->assertContains('user.node_grants:view', explode(' ', $response
      ->getHeader('X-Drupal-Cache-Contexts')[0]));
  }

  /**
   * Cannot GET an entity with dangling references in an ER field.
   *
   * @see https://www.drupal.org/project/drupal/issues/2984647
   */
  public function testDanglingReferencesInAnEntityReferenceFieldFromIssue2984647() {

    // Set up data model.
    $this
      ->drupalCreateContentType([
      'type' => 'journal_issue',
    ]);
    $this
      ->drupalCreateContentType([
      'type' => 'journal_conference',
    ]);
    $this
      ->drupalCreateContentType([
      'type' => 'journal_article',
    ]);
    $this
      ->createEntityReferenceField('node', 'journal_article', 'field_issue', NULL, 'node', 'default', [
      'target_bundles' => [
        'journal_issue' => 'journal_issue',
      ],
    ], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
    $this
      ->createEntityReferenceField('node', 'journal_article', 'field_mentioned_in', NULL, 'node', 'default', [
      'target_bundles' => [
        'journal_issue' => 'journal_issue',
        'journal_conference' => 'journal_conference',
      ],
    ], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
    $this
      ->rebuildAll();

    // Create data.
    $issue_node = Node::create([
      'title' => 'Test Journal Issue',
      'type' => 'journal_issue',
    ]);
    $issue_node
      ->save();
    $conference_node = Node::create([
      'title' => 'First Journal Conference!',
      'type' => 'journal_conference',
    ]);
    $conference_node
      ->save();
    $user = $this
      ->drupalCreateUser([
      'access content',
      'edit own journal_article content',
    ]);
    $article_node = Node::create([
      'title' => 'Test Journal Article',
      'type' => 'journal_article',
      'field_issue' => [
        [
          'target_id' => $issue_node
            ->id(),
        ],
      ],
      'field_mentioned_in' => [
        [
          'target_id' => $issue_node
            ->id(),
        ],
        [
          'target_id' => $conference_node
            ->id(),
        ],
      ],
    ]);
    $article_node
      ->setOwner($user);
    $article_node
      ->save();

    // Test.
    $url = Url::fromUri(sprintf('internal:/jsonapi/node/journal_article/%s', $article_node
      ->uuid()));
    $request_options = [
      RequestOptions::HEADERS => [
        'Content-Type' => 'application/vnd.api+json',
        'Accept' => 'application/vnd.api+json',
      ],
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
    ];
    $issue_node
      ->delete();
    $response = $this
      ->request('GET', $url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());

    // Entity reference field allowing a single bundle: dangling reference's
    // resource type is deduced.
    $this
      ->assertSame([
      [
        'type' => 'node--journal_issue',
        'id' => 'missing',
        'meta' => [
          'links' => [
            'help' => [
              'href' => 'https://www.drupal.org/docs/8/modules/json-api/core-concepts#missing',
              'meta' => [
                'about' => "Usage and meaning of the 'missing' resource identifier.",
              ],
            ],
          ],
        ],
      ],
    ], Json::decode((string) $response
      ->getBody())['data']['relationships']['field_issue']['data']);

    // Entity reference field allowing multiple bundles: dangling reference's
    // resource type is NOT deduced.
    $this
      ->assertSame([
      [
        'type' => 'unknown',
        'id' => 'missing',
        'meta' => [
          'links' => [
            'help' => [
              'href' => 'https://www.drupal.org/docs/8/modules/json-api/core-concepts#missing',
              'meta' => [
                'about' => "Usage and meaning of the 'missing' resource identifier.",
              ],
            ],
          ],
        ],
      ],
      [
        'type' => 'node--journal_conference',
        'id' => $conference_node
          ->uuid(),
        'meta' => [
          'drupal_internal__target_id' => (int) $conference_node
            ->id(),
        ],
      ],
    ], Json::decode((string) $response
      ->getBody())['data']['relationships']['field_mentioned_in']['data']);
  }

  /**
   * Ensures that JSON:API routes are caches are dynamically rebuilt.
   *
   * Adding a new relationship field should cause new routes to be immediately
   * regenerated. The site builder should not need to manually rebuild caches.
   *
   * @see https://www.drupal.org/project/drupal/issues/2984886
   */
  public function testThatRoutesAreRebuiltAfterDataModelChangesFromIssue2984886() {
    $user = $this
      ->drupalCreateUser([
      'access content',
    ]);
    $request_options = [
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
    ];
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/node/dog'), $request_options);
    $this
      ->assertSame(404, $response
      ->getStatusCode());
    $node_type_dog = NodeType::create([
      'type' => 'dog',
    ]);
    $node_type_dog
      ->save();
    NodeType::create([
      'type' => 'cat',
    ])
      ->save();
    \Drupal::service('router.builder')
      ->rebuildIfNeeded();
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/node/dog'), $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $this
      ->createEntityReferenceField('node', 'dog', 'field_test', NULL, 'node');
    \Drupal::service('router.builder')
      ->rebuildIfNeeded();
    $dog = Node::create([
      'type' => 'dog',
      'title' => 'Rosie P. Mosie',
    ]);
    $dog
      ->save();
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/node/dog/' . $dog
      ->uuid() . '/field_test'), $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $this
      ->createEntityReferenceField('node', 'cat', 'field_test', NULL, 'node');
    \Drupal::service('router.builder')
      ->rebuildIfNeeded();
    $cat = Node::create([
      'type' => 'cat',
      'title' => 'E. Napoleon',
    ]);
    $cat
      ->save();
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/node/cat/' . $cat
      ->uuid() . '/field_test'), $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    FieldConfig::loadByName('node', 'cat', 'field_test')
      ->delete();
    \Drupal::service('router.builder')
      ->rebuildIfNeeded();
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/node/cat/' . $cat
      ->uuid() . '/field_test'), $request_options);
    $this
      ->assertSame(404, $response
      ->getStatusCode());
    $node_type_dog
      ->delete();
    \Drupal::service('router.builder')
      ->rebuildIfNeeded();
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/node/dog'), $request_options);
    $this
      ->assertSame(404, $response
      ->getStatusCode());
  }

  /**
   * Ensures denormalizing relationships with aliased field names works.
   *
   * @see https://www.drupal.org/project/drupal/issues/3007113
   * @see https://www.drupal.org/project/jsonapi_extras/issues/3004582#comment-12817261
   */
  public function testDenormalizeAliasedRelationshipFromIssue2953207() {
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);

    // Since the JSON:API module does not have an explicit mechanism to set up
    // field aliases, create a strange data model so that automatic aliasing
    // allows us to test aliased relationships.
    // @see \Drupal\jsonapi\ResourceType\ResourceTypeRepository::getFieldMapping()
    $internal_relationship_field_name = 'type';
    $public_relationship_field_name = 'taxonomy_term_' . $internal_relationship_field_name;

    // Set up data model.
    $this
      ->createEntityReferenceField('taxonomy_term', 'tags', $internal_relationship_field_name, NULL, 'user');
    $this
      ->rebuildAll();

    // Create data.
    Term::create([
      'name' => 'foobar',
      'vid' => 'tags',
      'type' => [
        'target_id' => 1,
      ],
    ])
      ->save();

    // Test.
    $user = $this
      ->drupalCreateUser([
      'edit terms in tags',
    ]);
    $body = [
      'data' => [
        'type' => 'user--user',
        'id' => User::load(0)
          ->uuid(),
      ],
    ];

    // Test.
    $response = $this
      ->request('PATCH', Url::fromUri(sprintf('internal:/jsonapi/taxonomy_term/tags/%s/relationships/%s', Term::load(1)
      ->uuid(), $public_relationship_field_name)), [
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
      RequestOptions::HEADERS => [
        'Content-Type' => 'application/vnd.api+json',
      ],
      RequestOptions::BODY => Json::encode($body),
    ]);
    $this
      ->assertSame(204, $response
      ->getStatusCode());
  }

  /**
   * Ensures that Drupal's page cache is effective.
   *
   * @see https://www.drupal.org/project/drupal/issues/3009596
   */
  public function testPageCacheFromIssue3009596() {
    $anonymous_role = Role::load(RoleInterface::ANONYMOUS_ID);
    $anonymous_role
      ->grantPermission('access content');
    $anonymous_role
      ->trustData()
      ->save();
    NodeType::create([
      'type' => 'emu_fact',
    ])
      ->save();
    \Drupal::service('router.builder')
      ->rebuildIfNeeded();
    $node = Node::create([
      'type' => 'emu_fact',
      'title' => "Emus don't say moo!",
    ]);
    $node
      ->save();
    $request_options = [
      RequestOptions::HEADERS => [
        'Accept' => 'application/vnd.api+json',
      ],
    ];
    $node_url = Url::fromUri('internal:/jsonapi/node/emu_fact/' . $node
      ->uuid());

    // The first request should be a cache MISS.
    $response = $this
      ->request('GET', $node_url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $this
      ->assertSame('MISS', $response
      ->getHeader('X-Drupal-Cache')[0]);

    // The second request should be a cache HIT.
    $response = $this
      ->request('GET', $node_url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $this
      ->assertSame('HIT', $response
      ->getHeader('X-Drupal-Cache')[0]);
  }

  /**
   * Ensures that filtering by a sequential internal ID named 'id' is possible.
   *
   * @see https://www.drupal.org/project/drupal/issues/3015759
   */
  public function testFilterByIdFromIssue3015759() {

    // Set up data model.
    $this
      ->assertTrue($this->container
      ->get('module_installer')
      ->install([
      'shortcut',
    ], TRUE), 'Installed modules.');
    $this
      ->rebuildAll();

    // Create data.
    $shortcut = Shortcut::create([
      'shortcut_set' => 'default',
      'title' => $this
        ->randomMachineName(),
      'weight' => -20,
      'link' => [
        'uri' => 'internal:/user/logout',
      ],
    ]);
    $shortcut
      ->save();

    // Test.
    $user = $this
      ->drupalCreateUser([
      'access shortcuts',
      'customize shortcut links',
    ]);
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/shortcut/default?filter[drupal_internal__id]=' . $shortcut
      ->id()), [
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
    ]);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $doc = Json::decode((string) $response
      ->getBody());
    $this
      ->assertNotEmpty($doc['data']);
    $this
      ->assertSame($doc['data'][0]['id'], $shortcut
      ->uuid());
    $this
      ->assertSame($doc['data'][0]['attributes']['drupal_internal__id'], (int) $shortcut
      ->id());
    $this
      ->assertSame($doc['data'][0]['attributes']['title'], $shortcut
      ->label());
  }

  /**
   * Ensures datetime fields are normalized using the correct timezone.
   *
   * @see https://www.drupal.org/project/drupal/issues/2999438
   */
  public function testPatchingDateTimeNormalizedWrongTimeZoneIssue3021194() {

    // Set up data model.
    $this
      ->assertTrue($this->container
      ->get('module_installer')
      ->install([
      'datetime',
    ], TRUE), 'Installed modules.');
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    $this
      ->rebuildAll();
    FieldStorageConfig::create([
      'field_name' => 'when',
      'type' => 'datetime',
      'entity_type' => 'node',
      'settings' => [
        'datetime_type' => DateTimeItem::DATETIME_TYPE_DATETIME,
      ],
    ])
      ->save();
    FieldConfig::create([
      'field_name' => 'when',
      'entity_type' => 'node',
      'bundle' => 'page',
    ])
      ->save();

    // Create data.
    $page = Node::create([
      'title' => 'Stegosaurus',
      'type' => 'page',
      'when' => [
        'value' => '2018-09-16T12:00:00',
      ],
    ]);
    $page
      ->save();

    // Test.
    $user = $this
      ->drupalCreateUser([
      'access content',
    ]);
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/node/page/' . $page
      ->uuid()), [
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
    ]);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $doc = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame('2018-09-16T22:00:00+10:00', $doc['data']['attributes']['when']);
  }

  /**
   * Ensures PATCHing datetime (both date-only & date+time) fields is possible.
   *
   * @see https://www.drupal.org/project/drupal/issues/3021194
   */
  public function testPatchingDateTimeFieldsFromIssue3021194() {
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);

    // Set up data model.
    $this
      ->assertTrue($this->container
      ->get('module_installer')
      ->install([
      'datetime',
    ], TRUE), 'Installed modules.');
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    $this
      ->rebuildAll();
    FieldStorageConfig::create([
      'field_name' => 'when',
      'type' => 'datetime',
      'entity_type' => 'node',
      'settings' => [
        'datetime_type' => DateTimeItem::DATETIME_TYPE_DATE,
      ],
    ])
      ->save();
    FieldConfig::create([
      'field_name' => 'when',
      'entity_type' => 'node',
      'bundle' => 'page',
    ])
      ->save();
    FieldStorageConfig::create([
      'field_name' => 'when_exactly',
      'type' => 'datetime',
      'entity_type' => 'node',
      'settings' => [
        'datetime_type' => DateTimeItem::DATETIME_TYPE_DATETIME,
      ],
    ])
      ->save();
    FieldConfig::create([
      'field_name' => 'when_exactly',
      'entity_type' => 'node',
      'bundle' => 'page',
    ])
      ->save();

    // Create data.
    $page = Node::create([
      'title' => 'Stegosaurus',
      'type' => 'page',
      'when' => [
        'value' => '2018-12-19',
      ],
      'when_exactly' => [
        'value' => '2018-12-19T17:00:00',
      ],
    ]);
    $page
      ->save();

    // Test.
    $user = $this
      ->drupalCreateUser([
      'access content',
      'edit any page content',
    ]);
    $request_options = [
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
      RequestOptions::HEADERS => [
        'Content-Type' => 'application/vnd.api+json',
        'Accept' => 'application/vnd.api+json',
      ],
    ];
    $node_url = Url::fromUri('internal:/jsonapi/node/page/' . $page
      ->uuid());
    $response = $this
      ->request('GET', $node_url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $doc = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame('2018-12-19', $doc['data']['attributes']['when']);
    $this
      ->assertSame('2018-12-20T04:00:00+11:00', $doc['data']['attributes']['when_exactly']);
    $doc['data']['attributes']['when'] = '2018-12-20';
    $doc['data']['attributes']['when_exactly'] = '2018-12-19T19:00:00+01:00';
    $request_options = $request_options + [
      RequestOptions::JSON => $doc,
    ];
    $response = $this
      ->request('PATCH', $node_url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $doc = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame('2018-12-20', $doc['data']['attributes']['when']);
    $this
      ->assertSame('2018-12-20T05:00:00+11:00', $doc['data']['attributes']['when_exactly']);
  }

  /**
   * Ensure includes are respected even when POSTing.
   *
   * @see https://www.drupal.org/project/drupal/issues/3026030
   */
  public function testPostToIncludeUrlDoesNotReturnIncludeFromIssue3026030() {
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);

    // Set up data model.
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    $this
      ->rebuildAll();

    // Test.
    $user = $this
      ->drupalCreateUser([
      'bypass node access',
    ]);
    $url = Url::fromUri('internal:/jsonapi/node/page?include=uid');
    $request_options = [
      RequestOptions::HEADERS => [
        'Content-Type' => 'application/vnd.api+json',
        'Accept' => 'application/vnd.api+json',
      ],
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
      RequestOptions::JSON => [
        'data' => [
          'type' => 'node--page',
          'attributes' => [
            'title' => 'test',
          ],
        ],
      ],
    ];
    $response = $this
      ->request('POST', $url, $request_options);
    $this
      ->assertSame(201, $response
      ->getStatusCode());
    $doc = Json::decode((string) $response
      ->getBody());
    $this
      ->assertArrayHasKey('included', $doc);
    $this
      ->assertSame($user
      ->label(), $doc['included'][0]['attributes']['name']);
  }

  /**
   * Ensure includes are respected even when PATCHing.
   *
   * @see https://www.drupal.org/project/drupal/issues/3026030
   */
  public function testPatchToIncludeUrlDoesNotReturnIncludeFromIssue3026030() {
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);

    // Set up data model.
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    $this
      ->rebuildAll();

    // Create data.
    $user = $this
      ->drupalCreateUser([
      'bypass node access',
    ]);
    $page = Node::create([
      'title' => 'original',
      'type' => 'page',
      'uid' => $user
        ->id(),
    ]);
    $page
      ->save();

    // Test.
    $url = Url::fromUri(sprintf('internal:/jsonapi/node/page/%s/?include=uid', $page
      ->uuid()));
    $request_options = [
      RequestOptions::HEADERS => [
        'Content-Type' => 'application/vnd.api+json',
        'Accept' => 'application/vnd.api+json',
      ],
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
      RequestOptions::JSON => [
        'data' => [
          'type' => 'node--page',
          'id' => $page
            ->uuid(),
          'attributes' => [
            'title' => 'modified',
          ],
        ],
      ],
    ];
    $response = $this
      ->request('PATCH', $url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $doc = Json::decode((string) $response
      ->getBody());
    $this
      ->assertArrayHasKey('included', $doc);
    $this
      ->assertSame($user
      ->label(), $doc['included'][0]['attributes']['name']);
  }

  /**
   * Ensure `@FieldType=map` fields are normalized correctly.
   *
   * @see https://www.drupal.org/project/drupal/issues/3040590
   */
  public function testMapFieldTypeNormalizationFromIssue3040590() {
    $this
      ->assertTrue($this->container
      ->get('module_installer')
      ->install([
      'entity_test',
    ], TRUE), 'Installed modules.');

    // Create data.
    $entity_a = EntityTestMapField::create([
      'name' => 'A',
      'data' => [
        'foo' => 'bar',
        'baz' => 'qux',
      ],
    ]);
    $entity_a
      ->save();
    $entity_b = EntityTestMapField::create([
      'name' => 'B',
    ]);
    $entity_b
      ->save();
    $user = $this
      ->drupalCreateUser([
      'administer entity_test content',
    ]);

    // Test.
    $url = Url::fromUri('internal:/jsonapi/entity_test_map_field/entity_test_map_field?sort=drupal_internal__id');
    $request_options = [
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
    ];
    $response = $this
      ->request('GET', $url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $data = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame([
      'foo' => 'bar',
      'baz' => 'qux',
    ], $data['data'][0]['attributes']['data']);
    $this
      ->assertNull($data['data'][1]['attributes']['data']);
    $entity_a
      ->set('data', [
      'foo' => 'bar',
    ])
      ->save();
    $response = $this
      ->request('GET', $url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $data = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame([
      'foo' => 'bar',
    ], $data['data'][0]['attributes']['data']);
  }

  /**
   * Ensure filtering for entities with empty entity reference fields works.
   *
   * @see https://www.drupal.org/project/jsonapi/issues/3025372
   */
  public function testEmptyRelationshipFilteringFromIssue3025372() {

    // Set up data model.
    $this
      ->drupalCreateContentType([
      'type' => 'folder',
    ]);
    $this
      ->createEntityReferenceField('node', 'folder', 'field_parent_folder', NULL, 'node', 'default', [
      'target_bundles' => [
        'folder',
      ],
    ], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
    $this
      ->rebuildAll();

    // Create data.
    $node = Node::create([
      'title' => 'root folder',
      'type' => 'folder',
    ]);
    $node
      ->save();

    // Test.
    $user = $this
      ->drupalCreateUser([
      'access content',
    ]);
    $url = Url::fromRoute('jsonapi.node--folder.collection');
    $request_options = [
      RequestOptions::HEADERS => [
        'Content-Type' => 'application/vnd.api+json',
        'Accept' => 'application/vnd.api+json',
      ],
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
    ];
    $response = $this
      ->request('GET', $url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode(), (string) $response
      ->getBody());
    $this
      ->assertSame($node
      ->uuid(), Json::decode((string) $response
      ->getBody())['data'][0]['id']);
    $response = $this
      ->request('GET', $url
      ->setOption('query', [
      'filter[test][condition][path]' => 'field_parent_folder',
      'filter[test][condition][operator]' => 'IS NULL',
    ]), $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode(), (string) $response
      ->getBody());
    $this
      ->assertSame($node
      ->uuid(), Json::decode((string) $response
      ->getBody())['data'][0]['id']);
    $response = $this
      ->request('GET', $url
      ->setOption('query', [
      'filter[test][condition][path]' => 'field_parent_folder',
      'filter[test][condition][operator]' => 'IS NOT NULL',
    ]), $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode(), (string) $response
      ->getBody());
    $this
      ->assertEmpty(Json::decode((string) $response
      ->getBody())['data']);
  }

  /**
   * Tests that the response still has meaningful error messages.
   */
  public function testRecursionDetectedWhenResponseContainsViolationsFrom3042124() {
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);

    // Set up default request.
    $url = Url::fromUri('internal:/jsonapi/node/article');
    $request_options = [
      RequestOptions::HEADERS => [
        'Content-Type' => 'application/vnd.api+json',
        'Accept' => 'application/vnd.api+json',
      ],
      RequestOptions::JSON => [
        'data' => [
          'type' => 'node--article',
          'attributes' => [],
        ],
      ],
    ];

    // Set up test users.
    $user = $this
      ->drupalCreateUser([
      'bypass node access',
    ], 'Sam');
    $admin = $this
      ->drupalCreateUser([], 'Gandalf', TRUE);

    // Make request as regular user.
    $request_options[RequestOptions::AUTH] = [
      $user
        ->getAccountName(),
      $user->pass_raw,
    ];
    $this
      ->request('POST', $url, $request_options);
    $response = $this
      ->request('POST', $url, $request_options);

    // Assert that the response has a body.
    $data = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame(422, $response
      ->getStatusCode());
    $this
      ->assertNotNull($data);
    $this
      ->assertSame(sprintf('title: This value should not be null.'), $data['errors'][0]['detail']);

    // Make request as regular user.
    $request_options[RequestOptions::AUTH] = [
      $admin
        ->getAccountName(),
      $admin->pass_raw,
    ];
    $this
      ->request('POST', $url, $request_options);
    $response = $this
      ->request('POST', $url, $request_options);

    // Assert that the response has a body.
    $data = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame(422, $response
      ->getStatusCode());
    $this
      ->assertNotNull($data);
    $this
      ->assertSame(sprintf('title: This value should not be null.'), $data['errors'][0]['detail']);
  }

  /**
   * Ensure that child comments can be retrieved via JSON:API.
   */
  public function testLeakedCacheMetadataViaRdfFromIssue3053827() {
    $this
      ->assertTrue($this->container
      ->get('module_installer')
      ->install([
      'comment',
      'rdf',
    ], TRUE), 'Installed modules.');
    $this
      ->addDefaultCommentField('node', 'article', 'comment', CommentItemInterface::OPEN, 'comment');
    $this
      ->rebuildAll();

    // Create data.
    Node::create([
      'title' => 'Commented Node',
      'type' => 'article',
    ])
      ->save();
    $default_values = [
      'entity_id' => 1,
      'entity_type' => 'node',
      'field_name' => 'comment',
      'status' => 1,
    ];
    $parent = Comment::create([
      'subject' => 'Marlin',
    ] + $default_values);
    $parent
      ->save();
    $child = Comment::create([
      'subject' => 'Nemo',
      'pid' => $parent
        ->id(),
    ] + $default_values);
    $child
      ->save();

    // Test.
    $user = $this
      ->drupalCreateUser([
      'access comments',
    ]);
    $request_options = [
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
    ];

    // Requesting the comment collection should succeed.
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/comment/comment'), $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
  }

  /**
   * Ensure non-translatable entities can be PATCHed with an alternate language.
   *
   * @see https://www.drupal.org/project/drupal/issues/3043168
   */
  public function testNonTranslatableEntityUpdatesFromIssue3043168() {

    // Enable write-mode.
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);

    // Set the site language to Russian.
    $this
      ->config('system.site')
      ->set('langcode', 'ru')
      ->set('default_langcode', 'ru')
      ->save(TRUE);

    // Install a "custom" entity type that is not translatable.
    $this
      ->assertTrue($this->container
      ->get('module_installer')
      ->install([
      'entity_test',
    ], TRUE), 'Installed modules.');

    // Clear and rebuild caches and routes.
    $this
      ->rebuildAll();

    // Create a test entity.
    // @see \Drupal\language\DefaultLanguageItem
    $entity = EntityTest::create([
      'name' => 'Alexander',
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ]);
    $entity
      ->save();

    // Ensure it is an instance of TranslatableInterface and that it is *not*
    // translatable.
    $this
      ->assertInstanceOf(TranslatableInterface::class, $entity);
    $this
      ->assertFalse($entity
      ->isTranslatable());

    // Set up a test user with permission to view and update the test entity.
    $user = $this
      ->drupalCreateUser([
      'view test entity',
      'administer entity_test content',
    ]);
    $request_options[RequestOptions::HEADERS]['Accept'] = 'application/vnd.api+json';
    $request_options[RequestOptions::AUTH] = [
      $user
        ->getAccountName(),
      $user->pass_raw,
    ];

    // GET the test entity via JSON:API.
    $entity_url = Url::fromUri('internal:/jsonapi/entity_test/entity_test/' . $entity
      ->uuid());
    $response = $this
      ->request('GET', $entity_url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $response_document = Json::decode($response
      ->getBody());

    // Ensure that the entity's langcode attribute is 'und'.
    $this
      ->assertSame(LanguageInterface::LANGCODE_NOT_SPECIFIED, $response_document['data']['attributes']['langcode']);

    // Prepare to PATCH the entity via JSON:API.
    $request_options[RequestOptions::HEADERS]['Content-Type'] = 'application/vnd.api+json';
    $request_options[RequestOptions::JSON] = [
      'data' => [
        'type' => 'entity_test--entity_test',
        'id' => $entity
          ->uuid(),
        'attributes' => [
          'name' => 'Constantine',
        ],
      ],
    ];

    // Issue the PATCH request and verify that the test entity was successfully
    // updated.
    $response = $this
      ->request('PATCH', $entity_url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode(), (string) $response
      ->getBody());
    $response_document = Json::decode($response
      ->getBody());

    // Ensure that the entity's langcode attribute is still 'und' and the name
    // was successfully updated.
    $this
      ->assertSame(LanguageInterface::LANGCODE_NOT_SPECIFIED, $response_document['data']['attributes']['langcode']);
    $this
      ->assertSame('Constantine', $response_document['data']['attributes']['name']);
  }

  /**
   * Ensure POSTing invalid data results in a 422 response, not a PHP error.
   *
   * @see https://www.drupal.org/project/drupal/issues/3052954
   */
  public function testInvalidDataTriggersUnprocessableEntityErrorFromIssue3052954() {
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);

    // Set up data model.
    $user = $this
      ->drupalCreateUser([
      'bypass node access',
    ]);

    // Test.
    $request_options = [
      RequestOptions::HEADERS => [
        'Content-Type' => 'application/vnd.api+json',
        'Accept' => 'application/vnd.api+json',
      ],
      RequestOptions::JSON => [
        'data' => [
          'type' => 'article',
          'attributes' => [
            'title' => 'foobar',
            'created' => 'not_a_date',
          ],
        ],
      ],
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
    ];
    $response = $this
      ->request('POST', Url::fromUri('internal:/jsonapi/node/article'), $request_options);
    $this
      ->assertSame(422, $response
      ->getStatusCode());
  }

  /**
   * Ensure optional `@FieldType=map` fields are denormalized correctly.
   */
  public function testEmptyMapFieldTypeDenormalization() {
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);

    // Set up data model.
    $this
      ->assertTrue($this->container
      ->get('module_installer')
      ->install([
      'entity_test',
    ], TRUE), 'Installed modules.');

    // Create data.
    $entity = EntityTestMapField::create([
      'name' => 'foo',
    ]);
    $entity
      ->save();
    $user = $this
      ->drupalCreateUser([
      'administer entity_test content',
    ]);

    // Test.
    $url = Url::fromUri(sprintf('internal:/jsonapi/entity_test_map_field/entity_test_map_field/%s', $entity
      ->uuid()));
    $request_options = [
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
    ];

    // Retrieve the current representation of the entity.
    $response = $this
      ->request('GET', $url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $doc = Json::decode((string) $response
      ->getBody());

    // Modify the title. The @FieldType=map normalization is not changed. (The
    // name of this field is confusingly also 'data'.)
    $doc['data']['attributes']['name'] = 'bar';
    $request_options[RequestOptions::HEADERS] = [
      'Content-Type' => 'application/vnd.api+json',
      'Accept' => 'application/vnd.api+json',
    ];
    $request_options[RequestOptions::BODY] = Json::encode($doc);
    $response = $this
      ->request('PATCH', $url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $this
      ->assertSame($doc['data']['attributes']['data'], Json::decode((string) $response
      ->getBody())['data']['attributes']['data']);
  }

  /**
   * Ensure EntityAccessDeniedHttpException cacheability is taken into account.
   */
  public function testLeakCacheMetadataInOmitted() {
    $term = Term::create([
      'name' => 'Llama term',
      'vid' => 'tags',
    ]);
    $term
      ->setUnpublished();
    $term
      ->save();
    $node = Node::create([
      'type' => 'article',
      'title' => 'Llama node',
      'field_tags' => [
        'target_id' => $term
          ->id(),
      ],
    ]);
    $node
      ->save();
    $user = $this
      ->drupalCreateUser([
      'access content',
    ]);
    $request_options = [
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
    ];

    // Request with unpublished term. At this point it would include the term
    // into "omitted" part of the response. The point here is that we
    // purposefully warm up the cache where it is excluded from response and
    // on the next run we will assure merely publishing term is enough to make
    // it visible, i.e. that the 1st response was invalidated in Drupal cache.
    $url = Url::fromUri('internal:/jsonapi/' . $node
      ->getEntityTypeId() . '/' . $node
      ->bundle(), [
      'query' => [
        'include' => 'field_tags',
      ],
    ]);
    $response = $this
      ->request('GET', $url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $response = Json::decode((string) $response
      ->getBody());
    $this
      ->assertArrayNotHasKey('included', $response, 'JSON API response does not contain "included" taxonomy term as the latter is not published, i.e not accessible.');
    $omitted = $response['meta']['omitted']['links'];
    unset($omitted['help']);
    $omitted = reset($omitted);
    $expected_url = Url::fromUri('internal:/jsonapi/' . $term
      ->getEntityTypeId() . '/' . $term
      ->bundle() . '/' . $term
      ->uuid());
    $expected_url
      ->setAbsolute();
    $this
      ->assertSame($expected_url
      ->toString(), $omitted['href'], 'Entity that is excluded due to access constraints is correctly reported in the "Omitted" section of the JSON API response.');
    $term
      ->setPublished();
    $term
      ->save();
    $response = $this
      ->request('GET', $url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
    $this
      ->assertEquals($term
      ->uuid(), Json::decode((string) $response
      ->getBody())['included'][0]['id'], 'JSON API response contains "included" taxonomy term as it became published, i.e accessible.');
  }

  /**
   * Tests that "virtual/missing" resources can exist for renamed fields.
   *
   * @see https://www.drupal.org/project/drupal/issues/3034786
   * @see https://www.drupal.org/project/drupal/issues/3035544
   */
  public function testAliasedFieldsWithVirtualRelationships() {

    // Set up the data model.
    $this
      ->assertTrue($this->container
      ->get('module_installer')
      ->install([
      'taxonomy',
      'jsonapi_test_resource_type_building',
    ], TRUE), 'Installed modules.');
    \Drupal::state()
      ->set('jsonapi_test_resource_type_builder.resource_type_field_aliases', [
      'node--article' => [
        'field_tags' => 'field_aliased',
      ],
    ]);
    $this
      ->rebuildAll();
    $tag_term = Term::create([
      'vid' => 'tags',
      'name' => 'test_tag',
    ]);
    $tag_term
      ->save();
    $article_node = Node::create([
      'type' => 'article',
      'title' => 'test_article',
      'field_tags' => [
        'target_id' => $tag_term
          ->id(),
      ],
    ]);
    $article_node
      ->save();

    // Make a broken reference.
    $tag_term
      ->delete();

    // Make sure that accessing a node that references a deleted term does not
    // cause an error.
    $user = $this
      ->drupalCreateUser([
      'bypass node access',
    ]);
    $request_options = [
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
    ];
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/node/article/' . $article_node
      ->uuid()), $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode());
  }

  /**
   * Tests that caching isn't happening for non-cacheable methods.
   *
   * @see https://www.drupal.org/project/drupal/issues/3072076
   */
  public function testNonCacheableMethods() {
    $this->container
      ->get('module_installer')
      ->install([
      'jsonapi_test_non_cacheable_methods',
    ], TRUE);
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);
    $node = Node::create([
      'type' => 'article',
      'title' => 'Llama non-cacheable',
    ]);
    $node
      ->save();
    $user = $this
      ->drupalCreateUser([
      'access content',
      'create article content',
      'edit any article content',
      'delete any article content',
    ]);
    $base_request_options = [
      RequestOptions::HEADERS => [
        'Content-Type' => 'application/vnd.api+json',
        'Accept' => 'application/vnd.api+json',
      ],
      RequestOptions::AUTH => [
        $user
          ->getAccountName(),
        $user->pass_raw,
      ],
    ];
    $methods = [
      'HEAD',
      'GET',
      'PATCH',
      'DELETE',
    ];
    $non_post_request_options = $base_request_options + [
      RequestOptions::JSON => [
        'data' => [
          'type' => 'node--article',
          'id' => $node
            ->uuid(),
        ],
      ],
    ];
    foreach ($methods as $method) {
      $response = $this
        ->request($method, Url::fromUri('internal:/jsonapi/node/article/' . $node
        ->uuid()), $non_post_request_options);
      $this
        ->assertSame($method === 'DELETE' ? 204 : 200, $response
        ->getStatusCode());
    }
    $post_request_options = $base_request_options + [
      RequestOptions::JSON => [
        'data' => [
          'type' => 'node--article',
          'attributes' => [
            'title' => 'Llama non-cacheable',
          ],
        ],
      ],
    ];
    $response = $this
      ->request('POST', Url::fromUri('internal:/jsonapi/node/article'), $post_request_options);
    $this
      ->assertSame(201, $response
      ->getStatusCode());
  }

  /**
   * Tests that collections can be filtered by an entity reference target_id.
   *
   * @see https://www.drupal.org/project/drupal/issues/3036593
   */
  public function testFilteringEntitiesByEntityReferenceTargetId() {

    // Create two config entities to be the config targets of an entity
    // reference. In this case, the `roles` field.
    $role_llamalovers = $this
      ->drupalCreateRole([], 'llamalovers', 'Llama Lovers');
    $role_catcuddlers = $this
      ->drupalCreateRole([], 'catcuddlers', 'Cat Cuddlers');

    /** @var \Drupal\user\UserInterface[] $users */
    for ($i = 0; $i < 3; $i++) {

      // Create 3 users, one with the first role and two with the second role.
      $users[$i] = $this
        ->drupalCreateUser();
      $users[$i]
        ->addRole($i === 0 ? $role_llamalovers : $role_catcuddlers);
      $users[$i]
        ->save();

      // For each user, create a node that is owned by that user. The node's
      // `uid` field will be used to test filtering by a content entity ID.
      Node::create([
        'type' => 'article',
        'uid' => $users[$i]
          ->id(),
        'title' => 'Article created by ' . $users[$i]
          ->uuid(),
      ])
        ->save();
    }

    // Create a user that will be used to execute the test HTTP requests.
    $account = $this
      ->drupalCreateUser([
      'administer users',
      'bypass node access',
    ]);
    $request_options = [
      RequestOptions::AUTH => [
        $account
          ->getAccountName(),
        $account->pass_raw,
      ],
    ];

    // Ensure that an entity can be filtered by a target machine name.
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/user/user?filter[roles.meta.drupal_internal__target_id]=llamalovers'), $request_options);
    $document = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame(200, $response
      ->getStatusCode(), var_export($document, TRUE));

    // Only one user should have the first role.
    $this
      ->assertCount(1, $document['data']);
    $this
      ->assertSame($users[0]
      ->uuid(), $document['data'][0]['id']);
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/user/user?sort=drupal_internal__uid&filter[roles.meta.drupal_internal__target_id]=catcuddlers'), $request_options);
    $document = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame(200, $response
      ->getStatusCode(), var_export($document, TRUE));

    // Two users should have the second role. A sort is used on this request to
    // ensure a consistent ordering with different databases.
    $this
      ->assertCount(2, $document['data']);
    $this
      ->assertSame($users[1]
      ->uuid(), $document['data'][0]['id']);
    $this
      ->assertSame($users[2]
      ->uuid(), $document['data'][1]['id']);

    // Ensure that an entity can be filtered by an target entity integer ID.
    $response = $this
      ->request('GET', Url::fromUri('internal:/jsonapi/node/article?filter[uid.meta.drupal_internal__target_id]=' . $users[1]
      ->id()), $request_options);
    $document = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame(200, $response
      ->getStatusCode(), var_export($document, TRUE));

    // Only the node authored by the filtered user should be returned.
    $this
      ->assertCount(1, $document['data']);
    $this
      ->assertSame('Article created by ' . $users[1]
      ->uuid(), $document['data'][0]['attributes']['title']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertEscaped Deprecated	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated	protected	function	Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertLink Deprecated	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNoText Deprecated	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::assertNoUniqueText Deprecated	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated	protected	function	Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated	protected	function	Gets the current raw content.
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	protected	function
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 output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile	protected	property	The file name to write the list of URLs to.
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 drupal_rewrite_settings().
BrowserTestBase::$databasePrefix	protected	property	The database prefix of this test run.
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::$preserveGlobalState	protected	property
BrowserTestBase::$profile	protected	property	The profile to install as a basis for testing.	39
BrowserTestBase::$root	protected	property	The app root.
BrowserTestBase::$runTestInSeparateProcess	protected	property	Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
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 Simpletest environment.
BrowserTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated	protected	function	Gets the value of an HTTP response header.
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	Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests.	1
BrowserTestBase::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 Simpletest site.	1
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::__sleep	public	function	Prevents serializing any properties.
CommentTestTrait::addDefaultCommentField	public	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
EntityReferenceTestTrait::createEntityReferenceField	protected	function	Creates a field of an entity reference field storage on the specified bundle.
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::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.
FunctionalTestSetupTrait::installModulesFromClassProperty	protected	function	Install modules defined by `static::$modules`.	1
FunctionalTestSetupTrait::installParameters	protected	function	Returns the parameters that will be used when Simpletest installs Drupal.	9
FunctionalTestSetupTrait::prepareEnvironment	protected	function	Prepares the current environment for running the test.	20
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.	2
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
ImageFieldCreationTrait::createImageField	protected	function	Create a new image field.
JsonApiFunctionalTestBase::$files	protected	property	Test files.
JsonApiFunctionalTestBase::$httpClient	protected	property	The HTTP client.
JsonApiFunctionalTestBase::$nodes	protected	property	Test nodes.
JsonApiFunctionalTestBase::$tags	protected	property	Test taxonomy terms.
JsonApiFunctionalTestBase::$user	protected	property	Test user.
JsonApiFunctionalTestBase::$userCanViewProfiles	protected	property	Test user with access to view profiles.
JsonApiFunctionalTestBase::createDefaultContent	protected	function	Creates default content to test the API.
JsonApiFunctionalTestBase::IS_MULTILINGUAL		constant
JsonApiFunctionalTestBase::IS_NOT_MULTILINGUAL		constant
JsonApiFunctionalTestBase::request	protected	function	Performs a HTTP request. Wraps the Guzzle HTTP client.
JsonApiFunctionalTestBase::setUp	protected	function	Overrides BrowserTestBase::setUp	1
JsonApiRegressionTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides JsonApiFunctionalTestBase::$defaultTheme
JsonApiRegressionTest::$modules	protected static	property	Modules to enable. Overrides JsonApiFunctionalTestBase::$modules
JsonApiRegressionTest::testAliasedFieldsWithVirtualRelationships	public	function	Tests that "virtual/missing" resources can exist for renamed fields.
JsonApiRegressionTest::testBundlelessRelationshipMutationFromIssue2973681	public	function	Ensure POST and PATCH works for bundle-less relationship routes.
JsonApiRegressionTest::testBundleSpecificTargetEntityTypeFromIssue2953207	public	function	Ensure filtering on relationships works with bundle-specific target types.
JsonApiRegressionTest::testDanglingReferencesInAnEntityReferenceFieldFromIssue2968972	public	function	Cannot PATCH an entity with dangling references in an ER field.
JsonApiRegressionTest::testDanglingReferencesInAnEntityReferenceFieldFromIssue2984647	public	function	Cannot GET an entity with dangling references in an ER field.
JsonApiRegressionTest::testDeepNestedIncludeMultiTargetEntityTypeFieldFromIssue2973681	public	function	Ensure deep nested include works on multi target entity type field.
JsonApiRegressionTest::testDenormalizeAliasedRelationshipFromIssue2953207	public	function	Ensures denormalizing relationships with aliased field names works.
JsonApiRegressionTest::testEmptyMapFieldTypeDenormalization	public	function	Ensure optional `@FieldType=map` fields are denormalized correctly.
JsonApiRegressionTest::testEmptyRelationshipFilteringFromIssue3025372	public	function	Ensure filtering for entities with empty entity reference fields works.
JsonApiRegressionTest::testFilterByIdFromIssue3015759	public	function	Ensures that filtering by a sequential internal ID named 'id' is possible.
JsonApiRegressionTest::testFilteringEntitiesByEntityReferenceTargetId	public	function	Tests that collections can be filtered by an entity reference target_id.
JsonApiRegressionTest::testGetNodeCollectionWithHookNodeGrantsImplementationsFromIssue2984964	public	function	Ensures GETting node collection + hook_node_grants() implementations works.
JsonApiRegressionTest::testGetTermWhenMultipleVocabulariesExistFromIssue2977879	public	function	Ensures GETting terms works when multiple vocabularies exist.
JsonApiRegressionTest::testInvalidDataTriggersUnprocessableEntityErrorFromIssue3052954	public	function	Ensure POSTing invalid data results in a 422 response, not a PHP error.
JsonApiRegressionTest::testLeakCacheMetadataInOmitted	public	function	Ensure EntityAccessDeniedHttpException cacheability is taken into account.
JsonApiRegressionTest::testLeakedCacheMetadataViaRdfFromIssue3053827	public	function	Ensure that child comments can be retrieved via JSON:API.
JsonApiRegressionTest::testMapFieldTypeNormalizationFromIssue3040590	public	function	Ensure `@FieldType=map` fields are normalized correctly.
JsonApiRegressionTest::testNonCacheableMethods	public	function	Tests that caching isn't happening for non-cacheable methods.
JsonApiRegressionTest::testNonTranslatableEntityUpdatesFromIssue3043168	public	function	Ensure non-translatable entities can be PATCHed with an alternate language.
JsonApiRegressionTest::testPageCacheFromIssue3009596	public	function	Ensures that Drupal's page cache is effective.
JsonApiRegressionTest::testPatchingDateTimeFieldsFromIssue3021194	public	function	Ensures PATCHing datetime (both date-only & date+time) fields is possible.
JsonApiRegressionTest::testPatchingDateTimeNormalizedWrongTimeZoneIssue3021194	public	function	Ensures datetime fields are normalized using the correct timezone.
JsonApiRegressionTest::testPatchToIncludeUrlDoesNotReturnIncludeFromIssue3026030	public	function	Ensure includes are respected even when PATCHing.
JsonApiRegressionTest::testPostToIncludeUrlDoesNotReturnIncludeFromIssue3026030	public	function	Ensure includes are respected even when POSTing.
JsonApiRegressionTest::testRecursionDetectedWhenResponseContainsViolationsFrom3042124	public	function	Tests that the response still has meaningful error messages.
JsonApiRegressionTest::testThatRoutesAreRebuiltAfterDataModelChangesFromIssue2984886	public	function	Ensures that JSON:API routes are caches are dynamically rebuilt.
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
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
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.	1
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.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
RefreshVariablesTrait::refreshVariables	protected	function	Refreshes in-memory configuration and state information.	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::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
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.
TestSetupTrait::$container	protected	property	The dependency injection container used in the test.
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::$siteDirectory	protected	property	The site directory of this test run.
TestSetupTrait::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	1
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::getDatabaseConnection	public static	function	Returns the database connection to the site running Simpletest.
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::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.	2
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::drupalPostForm Deprecated	protected	function	Executes a form submission.
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.