class FrameworkTest in Zircon Profile 8

Same name and namespace in other branches

8.0 core/modules/system/src/Tests/Ajax/FrameworkTest.php \Drupal\system\Tests\Ajax\FrameworkTest

Performs tests on AJAX framework functions.

@group Ajax

Hierarchy

class \Drupal\simpletest\TestBase uses AssertHelperTrait, RandomGeneratorTrait, SessionTestTrait
- class \Drupal\simpletest\WebTestBase uses AssertContentTrait, UserCreationTrait
  - class \Drupal\system\Tests\Ajax\AjaxTestBase
    class \Drupal\system\Tests\Ajax\FrameworkTest

Expanded class hierarchy of FrameworkTest

File

core/modules/system/src/Tests/Ajax/FrameworkTest.php, line 23: Contains \Drupal\system\Tests\Ajax\FrameworkTest.

Namespace

Drupal\system\Tests\Ajax

View source

class FrameworkTest extends AjaxTestBase {

  /**
   * Ensures \Drupal\Core\Ajax\AjaxResponse::ajaxRender() returns JavaScript settings from the page request.
   */
  public function testAJAXRender() {

    // Verify that settings command is generated if JavaScript settings exist.
    $commands = $this
      ->drupalGetAjax('ajax-test/render');
    $expected = new SettingsCommand(array(
      'ajax' => 'test',
    ), TRUE);
    $this
      ->assertCommand($commands, $expected
      ->render(), '\\Drupal\\Core\\Ajax\\AjaxResponse::ajaxRender() loads JavaScript settings.');
  }

  /**
   * Tests AjaxResponse::prepare() AJAX commands ordering.
   */
  public function testOrder() {
    $expected_commands = array();

    // Expected commands, in a very specific order.
    $asset_resolver = \Drupal::service('asset.resolver');
    $css_collection_renderer = \Drupal::service('asset.css.collection_renderer');
    $js_collection_renderer = \Drupal::service('asset.js.collection_renderer');
    $renderer = \Drupal::service('renderer');
    $expected_commands[0] = new SettingsCommand(array(
      'ajax' => 'test',
    ), TRUE);
    $build['#attached']['library'][] = 'ajax_test/order-css-command';
    $assets = AttachedAssets::createFromRenderArray($build);
    $css_render_array = $css_collection_renderer
      ->render($asset_resolver
      ->getCssAssets($assets, FALSE));
    $expected_commands[1] = new AddCssCommand($renderer
      ->renderRoot($css_render_array));
    $build['#attached']['library'][] = 'ajax_test/order-header-js-command';
    $build['#attached']['library'][] = 'ajax_test/order-footer-js-command';
    $assets = AttachedAssets::createFromRenderArray($build);
    list($js_assets_header, $js_assets_footer) = $asset_resolver
      ->getJsAssets($assets, FALSE);
    $js_header_render_array = $js_collection_renderer
      ->render($js_assets_header);
    $js_footer_render_array = $js_collection_renderer
      ->render($js_assets_footer);
    $expected_commands[2] = new PrependCommand('head', $js_header_render_array);
    $expected_commands[3] = new AppendCommand('body', $js_footer_render_array);
    $expected_commands[4] = new HtmlCommand('body', 'Hello, world!');

    // Load any page with at least one CSS file, at least one JavaScript file
    // and at least one #ajax-powered element. The latter is an assumption of
    // drupalPostAjaxForm(), the two former are assumptions of
    // AjaxResponse::ajaxRender().
    // @todo refactor AJAX Framework + tests to make less assumptions.
    $this
      ->drupalGet('ajax_forms_test_lazy_load_form');

    // Verify AJAX command order — this should always be the order:
    // 1. JavaScript settings
    // 2. CSS files
    // 3. JavaScript files in the header
    // 4. JavaScript files in the footer
    // 5. Any other AJAX commands, in whatever order they were added.
    $commands = $this
      ->drupalPostAjaxForm(NULL, array(), NULL, 'ajax-test/order', array(), array(), NULL, array());
    $this
      ->assertCommand(array_slice($commands, 0, 1), $expected_commands[0]
      ->render(), 'Settings command is first.');
    $this
      ->assertCommand(array_slice($commands, 1, 1), $expected_commands[1]
      ->render(), 'CSS command is second (and CSS files are ordered correctly).');
    $this
      ->assertCommand(array_slice($commands, 2, 1), $expected_commands[2]
      ->render(), 'Header JS command is third.');
    $this
      ->assertCommand(array_slice($commands, 3, 1), $expected_commands[3]
      ->render(), 'Footer JS command is fourth.');
    $this
      ->assertCommand(array_slice($commands, 4, 1), $expected_commands[4]
      ->render(), 'HTML command is fifth.');
  }

