You are here

class JsonApiFunctionalTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/jsonapi/tests/src/Functional/JsonApiFunctionalTest.php \Drupal\Tests\jsonapi\Functional\JsonApiFunctionalTest
  2. 10 core/modules/jsonapi/tests/src/Functional/JsonApiFunctionalTest.php \Drupal\Tests\jsonapi\Functional\JsonApiFunctionalTest

General functional test class.

@group jsonapi

@internal

Hierarchy

Expanded class hierarchy of JsonApiFunctionalTest

File

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

Namespace

Drupal\Tests\jsonapi\Functional
View source
class JsonApiFunctionalTest extends JsonApiFunctionalTestBase {

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

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

  /**
   * Tests the GET method.
   */
  public function testRead() {
    $this
      ->createDefaultContent(61, 5, TRUE, TRUE, static::IS_NOT_MULTILINGUAL, FALSE);

    // Unpublish the last entity, so we can check access.
    $this->nodes[60]
      ->setUnpublished()
      ->save();

    // Different databases have different sort orders, so a sort is required so
    // test expectations do not need to vary per database.
    $default_sort = [
      'sort' => 'drupal_internal__nid',
    ];

    // 0. HEAD request allows a client to verify that JSON:API is installed.
    $this->httpClient
      ->request('HEAD', $this
      ->buildUrl('/jsonapi/node/article'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // 1. Load all articles (1st page).
    $collection_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => $default_sort,
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertCount(OffsetPage::SIZE_MAX, $collection_output['data']);
    $this
      ->assertSession()
      ->responseHeaderEquals('Content-Type', 'application/vnd.api+json');

    // 2. Load all articles (Offset 3).
    $collection_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'page' => [
          'offset' => 3,
        ],
      ] + $default_sort,
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertCount(OffsetPage::SIZE_MAX, $collection_output['data']);
    $this
      ->assertStringContainsString('page%5Boffset%5D=53', $collection_output['links']['next']['href']);

    // 3. Load all articles (1st page, 2 items)
    $collection_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'page' => [
          'limit' => 2,
        ],
      ] + $default_sort,
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertCount(2, $collection_output['data']);

    // 4. Load all articles (2nd page, 2 items).
    $collection_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'page' => [
          'limit' => 2,
          'offset' => 2,
        ],
      ] + $default_sort,
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertCount(2, $collection_output['data']);
    $this
      ->assertStringContainsString('page%5Boffset%5D=4', $collection_output['links']['next']['href']);

    // 5. Single article.
    $uuid = $this->nodes[0]
      ->uuid();
    $single_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article/' . $uuid));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertArrayHasKey('type', $single_output['data']);
    $this
      ->assertEquals($this->nodes[0]
      ->getTitle(), $single_output['data']['attributes']['title']);

    // 5.1 Single article with access denied because unauthenticated.
    Json::decode($this
      ->drupalGet('/jsonapi/node/article/' . $this->nodes[60]
      ->uuid()));
    $this
      ->assertSession()
      ->statusCodeEquals(401);

