You are here

Home » API reference » Scheduled Updates 8 » EmbeddedScheduledUpdateTypeTestBase.php

abstract class EmbeddedScheduledUpdateTypeTestBase in Scheduled Updates 8

Base test class for embedded update types.

There are differences in how the types are create but after that they have the same testing needs.

This also contain utility functions dealing with Inline Entity Form.

Hierarchy

Expanded class hierarchy of EmbeddedScheduledUpdateTypeTestBase

See also

checkAfterTypeCreated()

File

tests/src/FunctionalJavascript/EmbeddedScheduledUpdateTypeTestBase.php, line 24
Contains \Drupal\Tests\scheduled_updates\EmbeddedScheduledUpdateTypeTestBase.

Namespace

Drupal\Tests\scheduled_updates\FunctionalJavascript
View source 
abstract class EmbeddedScheduledUpdateTypeTestBase extends ScheduledUpdatesTestBase {
  use CronRunTrait;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'scheduled_updates',
    'scheduled_updates_tests',
    'node',
    'user',
    'field_ui',
    'block',
    'inline_entity_form',
    'dblog',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    \Drupal::state()
      ->set('constraint_uid', UserIdConstraintValidator::CONSTRAINT_NONE);
  }

  /**
   * Make sure Referenced types do not have a direct add form.
   *
   * @param string $label
   * @param string $type_id
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   * @throws \Behat\Mink\Exception\ResponseTextException
   */
  protected function confirmNoAddForm($label, $type_id) {
    $this
      ->loginWithPermissions([
      "create {$type_id} scheduled updates",
    ]);
    $this
      ->drupalGet('admin/content/scheduled-update/add');

    // 'Referenced type label does not appear on update add page.'
    $this
      ->assertSession()
      ->pageTextNotContains($label);

    // 'Update time field is not available on add page.'
    $this
      ->assertSession()
      ->pageTextNotContains('Update Date/time');
    $this
      ->checkAccessDenied('admin/content/scheduled-update/add/' . $type_id);
    $this
      ->loginLastUser();
  }

  /**
   * Make sure that reference field was created and put on target entity type.
   *
   * @param $entity_type
   * @param string $bundle
   * @param string $reference_field_label
   * @param string $reference_field_name
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   * @throws \Behat\Mink\Exception\ResponseTextException
   */
  protected function checkReferenceCreated($entity_type, $bundle, $reference_field_label, $reference_field_name) {
    $this
      ->loginWithPermissions([
      'administer node fields',
      'administer content types',
    ]);
    $this
      ->drupalGet("admin/structure/types/manage/{$bundle}/fields");
    $this
      ->assertSession()
      ->pageTextContains($reference_field_label);
    $this
      ->assertSession()
      ->pageTextContains($reference_field_name);
    $this
      ->loginLastUser();
  }

  /**
   * Make sure that reference field was created and put on target entity type.
   *
   * @param string $entity_type
   * @param string $bundle
   * @param string $reference_field_label
   * @param string $reference_field_name
   *
   * @throws \Exception
   */
  protected function checkReferenceOnEntityType($entity_type, $bundle, $reference_field_label, $reference_field_name) {
    $this
      ->loginWithPermissions([
      "create {$bundle} content",
    ]);
    $this
      ->drupalGet("node/add/{$bundle}");
    $this
      ->assertSession()
      ->pageTextContains($reference_field_label);

    // @todo Check html for field
    $this
      ->loginLastUser();

    // $field_id = 'edit-' . str_replace('_', '-', $reference_field_name);

    //$this->assertFieldbyId($field_id);
  }

  /**
   * @param array $edit
   * @param string $add_url
   * @param string $reference_field_label
   * @param string $reference_field_name
   *
   * @return array
   * @throws \Behat\Mink\Exception\ResponseTextException
   */
  protected function checkNewFieldRequired(array &$edit, $add_url, $reference_field_label, $reference_field_name) {

    // Save first without new field information.
    // This is only enforce by javascript states,
    // @see \Drupal\scheduled_updates\Form\ScheduledUpdateTypeBaseForm::validateForm
    $page = $this
      ->getSession()
      ->getPage();

    // Remove label explicitly.
    $page
      ->fillField('reference_settings[new_field][label]', '');

    //$page->fillField('reference_settings[new_field][field_name]', '');
    $page
      ->pressButton('Save');
    $this
      ->assertUrl($add_url);
    $edit['reference_settings[new_field][label]'] = $reference_field_label;
    return $edit;
  }

  /**
   * Get the URL for adding an entity.
   *
   * Hard-coded for node style path now
   *
   * @param string $entity_type
   * @param string $bundle
   *
   * @return string
   */
  protected function getEntityAddURL($entity_type, $bundle) {
    return "{$entity_type}/add/{$bundle}";
  }

  /**
   * Gets IEF button name.
   *
   * Copied from IEF module.
   *
   * @param string $xpath
   *   Xpath of the button.
   *
   * @return string|null
   *   The name of the button.
   */
  protected function getButtonName($xpath) {

    // \Behat\Mink\Element\NodeElement[]
    $elements = $this
      ->xpath($xpath);
    if ($elements) {
      if ($elements[0]
        ->hasAttribute('name')) {
        return $elements[0]
          ->getAttribute('name');
      }
    }
    return '';
  }

  /**
   * Submit a IEF Form with Ajax.
   *
   * @param string $label
   * @param string $drupal_selector
   * @param array $edit
   */
  protected function submitIEFForm($label, $drupal_selector, $edit = []) {
    $name = $this
      ->getButtonName("//input[@type=\"submit\" and @value=\"{$label}\" and @data-drupal-selector=\"{$drupal_selector}\"]");

    // Was drupalPostAjaxForm:
    $this
      ->drupalPostForm(NULL, $edit, $name);
  }

  /**
   * Checking adding and running updates for title.
   *
   * Hardcoded for node 'title' property now.
   *
   * @param string $bundle
   * @param string $reference_field_label
   * @param string $reference_field_name
   *
   * @throws \Behat\Mink\Exception\DriverException
   * @throws \Behat\Mink\Exception\ElementNotFoundException
   * @throws \Behat\Mink\Exception\ExpectationException
   * @throws \Behat\Mink\Exception\ResponseTextException
   * @throws \Behat\Mink\Exception\UnsupportedDriverActionException
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  protected function checkRunningTitleUpdates($bundle, $reference_field_name, $reference_field_label) {
    foreach ([
      'ui',
      'cron',
    ] as $run_updates_via) {
      $update_node = $this
        ->createNodeWithUpdate('Title to be updated', '-1 year', $bundle, $reference_field_name, $reference_field_label);
      $no_update_node = $this
        ->createNodeWithUpdate('Title NOT to be updated', '+1 year', $bundle, $reference_field_name, $reference_field_label);
      if ($run_updates_via == 'cron') {

        // Because the update type is UpdateRunnerInterface::USER_UPDATE_RUNNER
        // the update should switch to user #1 during cron. Trigger validation
        // error.
        \Drupal::state()
          ->set('constraint_uid', UserIdConstraintValidator::CONSTRAINT_USER_1);
        $this
          ->cronRun();

        // Reset to avoid trigger validation error.
        \Drupal::state()
          ->set('constraint_uid', UserIdConstraintValidator::CONSTRAINT_NONE);
      }
      else {
        $this
          ->runUpdatesUI();
      }
      $this
        ->drupalGet("node/" . $update_node
        ->id());

      // 'Update title appears on past update'
      $this
        ->assertSession()
        ->pageTextContains('Title to be updated:updated');
      $this
        ->drupalGet("node/" . $no_update_node
        ->id());

      // 'Original node title appears on future update'
      $this
        ->assertSession()
        ->pageTextContains("Title NOT to be updated");

      // , 'Update title does not appear on future update'
      $this
        ->assertSession()
        ->pageTextNotContains("Title NOT to be updated:updated");
      $update_node
        ->delete();
      $no_update_node
        ->delete();
    }

    // Make sure that the user is switched to user #1 when updates are run with
    // cron and UpdateRunnerInterface::USER_UPDATE_RUNNER was used.
    // @see \Drupal\scheduled_updates_tests\Plugin\Validation\Constraint\UserIdConstraintValidator
    $invalid_update = $this
      ->createNodeWithUpdate('Title to be updated', '-1 year', $bundle, $reference_field_name, $reference_field_label);
    \Drupal::state()
      ->set('constraint_uid', UserIdConstraintValidator::CONSTRAINT_ANONYMOUS);
    $this
      ->cronRun();
    \Drupal::state()
      ->set('constraint_uid', UserIdConstraintValidator::CONSTRAINT_NONE);
    $this
      ->drupalGet("node/" . $invalid_update
      ->id());

    // 'Title not updated with validation error'
    $this
      ->assertSession()
      ->pageTextNotContains('Title to be updated:updated');
    $invalid_update
      ->delete();
  }

  /**
   * Checking adding and running updates for title.
   *
   * Hardcoded for node 'title' property now.
   *
   * @param string $bundle
   * @param string $reference_field_label
   * @param string $reference_field_name
   *
   * @throws \Behat\Mink\Exception\DriverException
   * @throws \Behat\Mink\Exception\ElementNotFoundException
   * @throws \Behat\Mink\Exception\ExpectationException
   * @throws \Behat\Mink\Exception\ResponseTextException
   * @throws \Behat\Mink\Exception\UnsupportedDriverActionException
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function checkRunningPromoteUpdates($bundle, $reference_field_name, $reference_field_label) {
    $update_node = $this
      ->createNodeWithUpdate('Upate Node', '-1 year', $bundle, $reference_field_name, $reference_field_label, TRUE);
    $no_update_node = $this
      ->createNodeWithUpdate('No update node', '+1 year', $bundle, $reference_field_name, $reference_field_label, TRUE);
    $this
      ->runUpdatesUI();
    $this
      ->checkEntityValue('node', $update_node, 'promote', 1);
    $this
      ->checkEntityValue('node', $no_update_node, 'promote', 0);
  }

  /**
   * @param string $title
   * @param string $date_offset
   * @param string $bundle
   * @param string $reference_field_label
   * @param string $reference_field_name
   *
   * @param bool $field_hidden
   *
   * @return \Drupal\node\NodeInterface
   *
   * @throws \Behat\Mink\Exception\DriverException
   * @throws \Behat\Mink\Exception\ElementNotFoundException
   * @throws \Behat\Mink\Exception\ExpectationException
   * @throws \Behat\Mink\Exception\ResponseTextException
   * @throws \Behat\Mink\Exception\UnsupportedDriverActionException
   */
  protected function createNodeWithUpdate($title, $date_offset, $bundle, $reference_field_name, $reference_field_label, $field_hidden = FALSE) {
    $page = $this
      ->getSession()
      ->getPage();
    $id_field_name = str_replace('_', '-', $reference_field_name);
    $entity_add_url = $this
      ->getEntityAddURL('node', $bundle);
    $this
      ->drupalGet($entity_add_url);
    $ief_button = "Add new {$reference_field_label}";
    $this
      ->assertSession()
      ->buttonExists($ief_button);

    // Open IEF form
    $this
      ->submitIEFForm($ief_button, "edit-{$id_field_name}-actions-ief-add");

    // Check opened form.
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains('Update Date/time');

    // Submit IEF form
    // Create ief_test_complex node.
    $page
      ->fillField("{$reference_field_name}[form][0][update_timestamp][0][value][date]", $this
      ->getRelativeDate($date_offset, 'm/d/Y'));
    $page
      ->fillField("{$reference_field_name}[form][0][update_timestamp][0][value][time]", '01:00:00AM');
    if ($field_hidden) {

      //      $inputs = $this->getSession()->getDriver()->find("(//html//form)");
      //      foreach ($inputs as $element) {
      //        echo "====== Found: " . PHP_EOL . $element->getOuterHtml() . PHP_EOL . PHP_EOL;
      //      }
      // Hard-coded for now. @todo Create parameter to this function.
      // promote_reference[form][inline_entity_form][field_promote][value]
      $ief_field_name = "{$reference_field_name}[form][0][field_promote][value]";

      //($ief_field_name, NULL, "$reference_field_name - hides update field");
      $this
        ->assertSession()
        ->fieldNotExists($ief_field_name);
    }
    else {

      // Hard-coded for now. @todo Create parameter to this function.
      $ief_field_name = "{$reference_field_name}[form][0][field_title][0][value]";
      $this
        ->assertSession()
        ->fieldExists($ief_field_name);
      $page
        ->fillField($ief_field_name, "{$title}:updated");
    }
    $page
      ->pressButton("Create {$reference_field_label}");

    // Edit button appears when saved.
    // 'Saving IEF Update was successful.';
    $this
      ->assertNotEmpty($this
      ->assertSession()
      ->waitForElementVisible('css', "[data-drupal-selector='edit-{$id_field_name}-entities-0-actions-ief-entity-edit']"));

    // Create ief_test_complex node.
    $edit = [
      'title[0][value]' => $title,
    ];
    $this
      ->drupalPostForm(NULL, $edit, t(static::NODE_SAVE_BUTTON_TEXT));

    // 'Saving parent entity was successful.'
    $node = $this
      ->drupalGetNodeByTitle($title);
    $this
      ->assertTrue($node, "Node was created");
    return $node;
  }

  /**
   * @param string $label
   * @param string $type_id
   * @param string $reference_field_label
   * @param string $reference_field_name
   * @param $clone_field
   *
   * @throws \Behat\Mink\Exception\DriverException
   * @throws \Behat\Mink\Exception\ElementNotFoundException
   * @throws \Behat\Mink\Exception\ExpectationException
   * @throws \Behat\Mink\Exception\ResponseTextException
   * @throws \Behat\Mink\Exception\UnsupportedDriverActionException
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Core\Entity\EntityStorageException
   * @throws \Exception
   */
  protected function checkAfterTypeCreated($label, $type_id, $reference_field_label, $reference_field_name, $clone_field) {
    $permissions = [
      "create {$type_id} scheduled updates",
      'administer scheduled updates',
    ];

    // Check both permissions tha will allow the user to create updates.
    foreach ($permissions as $permission) {

      // Give permission to create the current update type.
      $this
        ->grantPermissionsToUser([
        $permission,
      ]);
      $this
        ->confirmNoAddForm($label, $type_id);
      $this
        ->checkReferenceCreated('node', 'page', $reference_field_label, $reference_field_name);
      $this
        ->checkReferenceOnEntityType('node', 'page', $reference_field_label, $reference_field_name);
      switch ($clone_field) {
        case 'title':
          $this
            ->checkRunningTitleUpdates('page', $reference_field_name, $reference_field_label);
          break;
        case 'promote':
          $this
            ->checkRunningPromoteUpdates('page', $reference_field_name, $reference_field_label);
          break;
      }
      $this
        ->revokePermissionsFromUser([
        $permission,
      ]);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
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 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::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::$defaultTheme protected property The theme to install as the default for testing. 1,597
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
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 Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
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 Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
CronRunTrait::cronRun protected function Runs cron on the test site.
EmbeddedScheduledUpdateTypeTestBase::$modules public static property Modules to enable. Overrides ScheduledUpdatesTestBase::$modules
EmbeddedScheduledUpdateTypeTestBase::checkAfterTypeCreated protected function
EmbeddedScheduledUpdateTypeTestBase::checkNewFieldRequired protected function
EmbeddedScheduledUpdateTypeTestBase::checkReferenceCreated protected function Make sure that reference field was created and put on target entity type.
EmbeddedScheduledUpdateTypeTestBase::checkReferenceOnEntityType protected function Make sure that reference field was created and put on target entity type.
EmbeddedScheduledUpdateTypeTestBase::checkRunningPromoteUpdates protected function Checking adding and running updates for title.
EmbeddedScheduledUpdateTypeTestBase::checkRunningTitleUpdates protected function Checking adding and running updates for title.
EmbeddedScheduledUpdateTypeTestBase::confirmNoAddForm protected function Make sure Referenced types do not have a direct add form.
EmbeddedScheduledUpdateTypeTestBase::createNodeWithUpdate protected function
EmbeddedScheduledUpdateTypeTestBase::getButtonName protected function Gets IEF button name.
EmbeddedScheduledUpdateTypeTestBase::getEntityAddURL protected function Get the URL for adding an entity.
EmbeddedScheduledUpdateTypeTestBase::setUp protected function Sets the test up. Overrides ScheduledUpdatesTestBase::setUp 2
EmbeddedScheduledUpdateTypeTestBase::submitIEFForm protected function Submit a IEF Form with Ajax.
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::$configDirectories Deprecated protected property The config directories used in this test.
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. 2
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 Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
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. 2
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.
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
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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. 1
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. 3
ScheduledUpdatesTestBase::$adminUser protected property Admin user
ScheduledUpdatesTestBase::$permissions protected property Permissions to grant admin user. 1
ScheduledUpdatesTestBase::$profile protected property Profile to use. Overrides BrowserTestBase::$profile
ScheduledUpdatesTestBase::checkEditType protected function Checks that an scheduled update type can be edit via the form.
ScheduledUpdatesTestBase::checkFieldLabels protected function
ScheduledUpdatesTestBase::checkRunnersAvailable protected function Check that a set of runner plugins are on form and no extras.
ScheduledUpdatesTestBase::cloneFields protected function Clone multiple fields on the Clone Field Page.
ScheduledUpdatesTestBase::createType protected function 2
ScheduledUpdatesTestBase::getNodePropertyMachineNames protected function Get Node Property machine names.
ScheduledUpdatesTestBase::grantPermissionsToUser protected function Grant permissions to a user.
ScheduledUpdatesTestBase::NODE_SAVE_BUTTON_TEXT constant
ScheduledUpdatesTestBase::revokePermissionsFromUser protected function Grant permissions to a user.
ScheduledUpdatesTestBase::runUpdatesUI protected function Runs Updates via the UI.
ScheduledUpdatesTestBase::setupContentTypes protected function
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. 1
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. 2
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 running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
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 a 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::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
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::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::$minkDefaultDriverClass protected property To use a legacy phantomjs based approach, please use PhantomJSDriver::class. Overrides BrowserTestBase::$minkDefaultDriverClass 2
WebDriverTestBase::assertElementNotVisible Deprecated protected function Asserts that the element with the given CSS selector is not visible.
WebDriverTestBase::assertElementVisible Deprecated protected function Asserts that the element with the given CSS selector is visible.
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 1
WebDriverTestBase::createScreenshot protected function Creates a screenshot.
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 1
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty
WebDriverTestBase::tearDown protected function Overrides BrowserTestBase::tearDown 1
WebTestExtended::$last_user protected property Store last user to easily login back in.
WebTestExtended::checkAccessDenied protected function Utility function to check that current user does not access to a given path.
WebTestExtended::checkEntityValue protected function Check an entity value after reload.
WebTestExtended::checkExpectedCheckboxes protected function Utility function to check that a checkboxes has the expected options.
WebTestExtended::checkExpectedOptions protected function Utility function to check that a select has only the expected options.
WebTestExtended::checkExpectedRadioOptions protected function Utility function to check that a radio group has only the expected options.
WebTestExtended::drupalLogin protected function Overridden to add easy switch back functionality. Overrides UiHelperTrait::drupalLogin
WebTestExtended::getRelativeDate protected function Utility Function to get a date relative from current.
WebTestExtended::gotoURLIfNot protected function Utility Function around drupalGet to avoid call if not needed.
WebTestExtended::loginLastUser protected function Login previous user.
WebTestExtended::loginWithPermissions protected function Create user and login with given permissions.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.