  /**
   * Tests the behavior of an error alert command.
   */
  public function testAJAXRenderError() {

    // Verify custom error message.
    $edit = array(
      'message' => 'Custom error message.',
    );
    $commands = $this
      ->drupalGetAjax('ajax-test/render-error', array(
      'query' => $edit,
    ));
    $expected = new AlertCommand($edit['message']);
    $this
      ->assertCommand($commands, $expected
      ->render(), 'Custom error message is output.');
  }

  /**
   * Tests that new JavaScript and CSS files are lazy-loaded on an AJAX request.
   */
  public function testLazyLoad() {
    $asset_resolver = \Drupal::service('asset.resolver');
    $css_collection_renderer = \Drupal::service('asset.css.collection_renderer');
    $js_collection_renderer = \Drupal::service('asset.js.collection_renderer');
    $renderer = \Drupal::service('renderer');
    $expected = array(
      'setting_name' => 'ajax_forms_test_lazy_load_form_submit',
      'setting_value' => 'executed',
      'library_1' => 'system/admin',
      'library_2' => 'system/drupal.system',
    );

    // Get the base page.
    $this
      ->drupalGet('ajax_forms_test_lazy_load_form');
    $original_settings = $this
      ->getDrupalSettings();
    $original_libraries = explode(',', $original_settings['ajaxPageState']['libraries']);

    // Verify that the base page doesn't have the settings and files that are to
    // be lazy loaded as part of the next requests.
    $this
      ->assertTrue(!isset($original_settings[$expected['setting_name']]), format_string('Page originally lacks the %setting, as expected.', array(
      '%setting' => $expected['setting_name'],
    )));
    $this
      ->assertTrue(!in_array($expected['library_1'], $original_libraries), format_string('Page originally lacks the %library library, as expected.', array(
      '%library' => $expected['library_1'],
    )));
    $this
      ->assertTrue(!in_array($expected['library_2'], $original_libraries), format_string('Page originally lacks the %library library, as expected.', array(
      '%library' => $expected['library_2'],
    )));

    // Calculate the expected CSS and JS.
    $assets = new AttachedAssets();
    $assets
      ->setLibraries([
      $expected['library_1'],
    ])
      ->setAlreadyLoadedLibraries($original_libraries);
    $css_render_array = $css_collection_renderer
      ->render($asset_resolver
      ->getCssAssets($assets, FALSE));
    $expected_css_html = $renderer
      ->renderRoot($css_render_array);
    $assets
      ->setLibraries([
      $expected['library_2'],
    ])
      ->setAlreadyLoadedLibraries($original_libraries);
    $js_assets = $asset_resolver
      ->getJsAssets($assets, FALSE)[1];
    unset($js_assets['drupalSettings']);
    $js_render_array = $js_collection_renderer
      ->render($js_assets);
    $expected_js_html = $renderer
      ->renderRoot($js_render_array);

    // Submit the AJAX request without triggering files getting added.
    $commands = $this
      ->drupalPostAjaxForm(NULL, array(
      'add_files' => FALSE,
    ), array(
      'op' => t('Submit'),
    ));
    $new_settings = $this
      ->getDrupalSettings();
    $new_libraries = explode(',', $new_settings['ajaxPageState']['libraries']);

    // Verify the setting was not added when not expected.
    $this
      ->assertTrue(!isset($new_settings[$expected['setting_name']]), format_string('Page still lacks the %setting, as expected.', array(
      '%setting' => $expected['setting_name'],
    )));
    $this
      ->assertTrue(!in_array($expected['library_1'], $new_libraries), format_string('Page still lacks the %library library, as expected.', array(
      '%library' => $expected['library_1'],
    )));
    $this
      ->assertTrue(!in_array($expected['library_2'], $new_libraries), format_string('Page still lacks the %library library, as expected.', array(
      '%library' => $expected['library_2'],
    )));

    // Verify a settings command does not add CSS or scripts to drupalSettings
    // and no command inserts the corresponding tags on the page.
    $found_settings_command = FALSE;
    $found_markup_command = FALSE;
    foreach ($commands as $command) {
      if ($command['command'] == 'settings' && (array_key_exists('css', $command['settings']['ajaxPageState']) || array_key_exists('js', $command['settings']['ajaxPageState']))) {
        $found_settings_command = TRUE;
      }
      if (isset($command['data']) && ($command['data'] == $expected_js_html || $command['data'] == $expected_css_html)) {
        $found_markup_command = TRUE;
      }
    }
    $this
      ->assertFalse($found_settings_command, format_string('Page state still lacks the %library_1 and %library_2 libraries, as expected.', array(
      '%library_1' => $expected['library_1'],
      '%library_2' => $expected['library_2'],
    )));
    $this
      ->assertFalse($found_markup_command, format_string('Page still lacks the %library_1 and %library_2 libraries, as expected.', array(
      '%library_1' => $expected['library_1'],
      '%library_2' => $expected['library_2'],
    )));

    // Submit the AJAX request and trigger adding files.
    $commands = $this
      ->drupalPostAjaxForm(NULL, array(
      'add_files' => TRUE,
    ), array(
      'op' => t('Submit'),
    ));
    $new_settings = $this
      ->getDrupalSettings();
    $new_libraries = explode(',', $new_settings['ajaxPageState']['libraries']);

    // Verify the expected setting was added, both to drupalSettings, and as
    // the first AJAX command.
    $this
      ->assertIdentical($new_settings[$expected['setting_name']], $expected['setting_value'], format_string('Page now has the %setting.', array(
      '%setting' => $expected['setting_name'],
    )));
    $expected_command = new SettingsCommand(array(
      $expected['setting_name'] => $expected['setting_value'],
    ), TRUE);
    $this
      ->assertCommand(array_slice($commands, 0, 1), $expected_command
      ->render(), 'The settings command was first.');

    // Verify the expected CSS file was added, both to drupalSettings, and as
    // the second AJAX command for inclusion into the HTML.
    $this
      ->assertTrue(in_array($expected['library_1'], $new_libraries), format_string('Page state now has the %library library.', array(
      '%library' => $expected['library_1'],
    )));
    $this
      ->assertCommand(array_slice($commands, 1, 1), array(
      'data' => $expected_css_html,
    ), format_string('Page now has the %library library.', array(
      '%library' => $expected['library_1'],
    )));

    // Verify the expected JS file was added, both to drupalSettings, and as
    // the third AJAX command for inclusion into the HTML. By testing for an
    // exact HTML string containing the SCRIPT tag, we also ensure that
    // unexpected JavaScript code, such as a jQuery.extend() that would
    // potentially clobber rather than properly merge settings, didn't
    // accidentally get added.
    $this
      ->assertTrue(in_array($expected['library_2'], $new_libraries), format_string('Page state now has the %library library.', array(
      '%library' => $expected['library_2'],
    )));
    $this
      ->assertCommand(array_slice($commands, 2, 1), array(
      'data' => $expected_js_html,
    ), format_string('Page now has the %library library.', array(
      '%library' => $expected['library_2'],
    )));
  }

