class CommandsTest

Same name in this branch
  1. 10 core/tests/Drupal/KernelTests/Core/Ajax/CommandsTest.php \Drupal\KernelTests\Core\Ajax\CommandsTest
Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Ajax/CommandsTest.php \Drupal\KernelTests\Core\Ajax\CommandsTest
  2. 9 core/tests/Drupal/FunctionalJavascriptTests/Ajax/CommandsTest.php \Drupal\FunctionalJavascriptTests\Ajax\CommandsTest
  3. 8.9.x core/tests/Drupal/KernelTests/Core/Ajax/CommandsTest.php \Drupal\KernelTests\Core\Ajax\CommandsTest
  4. 8.9.x core/tests/Drupal/FunctionalJavascriptTests/Ajax/CommandsTest.php \Drupal\FunctionalJavascriptTests\Ajax\CommandsTest
  5. 11.x core/tests/Drupal/KernelTests/Core/Ajax/CommandsTest.php \Drupal\KernelTests\Core\Ajax\CommandsTest
  6. 11.x core/tests/Drupal/FunctionalJavascriptTests/Ajax/CommandsTest.php \Drupal\FunctionalJavascriptTests\Ajax\CommandsTest

Performs tests on AJAX framework commands.

@group Ajax

Hierarchy

Expanded class hierarchy of CommandsTest

File

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

Namespace

