You are here

class CouponRedemptionPaneTest in Commerce Core 8.2

Tests the coupon redemption checkout pane.

@group commerce

Hierarchy

Expanded class hierarchy of CouponRedemptionPaneTest

File

modules/promotion/tests/src/FunctionalJavascript/CouponRedemptionPaneTest.php, line 18

Namespace

Drupal\Tests\commerce_promotion\FunctionalJavascript
View source
class CouponRedemptionPaneTest extends CommerceWebDriverTestBase {

  /**
   * The cart order to test against.
   *
   * @var \Drupal\commerce_order\Entity\OrderInterface
   */
  protected $cart;

  /**
   * The cart manager.
   *
   * @var \Drupal\commerce_cart\CartManagerInterface
   */
  protected $cartManager;

  /**
   * The promotion.
   *
   * @var \Drupal\commerce_promotion\Entity\PromotionInterface
   */
  protected $promotion;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'block',
    'commerce_cart',
    'commerce_promotion',
    'commerce_promotion_test',
    'commerce_checkout',
    'commerce_payment',
    'commerce_payment_example',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->cart = $this->container
      ->get('commerce_cart.cart_provider')
      ->createCart('default', $this->store, $this->adminUser);
    $this->cartManager = $this->container
      ->get('commerce_cart.cart_manager');
    OrderItemType::create([
      'id' => 'test',
      'label' => 'Test',
      'orderType' => 'default',
    ])
      ->save();
    $order_item = OrderItem::create([
      'type' => 'test',
      'quantity' => 1,
      'unit_price' => new Price('999.00', 'USD'),
    ]);
    $order_item
      ->save();
    $this->cartManager
      ->addOrderItem($this->cart, $order_item);

    // Starts now, enabled. No end time.
    $this->promotion = $this
      ->createEntity('commerce_promotion', [
      'name' => 'Promotion (with coupon)',
      'order_types' => [
        'default',
      ],
      'stores' => [
        $this->store
          ->id(),
      ],
      'status' => TRUE,
      'offer' => [
        'target_plugin_id' => 'order_percentage_off',
        'target_plugin_configuration' => [
          'percentage' => '0.10',
        ],
      ],
      'start_date' => '2017-01-01',
      'conditions' => [],
    ]);
    $coupon = $this
      ->createEntity('commerce_promotion_coupon', [
      'code' => $this
        ->getRandomGenerator()
        ->word(8),
      'status' => TRUE,
    ]);
    $coupon
      ->save();
    $this->promotion
      ->addCoupon($coupon);
    $this->promotion
      ->save();

    /** @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface $offsite_gateway */
    $offsite_gateway = PaymentGateway::create([
      'id' => 'offsite',
      'label' => 'Off-site',
      'plugin' => 'example_offsite_redirect',
      'configuration' => [
        'redirect_method' => 'post',
        'payment_method_types' => [
          'credit_card',
        ],
      ],
    ]);
    $offsite_gateway
      ->save();

