You are here

class CreditCardTest in Ubercart 8.4

Tests credit card payments with the test gateway.

This class is intended to be subclassed for use in testing other credit card gateways. Subclasses which test other gateways need to:

  • Override public static $modules, if necessary to enable the module providing the gateway and any other needed modules.
  • Override configureGateway() to implement gateway-specific configuration.

No other overrides are necessary, although a subclass may want to add additional test functions to cover cases not included in this base class.

@group ubercart

Hierarchy

Expanded class hierarchy of CreditCardTest

File

payment/uc_credit/tests/src/Functional/CreditCardTest.php, line 20

Namespace

Drupal\Tests\uc_credit\Functional
View source
class CreditCardTest extends UbercartBrowserTestBase {

  /**
   * A selection of "test" numbers to use for testing credit card payments.
   *
   * These numbers all pass the Luhn algorithm check and are reserved by
   * the card issuer for testing purposes.
   *
   * @var string[]
   */
  protected static $cardTestNumbers = [
    '378282246310005',
    // American Express
    '371449635398431',
    '370000000000002',
    '378734493671000',
    // American Express Corporate
    '5610591081018250',
    // Australian BankCard
    '30569309025904',
    // Diners Club
    '38520000023237',
    '38000000000006',
    // Carte Blanche
    '6011111111111117',
    // Discover
    '6011000990139424',
    '6011000000000012',
    '3530111333300000',
    // JCB
    '3566002020360505',
    '3088000000000017',
    '5555555555554444',
    // MasterCard
    '5105105105105100',
    '4111111111111111',
    // Visa
    '4012888888881881',
    '4007000000027',
    '4012888818888',
  ];

