first commit

This commit is contained in:
2024-07-15 12:33:27 +02:00
commit ce50ae282b
22084 changed files with 2623791 additions and 0 deletions

View File

@@ -0,0 +1,34 @@
<?php
/**
* @file
* Database additions for Drupal\contact\Tests\ContactUpgradePathTest.
*
* This dump only contains data for the contact module. The
* drupal-7.filled.bare.php file is imported before this dump, so the two form
* the database structure expected in tests altogether.
*/
$connection = \Drupal::database();
// Update the default category to that it is not selected.
$connection->update('contact')
->fields(['selected' => '0'])
->condition('cid', '1')
->execute();
// Add a custom contact category.
$connection->insert('contact')->fields([
'category',
'recipients',
'reply',
'weight',
'selected',
])
->values([
'category' => 'Upgrade test',
'recipients' => 'test1@example.com,test2@example.com',
'reply' => 'Test reply',
'weight' => 1,
'selected' => 1,
])
->execute();

View File

@@ -0,0 +1,13 @@
name: 'Contact test storage'
type: module
description: 'Tests that contact messages can be stored.'
package: Testing
# version: VERSION
dependencies:
- drupal:contact
- drupal:user
# Information added by Drupal.org packaging script on 2024-07-04
version: '10.3.1'
project: 'drupal'
datestamp: 1720094222

View File

@@ -0,0 +1,28 @@
<?php
/**
* @file
* Contains install and update hooks.
*/
use Drupal\Core\Entity\Sql\SqlContentEntityStorage;
/**
* Implements hook_install().
*/
function contact_storage_test_install() {
$entity_definition_update_manager = \Drupal::entityDefinitionUpdateManager();
$original = $entity_definition_update_manager->getEntityType('contact_message');
$entity_definition_update_manager->uninstallEntityType($original);
// Update the entity type definition and make it use the default SQL storage.
// @see contact_storage_test_entity_type_alter()
$entity_type = clone $original;
$entity_type->setStorageClass(SqlContentEntityStorage::class);
$keys = $entity_type->getKeys();
$keys['id'] = 'id';
$entity_type->set('entity_keys', $keys);
$entity_type->set('base_table', 'contact_message');
$entity_definition_update_manager->installEntityType($entity_type);
}

View File

@@ -0,0 +1,66 @@
<?php
/**
* @file
* Contains custom contact message functionality for ContactStorageTest.
*/
use Drupal\contact\ContactFormInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Form\FormStateInterface;
/**
* Implements hook_entity_base_field_info().
*/
function contact_storage_test_entity_base_field_info(EntityTypeInterface $entity_type) {
if ($entity_type->id() == 'contact_message') {
$fields = [];
$fields['id'] = BaseFieldDefinition::create('integer')
->setLabel(t('Message ID'))
->setDescription(t('The message ID.'))
->setReadOnly(TRUE)
->setSetting('unsigned', TRUE);
return $fields;
}
}
/**
* Implements hook_entity_type_alter().
*/
function contact_storage_test_entity_type_alter(array &$entity_types) {
/** @var \Drupal\Core\Entity\EntityTypeInterface[] $entity_types */
// Set the controller class for nodes to an alternate implementation of the
// Drupal\Core\Entity\EntityStorageInterface interface.
$entity_types['contact_message']->setStorageClass('\Drupal\Core\Entity\Sql\SqlContentEntityStorage');
$keys = $entity_types['contact_message']->getKeys();
$keys['id'] = 'id';
$entity_types['contact_message']->set('entity_keys', $keys);
$entity_types['contact_message']->set('base_table', 'contact_message');
}
/**
* Implements hook_form_FORM_ID_alter() for contact_form_form().
*/
function contact_storage_test_form_contact_form_form_alter(&$form, FormStateInterface $form_state) {
/** @var \Drupal\contact\ContactFormInterface $contact_form */
$contact_form = $form_state->getFormObject()->getEntity();
$form['send_a_pony'] = [
'#type' => 'checkbox',
'#title' => t('Send submitters a voucher for a free pony.'),
'#description' => t('Enable to send an additional email with a free pony voucher to anyone who submits the form.'),
'#default_value' => $contact_form->getThirdPartySetting('contact_storage_test', 'send_a_pony', FALSE),
];
$form['#entity_builders'][] = 'contact_storage_test_contact_form_form_builder';
}
/**
* Entity builder for the contact form edit form with third party options.
*
* @see contact_storage_test_form_contact_form_edit_form_alter()
*/
function contact_storage_test_contact_form_form_builder($entity_type, ContactFormInterface $contact_form, &$form, FormStateInterface $form_state) {
$contact_form->setThirdPartySetting('contact_storage_test', 'send_a_pony', $form_state->getValue('send_a_pony'));
}

View File

@@ -0,0 +1,12 @@
name: 'Contact test module'
type: module
description: 'Contains test contact form.'
package: Testing
# version: VERSION
dependencies:
- drupal:contact
# Information added by Drupal.org packaging script on 2024-07-04
version: '10.3.1'
project: 'drupal'
datestamp: 1720094222

View File

@@ -0,0 +1,14 @@
name: 'Contact test views'
type: module
description: 'Provides default views for views contact tests.'
package: Testing
# version: VERSION
dependencies:
- drupal:contact
- drupal:views
- drupal:user
# Information added by Drupal.org packaging script on 2024-07-04
version: '10.3.1'
project: 'drupal'
datestamp: 1720094222

View File

@@ -0,0 +1,148 @@
langcode: en
status: true
dependencies:
module:
- contact
- user
id: test_contact_link
label: test_contact_link
module: views
description: ''
tag: ''
base_table: users_field_data
base_field: uid
display:
default:
display_plugin: default
id: default
display_title: Default
position: 1
display_options:
access:
type: none
cache:
type: tag
options: { }
query:
type: views_query
options:
disable_sql_rewrite: false
distinct: false
replica: false
query_comment: ''
query_tags: { }
exposed_form:
type: basic
options:
submit_button: Apply
reset_button: false
reset_button_label: Reset
exposed_sorts_label: 'Sort by'
expose_sort_order: true
sort_asc_label: Asc
sort_desc_label: Desc
pager:
type: full
options:
items_per_page: 10
offset: 0
id: 0
total_pages: null
expose:
items_per_page: false
items_per_page_label: 'Items per page'
items_per_page_options: '5, 10, 20, 40, 60'
items_per_page_options_all: false
items_per_page_options_all_label: '- All -'
offset: false
offset_label: Offset
tags:
previous: ' Previous'
next: 'Next '
first: '« First'
last: 'Last »'
quantity: 9
style:
type: default
row:
type: fields
fields:
name:
id: name
table: users_field_data
field: name
label: ''
alter:
alter_text: false
make_link: false
absolute: false
trim: false
word_boundary: false
ellipsis: false
strip_tags: false
html: false
hide_empty: false
empty_zero: false
relationship: none
group_type: group
admin_label: ''
exclude: false
element_type: ''
element_class: ''
element_label_type: ''
element_label_class: ''
element_label_colon: true
element_wrapper_type: ''
element_wrapper_class: ''
element_default_classes: true
empty: ''
hide_alter_empty: true
plugin_id: field
type: user_name
entity_type: user
entity_field: name
contact:
id: contact
table: users
field: contact
plugin_id: contact_link
exclude: false
entity_type: user
filters:
status:
value: '1'
table: users_field_data
field: status
id: status
expose:
operator: '0'
group: 1
plugin_id: boolean
entity_type: user
entity_field: status
sorts: { }
title: test_contact_link
header: { }
footer: { }
empty: { }
relationships: { }
arguments: { }
display_extenders: { }
cache_metadata:
contexts:
- 'languages:language_content'
- 'languages:language_interface'
max-age: 0
page_1:
display_plugin: page
id: page_1
display_title: Page
position: 1
display_options:
display_extenders: { }
path: test-contact-link
cache_metadata:
contexts:
- 'languages:language_content'
- 'languages:language_interface'
max-age: 0

View File