    // 5.1 Single article with access denied while authenticated.
    $this
      ->drupalLogin($this->userCanViewProfiles);
    $single_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article/' . $this->nodes[60]
      ->uuid()));
    $this
      ->assertSession()
      ->statusCodeEquals(403);
    $this
      ->assertEquals('/data', $single_output['errors'][0]['source']['pointer']);
    $this
      ->drupalLogout();

    // 6. Single relationship item.
    $single_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article/' . $uuid . '/relationships/node_type'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertArrayHasKey('type', $single_output['data']);
    $this
      ->assertArrayNotHasKey('attributes', $single_output['data']);
    $this
      ->assertArrayHasKey('related', $single_output['links']);

    // 7. Single relationship image.
    $single_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article/' . $uuid . '/relationships/field_image'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertArrayHasKey('type', $single_output['data']);
    $this
      ->assertArrayNotHasKey('attributes', $single_output['data']);
    $this
      ->assertArrayHasKey('related', $single_output['links']);

    // 8. Multiple relationship item.
    $single_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article/' . $uuid . '/relationships/field_tags'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertArrayHasKey('type', $single_output['data'][0]);
    $this
      ->assertArrayNotHasKey('attributes', $single_output['data'][0]);
    $this
      ->assertArrayHasKey('related', $single_output['links']);

    // 8b. Single related item, empty.
    $single_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article/' . $uuid . '/field_heroless'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSame(NULL, $single_output['data']);

    // 9. Related tags with includes.
    $single_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article/' . $uuid . '/field_tags', [
      'query' => [
        'include' => 'vid',
      ],
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertEquals('taxonomy_term--tags', $single_output['data'][0]['type']);
    $this
      ->assertArrayNotHasKey('tid', $single_output['data'][0]['attributes']);
    $this
      ->assertStringContainsString('/taxonomy_term/tags/', $single_output['data'][0]['links']['self']['href']);
    $this
      ->assertEquals('taxonomy_vocabulary--taxonomy_vocabulary', $single_output['included'][0]['type']);

    // 10. Single article with includes.
    $single_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article/' . $uuid, [
      'query' => [
        'include' => 'uid,field_tags',
      ],
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertEquals('node--article', $single_output['data']['type']);
    $first_include = reset($single_output['included']);
    $this
      ->assertEquals('user--user', $first_include['type']);
    $last_include = end($single_output['included']);
    $this
      ->assertEquals('taxonomy_term--tags', $last_include['type']);

    // 10b. Single article with nested includes.
    $single_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article/' . $uuid, [
      'query' => [
        'include' => 'field_tags,field_tags.vid',
      ],
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertEquals('node--article', $single_output['data']['type']);
    $first_include = reset($single_output['included']);
    $this
      ->assertEquals('taxonomy_term--tags', $first_include['type']);
    $last_include = end($single_output['included']);
    $this
      ->assertEquals('taxonomy_vocabulary--taxonomy_vocabulary', $last_include['type']);

    // 11. Includes with relationships.
    $this
      ->drupalGet('/jsonapi/node/article/' . $uuid . '/relationships/uid');
    $single_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article/' . $uuid . '/relationships/uid', [
      'query' => [
        'include' => 'uid',
      ],
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertEquals('user--user', $single_output['data']['type']);
    $this
      ->assertArrayHasKey('related', $single_output['links']);
    $this
      ->assertArrayHasKey('included', $single_output);
    $first_include = reset($single_output['included']);
    $this
      ->assertEquals('user--user', $first_include['type']);
    $this
      ->assertFalse(empty($first_include['attributes']));
    $this
      ->assertTrue(empty($first_include['attributes']['mail']));
    $this
      ->assertTrue(empty($first_include['attributes']['pass']));

    // 12. Collection with one access denied.
    $this->nodes[1]
      ->set('status', FALSE);
    $this->nodes[1]
      ->save();
    $single_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'page' => [
          'limit' => 2,
        ],
      ] + $default_sort,
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertCount(1, $single_output['data']);
    $non_help_links = array_filter(array_keys($single_output['meta']['omitted']['links']), function ($key) {
      return $key !== 'help';
    });
    $this
      ->assertCount(1, $non_help_links);
    $link_keys = array_keys($single_output['meta']['omitted']['links']);
    $this
      ->assertSame('help', reset($link_keys));
    $this
      ->assertMatchesRegularExpression('/^item--[a-zA-Z0-9]{7}$/', next($link_keys));
    $this->nodes[1]
      ->set('status', TRUE);
    $this->nodes[1]
      ->save();

    // 13. Test filtering when using short syntax.
    $filter = [
      'uid.id' => [
        'value' => $this->user
          ->uuid(),
      ],
      'field_tags.id' => [
        'value' => $this->tags[0]
          ->uuid(),
      ],
    ];
    $single_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'filter' => $filter,
        'include' => 'uid,field_tags',
      ],
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertGreaterThan(0, count($single_output['data']));

    // 14. Test filtering when using long syntax.
    $filter = [
      'and_group' => [
        'group' => [
          'conjunction' => 'AND',
        ],
      ],
      'filter_user' => [
        'condition' => [
          'path' => 'uid.id',
          'value' => $this->user
            ->uuid(),
          'memberOf' => 'and_group',
        ],
      ],
      'filter_tags' => [
        'condition' => [
          'path' => 'field_tags.id',
          'value' => $this->tags[0]
            ->uuid(),
          'memberOf' => 'and_group',
        ],
      ],
    ];
    $single_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'filter' => $filter,
        'include' => 'uid,field_tags',
      ],
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertGreaterThan(0, count($single_output['data']));

    // 15. Test filtering when using invalid syntax.
    $filter = [
      'and_group' => [
        'group' => [
          'conjunction' => 'AND',
        ],
      ],
      'filter_user' => [
        'condition' => [
          'name-with-a-typo' => 'uid.id',
          'value' => $this->user
            ->uuid(),
          'memberOf' => 'and_group',
        ],
      ],
    ];
    $this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'filter' => $filter,
      ] + $default_sort,
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(400);

    // 16. Test filtering on the same field.
    $filter = [
      'or_group' => [
        'group' => [
          'conjunction' => 'OR',
        ],
      ],
      'filter_tags_1' => [
        'condition' => [
          'path' => 'field_tags.id',
          'value' => $this->tags[0]
            ->uuid(),
          'memberOf' => 'or_group',
        ],
      ],
      'filter_tags_2' => [
        'condition' => [
          'path' => 'field_tags.id',
          'value' => $this->tags[1]
            ->uuid(),
          'memberOf' => 'or_group',
        ],
      ],
    ];
    $single_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'filter' => $filter,
        'include' => 'field_tags',
      ] + $default_sort,
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertGreaterThanOrEqual(2, count($single_output['included']));

    // 17. Single user (check fields lacking 'view' access).
    $user_url = Url::fromRoute('jsonapi.user--user.individual', [
      'entity' => $this->user
        ->uuid(),
    ]);
    $response = $this
      ->request('GET', $user_url, [
      'auth' => [
        $this->userCanViewProfiles
          ->getAccountName(),
        $this->userCanViewProfiles->pass_raw,
      ],
    ]);
    $single_output = Json::decode($response
      ->getBody()
      ->__toString());
    $this
      ->assertEquals(200, $response
      ->getStatusCode());
    $this
      ->assertEquals('user--user', $single_output['data']['type']);
    $this
      ->assertEquals($this->user
      ->get('name')->value, $single_output['data']['attributes']['name']);
    $this
      ->assertTrue(empty($single_output['data']['attributes']['mail']));
    $this
      ->assertTrue(empty($single_output['data']['attributes']['pass']));

    // 18. Test filtering on the column of a link.
    $filter = [
      'linkUri' => [
        'condition' => [
          'path' => 'field_link.uri',
          'value' => 'https://',
          'operator' => 'STARTS_WITH',
        ],
      ],
    ];
    $single_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'filter' => $filter,
      ] + $default_sort,
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertGreaterThanOrEqual(1, count($single_output['data']));

    // 19. Test non-existing route without 'Accept' header.
    $this
      ->drupalGet('/jsonapi/node/article/broccoli');
    $this
      ->assertSession()
      ->statusCodeEquals(404);

    // Even without the 'Accept' header the 404 error is formatted as JSON:API.
    $this
      ->assertSession()
      ->responseHeaderEquals('Content-Type', 'application/vnd.api+json');

    // 20. Test non-existing route with 'Accept' header.
    $single_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article/broccoli', [], [
      'Accept' => 'application/vnd.api+json',
    ]));
    $this
      ->assertEquals(404, $single_output['errors'][0]['status']);
    $this
      ->assertSession()
      ->statusCodeEquals(404);

    // With the 'Accept' header we can know we want the 404 error formatted as
    // JSON:API.
    $this
      ->assertSession()
      ->responseHeaderContains('Content-Type', 'application/vnd.api+json');

    // 22. Test sort criteria on multiple fields: both ASC.
    $output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'page[limit]' => 6,
        'sort' => 'field_sort1,field_sort2',
      ],
    ]));
    $output_uuids = array_map(function ($result) {
      return $result['id'];
    }, $output['data']);
    $this
      ->assertCount(6, $output_uuids);
    $this
      ->assertSame([
      Node::load(5)
        ->uuid(),
      Node::load(4)
        ->uuid(),
      Node::load(3)
        ->uuid(),
      Node::load(2)
        ->uuid(),
      Node::load(1)
        ->uuid(),
      Node::load(10)
        ->uuid(),
    ], $output_uuids);

    // 23. Test sort criteria on multiple fields: first ASC, second DESC.
    $output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'page[limit]' => 6,
        'sort' => 'field_sort1,-field_sort2',
      ],
    ]));
    $output_uuids = array_map(function ($result) {
      return $result['id'];
    }, $output['data']);
    $this
      ->assertCount(6, $output_uuids);
    $this
      ->assertSame([
      Node::load(1)
        ->uuid(),
      Node::load(2)
        ->uuid(),
      Node::load(3)
        ->uuid(),
      Node::load(4)
        ->uuid(),
      Node::load(5)
        ->uuid(),
      Node::load(6)
        ->uuid(),
    ], $output_uuids);

    // 24. Test sort criteria on multiple fields: first DESC, second ASC.
    $output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'page[limit]' => 6,
        'sort' => '-field_sort1,field_sort2',
      ],
    ]));
    $output_uuids = array_map(function ($result) {
      return $result['id'];
    }, $output['data']);
    $this
      ->assertCount(5, $output_uuids);
    $this
      ->assertCount(2, $output['meta']['omitted']['links']);
    $this
      ->assertSame([
      Node::load(60)
        ->uuid(),
      Node::load(59)
        ->uuid(),
      Node::load(58)
        ->uuid(),
      Node::load(57)
        ->uuid(),
      Node::load(56)
        ->uuid(),
    ], $output_uuids);

    // 25. Test sort criteria on multiple fields: both DESC.
    $output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'page[limit]' => 6,
        'sort' => '-field_sort1,-field_sort2',
      ],
    ]));
    $output_uuids = array_map(function ($result) {
      return $result['id'];
    }, $output['data']);
    $this
      ->assertCount(5, $output_uuids);
    $this
      ->assertCount(2, $output['meta']['omitted']['links']);
    $this
      ->assertSame([
      Node::load(56)
        ->uuid(),
      Node::load(57)
        ->uuid(),
      Node::load(58)
        ->uuid(),
      Node::load(59)
        ->uuid(),
      Node::load(60)
        ->uuid(),
    ], $output_uuids);

    // 25. Test collection count.
    $this->container
      ->get('module_installer')
      ->install([
      'jsonapi_test_collection_count',
    ]);
    $collection_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertEquals(61, $collection_output['meta']['count']);
    $this->container
      ->get('module_installer')
      ->uninstall([
      'jsonapi_test_collection_count',
    ]);

    // Test documentation filtering examples.
    // 1. Only get published nodes.
    $filter = [
      'status-filter' => [
        'condition' => [
          'path' => 'status',
          'value' => 1,
        ],
      ],
    ];
    $collection_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'filter' => $filter,
      ] + $default_sort,
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertGreaterThanOrEqual(OffsetPage::SIZE_MAX, count($collection_output['data']));

    // 2. Nested Filters: Get nodes created by user admin.
    $filter = [
      'name-filter' => [
        'condition' => [
          'path' => 'uid.name',
          'value' => $this->user
            ->getAccountName(),
        ],
      ],
    ];
    $collection_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'filter' => $filter,
      ] + $default_sort,
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertGreaterThanOrEqual(OffsetPage::SIZE_MAX, count($collection_output['data']));

    // 3. Filtering with arrays: Get nodes created by users [admin, john].
    $filter = [
      'name-filter' => [
        'condition' => [
          'path' => 'uid.name',
          'operator' => 'IN',
          'value' => [
            $this->user
              ->getAccountName(),
            $this
              ->getRandomGenerator()
              ->name(),
          ],
        ],
      ],
    ];
    $collection_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'filter' => $filter,
      ] + $default_sort,
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertGreaterThanOrEqual(OffsetPage::SIZE_MAX, count($collection_output['data']));

    // 4. Grouping filters: Get nodes that are published and create by admin.
    $filter = [
      'and-group' => [
        'group' => [
          'conjunction' => 'AND',
        ],
      ],
      'name-filter' => [
        'condition' => [
          'path' => 'uid.name',
          'value' => $this->user
            ->getAccountName(),
          'memberOf' => 'and-group',
        ],
      ],
      'status-filter' => [
        'condition' => [
          'path' => 'status',
          'value' => 1,
          'memberOf' => 'and-group',
        ],
      ],
    ];
    $collection_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'filter' => $filter,
      ] + $default_sort,
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertGreaterThanOrEqual(OffsetPage::SIZE_MAX, count($collection_output['data']));

    // 5. Grouping grouped filters: Get nodes that are promoted or sticky and
    //    created by admin.
    $filter = [
      'and-group' => [
        'group' => [
          'conjunction' => 'AND',
        ],
      ],
      'or-group' => [
        'group' => [
          'conjunction' => 'OR',
          'memberOf' => 'and-group',
        ],
      ],
      'admin-filter' => [
        'condition' => [
          'path' => 'uid.name',
          'value' => $this->user
            ->getAccountName(),
          'memberOf' => 'and-group',
        ],
      ],
      'sticky-filter' => [
        'condition' => [
          'path' => 'sticky',
          'value' => 1,
          'memberOf' => 'or-group',
        ],
      ],
      'promote-filter' => [
        'condition' => [
          'path' => 'promote',
          'value' => 0,
          'memberOf' => 'or-group',
        ],
      ],
    ];
    $collection_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article', [
      'query' => [
        'filter' => $filter,
      ] + $default_sort,
    ]));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertCount(0, $collection_output['data']);
  }

  /**
   * Tests the GET method on articles referencing the same tag twice.
   */
  public function testReferencingTwiceRead() {
    $this
      ->createDefaultContent(1, 1, FALSE, FALSE, static::IS_NOT_MULTILINGUAL, TRUE);

    // 1. Load all articles (1st page).
    $collection_output = Json::decode($this
      ->drupalGet('/jsonapi/node/article'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertCount(1, $collection_output['data']);
    $this
      ->assertSession()
      ->responseHeaderEquals('Content-Type', 'application/vnd.api+json');
  }

  /**
   * Tests POST, PATCH and DELETE.
   */
  public function testWrite() {
    $this
      ->config('jsonapi.settings')
      ->set('read_only', FALSE)
      ->save(TRUE);
    $this
      ->createDefaultContent(0, 3, FALSE, FALSE, static::IS_NOT_MULTILINGUAL, FALSE);

    // 1. Successful post.
    $collection_url = Url::fromRoute('jsonapi.node--article.collection.post');
    $body = [
      'data' => [
        'type' => 'node--article',
        'attributes' => [
          'langcode' => 'en',
          'title' => 'My custom title',
          'default_langcode' => '1',
          'body' => [
            'value' => 'Custom value',
            'format' => 'plain_text',
            'summary' => 'Custom summary',
          ],
        ],
        'relationships' => [
          'field_tags' => [
            'data' => [
              [
                'type' => 'taxonomy_term--tags',
                'id' => $this->tags[0]
                  ->uuid(),
              ],
              [
                'type' => 'taxonomy_term--tags',
                'id' => $this->tags[1]
                  ->uuid(),
              ],
            ],
          ],
        ],
      ],
    ];
    $response = $this
      ->request('POST', $collection_url, [
      'body' => Json::encode($body),
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
      'headers' => [
        'Content-Type' => 'application/vnd.api+json',
      ],
    ]);
    $created_response = Json::decode($response
      ->getBody()
      ->__toString());
    $this
      ->assertEquals(201, $response
      ->getStatusCode());
    $this
      ->assertArrayNotHasKey('uuid', $created_response['data']['attributes']);
    $uuid = $created_response['data']['id'];
    $this
      ->assertCount(2, $created_response['data']['relationships']['field_tags']['data']);
    $this
      ->assertEquals($created_response['data']['links']['self']['href'], $response
      ->getHeader('Location')[0]);

    // 2. Authorization error.
    $response = $this
      ->request('POST', $collection_url, [
      'body' => Json::encode($body),
      'headers' => [
        'Content-Type' => 'application/vnd.api+json',
      ],
    ]);
    $created_response = Json::decode($response
      ->getBody()
      ->__toString());
    $this
      ->assertEquals(401, $response
      ->getStatusCode());
    $this
      ->assertNotEmpty($created_response['errors']);
    $this
      ->assertEquals('Unauthorized', $created_response['errors'][0]['title']);

    // 2.1 Authorization error with a user without create permissions.
    $response = $this
      ->request('POST', $collection_url, [
      'body' => Json::encode($body),
      'auth' => [
        $this->userCanViewProfiles
          ->getAccountName(),
        $this->userCanViewProfiles->pass_raw,
      ],
      'headers' => [
        'Content-Type' => 'application/vnd.api+json',
      ],
    ]);
    $created_response = Json::decode($response
      ->getBody()
      ->__toString());
    $this
      ->assertEquals(403, $response
      ->getStatusCode());
    $this
      ->assertNotEmpty($created_response['errors']);
    $this
      ->assertEquals('Forbidden', $created_response['errors'][0]['title']);

    // 3. Missing Content-Type error.
    $response = $this
      ->request('POST', $collection_url, [
      'body' => Json::encode($body),
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
      'headers' => [
        'Accept' => 'application/vnd.api+json',
      ],
    ]);
    $created_response = Json::decode($response
      ->getBody()
      ->__toString());
    $this
      ->assertEquals(415, $response
      ->getStatusCode());

    // 4. Article with a duplicate ID.
    $invalid_body = $body;
    $invalid_body['data']['id'] = Node::load(1)
      ->uuid();
    $response = $this
      ->request('POST', $collection_url, [
      'body' => Json::encode($invalid_body),
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
      'headers' => [
        'Accept' => 'application/vnd.api+json',
        'Content-Type' => 'application/vnd.api+json',
      ],
    ]);
    $created_response = Json::decode($response
      ->getBody()
      ->__toString());
    $this
      ->assertEquals(409, $response
      ->getStatusCode());
    $this
      ->assertNotEmpty($created_response['errors']);
    $this
      ->assertEquals('Conflict', $created_response['errors'][0]['title']);

    // 5. Article with wrong reference UUIDs for tags.
    $body_invalid_tags = $body;
    $body_invalid_tags['data']['relationships']['field_tags']['data'][0]['id'] = 'lorem';
    $body_invalid_tags['data']['relationships']['field_tags']['data'][1]['id'] = 'ipsum';
    $response = $this
      ->request('POST', $collection_url, [
      'body' => Json::encode($body_invalid_tags),
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
      'headers' => [
        'Content-Type' => 'application/vnd.api+json',
      ],
    ]);
    $created_response = Json::decode($response
      ->getBody()
      ->__toString());
    $this
      ->assertEquals(404, $response
      ->getStatusCode());

    // 6. Decoding error.
    $response = $this
      ->request('POST', $collection_url, [
      'body' => '{"bad json",,,}',
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
      'headers' => [
        'Content-Type' => 'application/vnd.api+json',
        'Accept' => 'application/vnd.api+json',
      ],
    ]);
    $created_response = Json::decode($response
      ->getBody()
      ->__toString());
    $this
      ->assertEquals(400, $response
      ->getStatusCode());
    $this
      ->assertNotEmpty($created_response['errors']);
    $this
      ->assertEquals('Bad Request', $created_response['errors'][0]['title']);

    // 6.1 Denormalizing error.
    $response = $this
      ->request('POST', $collection_url, [
      'body' => '{"data":{"type":"something"},"valid yet nonsensical json":[]}',
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
      'headers' => [
        'Content-Type' => 'application/vnd.api+json',
        'Accept' => 'application/vnd.api+json',
      ],
    ]);
    $created_response = Json::decode($response
      ->getBody()
      ->__toString());
    $this
      ->assertEquals(422, $response
      ->getStatusCode());
    $this
      ->assertNotEmpty($created_response['errors']);
    $this
      ->assertEquals('Unprocessable Entity', $created_response['errors'][0]['title']);

    // 6.2 Relationships are not included in "data".
    $malformed_body = $body;
    unset($malformed_body['data']['relationships']);
    $malformed_body['relationships'] = $body['data']['relationships'];
    $response = $this
      ->request('POST', $collection_url, [
      'body' => Json::encode($malformed_body),
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
      'headers' => [
        'Accept' => 'application/vnd.api+json',
        'Content-Type' => 'application/vnd.api+json',
      ],
    ]);
    $created_response = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame(400, $response
      ->getStatusCode());
    $this
      ->assertNotEmpty($created_response['errors']);
    $this
      ->assertSame("Bad Request", $created_response['errors'][0]['title']);
    $this
      ->assertSame("Found \"relationships\" within the document's top level. The \"relationships\" key must be within resource object.", $created_response['errors'][0]['detail']);

    // 6.2 "type" not included in "data".
    $missing_type = $body;
    unset($missing_type['data']['type']);
    $response = $this
      ->request('POST', $collection_url, [
      'body' => Json::encode($missing_type),
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
      'headers' => [
        'Accept' => 'application/vnd.api+json',
        'Content-Type' => 'application/vnd.api+json',
      ],
    ]);
    $created_response = Json::decode((string) $response
      ->getBody());
    $this
      ->assertSame(400, $response
      ->getStatusCode());
    $this
      ->assertNotEmpty($created_response['errors']);
    $this
      ->assertSame("Bad Request", $created_response['errors'][0]['title']);
    $this
      ->assertSame("Resource object must include a \"type\".", $created_response['errors'][0]['detail']);

    // 7. Successful PATCH.
    $body = [
      'data' => [
        'id' => $uuid,
        'type' => 'node--article',
        'attributes' => [
          'title' => 'My updated title',
        ],
      ],
    ];
    $individual_url = Url::fromRoute('jsonapi.node--article.individual', [
      'entity' => $uuid,
    ]);
    $response = $this
      ->request('PATCH', $individual_url, [
      'body' => Json::encode($body),
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
      'headers' => [
        'Content-Type' => 'application/vnd.api+json',
      ],
    ]);
    $updated_response = Json::decode($response
      ->getBody()
      ->__toString());
    $this
      ->assertEquals(200, $response
      ->getStatusCode());
    $this
      ->assertEquals('My updated title', $updated_response['data']['attributes']['title']);

    // 7.1 Unsuccessful PATCH due to access restrictions.
    $body = [
      'data' => [
        'id' => $uuid,
        'type' => 'node--article',
        'attributes' => [
          'title' => 'My updated title',
        ],
      ],
    ];
    $individual_url = Url::fromRoute('jsonapi.node--article.individual', [
      'entity' => $uuid,
    ]);
    $response = $this
      ->request('PATCH', $individual_url, [
      'body' => Json::encode($body),
      'auth' => [
        $this->userCanViewProfiles
          ->getAccountName(),
        $this->userCanViewProfiles->pass_raw,
      ],
      'headers' => [
        'Content-Type' => 'application/vnd.api+json',
      ],
    ]);
    $this
      ->assertEquals(403, $response
      ->getStatusCode());

    // 8. Field access forbidden check.
    $body = [
      'data' => [
        'id' => $uuid,
        'type' => 'node--article',
        'attributes' => [
          'title' => 'My updated title',
          'status' => 0,
        ],
      ],
    ];
    $response = $this
      ->request('PATCH', $individual_url, [
      'body' => Json::encode($body),
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
      'headers' => [
        'Content-Type' => 'application/vnd.api+json',
      ],
    ]);
    $updated_response = Json::decode($response
      ->getBody()
      ->__toString());
    $this
      ->assertEquals(403, $response
      ->getStatusCode());
    $this
      ->assertEquals("The current user is not allowed to PATCH the selected field (status). The 'administer nodes' permission is required.", $updated_response['errors'][0]['detail']);
    $node = \Drupal::service('entity.repository')
      ->loadEntityByUuid('node', $uuid);
    $this
      ->assertEquals(1, $node
      ->get('status')->value, 'Node status was not changed.');

    // 9. Successful POST to related endpoint.
    $body = [
      'data' => [
        [
          'id' => $this->tags[2]
            ->uuid(),
          'type' => 'taxonomy_term--tags',
        ],
      ],
    ];
    $relationship_url = Url::fromRoute('jsonapi.node--article.field_tags.relationship.post', [
      'entity' => $uuid,
    ]);
    $response = $this
      ->request('POST', $relationship_url, [
      'body' => Json::encode($body),
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
      'headers' => [
        'Content-Type' => 'application/vnd.api+json',
      ],
    ]);
    $updated_response = Json::decode($response
      ->getBody()
      ->__toString());
    $this
      ->assertEquals(200, $response
      ->getStatusCode());
    $this
      ->assertCount(3, $updated_response['data']);
    $this
      ->assertEquals('taxonomy_term--tags', $updated_response['data'][2]['type']);
    $this
      ->assertEquals($this->tags[2]
      ->uuid(), $updated_response['data'][2]['id']);

    // 10. Successful PATCH to related endpoint.
    $body = [
      'data' => [
        [
          'id' => $this->tags[1]
            ->uuid(),
          'type' => 'taxonomy_term--tags',
        ],
      ],
    ];
    $response = $this
      ->request('PATCH', $relationship_url, [
      'body' => Json::encode($body),
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
      'headers' => [
        'Content-Type' => 'application/vnd.api+json',
      ],
    ]);
    $this
      ->assertEquals(204, $response
      ->getStatusCode());
    $this
      ->assertEmpty($response
      ->getBody()
      ->__toString());

    // 11. Successful DELETE to related endpoint.
    $response = $this
      ->request('DELETE', $relationship_url, [
      // Send a request with no body.
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
      'headers' => [
        'Content-Type' => 'application/vnd.api+json',
        'Accept' => 'application/vnd.api+json',
      ],
    ]);
    $updated_response = Json::decode($response
      ->getBody()
      ->__toString());
    $this
      ->assertEquals('You need to provide a body for DELETE operations on a relationship (field_tags).', $updated_response['errors'][0]['detail']);
    $this
      ->assertEquals(400, $response
      ->getStatusCode());
    $response = $this
      ->request('DELETE', $relationship_url, [
      // Send a request with no authentication.
      'body' => Json::encode($body),
      'headers' => [
        'Content-Type' => 'application/vnd.api+json',
      ],
    ]);
    $this
      ->assertEquals(401, $response
      ->getStatusCode());
    $response = $this
      ->request('DELETE', $relationship_url, [
      // Remove the existing relationship item.
      'body' => Json::encode($body),
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
      'headers' => [
        'Content-Type' => 'application/vnd.api+json',
      ],
    ]);
    $this
      ->assertEquals(204, $response
      ->getStatusCode());
    $this
      ->assertEmpty($response
      ->getBody()
      ->__toString());

    // 12. PATCH with invalid title and body format.
    $body = [
      'data' => [
        'id' => $uuid,
        'type' => 'node--article',
        'attributes' => [
          'title' => '',
          'body' => [
            'value' => 'Custom value',
            'format' => 'invalid_format',
            'summary' => 'Custom summary',
          ],
        ],
      ],
    ];
    $response = $this
      ->request('PATCH', $individual_url, [
      'body' => Json::encode($body),
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
      'headers' => [
        'Content-Type' => 'application/vnd.api+json',
        'Accept' => 'application/vnd.api+json',
      ],
    ]);
    $updated_response = Json::decode($response
      ->getBody()
      ->__toString());
    $this
      ->assertEquals(422, $response
      ->getStatusCode());
    $this
      ->assertCount(2, $updated_response['errors']);
    for ($i = 0; $i < 2; $i++) {
      $this
        ->assertEquals("Unprocessable Entity", $updated_response['errors'][$i]['title']);
      $this
        ->assertEquals(422, $updated_response['errors'][$i]['status']);
    }
    $this
      ->assertEquals("title: This value should not be null.", $updated_response['errors'][0]['detail']);
    $this
      ->assertEquals("body.0.format: The value you selected is not a valid choice.", $updated_response['errors'][1]['detail']);
    $this
      ->assertEquals("/data/attributes/title", $updated_response['errors'][0]['source']['pointer']);
    $this
      ->assertEquals("/data/attributes/body/format", $updated_response['errors'][1]['source']['pointer']);

    // 13. PATCH with field that doesn't exist on Entity.
    $body = [
      'data' => [
        'id' => $uuid,
        'type' => 'node--article',
        'attributes' => [
          'field_that_does_not_exist' => 'foobar',
        ],
      ],
    ];
    $response = $this
      ->request('PATCH', $individual_url, [
      'body' => Json::encode($body),
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
      'headers' => [
        'Content-Type' => 'application/vnd.api+json',
        'Accept' => 'application/vnd.api+json',
      ],
    ]);
    $updated_response = Json::decode($response
      ->getBody()
      ->__toString());
    $this
      ->assertEquals(422, $response
      ->getStatusCode());
    $this
      ->assertEquals("The attribute field_that_does_not_exist does not exist on the node--article resource type.", $updated_response['errors']['0']['detail']);

    // 14. Successful DELETE.
    $response = $this
      ->request('DELETE', $individual_url, [
      'auth' => [
        $this->user
          ->getAccountName(),
        $this->user->pass_raw,
      ],
    ]);
    $this
      ->assertEquals(204, $response
      ->getStatusCode());
    $response = $this
      ->request('GET', $individual_url, []);
    $this
      ->assertEquals(404, $response
      ->getStatusCode());
  }

}

Members

Namesort descending 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.
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.
JsonApiFunctionalTest::$defaultTheme protected property The theme to install as the default for testing. Overrides JsonApiFunctionalTestBase::$defaultTheme
JsonApiFunctionalTest::$modules protected static property Modules to enable. Overrides JsonApiFunctionalTestBase::$modules
JsonApiFunctionalTest::testRead public function Tests the GET method.
JsonApiFunctionalTest::testReferencingTwiceRead public function Tests the GET method on articles referencing the same tag twice.
JsonApiFunctionalTest::testWrite public function Tests POST, PATCH and DELETE.
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
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.