You are here

Home » API reference » Commerce Recurring Framework 8 » SubscriptionTest.php

class SubscriptionTest in Commerce Recurring Framework 8

Same name in this branch
  1. 8 tests/src/Functional/SubscriptionTest.php \Drupal\Tests\commerce_recurring\Functional\SubscriptionTest
  2. 8 tests/src/Kernel/Entity/SubscriptionTest.php \Drupal\Tests\commerce_recurring\Kernel\Entity\SubscriptionTest

Tests the subscription UI.

@group commerce_recurring

Hierarchy

Expanded class hierarchy of SubscriptionTest

File

tests/src/Functional/SubscriptionTest.php, line 19

Namespace

Drupal\Tests\commerce_recurring\Functional
View source 
class SubscriptionTest extends CommerceBrowserTestBase {

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

  /**
   * The test billing schedule.
   *
   * @var \Drupal\commerce_recurring\Entity\BillingScheduleInterface
   */
  protected $billingSchedule;

  /**
   * The test billing profile.
   *
   * @var \Drupal\profile\Entity\ProfileInterface
   */
  protected $billingProfile;

  /**
   * The test payment gateway.
   *
   * @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface
   */
  protected $paymentGateway;

  /**
   * The test payment method.
   *
   * @var \Drupal\commerce_payment\Entity\PaymentMethodInterface
   */
  protected $paymentMethod;

  /**
   * Holds the date pattern string for the "html_date" format.
   *
   * @var string
   */
  protected $dateFormat;

  /**
   * Holds the date pattern string for the "html_time" format.
   *
   * @var string
   */
  protected $timeFormat;

  /**
   * The test variation.
   *
   * @var \Drupal\commerce_product\Entity\ProductVariationInterface
   */
  protected $variation;

  /**
   * The recurring order manager.
   *
   * @var \Drupal\commerce_recurring\RecurringOrderManagerInterface
   */
  protected $recurringOrderManager;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->variation = $this
      ->createEntity('commerce_product_variation', [
      'type' => 'default',
      'sku' => strtolower($this
        ->randomMachineName()),
      'price' => [
        'number' => '39.99',
        'currency_code' => 'USD',
      ],
    ]);
    $this
      ->createEntity('commerce_product', [
      'type' => 'default',
      'title' => 'My product',
      'variations' => [
        $this->variation,
      ],
      'stores' => [
        $this->store,
      ],
    ]);

    /** @var \Drupal\commerce_recurring\Entity\BillingScheduleInterface $billing_schedule */
    $this->billingSchedule = $this
      ->createEntity('commerce_billing_schedule', [
      'id' => 'test_id',
      'label' => 'Hourly schedule',
      'displayLabel' => 'Hourly schedule',
      'billingType' => BillingSchedule::BILLING_TYPE_POSTPAID,
      'plugin' => 'fixed',
      'configuration' => [
        'interval' => [
          'number' => '1',
          'unit' => 'hour',
        ],
      ],
    ]);
    $profile = Profile::create([
      'type' => 'customer',
      'address' => [
        'country_code' => 'US',
      ],
    ]);
    $profile
      ->save();
    $this->billingProfile = $this
      ->reloadEntity($profile);

    /** @var \Drupal\commerce_payment\Entity\PaymentGatewayInterface $payment_gateway */
    $payment_gateway = PaymentGateway::create([
      'id' => 'example',
      'label' => 'Example',
      'plugin' => 'example_onsite',
    ]);
    $payment_gateway
      ->save();
    $this->paymentGateway = $this
      ->reloadEntity($payment_gateway);

