class AuthenticationFormJsTest in Apigee Edge 8
Apigee Edge API credentials, authentication form, key integration test.
@group apigee_edge @group apigee_edge_javascript
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\FunctionalJavascriptTests\WebDriverTestBase
- class \Drupal\Tests\apigee_edge\FunctionalJavascript\ApigeeEdgeFunctionalJavascriptTestBase uses ApigeeEdgeFunctionalTestTrait
- class \Drupal\Tests\apigee_edge\FunctionalJavascript\Form\AuthenticationFormJsTest
- class \Drupal\Tests\apigee_edge\FunctionalJavascript\ApigeeEdgeFunctionalJavascriptTestBase uses ApigeeEdgeFunctionalTestTrait
- class \Drupal\FunctionalJavascriptTests\WebDriverTestBase
Expanded class hierarchy of AuthenticationFormJsTest
File
- tests/
src/ FunctionalJavascript/ Form/ AuthenticationFormJsTest.php, line 35
Namespace
Drupal\Tests\apigee_edge\FunctionalJavascript\FormView source
class AuthenticationFormJsTest extends ApigeeEdgeFunctionalJavascriptTestBase {
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'classy';
/**
* Valid username.
*
* @var string
*/
private $username;
/**
* Valid password.
*
* @var string
*/
private $password;
/**
* Valid organization.
*
* @var string
*/
private $organization;
/**
* Valid endpoint.
*
* @var string
*/
private $endpoint;
/**
* The Apigee instance type.
*
* @var string
*/
private $instanceType;
/**
* The account JSON key.
*
* @var string
*/
private $account_key;
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
// Save valid credentials for later use.
/** @var \Drupal\apigee_edge\Plugin\EdgeKeyTypeInterface $test_key_type */
$test_key = Key::load($this
->config(AuthenticationForm::CONFIG_NAME)
->get('active_key'));
$test_key_type = $test_key
->getKeyType();
$this->instanceType = $test_key_type
->getInstanceType($test_key);
$this->organization = $test_key_type
->getOrganization($test_key);
if ($this->instanceType != EdgeKeyTypeInterface::INSTANCE_TYPE_HYBRID) {
$this->username = $test_key_type
->getUsername($test_key);
$this->password = $test_key_type
->getPassword($test_key);
$this->endpoint = $test_key_type
->getEndpoint($test_key);
}
else {
$this->account_key = $test_key_type
->getAccountKey($test_key);
}
// Restore the default HTTP timeout set by the testing module because
// we would like to run a test that tries to connect to an invalid
// endpoint and we should not wait 6 minutes for the result.
$this
->config('apigee_edge.client')
->set('http_client_timeout', 30)
->save();
}
/**
* Tests the Authentication form.
*/
public function testAuthenticationForm() {
if ($this->instanceType == EdgeKeyTypeInterface::INSTANCE_TYPE_HYBRID) {
$this
->markTestSkipped('Skipping "testAuthenticationForm": can only be tested with public/private cloud credentials.');
}
$web_assert = $this
->assertSession();
// Test the authentication form.
$this
->drupalLogin($this->rootUser);
$this
->drupalGet(Url::fromRoute('apigee_edge.settings'));
// We need to fill in the password field to test connection.
$this
->getSession()
->getPage()
->fillField('Password', $this->password);
$this
->assertSession()
->pageTextContains('Send request using the given API credentials.');
$this
->assertSendRequestMessage('.messages--status', 'Connection successful.');
$web_assert
->elementNotExists('css', 'details[data-drupal-selector="edit-debug"]');
$page = $this
->getSession()
->getPage();
$page
->find('css', 'details[data-drupal-selector="edit-provider-section"] > summary')
->click();
$page
->selectFieldOption('key_provider', 'apigee_edge_environment_variables');
$this
->assertSession()
->waitForText("The selected key provider does not accept a value. See the provider's description for instructions on how and where to store the key value.");
$this
->validateForm([
$this,
'visitAuthenticationForm',
]);
// Validate that the form actually saved the valid credentials (DRUP-734).
$this
->visitAuthenticationForm();
$web_assert
->fieldValueEquals('Organization', $this->organization);
$web_assert
->fieldValueEquals('Username', $this->username);
// Password field should be empty.
$web_assert
->fieldValueEquals('Password', '');
}
/**
* Tests the Key add form.
*
* We assume that if the Authentication form and the Key add form test passed
* then the Key edit form also works correctly, because the Authentication
* form is a customized Key edit form.
*/
public function testKeyAddForm() {
if ($this->instanceType == EdgeKeyTypeInterface::INSTANCE_TYPE_HYBRID) {
$this
->markTestSkipped('Skipping "testKeyAddForm": can only be tested with public/private cloud credentials.');
}
$web_assert = $this
->assertSession();
// Test the authentication form using the default key stored by environment
// variable key provider.
$this
->drupalLogin($this->rootUser);
$this
->drupalGet(Url::fromRoute('entity.key.add_form'));
// The default Key type is "Authentication" so the "Send request" button
// should not be visible.
$web_assert
->elementNotExists('css', 'input[name="test_connection"]');
$this
->cssSelect('select[name="key_type"]')[0]
->setValue('apigee_auth');
// The "Send request" button now should appear.
$web_assert
->waitForElementVisible('css', 'input[name="test_connection"]');
// The "Send request" button now should not appear if Key entity form
// customization is disabled.
$this
->config('apigee_edge.dangerzone')
->set('do_not_alter_key_entity_forms', TRUE)
->save();
$this
->drupalGet(Url::fromRoute('entity.key.add_form'));
$this
->cssSelect('select[name="key_type"]')[0]
->setValue('apigee_auth');
$web_assert
->assertWaitOnAjaxRequest();
$web_assert
->elementNotExists('css', 'input[name="test_connection"]');
// Revert the config change.
$this
->config('apigee_edge.dangerzone')
->set('do_not_alter_key_entity_forms', FALSE)
->save();
$this
->validateForm([
$this,
'visitKeyAddForm',
]);
}
/**
* Tests the Authentication form using Hybrid auth.
*
* @group hybrid
*/
public function testUsingHybridForm() {
// We have to structure the key variables so that this test class can
// be run both against a Public and Hybrid cloud orgs. Because of this,
// if the APIGEE_EDGE_HYBRID_ORGANIZATION environment var is set, it will
// use it as the Hybrid org for this test.
// Similarly, if the configured key credentials are for a Public/Private
// cloud org, then retrieve the account key directly from the environment.
$organization = getenv('APIGEE_EDGE_HYBRID_ORGANIZATION') ?: $this->organization;
$account_key = $this->account_key ? json_encode($this->account_key) : getenv('APIGEE_EDGE_ACCOUNT_JSON_KEY');
if (!$organization || !$account_key) {
$this
->markTestSkipped('Skipping "testUsingHybridForm": missing test environment variables APIGEE_EDGE_HYBRID_ORGANIZATION and/or APIGEE_EDGE_ACCOUNT_JSON_KEY.');
}
$web_assert = $this
->assertSession();
// Test the authentication form.
$this
->drupalLogin($this->rootUser);
$this
->drupalGet(Url::fromRoute('entity.key.add_form'));
$this
->visitKeyAddForm();
$page = $this
->getSession()
->getPage();
$page
->selectFieldOption('key_input_settings[instance_type]', EdgeKeyTypeInterface::INSTANCE_TYPE_HYBRID);
$page
->fillField('Organization', $organization);
$page
->fillField('GCP service account key', $account_key);
$this
->assertSendRequestMessage('.messages--status', 'Connection successful.');
$web_assert
->elementNotExists('css', 'details[data-drupal-selector="edit-debug"]');
}
/**
* Visits the Authentication form for testing.
*/
protected function visitAuthenticationForm() : void {
if ($this->loggedInUser
->id() !== $this->rootUser) {
$this
->drupalLogin($this->rootUser);
}
$this
->drupalGet(Url::fromRoute('apigee_edge.settings'));
}
/**
* Visits the Key add form for testing.
*/
protected function visitKeyAddForm() : void {
$web_assert = $this
->assertSession();
$page = $this
->getSession()
->getPage();
if ($this->loggedInUser
->id() !== $this->rootUser) {
$this
->drupalLogin($this->rootUser);
}
$this
->drupalGet(Url::fromRoute('entity.key.add_form'));
// Key name is required.
$page
->fillField('Key name', $this
->randomMachineName());
$this
->cssSelect('select[name="key_type"]')[0]
->setValue('apigee_auth');
// The "Send request" button now should appear again.
$web_assert
->waitForElementVisible('css', 'input[name="test_connection"]');
$this
->cssSelect('select[name="key_provider"]')[0]
->setValue('apigee_edge_private_file');
$web_assert
->waitForElementVisible('css', 'key_input_settings[organization]');
}
/**
* Validates the visited form.
*
* @param callable $visitFormAsAdmin
* The function that visits the form as an admin user that we would like
* to validate.
*/
protected function validateForm(callable $visitFormAsAdmin) : void {
$web_assert = $this
->assertSession();
$page = $this
->getSession()
->getPage();
// Unset private file path and invalidate the active key.
$settings['settings']['file_private_path'] = (object) [
'value' => '',
'required' => TRUE,
];
$this
->writeSettings($settings);
$this
->invalidateKey();
// Ensure that the private file key provider is the default on the
// Authentication form and form detects the problem caused by the
// missing private filesystem configuration.
$visitFormAsAdmin();
$this
->assertSession()
->pageTextContains('The requirements of the selected Apigee Edge: Private File key provider are not fulfilled. Fix errors described below or change the key provider.');
$this
->assertSession()
->pageTextContains('Private filesystem has not been configured yet. Learn more');
// Set private file path.
$settings['settings']['file_private_path'] = (object) [
'value' => "{$this->siteDirectory}/private",
'required' => TRUE,
];
$this
->writeSettings($settings);
// Reload the page, the key input form should be visible.
$visitFormAsAdmin();
// Make sure the default fields are visible and empty.
$web_assert
->fieldValueEquals('Authentication type', 'oauth');
$web_assert
->fieldValueEquals('Username', '');
$web_assert
->fieldValueEquals('Password', '');
$web_assert
->fieldValueEquals('Organization', '');
$web_assert
->fieldValueEquals('Apigee Edge endpoint', '');
// Select basic auth.
$page
->selectFieldOption('key_input_settings[auth_type]', EdgeKeyTypeInterface::EDGE_AUTH_TYPE_BASIC);
// Make sure the oauth fields are hidden.
$this
->assertFalse($this
->cssSelect('input[name="key_input_settings[authorization_server]"]')[0]
->isVisible());
$this
->assertFalse($this
->cssSelect('input[name="key_input_settings[client_id]"]')[0]
->isVisible());
$this
->assertFalse($this
->cssSelect('input[name="key_input_settings[client_secret]"]')[0]
->isVisible());
// Test the connection with basic auth.
$page
->selectFieldOption('key_input_settings[instance_type]', EdgeKeyTypeInterface::INSTANCE_TYPE_PUBLIC);
$page
->fillField('Username', $this->username);
$page
->fillField('Password', $this->password);
$page
->fillField('Organization', $this->organization);
$this
->assertSession()
->pageTextContains('Send request using the given API credentials.');
$this
->assertSendRequestMessage('.messages--status', 'Connection successful.');
$web_assert
->elementNotExists('css', 'details[data-drupal-selector="edit-debug"]');
// Switch to oauth.
$this
->cssSelect('select[name="key_input_settings[auth_type]"]')[0]
->setValue('oauth');
// Make sure the oauth fields are visible.
$this
->assertTrue($this
->cssSelect('input[name="key_input_settings[authorization_server_type]"]')[0]
->isVisible());
$this
->assertTrue($this
->cssSelect('input[name="key_input_settings[client_id]"]')[0]
->isVisible());
$this
->assertTrue($this
->cssSelect('input[name="key_input_settings[client_secret]"]')[0]
->isVisible());
// Make sure that test connection is disabled without a password.
$page
->fillField('Password', '');
$this
->assertTrue($this
->cssSelect('input[name="test_connection"]')[0]
->hasAttribute('disabled'));
// Make sure that test connection is now enabled.
$page
->fillField('Password', $this->password);
$this
->assertFalse($this
->cssSelect('input[name="test_connection"]')[0]
->hasAttribute('disabled'));
// Test the connection with oauth.
$this
->assertSendRequestMessage('.messages--status', 'Connection successful.');
$web_assert
->elementNotExists('css', 'details[data-drupal-selector="edit-debug"]');
// Make sure the token file has not been left behind.
$token_file_path = $this->container
->get('file_system')
->realpath(OauthTokenFileStorage::DEFAULT_DIRECTORY . '/oauth.dat');
$this
->assertFileNotExists($token_file_path);
// Switch back to basic auth.
$this
->cssSelect('select[name="key_input_settings[auth_type]"]')[0]
->setValue('basic');
// Test the connection with basic auth.
$page
->fillField('Password', $this->password);
$this
->assertSendRequestMessage('.messages--status', 'Connection successful.');
$web_assert
->elementNotExists('css', 'details[data-drupal-selector="edit-debug"]');
$page
->fillField('Password', $this->password);
// Press the Save/Save configuration button.
$page
->pressButton('op');
$this
->assertSession()
->pageTextContains('Connection successful.');
// Because Key add/edit form redirects the user to the Key entity listing
// page on success therefore we have to re-visit the form again.
$visitFormAsAdmin();
// Setup valid credentials again.
$page
->selectFieldOption('key_input_settings[instance_type]', EdgeKeyTypeInterface::INSTANCE_TYPE_PUBLIC);
$page
->fillField('Username', $this->username);
$page
->fillField('Password', $this->password);
$page
->fillField('Organization', $this->organization);
$page
->selectFieldOption('key_input_settings[auth_type]', EdgeKeyTypeInterface::EDGE_AUTH_TYPE_BASIC);
// Test invalid password.
$random_pass = $this
->randomString();
$page
->fillField('Password', $random_pass);
$this
->assertSendRequestMessage('.messages--error', "Failed to connect to Apigee Edge. The given username ({$this->username}) or password is incorrect. Error message: ");
// TODO Re-add this assert later. It had to be disabled because of a
// regression bug in the Apigee Edge for Public Cloud 19.03.01 release. If
// valid organization name and username provided with an invalid password
// the MGMT server returns HTTP 500 with an error instead of HTTP 401.
// $web_assert->elementContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', 'HTTP/1.1 401 Unauthorized');.
$web_assert
->elementContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', '***credentials***');
$web_assert
->elementNotContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', $random_pass);
$page
->fillField('Password', $this->password);
// Test invalid username when using public cloud endpoint.
$page
->selectFieldOption('key_input_settings[instance_type]', EdgeKeyTypeInterface::INSTANCE_TYPE_PUBLIC);
$page
->fillField('Username', $this
->randomMachineName());
$this
->assertSendRequestMessage('.messages--error', "Failed to connect to Apigee Edge. The organization username should be a valid email. Error message: ");
$page
->fillField('Username', $this->username);
// Test invalid organization.
$random_org = $this->randomGenerator
->word(16);
$page
->fillField('Organization', $random_org);
$this
->assertSendRequestMessage('.messages--error', "Failed to connect to Apigee Edge. The given organization name ({$random_org}) is incorrect. Error message: ");
$web_assert
->elementContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', 'HTTP/1.1 404 Not Found');
$web_assert
->elementContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', "\"organization\": \"{$random_org}\"");
$page
->fillField('Organization', $this->organization);
// Test invalid endpoint.
$page
->selectFieldOption('key_input_settings[instance_type]', EdgeKeyTypeInterface::INSTANCE_TYPE_PRIVATE);
$invalid_domain = "{$this->randomGenerator->word(16)}.example.com";
$page
->fillField('Apigee Edge endpoint', "http://{$invalid_domain}/");
$this
->assertSendRequestMessage('.messages--error', "Failed to connect to Apigee Edge. The given endpoint (http://{$invalid_domain}/) is incorrect or something is wrong with the connection. Error message: ");
$web_assert
->elementContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', "\"endpoint\": \"http:\\/\\/{$invalid_domain}\\/\"");
$web_assert
->fieldValueEquals('Apigee Edge endpoint', "http://{$invalid_domain}/");
$page
->fillField('Apigee Edge endpoint', '');
$page
->selectFieldOption('key_input_settings[instance_type]', EdgeKeyTypeInterface::INSTANCE_TYPE_PUBLIC);
// Test another invalid endpoint scenario:
// Some endpoints are not a Management API endpoint, but still return
// HTTP 200 with a JSON response.
// Only test with mock client.
if (static::$mock_api_client_ready && !$this->integration_enabled) {
$invalid_endpoint = 'enterprise.apigee.com/platform/orgname';
$page
->selectFieldOption('key_input_settings[instance_type]', EdgeKeyTypeInterface::INSTANCE_TYPE_PRIVATE);
$page
->fillField('Apigee Edge endpoint', "https://{$invalid_endpoint}/");
$this
->assertSendRequestMessage('.messages--error', "Failed to connect to Apigee Edge. The given endpoint (https://{$invalid_endpoint}/) is incorrect or something is wrong with the connection. Error message: ");
$invalid_endpoint_escaped = str_replace('/', '\\/', $invalid_endpoint);
$web_assert
->elementContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', "\"endpoint\": \"https:\\/\\/{$invalid_endpoint_escaped}\\/\"");
$web_assert
->fieldValueEquals('Apigee Edge endpoint', "https://{$invalid_endpoint}/");
$page
->fillField('Apigee Edge endpoint', '');
$page
->selectFieldOption('key_input_settings[instance_type]', EdgeKeyTypeInterface::INSTANCE_TYPE_PUBLIC);
}
// Test invalid authorization server.
$this
->cssSelect('select[data-drupal-selector="edit-key-input-settings-auth-type"]')[0]
->setValue('oauth');
$invalid_domain = "{$this->randomGenerator->word(16)}.example.com";
$page
->selectFieldOption('key_input_settings[authorization_server_type]', 'custom');
$page
->fillField('Custom authorization server', "http://{$invalid_domain}/");
$this
->assertSendRequestMessage('.messages--error', "Failed to connect to the OAuth authorization server. The given authorization server (http://{$invalid_domain}/) is incorrect or something is wrong with the connection. Error message: ");
$web_assert
->fieldValueEquals('Custom authorization server', "http://{$invalid_domain}/");
$web_assert
->elementContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', '"auth_type": "oauth"');
$web_assert
->elementContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', "\"authorization_server\": \"http:\\/\\/{$invalid_domain}\\/\"");
$web_assert
->elementContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', '"client_id": "edgecli"');
$web_assert
->elementContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', '"client_secret": "edgeclisecret"');
$page
->fillField('Custom authorization server', '');
$page
->selectFieldOption('key_input_settings[authorization_server_type]', 'default');
// Test invalid client secret.
$random_secret = $this->randomGenerator
->word(16);
$page
->fillField('Client secret', $random_secret);
$this
->assertSendRequestMessage('.messages--error', "Failed to connect to the OAuth authorization server. The given username ({$this->username}) or password or client ID (edgecli) or client secret is incorrect. Error message: ");
$web_assert
->elementContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', '"authorization_server": "https:\\/\\/login.apigee.com\\/oauth\\/token"');
$web_assert
->elementContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', '"client_id": "edgecli"');
$web_assert
->elementContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', '"client_secret": "***client-secret***"');
$web_assert
->elementNotContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', $random_secret);
$page
->fillField('Client secret', '');
// Test invalid client id.
$client_id = $this->randomGenerator
->word(8);
$page
->fillField('Client ID', $client_id);
$this
->assertSendRequestMessage('.messages--error', "Failed to connect to the OAuth authorization server. The given username ({$this->username}) or password or client ID ({$client_id}) or client secret is incorrect. Error message: ");
$web_assert
->elementContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', '"authorization_server": "https:\\/\\/login.apigee.com\\/oauth\\/token"');
$web_assert
->elementContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', "\"client_id\": \"{$client_id}\"");
$web_assert
->elementContains('css', 'textarea[data-drupal-selector="edit-debug-text"]', '"client_secret": "edgeclisecret"');
$page
->fillField('Client ID', '');
}
/**
* Tests send request functionality.
*
* @param string $message_selector
* Either `.messages--error` or `.messages--error`.
* @param string $message
* The error or status message.
*/
public function assertSendRequestMessage($message_selector, $message) {
$web_assert = $this
->assertSession();
$page = $this
->getSession()
->getPage();
// Press the send request button.
$page
->pressButton('Send request');
$this
->assertNotNull($web_assert
->waitForElementVisible('css', '.ajax-progress.ajax-progress-throbber', 30000));
// Wait for the test to complete.
$web_assert
->assertWaitOnAjaxRequest(30000);
$web_assert
->elementTextContains('css', $message_selector, $message);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ApigeeEdgeFunctionalJavascriptTestBase:: |
public | function |
Creates a screenshot. Overrides WebDriverTestBase:: |
|
ApigeeEdgeFunctionalTestTrait:: |
protected static | property | Use the mock_api_client or not. | 9 |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | Implements link clicking properly. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | Creates a Drupal account. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function |
Creates an app for a user. Overrides ApigeeMockApiClientHelperTrait:: |
|
ApigeeEdgeFunctionalTestTrait:: |
protected | function | Creates a product. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | The corresponding developer will not be created if a Drupal user is saved. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | The same as drupalGet(), but ignores the meta refresh. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | The corresponding developer will be created if a Drupal user is saved. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | Finds a link on the current page. | |
ApigeeEdgeFunctionalTestTrait:: |
protected static | function | Returns absolute URL starts with a slash. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | Loads all apps for a given user. | 1 |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | Gets a random unique ID. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | Initializes test environment with required configuration. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | Log the given exception using the class short name as type. | |
ApigeeEdgeUtilTestTrait:: |
protected | function | Creates a test key from environment variables, using config key storage. | |
ApigeeEdgeUtilTestTrait:: |
protected | function | Removes the active key for testing with unset API credentials. | |
ApigeeEdgeUtilTestTrait:: |
protected | function | Restores the active key. | |
ApigeeEdgeUtilTestTrait:: |
protected | function | Set active authentication keys in config. | |
ApigeeMockApiClientHelperTrait:: |
protected | property | The entity type manager. | |
ApigeeMockApiClientHelperTrait:: |
protected | property | If integration (real API connection) is enabled. | |
ApigeeMockApiClientHelperTrait:: |
protected | property | The mock response factory service. | |
ApigeeMockApiClientHelperTrait:: |
protected | property | The SDK connector service. | 1 |
ApigeeMockApiClientHelperTrait:: |
protected | property | The mock handler stack is responsible for serving queued api responses. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Add matched developer response. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Add matched org response. | |
ApigeeMockApiClientHelperTrait:: |
public | function | Adds a user to a team. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Setup. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Setup. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Helper to create a Team entity. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Initialize SDK connector. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Installs a given list of modules and rebuilds the cache. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Queues up a mock companies response. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Queues up a mock company response. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Helper to add Edge entity response to stack. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Queues up a mock developer response. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Queues up a mock developer response. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Queues up a mock developers in a company response. | |
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 | ||
AuthenticationFormJsTest:: |
private | property | The account JSON key. | |
AuthenticationFormJsTest:: |
protected | property |
For tests relying on no markup at all or at least no core markup. Overrides ApigeeEdgeFunctionalJavascriptTestBase:: |
|
AuthenticationFormJsTest:: |
private | property | Valid endpoint. | |
AuthenticationFormJsTest:: |
private | property | The Apigee instance type. | |
AuthenticationFormJsTest:: |
private | property | Valid organization. | |
AuthenticationFormJsTest:: |
private | property | Valid password. | |
AuthenticationFormJsTest:: |
private | property | Valid username. | |
AuthenticationFormJsTest:: |
public | function | Tests send request functionality. | |
AuthenticationFormJsTest:: |
protected | function |
Overrides ApigeeEdgeFunctionalJavascriptTestBase:: |
|
AuthenticationFormJsTest:: |
public | function | Tests the Authentication form. | |
AuthenticationFormJsTest:: |
public | function | Tests the Key add form. | |
AuthenticationFormJsTest:: |
public | function | Tests the Authentication form using Hybrid auth. | |
AuthenticationFormJsTest:: |
protected | function | Validates the visited form. | |
AuthenticationFormJsTest:: |
protected | function | Visits the Authentication form for testing. | |
AuthenticationFormJsTest:: |
protected | function | Visits the Key add form for testing. | |
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 | 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 | Mink session manager. | |
BrowserTestBase:: |
protected | property | ||
BrowserTestBase:: |
protected static | property | Modules to enable. | 621 |
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 | Obtain the HTTP client for the system under test. | |
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:: |
public | function | Installs Drupal into the Simpletest site. | 1 |
BrowserTestBase:: |
protected | function | Registers additional Mink sessions. | |
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 | 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 |
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:: |
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. | |
WebDriverTestBase:: |
protected | property | Disables CSS animations in tests for more reliable testing. | |
WebDriverTestBase:: |
protected | property |
To use a legacy phantomjs based approach, please use PhantomJSDriver::class. Overrides BrowserTestBase:: |
2 |
WebDriverTestBase:: |
protected | function | Asserts that the element with the given CSS selector is not visible. | |
WebDriverTestBase:: |
protected | function | Asserts that the element with the given CSS selector is visible. | |
WebDriverTestBase:: |
protected | function | Waits for the given time or until the given JS condition becomes TRUE. | |
WebDriverTestBase:: |
public | function |
Returns WebAssert object. Overrides UiHelperTrait:: |
1 |
WebDriverTestBase:: |
protected | function |
Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase:: |
|
WebDriverTestBase:: |
protected | function |
Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait:: |
|
WebDriverTestBase:: |
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. Overrides BrowserTestBase:: |
|
WebDriverTestBase:: |
protected | function |
Visits the front page when initializing Mink. Overrides BrowserTestBase:: |
|
WebDriverTestBase:: |
protected | function |
Initializes Mink sessions. Overrides BrowserTestBase:: |
1 |
WebDriverTestBase:: |
protected | function |
Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait:: |
|
WebDriverTestBase:: |
protected | function |
Overrides BrowserTestBase:: |
1 |
XdebugRequestTrait:: |
protected | function | Adds xdebug cookies, from request setup. |