You are here

class PaymentMethodTest in Commerce Core 8.2

Same name in this branch
  1. 8.2 modules/payment/tests/src/Functional/PaymentMethodTest.php \Drupal\Tests\commerce_payment\Functional\PaymentMethodTest
  2. 8.2 modules/payment/tests/src/FunctionalJavascript/PaymentMethodTest.php \Drupal\Tests\commerce_payment\FunctionalJavascript\PaymentMethodTest
  3. 8.2 modules/payment/tests/src/Kernel/Entity/PaymentMethodTest.php \Drupal\Tests\commerce_payment\Kernel\Entity\PaymentMethodTest

Tests the payment method UI.

@group commerce

Hierarchy

Expanded class hierarchy of PaymentMethodTest

File

modules/payment/tests/src/Functional/PaymentMethodTest.php, line 15

Namespace

Drupal\Tests\commerce_payment\Functional
View source
class PaymentMethodTest extends CommerceBrowserTestBase {

  /**
   * A normal user with minimum permissions.
   *
   * @var \Drupal\User\UserInterface
   */
  protected $user;

  /**
   * The payment method collection url.
   *
   * @var string
   */
  protected $collectionUrl;

  /**
   * An on-site payment gateway.
   *
   * @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface
   */
  protected $paymentGateway;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'commerce_payment',
    'commerce_payment_example',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $permissions = [
      'manage own commerce_payment_method',
    ];
    $this->user = $this
      ->drupalCreateUser($permissions);
    $this
      ->drupalLogin($this->user);
    $this->store
      ->set('billing_countries', [
      'FR',
      'US',
    ]);
    $this->store
      ->save();
    $this->collectionUrl = 'user/' . $this->user
      ->id() . '/payment-methods';

