You are here

final class ExistingContactElementTest in Webform CiviCRM Integration 8.5

Tests submitting a Webform with CiviCRM: existing contact element.

@group webform_civicrm

Hierarchy

Expanded class hierarchy of ExistingContactElementTest

File

tests/src/FunctionalJavascript/ExistingContactElementTest.php, line 13

Namespace

Drupal\Tests\webform_civicrm\FunctionalJavascript
View source
final class ExistingContactElementTest extends WebformCivicrmTestBase {
  use AssertMailTrait;
  private function addcontactinfo() {
    $currentUserUF = $this
      ->getUFMatchRecord($this->rootUser
      ->id());
    $params = [
      'contact_id' => $currentUserUF['contact_id'],
      'first_name' => 'Maarten',
      'last_name' => 'van der Weijden',
    ];
    $utils = \Drupal::service('webform_civicrm.utils');
    $result = $utils
      ->wf_civicrm_api('Contact', 'create', $params);
    $this
      ->assertEquals(0, $result['is_error']);
    $this
      ->assertEquals(1, $result['count']);
  }
  public function testSubmitWebform() {
    $this
      ->addcontactinfo();
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->drupalGet(Url::fromRoute('entity.webform.civicrm', [
      'webform' => $this->webform
        ->id(),
    ]));

    // The label has a <div> in it which can cause weird failures here.
    $this
      ->enableCivicrmOnWebform();
    $this
      ->saveCiviCRMSettings();
    $this
      ->drupalGet($this->webform
      ->toUrl('canonical'));
    $this
      ->assertPageNoErrorMessages();
    $this
      ->assertSession()
      ->waitForField('First Name');

    // The Default Existing Contact Element behaviour is: load logged in User
    // The test here is to check if the fields on the form populate with Contact details belonging to the logged in User:
    $this
      ->assertSession()
      ->fieldValueEquals('First Name', 'Maarten');
    $this
      ->assertSession()
      ->fieldValueEquals('Last Name', 'van der Weijden');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Submit');
    $this
      ->assertPageNoErrorMessages();
    $this
      ->assertSession()
      ->pageTextContains('New submission added to CiviCRM Webform Test.');
  }