  /**
   * The payment method to use.
   *
   * @var \Drupal\uc_payment\PaymentMethodInterface
   */
  protected $paymentMethod;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'uc_payment',
    'uc_credit',
  ];

  /**
   * {@inheritdoc}
   */
  protected static $adminPermissions = [
    'administer credit cards',
    'process credit cards',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();

    // Need admin permissions in order to change credit card settings.
    $this
      ->drupalLogin($this->adminUser);

    // Configure and enable Credit card module and Test gateway.
    $this
      ->configureCreditCard();
    $this
      ->configureGateway();
  }

  /**
   * Tests security settings configuration.
   */
  public function testSecuritySettings() {

    /** @var \Drupal\Tests\WebAssert $assert */
    $assert = $this
      ->assertSession();

    // @todo Still need tests with existing key file
    // where key file is not readable or doesn't contain a valid key.
    // Create key directory, make it readable and writeable.
    \Drupal::service('file_system')
      ->mkdir('sites/default/files/testkey', 0755);

    // Try to submit settings form without a key file path.
    // Save current variable, reset to its value when first installed.
    $config = \Drupal::configFactory()
      ->getEditable('uc_credit.settings');
    $temp_variable = $config
      ->get('encryption_path');
    $config
      ->set('encryption_path', '')
      ->save();
    $this
      ->drupalGet('admin/store');
    $assert
      ->pageTextContains('You must review your credit card security settings and enable encryption before you can accept credit card payments.');
    $this
      ->drupalGet('admin/store/config/payment/credit');
    $this
      ->submitForm([], 'Save configuration');

    // Check that key file has not yet been configured.
    $assert
      ->fieldValueEquals('uc_credit_encryption_path', 'Not configured.');

    // Restore variable setting.
    $config
      ->set('encryption_path', $temp_variable)
      ->save();

    // Try to submit settings form with an empty key file path.
    $this
      ->drupalGet('admin/store/config/payment/credit');
    $this
      ->submitForm([
      'uc_credit_encryption_path' => '',
    ], 'Save configuration');
    $assert
      ->pageTextContains('Key path must be specified in security settings tab.');

    // Specify non-existent directory.
    $this
      ->drupalGet('admin/store/config/payment/credit');
    $this
      ->submitForm([
      'uc_credit_encryption_path' => 'sites/default/ljkh/asdfasfaaaaa',
    ], 'Save configuration');
    $assert
      ->pageTextContains('You have specified a non-existent directory.');

    // Next, specify existing directory that's write protected.
    // Use /dev, as that should never be accessible.
    $this
      ->drupalGet('admin/store/config/payment/credit');
    $this
      ->submitForm([
      'uc_credit_encryption_path' => '/dev',
    ], 'Save configuration');
    $assert
      ->pageTextContains('Cannot write to directory, please verify the directory permissions.');

    // Next, specify writeable directory, but with trailing '/' and
    // excess whitespace.
    $this
      ->drupalGet('admin/store/config/payment/credit');
    $this
      ->submitForm([
      'uc_credit_encryption_path' => '  sites/default/files/testkey/ ',
    ], 'Save configuration');

    // See that the directory has been properly re-written to remove
    // trailing '/' and whitespace.
    $assert
      ->fieldValueEquals('uc_credit_encryption_path', 'sites/default/files/testkey');
    $assert
      ->pageTextContains('Credit card encryption key file generated.');

    // Check that warning about needing key file goes away.
    $assert
      ->pageTextNotContains('Credit card security settings must be configured in the security settings tab.');

    // Remove key file.
    \Drupal::service('file_system')
      ->unlink('sites/default/files/testkey/' . UC_CREDIT_KEYFILE_NAME);

    // Finally, specify good directory.
    $this
      ->drupalGet('admin/store/config/payment/credit');
    $this
      ->submitForm([
      'uc_credit_encryption_path' => 'sites/default/files/testkey',
    ], 'Save configuration');
    $assert
      ->pageTextContains('Credit card encryption key file generated.');

    // Test contents - must contain 32-character hexadecimal string.
    $this
      ->assertTrue(file_exists('sites/default/files/simpletest.keys/' . UC_CREDIT_KEYFILE_NAME), 'Key has been generated and stored.');
    $this
      ->assertTrue(preg_match("([0-9a-fA-F]{32})", uc_credit_encryption_key()), 'Valid key detected in key file.');

    // Cleanup keys directory after test.
    \Drupal::service('file_system')
      ->unlink('sites/default/files/testkey/' . UC_CREDIT_KEYFILE_NAME);
    \Drupal::service('file_system')
      ->rmdir('sites/default/files/testkey');
  }

  /**
   * Tests that an order can be placed using the test gateway.
   */
  public function testCheckout() {

    /** @var \Drupal\Tests\WebAssert $assert */
    $assert = $this
      ->assertSession();
    $this
      ->addToCart($this->product);

    // Submit the checkout page. Note that because of the Ajax on the country
    // fields, which is used to populate the zone select, the zone doesn't
    // actually get set by this post. That's OK because we're not checking that
    // yet. But we need to make sure that the next time we post this page
    // (which now has the country set from the first post) we include the zones.
    $edit = $this
      ->populateCheckoutForm([
      'panes[payment][details][cc_number]' => array_rand(array_flip(self::$cardTestNumbers)),
      'panes[payment][details][cc_cvv]' => mt_rand(100, 999),
      'panes[payment][details][cc_exp_month]' => mt_rand(1, 12),
      'panes[payment][details][cc_exp_year]' => mt_rand(date('Y') + 1, 2022),
    ]);
    $this
      ->drupalGet('cart/checkout');
    $this
      ->submitForm($edit, 'Review order');

    // Confirm that truncated credit card number was found.
    $assert
      ->pageTextContains('(Last 4) ' . substr($edit['panes[payment][details][cc_number]'], -4));

    // Confirm that expiry date was found.
    $assert
      ->pageTextContains($edit['panes[payment][details][cc_exp_year]']);

    // Go back. Form will still be populated, but verify that the credit
    // card number is truncated and CVV is masked for security.
    $this
      ->submitForm([], 'Back');

    // Check that truncated credit card number found.
    $assert
      ->fieldValueEquals('panes[payment][details][cc_number]', '(Last 4) ' . substr($edit['panes[payment][details][cc_number]'], -4));

    // Check that masked CVV found.
    $assert
      ->fieldValueEquals('panes[payment][details][cc_cvv]', '---');

    // Check that expiry month found.
    $assert
      ->fieldValueEquals('panes[payment][details][cc_exp_month]', $edit['panes[payment][details][cc_exp_month]']);

    // Check that expiry year found.
    $assert
      ->fieldValueEquals('panes[payment][details][cc_exp_year]', $edit['panes[payment][details][cc_exp_year]']);

    // Change the card number and fail with a known-bad CVV.
    $edit['panes[payment][details][cc_number]'] = array_rand(array_flip(self::$cardTestNumbers));
    $edit['panes[payment][details][cc_cvv]'] = '000';

    // If zones were set, we must re-submit them here to work around the Ajax
    // situation described above. So we just re-submit all the data to be safe.
    $this
      ->submitForm($edit, 'Review order');

    // Confirm that truncated updated credit card number was found.
    $assert
      ->pageTextContains('(Last 4) ' . substr($edit['panes[payment][details][cc_number]'], -4));

    // Try to submit the bad CVV.
    $this
      ->submitForm([], 'Submit order');
    $assert
      ->pageTextContains('We were unable to process your credit card payment. Please verify your details and try again.');

    // Go back. Again check for truncated card number and masked CVV.
    $this
      ->submitForm([], 'Back');

    // Verify truncated updated credit card number found.
    $assert
      ->fieldValueEquals('panes[payment][details][cc_number]', '(Last 4) ' . substr($edit['panes[payment][details][cc_number]'], -4));

    // Verify masked CVV found.
    $assert
      ->fieldValueEquals('panes[payment][details][cc_cvv]', '---');

    // Fix the CVV and repost.
    $edit['panes[payment][details][cc_cvv]'] = mt_rand(100, 999);
    $this
      ->submitForm($edit, 'Review order');

    // Check for success.
    $this
      ->submitForm([], 'Submit order');
    $assert
      ->pageTextContains('Your order is complete!');
  }

  /**
   * Tests that expiry date validation functions correctly.
   */
  public function testExpiryDate() {

    /** @var \Drupal\Tests\WebAssert $assert */
    $assert = $this
      ->assertSession();
    $order = $this
      ->createOrder([
      'payment_method' => $this->paymentMethod['id'],
    ]);
    $year = date('Y');
    $month = date('n');
    for ($y = $year; $y <= $year + 2; $y++) {
      for ($m = 1; $m <= 12; $m++) {
        $edit = [
          'amount' => 1,
          'cc_data[cc_number]' => '4111111111111111',
          'cc_data[cc_cvv]' => '123',
          'cc_data[cc_exp_month]' => $m,
          'cc_data[cc_exp_year]' => $y,
        ];
        $this
          ->drupalGet('admin/store/orders/' . $order
          ->id() . '/credit/' . $this->paymentMethod['id']);
        $this
          ->submitForm($edit, 'Charge amount');
        if ($y > $year || $m >= $month) {

          // Check that expiry date in the future passed validation.
          $assert
            ->pageTextContains('The credit card was processed successfully.');
        }
        else {

          // Check that expiry date in the past failed validation.
          $assert
            ->pageTextNotContains('The credit card was processed successfully.');
        }
      }
    }
  }

  /**
   * Helper function to configure Credit Card payment method settings.
   */
  protected function configureCreditCard() {

    /** @var \Drupal\Tests\WebAssert $assert */
    $assert = $this
      ->assertSession();

    // Create key directory, make it readable and writeable.
    // Putting this under sites/default/files because SimpleTest needs to be
    // able to create the directory - this is NOT where you'd put the key file
    // on a live site. On a live site, it should be outside the web root.
    \Drupal::service('file_system')
      ->mkdir('sites/default/files/simpletest.keys', 0755);
    $this
      ->drupalGet('admin/store/config/payment/credit');
    $this
      ->submitForm([
      'uc_credit_encryption_path' => 'sites/default/files/simpletest.keys',
    ], 'Save configuration');

    // Check that key file path has been set.
    $assert
      ->fieldValueEquals('uc_credit_encryption_path', 'sites/default/files/simpletest.keys');
    $this
      ->assertTrue(file_exists('sites/default/files/simpletest.keys/' . UC_CREDIT_KEYFILE_NAME), 'Key has been generated and stored.');
    $this
      ->assertTrue(TRUE, 'Key = ' . uc_credit_encryption_key());
  }

  /**
   * Helper function to configure Credit Card gateway.
   */
  protected function configureGateway() {
    $this->paymentMethod = $this
      ->createPaymentMethod('test_gateway');
  }

  /**
   * {@inheritdoc}
   */
  protected function tearDown() {

    // Cleanup keys directory after test.
    \Drupal::service('file_system')
      ->unlink('sites/default/files/simpletest.keys/' . UC_CREDIT_KEYFILE_NAME);
    \Drupal::service('file_system')
      ->rmdir('sites/default/files/simpletest.keys');
    parent::tearDown();
  }

}

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
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.
AttributeTestTrait::createAttribute protected function Creates an attribute.
AttributeTestTrait::createAttributeOption protected function Creates an attribute option.
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::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
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::$minkDefaultDriverClass protected property 1
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::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::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. 1
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::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
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
CreditCardTest::$adminPermissions protected static property Permissions for administrator user. Overrides UbercartBrowserTestBase::$adminPermissions
CreditCardTest::$cardTestNumbers protected static property A selection of "test" numbers to use for testing credit card payments.
CreditCardTest::$modules protected static property Modules to enable. Overrides UbercartBrowserTestBase::$modules
CreditCardTest::$paymentMethod protected property The payment method to use.
CreditCardTest::configureCreditCard protected function Helper function to configure Credit Card payment method settings.
CreditCardTest::configureGateway protected function Helper function to configure Credit Card gateway.
CreditCardTest::setUp protected function Overrides UbercartBrowserTestBase::setUp
CreditCardTest::tearDown protected function Overrides BrowserTestBase::tearDown
CreditCardTest::testCheckout public function Tests that an order can be placed using the test gateway.
CreditCardTest::testExpiryDate public function Tests that expiry date validation functions correctly.
CreditCardTest::testSecuritySettings public function Tests security settings configuration.
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::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
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
OrderTestTrait::createOrder protected function Creates a new order directly, without going through checkout.
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.
ProductTestTrait::createProduct protected function Creates a new product.
ProductTestTrait::createProductClass protected function Creates a new product node type, AKA 'product class'.
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::$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::$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
UbercartBrowserTestBase::$adminUser protected property User with privileges to do everything.
UbercartBrowserTestBase::$product protected property Test product.
UbercartBrowserTestBase::$profile protected property The profile to install as a basis for testing. Overrides BrowserTestBase::$profile 1
UbercartBrowserTestBase::$strictConfigSchema protected property Don't check for or validate config schema. Overrides TestSetupTrait::$strictConfigSchema
UbercartBrowserTestBase::addToCart protected function Adds a product to the cart.
UbercartBrowserTestBase::assertNoMailString protected function Asserts that the most recently sent e-mails do not have the string in it.
UbercartBrowserTestBase::checkout protected function Executes the checkout process.
UbercartBrowserTestBase::createPaymentMethod protected function Defines a new payment method.
UbercartBrowserTestBase::populateCheckoutForm protected function Helper function to fill-in required fields on the checkout page. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
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.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.