class RequestTest in OpenAPI 8
Tests requests OpenAPI routes.
@group OpenAPI
Hierarchy
- class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\openapi\Functional\RequestTest
Expanded class hierarchy of RequestTest
File
- tests/
src/ Functional/ RequestTest.php, line 18
Namespace
Drupal\Tests\openapi\FunctionalView source
class RequestTest extends BrowserTestBase {
/**
* Set to TRUE to run this test to generate expectation files.
*
* The test will be marked as a fail when generating test files.
*/
const GENERATE_EXPECTATION_FILES = FALSE;
/**
* List of required array keys for response schema.
*/
const EXPECTED_STRUCTURE = [
'swagger' => 'swagger',
'info' => [
'description' => 'description',
'version' => 'version',
'title' => 'title',
],
'paths' => 'paths',
];
const ENTITY_TEST_BUNDLES = [
"taxonomy_term" => [
"camelids",
"taxonomy_term_test",
],
"openapi_test_entity" => [
"camelids",
"openapi_test_entity_test",
],
"openapi_test_entity_type" => [],
"user" => [],
];
/**
* {@inheritdoc}
*/
public static $modules = [
'user',
'field',
'filter',
'text',
'taxonomy',
'serialization',
'hal',
'schemata',
'schemata_json_schema',
'openapi',
'rest',
'openapi_test',
];
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
/*
* @TODO: The below configuration/setup should be shipped as part of the
* test resources sub module.
*/
foreach (static::ENTITY_TEST_BUNDLES['taxonomy_term'] as $bundle) {
if (!Vocabulary::load($bundle)) {
// Create a new vocabulary.
$vocabulary = Vocabulary::create([
'name' => $bundle,
'vid' => $bundle,
]);
$vocabulary
->save();
}
}
foreach (static::ENTITY_TEST_BUNDLES['openapi_test_entity'] as $bundle) {
if (!OpenApiTestEntityType::load($bundle)) {
// Create a new bundle.
OpenApiTestEntityType::create([
'label' => $bundle,
'id' => $bundle,
])
->save();
}
}
foreach (array_filter(static::ENTITY_TEST_BUNDLES) as $entity_type => $bundles) {
// Add single value and multi value fields.
FieldStorageConfig::create([
'entity_type' => $entity_type,
'field_name' => 'field_test_' . $entity_type,
'type' => 'text',
])
->setCardinality(1)
->save();
foreach ($bundles as $bundle) {
// Add field to each bundle.
FieldConfig::create([
'entity_type' => $entity_type,
'field_name' => 'field_test_' . $entity_type,
'bundle' => $bundle,
])
->setLabel('Test field')
->setTranslatable(FALSE)
->save();
}
}
$this
->drupalLogin($this
->drupalCreateUser([
'access openapi api docs',
'access content',
]));
}
/**
* Tests OpenAPI requests.
*
* @dataProvider providerRequestTypes
*/
public function testRequests($api_module, $options = []) {
if ($api_module == 'rest') {
// Enable all the entity types each request to make sure $options is
// respected for all parts of the spec.
$enable_entity_types = [
'openapi_test_entity' => [
'GET',
'POST',
'PATCH',
'DELETE',
],
'openapi_test_entity_type' => [
'GET',
],
'user' => [
'GET',
],
'taxonomy_term' => [
'GET',
'POST',
'PATCH',
'DELETE',
],
'taxonomy_vocabulary' => [
'GET',
],
];
foreach ($enable_entity_types as $entity_type_id => $methods) {
foreach ($methods as $method) {
$this
->enableRestService("entity:{$entity_type_id}", $method, 'json');
if ($entity_type_id === 'openapi_test_entity') {
$this
->enableRestService("entity:{$entity_type_id}", $method, 'hal_json');
}
}
}
$this->container
->get('router.builder')
->rebuild();
}
if ($api_module == 'jsonapi') {
// @todo Add JSON API to $modules
// Currently this will not work because the new bundles are not picked
// up in \Drupal\jsonapi\Routing\Routes::routes().
$this->container
->get('module_installer')
->install([
'jsonapi',
]);
}
$this
->requestOpenApiJson($api_module, $options);
}
/**
* Assert that test expectation generation is disabled.
*/
public function testNotGenerating() {
$this
->assertFalse(static::GENERATE_EXPECTATION_FILES, 'Expectation files generated. Change \\Drupal\\Tests\\openapi\\Functional\\RequestTest::GENERATE_EXPECTATION_FILES to FALSE to run tests.');
}
/**
* Dataprovider for testRequests.
*/
public function providerRequestTypes() {
$data = [];
foreach ([
'rest',
'jsonapi',
] as $api_module) {
foreach (static::ENTITY_TEST_BUNDLES as $entity_type => $bundles) {
foreach ($bundles as $bundle) {
$data[$api_module . ':' . $entity_type . '_' . $bundle] = [
$api_module,
[
'entity_type_id' => $entity_type,
'bundle_name' => $bundle,
],
];
}
// Test all bundles for entity type.
$data[$api_module . ':' . $entity_type] = [
$api_module,
[
'entity_type_id' => $entity_type,
],
];
}
// Test all entity types and bundle for module.
$data[$api_module] = [
$api_module,
];
}
return $data;
}
/**
* Makes OpenAPI request and checks the response.
*
* @param string $api_module
* The API module being tested. Either 'rest' or 'jsonapi'.
* @param array $options
* The query options for generating the OpenAPI output.
*/
protected function requestOpenApiJson($api_module, array $options = []) {
$get_options = [
'query' => [
'_format' => 'json',
'options' => $options,
],
];
$response = $this
->drupalGet("openapi/{$api_module}", $get_options);
$decoded_response = json_decode($response, TRUE);
$this
->assertSession()
->statusCodeEquals(200);
// Test the the first tier schema has the expected keys.
$structure_keys = array_keys(static::EXPECTED_STRUCTURE);
$response_keys = array_keys($decoded_response);
$missing = array_diff($structure_keys, $response_keys);
$this
->assertTrue(empty($missing), 'Schema missing expected key(s): ' . implode(', ', $missing));
// Test that the required info block keys exist in the response.
$structure_info_keys = array_keys(static::EXPECTED_STRUCTURE['info']);
$response_keys = array_keys($decoded_response['info']);
$missing_info = array_diff($structure_info_keys, $response_keys);
$this
->assertTrue(empty($missing_info), 'Schema info missing expected key(s): ' . implode(', ', $missing_info));
// Test that schemes is not empty.
$this
->assertTrue(!empty($decoded_response['schemes']), 'Schema for ' . $api_module . ' should define at least one scheme.');
// Test basePath and host.
$port = parse_url($this->baseUrl, PHP_URL_PORT);
$host = parse_url($this->baseUrl, PHP_URL_HOST) . ($port ? ':' . $port : '');
$this
->assertEquals($host, $decoded_response['host'], 'Schema has invalid host.');
$basePath = $this
->getBasePath();
$response_basePath = $decoded_response['basePath'];
$this
->assertEquals($basePath, substr($response_basePath, 0, strlen($basePath)), 'Schema has invalid basePath.');
$routeBase = $api_module === 'jsonapi' ? 'jsonapi' : '';
$response_routeBase = substr($response_basePath, strlen($basePath));
// Verify that with the subdirectory removed, that the basePath is correct.
$this
->assertEquals($routeBase, ltrim($response_routeBase, '/'), 'Route base path is invalid.');
// Verify that root consumes and produces exists and is not empty.
foreach ([
'consumes',
'produces',
] as $key) {
$this
->assertArrayHasKey($key, $decoded_response, "Schema does not contains a root {$key}");
$this
->assertNotEmpty($decoded_response[$key], "Schema has empty root {$key}");
if (!isset($decoded_response[$key])) {
if ($api_module == 'jsonapi') {
$this
->assertEquals([
'application/vnd.api+json',
], $decoded_response[$key], "{$api_module} root {$key} should only contain application/vnd.api+json");
}
elseif ($api_module == 'rest') {
$rest_mimetypes = [
'application/json',
];
if (isset($options['entity_type_id']) && $options['entity_type_id'] === 'openapi_test_entity') {
$rest_mimetypes[] = 'application/hal+json';
}
$this
->assertEquals($rest_mimetypes, $decoded_response[$key], "{$api_module} root {$key} should only contain " . implode(' and ', $rest_mimetypes));
}
}
}
/*
* Tags for rest schema define 'x-entity-type' to reference the entity type
* associated with the entity. This value should exist in the definitions.
*
* NOTE: Currently not all entity types are provided as definitions. As a
* result, the below test is subject to failure, and has been disabled.
*
* @TODO: #2940397 - Convert x-entity-type to x-definition.
* @TODO: #2940407 - Provide all entity types as definitions.
*/
$tags = $decoded_response['tags'];
if (FALSE) {
$definitions = $decoded_response['definitions'];
foreach ($tags as $tag) {
if (isset($tag['x-entity-type'])) {
$type_id = $tag['x-entity-type'];
$this
->assertTrue(isset($definitions[$type_id]), 'The \'x-entity-type\' ' . $type_id . ' is invalid for ' . $tag['name'] . '.');
}
}
}
// Validate that all security definitions are valid, and have a provider.
$security_definitions = $decoded_response['securityDefinitions'];
$auth_providers = $this->container
->get('authentication_collector')
->getSortedProviders();
$supported_security_types = [
'basic',
'apiKey',
'cookie',
'oauth',
'oauth2',
];
foreach ($security_definitions as $definition_id => $definition) {
if ($definition_id !== 'csrf_token') {
// CSRF Token will never have an auth collector, all others shoud.
$this
->assertTrue(array_key_exists($definition_id, $auth_providers), 'Security definition ' . $definition_id . ' not an auth collector.');
}
$this
->assertTrue(in_array($definition['type'], $supported_security_types), 'Security definition schema ' . $definition_id . ' has invalid type ' . $definition['type']);
}
// Test paths for valid tags, schema, security, and definitions.
$paths =& $decoded_response['paths'];
$tag_names = array_column($tags, 'name');
$all_method_tags = [];
foreach ($paths as $path => &$methods) {
foreach ($methods as $method => &$method_schema) {
// Ensure all tags are defined.
$missing_tags = array_diff($method_schema['tags'], $tag_names);
$all_method_tags = array_merge($all_method_tags, $method_schema['tags']);
$this
->assertTrue(empty($missing_tags), 'Method ' . $method . ' for ' . $path . ' has invalid tag(s): ' . implode(', ', $missing_tags));
// Ensure all request schemes are defined.
if (isset($method_schema['schemes'])) {
$missing_schemas = array_diff($method_schema['schemes'], $decoded_response['schemes']);
$this
->assertTrue(empty($missing_schemas), 'Method ' . $method . ' for ' . $path . ' has invalid scheme(s): ' . implode(', ', $missing_schemas));
}
$response_security_types = array_keys($decoded_response['securityDefinitions']);
if (isset($method_schema['security'])) {
foreach ($method_schema['security'] as $security_definitions) {
$security_types = array_keys($security_definitions);
$missing_security_types = array_diff($security_types, $response_security_types);
$this
->assertTrue(empty($missing_security_types), 'Method ' . $method . ' for ' . $path . ' has invalid security type(s): ' . implode(', ', $missing_security_types) . ' + ' . implode(', ', $security_types) . ' + ' . implode(', ', $response_security_types));
}
}
foreach ([
'consumes',
'produces',
] as $key) {
if (isset($method_schema[$key]) && !empty($method_schema[$key])) {
// Filter out mimetypes that exist in parent.
$method_extra_mimetypes = array_diff($method_schema[$key], $decoded_response[$key]);
$this
->assertEmpty($method_extra_mimetypes, 'Method ' . $method . ' for ' . $path . ' has invalid mime type(s): ' . implode(', ', $method_extra_mimetypes));
if ($api_module == 'rest') {
$rest_mimetypes = [
'application/json',
];
if (isset($options['entity_type_id']) && $options['entity_type_id'] === 'openapi_test_entity') {
$rest_mimetypes[] = 'application/hal+json';
}
$this
->assertEquals($rest_mimetypes, $method_schema[$key], 'Entity type ' . $options['entity_type_id'] . ' should only have REST mimetype(s): ' . implode(', ', $rest_mimetypes));
}
}
}
// Remove all tested properties from method schema.
unset($method_schema['tags']);
unset($method_schema['schemes']);
unset($method_schema['security']);
}
}
$all_method_tags = array_unique($all_method_tags);
asort($all_method_tags);
asort($tag_names);
$this
->assertEquals(array_values($all_method_tags), array_values($tag_names), "Method tags equal tag names");
// Strip response down to only untested properties.
$root_keys = [
'definitions',
'paths',
];
foreach (array_diff(array_keys($decoded_response), $root_keys) as $remove) {
unset($decoded_response[$remove]);
}
// Build file name.
$file_name = __DIR__ . "/../../expectations/{$api_module}";
if ($options) {
$file_name .= "." . implode('.', $options);
}
$file_name .= '.json';
if (static::GENERATE_EXPECTATION_FILES) {
$this
->saveExpectationFile($file_name, $decoded_response);
// Response assertion is not performed when generating expectation
// files.
return;
}
// Load expected value and test remaining schema.
$expected = json_decode(file_get_contents($file_name), TRUE);
$this
->nestedKsort($expected);
$this
->nestedKsort($decoded_response);
// @todo Update the expectations to include path alias stuff, and then
// delete these unset() calls.
unset($decoded_response['definitions']['path_alias--path_alias']);
unset($decoded_response['paths']['/path_alias/path_alias']);
unset($decoded_response['paths']['/path_alias/path_alias/{entity}']);
$this
->assertEquals($expected, $decoded_response, "The response does not match expected file: {$file_name}");
}
/**
* Saves an expectation file.
*
* @param string $file_name
* The file name of the expectation file.
* @param array $decoded_response
* The decoded JSON response.
*
* @see \Drupal\Tests\openapi\Functional\RequestTest::GENERATE_EXPECTATION_FILES
*/
protected function saveExpectationFile($file_name, array $decoded_response) {
// Remove the base path from the start of the string, if present.
$re_encode = json_encode($decoded_response, JSON_PRETTY_PRINT);
file_put_contents($file_name, $re_encode);
}
/**
* Enables the REST service interface for a specific entity type.
*
* @param string|false $resource_type
* The resource type that should get REST API enabled or FALSE to disable
* all resource types.
* @param string $method
* The HTTP method to enable, e.g. GET, POST etc.
* @param string|array $format
* (Optional) The serialization format, e.g. hal_json, or a list of formats.
* @param array $auth
* (Optional) The list of valid authentication methods.
*/
protected function enableRestService($resource_type, $method = 'GET', $format = 'json', array $auth = [
'csrf_token',
]) {
if ($resource_type) {
// Enable REST API for this entity type.
$resource_config_id = str_replace(':', '.', $resource_type);
// Get entity by id.
/** @var \Drupal\rest\RestResourceConfigInterface $resource_config */
$resource_config = RestResourceConfig::load($resource_config_id);
if (!$resource_config) {
$resource_config = RestResourceConfig::create([
'id' => $resource_config_id,
'granularity' => RestResourceConfigInterface::METHOD_GRANULARITY,
'configuration' => [],
]);
}
$configuration = $resource_config
->get('configuration');
if (is_array($format)) {
for ($i = 0; $i < count($format); $i++) {
$configuration[$method]['supported_formats'][] = $format[$i];
}
}
else {
$configuration[$method]['supported_formats'][] = $format;
}
foreach ($auth as $auth_provider) {
$configuration[$method]['supported_auth'][] = $auth_provider;
}
$resource_config
->set('configuration', $configuration);
$resource_config
->save();
}
else {
foreach (RestResourceConfig::loadMultiple() as $resource_config) {
$resource_config
->delete();
}
}
}
/**
* Gets the base path to be used in OpenAPI.
*
* @return string
* The base path.
*/
protected function getBasePath() {
$path = rtrim(parse_url($this->baseUrl, PHP_URL_PATH), '/');
// OpenAPI spec states that the base path must start with a '/'.
if (strlen($path) == 0) {
// For a zero length string, set it to minimal value.
$path = "/";
}
elseif (substr($path, 0, 1) !== '/') {
// Prepend a slash to any other string that don't have one.
$path = '/' . $path;
}
return $path;
}
/**
* Sorts a nested array with ksort().
*
* @param array $array
* The nested array to sort.
*/
protected function nestedKsort(array &$array) {
if ($this
->isAssocArray($array)) {
ksort($array);
}
else {
usort($array, function ($a, $b) {
if (isset($a['name']) && isset($b['name'])) {
return strcmp($a['name'], $b['name']);
}
return -1;
});
}
foreach ($array as &$item) {
if (is_array($item)) {
$this
->nestedKsort($item);
}
}
}
/**
* Determine if an array is associative array.
*
* @param array $arr
* The array.
*
* @return bool
* TRUE if the array is associative, otherwise false.
*/
protected function isAssocArray(array $arr) {
if (empty($arr)) {
return FALSE;
}
return array_keys($arr) !== range(0, count($arr) - 1);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertHelperTrait:: |
protected static | function | Casts MarkupInterface objects into strings. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | Asserts whether an expected cache tag was present in the last response. | |
AssertLegacyTrait:: |
protected | function | Asserts that the element with the given CSS selector is not present. | |
AssertLegacyTrait:: |
protected | function | Asserts that the element with the given CSS selector is present. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertLegacyTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertLegacyTrait:: |
protected | function | Checks that current response header equals value. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertLegacyTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertLegacyTrait:: |
protected | function | Asserts whether an expected cache tag was absent in the last response. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text is not found escaped on the loaded page. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does NOT exist with the given name or ID. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertLegacyTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertLegacyTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertLegacyTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option does NOT exist in the current page. | |
AssertLegacyTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is not found in the raw content. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS not found on the loaded page, fail otherwise. | 1 |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | 1 |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead. | |
AssertLegacyTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertLegacyTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | 1 |
AssertLegacyTrait:: |
protected | function | Asserts the page responds with the specified response code. | 1 |
AssertLegacyTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | 1 |
AssertLegacyTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertLegacyTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertLegacyTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertLegacyTrait:: |
protected | function | Passes if the internal browser's URL matches the given path. | |
AssertLegacyTrait:: |
protected | function | Builds an XPath query. | |
AssertLegacyTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertLegacyTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertLegacyTrait:: |
protected | function | Gets the current raw content. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | ||
BlockCreationTrait:: |
protected | function | Creates a block instance based on default settings. Aliased as: drupalPlaceBlock | |
BrowserHtmlDebugTrait:: |
protected | property | The Base URI to use for links to the output files. | |
BrowserHtmlDebugTrait:: |
protected | property | Class name for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Counter for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Counter storage for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Directory name for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | HTML output output enabled. | |
BrowserHtmlDebugTrait:: |
protected | property | The file name to write the list of URLs to. | |
BrowserHtmlDebugTrait:: |
protected | property | HTML output test ID. | |
BrowserHtmlDebugTrait:: |
protected | function | Formats HTTP headers as string for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | function | Returns headers in HTML output format. | 1 |
BrowserHtmlDebugTrait:: |
protected | function | Logs a HTML output message in a text file. | |
BrowserHtmlDebugTrait:: |
protected | function | Creates the directory to store browser output. | |
BrowserTestBase:: |
protected | property | The base URL. | |
BrowserTestBase:: |
protected | property | The config importer that can be used in a test. | |
BrowserTestBase:: |
protected | property | An array of custom translations suitable for drupal_rewrite_settings(). | |
BrowserTestBase:: |
protected | property | The database prefix of this test run. | |
BrowserTestBase:: |
protected | property | The theme to install as the default for testing. | 1,597 |
BrowserTestBase:: |
protected | property | Mink session manager. | |
BrowserTestBase:: |
protected | property | ||
BrowserTestBase:: |
protected | property | 1 | |
BrowserTestBase:: |
protected | property | The original container. | |
BrowserTestBase:: |
protected | property | The original array of shutdown function callbacks. | |
BrowserTestBase:: |
protected | property | ||
BrowserTestBase:: |
protected | property | The profile to install as a basis for testing. | 39 |
BrowserTestBase:: |
protected | property | The app root. | |
BrowserTestBase:: |
protected | property | Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests. | |
BrowserTestBase:: |
protected | property | Time limit in seconds for the test. | |
BrowserTestBase:: |
protected | property | The translation file directory for the test environment. | |
BrowserTestBase:: |
protected | function | Clean up the Simpletest environment. | |
BrowserTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
BrowserTestBase:: |
protected | function | Translates a CSS expression to its XPath equivalent. | |
BrowserTestBase:: |
protected | function | Gets the value of an HTTP response header. | |
BrowserTestBase:: |
protected | function | Returns all response headers. | |
BrowserTestBase:: |
public static | function | Ensures test files are deletable. | |
BrowserTestBase:: |
protected | function | Gets an instance of the default Mink driver. | |
BrowserTestBase:: |
protected | function | Gets the JavaScript drupalSettings variable for the currently-loaded page. | 1 |
BrowserTestBase:: |
protected | function | Obtain the HTTP client for the system under test. | |
BrowserTestBase:: |
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:: |
protected | function | Helper function to get the options of select field. | |
BrowserTestBase:: |
protected | function |
Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait:: |
|
BrowserTestBase:: |
public | function | Returns Mink session. | |
BrowserTestBase:: |
protected | function | Get session cookies from current session. | |
BrowserTestBase:: |
protected | function |
Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait:: |
|
BrowserTestBase:: |
protected | function | Visits the front page when initializing Mink. | 3 |
BrowserTestBase:: |
protected | function | Initializes Mink sessions. | 1 |
BrowserTestBase:: |
public | function | Installs Drupal into the Simpletest site. | 1 |
BrowserTestBase:: |
protected | function | Registers additional Mink sessions. | |
BrowserTestBase:: |
protected | function | 3 | |
BrowserTestBase:: |
protected | function | Transforms a nested array into a flat array suitable for drupalPostForm(). | |
BrowserTestBase:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
BrowserTestBase:: |
public | function | 1 | |
BrowserTestBase:: |
public | function | Prevents serializing any properties. | |
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ContentTypeCreationTrait:: |
protected | function | Creates a custom content type based on default settings. Aliased as: drupalCreateContentType | 1 |
FunctionalTestSetupTrait:: |
protected | property | The flag to set 'apcu_ensure_unique_prefix' setting. | 1 |
FunctionalTestSetupTrait:: |
protected | property | The class loader to use for installation and initialization of setup. | |
FunctionalTestSetupTrait:: |
protected | property | The config directories used in this test. | |
FunctionalTestSetupTrait:: |
protected | property | The "#1" admin user. | |
FunctionalTestSetupTrait:: |
protected | function | Execute the non-interactive installer. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Returns all supported database driver installer objects. | |
FunctionalTestSetupTrait:: |
protected | function | Initialize various configurations post-installation. | 2 |
FunctionalTestSetupTrait:: |
protected | function | Initializes the kernel after installation. | |
FunctionalTestSetupTrait:: |
protected | function | Initialize settings created during install. | |
FunctionalTestSetupTrait:: |
protected | function | Initializes user 1 for the site to be installed. | |
FunctionalTestSetupTrait:: |
protected | function | Installs the default theme defined by `static::$defaultTheme` when needed. | |
FunctionalTestSetupTrait:: |
protected | function | Install modules defined by `static::$modules`. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Returns the parameters that will be used when Simpletest installs Drupal. | 9 |
FunctionalTestSetupTrait:: |
protected | function | Prepares the current environment for running the test. | 23 |
FunctionalTestSetupTrait:: |
protected | function | Creates a mock request and sets it on the generator. | |
FunctionalTestSetupTrait:: |
protected | function | Prepares site settings and services before installation. | 2 |
FunctionalTestSetupTrait:: |
protected | function | Resets and rebuilds the environment after setup. | |
FunctionalTestSetupTrait:: |
protected | function | Rebuilds \Drupal::getContainer(). | |
FunctionalTestSetupTrait:: |
protected | function | Resets all data structures after having enabled new modules. | |
FunctionalTestSetupTrait:: |
protected | function | Changes parameters in the services.yml file. | |
FunctionalTestSetupTrait:: |
protected | function | Sets up the base URL based upon the environment variable. | |
FunctionalTestSetupTrait:: |
protected | function | Rewrites the settings.php file of the test site. | |
NodeCreationTrait:: |
protected | function | Creates a node based on default settings. Aliased as: drupalCreateNode | |
NodeCreationTrait:: |
public | function | Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle | |
PhpunitCompatibilityTrait:: |
public | function | Returns a mock object for the specified class using the available method. | |
PhpunitCompatibilityTrait:: |
public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
RefreshVariablesTrait:: |
protected | function | Refreshes in-memory configuration and state information. | 3 |
RequestTest:: |
public static | property |
Modules to enable. Overrides BrowserTestBase:: |
|
RequestTest:: |
protected | function | Enables the REST service interface for a specific entity type. | |
RequestTest:: |
constant | |||
RequestTest:: |
constant | List of required array keys for response schema. | ||
RequestTest:: |
constant | Set to TRUE to run this test to generate expectation files. | ||
RequestTest:: |
protected | function | Gets the base path to be used in OpenAPI. | |
RequestTest:: |
protected | function | Determine if an array is associative array. | |
RequestTest:: |
protected | function | Sorts a nested array with ksort(). | |
RequestTest:: |
public | function | Dataprovider for testRequests. | |
RequestTest:: |
protected | function | Makes OpenAPI request and checks the response. | |
RequestTest:: |
protected | function | Saves an expectation file. | |
RequestTest:: |
protected | function |
Overrides BrowserTestBase:: |
|
RequestTest:: |
public | function | Assert that test expectation generation is disabled. | |
RequestTest:: |
public | function | Tests OpenAPI requests. | |
SessionTestTrait:: |
protected | property | The name of the session cookie. | |
SessionTestTrait:: |
protected | function | Generates a session cookie name. | |
SessionTestTrait:: |
protected | function | Returns the session name in use on the child site. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
TestSetupTrait:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
TestSetupTrait:: |
protected | property | The dependency injection container used in the test. | |
TestSetupTrait:: |
protected | property | The DrupalKernel instance used in the test. | |
TestSetupTrait:: |
protected | property | The site directory of the original parent site. | |
TestSetupTrait:: |
protected | property | The private file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The public file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The site directory of this test run. | |
TestSetupTrait:: |
protected | property | Set to TRUE to strict check all configuration saved. | 2 |
TestSetupTrait:: |
protected | property | The temporary file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The test run ID. | |
TestSetupTrait:: |
protected | function | Changes the database connection to the prefixed one. | |
TestSetupTrait:: |
protected | function | Gets the config schema exclusions for this test. | |
TestSetupTrait:: |
public static | function | Returns the database connection to the site running Simpletest. | |
TestSetupTrait:: |
protected | function | Generates a database prefix for running tests. | 2 |
UiHelperTrait:: |
protected | property | The current user logged in using the Mink controlled browser. | |
UiHelperTrait:: |
protected | property | The number of meta refresh redirects to follow, or NULL if unlimited. | |
UiHelperTrait:: |
protected | property | The number of meta refresh redirects followed during ::drupalGet(). | |
UiHelperTrait:: |
public | function | Returns WebAssert object. | 1 |
UiHelperTrait:: |
protected | function | Builds an a absolute URL from a system path or a URL object. | |
UiHelperTrait:: |
protected | function | Checks for meta refresh tag and if found call drupalGet() recursively. | |
UiHelperTrait:: |
protected | function | Clicks the element with the given CSS selector. | |
UiHelperTrait:: |
protected | function | Follows a link by complete name. | |
UiHelperTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
UiHelperTrait:: |
protected | function | Retrieves a Drupal path or an absolute path. | 3 |
UiHelperTrait:: |
protected | function | Logs in a user using the Mink controlled browser. | |
UiHelperTrait:: |
protected | function | Logs a user out of the Mink controlled browser and confirms. | |
UiHelperTrait:: |
protected | function | Executes a form submission. | |
UiHelperTrait:: |
protected | function | Returns whether a given user account is logged in. | |
UiHelperTrait:: |
protected | function | Takes a path and returns an absolute path. | |
UiHelperTrait:: |
protected | function | Retrieves the plain-text content from the current page. | |
UiHelperTrait:: |
protected | function | Get the current URL from the browser. | |
UiHelperTrait:: |
protected | function | Prepare for a request to testing site. | 1 |
UiHelperTrait:: |
protected | function | Fills and submits a form. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. | |
UserCreationTrait:: |
protected | function | Creates an administrative role. | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. Aliased as: drupalCreateRole | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. Aliased as: drupalCreateUser | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. | |
XdebugRequestTrait:: |
protected | function | Adds xdebug cookies, from request setup. |