  /**
   * Verify if existing contact element is loaded as expected.
   */
  function testRenderingOfExistingContactElement() {
    $this
      ->addcontactinfo();
    $childContact = [
      'first_name' => 'Fred',
      'last_name' => 'Pinto',
    ];
    $this->childContact = $this
      ->createIndividual($childContact);
    $this->utils
      ->wf_civicrm_api('Relationship', 'create', [
      'contact_id_a' => $this->childContact['id'],
      'contact_id_b' => $this->rootUserCid,
      'relationship_type_id' => "Child of",
    ]);
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->drupalGet(Url::fromRoute('entity.webform.civicrm', [
      'webform' => $this->webform
        ->id(),
    ]));

    // The label has a <div> in it which can cause weird failures here.
    $this
      ->enableCivicrmOnWebform();
    $this
      ->getSession()
      ->getPage()
      ->selectFieldOption('contact_1_number_of_email', 1);
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->getSession()
      ->getPage()
      ->selectFieldOption("number_of_contacts", 4);
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->htmlOutput();
    foreach ([
      2,
      3,
      4,
    ] as $c) {
      $this
        ->getSession()
        ->getPage()
        ->clickLink("Contact {$c}");
      $this
        ->assertSession()
        ->assertWaitOnAjaxRequest();

      //Make second contact as household contact.
      if ($c == 2) {
        $this
          ->getSession()
          ->getPage()
          ->selectFieldOption("{$c}_contact_type", 'Household');
        $this
          ->assertSession()
          ->assertWaitOnAjaxRequest();
      }
      elseif ($c == 3) {
        $this
          ->getSession()
          ->getPage()
          ->checkField("edit-civicrm-{$c}-contact-1-contact-job-title");
        $this
          ->assertSession()
          ->checkboxChecked("edit-civicrm-{$c}-contact-1-contact-job-title");
      }
      $this
        ->getSession()
        ->getPage()
        ->checkField("civicrm_{$c}_contact_1_contact_existing");
      $this
        ->assertSession()
        ->checkboxChecked("civicrm_{$c}_contact_1_contact_existing");
    }
    $this
      ->saveCiviCRMSettings();
    $this
      ->drupalGet($this->webform
      ->toUrl('edit-form'));

    // Edit contact element 1.
    $editContact = [
      'title' => 'Primary Contact',
      'selector' => 'edit-webform-ui-elements-civicrm-1-contact-1-contact-existing-operations',
      'widget' => 'Static',
      'description' => 'Description of the static contact element.',
      'hide_fields' => 'Email',
    ];
    $this
      ->editContactElement($editContact);

    // Edit contact element 2.
    $editContact = [
      'selector' => 'edit-webform-ui-elements-civicrm-2-contact-1-contact-existing-operations',
      'widget' => 'Static',
    ];
    $this
      ->editContactElement($editContact, FALSE);

    // Edit contact element 3.
    $editContact = [
      'selector' => 'edit-webform-ui-elements-civicrm-3-contact-1-contact-existing-operations',
      'widget' => 'Autocomplete',
    ];
    $this
      ->editContactElement($editContact, FALSE);
    $this
      ->drupalGet($this->webform
      ->toUrl('edit-form'));

    // Set a default value for Job title.
    $this
      ->assertSession()
      ->elementExists('css', "[data-drupal-selector='edit-webform-ui-elements-civicrm-3-contact-1-contact-job-title-operations'] a.webform-ajax-link")
      ->click();
    $this
      ->assertSession()
      ->waitForElementVisible('xpath', '//a[contains(@id, "--advanced")]');
    $this
      ->assertSession()
      ->elementExists('xpath', '//a[contains(@id, "--advanced")]')
      ->click();
    $this
      ->assertSession()
      ->elementExists('css', '[data-drupal-selector="edit-default"]')
      ->click();
    $this
      ->getSession()
      ->getPage()
      ->fillField('properties[default_value]', 'Accountant');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Save');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains('Job Title has been updated');
    $this
      ->drupalGet($this->webform
      ->toUrl('edit-form'));

    // Edit contact element 4.
    $editContact = [
      'selector' => 'edit-webform-ui-elements-civicrm-4-contact-1-contact-existing-operations',
      'widget' => 'Static',
      'default' => 'relationship',
      'default_relationship' => [
        'default_relationship_to' => 'Contact 3',
        'default_relationship' => 'Child of Contact 3',
      ],
    ];
    $this
      ->editContactElement($editContact, FALSE);

    // Visit the webform.
    $this
      ->drupalGet($this->webform
      ->toUrl('canonical'));
    $this
      ->assertPageNoErrorMessages();
    $this
      ->htmlOutput();

    // Check if static title is displayed.
    $this
      ->assertSession()
      ->pageTextContains('Primary Contact');
    $this
      ->assertSession()
      ->pageTextContains('Description of the static contact element');

    //Make sure email field is not loaded.
    $this
      ->assertFalse($this
      ->getSession()
      ->getDriver()
      ->isVisible($this
      ->cssSelectToXpath('.form-type-email')));

    // Check if "None Found" text is present in the static element.
    $this
      ->assertSession()
      ->elementTextContains('css', '[id="edit-civicrm-2-contact-1-fieldset-fieldset"]', '- None Found -');

    // Check if c4 contains the text for "create new".
    $this
      ->assertSession()
      ->elementTextContains('css', '[id="edit-civicrm-4-contact-1-fieldset-fieldset"]', '+ Create new +');

    // Enter contact 3.
    $this
      ->fillContactAutocomplete('token-input-edit-civicrm-3-contact-1-contact-existing', 'Maarten');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertFieldValue('edit-civicrm-3-contact-1-contact-job-title', 'Accountant');

    // Check if related contact is loaded on c4.
    $this
      ->htmlOutput();
    $this
      ->assertSession()
      ->elementTextContains('css', '[id="edit-civicrm-4-contact-1-fieldset-fieldset"]', 'Fred Pinto');
  }