  /**
   * Tests that drupalSettings.currentPath is not updated on AJAX requests.
   */
  public function testCurrentPathChange() {
    $commands = $this
      ->drupalPostAjaxForm('ajax_forms_test_lazy_load_form', array(
      'add_files' => FALSE,
    ), array(
      'op' => t('Submit'),
    ));
    foreach ($commands as $command) {
      if ($command['command'] == 'settings') {
        $this
          ->assertFalse(isset($command['settings']['currentPath']), 'Value of drupalSettings.currentPath is not updated after an AJAX request.');
      }
    }
  }

  /**
   * Tests that overridden CSS files are not added during lazy load.
   */
  public function testLazyLoadOverriddenCSS() {

    // The test theme overrides system.module.css without an implementation,
    // thereby removing it.
    \Drupal::service('theme_handler')
      ->install(array(
      'test_theme',
    ));
    $this
      ->config('system.theme')
      ->set('default', 'test_theme')
      ->save();

    // This gets the form, and emulates an Ajax submission on it, including
    // adding markup to the HEAD and BODY for any lazy loaded JS/CSS files.
    $this
      ->drupalPostAjaxForm('ajax_forms_test_lazy_load_form', array(
      'add_files' => TRUE,
    ), array(
      'op' => t('Submit'),
    ));

    // Verify that the resulting HTML does not load the overridden CSS file.
    // We add a "?" to the assertion, because drupalSettings may include
    // information about the file; we only really care about whether it appears
    // in a LINK or STYLE tag, for which Drupal always adds a query string for
    // cache control.
    $this
      ->assertNoText('system.module.css?', 'Ajax lazy loading does not add overridden CSS files.');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AjaxTestBase::$modules	public static	property	Modules to enable.	2
AjaxTestBase::assertCommand	protected	function	Asserts the array of Ajax commands contains the searched command.
AssertContentTrait::$content	protected	property	The current raw content.
AssertContentTrait::$drupalSettings	protected	property	The drupalSettings value from the current raw $content.
AssertContentTrait::$elements	protected	property	The XML structure parsed from the current raw $content.	2
AssertContentTrait::$plainTextContent	protected	property	The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds	protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped	protected	function	Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion	protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption	protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected	protected	function	Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern	protected	function	Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw	protected	function	Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle	protected	function	Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern	protected	function	Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput	protected	function	Asserts themed output.
AssertContentTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertContentTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper	protected	function	Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertContentTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings	protected	function	Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent	protected	function	Gets the current raw content.
AssertContentTrait::getSelectedItem	protected	function	Get the selected value from a select field.
AssertContentTrait::getTextContent	protected	function	Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl	protected	function	Get the current URL from the cURL handler.	1
AssertContentTrait::parse	protected	function	Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace	protected	function	Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings	protected	function	Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent	protected	function	Sets the raw content (e.g. HTML).
AssertContentTrait::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings	protected	function	Casts MarkupInterface objects into strings.
FrameworkTest::testAJAXRender	public	function	Ensures \Drupal\Core\Ajax\AjaxResponse::ajaxRender() returns JavaScript settings from the page request.
FrameworkTest::testAJAXRenderError	public	function	Tests the behavior of an error alert command.
FrameworkTest::testCurrentPathChange	public	function	Tests that drupalSettings.currentPath is not updated on AJAX requests.
FrameworkTest::testLazyLoad	public	function	Tests that new JavaScript and CSS files are lazy-loaded on an AJAX request.
FrameworkTest::testLazyLoadOverriddenCSS	public	function	Tests that overridden CSS files are not added during lazy load.
FrameworkTest::testOrder	public	function	Tests AjaxResponse::prepare() AJAX commands ordering.
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.
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.
TestBase::$assertions	protected	property	Assertions thrown in that test case.
TestBase::$configImporter	protected	property	The config importer that can used in a test.	5
TestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
TestBase::$container	protected	property	The dependency injection container used in the test.
TestBase::$databasePrefix	protected	property	The database prefix of this test run.
TestBase::$dieOnFail	public	property	Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials	protected	property	HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod	protected	property	HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$originalConf	protected	property	The original configuration (variables), if available.
TestBase::$originalConfig	protected	property	The original configuration (variables).
TestBase::$originalConfigDirectories	protected	property	The original configuration directories.
TestBase::$originalContainer	protected	property	The original container.
TestBase::$originalFileDirectory	protected	property	The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage	protected	property	The original language.
TestBase::$originalPrefix	protected	property	The original database prefix when running inside Simpletest.
TestBase::$originalProfile	protected	property	The original installation profile.
TestBase::$originalSessionName	protected	property	The name of the session cookie of the test-runner.
TestBase::$originalSettings	protected	property	The settings array.
TestBase::$originalSite	protected	property	The site directory of the original parent site.
TestBase::$privateFilesDirectory	protected	property	The private file directory for the test environment.
TestBase::$publicFilesDirectory	protected	property	The public file directory for the test environment.
TestBase::$results	public	property	Current results of this test case.
TestBase::$siteDirectory	protected	property	The site directory of this test run.
TestBase::$skipClasses	protected	property	This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	4
TestBase::$tempFilesDirectory	protected	property	The temporary file directory for the test environment.
TestBase::$testId	protected	property	The test run ID.
TestBase::$timeLimit	protected	property	Time limit for the test.
TestBase::$translationFilesDirectory	protected	property	The translation file directory for the test environment.
TestBase::$verbose	public	property	TRUE if verbose debugging is enabled.
TestBase::$verboseClassName	protected	property	Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory	protected	property	Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl	protected	property	URL to the verbose output file directory.
TestBase::$verboseId	protected	property	Incrementing identifier for verbose output filenames.
TestBase::assert	protected	function	Internal helper: stores the assert.
TestBase::assertEqual	protected	function	Check to see if two values are equal.
TestBase::assertErrorLogged	protected	function	Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse	protected	function	Check to see if a value is false.
TestBase::assertIdentical	protected	function	Check to see if two values are identical.
TestBase::assertIdenticalObject	protected	function	Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged	protected	function	Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual	protected	function	Check to see if two values are not equal.
TestBase::assertNotIdentical	protected	function	Check to see if two values are not identical.
TestBase::assertNotNull	protected	function	Check to see if a value is not NULL.
TestBase::assertNull	protected	function	Check to see if a value is NULL.
TestBase::assertTrue	protected	function	Check to see if a value is not false.
TestBase::beforePrepareEnvironment	protected	function	Act on global state information before the environment is altered for a test.	1
TestBase::changeDatabasePrefix	private	function	Changes the database connection to the prefixed one.
TestBase::checkRequirements	protected	function	Checks the matching requirements for Test.	2
TestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter	public	function	Returns a ConfigImporter object to import test importing of configuration.	5
TestBase::copyConfig	public	function	Copies configuration objects from source storage to target storage.
TestBase::deleteAssert	public static	function	Delete an assertion record by message ID.
TestBase::error	protected	function	Fire an error assertion.	3
TestBase::errorHandler	public	function	Handle errors during test runs.
TestBase::exceptionHandler	protected	function	Handle exceptions.
TestBase::fail	protected	function	Fire an assertion that is always negative.
TestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations	public static	function	Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall	protected	function	Cycles through backtrace until the first non-assertion method is found.
TestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection	public static	function	Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix	public	function	Gets the database prefix.
TestBase::getTempFilesDirectory	public	function	Gets the temporary files directory.
TestBase::insertAssert	public static	function	Store an assertion from outside the testing context.
TestBase::pass	protected	function	Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix	private	function	Generates a database prefix for running tests.
TestBase::prepareEnvironment	private	function	Prepares the current environment for running the test.
TestBase::restoreEnvironment	private	function	Cleans up the test environment and restores the original environment.
TestBase::run	public	function	Run all tests in this class.	1
TestBase::settingsSet	protected	function	Changes in memory settings.
TestBase::storeAssertion	protected	function	Helper method to store an assertion record in the configured database.
TestBase::verbose	protected	function	Logs a verbose message in a text file.
UserCreationTrait::checkPermissions	protected	function	Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole	protected	function	Creates an administrative role. Aliased as: drupalCreateAdminRole
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.
WebTestBase::$additionalCurlOptions	protected	property	Additional cURL options.
WebTestBase::$assertAjaxHeader	protected	property	Whether or not to assert the presence of the X-Drupal-Ajax-Token.
WebTestBase::$classLoader	protected	property	The class loader to use for installation and initialization of setup.
WebTestBase::$configDirectories	protected	property	The config directories used in this test.
WebTestBase::$cookieFile	protected	property	The current cookie file used by cURL.
WebTestBase::$cookies	protected	property	The cookies of the page currently loaded in the internal browser.
WebTestBase::$curlCookies	protected	property	Cookies to set on curl requests.
WebTestBase::$curlHandle	protected	property	The handle of the current cURL connection.
WebTestBase::$customTranslations	protected	property	An array of custom translations suitable for drupal_rewrite_settings().
WebTestBase::$dumpHeaders	protected	property	Indicates that headers should be dumped if verbose output is enabled.	12
WebTestBase::$generatedTestFiles	protected	property	Whether the files were copied to the test files directory.
WebTestBase::$headers	protected	property	The headers of the page currently loaded in the internal browser.
WebTestBase::$kernel	protected	property	The kernel used in this test. Overrides TestBase::$kernel
WebTestBase::$loggedInUser	protected	property	The current user logged in using the internal browser.
WebTestBase::$maximumMetaRefreshCount	protected	property	The number of meta refresh redirects to follow, or NULL if unlimited.
WebTestBase::$maximumRedirects	protected	property	The maximum number of redirects to follow when handling responses.
WebTestBase::$metaRefreshCount	protected	property	The number of meta refresh redirects followed during ::drupalGet().
WebTestBase::$originalBatch	protected	property	The original batch, before it was changed for testing purposes.
WebTestBase::$originalShutdownCallbacks	protected	property	The original shutdown handlers array, before it was cleaned for testing. Overrides TestBase::$originalShutdownCallbacks
WebTestBase::$originalUser	protected	property	The original user, before it was changed to a clean uid = 1 for testing. Overrides TestBase::$originalUser
WebTestBase::$profile	protected	property	The profile to install as a basis for testing.	30
WebTestBase::$redirectCount	protected	property	The number of redirects followed during the handling of a request.
WebTestBase::$rootUser	protected	property	The "#1" admin user.
WebTestBase::$sessionId	protected	property	The current session ID, if available.
WebTestBase::$url	protected	property	The URL currently loaded in the internal browser.
WebTestBase::addCustomTranslations	protected	function	Queues custom translations to be written to settings.php.
WebTestBase::assertBlockAppears	protected	function	Checks to see whether a block appears on the page.
WebTestBase::assertCacheContext	protected	function	Asserts whether an expected cache context was present in the last response.
WebTestBase::assertCacheTag	protected	function	Asserts whether an expected cache tag was present in the last response.
WebTestBase::assertHeader	protected	function	Check if a HTTP response header exists and has the expected value.
WebTestBase::assertMail	protected	function	Asserts that the most recently sent email message has the given value.
WebTestBase::assertMailPattern	protected	function	Asserts that the most recently sent email message has the pattern in it.
WebTestBase::assertMailString	protected	function	Asserts that the most recently sent email message has the string in it.
WebTestBase::assertNoBlockAppears	protected	function	Checks to see whether a block does not appears on the page.
WebTestBase::assertNoCacheContext	protected	function	Asserts that a cache context was not present in the last response.
WebTestBase::assertNoCacheTag	protected	function	Asserts whether an expected cache tag was absent in the last response.
WebTestBase::assertNoResponse	protected	function	Asserts the page did not return the specified response code.
WebTestBase::assertResponse	protected	function	Asserts the page responds with the specified response code.
WebTestBase::assertUrl	protected	function	Passes if the internal browser's URL matches the given path.
WebTestBase::buildUrl	protected	function	Builds an a absolute URL from a system path or a URL object.
WebTestBase::checkForMetaRefresh	protected	function	Checks for meta refresh tag and if found call drupalGet() recursively.
WebTestBase::clickLink	protected	function	Follows a link by complete name.
WebTestBase::clickLinkHelper	protected	function	Provides a helper for ::clickLink() and ::clickLinkPartialName().
WebTestBase::clickLinkPartialName	protected	function	Follows a link by partial name.
WebTestBase::cronRun	protected	function	Runs cron in the Drupal installed by Simpletest.
WebTestBase::curlClose	protected	function	Close the cURL handler and unset the handler.
WebTestBase::curlExec	protected	function	Initializes and executes a cURL request.	2
WebTestBase::curlHeaderCallback	protected	function	Reads headers and registers errors received from the tested site.
WebTestBase::curlInitialize	protected	function	Initializes the cURL connection.
WebTestBase::doInstall	protected	function	Execute the non-interactive installer.
WebTestBase::drupalBuildEntityView	protected	function	Builds the renderable view of an entity.
WebTestBase::drupalCompareFiles	protected	function	Compare two files based on size and file name.
WebTestBase::drupalCreateContentType	protected	function	Creates a custom content type based on default settings.
WebTestBase::drupalCreateNode	protected	function	Creates a node based on default settings.
WebTestBase::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	1
WebTestBase::drupalGetAjax	protected	function	Requests a path or URL in drupal_ajax format and JSON-decodes the response.
WebTestBase::drupalGetHeader	protected	function	Gets the value of an HTTP response header.
WebTestBase::drupalGetHeaders	protected	function	Gets the HTTP response headers of the requested page.
WebTestBase::drupalGetJSON	protected	function	Retrieves a Drupal path or an absolute path and JSON decodes the result.
WebTestBase::drupalGetMails	protected	function	Gets an array containing all emails sent during this test case.
WebTestBase::drupalGetNodeByTitle		function	Get a node from the database based on its title.
WebTestBase::drupalGetTestFiles	protected	function	Gets a list of files that can be used in tests.
WebTestBase::drupalGetWithFormat	protected	function	Retrieves a Drupal path or an absolute path for a given format.
WebTestBase::drupalGetXHR	protected	function	Requests a Drupal path or an absolute path as if it is a XMLHttpRequest.
WebTestBase::drupalHead	protected	function	Retrieves only the headers for a Drupal path or an absolute path.
WebTestBase::drupalLogin	protected	function	Log in a user with the internal browser.
WebTestBase::drupalLogout	protected	function	Logs a user out of the internal browser and confirms.
WebTestBase::drupalPlaceBlock	protected	function	Creates a block instance based on default settings.
WebTestBase::drupalPost	protected	function	Perform a POST HTTP request.
WebTestBase::drupalPostAjaxForm	protected	function	Executes an Ajax form submission.
WebTestBase::drupalPostForm	protected	function	Executes a form submission.
WebTestBase::drupalPostWithFormat	protected	function	Performs a POST HTTP request with a specific format.
WebTestBase::drupalProcessAjaxResponse	protected	function	Processes an AJAX response into current content.
WebTestBase::drupalUserIsLoggedIn	protected	function	Returns whether a given user account is logged in.
WebTestBase::findBlockInstance	protected	function	Find a block instance on the page.
WebTestBase::getAbsoluteUrl	protected	function	Takes a path and returns an absolute path.
WebTestBase::getAjaxPageStatePostData	protected	function	Get the Ajax page state from drupalSettings and prepare it for POSTing.
WebTestBase::getDatabaseTypes	protected	function	Returns all supported database driver installer objects.
WebTestBase::handleForm	protected	function	Handles form input related to drupalPostForm().
WebTestBase::initConfig	protected	function	Initialize various configurations post-installation.
WebTestBase::initKernel	protected	function	Initializes the kernel after installation.
WebTestBase::initSettings	protected	function	Initialize settings created during install.
WebTestBase::initUserSession	protected	function	Initializes user 1 for the site to be installed.
WebTestBase::installModulesFromClassProperty	protected	function	Install modules defined by `static::$modules`.
WebTestBase::installParameters	protected	function	Returns the parameters that will be used when Simpletest installs Drupal.	2
WebTestBase::isInChildSite	protected	function	Returns whether the test is being executed from within a test site.
WebTestBase::prepareRequestForGenerator	protected	function	Creates a mock request and sets it on the generator.
WebTestBase::prepareSettings	protected	function	Prepares site settings and services before installation.	1
WebTestBase::rebuildAll	protected	function	Reset and rebuild the environment after setup.
WebTestBase::rebuildContainer	protected	function	Rebuilds \Drupal::getContainer().
WebTestBase::refreshVariables	protected	function	Refreshes in-memory configuration and state information.	1
WebTestBase::resetAll	protected	function	Resets all data structures after having enabled new modules.
WebTestBase::restoreBatch	protected	function	Restore the original batch.
WebTestBase::serializePostValues	protected	function	Serialize POST HTTP request values.
WebTestBase::setBatch	protected	function	Preserve the original batch, and instantiate the test batch.
WebTestBase::setContainerParameter	protected	function	Changes parameters in the services.yml file.
WebTestBase::setHttpResponseDebugCacheabilityHeaders	protected	function	Enables/disables the cacheability headers.
WebTestBase::setUp	protected	function	Sets up a Drupal site for running functional and integration tests. Overrides TestBase::setUp	272
WebTestBase::tearDown	protected	function	Cleans up after testing. Overrides TestBase::tearDown	2
WebTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm().
WebTestBase::verboseEmail	protected	function	Outputs to verbose the most recent $count emails sent.
WebTestBase::writeCustomTranslations	protected	function	Writes custom translations to the test site's settings.php.
WebTestBase::writeSettings	protected	function	Rewrites the settings.php file of the test site.
WebTestBase::__construct		function	Constructor for \Drupal\simpletest\WebTestBase. Overrides TestBase::__construct	1

You are here

class FrameworkTest in Zircon Profile 8

Hierarchy

File

Namespace

Members

API Navigation