    /** @var \Drupal\commerce_payment\Entity\PaymentMethodInterface $payment_method */
    $payment_method = PaymentMethod::create([
      'type' => 'credit_card',
      'payment_gateway' => $this->paymentGateway,
      'card_type' => 'visa',
      'card_number' => 1,
      'uid' => $this->adminUser
        ->id(),
      'billing_profile' => $this->billingProfile,
    ]);
    $payment_method
      ->save();
    $this->paymentMethod = $this
      ->reloadEntity($payment_method);
    $this->dateFormat = DateFormat::load('html_date')
      ->getPattern();
    $this->timeFormat = DateFormat::load('html_time')
      ->getPattern();
    $this->recurringOrderManager = $this->container
      ->get('commerce_recurring.order_manager');
  }

  /**
   * {@inheritdoc}
   */
  protected function getAdministratorPermissions() {
    return [
      'administer commerce_subscription',
    ] + parent::getAdministratorPermissions();
  }

  /**
   * Tests creating a subscription.
   */
  public function testSubscriptionCreation() {
    $this
      ->drupalGet('admin/commerce/subscriptions/add');
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->clickLink('Product variation');
    $this
      ->assertSession()
      ->addressEquals('admin/commerce/subscriptions/product_variation/add');
    $start_date = DrupalDateTime::createFromTimestamp(time() + 3600);
    $values = [
      'title[0][value]' => 'Test subscription',
      'billing_schedule' => $this->billingSchedule
        ->id(),
      'payment_method[target_id]' => $this->paymentMethod
        ->label() . ' (' . $this->paymentMethod
        ->id() . ')',
      'purchased_entity[0][target_id]' => $this->variation
        ->getTitle() . ' (' . $this->variation
        ->id() . ')',
      'uid[0][target_id]' => $this->adminUser
        ->label() . ' (' . $this->adminUser
        ->id() . ')',
      'unit_price[0][number]' => '9.99',
      'starts[0][value][date]' => $start_date
        ->format($this->dateFormat),
      'starts[0][value][time]' => $start_date
        ->format($this->timeFormat),
    ];
    $this
      ->submitForm($values, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('A subscription been successfully saved.');

    /** @var \Drupal\commerce_recurring\Entity\SubscriptionInterface $subscription */
    $subscription = Subscription::load(1);
    $this
      ->assertSession()
      ->pageTextContains($subscription
      ->getTitle());
    $this
      ->assertSession()
      ->pageTextContains($subscription
      ->getState()
      ->getId());
    $this
      ->assertSession()
      ->pageTextContains($subscription
      ->getBillingSchedule()
      ->label());
    $this
      ->assertEquals($values['title[0][value]'], $subscription
      ->getTitle());
    $this
      ->assertEquals($this->billingSchedule
      ->id(), $subscription
      ->getBillingSchedule()
      ->id());
    $this
      ->assertEquals($this->paymentMethod
      ->id(), $subscription
      ->getPaymentMethodId());
    $this
      ->assertNull($subscription
      ->getTrialStartTime());
    $this
      ->assertNull($subscription
      ->getTrialEndTime());
    $this
      ->assertNull($subscription
      ->getEndTime());
    $this
      ->assertEquals($start_date
      ->getTimestamp(), $subscription
      ->getStartTime());
    $this
      ->assertEquals($subscription
      ->getCustomerId(), $this->adminUser
      ->id());
    $this
      ->assertEquals('pending', $subscription
      ->getState()
      ->getId());
  }

  /**
   * Tests editing a subscription.
   */
  public function testSubscriptionEditing() {

    /** @var \Drupal\commerce_recurring\Entity\SubscriptionInterface $subscription */
    $subscription = $this
      ->createEntity('commerce_subscription', [
      'title' => $this
        ->randomString(),
      'uid' => $this->adminUser
        ->id(),
      'billing_schedule' => $this->billingSchedule,
      'type' => 'product_variation',
      'purchased_entity' => $this->variation,
      'store_id' => $this->store
        ->id(),
      'unit_price' => $this->variation
        ->getPrice(),
      'starts' => time() + 3600,
      'trial_starts' => time(),
      'state' => 'trial',
    ]);
    $trial_end = DrupalDateTime::createFromTimestamp($subscription
      ->getStartTime());
    $end = DrupalDateTime::createFromTimestamp($subscription
      ->getStartTime() + 7200);
    $this
      ->drupalGet('admin/commerce/subscriptions/' . $subscription
      ->id() . '/edit');
    $this
      ->assertSession()
      ->pageTextContains('Trial');
    $this
      ->assertSession()
      ->buttonExists('Cancel subscription');
    $values = [
      'title[0][value]' => 'Test (Modified)',
      'trial_ends[0][has_value]' => 1,
      'trial_ends[0][container][value][date]' => $trial_end
        ->format($this->dateFormat),
      'trial_ends[0][container][value][time]' => $trial_end
        ->format($this->timeFormat),
      'ends[0][has_value]' => 1,
      'ends[0][container][value][date]' => $end
        ->format($this->dateFormat),
      'ends[0][container][value][time]' => $end
        ->format($this->timeFormat),
    ];
    $this
      ->submitForm($values, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('A subscription been successfully saved.');
    $subscription = $this
      ->reloadEntity($subscription);
    $this
      ->assertEquals($values['title[0][value]'], $subscription
      ->getTitle());
    $this
      ->assertSession()
      ->pageTextContains($subscription
      ->getTitle());
    $this
      ->assertNotEmpty($subscription
      ->getTrialStartTime());
    $this
      ->assertEquals($subscription
      ->getStartTime(), $subscription
      ->getTrialEndTime());
  }

  /**
   * Tests editing the payment method of a subscription.
   */
  public function testSubscriptionPaymentMethodEditing() {

    /** @var \Drupal\commerce_recurring\Entity\SubscriptionInterface $subscription */
    $subscription = $this
      ->createEntity('commerce_subscription', [
      'title' => $this
        ->randomString(),
      'uid' => $this->adminUser
        ->id(),
      'billing_schedule' => $this->billingSchedule,
      'payment_method' => $this->paymentMethod,
      'type' => 'product_variation',
      'purchased_entity' => $this->variation,
      'store_id' => $this->store
        ->id(),
      'unit_price' => $this->variation
        ->getPrice(),
      'starts' => time() + 3600,
      'state' => 'active',
    ]);

    // Create an additional payment method for the subscription owner, as well
    // as another one for a different user.
    $payment_method_2 = PaymentMethod::create([
      'type' => 'credit_card',
      'payment_gateway' => $this->paymentGateway,
      'card_type' => 'visa',
      'card_number' => 2,
      'uid' => $this->adminUser
        ->id(),
      'billing_profile' => $this->billingProfile,
    ]);
    $payment_method_2
      ->save();
    $another_user = $this
      ->drupalCreateUser();
    $payment_method_3 = PaymentMethod::create([
      'type' => 'credit_card',
      'payment_gateway' => $this->paymentGateway,
      'card_type' => 'visa',
      'card_number' => 3,
      'uid' => $another_user
        ->id(),
      'billing_profile' => $this->billingProfile,
    ]);
    $payment_method_3
      ->save();
    $this->container
      ->get('entity_type.manager')
      ->getStorage('commerce_payment_method')
      ->resetCache();
    $this
      ->drupalGet('admin/commerce/subscriptions/' . $subscription
      ->id() . '/edit');
    $this
      ->assertSession()
      ->pageTextContains('Visa ending in 1');
    $this
      ->assertSession()
      ->pageTextContains('Visa ending in 2');
    $this
      ->assertSession()
      ->pageTextNotContains('Visa ending in 3');
    $values = [
      'payment_method[target_id]' => 2,
    ];
    $this
      ->submitForm($values, 'Save');
    $subscription = $this
      ->reloadEntity($subscription);
    $this
      ->assertEquals($payment_method_2
      ->id(), $subscription
      ->getPaymentMethodId());
  }

  /**
   * Tests cancelling a subscription immediately.
   */
  public function testSubscriptionImmediateCancelling() {
    $this
      ->drupalGet('admin/commerce/subscriptions/add');
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->clickLink('Product variation');
    $start_date = DrupalDateTime::createFromTimestamp(time() + 3600);
    $values = [
      'title[0][value]' => 'Test subscription',
      'billing_schedule' => $this->billingSchedule
        ->id(),
      'purchased_entity[0][target_id]' => $this->variation
        ->getTitle() . ' (' . $this->variation
        ->id() . ')',
      'uid[0][target_id]' => $this->adminUser
        ->label() . ' (' . $this->adminUser
        ->id() . ')',
      'unit_price[0][number]' => '9.99',
      'starts[0][value][date]' => $start_date
        ->format($this->dateFormat),
      'starts[0][value][time]' => $start_date
        ->format($this->timeFormat),
    ];
    $this
      ->submitForm($values, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('A subscription been successfully saved.');

    /** @var \Drupal\commerce_recurring\Entity\SubscriptionInterface $subscription */
    $subscription = Subscription::load(1);

    // Since we use no payment provider in this test, the subscription gets the
    // state Pending instead of Active. We nudge it to Active to get things
    // going again.
    $subscription
      ->getState()
      ->applyTransitionById('activate');
    $subscription
      ->save();
    $this->recurringOrderManager
      ->startRecurring($subscription);
    $this
      ->drupalGet('admin/commerce/subscriptions/' . $subscription
      ->id() . '/cancel');
    $radio = $this
      ->getSession()
      ->getPage()
      ->findField('edit-cancel-option-now');
    $name = $radio
      ->getAttribute('name');
    $this
      ->assertEqual($name, 'cancel_option');
    $option = $radio
      ->getAttribute('value');
    $this
      ->assertEqual($option, 'now');
    $this
      ->getSession()
      ->getPage()
      ->selectFieldOption($name, $option);
    $this
      ->getSession()
      ->getPage()
      ->findButton('Confirm')
      ->click();
    $this
      ->assertSession()
      ->pageTextContains('The subscription has been canceled.');

    // Check that already cancelled subscriptions aren't cancelable anymore.
    $this
      ->drupalGet('admin/commerce/subscriptions/' . $subscription
      ->id() . '/cancel');
    $this
      ->assertSession()
      ->pageTextContains('The subscription has already been canceled.');
  }

  /**
   * Tests scheduled subscription cancellation.
   */
  public function testSubscriptionScheduledCancelling() {
    $this
      ->drupalGet('admin/commerce/subscriptions/add');
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->clickLink('Product variation');
    $start_date = DrupalDateTime::createFromTimestamp(time() + 3600);
    $values = [
      'title[0][value]' => 'Test subscription',
      'billing_schedule' => $this->billingSchedule
        ->id(),
      'purchased_entity[0][target_id]' => $this->variation
        ->getTitle() . ' (' . $this->variation
        ->id() . ')',
      'uid[0][target_id]' => $this->adminUser
        ->label() . ' (' . $this->adminUser
        ->id() . ')',
      'unit_price[0][number]' => '9.99',
      'starts[0][value][date]' => $start_date
        ->format($this->dateFormat),
      'starts[0][value][time]' => $start_date
        ->format($this->timeFormat),
    ];
    $this
      ->submitForm($values, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('A subscription been successfully saved.');

    /** @var \Drupal\commerce_recurring\Entity\SubscriptionInterface $subscription */
    $subscription = Subscription::load(1);

    // Since we use no payment provider in this test, the subscription gets the
    // state Pending instead of Active. We nudge it to Active to get things
    // going again.
    $subscription
      ->getState()
      ->applyTransitionById('activate');
    $subscription
      ->save();
    $this->recurringOrderManager
      ->startRecurring($subscription);
    $this
      ->drupalGet('admin/commerce/subscriptions/' . $subscription
      ->id() . '/cancel');
    $radio = $this
      ->getSession()
      ->getPage()
      ->findField('edit-cancel-option-scheduled');
    $name = $radio
      ->getAttribute('name');
    $this
      ->assertEqual($name, 'cancel_option');
    $option = $radio
      ->getAttribute('value');
    $this
      ->assertEqual($option, 'scheduled');
    $this
      ->getSession()
      ->getPage()
      ->selectFieldOption($name, $option);
    $this
      ->getSession()
      ->getPage()
      ->findButton('Confirm')
      ->click();
    $this
      ->assertSession()
      ->pageTextContains('The subscription has been scheduled for cancellation.');
    $this
      ->drupalGet('admin/commerce/subscriptions/' . $subscription
      ->id() . '/cancel');
    $this
      ->assertSession()
      ->pageTextContains('A cancellation has already been scheduled for ');
  }

}

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::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
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.
SubscriptionTest::$billingProfile protected property The test billing profile.
SubscriptionTest::$billingSchedule protected property The test billing schedule.
SubscriptionTest::$dateFormat protected property Holds the date pattern string for the "html_date" format.
SubscriptionTest::$modules public static property Modules to enable. Overrides CommerceBrowserTestBase::$modules
SubscriptionTest::$paymentGateway protected property The test payment gateway.
SubscriptionTest::$paymentMethod protected property The test payment method.
SubscriptionTest::$recurringOrderManager protected property The recurring order manager.
SubscriptionTest::$timeFormat protected property Holds the date pattern string for the "html_time" format.
SubscriptionTest::$variation protected property The test variation.
SubscriptionTest::getAdministratorPermissions protected function Gets the permissions for the admin user. Overrides CommerceBrowserTestBase::getAdministratorPermissions
SubscriptionTest::setUp protected function Overrides CommerceBrowserTestBase::setUp
SubscriptionTest::testSubscriptionCreation public function Tests creating a subscription.
SubscriptionTest::testSubscriptionEditing public function Tests editing a subscription.
SubscriptionTest::testSubscriptionImmediateCancelling public function Tests cancelling a subscription immediately.
SubscriptionTest::testSubscriptionPaymentMethodEditing public function Tests editing the payment method of a subscription.
SubscriptionTest::testSubscriptionScheduledCancelling public function Tests scheduled subscription cancellation.
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.