  /**
   * Test Tokens in Email.
   */
  public function testTokensInEmail() {

    //Create 2 meeting activities for the contact.
    $actID1 = $this->utils
      ->wf_civicrm_api('Activity', 'create', [
      'source_contact_id' => $this->rootUserCid,
      'activity_type_id' => "Meeting",
      'target_id' => $this->rootUserCid,
    ])['id'];
    $actID2 = $this->utils
      ->wf_civicrm_api('Activity', 'create', [
      'source_contact_id' => $this->rootUserCid,
      'activity_type_id' => "Meeting",
      'target_id' => $this->rootUserCid,
    ])['id'];
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->drupalGet(Url::fromRoute('entity.webform.civicrm', [
      'webform' => $this->webform
        ->id(),
    ]));
    $this
      ->enableCivicrmOnWebform();

    // Enable Email address
    $this
      ->getSession()
      ->getPage()
      ->selectFieldOption('contact_1_number_of_email', 1);
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->checkboxChecked("civicrm_1_contact_1_email_email");
    $this
      ->getSession()
      ->getPage()
      ->selectFieldOption('civicrm_1_contact_1_email_location_type_id', 'Main');
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Activities');
    $this
      ->getSession()
      ->getPage()
      ->selectFieldOption('activity_number_of_activity', 2);
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->htmlOutput();
    $this
      ->saveCiviCRMSettings();
    $email = [
      'to_mail' => '[webform_submission:values:civicrm_1_contact_1_email_email:raw]',
      'body' => 'Existing Contact - [webform_submission:values:civicrm_1_contact_1_contact_existing]. Activity 1 ID - [webform_submission:activity-id:1]. Activity 2 ID - [webform_submission:activity-id:2]. Webform CiviCRM Contacts IDs - [webform_submission:contact-id:1]. Webform CiviCRM Contacts Links - [webform_submission:contact-link:1].',
    ];
    $this
      ->addEmailHandler($email);
    $this
      ->drupalGet($this->webform
      ->toUrl('handlers'));
    $civicrm_handler = $this
      ->assertSession()
      ->elementExists('css', '[data-webform-key="webform_civicrm"] a.tabledrag-handle');

    // Move up to be the top-most handler.
    $this
      ->sendKeyPress($civicrm_handler, 38);
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Save handlers');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->drupalGet($this->webform
      ->toUrl('canonical', [
      'query' => [
        'activity1' => $actID1,
        'activity2' => $actID2,
      ],
    ]));
    $this
      ->getSession()
      ->getPage()
      ->fillField('First Name', 'Frederick');
    $this
      ->getSession()
      ->getPage()
      ->fillField('Last Name', 'Pabst');
    $this
      ->getSession()
      ->getPage()
      ->fillField('Email', 'frederick@pabst.io');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Submit');
    $this
      ->assertPageNoErrorMessages();
    $this
      ->assertSession()
      ->pageTextContains('New submission added to CiviCRM Webform Test.');
    $sent_email = $this
      ->getMails();
    $cidURL = Url::fromUri('internal:/civicrm/contact/view', [
      'absolute' => TRUE,
      'query' => [
        'reset' => 1,
        'cid' => $this->rootUserCid,
      ],
    ])
      ->toString();

    // Check if email was sent to contact 1.
    $this
      ->assertStringContainsString('frederick@pabst.io', $sent_email[0]['to']);

