class DialogTest in Drupal 10

Same name and namespace in other branches

8 core/tests/Drupal/FunctionalJavascriptTests/Ajax/DialogTest.php \Drupal\FunctionalJavascriptTests\Ajax\DialogTest
9 core/tests/Drupal/FunctionalJavascriptTests/Ajax/DialogTest.php \Drupal\FunctionalJavascriptTests\Ajax\DialogTest

Performs tests on opening and manipulating dialogs via AJAX commands.

@group Ajax

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\FunctionalJavascriptTests\WebDriverTestBase
  - class \Drupal\FunctionalJavascriptTests\Ajax\DialogTest

Expanded class hierarchy of DialogTest

File

core/tests/Drupal/FunctionalJavascriptTests/Ajax/DialogTest.php, line 14

Namespace

Drupal\FunctionalJavascriptTests\Ajax

View source

class DialogTest extends WebDriverTestBase {

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

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

  /**
   * Tests 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 an 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 panel 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
        ->assertStringContainsStringIgnoringCase('display: none;', $styles);
      $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
        ->assertEquals($hidden_button_text[$key], $button
        ->getText());
    }

    // 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
      ->assertNotEmpty($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.');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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 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::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::$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.	14
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 test environment.
BrowserTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance	protected	function	Gets an instance of the default Mink driver.
BrowserTestBase::getHttpClient	protected	function	Obtain the HTTP client for the system under test.
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::installDrupal	public	function	Installs Drupal into the test site.	1
BrowserTestBase::registerSessions	protected	function	Registers additional Mink sessions.
BrowserTestBase::setUp	protected	function		132
BrowserTestBase::setUpAppRoot	protected	function	Sets up the root application path.
BrowserTestBase::setUpBeforeClass	public static	function
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.
DialogTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
DialogTest::$modules	protected static	property	Modules to enable. Overrides BrowserTestBase::$modules
DialogTest::testDialog	public	function	Tests sending non-JS and AJAX requests to open and manipulate modals.
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
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.
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::installParameters	protected	function	Returns the parameters that will be used when the test installs Drupal.	4
FunctionalTestSetupTrait::prepareEnvironment	protected	function	Prepares the current environment for running the test.	21
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.	3
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
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.
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.
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 under test.
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::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.
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::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.
WebDriverTestBase::$disableCssAnimations	protected	property	Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$failOnJavascriptConsoleErrors	protected	property	Determines if a test should fail on JavaScript console errors.	1
WebDriverTestBase::$minkDefaultDriverClass	protected	property	Mink class for the default driver to use. Overrides BrowserTestBase::$minkDefaultDriverClass	1
WebDriverTestBase::assertJsCondition	protected	function	Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession	public	function	Returns WebAssert object. Overrides UiHelperTrait::assertSession
WebDriverTestBase::createScreenshot	protected	function	Creates a screenshot.
WebDriverTestBase::failOnJavaScriptErrors	protected	function	Triggers a test failure if a JavaScript error was encountered.
WebDriverTestBase::getDrupalSettings	protected	function	Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders	protected	function	Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::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. Overrides BrowserTestBase::getMinkDriverArgs
WebDriverTestBase::initFrontPage	protected	function	Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink	protected	function	Initializes Mink sessions. Overrides BrowserTestBase::initMink
WebDriverTestBase::installModulesFromClassProperty	protected	function	Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty
WebDriverTestBase::tearDown	protected	function	Overrides BrowserTestBase::tearDown
XdebugRequestTrait::extractCookiesFromRequest	protected	function	Adds xdebug cookies, from request setup.

You are here

class DialogTest in Drupal 10

Hierarchy

File

Namespace

Members

API Navigation