You are here

class ContactSitewideTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/contact/tests/src/Functional/ContactSitewideTest.php \Drupal\Tests\contact\Functional\ContactSitewideTest

Tests site-wide contact form functionality.

@group contact

Hierarchy

Expanded class hierarchy of ContactSitewideTest

See also

\Drupal\Tests\contact\Functional\ContactStorageTest

File

core/modules/contact/tests/src/Functional/ContactSitewideTest.php, line 22

Namespace

Drupal\Tests\contact\Functional
View source
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 = 'classy';

  /**
   * {@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() {

    // 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 = mb_strtolower($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 = mb_strtolower($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 = mb_strtolower($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(mb_strtolower($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 = mb_strtolower($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', '')
      ->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 = mb_strtolower($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('Add field');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Create a simple textfield.
    $field_name = mb_strtolower($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(t('[@label] @subject', [
      '@label' => $label,
      '@subject' => $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[@role="contentinfo"]');
    $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.
    $page_text = $this
      ->getSession()
      ->getPage()
      ->getText();
    $this
      ->assertGreaterThan(1, substr_count($page_text, 'Message'));
    $this
      ->assertSession()
      ->responseContains('class="field field--name-message field--type-string-long field--label-above');
    $this
      ->assertSession()
      ->pageTextContains($edit['message[0][value]']);

    // 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.
    $page_text = $this
      ->getSession()
      ->getPage()
      ->getText();
    $this
      ->assertEquals(1, substr_count($page_text, 'Message'));
    $this
      ->assertSession()
      ->responseContains('class="field field--name-message field--type-string-long field--label-hidden field__item">');
    $this
      ->assertSession()
      ->pageTextContains($edit['message[0][value]']);

    // 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() {

    // 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 e-mail 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');
  }

  /**
   * 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), new FormattableMarkup('Form %contact_form not found', [
          '%contact_form' => $contact_form
            ->label(),
        ]));
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated 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 Deprecated protected function Outputs to verbose the most recent $count emails sent.
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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for 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 Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$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::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
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::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::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__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.
ContactSitewideTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme 1
ContactSitewideTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules 1
ContactSitewideTest::addContactForm public function Adds a form.
ContactSitewideTest::deleteContactForms public function Deletes all forms.
ContactSitewideTest::setUp protected function Overrides BrowserTestBase::setUp
ContactSitewideTest::submitContact public function Submits the contact form.
ContactSitewideTest::testAutoReply public function Tests auto-reply on the site-wide contact form.
ContactSitewideTest::testSiteWideContact public function Tests configuration options and the site-wide contact form.
ContactSitewideTest::updateContactForm public function Updates a form.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FieldUiTestTrait::fieldUIAddExistingField public function Adds an existing field through the Field UI.
FieldUiTestTrait::fieldUIAddNewField public function Creates a new field through the Field UI.
FieldUiTestTrait::fieldUIDeleteField public function Deletes a field through the Field UI.
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::$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. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
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. 20
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. 1
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
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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. 1
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. 1
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. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 2
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 Deprecated 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::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.