@@ -0,0 +1,71 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional;
use Drupal\Tests\BrowserTestBase;
use Drupal\Tests\language\Traits\LanguageTestTrait;
/**
* Tests contact messages with language module.
*
* This is to ensure that a contact form by default does not show the language
* select, but it does so when it's enabled from the content language settings
* page.
*
* @group contact
*/
class ContactLanguageTest extends BrowserTestBase {
use LanguageTestTrait;
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = [
'contact',
'language',
'contact_test',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* {@inheritdoc}
*/
protected function setUp(): void {
parent::setUp();
// Create and log in administrative user.
$admin_user = $this->drupalCreateUser([
'access site-wide contact form',
'administer languages',
]);
$this->drupalLogin($admin_user);
}
/**
* Tests configuration options with language enabled.
*/
public function testContactLanguage(): void {
// Ensure that contact form by default does not show the language select.
$this->drupalGet('contact');
$this->assertSession()->statusCodeEquals(200);
$this->assertSession()->fieldNotExists('edit-langcode-0-value');
// Enable translations for feedback contact messages.
static::enableBundleTranslation('contact_message', 'feedback');
// Ensure that contact form now shows the language select.
$this->drupalGet('contact');
$this->assertSession()->statusCodeEquals(200);
$this->assertSession()->fieldExists('edit-langcode-0-value');
}
}

View File

@@ -0,0 +1,402 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Component\Utility\Html;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\Test\AssertMailTrait;
use Drupal\Tests\BrowserTestBase;
use Drupal\Tests\system\Functional\Cache\AssertPageCacheContextsAndTagsTrait;
use Drupal\user\RoleInterface;
/**
* Tests personal contact form functionality.
*
* @group contact
*/
class ContactPersonalTest extends BrowserTestBase {
use AssertMailTrait;
use AssertPageCacheContextsAndTagsTrait;
/**
* Modules to enable.
*
* @var array
*/
protected 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;
/**
* {@inheritdoc}
*/
protected function setUp(): void {
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(): void {
// 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->assertSession()->assertEscaped($mail);
$message = $this->submitPersonalContact($this->contactUser);
$mails = $this->getMails();
$this->assertCount(1, $mails);
$mail = $mails[0];
$this->assertEquals($this->contactUser->getEmail(), $mail['to']);
$this->assertEquals($this->config('system.site')->get('mail'), $mail['from']);
$this->assertEquals($this->webUser->getEmail(), $mail['reply-to']);
$this->assertEquals('user_mail', $mail['key']);
$subject = '[' . $this->config('system.site')->get('name') . '] ' . $message['subject[0][value]'];
$this->assertEquals($subject, $mail['subject'], 'Subject is in sent message.');
$this->assertStringContainsString('Hello ' . $this->contactUser->getDisplayName(), $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->getAccountName(),
'@sender_email' => $this->webUser->getEmail(),
'@recipient_name' => $this->contactUser->getAccountName(),
];
$this->assertSession()->responseContains(new FormattableMarkup('@sender_name (@sender_email) sent @recipient_name an email.', $placeholders));
// Ensure an unescaped version of the email does not exist anywhere.
$this->assertSession()->responseNotContains($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 ' . $this->contactUser->getDisplayName(), 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(): void {
// 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->assertSession()->pageTextContains('Contact ' . $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->assertSession()->linkByHrefNotExists($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->drupalGet('admin/config/people/accounts');
$this->submitForm($edit, 'Save configuration');
$this->assertSession()->pageTextContains('The configuration options have been 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->assertSession()->checkboxNotChecked('edit-contact--2');
$this->assertNull(\Drupal::service('user.data')->get('contact', $this->webUser->id(), 'enabled'), 'Personal contact form disabled');
$this->submitForm(['contact' => TRUE], 'Save');
$this->assertSession()->checkboxChecked('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(): void {
$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->assertSession()->pageTextContains('Your message has been sent.');
}
// Submit contact form one over limit.
$this->submitPersonalContact($this->contactUser);
// Normal user should be denied access to flooded contact form.
$interval = \Drupal::service('date.formatter')->formatInterval($this->config('contact.settings')->get('flood.interval'));
$this->assertSession()->pageTextContains("You cannot send more than 3 messages in {$interval}. Try again later.");
// Test that the admin user can still access the contact form even though
// the flood limit was reached.
$this->drupalLogin($this->adminUser);
$this->assertSession()->pageTextNotContains('Try again later.');
}
/**
* Tests the personal contact form based access when an admin adds users.
*/
public function testAdminContact(): void {
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->assertSession()->checkboxChecked('edit-contact--2');
}
else {
$this->assertSession()->checkboxNotChecked('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->drupalGet('admin/people/create');
$this->submitForm($edit, '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.
* @param bool $user_copy
* (optional) A boolean to determine whether to send a user copy email.
* Defaults to FALSE.
*
* @return array
* An array with the form fields being used.
*/
protected function submitPersonalContact(AccountInterface $account, array $message = [], bool $user_copy = FALSE) {
$message += [
'subject[0][value]' => $this->randomMachineName(16) . '< " =+ >',
'message[0][value]' => $this->randomMachineName(64) . '< " =+ >',
'copy' => $user_copy,
];
$this->drupalGet('user/' . $account->id() . '/contact');
$this->submitForm($message, 'Send message');
return $message;
}
/**
* Tests that the opt-out message is included correctly in contact emails.
*/
public function testPersonalContactForm(): void {
$opt_out_message = "If you don't want to receive such messages, you can change your settings at";
// Send an email from an admin (should not contain the opt-out message).
$this->drupalLogin($this->adminUser);
$this->submitPersonalContact($this->contactUser);
$this->drupalLogout();
$this->assertStringNotContainsString($opt_out_message, $this->getMails()[0]['body'], 'Opt-out message excluded in email.');
// Send an email from a non-admin (should contain the opt-out message).
$this->drupalLogin($this->webUser);
$this->submitPersonalContact($this->contactUser);
$this->assertMailString('body', $opt_out_message, 1, 'Opt-out message included in email.');
}
/**
* Tests that the opt-out message is not included in user copy emails.
*/
public function testPersonalContactFormUserCopy(): void {
$opt_out_message = "If you don't want to receive such messages, you can change your settings at";
// Send an email from an admin.
$this->drupalLogin($this->adminUser);
$this->submitPersonalContact($this->contactUser, [], TRUE);
$this->drupalLogout();
// Send an email from a non-admin.
$this->drupalLogin($this->webUser);
$this->submitPersonalContact($this->contactUser, [], TRUE);
$user_copy_emails = $this->getMails(['id' => 'contact_user_copy']);
// Tests that the opt-out message is not included in admin user copy emails.
$this->assertStringNotContainsString($opt_out_message, $user_copy_emails[0]['body'], 'Opt-out message not included in admin user copy email.');
// Tests that the opt-out message is not included in non-admin user copy emails.
$this->assertStringNotContainsString($opt_out_message, $user_copy_emails[1]['body'], 'Opt-out message not included in non-admin user copy email.');
}
}

View File

@@ -0,0 +1,625 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional;
use Drupal\Core\Url;
use Drupal\contact\Entity\ContactForm;
use Drupal\Core\Mail\MailFormatHelper;
use Drupal\Core\Test\AssertMailTrait;
use Drupal\Tests\BrowserTestBase;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Tests\field_ui\Traits\FieldUiTestTrait;
use Drupal\user\RoleInterface;
/**
* Tests site-wide contact form functionality.
*
* @see \Drupal\Tests\contact\Functional\ContactStorageTest
*
* @group contact
*/
class ContactSitewideTest extends BrowserTestBase {
use FieldUiTestTrait;
use AssertMailTrait;
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = [
'text',
'contact',
'field_ui',
'contact_test',
'block',
'error_service_test',
'dblog',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* {@inheritdoc}
*/
protected function setUp(): void {
parent::setUp();
$this->drupalPlaceBlock('system_breadcrumb_block');
$this->drupalPlaceBlock('local_tasks_block');
$this->drupalPlaceBlock('local_actions_block');
$this->drupalPlaceBlock('page_title_block');
}
/**
* Tests configuration options and the site-wide contact form.
*/
public function testSiteWideContact(): void {
// Tests name and email fields for authenticated and anonymous users.
$this->drupalLogin($this->drupalCreateUser([
'access site-wide contact form',
]));
$this->drupalGet('contact');
// Ensure that there is no textfield for name.
$this->assertSession()->fieldNotExists('name');
// Ensure that there is no textfield for email.
$this->assertSession()->fieldNotExists('mail');
// Logout and retrieve the page as an anonymous user
$this->drupalLogout();
user_role_grant_permissions('anonymous', ['access site-wide contact form']);
$this->drupalGet('contact');
// Ensure that there is textfield for name.
$this->assertSession()->fieldExists('name');
// Ensure that there is textfield for email.
$this->assertSession()->fieldExists('mail');
// Create and log in administrative user.
$admin_user = $this->drupalCreateUser([
'access site-wide contact form',
'administer contact forms',
'administer users',
'administer account settings',
'administer contact_message display',
'administer contact_message fields',
'administer contact_message form display',
]);
$this->drupalLogin($admin_user);
// Check the presence of expected cache tags.
$this->drupalGet('contact');
$this->assertSession()->responseHeaderContains('X-Drupal-Cache-Tags', 'config:contact.settings');
$flood_limit = 3;
$this->config('contact.settings')
->set('flood.limit', $flood_limit)
->set('flood.interval', 600)
->save();
// Set settings.
$edit = [];
$edit['contact_default_status'] = TRUE;
$this->drupalGet('admin/config/people/accounts');
$this->submitForm($edit, 'Save configuration');
$this->assertSession()->pageTextContains('The configuration options have been saved.');
$this->drupalGet('admin/structure/contact');
// Default form exists.
$this->assertSession()->linkByHrefExists('admin/structure/contact/manage/feedback/delete');
// User form could not be changed or deleted.
// Cannot use ::assertNoLinkByHref as it does partial URL matching and with
// field_ui enabled admin/structure/contact/manage/personal/fields exists.
// @todo See https://www.drupal.org/node/2031223 for the above.
$url = Url::fromRoute('entity.contact_form.edit_form', ['contact_form' => 'personal'])->toString();
$this->assertSession()->elementNotExists('xpath', "//a[@href='{$url}']");
$this->assertSession()->linkByHrefNotExists('admin/structure/contact/manage/personal/delete');
$this->drupalGet('admin/structure/contact/manage/personal');
$this->assertSession()->statusCodeEquals(403);
// Delete old forms to ensure that new forms are used.
$this->deleteContactForms();
$this->drupalGet('admin/structure/contact');
$this->assertSession()->pageTextContains('Personal');
$this->assertSession()->linkByHrefNotExists('admin/structure/contact/manage/feedback');
// Ensure that the contact form won't be shown without forms.
user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, ['access site-wide contact form']);
$this->drupalLogout();
$this->drupalGet('contact');
$this->assertSession()->statusCodeEquals(404);
$this->drupalLogin($admin_user);
$this->drupalGet('contact');
$this->assertSession()->statusCodeEquals(200);
$this->assertSession()->pageTextContains('The contact form has not been configured.');
// Test access personal form via site-wide contact page.
$this->drupalGet('contact/personal');
$this->assertSession()->statusCodeEquals(403);
// Add forms.
// Test invalid recipients.
$invalid_recipients = ['invalid', 'invalid@', 'invalid@site.', '@site.', '@site.com'];
foreach ($invalid_recipients as $invalid_recipient) {
$this->addContactForm($this->randomMachineName(16), $this->randomMachineName(16), $invalid_recipient, '', FALSE);
$this->assertSession()->pageTextContains($invalid_recipient . ' is an invalid email address.');
}
// Test validation of empty form and recipients fields.
$this->addContactForm('', '', '', '', TRUE);
$this->assertSession()->pageTextContains('Label field is required.');
$this->assertSession()->pageTextContains('Machine-readable name field is required.');
$this->assertSession()->pageTextContains('Recipients field is required.');
// Test validation of max_length machine name.
$recipients = ['simpletest&@example.com', 'simpletest2@example.com', 'simpletest3@example.com'];
$max_length = EntityTypeInterface::BUNDLE_MAX_LENGTH;
$max_length_exceeded = $max_length + 1;
$this->addContactForm($id = $this->randomMachineName($max_length_exceeded), $label = $this->randomMachineName($max_length_exceeded), implode(',', [$recipients[0]]), '', TRUE);
$this->assertSession()->pageTextContains('Machine-readable name cannot be longer than ' . $max_length . ' characters but is currently ' . $max_length_exceeded . ' characters long.');
$this->addContactForm($id = $this->randomMachineName($max_length), $label = $this->randomMachineName($max_length), implode(',', [$recipients[0]]), '', TRUE);
$this->assertSession()->pageTextContains('Contact form ' . $label . ' has been added.');
// Verify that the creation message contains a link to a contact form.
$this->assertSession()->elementExists('xpath', '//div[@data-drupal-messages]//a[contains(@href, "contact/")]');
// Create first valid form.
$this->addContactForm($id = $this->randomMachineName(16), $label = $this->randomMachineName(16), implode(',', [$recipients[0]]), '', TRUE);
$this->assertSession()->pageTextContains('Contact form ' . $label . ' has been added.');
// Verify that the creation message contains a link to a contact form.
$this->assertSession()->elementExists('xpath', '//div[@data-drupal-messages]//a[contains(@href, "contact/")]');
// Check that the form was created in site default language.
$langcode = $this->config('contact.form.' . $id)->get('langcode');
$default_langcode = \Drupal::languageManager()->getDefaultLanguage()->getId();
$this->assertEquals($default_langcode, $langcode);
// Make sure the newly created form is included in the list of forms.
$this->assertSession()->pageTextMatchesCount(2, '/' . $label . '/');
// Ensure that the recipient email is escaped on the listing.
$this->drupalGet('admin/structure/contact');
$this->assertSession()->assertEscaped($recipients[0]);
// Test update contact form.
$this->updateContactForm($id, $label = $this->randomMachineName(16), implode(',', [$recipients[0], $recipients[1]]), $reply = $this->randomMachineName(30), FALSE, 'Your message has been sent.', '/user');
$config = $this->config('contact.form.' . $id)->get();
$this->assertEquals($label, $config['label']);
$this->assertEquals([$recipients[0], $recipients[1]], $config['recipients']);
$this->assertEquals($reply, $config['reply']);
$this->assertNotEquals($this->config('contact.settings')->get('default_form'), $id);
$this->assertSession()->pageTextContains('Contact form ' . $label . ' has been updated.');
// Ensure the label is displayed on the contact page for this form.
$this->drupalGet('contact/' . $id);
$this->assertSession()->pageTextContains($label);
// Reset the form back to be the default form.
$this->config('contact.settings')->set('default_form', $id)->save();
// Ensure that the contact form is shown without a form selection input.
user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, ['access site-wide contact form']);
$this->drupalLogout();
$this->drupalGet('contact');
$this->assertSession()->pageTextContains('Your email address');
$this->assertSession()->pageTextNotContains('Form');
$this->drupalLogin($admin_user);
// Add more forms.
$this->addContactForm($this->randomMachineName(16), $label = $this->randomMachineName(16), implode(',', [$recipients[0], $recipients[1]]), '', FALSE);
$this->assertSession()->pageTextContains('Contact form ' . $label . ' has been added.');
$this->addContactForm($name = $this->randomMachineName(16), $label = $this->randomMachineName(16), implode(',', [$recipients[0], $recipients[1], $recipients[2]]), '', FALSE);
$this->assertSession()->pageTextContains('Contact form ' . $label . ' has been added.');
// Try adding a form that already exists.
$this->addContactForm($name, $label, '', '', FALSE);
$this->assertSession()->pageTextNotContains("Contact form $label has been added.");
$this->assertSession()->pageTextContains('The machine-readable name is already in use. It must be unique.');
$this->drupalLogout();
// Check to see that anonymous user cannot see contact page without permission.
user_role_revoke_permissions(RoleInterface::ANONYMOUS_ID, ['access site-wide contact form']);
$this->drupalGet('contact');
$this->assertSession()->statusCodeEquals(403);
// Give anonymous user permission and see that page is viewable.
user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, ['access site-wide contact form']);
$this->drupalGet('contact');
$this->assertSession()->statusCodeEquals(200);
// Submit contact form with invalid values.
$this->submitContact('', $recipients[0], $this->randomMachineName(16), $id, $this->randomMachineName(64));
$this->assertSession()->pageTextContains('Your name field is required.');
$this->submitContact($this->randomMachineName(16), '', $this->randomMachineName(16), $id, $this->randomMachineName(64));
$this->assertSession()->pageTextContains('Your email address field is required.');
$this->submitContact($this->randomMachineName(16), $invalid_recipients[0], $this->randomMachineName(16), $id, $this->randomMachineName(64));
$this->assertSession()->pageTextContains('The email address invalid is not valid.');
$this->submitContact($this->randomMachineName(16), $recipients[0], '', $id, $this->randomMachineName(64));
$this->assertSession()->pageTextContains('Subject field is required.');
$this->submitContact($this->randomMachineName(16), $recipients[0], $this->randomMachineName(16), $id, '');
$this->assertSession()->pageTextContains('Message field is required.');
// Test contact form with no default form selected.
$this->config('contact.settings')
->set('default_form', NULL)
->save();
$this->drupalGet('contact');
$this->assertSession()->statusCodeEquals(404);
// Try to access contact form with non-existing form IDs.
$this->drupalGet('contact/0');
$this->assertSession()->statusCodeEquals(404);
$this->drupalGet('contact/' . $this->randomMachineName());
$this->assertSession()->statusCodeEquals(404);
// Submit contact form with correct values and check flood interval.
for ($i = 0; $i < $flood_limit; $i++) {
$this->submitContact($this->randomMachineName(16), $recipients[0], $this->randomMachineName(16), $id, $this->randomMachineName(64));
$this->assertSession()->pageTextContains('Your message has been sent.');
}
// Submit contact form one over limit.
$this->submitContact($this->randomMachineName(16), $recipients[0], $this->randomMachineName(16), $id, $this->randomMachineName(64));
$this->assertSession()->pageTextContains('You cannot send more than ' . $this->config('contact.settings')->get('flood.limit') . ' messages in 10 min. Try again later.');
// Test listing controller.
$this->drupalLogin($admin_user);
$this->deleteContactForms();
$label = $this->randomMachineName(16);
$recipients = implode(',', [$recipients[0], $recipients[1], $recipients[2]]);
$contact_form = $this->randomMachineName(16);
$this->addContactForm($contact_form, $label, $recipients, '', FALSE);
$this->drupalGet('admin/structure/contact');
$this->clickLink('Edit');
$this->assertSession()->statusCodeEquals(200);
$this->assertSession()->fieldValueEquals('label', $label);
// Verify contact "View" tab exists.
$this->assertSession()->linkExists('View');
// Test field UI and field integration.
$this->drupalGet('admin/structure/contact');
// Test contact listing links to contact form.
$this->assertSession()->elementExists('xpath', $this->assertSession()->buildXPathQuery('//table/tbody/tr/td/a[contains(@href, :href) and text()=:text]', [
':href' => Url::fromRoute('entity.contact_form.canonical', ['contact_form' => $contact_form])->toString(),
':text' => $label,
]));
// Find out in which row the form we want to add a field to is.
foreach ($this->xpath('//table/tbody/tr') as $row) {
if ($row->findLink($label)) {
$row->clickLink('Manage fields');
break;
}
}
$this->assertSession()->statusCodeEquals(200);
$this->clickLink('Create a new field');
$this->assertSession()->statusCodeEquals(200);
// Create a simple textfield.
$field_name = $this->randomMachineName();
$field_label = $this->randomMachineName();
$this->fieldUIAddNewField(NULL, $field_name, $field_label, 'text');
$field_name = 'field_' . $field_name;
// Check preview field can be ordered.
$this->drupalGet('admin/structure/contact/manage/' . $contact_form . '/form-display');
$this->assertSession()->pageTextContains('Preview');
// Check that the field is displayed.
$this->drupalGet('contact/' . $contact_form);
$this->assertSession()->pageTextContains($field_label);
// Submit the contact form and verify the content.
$edit = [
'subject[0][value]' => $this->randomMachineName(),
'message[0][value]' => $this->randomMachineName(),
$field_name . '[0][value]' => $this->randomMachineName(),
];
$this->submitForm($edit, 'Send message');
$mails = $this->getMails();
$mail = array_pop($mails);
$this->assertEquals(sprintf('[%s] %s', $label, $edit['subject[0][value]']), $mail['subject']);
$this->assertStringContainsString($field_label, $mail['body']);
$this->assertStringContainsString($edit[$field_name . '[0][value]'], $mail['body']);
// Test messages and redirect.
/** @var \Drupal\contact\ContactFormInterface $form */
$form = ContactForm::load($contact_form);
$form->setMessage('Thanks for your submission.');
$form->setRedirectPath('/user/' . $admin_user->id());
$form->save();
// Check that the field is displayed.
$this->drupalGet('contact/' . $contact_form);
// Submit the contact form and verify the content.
$edit = [
'subject[0][value]' => $this->randomMachineName(),
'message[0][value]' => $this->randomMachineName(),
$field_name . '[0][value]' => $this->randomMachineName(),
];
$this->submitForm($edit, 'Send message');
$this->assertSession()->pageTextContains('Thanks for your submission.');
$this->assertSession()->addressEquals('user/' . $admin_user->id());
// Test Empty message.
/** @var \Drupal\contact\ContactFormInterface $form */
$form = ContactForm::load($contact_form);
$form->setMessage('');
$form->setRedirectPath('/user/' . $admin_user->id());
$form->save();
$this->drupalGet('admin/structure/contact/manage/' . $contact_form);
// Check that the field is displayed.
$this->drupalGet('contact/' . $contact_form);
// Submit the contact form and verify the content.
$edit = [
'subject[0][value]' => $this->randomMachineName(),
'message[0][value]' => $this->randomMachineName(),
$field_name . '[0][value]' => $this->randomMachineName(),
];
$this->submitForm($edit, 'Send message');
// Verify that messages are not found.
$this->assertSession()->elementNotExists('xpath', '//div[@data-drupal-messages]');
$this->assertSession()->addressEquals('user/' . $admin_user->id());
// Test preview and visibility of the message field and label. Submit the
// contact form and verify the content.
$edit = [
'subject[0][value]' => $this->randomMachineName(),
'message[0][value]' => $this->randomMachineName(),
$field_name . '[0][value]' => $this->randomMachineName(),
];
$this->drupalGet($form->toUrl('canonical'));
$this->submitForm($edit, 'Preview');
// Message is now by default displayed twice, once for the form element and
// once for the viewed message.
$message = $edit['message[0][value]'];
$this->assertSession()->pageTextMatchesCount(2, '/Message/');
$this->assertSession()->pageTextMatchesCount(2, '/' . $message . '/');
// Check for label and message in form element.
$this->assertSession()->elementTextEquals('css', 'label[for="edit-message-0-value"]', 'Message');
$this->assertSession()->fieldValueEquals('edit-message-0-value', $message);
// Check for label and message in preview.
$this->assertSession()->elementTextContains('css', '#edit-preview', 'Message');
$this->assertSession()->elementTextContains('css', '#edit-preview', $message);
// Hide the message field label.
$display_edit = [
'fields[message][label]' => 'hidden',
];
$this->drupalGet('admin/structure/contact/manage/' . $contact_form . '/display');
$this->submitForm($display_edit, 'Save');
$this->drupalGet($form->toUrl('canonical'));
$this->submitForm($edit, 'Preview');
// 'Message' should only be displayed once now with the actual message
// displayed twice.
$this->assertSession()->pageTextContainsOnce('Message');
$this->assertSession()->pageTextMatchesCount(2, '/' . $message . '/');
// Check for label and message in form element.
$this->assertSession()->elementTextEquals('css', 'label[for="edit-message-0-value"]', 'Message');
$this->assertSession()->fieldValueEquals('edit-message-0-value', $message);
// Check for message in preview but no label.
$this->assertSession()->elementTextNotContains('css', '#edit-preview', 'Message');
$this->assertSession()->elementTextContains('css', '#edit-preview', $message);
// Set the preview field to 'hidden' in the view mode and check that the
// field is hidden.
$edit = [
'fields[preview][region]' => 'hidden',
];
$this->drupalGet('admin/structure/contact/manage/' . $contact_form . '/form-display');
$this->submitForm($edit, 'Save');
$this->assertSession()->fieldExists('fields[preview][region]');
// Check that the field preview is not displayed in the form.
$this->drupalGet('contact/' . $contact_form);
$this->assertSession()->responseNotContains('Preview');
}
/**
* Tests auto-reply on the site-wide contact form.
*/
public function testAutoReply(): void {
// Create and log in administrative user.
$admin_user = $this->drupalCreateUser([
'access site-wide contact form',
'administer contact forms',
'administer permissions',
'administer users',
'access site reports',
]);
$this->drupalLogin($admin_user);
// Set up three forms, 2 with an auto-reply and one without.
$foo_autoreply = $this->randomMachineName(40);
$bar_autoreply = $this->randomMachineName(40);
$this->addContactForm('foo', 'foo', 'foo@example.com', $foo_autoreply, FALSE);
$this->addContactForm('bar', 'bar', 'bar@example.com', $bar_autoreply, FALSE);
$this->addContactForm('no_autoreply', 'no_autoreply', 'bar@example.com', '', FALSE);
// Log the current user out in order to test the name and email fields.
$this->drupalLogout();
user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, ['access site-wide contact form']);
// Test the auto-reply for form 'foo'.
$email = $this->randomMachineName(32) . '@example.com';
$subject = $this->randomMachineName(64);
$this->submitContact($this->randomMachineName(16), $email, $subject, 'foo', $this->randomString(128));
// We are testing the auto-reply, so there should be one email going to the sender.
$captured_emails = $this->getMails(['id' => 'contact_page_autoreply', 'to' => $email]);
$this->assertCount(1, $captured_emails);
$this->assertEquals(trim(MailFormatHelper::htmlToText($foo_autoreply)), trim($captured_emails[0]['body']));
// Test the auto-reply for form 'bar'.
$email = $this->randomMachineName(32) . '@example.com';
$this->submitContact($this->randomMachineName(16), $email, $this->randomString(64), 'bar', $this->randomString(128));
// Auto-reply for form 'bar' should result in one auto-reply email to the sender.
$captured_emails = $this->getMails(['id' => 'contact_page_autoreply', 'to' => $email]);
$this->assertCount(1, $captured_emails);
$this->assertEquals(trim(MailFormatHelper::htmlToText($bar_autoreply)), trim($captured_emails[0]['body']));
// Verify that no auto-reply is sent when the auto-reply field is left blank.
$email = $this->randomMachineName(32) . '@example.com';
$this->submitContact($this->randomMachineName(16), $email, $this->randomString(64), 'no_autoreply', $this->randomString(128));
$captured_emails = $this->getMails(['id' => 'contact_page_autoreply', 'to' => $email]);
$this->assertCount(0, $captured_emails);
// Verify that the current error message doesn't show, that the auto-reply
// doesn't get sent and the correct silent error gets logged.
$email = '';
\Drupal::service('entity_display.repository')
->getFormDisplay('contact_message', 'foo')
->removeComponent('mail')
->save();
$this->submitContact($this->randomMachineName(16), $email, $this->randomString(64), 'foo', $this->randomString(128));
$this->assertSession()->pageTextNotContains('Unable to send email. Contact the site administrator if the problem persists.');
$captured_emails = $this->getMails(['id' => 'contact_page_autoreply', 'to' => $email]);
$this->assertCount(0, $captured_emails);
$this->drupalLogin($admin_user);
$this->drupalGet('admin/reports/dblog');
$this->assertSession()->responseContains('Error sending auto-reply, missing sender email address in foo');
}
/**
* Adds a form.
*
* @param string $id
* The form machine name.
* @param string $label
* The form label.
* @param string $recipients
* The list of recipient email addresses.
* @param string $reply
* The auto-reply text that is sent to a user upon completing the contact
* form.
* @param bool $selected
* A Boolean indicating whether the form should be selected by default.
* @param string $message
* The message that will be displayed to a user upon completing the contact
* form.
* @param array $third_party_settings
* Array of third party settings to be added to the posted form data.
*/
public function addContactForm($id, $label, $recipients, $reply, $selected, $message = 'Your message has been sent.', $third_party_settings = []) {
$edit = [];
$edit['label'] = $label;
$edit['id'] = $id;
$edit['message'] = $message;
$edit['recipients'] = $recipients;
$edit['reply'] = $reply;
$edit['selected'] = ($selected ? TRUE : FALSE);
$edit += $third_party_settings;
$this->drupalGet('admin/structure/contact/add');
$this->submitForm($edit, 'Save');
// Ensure the statically cached bundle info is aware of the contact form
// that was just created in the UI.
$this->container->get('entity_type.bundle.info')->clearCachedBundles();
}
/**
* Updates a form.
*
* @param string $id
* The form machine name.
* @param string $label
* The form label.
* @param string $recipients
* The list of recipient email addresses.
* @param string $reply
* The auto-reply text that is sent to a user upon completing the contact
* form.
* @param bool $selected
* A Boolean indicating whether the form should be selected by default.
* @param string $message
* The message that will be displayed to a user upon completing the contact
* form.
* @param string $redirect
* The path where user will be redirect after this form has been submitted..
*/
public function updateContactForm($id, $label, $recipients, $reply, $selected, $message = 'Your message has been sent.', $redirect = '/') {
$edit = [];
$edit['label'] = $label;
$edit['recipients'] = $recipients;
$edit['reply'] = $reply;
$edit['selected'] = ($selected ? TRUE : FALSE);
$edit['message'] = $message;
$edit['redirect'] = $redirect;
$this->drupalGet("admin/structure/contact/manage/{$id}");
$this->submitForm($edit, 'Save');
}
/**
* Submits the contact form.
*
* @param string $name
* The name of the sender.
* @param string $mail
* The email address of the sender.
* @param string $subject
* The subject of the message.
* @param string $id
* The form ID of the message.
* @param string $message
* The message body.
*/
public function submitContact($name, $mail, $subject, $id, $message) {
$edit = [];
$edit['name'] = $name;
$edit['mail'] = $mail;
$edit['subject[0][value]'] = $subject;
$edit['message[0][value]'] = $message;
if ($id == $this->config('contact.settings')->get('default_form')) {
$this->drupalGet('contact');
$this->submitForm($edit, 'Send message');
}
else {
$this->drupalGet('contact/' . $id);
$this->submitForm($edit, 'Send message');
}
}
/**
* Deletes all forms.
*/
public function deleteContactForms() {
$contact_forms = ContactForm::loadMultiple();
foreach ($contact_forms as $id => $contact_form) {
if ($id == 'personal') {
// Personal form could not be deleted.
$this->drupalGet("admin/structure/contact/manage/$id/delete");
$this->assertSession()->statusCodeEquals(403);
}
else {
$this->drupalGet("admin/structure/contact/manage/{$id}/delete");
$this->submitForm([], 'Delete');
$this->assertSession()->pageTextContains("The contact form {$contact_form->label()} has been deleted.");
$this->assertNull(ContactForm::load($id), "Form {$contact_form->label()} not found");
}
}
}
}

View File

@@ -0,0 +1,83 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional;
use Drupal\contact\Entity\Message;
use Drupal\user\RoleInterface;
/**
* Tests storing contact messages.
*
* Note that the various test methods in ContactSitewideTest are also run by
* this test. This is by design to ensure that regular contact.module functions
* continue to work when a storage handler other than ContentEntityNullStorage
* is enabled for contact Message entities.
*
* @group contact
*/
class ContactStorageTest extends ContactSitewideTest {
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = [
'block',
'text',
'contact',
'field_ui',
'contact_storage_test',
'contact_test',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* Tests configuration options and the site-wide contact form.
*/
public function testContactStorage(): void {
// Create and log in administrative user.
$admin_user = $this->drupalCreateUser([
'access site-wide contact form',
'administer contact forms',
'administer users',
'administer account settings',
'administer contact_message fields',
]);
$this->drupalLogin($admin_user);
// Create first valid contact form.
$mail = 'simpletest@example.com';
$this->addContactForm($id = $this->randomMachineName(16), $label = $this->randomMachineName(16), implode(',', [$mail]), '', TRUE, 'Your message has been sent.', [
'send_a_pony' => 1,
]);
$this->assertSession()->pageTextContains('Contact form ' . $label . ' has been added.');
// Ensure that anonymous can submit site-wide contact form.
user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, ['access site-wide contact form']);
$this->drupalLogout();
$this->drupalGet('contact');
$this->assertSession()->pageTextContains('Your email address');
$this->assertSession()->pageTextNotContains('Form');
$this->submitContact($name = $this->randomMachineName(16), $mail, $subject = $this->randomMachineName(16), $id, $message = $this->randomMachineName(64));
$this->assertSession()->pageTextContains('Your message has been sent.');
$messages = Message::loadMultiple();
/** @var \Drupal\contact\Entity\Message $message */
$message = reset($messages);
$this->assertEquals($id, $message->getContactForm()->id());
$this->assertTrue($message->getContactForm()->getThirdPartySetting('contact_storage_test', 'send_a_pony', FALSE));
$this->assertEquals($name, $message->getSenderName());
$this->assertEquals($subject, $message->getSubject());
$this->assertEquals($mail, $message->getSenderMail());
$config = $this->config("contact.form.$id");
$this->assertEquals($id, $config->get('id'));
}
}

View File

@@ -0,0 +1,14 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional;
use Drupal\Tests\system\Functional\Module\GenericModuleTestBase;
/**
* Generic module test for contact.
*
* @group contact
*/
class GenericTest extends GenericModuleTestBase {}

View File

@@ -0,0 +1,31 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional\Rest;
use Drupal\Tests\rest\Functional\AnonResourceTestTrait;
/**
* @group rest
*/
class ContactFormJsonAnonTest extends ContactFormResourceTestBase {
use AnonResourceTestTrait;
/**
* {@inheritdoc}
*/
protected static $format = 'json';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'application/json';
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
}

View File

@@ -0,0 +1,41 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional\Rest;
use Drupal\Tests\rest\Functional\BasicAuthResourceTestTrait;
/**
* @group rest
*/
class ContactFormJsonBasicAuthTest extends ContactFormResourceTestBase {
use BasicAuthResourceTestTrait;
/**
* {@inheritdoc}
*/
protected static $modules = ['basic_auth'];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* {@inheritdoc}
*/
protected static $format = 'json';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'application/json';
/**
* {@inheritdoc}
*/
protected static $auth = 'basic_auth';
}

View File

@@ -0,0 +1,36 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional\Rest;
use Drupal\Tests\rest\Functional\CookieResourceTestTrait;
/**
* @group rest
*/
class ContactFormJsonCookieTest extends ContactFormResourceTestBase {
use CookieResourceTestTrait;
/**
* {@inheritdoc}
*/
protected static $format = 'json';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'application/json';
/**
* {@inheritdoc}
*/
protected static $auth = 'cookie';
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
}

View File

@@ -0,0 +1,100 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional\Rest;
use Drupal\contact\Entity\ContactForm;
use Drupal\Tests\rest\Functional\EntityResource\ConfigEntityResourceTestBase;
abstract class ContactFormResourceTestBase extends ConfigEntityResourceTestBase {
/**
* {@inheritdoc}
*/
protected static $modules = ['contact'];
/**
* {@inheritdoc}
*/
protected static $entityTypeId = 'contact_form';
/**
* {@inheritdoc}
*/
protected static $patchProtectedFieldNames = [];
/**
* @var \Drupal\contact\Entity\ContactForm
*/
protected $entity;
/**
* {@inheritdoc}
*/
protected function setUpAuthorization($method) {
switch ($method) {
case 'GET':
$this->grantPermissionsToTestedRole(['access site-wide contact form']);
default:
$this->grantPermissionsToTestedRole(['administer contact forms']);
}
}
/**
* {@inheritdoc}
*/
protected function createEntity() {
$contact_form = ContactForm::create([
'id' => 'llama',
'label' => 'Llama',
'message' => 'Let us know what you think about llamas',
'reply' => 'Llamas are indeed awesome!',
'recipients' => [
'llama@example.com',
'contact@example.com',
],
]);
$contact_form->save();
return $contact_form;
}
/**
* {@inheritdoc}
*/
protected function getExpectedNormalizedEntity() {
return [
'dependencies' => [],
'id' => 'llama',
'label' => 'Llama',
'langcode' => 'en',
'message' => 'Let us know what you think about llamas',
'recipients' => [
'llama@example.com',
'contact@example.com',
],
'redirect' => NULL,
'reply' => 'Llamas are indeed awesome!',
'status' => TRUE,
'uuid' => $this->entity->uuid(),
'weight' => 0,
];
}
/**
* {@inheritdoc}
*/
protected function getNormalizedPostEntity() {
// @todo Update in https://www.drupal.org/node/2300677.
return [];
}
/**
* {@inheritdoc}
*/
protected function getExpectedUnauthorizedAccessMessage($method) {
return "The 'access site-wide contact form' permission is required.";
}
}

View File

@@ -0,0 +1,33 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional\Rest;
use Drupal\Tests\rest\Functional\AnonResourceTestTrait;
use Drupal\Tests\rest\Functional\EntityResource\XmlEntityNormalizationQuirksTrait;
/**
* @group rest
*/
class ContactFormXmlAnonTest extends ContactFormResourceTestBase {
use AnonResourceTestTrait;
use XmlEntityNormalizationQuirksTrait;
/**
* {@inheritdoc}
*/
protected static $format = 'xml';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'text/xml; charset=UTF-8';
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
}

View File

@@ -0,0 +1,43 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional\Rest;
use Drupal\Tests\rest\Functional\BasicAuthResourceTestTrait;
use Drupal\Tests\rest\Functional\EntityResource\XmlEntityNormalizationQuirksTrait;
/**
* @group rest
*/
class ContactFormXmlBasicAuthTest extends ContactFormResourceTestBase {
use BasicAuthResourceTestTrait;
use XmlEntityNormalizationQuirksTrait;
/**
* {@inheritdoc}
*/
protected static $modules = ['basic_auth'];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* {@inheritdoc}
*/
protected static $format = 'xml';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'text/xml; charset=UTF-8';
/**
* {@inheritdoc}
*/
protected static $auth = 'basic_auth';
}

View File

@@ -0,0 +1,38 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional\Rest;
use Drupal\Tests\rest\Functional\CookieResourceTestTrait;
use Drupal\Tests\rest\Functional\EntityResource\XmlEntityNormalizationQuirksTrait;
/**
* @group rest
*/
class ContactFormXmlCookieTest extends ContactFormResourceTestBase {
use CookieResourceTestTrait;
use XmlEntityNormalizationQuirksTrait;
/**
* {@inheritdoc}
*/
protected static $format = 'xml';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'text/xml; charset=UTF-8';
/**
* {@inheritdoc}
*/
protected static $auth = 'cookie';
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
}

View File

@@ -0,0 +1,31 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional\Rest;
use Drupal\Tests\rest\Functional\AnonResourceTestTrait;
/**
* @group rest
*/
class MessageJsonAnonTest extends MessageResourceTestBase {
use AnonResourceTestTrait;
/**
* {@inheritdoc}
*/
protected static $format = 'json';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'application/json';
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
}

View File

@@ -0,0 +1,41 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional\Rest;
use Drupal\Tests\rest\Functional\BasicAuthResourceTestTrait;
/**
* @group rest
*/
class MessageJsonBasicAuthTest extends MessageResourceTestBase {
use BasicAuthResourceTestTrait;
/**
* {@inheritdoc}
*/
protected static $modules = ['basic_auth'];
/**
* {@inheritdoc}
*/
protected static $format = 'json';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'application/json';
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* {@inheritdoc}
*/
protected static $auth = 'basic_auth';
}

View File

@@ -0,0 +1,36 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional\Rest;
use Drupal\Tests\rest\Functional\CookieResourceTestTrait;
/**
* @group rest
*/
class MessageJsonCookieTest extends MessageResourceTestBase {
use CookieResourceTestTrait;
/**
* {@inheritdoc}
*/
protected static $format = 'json';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'application/json';
/**
* {@inheritdoc}
*/
protected static $auth = 'cookie';
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
}

View File

@@ -0,0 +1,148 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional\Rest;
use Drupal\contact\Entity\ContactForm;
use Drupal\contact\Entity\Message;
use Drupal\Core\Url;
use Drupal\Tests\rest\Functional\EntityResource\EntityResourceTestBase;
use Symfony\Component\Routing\Exception\RouteNotFoundException;
abstract class MessageResourceTestBase extends EntityResourceTestBase {
/**
* {@inheritdoc}
*/
protected static $modules = ['contact'];
/**
* {@inheritdoc}
*/
protected static $entityTypeId = 'contact_message';
/**
* {@inheritdoc}
*/
protected static $labelFieldName = 'subject';
/**
* The Message entity.
*
* @var \Drupal\contact\MessageInterface
*/
protected $entity;
/**
* {@inheritdoc}
*/
protected function setUpAuthorization($method) {
$this->grantPermissionsToTestedRole(['access site-wide contact form']);
}
/**
* {@inheritdoc}
*/
protected function createEntity() {
if (!ContactForm::load('camelids')) {
// Create a "Camelids" contact form.
ContactForm::create([
'id' => 'camelids',
'label' => 'Llama',
'message' => 'Let us know what you think about llamas',
'reply' => 'Llamas are indeed awesome!',
'recipients' => [
'llama@example.com',
'contact@example.com',
],
])->save();
}
$message = Message::create([
'contact_form' => 'camelids',
'subject' => 'Llama Gabilondo',
'message' => 'Llamas are awesome!',
]);
$message->save();
return $message;
}
/**
* {@inheritdoc}
*/
protected function getNormalizedPostEntity() {
return [
'subject' => [
[
'value' => 'Drama llama',
],
],
'contact_form' => [
[
'target_id' => 'camelids',
],
],
'message' => [
[
'value' => 'http://www.urbandictionary.com/define.php?term=drama%20llama',
],
],
];
}
/**
* {@inheritdoc}
*/
protected function getExpectedNormalizedEntity() {
throw new \Exception('Not yet supported.');
}
/**
* {@inheritdoc}
*/
protected function getExpectedUnauthorizedAccessMessage($method) {
if ($method === 'POST') {
return "The 'access site-wide contact form' permission is required.";
}
return parent::getExpectedUnauthorizedAccessMessage($method);
}
/**
* {@inheritdoc}
*/
public function testGet(): void {
// Contact Message entities are not stored, so they cannot be retrieved.
$this->expectException(RouteNotFoundException::class);
$this->expectExceptionMessage('Route "rest.entity.contact_message.GET" does not exist.');
$this->provisionEntityResource();
Url::fromRoute('rest.entity.contact_message.GET')->toString(TRUE);
}
/**
* {@inheritdoc}
*/
public function testPatch(): void {
// Contact Message entities are not stored, so they cannot be modified.
$this->expectException(RouteNotFoundException::class);
$this->expectExceptionMessage('Route "rest.entity.contact_message.PATCH" does not exist.');
$this->provisionEntityResource();
Url::fromRoute('rest.entity.contact_message.PATCH')->toString(TRUE);
}
/**
* {@inheritdoc}
*/
public function testDelete(): void {
// Contact Message entities are not stored, so they cannot be deleted.
$this->expectException(RouteNotFoundException::class);
$this->expectExceptionMessage('Route "rest.entity.contact_message.DELETE" does not exist.');
$this->provisionEntityResource();
Url::fromRoute('rest.entity.contact_message.DELETE')->toString(TRUE);
}
}

View File

@@ -0,0 +1,33 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional\Rest;
use Drupal\Tests\rest\Functional\AnonResourceTestTrait;
use Drupal\Tests\rest\Functional\EntityResource\XmlEntityNormalizationQuirksTrait;
/**
* @group rest
*/
class MessageXmlAnonTest extends MessageResourceTestBase {
use AnonResourceTestTrait;
use XmlEntityNormalizationQuirksTrait;
/**
* {@inheritdoc}
*/
protected static $format = 'xml';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'text/xml; charset=UTF-8';
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
}

View File

@@ -0,0 +1,43 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional\Rest;
use Drupal\Tests\rest\Functional\BasicAuthResourceTestTrait;
use Drupal\Tests\rest\Functional\EntityResource\XmlEntityNormalizationQuirksTrait;
/**
* @group rest
*/
class MessageXmlBasicAuthTest extends MessageResourceTestBase {
use BasicAuthResourceTestTrait;
use XmlEntityNormalizationQuirksTrait;
/**
* {@inheritdoc}
*/
protected static $modules = ['basic_auth'];
/**
* {@inheritdoc}
*/
protected static $format = 'xml';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'text/xml; charset=UTF-8';
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* {@inheritdoc}
*/
protected static $auth = 'basic_auth';
}

View File

@@ -0,0 +1,38 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional\Rest;
use Drupal\Tests\rest\Functional\CookieResourceTestTrait;
use Drupal\Tests\rest\Functional\EntityResource\XmlEntityNormalizationQuirksTrait;
/**
* @group rest
*/
class MessageXmlCookieTest extends MessageResourceTestBase {
use CookieResourceTestTrait;
use XmlEntityNormalizationQuirksTrait;
/**
* {@inheritdoc}
*/
protected static $format = 'xml';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'text/xml; charset=UTF-8';
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* {@inheritdoc}
*/
protected static $auth = 'cookie';
}

View File

@@ -0,0 +1,36 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional\Update;
use Drupal\FunctionalTests\Update\UpdatePathTestBase;
/**
* Tests the upgrade path for making 'default_form' in 'contact.settings' config to NULL.
*
* @group contact
* @see contact_post_update_set_empty_default_form_to_null()
*/
class NullDefaultFormTest extends UpdatePathTestBase {
/**
* {@inheritdoc}
*/
protected function setDatabaseDumpFiles() {
$this->databaseDumpFiles = [
__DIR__ . '/../../../../../system/tests/fixtures/update/drupal-9.4.0.filled.standard.php.gz',
];
}
/**
* Tests the upgrade path for updating empty 'default_form' to NULL.
*/
public function testRunUpdates(): void {
$this->config('contact.settings')->set('default_form', '')->save();
$this->assertSame('', $this->config('contact.settings')->get('default_form'));
$this->runUpdates();
$this->assertNull($this->config('contact.settings')->get('default_form'));
}
}

View File

@@ -0,0 +1,111 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Functional\Views;
use Drupal\Core\Cache\Cache;
use Drupal\Tests\views\Functional\ViewTestBase;
use Drupal\user\Entity\User;
/**
* Tests the contact link field.
*
* @group contact
* @see \Drupal\contact\Plugin\views\field\ContactLink.
*/
class ContactLinkTest extends ViewTestBase {
/**
* Stores the user data service used by the test.
*
* @var \Drupal\user\UserDataInterface
*/
public $userData;
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = ['contact_test_views'];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* Views used by this test.
*
* @var array
*/
public static $testViews = ['test_contact_link'];
/**
* {@inheritdoc}
*/
protected function setUp($import_test_views = TRUE, $modules = ['contact_test_views']): void {
parent::setUp($import_test_views, $modules);
$this->userData = $this->container->get('user.data');
}
/**
* Tests contact link.
*/
public function testContactLink(): void {
$accounts = [];
$accounts['root'] = User::load(1);
// Create an account with access to all contact pages.
$admin_account = $this->drupalCreateUser(['administer users']);
$accounts['admin'] = $admin_account;
// Create an account with no access to contact pages.
$no_contact_account = $this->drupalCreateUser();
$accounts['no_contact'] = $no_contact_account;
// Create an account with access to contact pages.
$contact_account = $this->drupalCreateUser(['access user contact forms']);
$accounts['contact'] = $contact_account;
$this->drupalLogin($admin_account);
$this->drupalGet('test-contact-link');
// The admin user has access to all contact links beside their own.
$this->assertContactLinks($accounts, ['root', 'no_contact', 'contact']);
$this->drupalLogin($no_contact_account);
$this->drupalGet('test-contact-link');
// Ensure that the user without the permission doesn't see any link.
$this->assertContactLinks($accounts, []);
$this->drupalLogin($contact_account);
$this->drupalGet('test-contact-link');
$this->assertContactLinks($accounts, ['root', 'admin', 'no_contact']);
// Disable contact link for no_contact.
$this->userData->set('contact', $no_contact_account->id(), 'enabled', FALSE);
// @todo Remove cache invalidation in https://www.drupal.org/node/2477903.
Cache::invalidateTags($no_contact_account->getCacheTagsToInvalidate());
$this->drupalGet('test-contact-link');
$this->assertContactLinks($accounts, ['root', 'admin']);
}
/**
* Asserts whether certain users contact links appear on the page.
*
* @param array $accounts
* All user objects used by the test.
* @param array $names
* Users which should have contact links.
*
* @internal
*/
public function assertContactLinks(array $accounts, array $names): void {
$this->assertSession()->elementsCount('xpath', '//div[contains(@class, "views-field-contact")]//a', count($names));
foreach ($names as $name) {
$account_url = $accounts[$name]->toUrl('contact-form')->toString();
$this->assertSession()->elementExists('xpath', "//div[contains(@class, 'views-field-contact')]//a[contains(@href, '$account_url')]");
}
}
}

View File

@@ -0,0 +1,46 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Kernel;
use Drupal\contact\ContactFormInterface;
use Drupal\contact\Entity\ContactForm;
use Drupal\KernelTests\Core\Config\ConfigEntityValidationTestBase;
/**
* Tests validation of contact_form entities.
*
* @group contact
*/
class ContactFormValidationTest extends ConfigEntityValidationTestBase {
/**
* {@inheritdoc}
*/
protected static $modules = ['contact', 'user'];
/**
* {@inheritdoc}
*/
protected function setUp(): void {
parent::setUp();
$this->entity = ContactForm::create([
'id' => 'test',
'label' => 'Test',
]);
$this->entity->save();
}
/**
* Tests validation of message.
*/
public function testMessageValidation(): void {
assert($this->entity instanceof ContactFormInterface);
// Messages should be able to span multiple lines.
$this->entity->setMessage("Multi\nLine");
$this->assertValidationErrors([]);
}
}

View File

@@ -0,0 +1,76 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Kernel;
use Drupal\KernelTests\Core\Entity\EntityKernelTestBase;
/**
* Tests the message entity class.
*
* @group contact
* @see \Drupal\contact\Entity\Message
*/
class MessageEntityTest extends EntityKernelTestBase {
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = [
'system',
'contact',
'field',
'user',
'contact_test',
];
/**
* {@inheritdoc}
*/
protected function setUp(): void {
parent::setUp();
$this->installConfig(['contact', 'contact_test']);
}
/**
* Tests some of the methods.
*/
public function testMessageMethods(): void {
$message_storage = $this->container->get('entity_type.manager')->getStorage('contact_message');
$message = $message_storage->create(['contact_form' => 'feedback']);
// Check for empty values first.
$this->assertEquals('', $message->getMessage());
$this->assertEquals('', $message->getSenderName());
$this->assertEquals('', $message->getSenderMail());
$this->assertFalse($message->copySender());
// Check for default values.
$this->assertEquals('feedback', $message->getContactForm()->id());
$this->assertFalse($message->isPersonal());
// Set some values and check for them afterwards.
$message->setMessage('welcome_message');
$message->setSenderName('sender_name');
$message->setSenderMail('sender_mail');
$message->setCopySender(TRUE);
$this->assertEquals('welcome_message', $message->getMessage());
$this->assertEquals('sender_name', $message->getSenderName());
$this->assertEquals('sender_mail', $message->getSenderMail());
$this->assertTrue($message->copySender());
$no_access_user = $this->createUser([], NULL, FALSE, ['uid' => 2]);
$access_user = $this->createUser(['access site-wide contact form'], NULL, FALSE, ['uid' => 3]);
$admin = $this->createUser(['administer contact forms'], NULL, FALSE, ['uid' => 4]);
$this->assertFalse(\Drupal::entityTypeManager()->getAccessControlHandler('contact_message')->createAccess(NULL, $no_access_user));
$this->assertTrue(\Drupal::entityTypeManager()->getAccessControlHandler('contact_message')->createAccess(NULL, $access_user));
$this->assertTrue($message->access('update', $admin));
$this->assertFalse($message->access('update', $access_user));
}
}

View File

@@ -0,0 +1,87 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Kernel\Migrate;
use Drupal\contact\Entity\ContactForm;
use Drupal\contact\ContactFormInterface;
use Drupal\Tests\migrate_drupal\Kernel\d6\MigrateDrupal6TestBase;
/**
* Migrate contact categories to contact.form.*.yml.
*
* @group contact_category
*/
class MigrateContactCategoryTest extends MigrateDrupal6TestBase {
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = ['contact'];
/**
* {@inheritdoc}
*/
protected function setUp(): void {
parent::setUp();
$this->executeMigration('contact_category');
}
/**
* Performs various assertions on a single contact form entity.
*
* @param string $id
* The contact form ID.
* @param string $expected_label
* The expected label.
* @param string[] $expected_recipients
* The recipient email addresses the form should have.
* @param string $expected_reply
* The expected reply message.
* @param int $expected_weight
* The contact form's expected weight.
*
* @internal
*/
protected function assertEntity(string $id, string $expected_label, array $expected_recipients, string $expected_reply, int $expected_weight): void {
/** @var \Drupal\contact\ContactFormInterface $entity */
$entity = ContactForm::load($id);
$this->assertInstanceOf(ContactFormInterface::class, $entity);
$this->assertSame($expected_label, $entity->label());
$this->assertSame($expected_recipients, $entity->getRecipients());
$this->assertSame($expected_reply, $entity->getReply());
$this->assertSame($expected_weight, $entity->getWeight());
}
/**
* The Drupal 6 and 7 contact categories to Drupal 8 migration.
*/
public function testContactCategory(): void {
$this->assertEntity('website_feedback', 'Website feedback', ['admin@example.com'], '', 0);
$this->assertEntity('some_other_category', 'Some other category', ['test@example.com'], 'Thanks for contacting us, we will reply ASAP!', 1);
$this->assertEntity('a_category_much_longer_than_th', 'A category much longer than thirty two characters', ['fortyninechars@example.com'], '', 2);
// Test there are no duplicated roles.
$contact_forms = [
'website_feedback1',
'some_other_category1',
'a_category_much_longer_than_thir1',
];
$this->assertEmpty(ContactForm::loadMultiple($contact_forms));
/*
* Remove the map row for the Website feedback contact form so that it
* can be migrated again.
*/
$id_map = $this->getMigration('contact_category')->getIdMap();
$id_map->delete(['cid' => '1']);
$this->executeMigration('contact_category');
// Test there is a duplicate Website feedback form.
$this->assertEntity('website_feedback1', 'Website feedback', ['admin@example.com'], '', 0);
}
}

View File

@@ -0,0 +1,43 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Kernel\Migrate\d6;
use Drupal\Tests\SchemaCheckTestTrait;
use Drupal\Tests\migrate_drupal\Kernel\d6\MigrateDrupal6TestBase;
/**
* Upgrade variables to contact.settings.yml.
*
* @group migrate_drupal_6
*/
class MigrateContactSettingsTest extends MigrateDrupal6TestBase {
use SchemaCheckTestTrait;
/**
* {@inheritdoc}
*/
protected static $modules = ['contact'];
/**
* {@inheritdoc}
*/
protected function setUp(): void {
parent::setUp();
$this->executeMigrations(['contact_category', 'd6_contact_settings']);
}
/**
* Tests migration of contact variables to contact.settings.yml.
*/
public function testContactSettings(): void {
$config = $this->config('contact.settings');
$this->assertTrue($config->get('user_default_enabled'));
$this->assertSame(3, $config->get('flood.limit'));
$this->assertSame('some_other_category', $config->get('default_form'));
$this->assertConfigSchema(\Drupal::service('config.typed'), 'contact.settings', $config->get());
}
}

View File

@@ -0,0 +1,40 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Kernel\Migrate\d7;
use Drupal\Tests\migrate_drupal\Kernel\d7\MigrateDrupal7TestBase;
/**
* Tests migration of Contact settings to configuration.
*
* @group migrate_drupal_7
*/
class MigrateContactSettingsTest extends MigrateDrupal7TestBase {
/**
* {@inheritdoc}
*/
protected static $modules = ['contact'];
/**
* {@inheritdoc}
*/
protected function setUp(): void {
parent::setUp();
$this->executeMigration('contact_category');
$this->executeMigration('d7_contact_settings');
}
/**
* Tests migration of Contact's variables to configuration.
*/
public function testContactSettings(): void {
$config = $this->config('contact.settings');
$this->assertTrue($config->get('user_default_enabled'));
$this->assertSame(33, $config->get('flood.limit'));
$this->assertEquals('website_testing', $config->get('default_form'));
}
}

View File

@@ -0,0 +1,59 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Kernel\Plugin\migrate\source;
use Drupal\Tests\migrate\Kernel\MigrateSqlSourceTestBase;
/**
* Tests D6 contact category source plugin.
*
* @covers \Drupal\contact\Plugin\migrate\source\ContactCategory
* @group contact
*/
class ContactCategoryTest extends MigrateSqlSourceTestBase {
/**
* {@inheritdoc}
*/
protected static $modules = ['contact', 'migrate_drupal', 'user'];
/**
* {@inheritdoc}
*/
public static function providerSource() {
$tests = [
[
'source_data' => [],
'expected_data' => [],
],
];
$tests[0]['expected_data'] = [
[
'cid' => 1,
'category' => 'contact category value 1',
'recipients' => ['admin@example.com', 'user@example.com'],
'reply' => 'auto reply value 1',
'weight' => 0,
'selected' => 0,
],
[
'cid' => 2,
'category' => 'contact category value 2',
'recipients' => ['admin@example.com', 'user@example.com'],
'reply' => 'auto reply value 2',
'weight' => 0,
'selected' => 0,
],
];
foreach ($tests[0]['expected_data'] as $k => $row) {
$row['recipients'] = implode(',', $row['recipients']);
$tests[0]['source_data']['contact'][$k] = $row;
}
return $tests;
}
}

View File

@@ -0,0 +1,56 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Kernel\Plugin\migrate\source\d6;
use Drupal\Tests\migrate\Kernel\MigrateSqlSourceTestBase;
/**
* Tests D6 contact settings source plugin.
*
* @covers \Drupal\contact\Plugin\migrate\source\ContactSettings
* @group contact
*/
class ContactSettingsTest extends MigrateSqlSourceTestBase {
/**
* {@inheritdoc}
*/
protected static $modules = ['contact', 'migrate_drupal', 'user'];
/**
* {@inheritdoc}
*/
public static function providerSource() {
$tests = [];
$tests[0]['source_data']['variable'] = [
[
'name' => 'site_name',
'value' => serialize('foo!'),
],
];
$tests[0]['source_data']['contact'] = [
[
'cid' => '1',
'category' => 'Website feedback',
'recipients' => 'admin@example.com',
'reply' => '',
'weight' => '0',
'selected' => '1',
],
];
$tests[0]['expected_data'] = [
[
'default_category' => '1',
'site_name' => 'foo!',
],
];
$tests[0]['expected_count'] = NULL;
$tests[0]['configuration']['variables'] = ['site_name'];
return $tests;
}
}

View File

@@ -0,0 +1,60 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Kernel\Views;
use Drupal\contact\Entity\ContactForm;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\KernelTests\KernelTestBase;
/**
* Tests that no storage is created for the contact_message entity.
*
* @group contact
*/
class ContactFieldsTest extends KernelTestBase {
/**
* {@inheritdoc}
*/
protected static $modules = [
'contact',
'field',
'system',
'text',
'user',
'views',
];
/**
* Tests the views data generation.
*/
public function testViewsData(): void {
$this->installConfig(['contact']);
FieldStorageConfig::create([
'type' => 'text',
'entity_type' => 'contact_message',
'field_name' => $field_name = $this->randomMachineName(),
])->save();
ContactForm::create([
'id' => 'contact_message',
'label' => 'Test contact form',
])->save();
FieldConfig::create([
'entity_type' => 'contact_message',
'bundle' => 'contact_message',
'field_name' => $field_name,
])->save();
// Test that the field is not exposed to views, since contact_message
// entities have no storage.
$table_name = 'contact_message__' . $field_name;
$data = $this->container->get('views.views_data')->get($table_name);
$this->assertEmpty($data);
}
}

View File

@@ -0,0 +1,52 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Unit;
use Drupal\contact\Plugin\views\field\ContactLink;
use Drupal\Core\Access\AccessManagerInterface;
use Drupal\Core\Entity\EntityRepositoryInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Language\LanguageManagerInterface;
use Drupal\Core\StringTranslation\TranslationInterface;
use Drupal\Tests\UnitTestCase;
use Drupal\Tests\views\Traits\ViewsLoggerTestTrait;
use Drupal\views\Plugin\views\display\DisplayPluginBase;
use Drupal\views\ResultRow;
use Drupal\views\ViewExecutable;
/**
* @coversDefaultClass \Drupal\contact\Plugin\views\field\ContactLink
* @group contact
*/
class ContactLinkTest extends UnitTestCase {
use ViewsLoggerTestTrait;
/**
* {@inheritdoc}
*/
protected function setUp(): void {
parent::setUp();
$this->setUpMockLoggerWithMissingEntity();
$container = \Drupal::getContainer();
$container->set('string_translation', $this->createMock(TranslationInterface::class));
\Drupal::setContainer($container);
}
/**
* Test the render method when getEntity returns NULL.
*
* @covers ::render
*/
public function testRenderNullEntity(): void {
$row = new ResultRow();
$field = new ContactLink(['entity_type' => 'foo', 'entity field' => 'bar'], '', [], $this->createMock(AccessManagerInterface::class), $this->createMock(EntityTypeManagerInterface::class), $this->createMock(EntityRepositoryInterface::class), $this->createMock(LanguageManagerInterface::class));
$view = $this->createMock(ViewExecutable::class);
$display = $this->createMock(DisplayPluginBase::class);
$field->init($view, $display);
$this->assertEmpty($field->render($row));
}
}

View File

@@ -0,0 +1,346 @@
<?php
declare(strict_types=1);
namespace Drupal\Tests\contact\Unit;
use Drupal\contact\MailHandler;
use Drupal\contact\MailHandlerException;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Language\Language;
use Drupal\Tests\UnitTestCase;
use Drupal\user\Entity\User;
/**
* @coversDefaultClass \Drupal\contact\MailHandler
* @group contact
*/
class MailHandlerTest extends UnitTestCase {
/**
* Language manager service.
*
* @var \Drupal\Core\Language\LanguageManagerInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $languageManager;
/**
* Logger service.
*
* @var \Psr\Log\LoggerInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $logger;
/**
* Mail manager service.
*
* @var \Drupal\Core\Mail\MailManagerInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $mailManager;
/**
* Contact mail messages service.
*
* @var \Drupal\contact\MailHandlerInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $contactMailHandler;
/**
* The contact form entity.
*
* @var \Drupal\contact\ContactFormInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $contactForm;
/**
* The entity type manager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $entityTypeManager;
/**
* The user storage handler.
*
* @var \Drupal\Core\Entity\EntityStorageInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $userStorage;
/**
* {@inheritdoc}
*/
protected function setUp(): void {
parent::setUp();
$this->mailManager = $this->createMock('\Drupal\Core\Mail\MailManagerInterface');
$this->languageManager = $this->createMock('\Drupal\Core\Language\LanguageManagerInterface');
$this->logger = $this->createMock('\Psr\Log\LoggerInterface');
$this->entityTypeManager = $this->createMock(EntityTypeManagerInterface::class);
$this->userStorage = $this->createMock('\Drupal\Core\Entity\EntityStorageInterface');
$this->entityTypeManager->expects($this->any())
->method('getStorage')
->with('user')
->willReturn($this->userStorage);
$string_translation = $this->getStringTranslationStub();
$this->contactMailHandler = new MailHandler($this->mailManager, $this->languageManager, $this->logger, $string_translation, $this->entityTypeManager);
$language = new Language(['id' => 'en']);
$this->languageManager->expects($this->any())
->method('getDefaultLanguage')
->willReturn($language);
$this->languageManager->expects($this->any())
->method('getCurrentLanguage')
->willReturn($language);
}
/**
* Tests the children() method with an invalid key.
*
* @covers ::sendMailMessages
*/
public function testInvalidRecipient(): void {
$message = $this->createMock('\Drupal\contact\MessageInterface');
$message->expects($this->once())
->method('isPersonal')
->willReturn(TRUE);
$message->expects($this->once())
->method('getPersonalRecipient')
->willReturn(NULL);
$message->expects($this->once())
->method('getContactForm')
->willReturn($this->createMock('\Drupal\contact\ContactFormInterface'));
$sender = $this->createMock('\Drupal\Core\Session\AccountInterface');
$this->userStorage->expects($this->any())
->method('load')
->willReturn($sender);
// User IDs 1 and 0 have special implications, use 3 instead.
$sender->expects($this->any())
->method('id')
->willReturn(3);
$sender->expects($this->once())
->method('isAnonymous')
->willReturn(FALSE);
$this->expectException(MailHandlerException::class);
$this->expectExceptionMessage('Unable to determine message recipient');
$this->contactMailHandler->sendMailMessages($message, $sender);
}
/**
* Tests the sendMailMessages method.
*
* @dataProvider getSendMailMessages
*
* @covers ::sendMailMessages
*/
public function testSendMailMessages(bool $anonymous, ?bool $auto_reply, bool $copy_sender, array $results): void {
if ($anonymous) {
$message = $this->getAnonymousMockMessage(explode(', ', $results[0]['to']), $auto_reply, $copy_sender);
$sender = $this->getMockSender();
}
else {
$message = $this->getAuthenticatedMockMessage($copy_sender);
$sender = $this->getMockSender(FALSE, 'user@drupal.org');
}
$expected_params['contact_message'] = $message;
$expected_params['sender'] = $sender;
if ($anonymous) {
$expected_params['contact_form'] = $message->getContactForm();
}
else {
$expected_params['recipient'] = $message->getPersonalRecipient();
}
$this->logger->expects($this->once())
->method('info');
$this->mailManager->expects($this->any())
->method('mail')
->willReturnCallback(
function ($module, $key, $to, $langcode, $params, $from) use (&$results, $expected_params) {
$result = array_shift($results);
$this->assertEquals($module, $result['module']);
$this->assertEquals($key, $result['key']);
$this->assertEquals($to, $result['to']);
$this->assertEquals($langcode, $result['langcode']);
$this->assertEquals($params, $expected_params);
$this->assertEquals($from, $result['from']);
});
$this->userStorage->expects($this->any())
->method('load')
->willReturn(clone $sender);
$this->contactMailHandler->sendMailMessages($message, $sender);
}
/**
* Data provider for ::testSendMailMessages.
*/
public static function getSendMailMessages() {
$default_result = [
'module' => 'contact',
'key' => 'page_mail',
'to' => 'admin@drupal.org, user@drupal.org',
'langcode' => 'en',
'params' => [],
'from' => 'anonymous@drupal.org',
];
$autoreply_result = [
'key' => 'page_autoreply',
'to' => 'anonymous@drupal.org',
'from' => NULL,
] + $default_result;
$copy_result = [
'key' => 'page_copy',
'to' => 'anonymous@drupal.org',
] + $default_result;
yield 'anonymous, no auto reply, no copy sender' => [TRUE, FALSE, FALSE, [$default_result]];
yield 'anonymous, auto reply, no copy sender' => [TRUE, TRUE, FALSE, [$default_result, $autoreply_result]];
yield 'anonymous, no auto reply, copy sender' => [TRUE, FALSE, TRUE, [$default_result, $copy_result]];
yield 'anonymous, auto reply, copy sender' => [TRUE, TRUE, TRUE, [$default_result, $copy_result, $autoreply_result]];
// For authenticated user.
$default_result = [
'module' => 'contact',
'key' => 'user_mail',
'to' => 'user2@drupal.org',
'langcode' => 'en',
'from' => 'user@drupal.org',
];
$copy_result = [
'key' => 'user_copy',
'to' => 'user@drupal.org',
] + $default_result;
yield 'authenticated, no copy sender' => [FALSE, NULL, FALSE, [$default_result]];
yield 'authenticated, copy sender' => [FALSE, NULL, TRUE, [$default_result, $copy_result]];
}
/**
* Builds a mock sender on given scenario.
*
* @param bool $anonymous
* TRUE if the sender is anonymous.
* @param string $mail_address
* The mail address of the user.
*
* @return \Drupal\Core\Session\AccountInterface|\PHPUnit\Framework\MockObject\MockObject
* Mock sender for testing.
*/
protected function getMockSender($anonymous = TRUE, $mail_address = 'anonymous@drupal.org') {
$sender = $this->createMock(User::class);
$sender->expects($this->once())
->method('isAnonymous')
->willReturn($anonymous);
$sender->expects($this->any())
->method('getEmail')
->willReturn($mail_address);
$sender->expects($this->any())
->method('getDisplayName')
->willReturn('user');
// User ID 1 has special implications, use 3 instead.
$sender->expects($this->any())
->method('id')
->willReturn($anonymous ? 0 : 3);
if ($anonymous) {
// Anonymous user values set in params include updated values for name and
// mail.
$sender->name = 'Anonymous (not verified)';
$sender->mail = 'anonymous@drupal.org';
}
return $sender;
}
/**
* Builds a mock message from anonymous user.
*
* @param array $recipients
* An array of recipient email addresses.
* @param bool $auto_reply
* TRUE if auto reply is enable.
* @param bool $copy_sender
* TRUE if a copy should be sent, FALSE if not.
*
* @return \Drupal\contact\MessageInterface|\PHPUnit\Framework\MockObject\MockObject
* Mock message for testing.
*/
protected function getAnonymousMockMessage($recipients, $auto_reply, $copy_sender = FALSE) {
$message = $this->createMock('\Drupal\contact\MessageInterface');
$message->expects($this->any())
->method('getSenderName')
->willReturn('Anonymous');
$message->expects($this->once())
->method('getSenderMail')
->willReturn('anonymous@drupal.org');
$message->expects($this->any())
->method('isPersonal')
->willReturn(FALSE);
$message->expects($this->once())
->method('copySender')
->willReturn($copy_sender);
$message->expects($this->any())
->method('getContactForm')
->willReturn($this->getMockContactForm($recipients, $auto_reply ? 'reply' : ''));
return $message;
}
/**
* Builds a mock message from authenticated user.
*
* @param bool $copy_sender
* TRUE if a copy should be sent, FALSE if not.
*
* @return \Drupal\contact\MessageInterface|\PHPUnit\Framework\MockObject\MockObject
* Mock message for testing.
*/
protected function getAuthenticatedMockMessage($copy_sender = FALSE) {
$message = $this->createMock('\Drupal\contact\MessageInterface');
$message->expects($this->any())
->method('isPersonal')
->willReturn(TRUE);
$message->expects($this->once())
->method('copySender')
->willReturn($copy_sender);
$recipient = $this->createMock('\Drupal\user\UserInterface');
$recipient->expects($this->once())
->method('getEmail')
->willReturn('user2@drupal.org');
$recipient->expects($this->any())
->method('getDisplayName')
->willReturn('user2');
$recipient->expects($this->once())
->method('getPreferredLangcode')
->willReturn('en');
$message->expects($this->any())
->method('getPersonalRecipient')
->willReturn($recipient);
return $message;
}
/**
* Builds a mock message on given scenario.
*
* @param array $recipients
* An array of recipient email addresses.
* @param string $auto_reply
* An auto-reply message to send to the message author.
*
* @return \Drupal\contact\ContactFormInterface|\PHPUnit\Framework\MockObject\MockObject
* Mock message for testing.
*/
protected function getMockContactForm($recipients, $auto_reply) {
$contact_form = $this->createMock('\Drupal\contact\ContactFormInterface');
$contact_form->expects($this->once())
->method('getRecipients')
->willReturn($recipients);
$contact_form->expects($this->once())
->method('getReply')
->willReturn($auto_reply);
return $contact_form;
}
}