Drupal\FunctionalJavascriptTests\Ajax
View source
class CommandsTest extends WebDriverTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'ajax_test',
        'ajax_forms_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests the various Ajax Commands.
     */
    public function testAjaxCommands() : void {
        $session = $this->getSession();
        $page = $this->getSession()
            ->getPage();
        $form_path = 'ajax_forms_test_ajax_commands_form';
        $web_user = $this->drupalCreateUser([
            'access content',
        ]);
        $this->drupalLogin($web_user);
        $this->drupalGet($form_path);
        // Tests the 'add_css' command.
        $page->pressButton("AJAX 'add_css' command");
        $this->assertWaitPageContains('my/file.css');
        $this->assertSession()
            ->elementExists('css', 'link[href="my/file.css"]');
        $this->assertSession()
            ->elementExists('css', 'link[href="https://example.com/css?family=Open+Sans"]');
        // Tests the 'after' command.
        $page->pressButton("AJAX 'After': Click to put something after the div");
        $this->assertWaitPageContains('<div id="after_div">Something can be inserted after this</div>This will be placed after');
        // Tests the 'alert' command.
        $page->pressButton("AJAX 'Alert': Click to alert");
        // Wait for the alert to appear.
        $page->waitFor(10, function () use ($session) {
            try {
                $session->getDriver()
                    ->getWebDriverSession()
                    ->getAlert_text();
                return TRUE;
            } catch (\Exception $e) {
                return FALSE;
            }
        });
        $alert_text = $this->getSession()
            ->getDriver()
            ->getWebDriverSession()
            ->getAlert_text();
        $this->assertEquals('Alert', $alert_text);
        $this->getSession()
            ->getDriver()
            ->getWebDriverSession()
            ->accept_alert();
        $this->drupalGet($form_path);
        $page->pressButton("AJAX 'Announce': Click to announce");
        $this->assertWaitPageContains('<div id="drupal-live-announce" class="visually-hidden" aria-live="polite" aria-busy="false">Default announcement.</div>');
        $this->drupalGet($form_path);
        $page->pressButton("AJAX 'Announce': Click to announce with 'polite' priority");
        $this->assertWaitPageContains('<div id="drupal-live-announce" class="visually-hidden" aria-live="polite" aria-busy="false">Polite announcement.</div>');
        $this->drupalGet($form_path);
        $page->pressButton("AJAX 'Announce': Click to announce with 'assertive' priority");
        $this->assertWaitPageContains('<div id="drupal-live-announce" class="visually-hidden" aria-live="assertive" aria-busy="false">Assertive announcement.</div>');
        $this->drupalGet($form_path);
        $page->pressButton("AJAX 'Announce': Click to announce twice");
        $this->assertWaitPageContains('<div id="drupal-live-announce" class="visually-hidden" aria-live="assertive" aria-busy="false">Assertive announcement.' . "\nAnother announcement.</div>");
        // Tests the 'append' command.
        $page->pressButton("AJAX 'Append': Click to append something");
        $this->assertWaitPageContains('<div id="append_div">Append inside this divAppended text</div>');
        // Tests the 'before' command.
        $page->pressButton("AJAX 'before': Click to put something before the div");
        $this->assertWaitPageContains('Before text<div id="before_div">Insert something before this.</div>');
        // Tests the 'changed' command.
        $page->pressButton("AJAX changed: Click to mark div changed.");
        $this->assertWaitPageContains('<div id="changed_div" class="ajax-changed">');
        // Tests the 'changed' command using the second argument.
        // Refresh page for testing 'changed' command to same element again.
        $this->drupalGet($form_path);
        $page->pressButton("AJAX changed: Click to mark div changed with asterisk.");
        $this->assertWaitPageContains('<div id="changed_div" class="ajax-changed"> <div id="changed_div_mark_this">This div can be marked as changed or not. <abbr class="ajax-changed" title="Changed">*</abbr> </div></div>');
        // Tests the 'css' command.
        $page->pressButton("Set the '#box' div to be blue.");
        $this->assertWaitPageContains('<div id="css_div" style="background-color: blue;">');
        // Tests the 'data' command.
        $page->pressButton("AJAX data command: Issue command.");
        $this->assertTrue($page->waitFor(10, function () use ($session) {
            return 'test_value' === $session->evaluateScript('window.jQuery("#data_div").data("test_key")');
        }));
        // Tests the 'html' command.
        $page->pressButton("AJAX html: Replace the HTML in a selector.");
        $this->assertWaitPageContains('<div id="html_div">replacement text</div>');
        // Tests the 'insert' command.
        $page->pressButton("AJAX insert: Let client insert based on #ajax['method'].");
        $this->assertWaitPageContains('<div id="insert_div">insert replacement textOriginal contents</div>');
        // Tests the 'invoke' command.
        $page->pressButton("AJAX invoke command: Invoke addClass() method.");
        $this->assertWaitPageContains('<div id="invoke_div" class="error">Original contents</div>');
        // Tests the 'prepend' command.
        $page->pressButton("AJAX 'prepend': Click to prepend something");
        $this->assertWaitPageContains('<div id="prepend_div">prepended textSomething will be prepended to this div. </div>');
        // Tests the 'remove' command.
        $page->pressButton("AJAX 'remove': Click to remove text");
        $this->assertWaitPageContains('<div id="remove_div"></div>');
        // Tests the 'restripe' command.
        $page->pressButton("AJAX 'restripe' command");
        $this->assertWaitPageContains('<tr id="table-first" class="odd"><td>first row</td></tr>');
        $this->assertWaitPageContains('<tr class="even"><td>second row</td></tr>');
        // Tests the 'settings' command.
        $test_settings_command = <<<JS
Drupal.behaviors.testSettingsCommand = {
  attach: function (context, settings) {
    window.jQuery('body').append('<div class="test-settings-command">' + settings.ajax_forms_test.foo + '</div>');
  }
};
JS;
        $session->executeScript($test_settings_command);
        // @todo Replace after https://www.drupal.org/project/drupal/issues/2616184
        $session->executeScript('window.jQuery("#edit-settings-command-example").mousedown();');
        $this->assertWaitPageContains('<div class="test-settings-command">42</div>');
    }
    
    /**
     * Tests the various Ajax Commands with legacy parameters.
     * @group legacy
     */
    public function testLegacyAjaxCommands() : void {
        $session = $this->getSession();
        $page = $this->getSession()
            ->getPage();
        $form_path = 'ajax_forms_test_ajax_commands_form';
        $web_user = $this->drupalCreateUser([
            'access content',
        ]);
        $this->drupalLogin($web_user);
        $this->drupalGet($form_path);
        // Tests the 'add_css' command with legacy string value.
        $this->expectDeprecation('Javascript Deprecation: Passing a string to the Drupal.ajax.add_css() method is deprecated in 10.1.0 and is removed from drupal:11.0.0. See https://www.drupal.org/node/3154948.');
        $page->pressButton("AJAX 'add_css' legacy command");
        $this->assertWaitPageContains('my/file.css');
    }
    
    /**
     * Asserts that page contains a text after waiting.
     *
     * @param string $text
     *   A needle text.
     *
     * @internal
     */
    protected function assertWaitPageContains(string $text) : void {
        $page = $this->getSession()
            ->getPage();
        $page->waitFor(10, function () use ($page, $text) {
            return stripos($page->getContent(), $text) !== FALSE;
        });
        $this->assertStringContainsString($text, $page->getContent());
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
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 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 SettingsEditor::rewrite().
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. 40
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. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUp protected function 544
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
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::__get public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
CommandsTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
CommandsTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
CommandsTest::assertWaitPageContains protected function Asserts that page contains a text after waiting.
CommandsTest::testAjaxCommands public function Tests the various Ajax Commands.
CommandsTest::testLegacyAjaxCommands public function Tests the various Ajax Commands with legacy parameters.
@group legacy
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.
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.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
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. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
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. 4
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::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 Deprecated public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
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 Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated 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. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
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::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
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 Deprecated 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::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
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. 3
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::drupalResetSession protected function Resets the current active session back to Anonymous session.
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.
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. 2
WebDriverTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. Overrides BrowserTestBase::$minkDefaultDriverClass
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 Gets the Mink driver args from an environment variable. Overrides BrowserTestBase::getMinkDriverArgs 1
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 1
WebDriverTestBase::tearDown protected function Overrides BrowserTestBase::tearDown 1
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.