class JsonApiFunctionalTestBase

Same name in other branches
  1. 9 core/modules/jsonapi/tests/src/Functional/JsonApiFunctionalTestBase.php \Drupal\Tests\jsonapi\Functional\JsonApiFunctionalTestBase
  2. 8.9.x core/modules/jsonapi/tests/src/Functional/JsonApiFunctionalTestBase.php \Drupal\Tests\jsonapi\Functional\JsonApiFunctionalTestBase
  3. 10 core/modules/jsonapi/tests/src/Functional/JsonApiFunctionalTestBase.php \Drupal\Tests\jsonapi\Functional\JsonApiFunctionalTestBase

Provides helper methods for the JSON:API module's functional tests.

@internal

Hierarchy

Expanded class hierarchy of JsonApiFunctionalTestBase

File

core/modules/jsonapi/tests/src/Functional/JsonApiFunctionalTestBase.php, line 29

Namespace

Drupal\Tests\jsonapi\Functional
View source
abstract class JsonApiFunctionalTestBase extends BrowserTestBase {
    use EntityReferenceFieldCreationTrait;
    use GetDocumentFromResponseTrait;
    use ImageFieldCreationTrait;
    const IS_MULTILINGUAL = TRUE;
    const IS_NOT_MULTILINGUAL = FALSE;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'jsonapi',
        'serialization',
        'node',
        'image',
        'taxonomy',
        'link',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Test user.
     *
     * @var \Drupal\user\Entity\User
     */
    protected $user;
    
    /**
     * Test user with access to view profiles.
     *
     * @var \Drupal\user\Entity\User
     */
    protected $userCanViewProfiles;
    
    /**
     * Test nodes.
     *
     * @var \Drupal\node\Entity\Node[]
     */
    protected $nodes = [];
    
    /**
     * Test taxonomy terms.
     *
     * @var \Drupal\taxonomy\Entity\Term[]
     */
    protected $tags = [];
    
    /**
     * Test files.
     *
     * @var \Drupal\file\Entity\File[]
     */
    protected $files = [];
    
    /**
     * The HTTP client.
     *
     * @var \GuzzleHttp\ClientInterface
     */
    protected $httpClient;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Set up a HTTP client that accepts relative URLs.
        $this->httpClient = $this->container
            ->get('http_client_factory')
            ->fromOptions([
            'base_uri' => $this->baseUrl,
        ]);
        // Create Basic page and Article node types.
        if ($this->profile != 'standard') {
            $this->drupalCreateContentType([
                'type' => 'article',
                'name' => 'Article',
            ]);
            // Setup vocabulary.
            Vocabulary::create([
                'vid' => 'tags',
                'name' => 'Tags',
            ])->save();
            // Add tags and field_image to the article.
            $this->createEntityReferenceField('node', 'article', 'field_tags', 'Tags', 'taxonomy_term', 'default', [
                'target_bundles' => [
                    'tags' => 'tags',
                ],
                'auto_create' => TRUE,
            ], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
            $this->createImageField('field_image', 'node', 'article');
            $this->createImageField('field_no_hero', 'node', 'article');
        }
        FieldStorageConfig::create([
            'field_name' => 'field_link',
            'entity_type' => 'node',
            'type' => 'link',
            'settings' => [],
            'cardinality' => 1,
        ])->save();
        $field_config = FieldConfig::create([
            'field_name' => 'field_link',
            'label' => 'Link',
            'entity_type' => 'node',
            'bundle' => 'article',
            'required' => FALSE,
            'settings' => [],
            'description' => '',
        ]);
        $field_config->save();
        // Field for testing sorting.
        FieldStorageConfig::create([
            'field_name' => 'field_sort1',
            'entity_type' => 'node',
            'type' => 'integer',
        ])->save();
        FieldConfig::create([
            'field_name' => 'field_sort1',
            'entity_type' => 'node',
            'bundle' => 'article',
        ])->save();
        // Another field for testing sorting.
        FieldStorageConfig::create([
            'field_name' => 'field_sort2',
            'entity_type' => 'node',
            'type' => 'integer',
        ])->save();
        FieldConfig::create([
            'field_name' => 'field_sort2',
            'entity_type' => 'node',
            'bundle' => 'article',
        ])->save();
        $this->user = $this->drupalCreateUser([
            'create article content',
            'edit any article content',
            'delete any article content',
        ]);
        // Create a user that can.
        $this->userCanViewProfiles = $this->drupalCreateUser([
            'access user profiles',
        ]);
        $this->grantPermissions(Role::load(RoleInterface::ANONYMOUS_ID), [
            'access user profiles',
            'administer taxonomy',
        ]);
        \Drupal::service('router.builder')->rebuild();
    }
    