    // Verify tokens are rendered correctly.
    $this
      ->assertStringContainsString('Existing Contact - Frederick Pabst.', $sent_email[0]['body']);
    $this
      ->assertStringContainsString("Activity 1 ID - {$actID1}", $sent_email[0]['body']);
    $this
      ->assertStringContainsString("Activity 2 ID - {$actID2}", $sent_email[0]['body']);
    $this
      ->assertStringContainsString("Webform CiviCRM Contacts IDs - {$this->rootUserCid}", $sent_email[0]['body']);
    $this
      ->assertStringContainsString($cidURL, $sent_email[0]['body']);
  }

}

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::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
AssertMailTrait::assertMail protected function Asserts that the most recently sent email message has the given value.
AssertMailTrait::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
AssertMailTrait::assertMailString protected function Asserts that the most recently sent email message has the string in it.
AssertMailTrait::getMails protected function Gets an array containing all emails sent during this test case.
AssertMailTrait::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
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::$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::$profile protected property The profile to install as a basis for testing. 39
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::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.
CiviCrmTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
CiviCrmTestBase::changeDatabasePrefix protected function Changes the database connection to the prefixed one. Overrides TestSetupTrait::changeDatabasePrefix
CiviCrmTestBase::cleanupEnvironment protected function Clean up the Simpletest environment. Overrides BrowserTestBase::cleanupEnvironment
CiviCrmTestBase::prepareSettings protected function Prepares site settings and services before installation. Overrides FunctionalTestSetupTrait::prepareSettings
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
ExistingContactElementTest::addcontactinfo private function
ExistingContactElementTest::testRenderingOfExistingContactElement function Verify if existing contact element is loaded as expected.
ExistingContactElementTest::testSubmitWebform public function
ExistingContactElementTest::testTokensInEmail public function Test Tokens in Email.
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::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
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::$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::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::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::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::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::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
WebformBrowserTestTrait::$basicHtmlFilter protected property Basic HTML filter format.
WebformBrowserTestTrait::$fullHtmlFilter protected property Full HTML filter format.
WebformBrowserTestTrait::assertCssSelect protected function Passes if the CSS selector IS found on the loaded page, fail otherwise.
WebformBrowserTestTrait::assertElementNotVisible protected function Asserts that the element with the given CSS selector is not visible.
WebformBrowserTestTrait::assertElementVisible protected function Asserts that the element with the given CSS selector is visible.
WebformBrowserTestTrait::assertNoCssSelect protected function Passes if the CSS selector IS NOT found on the loaded page, fail otherwise.
WebformBrowserTestTrait::createFilters protected function Create basic HTML filter format.
WebformBrowserTestTrait::createTags protected function Create the 'tags' taxonomy vocabulary.
WebformBrowserTestTrait::createWebform protected function Create a webform.
WebformBrowserTestTrait::debug protected function Logs verbose (debug) message in a text file.
WebformBrowserTestTrait::getExport protected function Request a webform results export CSV.
WebformBrowserTestTrait::getExportColumns protected function Get webform export columns.
WebformBrowserTestTrait::getLastEmail protected function Gets that last email sent during the currently running test case.
WebformBrowserTestTrait::getLastSubmissionId protected function Get the last submission id.
WebformBrowserTestTrait::getWebformSubmitButtonLabel protected function Get a webform's submit button label.
WebformBrowserTestTrait::loadSubmission protected function Load the specified webform submission from the storage.
WebformBrowserTestTrait::loadWebform protected function Lazy load a test webform.
WebformBrowserTestTrait::loadWebforms protected function Lazy load a test webforms.
WebformBrowserTestTrait::placeBlocks protected function Place breadcrumb page, tasks, and actions.
WebformBrowserTestTrait::placeWebformBlocks protected function Place webform test module blocks.
WebformBrowserTestTrait::postSubmission protected function Post a new submission to a webform.
WebformBrowserTestTrait::postSubmissionTest protected function Post a new test submission to a webform.
WebformBrowserTestTrait::purgeSubmissions protected function Purge all submission before the webform.module is uninstalled. 1
WebformBrowserTestTrait::reloadSubmission protected function Reload a test webform submission.
WebformBrowserTestTrait::reloadWebform protected function Reload a test webform.
WebformCivicrmTestBase::$adminUser protected property The test admin user.
WebformCivicrmTestBase::$configSchemaCheckerExclusions protected static property During tests configuration schema is validated. This module does not provide schema definitions for its handler. Overrides TestSetupTrait::$configSchemaCheckerExclusions
WebformCivicrmTestBase::$modules protected static property Modules to enable. Overrides CiviCrmTestBase::$modules 1
WebformCivicrmTestBase::$webform protected property The test webform.
WebformCivicrmTestBase::addEmailHandler protected function Add email handler
WebformCivicrmTestBase::addFieldValue public function Copy of TraversableElement::fillField, but it replaces the existing value on the element rather than appending to it.
WebformCivicrmTestBase::assertFieldValue public function Assert populated values on the field. fieldValueEquals() fails for populated values on chromedriver > 91
WebformCivicrmTestBase::assertOptionSelected protected function Asserts that a select option in the current page is checked. Overrides AssertLegacyTrait::assertOptionSelected
WebformCivicrmTestBase::assertPageNoErrorMessages protected function Asserts the page has no error messages.
WebformCivicrmTestBase::configureContributionTab protected function
WebformCivicrmTestBase::createCustomGroup protected function Create custom group.
WebformCivicrmTestBase::createHousehold protected function Create test contact of type individual.
WebformCivicrmTestBase::createIndividual protected function Create test contact of type individual.
WebformCivicrmTestBase::createPaymentProcessor protected function Create Payment Processor.
WebformCivicrmTestBase::editCivicrmOptionElement protected function Modify settings so the element displays as a checkbox
WebformCivicrmTestBase::editContactElement protected function Edit contact element on the build form.
WebformCivicrmTestBase::enableBillingSection protected function Enable Billing Section on the contribution tab.
WebformCivicrmTestBase::enableCivicrmOnWebform public function Enables civicrm on the webform.
WebformCivicrmTestBase::enableComponent protected function Enable Component in CiviCRM.
WebformCivicrmTestBase::fillBillingFields protected function Insert values in billing fields.
WebformCivicrmTestBase::fillCKEditor public function Fill CKEditor field.
WebformCivicrmTestBase::fillContactAutocomplete protected function Fill Contact Autocomplete widget.
WebformCivicrmTestBase::getUFMatchRecord protected function Return UF Match record.
WebformCivicrmTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides WebDriverTestBase::initFrontPage
WebformCivicrmTestBase::saveCiviCRMSettings public function Save the settings configured on the civicrm tab.
WebformCivicrmTestBase::sendKeyPress protected function Send a key press to an element.
WebformCivicrmTestBase::setUp protected function Overrides CiviCrmTestBase::setUp 5
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.