class ContactPersonalTest
Same name in other branches
- 9 core/modules/contact/tests/src/Functional/ContactPersonalTest.php \Drupal\Tests\contact\Functional\ContactPersonalTest
- 10 core/modules/contact/tests/src/Functional/ContactPersonalTest.php \Drupal\Tests\contact\Functional\ContactPersonalTest
- 11.x core/modules/contact/tests/src/Functional/ContactPersonalTest.php \Drupal\Tests\contact\Functional\ContactPersonalTest
Tests personal contact form functionality.
@group contact
Hierarchy
- class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Core\Test\FunctionalTestSetupTrait, \Drupal\Tests\UiHelperTrait, \Drupal\Core\Test\TestSetupTrait, \Drupal\Tests\block\Traits\BlockCreationTrait, \Drupal\FunctionalTests\AssertLegacyTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\node\Traits\NodeCreationTrait, \Drupal\Tests\node\Traits\ContentTypeCreationTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\user\Traits\UserCreationTrait, \Drupal\Tests\XdebugRequestTrait, \Drupal\Tests\PhpunitCompatibilityTrait
- class \Drupal\Tests\contact\Functional\ContactPersonalTest extends \Drupal\Tests\BrowserTestBase uses \Drupal\Core\Test\AssertMailTrait, \Drupal\Tests\system\Functional\Cache\AssertPageCacheContextsAndTagsTrait
Expanded class hierarchy of ContactPersonalTest
File
-
core/
modules/ contact/ tests/ src/ Functional/ ContactPersonalTest.php, line 19
Namespace
Drupal\Tests\contact\FunctionalView source
class ContactPersonalTest extends BrowserTestBase {
use AssertMailTrait;
use AssertPageCacheContextsAndTagsTrait;
/**
* Modules to enable.
*
* @var array
*/
public static $modules = [
'contact',
'dblog',
'mail_html_test',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* A user with some administrative permissions.
*
* @var \Drupal\user\UserInterface
*/
private $adminUser;
/**
* A user with permission to view profiles and access user contact forms.
*
* @var \Drupal\user\UserInterface
*/
private $webUser;
/**
* A user without any permissions.
*
* @var \Drupal\user\UserInterface
*/
private $contactUser;
protected function setUp() {
parent::setUp();
// Create an admin user.
$this->adminUser = $this->drupalCreateUser([
'administer contact forms',
'administer users',
'administer account settings',
'access site reports',
]);
// Create some normal users with their contact forms enabled by default.
$this->config('contact.settings')
->set('user_default_enabled', TRUE)
->save();
$this->webUser = $this->drupalCreateUser([
'access user profiles',
'access user contact forms',
]);
$this->contactUser = $this->drupalCreateUser();
}
/**
* Tests that mails for contact messages are correctly sent.
*/
public function testSendPersonalContactMessage() {
// Ensure that the web user's email needs escaping.
$mail = $this->webUser
->getAccountName() . '&escaped@example.com';
$this->webUser
->setEmail($mail)
->save();
$this->drupalLogin($this->webUser);
$this->drupalGet('user/' . $this->contactUser
->id() . '/contact');
$this->assertEscaped($mail);
$message = $this->submitPersonalContact($this->contactUser);
$mails = $this->getMails();
$this->assertCount(1, $mails);
$mail = $mails[0];
$this->assertEqual($mail['to'], $this->contactUser
->getEmail());
$this->assertEqual($mail['from'], $this->config('system.site')
->get('mail'));
$this->assertEqual($mail['reply-to'], $this->webUser
->getEmail());
$this->assertEqual($mail['key'], 'user_mail');
$variables = [
'@site-name' => $this->config('system.site')
->get('name'),
'@subject' => $message['subject[0][value]'],
'@recipient-name' => $this->contactUser
->getDisplayName(),
];
$subject = PlainTextOutput::renderFromHtml(t('[@site-name] @subject', $variables));
$this->assertEqual($mail['subject'], $subject, 'Subject is in sent message.');
$this->assertStringContainsString('Hello ' . $variables['@recipient-name'], $mail['body'], 'Recipient name is in sent message.');
$this->assertStringContainsString($this->webUser
->getDisplayName(), $mail['body'], 'Sender name is in sent message.');
$this->assertStringContainsString($message['message[0][value]'], $mail['body'], 'Message body is in sent message.');
// Check there was no problems raised during sending.
$this->drupalLogout();
$this->drupalLogin($this->adminUser);
// Verify that the correct watchdog message has been logged.
$this->drupalGet('/admin/reports/dblog');
$placeholders = [
'@sender_name' => $this->webUser->username,
'@sender_email' => $this->webUser
->getEmail(),
'@recipient_name' => $this->contactUser
->getAccountName(),
];
$this->assertRaw(new FormattableMarkup('@sender_name (@sender_email) sent @recipient_name an email.', $placeholders));
// Ensure an unescaped version of the email does not exist anywhere.
$this->assertNoRaw($this->webUser
->getEmail());
// Test HTML mails.
$mail_config = $this->config('system.mail');
$mail_config->set('interface.default', 'test_html_mail_collector');
$mail_config->save();
$this->drupalLogin($this->webUser);
$message['message[0][value]'] = 'This <i>is</i> a more <b>specific</b> <sup>test</sup>, the emails are formatted now.';
$message = $this->submitPersonalContact($this->contactUser, $message);
// Assert mail content.
$this->assertMailString('body', 'Hello ' . $variables['@recipient-name'], 1);
$this->assertMailString('body', $this->webUser
->getDisplayName(), 1);
$this->assertMailString('body', Html::Escape($message['message[0][value]']), 1);
}
/**
* Tests access to the personal contact form.
*/
public function testPersonalContactAccess() {
// Test allowed access to admin user's contact form.
$this->drupalLogin($this->webUser);
$this->drupalGet('user/' . $this->adminUser
->id() . '/contact');
$this->assertSession()
->statusCodeEquals(200);
// Check the page title is properly displayed.
$this->assertRaw(t('Contact @username', [
'@username' => $this->adminUser
->getDisplayName(),
]));
// Test denied access to admin user's own contact form.
$this->drupalLogout();
$this->drupalLogin($this->adminUser);
$this->drupalGet('user/' . $this->adminUser
->id() . '/contact');
$this->assertSession()
->statusCodeEquals(403);
// Test allowed access to user with contact form enabled.
$this->drupalLogin($this->webUser);
$this->drupalGet('user/' . $this->contactUser
->id() . '/contact');
$this->assertSession()
->statusCodeEquals(200);
// Test that there is no access to personal contact forms for users
// without an email address configured.
$original_email = $this->contactUser
->getEmail();
$this->contactUser
->setEmail(FALSE)
->save();
$this->drupalGet('user/' . $this->contactUser
->id() . '/contact');
$this->assertSession()
->statusCodeEquals(404);
// Test that the 'contact tab' does not appear on the user profiles
// for users without an email address configured.
$this->drupalGet('user/' . $this->contactUser
->id());
$contact_link = '/user/' . $this->contactUser
->id() . '/contact';
$this->assertSession()
->statusCodeEquals(200);
$this->assertNoLinkByHref($contact_link, 'The "contact" tab is hidden on profiles for users with no email address');
// Restore original email address.
$this->contactUser
->setEmail($original_email)
->save();
// Test denied access to the user's own contact form.
$this->drupalGet('user/' . $this->webUser
->id() . '/contact');
$this->assertSession()
->statusCodeEquals(403);
// Test always denied access to the anonymous user contact form.
$this->drupalGet('user/0/contact');
$this->assertSession()
->statusCodeEquals(403);
// Test that anonymous users can access the contact form.
$this->drupalLogout();
user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, [
'access user contact forms',
]);
$this->drupalGet('user/' . $this->contactUser
->id() . '/contact');
$this->assertSession()
->statusCodeEquals(200);
// Test that anonymous users can access admin user's contact form.
$this->drupalGet('user/' . $this->adminUser
->id() . '/contact');
$this->assertSession()
->statusCodeEquals(200);
$this->assertCacheContext('user');
// Revoke the personal contact permission for the anonymous user.
user_role_revoke_permissions(RoleInterface::ANONYMOUS_ID, [
'access user contact forms',
]);
$this->drupalGet('user/' . $this->contactUser
->id() . '/contact');
$this->assertSession()
->statusCodeEquals(403);
$this->assertCacheContext('user');
$this->drupalGet('user/' . $this->adminUser
->id() . '/contact');
$this->assertSession()
->statusCodeEquals(403);
// Disable the personal contact form.
$this->drupalLogin($this->adminUser);
$edit = [
'contact_default_status' => FALSE,
];
$this->drupalPostForm('admin/config/people/accounts', $edit, t('Save configuration'));
$this->assertText(t('The configuration options have been saved.'), 'Setting successfully saved.');
$this->drupalLogout();
// Re-create our contacted user with personal contact forms disabled by
// default.
$this->contactUser = $this->drupalCreateUser();
// Test denied access to a user with contact form disabled.
$this->drupalLogin($this->webUser);
$this->drupalGet('user/' . $this->contactUser
->id() . '/contact');
$this->assertSession()
->statusCodeEquals(403);
// Test allowed access for admin user to a user with contact form disabled.
$this->drupalLogin($this->adminUser);
$this->drupalGet('user/' . $this->contactUser
->id() . '/contact');
$this->assertSession()
->statusCodeEquals(200);
// Re-create our contacted user as a blocked user.
$this->contactUser = $this->drupalCreateUser();
$this->contactUser
->block();
$this->contactUser
->save();
// Test that blocked users can still be contacted by admin.
$this->drupalGet('user/' . $this->contactUser
->id() . '/contact');
$this->assertSession()
->statusCodeEquals(200);
// Test that blocked users cannot be contacted by non-admins.
$this->drupalLogin($this->webUser);
$this->drupalGet('user/' . $this->contactUser
->id() . '/contact');
$this->assertSession()
->statusCodeEquals(403);
// Test enabling and disabling the contact page through the user profile
// form.
$this->drupalGet('user/' . $this->webUser
->id() . '/edit');
$this->assertNoFieldChecked('edit-contact--2');
$this->assertNull(\Drupal::service('user.data')->get('contact', $this->webUser
->id(), 'enabled'), 'Personal contact form disabled');
$this->drupalPostForm(NULL, [
'contact' => TRUE,
], t('Save'));
$this->assertFieldChecked('edit-contact--2');
$this->assertNotEmpty(\Drupal::service('user.data')->get('contact', $this->webUser
->id(), 'enabled'), 'Personal contact form enabled');
// Test with disabled global default contact form in combination with a user
// that has the contact form enabled.
$this->config('contact.settings')
->set('user_default_enabled', FALSE)
->save();
$this->contactUser = $this->drupalCreateUser();
\Drupal::service('user.data')->set('contact', $this->contactUser
->id(), 'enabled', 1);
$this->drupalGet('user/' . $this->contactUser
->id() . '/contact');
$this->assertSession()
->statusCodeEquals(200);
}
/**
* Tests the personal contact form flood protection.
*/
public function testPersonalContactFlood() {
$flood_limit = 3;
$this->config('contact.settings')
->set('flood.limit', $flood_limit)
->save();
$this->drupalLogin($this->webUser);
// Submit contact form with correct values and check flood interval.
for ($i = 0; $i < $flood_limit; $i++) {
$this->submitPersonalContact($this->contactUser);
$this->assertText(t('Your message has been sent.'), 'Message sent.');
}
// Submit contact form one over limit.
$this->submitPersonalContact($this->contactUser);
$this->assertRaw(t('You cannot send more than %number messages in @interval. Try again later.', [
'%number' => $flood_limit,
'@interval' => \Drupal::service('date.formatter')->formatInterval($this->config('contact.settings')
->get('flood.interval')),
]), 'Normal user denied access to flooded contact form.');
// Test that the admin user can still access the contact form even though
// the flood limit was reached.
$this->drupalLogin($this->adminUser);
$this->assertNoText('Try again later.', 'Admin user not denied access to flooded contact form.');
}
/**
* Tests the personal contact form based access when an admin adds users.
*/
public function testAdminContact() {
user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, [
'access user contact forms',
]);
$this->checkContactAccess(200);
$this->checkContactAccess(403, FALSE);
$config = $this->config('contact.settings');
$config->set('user_default_enabled', FALSE);
$config->save();
$this->checkContactAccess(403);
}
/**
* Creates a user and then checks contact form access.
*
* @param int $response
* The expected response code.
* @param bool $contact_value
* (optional) The value the contact field should be set too.
*/
protected function checkContactAccess($response, $contact_value = NULL) {
$this->drupalLogin($this->adminUser);
$this->drupalGet('admin/people/create');
if ($this->config('contact.settings')
->get('user_default_enabled', TRUE)) {
$this->assertFieldChecked('edit-contact--2');
}
else {
$this->assertNoFieldChecked('edit-contact--2');
}
$name = $this->randomMachineName();
$edit = [
'name' => $name,
'mail' => $this->randomMachineName() . '@example.com',
'pass[pass1]' => $pass = $this->randomString(),
'pass[pass2]' => $pass,
'notify' => FALSE,
];
if (isset($contact_value)) {
$edit['contact'] = $contact_value;
}
$this->drupalPostForm('admin/people/create', $edit, t('Create new account'));
$user = user_load_by_name($name);
$this->drupalLogout();
$this->drupalGet('user/' . $user->id() . '/contact');
$this->assertSession()
->statusCodeEquals($response);
}
/**
* Fills out a user's personal contact form and submits it.
*
* @param \Drupal\Core\Session\AccountInterface $account
* A user object of the user being contacted.
* @param array $message
* (optional) An array with the form fields being used. Defaults to an empty
* array.
*
* @return array
* An array with the form fields being used.
*/
protected function submitPersonalContact(AccountInterface $account, array $message = []) {
$message += [
'subject[0][value]' => $this->randomMachineName(16) . '< " =+ >',
'message[0][value]' => $this->randomMachineName(64) . '< " =+ >',
];
$this->drupalPostForm('user/' . $account->id() . '/contact', $message, t('Send message'));
return $message;
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|---|
AssertHelperTrait::castSafeStrings | protected static | function | Casts MarkupInterface objects into strings. | ||||
AssertLegacyTrait::assert | protected | function | |||||
AssertLegacyTrait::assertCacheTag | protected | function | Asserts whether an expected cache tag was present in the last response. | ||||
AssertLegacyTrait::assertElementNotPresent | protected | function | Asserts that the element with the given CSS selector is not present. | ||||
AssertLegacyTrait::assertElementPresent | protected | function | Asserts that the element with the given CSS selector is present. | ||||
AssertLegacyTrait::assertEqual | protected | function | |||||
AssertLegacyTrait::assertEscaped | protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | ||||
AssertLegacyTrait::assertField | protected | function | Asserts that a field exists with the given name or ID. | ||||
AssertLegacyTrait::assertFieldById | protected | function | Asserts that a field exists with the given ID and value. | ||||
AssertLegacyTrait::assertFieldByName | protected | function | Asserts that a field exists with the given name and value. | ||||
AssertLegacyTrait::assertFieldByXPath | protected | function | Asserts that a field exists in the current page by the given XPath. | ||||
AssertLegacyTrait::assertFieldChecked | protected | function | Asserts that a checkbox field in the current page is checked. | ||||
AssertLegacyTrait::assertFieldsByValue | protected | function | Asserts that a field exists in the current page with a given Xpath result. | ||||
AssertLegacyTrait::assertHeader | protected | function | Checks that current response header equals value. | ||||
AssertLegacyTrait::assertIdentical | protected | function | |||||
AssertLegacyTrait::assertIdenticalObject | protected | function | |||||
AssertLegacyTrait::assertLink | protected | function | Passes if a link with the specified label is found. | ||||
AssertLegacyTrait::assertLinkByHref | protected | function | Passes if a link containing a given href (part) is found. | ||||
AssertLegacyTrait::assertNoCacheTag | protected | function | Asserts whether an expected cache tag was absent in the last response. | ||||
AssertLegacyTrait::assertNoEscaped | protected | function | Passes if the raw text is not found escaped on the loaded page. | ||||
AssertLegacyTrait::assertNoField | protected | function | Asserts that a field does NOT exist with the given name or ID. | ||||
AssertLegacyTrait::assertNoFieldById | protected | function | Asserts that a field does not exist with the given ID and value. | ||||
AssertLegacyTrait::assertNoFieldByName | protected | function | Asserts that a field does not exist with the given name and value. | ||||
AssertLegacyTrait::assertNoFieldByXPath | protected | function | Asserts that a field does not exist or its value does not match, by XPath. | ||||
AssertLegacyTrait::assertNoFieldChecked | protected | function | Asserts that a checkbox field in the current page is not checked. | ||||
AssertLegacyTrait::assertNoLink | protected | function | Passes if a link with the specified label is not found. | ||||
AssertLegacyTrait::assertNoLinkByHref | protected | function | Passes if a link containing a given href (part) is not found. | ||||
AssertLegacyTrait::assertNoOption | protected | function | Asserts that a select option does NOT exist in the current page. | ||||
AssertLegacyTrait::assertNoPattern | protected | function | Triggers a pass if the Perl regex pattern is not found in the raw content. | ||||
AssertLegacyTrait::assertNoRaw | protected | function | Passes if the raw text IS not found on the loaded page, fail otherwise. | 1 | |||
AssertLegacyTrait::assertNotEqual | protected | function | |||||
AssertLegacyTrait::assertNoText | protected | function | Passes if the page (with HTML stripped) does not contains the text. | 1 | |||
AssertLegacyTrait::assertNotIdentical | protected | function | |||||
AssertLegacyTrait::assertNoUniqueText | protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | ||||
AssertLegacyTrait::assertOption | protected | function | Asserts that a select option in the current page exists. | ||||
AssertLegacyTrait::assertOptionByText | protected | function | Asserts that a select option with the visible text exists. | ||||
AssertLegacyTrait::assertOptionSelected | protected | function | Asserts that a select option in the current page is checked. | ||||
AssertLegacyTrait::assertPattern | protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | ||||
AssertLegacyTrait::assertRaw | protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | 1 | |||
AssertLegacyTrait::assertResponse | protected | function | Asserts the page responds with the specified response code. | 1 | |||
AssertLegacyTrait::assertText | protected | function | Passes if the page (with HTML stripped) contains the text. | 1 | |||
AssertLegacyTrait::assertTextHelper | protected | function | Helper for assertText and assertNoText. | ||||
AssertLegacyTrait::assertTitle | protected | function | Pass if the page title is the given string. | ||||
AssertLegacyTrait::assertUniqueText | protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | ||||
AssertLegacyTrait::assertUrl | protected | function | Passes if the internal browser's URL matches the given path. | ||||
AssertLegacyTrait::buildXPathQuery | protected | function | Builds an XPath query. | ||||
AssertLegacyTrait::constructFieldXpath | protected | function | Helper: Constructs an XPath for the given set of attributes and value. | ||||
AssertLegacyTrait::getAllOptions | protected | function | Get all option elements, including nested options, in a select. | ||||
AssertLegacyTrait::getRawContent | protected | function | Gets the current raw content. | ||||
AssertLegacyTrait::pass | protected | function | |||||
AssertLegacyTrait::verbose | protected | function | |||||
AssertMailTrait::assertMail | protected | function | Asserts that the most recently sent email message has the given value. | ||||
AssertMailTrait::assertMailPattern | protected | function | Asserts that the most recently sent email message has the pattern in it. | ||||
AssertMailTrait::assertMailString | protected | function | Asserts that the most recently sent email message has the string in it. | ||||
AssertMailTrait::getMails | protected | function | Gets an array containing all emails sent during this test case. | ||||
AssertMailTrait::verboseEmail | protected | function | Outputs to verbose the most recent $count emails sent. | ||||
AssertPageCacheContextsAndTagsTrait::assertCacheContext | protected | function | Asserts whether an expected cache context was present in the last response. | ||||
AssertPageCacheContextsAndTagsTrait::assertCacheContexts | protected | function | Ensures that some cache contexts are present in the current response. | ||||
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge | protected | function | Asserts the max age header. | ||||
AssertPageCacheContextsAndTagsTrait::assertCacheTags | protected | function | Ensures that some cache tags are present in the current response. | ||||
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext | protected | function | Asserts that a cache context was not present in the last response. | ||||
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags | protected | function | Asserts page cache miss, then hit for the given URL; checks cache headers. | ||||
AssertPageCacheContextsAndTagsTrait::enablePageCaching | protected | function | Enables page caching. | ||||
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues | protected | function | Gets a specific header value as array. | ||||
BlockCreationTrait::placeBlock | protected | function | Creates a block instance based on default settings. | Aliased as: drupalPlaceBlock | |||
BrowserHtmlDebugTrait::$htmlOutputBaseUrl | protected | property | The Base URI to use for links to the output files. | ||||
BrowserHtmlDebugTrait::$htmlOutputClassName | protected | property | Class name for HTML output logging. | ||||
BrowserHtmlDebugTrait::$htmlOutputCounter | protected | property | Counter for HTML output logging. | ||||
BrowserHtmlDebugTrait::$htmlOutputCounterStorage | protected | property | Counter storage for HTML output logging. | ||||
BrowserHtmlDebugTrait::$htmlOutputDirectory | protected | property | Directory name for HTML output logging. | ||||
BrowserHtmlDebugTrait::$htmlOutputEnabled | protected | property | HTML output output enabled. | ||||
BrowserHtmlDebugTrait::$htmlOutputFile | protected | property | The file name to write the list of URLs to. | ||||
BrowserHtmlDebugTrait::$htmlOutputTestId | protected | property | HTML output test ID. | ||||
BrowserHtmlDebugTrait::formatHtmlOutputHeaders | protected | function | Formats HTTP headers as string for HTML output logging. | ||||
BrowserHtmlDebugTrait::getHtmlOutputHeaders | protected | function | Returns headers in HTML output format. | 1 | |||
BrowserHtmlDebugTrait::htmlOutput | protected | function | Logs a HTML output message in a text file. | ||||
BrowserHtmlDebugTrait::initBrowserOutputFile | protected | function | Creates the directory to store browser output. | ||||
BrowserTestBase::$baseUrl | protected | property | The base URL. | ||||
BrowserTestBase::$configImporter | protected | property | The config importer that can be used in a test. | ||||
BrowserTestBase::$customTranslations | protected | property | An array of custom translations suitable for drupal_rewrite_settings(). | ||||
BrowserTestBase::$databasePrefix | protected | property | The database prefix of this test run. | ||||
BrowserTestBase::$mink | protected | property | Mink session manager. | ||||
BrowserTestBase::$minkDefaultDriverArgs | protected | property | |||||
BrowserTestBase::$minkDefaultDriverClass | protected | property | 1 | ||||
BrowserTestBase::$originalContainer | protected | property | The original container. | ||||
BrowserTestBase::$originalShutdownCallbacks | protected | property | The original array of shutdown function callbacks. | ||||
BrowserTestBase::$preserveGlobalState | protected | property | |||||
BrowserTestBase::$profile | protected | property | The profile to install as a basis for testing. | 39 | |||
BrowserTestBase::$root | protected | property | The app root. | ||||
BrowserTestBase::$runTestInSeparateProcess | protected | property | Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests. |
||||
BrowserTestBase::$timeLimit | protected | property | Time limit in seconds for the test. | ||||
BrowserTestBase::$translationFilesDirectory | protected | property | The translation file directory for the test environment. | ||||
BrowserTestBase::cleanupEnvironment | protected | function | Clean up the Simpletest environment. | ||||
BrowserTestBase::config | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | ||||
BrowserTestBase::cssSelectToXpath | protected | function | Translates a CSS expression to its XPath equivalent. | ||||
BrowserTestBase::drupalGetHeader | protected | function | Gets the value of an HTTP response header. | ||||
BrowserTestBase::drupalGetHeaders | Deprecated | protected | function | Returns all response headers. | |||
BrowserTestBase::filePreDeleteCallback | public static | function | Ensures test files are deletable. | ||||
BrowserTestBase::getDefaultDriverInstance | protected | function | Gets an instance of the default Mink driver. | ||||
BrowserTestBase::getDrupalSettings | protected | function | Gets the JavaScript drupalSettings variable for the currently-loaded page. | 1 | |||
BrowserTestBase::getHttpClient | protected | function | Obtain the HTTP client for the system under test. | ||||
BrowserTestBase::getMinkDriverArgs | protected | function | Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. |
1 | |||
BrowserTestBase::getOptions | protected | function | Helper function to get the options of select field. | ||||
BrowserTestBase::getResponseLogHandler | protected | function | Provides a Guzzle middleware handler to log every response received. | Overrides BrowserHtmlDebugTrait::getResponseLogHandler | |||
BrowserTestBase::getSession | public | function | Returns Mink session. | ||||
BrowserTestBase::getSessionCookies | protected | function | Get session cookies from current session. | ||||
BrowserTestBase::getTestMethodCaller | protected | function | Retrieves the current calling line in the class under test. | Overrides BrowserHtmlDebugTrait::getTestMethodCaller | |||
BrowserTestBase::initFrontPage | protected | function | Visits the front page when initializing Mink. | 3 | |||
BrowserTestBase::initMink | protected | function | Initializes Mink sessions. | 1 | |||
BrowserTestBase::installDrupal | public | function | Installs Drupal into the Simpletest site. | 1 | |||
BrowserTestBase::registerSessions | protected | function | Registers additional Mink sessions. | ||||
BrowserTestBase::tearDown | protected | function | 3 | ||||
BrowserTestBase::translatePostValues | protected | function | Transforms a nested array into a flat array suitable for drupalPostForm(). | ||||
BrowserTestBase::xpath | protected | function | Performs an xpath search on the contents of the internal browser. | ||||
BrowserTestBase::__construct | public | function | 1 | ||||
BrowserTestBase::__sleep | public | function | Prevents serializing any properties. | ||||
ConfigTestTrait::configImporter | protected | function | Returns a ConfigImporter object to import test configuration. | ||||
ConfigTestTrait::copyConfig | protected | function | Copies configuration objects from source storage to target storage. | ||||
ContactPersonalTest::$adminUser | private | property | A user with some administrative permissions. | ||||
ContactPersonalTest::$contactUser | private | property | A user without any permissions. | ||||
ContactPersonalTest::$defaultTheme | protected | property | The theme to install as the default for testing. | Overrides BrowserTestBase::$defaultTheme | |||
ContactPersonalTest::$modules | public static | property | Modules to enable. | Overrides BrowserTestBase::$modules | |||
ContactPersonalTest::$webUser | private | property | A user with permission to view profiles and access user contact forms. | ||||
ContactPersonalTest::checkContactAccess | protected | function | Creates a user and then checks contact form access. | ||||
ContactPersonalTest::setUp | protected | function | Overrides BrowserTestBase::setUp | ||||
ContactPersonalTest::submitPersonalContact | protected | function | Fills out a user's personal contact form and submits it. | ||||
ContactPersonalTest::testAdminContact | public | function | Tests the personal contact form based access when an admin adds users. | ||||
ContactPersonalTest::testPersonalContactAccess | public | function | Tests access to the personal contact form. | ||||
ContactPersonalTest::testPersonalContactFlood | public | function | Tests the personal contact form flood protection. | ||||
ContactPersonalTest::testSendPersonalContactMessage | public | function | Tests that mails for contact messages are correctly sent. | ||||
ContentTypeCreationTrait::createContentType | protected | function | Creates a custom content type based on default settings. | Aliased as: drupalCreateContentType | 1 | ||
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix | protected | property | The flag to set 'apcu_ensure_unique_prefix' setting. | 1 | |||
FunctionalTestSetupTrait::$classLoader | protected | property | The class loader to use for installation and initialization of setup. | ||||
FunctionalTestSetupTrait::$configDirectories | Deprecated | protected | property | The config directories used in this test. | |||
FunctionalTestSetupTrait::$rootUser | protected | property | The "#1" admin user. | ||||
FunctionalTestSetupTrait::doInstall | protected | function | Execute the non-interactive installer. | 1 | |||
FunctionalTestSetupTrait::getDatabaseTypes | protected | function | Returns all supported database driver installer objects. | ||||
FunctionalTestSetupTrait::initConfig | protected | function | Initialize various configurations post-installation. | 2 | |||
FunctionalTestSetupTrait::initKernel | protected | function | Initializes the kernel after installation. | ||||
FunctionalTestSetupTrait::initSettings | protected | function | Initialize settings created during install. | ||||
FunctionalTestSetupTrait::initUserSession | protected | function | Initializes user 1 for the site to be installed. | ||||
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty | protected | function | Installs the default theme defined by `static::$defaultTheme` when needed. | ||||
FunctionalTestSetupTrait::installModulesFromClassProperty | protected | function | Install modules defined by `static::$modules`. | 1 | |||
FunctionalTestSetupTrait::installParameters | protected | function | Returns the parameters that will be used when Simpletest installs Drupal. | 9 | |||
FunctionalTestSetupTrait::prepareEnvironment | protected | function | Prepares the current environment for running the test. | 23 | |||
FunctionalTestSetupTrait::prepareRequestForGenerator | protected | function | Creates a mock request and sets it on the generator. | ||||
FunctionalTestSetupTrait::prepareSettings | protected | function | Prepares site settings and services before installation. | 2 | |||
FunctionalTestSetupTrait::rebuildAll | protected | function | Resets and rebuilds the environment after setup. | ||||
FunctionalTestSetupTrait::rebuildContainer | protected | function | Rebuilds \Drupal::getContainer(). | ||||
FunctionalTestSetupTrait::resetAll | protected | function | Resets all data structures after having enabled new modules. | ||||
FunctionalTestSetupTrait::setContainerParameter | protected | function | Changes parameters in the services.yml file. | ||||
FunctionalTestSetupTrait::setupBaseUrl | protected | function | Sets up the base URL based upon the environment variable. | ||||
FunctionalTestSetupTrait::writeSettings | protected | function | Rewrites the settings.php file of the test site. | ||||
NodeCreationTrait::createNode | protected | function | Creates a node based on default settings. | Aliased as: drupalCreateNode | |||
NodeCreationTrait::getNodeByTitle | public | function | Get a node from the database based on its title. | Aliased as: drupalGetNodeByTitle | |||
PhpunitCompatibilityTrait::getMock | Deprecated | public | function | Returns a mock object for the specified class using the available method. | |||
PhpunitCompatibilityTrait::setExpectedException | Deprecated | public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | |||
RandomGeneratorTrait::$randomGenerator | protected | property | The random generator. | ||||
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | ||||
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | 1 | |||
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | ||||
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | ||||
RandomGeneratorTrait::randomStringValidate | public | function | Callback for random string validation. | ||||
RefreshVariablesTrait::refreshVariables | protected | function | Refreshes in-memory configuration and state information. | 3 | |||
SessionTestTrait::$sessionName | protected | property | The name of the session cookie. | ||||
SessionTestTrait::generateSessionName | protected | function | Generates a session cookie name. | ||||
SessionTestTrait::getSessionName | protected | function | Returns the session name in use on the child site. | ||||
StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | ||||
TestRequirementsTrait::checkModuleRequirements | private | function | Checks missing module requirements. | ||||
TestRequirementsTrait::checkRequirements | protected | function | Check module requirements for the Drupal use case. | 1 | |||
TestRequirementsTrait::getDrupalRoot | protected static | function | Returns the Drupal root directory. | ||||
TestSetupTrait::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | ||||
TestSetupTrait::$container | protected | property | The dependency injection container used in the test. | ||||
TestSetupTrait::$kernel | protected | property | The DrupalKernel instance used in the test. | ||||
TestSetupTrait::$originalSite | protected | property | The site directory of the original parent site. | ||||
TestSetupTrait::$privateFilesDirectory | protected | property | The private file directory for the test environment. | ||||
TestSetupTrait::$publicFilesDirectory | protected | property | The public file directory for the test environment. | ||||
TestSetupTrait::$siteDirectory | protected | property | The site directory of this test run. | ||||
TestSetupTrait::$strictConfigSchema | protected | property | Set to TRUE to strict check all configuration saved. | 2 | |||
TestSetupTrait::$tempFilesDirectory | protected | property | The temporary file directory for the test environment. | ||||
TestSetupTrait::$testId | protected | property | The test run ID. | ||||
TestSetupTrait::changeDatabasePrefix | protected | function | Changes the database connection to the prefixed one. | ||||
TestSetupTrait::getConfigSchemaExclusions | protected | function | Gets the config schema exclusions for this test. | ||||
TestSetupTrait::getDatabaseConnection | public static | function | Returns the database connection to the site running Simpletest. | ||||
TestSetupTrait::prepareDatabasePrefix | protected | function | Generates a database prefix for running tests. | 2 | |||
UiHelperTrait::$loggedInUser | protected | property | The current user logged in using the Mink controlled browser. | ||||
UiHelperTrait::$maximumMetaRefreshCount | protected | property | The number of meta refresh redirects to follow, or NULL if unlimited. | ||||
UiHelperTrait::$metaRefreshCount | protected | property | The number of meta refresh redirects followed during ::drupalGet(). | ||||
UiHelperTrait::assertSession | public | function | Returns WebAssert object. | 1 | |||
UiHelperTrait::buildUrl | protected | function | Builds an a absolute URL from a system path or a URL object. | ||||
UiHelperTrait::checkForMetaRefresh | protected | function | Checks for meta refresh tag and if found call drupalGet() recursively. | ||||
UiHelperTrait::click | protected | function | Clicks the element with the given CSS selector. | ||||
UiHelperTrait::clickLink | protected | function | Follows a link by complete name. | ||||
UiHelperTrait::cssSelect | protected | function | Searches elements using a CSS selector in the raw content. | ||||
UiHelperTrait::drupalGet | protected | function | Retrieves a Drupal path or an absolute path. | 3 | |||
UiHelperTrait::drupalLogin | protected | function | Logs in a user using the Mink controlled browser. | ||||
UiHelperTrait::drupalLogout | protected | function | Logs a user out of the Mink controlled browser and confirms. | ||||
UiHelperTrait::drupalPostForm | protected | function | Executes a form submission. | ||||
UiHelperTrait::drupalUserIsLoggedIn | protected | function | Returns whether a given user account is logged in. | ||||
UiHelperTrait::getAbsoluteUrl | protected | function | Takes a path and returns an absolute path. | ||||
UiHelperTrait::getTextContent | protected | function | Retrieves the plain-text content from the current page. | ||||
UiHelperTrait::getUrl | protected | function | Get the current URL from the browser. | ||||
UiHelperTrait::prepareRequest | protected | function | Prepare for a request to testing site. | 1 | |||
UiHelperTrait::submitForm | protected | function | Fills and submits a form. | ||||
UserCreationTrait::checkPermissions | protected | function | Checks whether a given list of permission names is valid. | ||||
UserCreationTrait::createAdminRole | protected | function | Creates an administrative role. | ||||
UserCreationTrait::createRole | protected | function | Creates a role with specified permissions. | 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.