    /**
     * Performs a HTTP request. Wraps the Guzzle HTTP client.
     *
     * Why wrap the Guzzle HTTP client? Because any error response is returned via
     * an exception, which would make the tests unnecessarily complex to read.
     *
     * @param string $method
     *   HTTP method.
     * @param \Drupal\Core\Url $url
     *   URL to request.
     * @param array $request_options
     *   Request options to apply.
     *
     * @return \Psr\Http\Message\ResponseInterface
     *   The request response.
     *
     * @throws \Psr\Http\Client\ClientExceptionInterface
     *
     * @see \GuzzleHttp\ClientInterface::request
     */
    protected function request($method, Url $url, array $request_options) : ResponseInterface {
        try {
            $response = $this->httpClient
                ->request($method, $url->toString(), $request_options);
        } catch (ClientException $e) {
            $response = $e->getResponse();
        } catch (ServerException $e) {
            $response = $e->getResponse();
        }
        return $response;
    }
    
    /**
     * Creates default content to test the API.
     *
     * @param int $num_articles
     *   Number of articles to create.
     * @param int $num_tags
     *   Number of tags to create.
     * @param bool $article_has_image
     *   Set to TRUE if you want to add an image to the generated articles.
     * @param bool $article_has_link
     *   Set to TRUE if you want to add a link to the generated articles.
     * @param bool $is_multilingual
     *   (optional) Set to TRUE if you want to enable multilingual content.
     * @param bool $referencing_twice
     *   (optional) Set to TRUE if you want articles to reference the same tag
     *   twice.
     */
    protected function createDefaultContent($num_articles, $num_tags, $article_has_image, $article_has_link, $is_multilingual, $referencing_twice = FALSE) {
        $random = $this->getRandomGenerator();
        for ($created_tags = 0; $created_tags < $num_tags; $created_tags++) {
            $term = Term::create([
                'vid' => 'tags',
                'name' => $random->name(),
            ]);
            if ($is_multilingual) {
                $term->addTranslation('ca', [
                    'name' => $term->getName() . ' (ca)',
                ]);
            }
            $term->save();
            $this->tags[] = $term;
        }
        for ($created_nodes = 0; $created_nodes < $num_articles; $created_nodes++) {
            $values = [
                'uid' => [
                    'target_id' => $this->user
                        ->id(),
                ],
                'type' => 'article',
            ];
            if ($referencing_twice) {
                $values['field_tags'] = [
                    [
                        'target_id' => 1,
                    ],
                    [
                        'target_id' => 1,
                    ],
                ];
            }
            else {
                // Get N random tags.
                $selected_tags = mt_rand(1, $num_tags);
                $tags = [];
                while (count($tags) < $selected_tags) {
                    $tags[] = mt_rand(1, $num_tags);
                    $tags = array_unique($tags);
                }
                $values['field_tags'] = array_map(function ($tag) {
                    return [
                        'target_id' => $tag,
                    ];
                }, $tags);
            }
            if ($article_has_image) {
                $file = File::create([
                    'uri' => 'public://' . $random->name() . '.png',
                ]);
                $file->setPermanent();
                $file->save();
                $this->files[] = $file;
                $values['field_image'] = [
                    'target_id' => $file->id(),
                    'alt' => 'alt text',
                ];
            }
            if ($article_has_link) {
                $values['field_link'] = [
                    'title' => $this->getRandomGenerator()
                        ->name(),
                    'uri' => sprintf('%s://%s.%s', 'http' . (mt_rand(0, 2) > 1 ? '' : 's'), $this->getRandomGenerator()
                        ->name(), 'org'),
                ];
            }
            // Create values for the sort fields, to allow for testing complex
            // sorting:
            // - field_sort1 increments every 5 articles, starting at zero
            // - field_sort2 decreases every article, ending at zero.
            $values['field_sort1'] = [
                'value' => floor($created_nodes / 5),
            ];
            $values['field_sort2'] = [
                'value' => $num_articles - $created_nodes,
            ];
            $node = $this->createNode($values);
            if ($is_multilingual === static::IS_MULTILINGUAL) {
                $values['title'] = $node->getTitle() . ' (ca)';
                $values['field_image']['alt'] = 'alt text (ca)';
                $node->addTranslation('ca', $values);
            }
            $node->save();
            $this->nodes[] = $node;
        }
        if ($article_has_link) {
            // Make sure that there is at least 1 https link for ::testRead() #19.
            $this->nodes[0]->field_link = [
                'title' => 'Drupal',
                'uri' => 'https://example.com',
            ];
            $this->nodes[0]
                ->save();
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 42
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
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
EntityReferenceFieldCreationTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 3
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 29
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
GetDocumentFromResponseTrait::getDocumentFromResponse protected function Retrieve document from response, with basic validation.
ImageFieldCreationTrait::createImageField protected function Create a new image field.
JsonApiFunctionalTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme 5
JsonApiFunctionalTestBase::$files protected property Test files.
JsonApiFunctionalTestBase::$httpClient protected property The HTTP client.
JsonApiFunctionalTestBase::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules 6
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 2
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.