You are here

Home » API reference » JSON:API Hypermedia 8 » LinkProviderTest.php

final class LinkProviderTest in JSON:API Hypermedia 8

Class LinkProviderTest.

@group jsonapi_hypermedia

@internal

Hierarchy

Expanded class hierarchy of LinkProviderTest

File

tests/src/Functional/LinkProviderTest.php, line 25

Namespace

Drupal\Tests\jsonapi_hypermedia\Functional
View source 
final class LinkProviderTest extends BrowserTestBase {
  use JsonApiRequestTestTrait;
  use UserCreationTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'serialization',
    'jsonapi',
    'jsonapi_hypermedia',
    'jsonapi_hypermedia_test_link_providers',
    'node',
    'user',
    'system',
  ];

  /**
   * A map of document types to internal URIs.
   *
   * @var array
   */
  protected $uris;

  /**
   * The link provider manager.
   *
   * @var \Drupal\jsonapi_hypermedia\Plugin\LinkProviderManagerInterface
   */
  protected $linkManager;

  /**
   * The state service.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    NodeType::create([
      'type' => 'article',
      'name' => 'Article',
    ])
      ->save();
    $node = Node::create([
      'type' => 'article',
      'title' => 'Test Node',
    ]);
    $node
      ->save();
    $this->uris = [
      'entrypoint' => 'base:/jsonapi',
      'error' => 'base:/jsonapi/node/article/missing',
      'individual' => "base:/jsonapi/node/article/{$node->uuid()}",
      'collection' => 'base:/jsonapi/node/article',
      'relationship' => "base:/jsonapi/node/article/{$node->uuid()}/relationships/uid",
    ];
    $this->linkManager = $this->container
      ->get('jsonapi_hypermedia_provider.manager');
    $this->state = $this->container
      ->get('state');
    $this->account = $this
      ->createUser();
    $this->container
      ->set('current_user', $this->account);
  }

  /**
   * Tests that link provider plugins properly affect the JSON:API output.
   *
   * @dataProvider pluginDefinitionTemplates
   */
  public function testLinkProviders($plugin_template) {
    $link_location = $plugin_template['location'];
    $expected_on_document_types = $plugin_template['presence'] ?? TRUE;
    $this->state
      ->set('jsonapi_hypermedia_test_link_providers.template', $plugin_template);
    $this
      ->rebuildAll();
    $test_definitions = array_filter($this->linkManager
      ->getDefinitions(), function ($definition) {
      return $definition['provider'] === 'jsonapi_hypermedia_test_link_providers';
    });
    foreach ($test_definitions as $plugin_id => $test_definition) {
      $link_key = $test_definition['link_key'] ?? $test_definition['link_relation_type'];
      if (!empty($test_definition['_test_restrict_access'])) {
        $link = $this
          ->getLink($link_location, $link_key, []);
        $this
          ->assertNull($link);
        $this
          ->grantPermissions(Role::load(AccountInterface::ANONYMOUS_ROLE), [
          "view {$test_definition['link_key']} link",
        ]);
        $link = $this
          ->getLink($link_location, $link_key, $expected_on_document_types);
      }
      else {
        $link = $this
          ->getLink($link_location, $link_key, $expected_on_document_types);
      }
      if (!empty($expected_on_document_types)) {
        $this
          ->assertNotNull($link);
      }
      else {
        $this
          ->assertNull($link);
        continue;
      }
      if (!empty($test_definition['_test_target_attributes'])) {
        $actual = NestedArray::getValue($link, [
          'meta',
          'linkParams',
        ]);
        $this
          ->assertNotNull($actual);
        $this
          ->assertSame($test_definition['_test_target_attributes'], array_diff_key($actual, array_flip([
          'rel',
          'randomAttr',
        ])));
      }
      $rel_exists = NULL;
      $actual_rel = NestedArray::getValue($link, [
        'meta',
        'linkParams',
        'rel',
      ], $rel_exists);
      if ($test_definition['link_relation_type'] === 'test') {
        $this
          ->assertTrue($rel_exists);
        $this
          ->assertSame('https://drupal.org/project/jsonapi_hypermedia/link-relations/#test', $actual_rel[0]);
      }
      elseif (empty($test_definition['link_key'])) {
        $this
          ->assertFalse($rel_exists);
      }
      else {
        $this
          ->assertTrue($rel_exists);
        $this
          ->assertSame('related', $actual_rel[0]);
      }
      $cache_hit_link = $this
        ->getLink($link_location, $link_key, $expected_on_document_types);
      $this
        ->assertSame($link, $cache_hit_link);
      Cache::invalidateTags([
        'test_jsonapi_hypermedia_cache_tag',
      ]);
      $cache_miss_link = $this
        ->getLink($link_location, $link_key, $expected_on_document_types);
      $this
        ->assertNotSame($cache_hit_link, $cache_miss_link);
    }
  }

  /**
   * Requests a document from which to assert & extract an expected link.
   *
   * @param string $link_location
   *   The path to the links object in the document given as a dot (.) separated
   *   list of JSON property names.
   * @param string $link_key
   *   The key of the expected link.
   * @param string[]|true $expected_on_document_types
   *   The types of documents on which to assert and extract the link. TRUE if
   *   the link is expected on all document types.
   *
   * @return array|null
   *   The normalized link or NULL if the link was not found.
   */
  protected function getLink($link_location, $link_key, $expected_on_document_types) {
    assert($expected_on_document_types === TRUE || is_array($expected_on_document_types));
    $path = array_map(function ($key) {
      return is_numeric($key) ? (int) $key : $key;
    }, array_merge(explode('.', $link_location), [
      $link_key,
    ]));
    $link = NULL;
    foreach ($this->uris as $document_type => $uri) {
      $is_error_type = $document_type === 'error';
      $document = $this
        ->getJsonapiDocument($uri, $is_error_type ? 404 : 200);
      $exists = NULL;
      $current_link = NestedArray::getValue($document, $path, $exists);
      $expected_everywhere = $expected_on_document_types === TRUE;
      $expected_on_current_type = !$expected_everywhere && in_array($document_type, $expected_on_document_types);
      $expected_on_success = !$expected_everywhere && in_array('success', $expected_on_document_types);
      if ($expected_everywhere || $expected_on_current_type || $expected_on_success && !$is_error_type) {
        $this
          ->assertTrue($exists, "Expected link under `{$link_location}` on the {$document_type} document at {$uri}");
      }
      else {
        $this
          ->assertFalse($exists, "Unexpected link under `{$link_location}` on the {$document_type} document at {$uri}");
      }
      $link = $current_link ?? $link;
    }
    return $link;
  }

  /**
   * Gets an array of templates from which to configure test plugins.
   *
   * @return array
   *   The plugin definition templates.
   */
  public function pluginDefinitionTemplates() {
    return [
      'all top-level links' => [
        [
          'link_context' => [
            'top_level_object' => TRUE,
          ],
          'location' => 'links',
        ],
      ],
      'top-level links; only on the entrypoint' => [
        [
          'link_context' => [
            'top_level_object' => 'entrypoint',
          ],
          'location' => 'links',
          'presence' => [
            'entrypoint',
          ],
        ],
      ],
      'top-level links; only on successful documents' => [
        [
          'link_context' => [
            'top_level_object' => 'success',
          ],
          'location' => 'links',
          'presence' => [
            'entrypoint',
            'collection',
            'individual',
            'relationship',
            'related',
          ],
        ],
      ],
      'top-level links; only on error documents' => [
        [
          'link_context' => [
            'top_level_object' => 'error',
          ],
          'location' => 'links',
          'presence' => [
            'error',
          ],
        ],
      ],
      'top-level links; only on individual documents' => [
        [
          'link_context' => [
            'top_level_object' => 'individual',
          ],
          'location' => 'links',
          'presence' => [
            'individual',
          ],
        ],
      ],
      'top-level links; only on collection documents' => [
        [
          'link_context' => [
            'top_level_object' => 'collection',
          ],
          'location' => 'links',
          'presence' => [
            'collection',
          ],
        ],
      ],
      'top-level links; only on relationship documents' => [
        [
          'link_context' => [
            'top_level_object' => 'relationship',
          ],
          'location' => 'links',
          'presence' => [
            'relationship',
          ],
        ],
      ],
      'resource object links on individual documents' => [
        [
          'link_context' => [
            'resource_object' => TRUE,
          ],
          'location' => 'data.links',
          'presence' => [
            'individual',
          ],
        ],
      ],
      'resource object links on collection documents' => [
        [
          'link_context' => [
            'resource_object' => TRUE,
          ],
          'location' => 'data.0.links',
          'presence' => [
            'collection',
          ],
        ],
      ],
      'only article resource objects on individual documents' => [
        [
          'link_context' => [
            'resource_object' => 'node--article',
          ],
          'location' => 'data.links',
          'presence' => [
            'individual',
          ],
        ],
      ],
      'only article resource objects on collection documents' => [
        [
          'link_context' => [
            'resource_object' => 'node--article',
          ],
          'location' => 'data.0.links',
          'presence' => [
            'collection',
          ],
        ],
      ],
      'relationship objects on individual documents' => [
        [
          'link_context' => [
            'relationship_object' => TRUE,
          ],
          'location' => 'data.relationships.uid.links',
          'presence' => [
            'individual',
          ],
        ],
      ],
      'relationship objects on collection documents' => [
        [
          'link_context' => [
            'relationship_object' => TRUE,
          ],
          'location' => 'data.0.relationships.uid.links',
          'presence' => [
            'collection',
          ],
        ],
      ],
      'relationship objects on relationship documents' => [
        [
          'link_context' => [
            'relationship_object' => TRUE,
          ],
          'location' => 'links',
          'presence' => [
            'relationship',
          ],
        ],
      ],
      'article author relationship objects on individual documents' => [
        [
          'link_context' => [
            'relationship_object' => [
              'node--article',
              'uid',
            ],
          ],
          'location' => 'data.relationships.uid.links',
          'presence' => [
            'individual',
          ],
        ],
      ],
      'article bundle relationship objects on individual documents' => [
        [
          'link_context' => [
            'relationship_object' => [
              'node--article',
              'uid',
            ],
          ],
          'location' => 'data.relationships.node_type.links',
          'presence' => [],
        ],
      ],
      'article author relationship objects on collection documents' => [
        [
          'link_context' => [
            'relationship_object' => [
              'node--article',
              'uid',
            ],
          ],
          'location' => 'data.0.relationships.uid.links',
          'presence' => [
            'collection',
          ],
        ],
      ],
      'article bundle relationship objects on collection documents' => [
        [
          'link_context' => [
            'relationship_object' => [
              'node--article',
              'uid',
            ],
          ],
          'location' => 'data.0.relationships.node_type.links',
          'presence' => [],
        ],
      ],
      'article author relationship objects on relationship documents' => [
        [
          'link_context' => [
            'relationship_object' => [
              'node--article',
              'uid',
            ],
          ],
          'location' => 'links',
          'presence' => [
            'relationship',
          ],
        ],
      ],
    ];
  }

  /**
   * Performs a JSON:API request and returns its deserialized document response.
   *
   * @param string $uri
   *   The URI of the JSON:API document to be fetched.
   * @param int $expected_status
   *   The expected status of the response to be fetched.
   *
   * @return array
   *   The fetched and deserialized JSON:API document.
   */
  protected function getJsonapiDocument($uri, $expected_status = 200) {
    $headers = [
      'accept' => 'application/vnd.api+json',
    ];
    $options = [
      RequestOptions::HEADERS => $headers,
    ];
    $url = Url::fromUri($uri);
    $response = $this
      ->request('GET', $url, $options);
    $this
      ->assertSame($expected_status, $response
      ->getStatusCode(), "URL: {$url->setAbsolute()->toString()}");
    $body = (string) $response
      ->getBody();
    $document = Json::decode($body);
    $this
      ->assertNotNull($document, "Response Body: {$body}");
    return $document;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose 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::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::$defaultTheme protected property The theme to install as the default for testing. 1,597
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
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::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
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
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::$configDirectories Deprecated protected property The config directories used in this test.
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. 2
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. 23
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.
JsonApiRequestTestTrait::decorateWithXdebugCookie protected function Adds the Xdebug cookie to the request options.
JsonApiRequestTestTrait::request protected function Performs a HTTP request. Wraps the Guzzle HTTP client.
LinkProviderTest::$linkManager protected property The link provider manager.
LinkProviderTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
LinkProviderTest::$state protected property The state service.
LinkProviderTest::$uris protected property A map of document types to internal URIs.
LinkProviderTest::getJsonapiDocument protected function Performs a JSON:API request and returns its deserialized document response.
LinkProviderTest::getLink protected function Requests a document from which to assert & extract an expected link.
LinkProviderTest::pluginDefinitionTemplates public function Gets an array of templates from which to configure test plugins.
LinkProviderTest::setUp protected function Overrides BrowserTestBase::setUp
LinkProviderTest::testLinkProviders public function Tests that link provider plugins properly affect the JSON:API output.
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
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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. 3
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. 2
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. 2
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 a 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::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm 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::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.
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.
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.