You are here

Home » API reference » Drupal 10 » ContactSitewideTest.php » ContactSitewideTest

public function ContactSitewideTest::testSiteWideContact in Drupal 10

Same name and namespace in other branches
  1. 8 core/modules/contact/tests/src/Functional/ContactSitewideTest.php \Drupal\Tests\contact\Functional\ContactSitewideTest::testSiteWideContact()
  2. 9 core/modules/contact/tests/src/Functional/ContactSitewideTest.php \Drupal\Tests\contact\Functional\ContactSitewideTest::testSiteWideContact()

Tests configuration options and the site-wide contact form.

File

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

Class

ContactSitewideTest
Tests site-wide contact form functionality.

Namespace

Drupal\Tests\contact\Functional

Code

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[@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');
}