    /** @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface $payment_gateway */
    $this->paymentGateway = $this
      ->createEntity('commerce_payment_gateway', [
      'id' => 'example',
      'label' => 'Example',
      'plugin' => 'example_onsite',
    ]);
  }

  /**
   * Tests accessing the payment method pages.
   */
  public function testUserAccess() {
    $this
      ->drupalGet('user/' . $this->adminUser
      ->id() . '/payment-methods');
    $this
      ->assertSession()
      ->statusCodeEquals(403);
    $this
      ->drupalGet('user/' . $this->adminUser
      ->id() . '/payment-methods/add');
    $this
      ->assertSession()
      ->statusCodeEquals(403);
    $this
      ->drupalLogout();

    // Ensure anonymous users don't have access to the manage payment methods
    // page, even if either the "manage own payment methods" permission or
    // the "administer commerce_payment_method" is granted.
    $role = Role::load(AccountInterface::ANONYMOUS_ROLE);
    $role
      ->grantPermission('manage own commerce_payment_method');
    $role
      ->grantPermission('administer commerce_payment_method');
    $role
      ->trustData()
      ->save();
    $this
      ->drupalGet('user/0/payment-methods');
    $this
      ->assertSession()
      ->statusCodeEquals(403);
    $this
      ->drupalGet('user/0/payment-methods/add');
    $this
      ->assertSession()
      ->statusCodeEquals(403);
  }

  /**
   * Tests creating and updating a payment method.
   */
  public function testPaymentMethodCreationAndUpdate() {
    $default_address = [
      'country_code' => 'US',
      'administrative_area' => 'SC',
      'locality' => 'Greenville',
      'postal_code' => '29616',
      'address_line1' => '9 Drupal Ave',
      'given_name' => 'Bryan',
      'family_name' => 'Centarro',
    ];
    $default_profile = $this
      ->createEntity('profile', [
      'type' => 'customer',
      'uid' => $this->user
        ->id(),
      'address' => $default_address,
    ]);

    /** @var \Drupal\commerce_payment_example\Plugin\Commerce\PaymentGateway\OnsiteInterface $plugin */
    $this
      ->drupalGet($this->collectionUrl);
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Add payment method');
    $this
      ->assertSession()
      ->addressEquals($this->collectionUrl . '/add');
    $rendered_address = $default_address;

    // Note that the full country name is rendered (not just the country code).
    $rendered_address['country_code'] = 'United States';

    // Confirm that the default profile's address is rendered.
    foreach ($rendered_address as $property => $value) {
      $prefix = 'add_payment_method[billing_information][address][0][address]';
      $this
        ->assertSession()
        ->pageTextContains($value);
      $this
        ->assertSession()
        ->fieldNotExists($prefix . '[' . $property . ']');
    }
    $form_values = [
      'add_payment_method[payment_details][number]' => '4111111111111111',
      'add_payment_method[payment_details][expiration][month]' => '01',
      'add_payment_method[payment_details][expiration][year]' => date('Y') + 1,
      'add_payment_method[payment_details][security_code]' => '111',
    ];
    $this
      ->submitForm($form_values, 'Save');
    $this
      ->assertSession()
      ->addressEquals($this->collectionUrl);
    $this
      ->assertSession()
      ->pageTextContains('Visa ending in 1111 saved to your payment methods.');
    $payment_method = PaymentMethod::load(1);
    $billing_profile = $payment_method
      ->getBillingProfile();
    $this
      ->assertEquals($this->user
      ->id(), $payment_method
      ->getOwnerId());
    $this
      ->assertEquals($default_address, array_filter($billing_profile
      ->get('address')
      ->first()
      ->getValue()));
    $this
      ->assertEquals(2, $payment_method
      ->getBillingProfile()
      ->id());
    $this
      ->drupalGet($this->collectionUrl . '/' . $payment_method
      ->id() . '/edit');

    // Confirm that the default profile's address is rendered.
    foreach ($rendered_address as $property => $value) {
      $prefix = 'add_payment_method[billing_information][address][0][address]';
      $this
        ->assertSession()
        ->pageTextContains($value);
      $this
        ->assertSession()
        ->fieldNotExists($prefix . '[' . $property . ']');
    }
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $form_values = [
      'payment_method[payment_details][expiration][month]' => '02',
      'payment_method[payment_details][expiration][year]' => '2026',
      'payment_method[billing_information][address][0][address][given_name]' => 'Johnny',
      'payment_method[billing_information][address][0][address][family_name]' => 'Appleseed',
      'payment_method[billing_information][address][0][address][address_line1]' => '123 New York Drive',
      'payment_method[billing_information][address][0][address][locality]' => 'New York City',
      'payment_method[billing_information][address][0][address][administrative_area]' => 'NY',
      'payment_method[billing_information][address][0][address][postal_code]' => '10001',
    ];
    $this
      ->submitForm($form_values, 'Save');
    $this
      ->assertSession()
      ->addressEquals($this->collectionUrl);
    $this
      ->assertSession()
      ->pageTextContains('2/2026');
    \Drupal::entityTypeManager()
      ->getStorage('commerce_payment_method')
      ->resetCache([
      1,
    ]);
    \Drupal::entityTypeManager()
      ->getStorage('profile')
      ->resetCache([
      2,
    ]);
    $payment_method = PaymentMethod::load(1);
    $this
      ->assertEquals('2026', $payment_method
      ->get('card_exp_year')->value);

    /** @var \Drupal\profile\Entity\ProfileInterface $billing_profile */
    $billing_profile = $payment_method
      ->getBillingProfile();
    $this
      ->assertEquals($this->user
      ->id(), $payment_method
      ->getOwnerId());
    $this
      ->assertEquals('NY', $billing_profile
      ->get('address')
      ->first()
      ->getAdministrativeArea());
    $this
      ->assertEquals(2, $payment_method
      ->getBillingProfile()
      ->id());

    // Confirm that the address book profile was updated.
    $default_profile = $this
      ->reloadEntity($default_profile);
    $this
      ->assertTrue($billing_profile
      ->get('address')
      ->equals($default_profile
      ->get('address')));
  }

  /**
   * Tests creating and updating a payment method without billing information.
   */
  public function testPaymentMethodCreationAndUpdateWithoutBilling() {
    $this->paymentGateway
      ->setPluginConfiguration([
      'collect_billing_information' => FALSE,
    ]);
    $this->paymentGateway
      ->save();

    /** @var \Drupal\commerce_payment_example\Plugin\Commerce\PaymentGateway\OnsiteInterface $plugin */
    $this
      ->drupalGet($this->collectionUrl);
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Add payment method');
    $this
      ->assertSession()
      ->addressEquals($this->collectionUrl . '/add');
    $this
      ->assertSession()
      ->pageTextNotContains('Country');
    $form_values = [
      'add_payment_method[payment_details][number]' => '4111111111111111',
      'add_payment_method[payment_details][expiration][month]' => '01',
      'add_payment_method[payment_details][expiration][year]' => date('Y') + 1,
      'add_payment_method[payment_details][security_code]' => '111',
    ];
    $this
      ->submitForm($form_values, 'Save');
    $this
      ->assertSession()
      ->addressEquals($this->collectionUrl);
    $this
      ->assertSession()
      ->pageTextContains('Visa ending in 1111 saved to your payment methods.');
    $payment_method = PaymentMethod::load(1);
    $this
      ->assertNull($payment_method
      ->getBillingProfile());
    $this
      ->drupalGet($this->collectionUrl . '/' . $payment_method
      ->id() . '/edit');
    $this
      ->assertSession()
      ->pageTextNotContains('Country');
    $form_values = [
      'payment_method[payment_details][expiration][month]' => '02',
      'payment_method[payment_details][expiration][year]' => '2026',
    ];
    $this
      ->submitForm($form_values, 'Save');
    $this
      ->assertSession()
      ->addressEquals($this->collectionUrl);
    $this
      ->assertSession()
      ->pageTextContains('2/2026');
    \Drupal::entityTypeManager()
      ->getStorage('commerce_payment_method')
      ->resetCache([
      1,
    ]);
    $payment_method = PaymentMethod::load(1);
    $this
      ->assertEquals('2026', $payment_method
      ->get('card_exp_year')->value);
    $this
      ->assertNull($payment_method
      ->getBillingProfile());
  }

  /**
   * Tests creating a payment method declined by the remote API.
   */
  public function testPaymentMethodDecline() {

    /** @var \Drupal\commerce_payment_example\Plugin\Commerce\PaymentGateway\OnsiteInterface $plugin */
    $this
      ->drupalGet($this->collectionUrl);
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Add payment method');
    $this
      ->assertSession()
      ->addressEquals($this->collectionUrl . '/add');
    $form_values = [
      'add_payment_method[payment_details][number]' => '4111111111111111',
      'add_payment_method[payment_details][expiration][month]' => '01',
      'add_payment_method[payment_details][expiration][year]' => date('Y') + 1,
      'add_payment_method[payment_details][security_code]' => '111',
      'add_payment_method[billing_information][address][0][address][given_name]' => 'Johnny',
      'add_payment_method[billing_information][address][0][address][family_name]' => 'Appleseed',
      'add_payment_method[billing_information][address][0][address][address_line1]' => '123 New York Drive',
      'add_payment_method[billing_information][address][0][address][locality]' => 'Somewhere',
      'add_payment_method[billing_information][address][0][address][administrative_area]' => 'WI',
      'add_payment_method[billing_information][address][0][address][postal_code]' => '53141',
    ];
    $this
      ->submitForm($form_values, 'Save');
    $this
      ->assertSession()
      ->addressNotEquals($this->collectionUrl);
    $this
      ->assertSession()
      ->pageTextNotContains('Visa ending in 1111 saved to your payment methods.');
    $this
      ->assertSession()
      ->pageTextContains('We encountered an error processing your payment method. Please verify your details and try again.');
  }

  /**
   * Tests deleting a payment method.
   */
  public function testPaymentMethodDeletion() {
    $payment_method = $this
      ->createEntity('commerce_payment_method', [
      'uid' => $this->user
        ->id(),
      'type' => 'credit_card',
      'payment_gateway' => 'example',
    ]);
    $details = [
      'type' => 'visa',
      'number' => '4111111111111111',
      'expiration' => [
        'month' => '01',
        'year' => date("Y") + 1,
      ],
    ];
    $this->paymentGateway
      ->getPlugin()
      ->createPaymentMethod($payment_method, $details);
    $this->paymentGateway
      ->save();
    $this
      ->drupalGet($this->collectionUrl . '/' . $payment_method
      ->id() . '/delete');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Delete');
    $this
      ->assertSession()
      ->addressEquals($this->collectionUrl);
    $payment_gateway = PaymentMethod::load($payment_method
      ->id());
    $this
      ->assertNull($payment_gateway);
  }

  /**
   * Tests deleting a payment method without a gateway.
   */
  public function testPaymentMethodDeletionNoGateway() {
    $payment_method = $this
      ->createEntity('commerce_payment_method', [
      'uid' => $this->user
        ->id(),
      'type' => 'credit_card',
      'payment_gateway' => 'example',
    ]);
    $details = [
      'type' => 'visa',
      'number' => '4111111111111111',
      'expiration' => [
        'month' => '01',
        'year' => date("Y") + 1,
      ],
    ];
    $this->paymentGateway
      ->getPlugin()
      ->createPaymentMethod($payment_method, $details);
    $this->paymentGateway
      ->delete();
    $this
      ->drupalGet($this->collectionUrl . '/' . $payment_method
      ->id() . '/delete');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Delete');
    $this
      ->assertSession()
      ->addressEquals($this->collectionUrl);
    $payment_gateway = PaymentMethod::load($payment_method
      ->id());
    $this
      ->assertNull($payment_gateway);
  }

}

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.
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::$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::$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::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.
CommerceBrowserTestBase::$adminUser protected property A test user with administrative privileges.
CommerceBrowserTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme 1
CommerceBrowserTestBase::$store protected property The store entity.
CommerceBrowserTestBase::getAdministratorPermissions protected function Gets the permissions for the admin user. 14
CommerceBrowserTestBase::tearDown protected function Overrides BrowserTestBase::tearDown
CommerceBrowserTestTrait::assertFieldValues protected function Asserts that the passed field values are correct.
CommerceBrowserTestTrait::createEntity protected function Creates a new entity.
CommerceBrowserTestTrait::reloadEntity protected function Reloads the entity after clearing the static cache.
CommerceBrowserTestTrait::saveHtmlOutput protected function Debugger method to save additional HTML output.
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
DeprecationSuppressionTrait::restoreErrorHandler protected function Restores the original error handler.
DeprecationSuppressionTrait::setErrorHandler protected function Sets an error handler to suppress specified deprecation messages.
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
PaymentMethodTest::$collectionUrl protected property The payment method collection url.
PaymentMethodTest::$modules public static property Modules to enable. Overrides CommerceBrowserTestBase::$modules
PaymentMethodTest::$paymentGateway protected property An on-site payment gateway.
PaymentMethodTest::$user protected property A normal user with minimum permissions.
PaymentMethodTest::setUp protected function Overrides CommerceBrowserTestBase::setUp
PaymentMethodTest::testPaymentMethodCreationAndUpdate public function Tests creating and updating a payment method.
PaymentMethodTest::testPaymentMethodCreationAndUpdateWithoutBilling public function Tests creating and updating a payment method without billing information.
PaymentMethodTest::testPaymentMethodDecline public function Tests creating a payment method declined by the remote API.
PaymentMethodTest::testPaymentMethodDeletion public function Tests deleting a payment method.
PaymentMethodTest::testPaymentMethodDeletionNoGateway public function Tests deleting a payment method without a gateway.
PaymentMethodTest::testUserAccess public function Tests accessing the payment method pages.
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.
StoreCreationTrait::createStore protected function Creates a store for the test.
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::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.