DialogTest.php in Drupal 8

Namespace

Drupal\FunctionalJavascriptTests\Ajax

File

core/tests/Drupal/FunctionalJavascriptTests/Ajax/DialogTest.php

<?php

namespace Drupal\FunctionalJavascriptTests\Ajax;

use Drupal\ajax_test\Controller\AjaxTestController;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\FunctionalJavascriptTests\WebDriverTestBase;

/**
 * Performs tests on opening and manipulating dialogs via AJAX commands.
 *
 * @group Ajax
 */
class DialogTest extends WebDriverTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'ajax_test',
    'ajax_forms_test',
    'contact',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'classy';

  /**
   * Test sending non-JS and AJAX requests to open and manipulate modals.
   */
  public function testDialog() {
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'administer contact forms',
    ]));

    // Ensure the elements render without notices or exceptions.
    $this
      ->drupalGet('ajax-test/dialog');

    // Set up variables for this test.
    $dialog_renderable = AjaxTestController::dialogContents();
    $dialog_contents = \Drupal::service('renderer')
      ->renderRoot($dialog_renderable);

    // Check that requesting a modal dialog without JS goes to a page.
    $this
      ->drupalGet('ajax-test/dialog-contents');
    $this
      ->assertSession()
      ->responseContains($dialog_contents);

    // Visit the page containing the many test dialog links.
    $this
      ->drupalGet('ajax-test/dialog');

    // Tests a basic modal dialog by verifying the contents of the dialog are as
    // expected.
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Link 1 (modal)');

    // Clicking the link triggers a AJAX request/response.
    // Opens a Dialog panel.
    $link1_dialog_div = $this
      ->assertSession()
      ->waitForElementVisible('css', 'div.ui-dialog');
    $this
      ->assertNotNull($link1_dialog_div, 'Link was used to open a dialog ( modal )');
    $link1_modal = $link1_dialog_div
      ->find('css', '#drupal-modal');
    $this
      ->assertNotNull($link1_modal, 'Link was used to open a dialog ( non-modal )');
    $this
      ->assertSession()
      ->responseContains($dialog_contents);
    $dialog_title = $link1_dialog_div
      ->find('css', "span.ui-dialog-title:contains('AJAX Dialog & contents')");
    $this
      ->assertNotNull($dialog_title);
    $dialog_title_amp = $link1_dialog_div
      ->find('css', "span.ui-dialog-title:contains('AJAX Dialog &amp; contents')");
    $this
      ->assertNull($dialog_title_amp);

    // Close open dialog, return to the dialog links page.
    $close_button = $link1_dialog_div
      ->findButton('Close');
    $this
      ->assertNotNull($close_button);
    $close_button
      ->press();

    // Tests a modal with a dialog-option.
    // Link 2 is similar to Link 1, except it submits additional width
    // information which must be echoed in the resulting  DOM update.
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Link 2 (modal)');
    $dialog = $this
      ->assertSession()
      ->waitForElementVisible('css', 'div.ui-dialog');
    $this
      ->assertNotNull($dialog, 'Link was used to open a dialog ( non-modal, with options )');
    $style = $dialog
      ->getAttribute('style');
    $this
      ->assertStringContainsString('width: 400px;', $style, new FormattableMarkup('Modal respected the dialog-options width parameter.  Style = style', [
      '%style' => $style,
    ]));

    // Reset: Return to the dialog links page.
    $this
      ->drupalGet('ajax-test/dialog');

    // Test a non-modal dialog ( with target ).
    $this
      ->clickLink('Link 3 (non-modal)');
    $non_modal_dialog = $this
      ->assertSession()
      ->waitForElementVisible('css', 'div.ui-dialog');
    $this
      ->assertNotNull($non_modal_dialog, 'Link opens a non-modal dialog.');

    // Tests the dialog contains a target element specified in the AJAX request.
    $non_modal_dialog
      ->find('css', 'div#ajax-test-dialog-wrapper-1');
    $this
      ->assertSession()
      ->responseContains($dialog_contents);

    // Reset: Return to the dialog links page.
    $this
      ->drupalGet('ajax-test/dialog');

    // Tests a non-modal dialog ( without target ).
    $this
      ->clickLink('Link 7 (non-modal, no target)');
    $no_target_dialog = $this
      ->assertSession()
      ->waitForElementVisible('css', 'div.ui-dialog');
    $this
      ->assertNotNull($no_target_dialog, 'Link opens a non-modal dialog.');
    $contents_no_target = $no_target_dialog
      ->find('css', 'div.ui-dialog-content');
    $this
      ->assertNotNull($contents_no_target, 'non-modal dialog opens ( no target ). ');
    $id = $contents_no_target
      ->getAttribute('id');
    $partial_match = strpos($id, 'drupal-dialog-ajax-testdialog-contents') === 0;
    $this
      ->assertTrue($partial_match, 'The non-modal ID has the expected prefix.');
    $no_target_button = $no_target_dialog
      ->findButton('Close');
    $this
      ->assertNotNull($no_target_button, 'Link dialog has a close button');
    $no_target_button
      ->press();
    $this
      ->getSession()
      ->getPage()
      ->findButton('Button 1 (modal)')
      ->press();
    $button1_dialog = $this
      ->assertSession()
      ->waitForElementVisible('css', 'div.ui-dialog');
    $this
      ->assertNotNull($button1_dialog, 'Button opens a modal dialog.');
    $button1_dialog_content = $button1_dialog
      ->find('css', 'div.ui-dialog-content');
    $this
      ->assertNotNull($button1_dialog_content, 'Button opens a modal dialog.');

    // Test the HTML escaping of & character.
    $button1_dialog_title = $button1_dialog
      ->find('css', "span.ui-dialog-title:contains('AJAX Dialog & contents')");
    $this
      ->assertNotNull($button1_dialog_title);
    $button1_dialog_title_amp = $button1_dialog
      ->find('css', "span.ui-dialog-title:contains('AJAX Dialog &amp; contents')");
    $this
      ->assertNull($button1_dialog_title_amp);

    // Reset: Close the dialog.
    $button1_dialog
      ->findButton('Close')
      ->press();

    // Abbreviated test for "normal" dialogs, testing only the difference.
    $this
      ->getSession()
      ->getPage()
      ->findButton('Button 2 (non-modal)')
      ->press();
    $button2_dialog = $this
      ->assertSession()
      ->waitForElementVisible('css', 'div.ui-dialog-content');
    $this
      ->assertNotNull($button2_dialog, 'Non-modal content displays as expected.');

    // Use a link to close the pagnel opened by button 2.
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Link 4 (close non-modal if open)');

    // Form modal.
    $this
      ->clickLink('Link 5 (form)');

    // Two links have been clicked in succession - This time wait for a change
    // in the title as the previous closing dialog may temporarily be open.
    $form_dialog_title = $this
      ->assertSession()
      ->waitForElementVisible('css', "span.ui-dialog-title:contains('Ajax Form contents')");
    $this
      ->assertNotNull($form_dialog_title, 'Dialog form has the expected title.');

    // Locate the newly opened dialog.
    $form_dialog = $this
      ->getSession()
      ->getPage()
      ->find('css', 'div.ui-dialog');
    $this
      ->assertNotNull($form_dialog, 'Form dialog is visible');
    $form_contents = $form_dialog
      ->find('css', "p:contains('Ajax Form contents description.')");
    $this
      ->assertNotNull($form_contents, 'For has the expected text.');
    $do_it = $form_dialog
      ->findButton('Do it');
    $this
      ->assertNotNull($do_it, 'The dialog has a "Do it" button.');
    $preview = $form_dialog
      ->findButton('Preview');
    $this
      ->assertNotNull($preview, 'The dialog contains a "Preview" button.');

    // When a form with submit inputs is in a dialog, the form's submit inputs
    // are copied to the dialog buttonpane as buttons. The originals should have
    // their styles set to display: none.
    $hidden_buttons = $this
      ->getSession()
      ->getPage()
      ->findAll('css', '.ajax-test-form [type="submit"]');
    $this
      ->assertCount(2, $hidden_buttons);
    $hidden_button_text = [];
    foreach ($hidden_buttons as $button) {
      $styles = $button
        ->getAttribute('style');
      $this
        ->assertTrue(stripos($styles, 'display: none;') !== FALSE);
      $hidden_button_text[] = $button
        ->getAttribute('value');
    }

    // The copied buttons should have the same text as the submit inputs they
    // were copied from.
    $moved_to_buttonpane_buttons = $this
      ->getSession()
      ->getPage()
      ->findAll('css', '.ui-dialog-buttonpane button');
    $this
      ->assertCount(2, $moved_to_buttonpane_buttons);
    foreach ($moved_to_buttonpane_buttons as $key => $button) {
      $this
        ->assertEqual($button
        ->getText(), $hidden_button_text[$key]);
    }

    // Reset: close the form.
    $form_dialog
      ->findButton('Close')
      ->press();

    // Non AJAX version of Link 6.
    $this
      ->drupalGet('admin/structure/contact/add');

    // Check we get a chunk of the code, we can't test the whole form as form
    // build id and token with be different.
    $contact_form = $this
      ->xpath("//form[@id='contact-form-add-form']");
    $this
      ->assertTrue(!empty($contact_form), 'Non-JS entity form page present.');

    // Reset: Return to the dialog links page.
    $this
      ->drupalGet('ajax-test/dialog');
    $this
      ->clickLink('Link 6 (entity form)');
    $dialog_add = $this
      ->assertSession()
      ->waitForElementVisible('css', 'div.ui-dialog');
    $this
      ->assertNotNull($dialog_add, 'Form dialog is visible');
    $form_add = $dialog_add
      ->find('css', 'form.contact-form-add-form');
    $this
      ->assertNotNull($form_add, 'Modal dialog JSON contains entity form.');
    $form_title = $dialog_add
      ->find('css', "span.ui-dialog-title:contains('Add contact form')");
    $this
      ->assertNotNull($form_title, 'The add form title is as expected.');
  }

}

Classes

Name	Description
DialogTest	Performs tests on opening and manipulating dialogs via AJAX commands.