    /** @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface $onsite_gateway */
    $onsite_gateway = PaymentGateway::create([
      'id' => 'onsite',
      'label' => 'On-site',
      'plugin' => 'example_onsite',
      'configuration' => [
        'api_key' => '2342fewfsfs',
        'payment_method_types' => [
          'credit_card',
        ],
      ],
    ]);
    $onsite_gateway
      ->save();
    $profile = $this
      ->createEntity('profile', [
      'type' => 'customer',
      'address' => [
        'country_code' => 'US',
        'postal_code' => '53177',
        'locality' => 'Milwaukee',
        'address_line1' => 'Pabst Blue Ribbon Dr',
        'administrative_area' => 'WI',
        'given_name' => 'Frederick',
        'family_name' => 'Pabst',
      ],
      'uid' => $this->adminUser
        ->id(),
    ]);
    $payment_method1 = $this
      ->createEntity('commerce_payment_method', [
      'uid' => $this->adminUser
        ->id(),
      'type' => 'credit_card',
      'payment_gateway' => 'onsite',
      'card_type' => 'visa',
      'card_number' => '1111',
      'billing_profile' => $profile,
      'reusable' => TRUE,
      'expires' => strtotime('2028/03/24'),
    ]);
    $payment_method1
      ->setBillingProfile($profile);
    $payment_method1
      ->save();
    $payment_method2 = $this
      ->createEntity('commerce_payment_method', [
      'type' => 'credit_card',
      'payment_gateway' => 'onsite',
      'card_type' => 'visa',
      'card_number' => '9999',
      'billing_profile' => $profile,
      'reusable' => TRUE,
      'expires' => strtotime('2028/03/24'),
    ]);
    $payment_method2
      ->setBillingProfile($profile);
    $payment_method2
      ->save();
  }

  /**
   * Tests redeeming a coupon using the coupon redemption pane.
   */
  public function testCouponRedemption() {
    $coupons = $this->promotion
      ->getCoupons();
    $coupon = reset($coupons);
    $checkout_url = Url::fromRoute('commerce_checkout.form', [
      'commerce_order' => $this->cart
        ->id(),
    ]);
    $this
      ->drupalGet($checkout_url);

    // Confirm that validation errors set by the form element are visible.
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Apply coupon');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains('Please provide a coupon code');

    // Valid coupon.
    $this
      ->getSession()
      ->getPage()
      ->fillField('Coupon code', $coupon
      ->getCode());
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Apply coupon');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains($coupon
      ->getCode());
    $this
      ->assertSession()
      ->fieldNotExists('Coupon code');
    $this
      ->assertSession()
      ->buttonNotExists('Apply coupon');
    $this
      ->assertSession()
      ->pageTextContains('-$99.90');
    $this
      ->assertSession()
      ->pageTextContains('$899.10');

    // Coupon removal.
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Remove coupon');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextNotContains($coupon
      ->getCode());
    $this
      ->assertSession()
      ->fieldExists('Coupon code');
    $this
      ->assertSession()
      ->buttonExists('Apply coupon');
    $this
      ->assertSession()
      ->pageTextNotContains('-$99.90');
    $this
      ->assertSession()
      ->pageTextContains('$999');

    // Valid coupon.
    $this
      ->getSession()
      ->getPage()
      ->fillField('Coupon code', $coupon
      ->getCode());
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Apply coupon');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains($coupon
      ->getCode());
    $this
      ->assertSession()
      ->fieldNotExists('Coupon code');
    $this
      ->assertSession()
      ->buttonNotExists('Apply coupon');
    $this
      ->assertSession()
      ->pageTextContains('-$99.90');
    $this
      ->assertSession()
      ->pageTextContains('$899.10');

    // Coupon removal.
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Remove coupon');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextNotContains($coupon
      ->getCode());
    $this
      ->assertSession()
      ->fieldExists('Coupon code');
    $this
      ->assertSession()
      ->buttonExists('Apply coupon');
    $this
      ->assertSession()
      ->pageTextNotContains('-$99.90');
    $this
      ->assertSession()
      ->pageTextContains('$999');

    // Confirm that the order summary is refreshed when outside of the sidebar.
    $checkout_flow = CheckoutFlow::load('default');
    $configuration = $checkout_flow
      ->get('configuration');
    $configuration['panes']['order_summary']['step'] = 'order_information';
    $checkout_flow
      ->set('configuration', $configuration);
    $checkout_flow
      ->save();
    $this
      ->drupalGet($checkout_url);
    $this
      ->getSession()
      ->getPage()
      ->fillField('Coupon code', $coupon
      ->getCode());
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Apply coupon');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains($coupon
      ->getCode());
    $this
      ->assertSession()
      ->fieldNotExists('Coupon code');
    $this
      ->assertSession()
      ->buttonNotExists('Apply coupon');
    $this
      ->assertSession()
      ->pageTextContains('-$99.90');
    $this
      ->assertSession()
      ->pageTextContains('$899.10');
  }

  /**
   * Tests redeeming coupon on the cart form, with multiple coupons allowed.
   */
  public function testMultipleCouponRedemption() {
    $config = \Drupal::configFactory()
      ->getEditable('commerce_checkout.commerce_checkout_flow.default');
    $config
      ->set('configuration.panes.coupon_redemption.allow_multiple', TRUE);
    $config
      ->save();
    $coupons = $this->promotion
      ->getCoupons();
    $coupon = reset($coupons);
    $this
      ->drupalGet(Url::fromRoute('commerce_checkout.form', [
      'commerce_order' => $this->cart
        ->id(),
    ]));
    $this
      ->getSession()
      ->getPage()
      ->fillField('Coupon code', $coupon
      ->getCode());
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Apply coupon');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains($coupon
      ->getCode());
    $this
      ->assertSession()
      ->fieldExists('Coupon code');
    $this
      ->assertSession()
      ->pageTextContains('-$99.90');
    $this
      ->assertSession()
      ->pageTextContains('$899.10');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Remove coupon');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains('$999.00');
  }

  /**
   * Tests checkout with a redeemed coupon.
   */
  public function testCheckout() {
    $coupons = $this->promotion
      ->getCoupons();
    $coupon = reset($coupons);
    $this
      ->drupalGet(Url::fromRoute('commerce_checkout.form', [
      'commerce_order' => $this->cart
        ->id(),
    ]));
    $this
      ->getSession()
      ->getPage()
      ->fillField('Coupon code', $coupon
      ->getCode());
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Apply coupon');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains($coupon
      ->getCode());
    $this
      ->assertSession()
      ->pageTextContains('-$99.90');
    $this
      ->assertSession()
      ->pageTextContains('$899.10');

    // Ensure that the payment method ajax works with the coupon ajax.
    $radio_button = $this
      ->getSession()
      ->getPage()
      ->findField('Visa ending in 9999');
    $radio_button
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->submitForm([], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('Visa ending in 9999');
    $this
      ->assertSession()
      ->pageTextContains($coupon
      ->getCode());
    $this
      ->assertSession()
      ->pageTextContains('-$99.90');
    $this
      ->assertSession()
      ->pageTextContains('$899.10');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $this
      ->assertSession()
      ->pageTextContains('Your order number is 1. You can view your order on your account page when logged in.');
    $order_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('commerce_order');
    $order_storage
      ->resetCache([
      $this->cart
        ->id(),
    ]);
    $this->cart = $order_storage
      ->load($this->cart
      ->id());
    $this
      ->assertEquals(new Price('899.10', 'USD'), $this->cart
      ->getTotalPrice());
  }

  /**
   * Tests checkout using the main submit button instead of 'Apply coupon'.
   */
  public function testCheckoutWithMainSubmit() {
    $coupons = $this->promotion
      ->getCoupons();
    $coupon = reset($coupons);
    $this
      ->drupalGet(Url::fromRoute('commerce_checkout.form', [
      'commerce_order' => $this->cart
        ->id(),
    ]));
    $this
      ->getSession()
      ->getPage()
      ->fillField('Coupon code', $coupon
      ->getCode());
    $this
      ->submitForm([], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains('Visa ending in 9999');
    $this
      ->assertSession()
      ->pageTextContains($coupon
      ->getCode());
    $this
      ->assertSession()
      ->pageTextContains('-$99.90');
    $this
      ->assertSession()
      ->pageTextContains('$899.10');
    $this
      ->submitForm([], 'Pay and complete purchase');
    $this
      ->assertSession()
      ->pageTextContains('Your order number is 1. You can view your order on your account page when logged in.');
    $order_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('commerce_order');
    $order_storage
      ->resetCache([
      $this->cart
        ->id(),
    ]);
    $this->cart = $order_storage
      ->load($this->cart
      ->id());
    $this
      ->assertEquals(new Price('899.10', 'USD'), $this->cart
      ->getTotalPrice());
  }

  /**
   * Tests that adding/removing coupons does not submit other panes.
   */
  public function testCheckoutSubmit() {

    // Start checkout, and enter billing information.
    $this
      ->drupalGet(Url::fromRoute('commerce_checkout.form', [
      'commerce_order' => $this->cart
        ->id(),
    ]));
    $this
      ->getSession()
      ->getPage()
      ->findField('Example')
      ->click();
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->submitForm([
      'payment_information[billing_information][address][0][address][given_name]' => 'Johnny',
      'payment_information[billing_information][address][0][address][family_name]' => 'Appleseed',
      'payment_information[billing_information][address][0][address][address_line1]' => '123 New York Drive',
      'payment_information[billing_information][address][0][address][locality]' => 'New York City',
      'payment_information[billing_information][address][0][address][administrative_area]' => 'NY',
      'payment_information[billing_information][address][0][address][postal_code]' => '10001',
    ], 'Continue to review');

    // Go back and edit the billing information, but don't submit it.
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Go back');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('billing_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $address_prefix = 'payment_information[billing_information][address][0][address]';
    $this
      ->getSession()
      ->getPage()
      ->fillField($address_prefix . '[given_name]', 'John');
    $this
      ->getSession()
      ->getPage()
      ->fillField($address_prefix . '[family_name]', 'Smith');

    // Add a coupon.
    $coupons = $this->promotion
      ->getCoupons();
    $coupon = reset($coupons);
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->fillField('Coupon code', $coupon
      ->getCode());
    $page
      ->pressButton('Apply coupon');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains($coupon
      ->getCode());
    $this
      ->assertSession()
      ->fieldNotExists('Coupon code');
    $this
      ->assertSession()
      ->buttonNotExists('Apply coupon');

    // Refresh the page and ensure the billing information hasn't been modified.
    $this
      ->drupalGet(Url::fromRoute('commerce_checkout.form', [
      'commerce_order' => $this->cart
        ->id(),
      'step' => 'order_information',
    ]));
    $page = $this
      ->getSession()
      ->getPage();
    $this
      ->assertStringContainsString('Johnny Appleseed', $page
      ->find('css', 'p.address')
      ->getText());
  }

  /**
   * Tests that payment is not skipped if an order is no longer free.
   */
  public function testPaymentAfterCouponRemoval() {
    $offer = $this->promotion
      ->getOffer();
    $offer
      ->setConfiguration([
      'percentage' => '1',
    ]);
    $this->promotion
      ->setOffer($offer);
    $this->promotion
      ->save();
    $coupons = $this->promotion
      ->getCoupons();
    $coupon = reset($coupons);
    $this->cart
      ->get('coupons')
      ->appendItem($coupon
      ->id());
    $this->cart
      ->save();
    $this
      ->drupalGet(Url::fromRoute('commerce_checkout.form', [
      'commerce_order' => $this->cart
        ->id(),
    ]));
    $this
      ->submitForm([
      'payment_information[billing_information][address][0][address][given_name]' => 'Johnny',
      'payment_information[billing_information][address][0][address][family_name]' => 'Appleseed',
      'payment_information[billing_information][address][0][address][address_line1]' => '123 New York Drive',
      'payment_information[billing_information][address][0][address][locality]' => 'New York City',
      'payment_information[billing_information][address][0][address][administrative_area]' => 'NY',
      'payment_information[billing_information][address][0][address][postal_code]' => '10001',
    ], 'Continue to review');
    $this
      ->assertSession()
      ->pageTextContains($coupon
      ->getCode());
    $this
      ->assertSession()
      ->buttonExists('Complete checkout');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Remove coupon');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextNotContains($coupon
      ->getCode());

    // Now that the coupon is removed, the button label should change.
    $this
      ->submitForm([], 'Pay and complete purchase');

    // In theory, the customer should be redirected to the order information
    // step because the order is no longer free and the order doesn't reference
    // a payment gateway.
    $this
      ->assertSession()
      ->pageTextNotContains('Your order number is 1. You can view your order on your account page when logged in.');
    $this
      ->assertSession()
      ->pageTextContains('No payment gateway selected.');
    $this
      ->getSession()
      ->getPage()
      ->hasField('Example');
  }

}

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::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::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
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.
CommerceWebDriverTestBase::$adminUser protected property A test user with administrative privileges.
CommerceWebDriverTestBase::$countryList protected property The country list.
CommerceWebDriverTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme 3
CommerceWebDriverTestBase::$store protected property The store entity.
CommerceWebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE. Overrides WebDriverTestBase::assertJsCondition
CommerceWebDriverTestBase::assertRenderedAddress protected function Asserts that the given address is rendered on the page.
CommerceWebDriverTestBase::getAdministratorPermissions protected function Gets the permissions for the admin user. 10
CommerceWebDriverTestBase::setRawFieldValue protected function Sets an input field's raw value.
CommerceWebDriverTestBase::tearDown protected function Overrides WebDriverTestBase::tearDown
CommerceWebDriverTestBase::waitForAjaxToFinish Deprecated protected function Waits for jQuery to become active and animations to complete.
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
CouponRedemptionPaneTest::$cart protected property The cart order to test against.
CouponRedemptionPaneTest::$cartManager protected property The cart manager.
CouponRedemptionPaneTest::$modules public static property Modules to enable. Overrides CommerceWebDriverTestBase::$modules
CouponRedemptionPaneTest::$promotion protected property The promotion.
CouponRedemptionPaneTest::setUp protected function Overrides CommerceWebDriverTestBase::setUp
CouponRedemptionPaneTest::testCheckout public function Tests checkout with a redeemed coupon.
CouponRedemptionPaneTest::testCheckoutSubmit public function Tests that adding/removing coupons does not submit other panes.
CouponRedemptionPaneTest::testCheckoutWithMainSubmit public function Tests checkout using the main submit button instead of 'Apply coupon'.
CouponRedemptionPaneTest::testCouponRedemption public function Tests redeeming a coupon using the coupon redemption pane.
CouponRedemptionPaneTest::testMultipleCouponRedemption public function Tests redeeming coupon on the cart form, with multiple coupons allowed.
CouponRedemptionPaneTest::testPaymentAfterCouponRemoval public function Tests that payment is not skipped if an order is no longer free.
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::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
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::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::assertElementNotVisible Deprecated protected function Asserts that the element with the given CSS selector is not visible.
WebDriverTestBase::assertElementVisible Deprecated protected function Asserts that the element with the given CSS selector is visible.
WebDriverTestBase::assertSession public function Returns WebAssert object. Overrides UiHelperTrait::assertSession 1
WebDriverTestBase::createScreenshot protected function Creates a screenshot.
WebDriverTestBase::getDrupalSettings protected function Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders protected function Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. Overrides BrowserTestBase::getMinkDriverArgs
WebDriverTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink protected function Initializes Mink sessions. Overrides BrowserTestBase::initMink 1
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.