You are here

class RecurringOrderManagerTest in Commerce Recurring Framework 8

@coversDefaultClass \Drupal\commerce_recurring\RecurringOrderManager @group commerce_recurring

Hierarchy

Expanded class hierarchy of RecurringOrderManagerTest

File

tests/src/Kernel/RecurringOrderManagerTest.php, line 18

Namespace

Drupal\Tests\commerce_recurring\Kernel
View source
class RecurringOrderManagerTest extends RecurringKernelTestBase {

  /**
   * A trial subscription.
   *
   * @var \Drupal\commerce_recurring\Entity\SubscriptionInterface
   */
  protected $trialSubscription;

  /**
   * An active subscription.
   *
   * @var \Drupal\commerce_recurring\Entity\SubscriptionInterface
   */
  protected $activeSubscription;

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

  /**
   * {@inheritdoc}
   */
  public function setUp() : void {
    parent::setUp();
    $trial_subscription = Subscription::create([
      'type' => 'product_variation',
      'store_id' => $this->store
        ->id(),
      'billing_schedule' => $this->billingSchedule,
      'uid' => $this->user,
      'payment_method' => $this->paymentMethod,
      'purchased_entity' => $this->variation,
      'title' => $this->variation
        ->getOrderItemTitle(),
      'quantity' => '2',
      'unit_price' => new Price('20', 'USD'),
      'state' => 'trial',
      'trial_starts' => strtotime('2019-02-05 00:00'),
    ]);
    $trial_subscription
      ->save();
    $this->trialSubscription = $this
      ->reloadEntity($trial_subscription);
    $active_subscription = Subscription::create([
      'type' => 'product_variation',
      'store_id' => $this->store
        ->id(),
      'billing_schedule' => $this->billingSchedule,
      'uid' => $this->user,
      'payment_method' => $this->paymentMethod,
      'purchased_entity' => $this->variation,
      'title' => $this->variation
        ->getOrderItemTitle(),
      'quantity' => '2',
      'unit_price' => new Price('20', 'USD'),
      'state' => 'active',
      'starts' => strtotime('2019-02-15 00:00:00'),
    ]);
    $active_subscription
      ->save();
    $this->activeSubscription = $this
      ->reloadEntity($active_subscription);
    $this->recurringOrderManager = $this->container
      ->get('commerce_recurring.order_manager');
  }

  /**
   * @covers ::startTrial
   */
  public function testStartTrialWithInvalidState() {
    $this
      ->expectException(\InvalidArgumentException::class);
    $this
      ->expectExceptionMessage('Unexpected subscription state "active".');
    $order = $this->recurringOrderManager
      ->startTrial($this->activeSubscription);
  }

  /**
   * @covers ::startTrial
   */
  public function testStartTrialWithInvalidBillingSchedule() {
    $configuration = $this->billingSchedule
      ->getPluginConfiguration();
    unset($configuration['trial_interval']);
    $this->billingSchedule
      ->setPluginConfiguration($configuration);
    $this->billingSchedule
      ->save();
    $this
      ->expectException(\InvalidArgumentException::class);
    $this
      ->expectExceptionMessage('The billing schedule "test_id" does not allow trials.');
    $order = $this->recurringOrderManager
      ->startTrial($this->trialSubscription);
  }

  /**
   * @covers ::startTrial
   * @covers ::collectSubscriptions
   */
  public function testStartTrialPostpaid() {
    $order = $this->recurringOrderManager
      ->startTrial($this->trialSubscription);
    $expected_billing_period = new BillingPeriod(new DrupalDateTime('2019-02-05 00:00:00'), new DrupalDateTime('2019-02-15 00:00:00'));

    /** @var \Drupal\commerce_recurring\Plugin\Field\FieldType\BillingPeriodItem $billing_period_item */
    $billing_period_item = $order
      ->get('billing_period')
      ->first();
    $billing_period = $billing_period_item
      ->toBillingPeriod();
    $this
      ->assertEquals($expected_billing_period, $billing_period);
    $this
      ->assertTrue($this->trialSubscription
      ->hasOrder($order));
    $this
      ->assertEmpty($this->trialSubscription
      ->getRenewedTime());
    $this
      ->assertEmpty($this->trialSubscription
      ->getNextRenewalTime());
    $this
      ->assertOrder($order, $this->trialSubscription);
    $this
      ->assertTrue($order
      ->hasItems());
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);

    /** @var \Drupal\commerce_recurring\Plugin\Field\FieldType\BillingPeriodItem $order_item_billing_period_item */
    $order_item_billing_period_item = $order_item
      ->get('billing_period')
      ->first();
    $order_item_billing_period = $order_item_billing_period_item
      ->toBillingPeriod();
    $this
      ->assertEquals('recurring_product_variation', $order_item
      ->bundle());
    $this
      ->assertEquals($this->trialSubscription
      ->id(), $order_item
      ->get('subscription')->target_id);
    $this
      ->assertEquals($this->trialSubscription
      ->getTitle(), $order_item
      ->getTitle());
    $this
      ->assertEquals($this->trialSubscription
      ->getQuantity(), $order_item
      ->getQuantity());
    $this
      ->assertEquals($this->trialSubscription
      ->getPurchasedEntityId(), $order_item
      ->getPurchasedEntityId());
    $this
      ->assertEquals($billing_period, $order_item_billing_period);
    $this
      ->assertTrue($order_item
      ->getTotalPrice()
      ->isZero());
  }

  /**
   * @covers ::startTrial
   * @covers ::collectSubscriptions
   */
  public function testStartTrialPrepaid() {
    $this->billingSchedule
      ->setBillingType(BillingScheduleInterface::BILLING_TYPE_PREPAID);
    $this->billingSchedule
      ->save();
    $order = $this->recurringOrderManager
      ->startTrial($this->trialSubscription);
    $expected_billing_period = new BillingPeriod(new DrupalDateTime('2019-02-05 00:00:00'), new DrupalDateTime('2019-02-15 00:00:00'));

    /** @var \Drupal\commerce_recurring\Plugin\Field\FieldType\BillingPeriodItem $billing_period_item */
    $billing_period_item = $order
      ->get('billing_period')
      ->first();
    $billing_period = $billing_period_item
      ->toBillingPeriod();
    $this
      ->assertEquals($expected_billing_period, $billing_period);
    $this
      ->assertTrue($this->trialSubscription
      ->hasOrder($order));
    $this
      ->assertEmpty($this->trialSubscription
      ->getRenewedTime());
    $this
      ->assertEmpty($this->trialSubscription
      ->getNextRenewalTime());
    $this
      ->assertOrder($order, $this->trialSubscription);
    $this
      ->assertTrue($order
      ->hasItems());
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);

    /** @var \Drupal\commerce_recurring\Plugin\Field\FieldType\BillingPeriodItem $order_item_billing_period_item */
    $order_item_billing_period_item = $order_item
      ->get('billing_period')
      ->first();
    $order_item_billing_period = $order_item_billing_period_item
      ->toBillingPeriod();
    $expected_order_item_billing_period = new BillingPeriod(new DrupalDateTime('2019-02-15 00:00:00'), new DrupalDateTime('2019-03-01 00:00'));
    $this
      ->assertEquals('recurring_product_variation', $order_item
      ->bundle());
    $this
      ->assertEquals($this->trialSubscription
      ->id(), $order_item
      ->get('subscription')->target_id);
    $this
      ->assertEquals($this->trialSubscription
      ->getTitle(), $order_item
      ->getTitle());
    $this
      ->assertEquals($this->trialSubscription
      ->getQuantity(), $order_item
      ->getQuantity());
    $this
      ->assertEquals($this->trialSubscription
      ->getPurchasedEntityId(), $order_item
      ->getPurchasedEntityId());
    $this
      ->assertEquals($expected_order_item_billing_period, $order_item_billing_period);

    // The subscription started mid-cycle, the unit price should be
    // half the usual due to proration.
    $this
      ->assertEquals($this->trialSubscription
      ->getUnitPrice()
      ->divide('2'), $order_item
      ->getUnitPrice());
  }

  /**
   * @covers ::startRecurring
   */
  public function testStartRecurringWithInvalidState() {
    $this
      ->expectException(\InvalidArgumentException::class);
    $this
      ->expectExceptionMessage('Unexpected subscription state "trial".');
    $order = $this->recurringOrderManager
      ->startRecurring($this->trialSubscription);
  }

  /**
   * @covers ::startRecurring
   * @covers ::collectSubscriptions
   */
  public function testStartRecurringPostpaid() {
    $order = $this->recurringOrderManager
      ->startRecurring($this->activeSubscription);
    $expected_billing_period = new BillingPeriod(new DrupalDateTime('2019-02-01 00:00:00'), new DrupalDateTime('2019-03-01 00:00'));

    /** @var \Drupal\commerce_recurring\Plugin\Field\FieldType\BillingPeriodItem $billing_period_item */
    $billing_period_item = $order
      ->get('billing_period')
      ->first();
    $billing_period = $billing_period_item
      ->toBillingPeriod();
    $this
      ->assertEquals($expected_billing_period, $billing_period);
    $this
      ->assertEquals($billing_period
      ->getEndDate()
      ->getTimestamp(), $this->activeSubscription
      ->getNextRenewalTime());

    // Confirm that the current billing period is 28 days long.
    $this
      ->assertEquals(2419200, $billing_period
      ->getDuration());
    $this
      ->assertTrue($this->activeSubscription
      ->hasOrder($order));
    $this
      ->assertEmpty($this->activeSubscription
      ->getRenewedTime());
    $this
      ->assertOrder($order, $this->activeSubscription);
    $this
      ->assertTrue($order
      ->hasItems());
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);

    /** @var \Drupal\commerce_recurring\BillingPeriod $order_item_billing_period */

    /** @var \Drupal\commerce_recurring\Plugin\Field\FieldType\BillingPeriodItem $order_item_billing_period_item */
    $order_item_billing_period_item = $order_item
      ->get('billing_period')
      ->first();
    $order_item_billing_period = $order_item_billing_period_item
      ->toBillingPeriod();
    $expected_order_item_billing_period = new BillingPeriod(new DrupalDateTime('2019-02-15 00:00:00'), new DrupalDateTime('2019-03-01 00:00'));
    $this
      ->assertEquals('recurring_product_variation', $order_item
      ->bundle());
    $this
      ->assertEquals($this->activeSubscription
      ->id(), $order_item
      ->get('subscription')->target_id);
    $this
      ->assertEquals($this->activeSubscription
      ->getTitle(), $order_item
      ->getTitle());
    $this
      ->assertEquals($this->activeSubscription
      ->getQuantity(), $order_item
      ->getQuantity());
    $this
      ->assertEquals($this->activeSubscription
      ->getPurchasedEntityId(), $order_item
      ->getPurchasedEntityId());
    $this
      ->assertEquals($expected_order_item_billing_period, $order_item_billing_period);

    // The subscription was created mid-cycle, the unit price should be
    // half the usual due to proration.
    $this
      ->assertEquals($this->activeSubscription
      ->getUnitPrice()
      ->divide('2'), $order_item
      ->getUnitPrice());
    $this
      ->assertEquals($this->activeSubscription
      ->getStartDate(), $order_item_billing_period
      ->getStartDate());
    $this
      ->assertEquals($billing_period
      ->getEndDate(), $order_item_billing_period
      ->getEndDate());
  }

  /**
   * @covers ::startRecurring
   * @covers ::collectSubscriptions
   */
  public function testStartRecurringPrepaid() {
    $this->billingSchedule
      ->setBillingType(BillingScheduleInterface::BILLING_TYPE_PREPAID);
    $this->billingSchedule
      ->save();
    $order = $this->recurringOrderManager
      ->startRecurring($this->activeSubscription);
    $expected_billing_period = new BillingPeriod(new DrupalDateTime('2019-02-01 00:00:00'), new DrupalDateTime('2019-03-01 00:00'));

    /** @var \Drupal\commerce_recurring\Plugin\Field\FieldType\BillingPeriodItem $billing_period_item */
    $billing_period_item = $order
      ->get('billing_period')
      ->first();
    $billing_period = $billing_period_item
      ->toBillingPeriod();
    $this
      ->assertEquals($expected_billing_period, $billing_period);
    $this
      ->assertEquals($billing_period
      ->getEndDate()
      ->getTimestamp(), $this->activeSubscription
      ->getNextRenewalTime());

    // Confirm that the current billing period is 28 days long.
    $this
      ->assertEquals(2419200, $billing_period
      ->getDuration());
    $this
      ->assertTrue($this->activeSubscription
      ->hasOrder($order));
    $this
      ->assertEmpty($this->activeSubscription
      ->getRenewedTime());
    $this
      ->assertOrder($order, $this->activeSubscription);
    $this
      ->assertTrue($order
      ->hasItems());
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);

    /** @var \Drupal\commerce_recurring\Plugin\Field\FieldType\BillingPeriodItem $order_item_billing_period_item */
    $order_item_billing_period_item = $order_item
      ->get('billing_period')
      ->first();
    $order_item_billing_period = $order_item_billing_period_item
      ->toBillingPeriod();
    $expected_order_item_billing_period = new BillingPeriod(new DrupalDateTime('2019-03-01 00:00:00'), new DrupalDateTime('2019-04-01 00:00'));
    $this
      ->assertEquals('recurring_product_variation', $order_item
      ->bundle());
    $this
      ->assertEquals($this->activeSubscription
      ->id(), $order_item
      ->get('subscription')->target_id);
    $this
      ->assertEquals($this->activeSubscription
      ->getTitle(), $order_item
      ->getTitle());
    $this
      ->assertEquals($this->activeSubscription
      ->getQuantity(), $order_item
      ->getQuantity());
    $this
      ->assertEquals($this->activeSubscription
      ->getPurchasedEntityId(), $order_item
      ->getPurchasedEntityId());
    $this
      ->assertEquals($expected_order_item_billing_period, $order_item_billing_period);

    // The order item is charging for the next billing period, the unit price
    // should not be prorated.
    $this
      ->assertEquals($this->activeSubscription
      ->getUnitPrice(), $order_item
      ->getUnitPrice());
  }

  /**
   * @covers ::refreshOrder
   */
  public function testRefreshOrder() {
    $order = $this->recurringOrderManager
      ->startRecurring($this->activeSubscription);
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);
    $previous_order_item_id = $order_item
      ->id();
    $this->activeSubscription
      ->set('payment_method', NULL);
    $this->activeSubscription
      ->setUnitPrice(new Price('3', 'USD'));
    $this->activeSubscription
      ->save();
    $this->recurringOrderManager
      ->refreshOrder($order);
    $this
      ->assertEmpty($order
      ->get('billing_profile')->target_id);
    $this
      ->assertEmpty($order
      ->get('payment_method')->target_id);
    $this
      ->assertEmpty($order
      ->get('payment_gateway')->target_id);
    $order_items = $order
      ->getItems();
    $order_item = reset($order_items);
    $this
      ->assertEquals($previous_order_item_id, $order_item
      ->id());
    $this
      ->assertEquals($this->activeSubscription
      ->getUnitPrice()
      ->divide('2'), $order_item
      ->getUnitPrice());

    // Confirm that the order is canceled on refresh if no charges remain.
    $this->billingSchedule
      ->setBillingType(BillingScheduleInterface::BILLING_TYPE_PREPAID);
    $this->billingSchedule
      ->save();
    $this->activeSubscription = $this
      ->reloadEntity($this->activeSubscription);
    $this->activeSubscription
      ->cancel();
    $this->activeSubscription
      ->save();
    $this
      ->reloadEntity($order_item);
    $this->recurringOrderManager
      ->refreshOrder($order);
    $this
      ->assertEquals('canceled', $order
      ->getState()
      ->getId());
    $this
      ->assertEmpty($order
      ->getItems());
  }

  /**
   * @covers ::renewOrder
   */
  public function testCloseOrderWithoutPaymentMethod() {
    $this->activeSubscription
      ->set('payment_method', NULL);
    $this->activeSubscription
      ->save();
    $order = $this->recurringOrderManager
      ->startRecurring($this->activeSubscription);
    $this
      ->expectException(HardDeclineException::class);
    $this
      ->expectExceptionMessage('Payment method not found.');
    $this->recurringOrderManager
      ->closeOrder($order);
  }

  /**
   * @covers ::closeOrder
   */
  public function testCloseOrder() {
    $order = $this->recurringOrderManager
      ->startRecurring($this->activeSubscription);
    $this->recurringOrderManager
      ->closeOrder($order);
    $this
      ->assertEquals('completed', $order
      ->getState()
      ->getId());

    // Re-enable after #3011667 is fixed.
    // $this->assertTrue($order->isPaid());

    /** @var \Drupal\commerce_payment\PaymentStorageInterface $payment_storage */
    $payment_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('commerce_payment');
    $payments = $payment_storage
      ->loadMultipleByOrder($order);
    $this
      ->assertCount(1, $payments);

    /** @var \Drupal\commerce_payment\Entity\PaymentInterface $payment */
    $payment = reset($payments);
    $this
      ->assertEquals('completed', $payment
      ->getState()
      ->getId());
    $this
      ->assertEquals($this->paymentGateway
      ->id(), $payment
      ->getPaymentGatewayId());
    $this
      ->assertEquals($this->paymentMethod
      ->id(), $payment
      ->getPaymentMethodId());
    $this
      ->assertEquals($order
      ->id(), $payment
      ->getOrderId());
    $this
      ->assertEquals($order
      ->getTotalPrice(), $payment
      ->getAmount());
  }

  /**
   * @covers ::closeOrder
   */
  public function testCloseOrderAlreadyPaidMarksTheOrderAsCompleted() {
    $order = $this->recurringOrderManager
      ->startRecurring($this->activeSubscription);

    // We set the total paid to the amount of the order, but don't set the order
    // as complete.
    $order
      ->set('total_paid', $order
      ->getTotalPrice())
      ->set('state', 'needs_payment')
      ->save();
    $order = $this
      ->reloadEntity($order);
    $this
      ->assertEquals('needs_payment', $order
      ->getState()
      ->getId());
    $this
      ->assertTrue($order
      ->isPaid());

    // We close an order that was already completed.
    $this->recurringOrderManager
      ->closeOrder($order);
    $order = $this
      ->reloadEntity($order);
    $this
      ->assertTrue($order
      ->isPaid());
    $this
      ->assertEquals('completed', $order
      ->getState()
      ->getId());

    /** @var \Drupal\commerce_payment\PaymentStorageInterface $payment_storage */
    $payment_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('commerce_payment');

    // No extra payment has been added.
    $payments = $payment_storage
      ->loadMultipleByOrder($order);
    $this
      ->assertCount(0, $payments);
  }

  /**
   * @covers ::closeOrder
   */
  public function testCloseOrderAlreadyCanceledDoesntAddExtraPayment() {
    $order = $this->recurringOrderManager
      ->startRecurring($this->activeSubscription);

    // We set the order as canceled.
    $order
      ->set('state', 'canceled')
      ->save();
    $order = $this
      ->reloadEntity($order);
    $this
      ->assertEquals('canceled', $order
      ->getState()
      ->getId());

    // We close an order that was canceled.
    $this->recurringOrderManager
      ->closeOrder($order);
    $order = $this
      ->reloadEntity($order);
    $this
      ->assertFalse($order
      ->isPaid());
    $this
      ->assertEquals('canceled', $order
      ->getState()
      ->getId());

    /** @var \Drupal\commerce_payment\PaymentStorageInterface $payment_storage */
    $payment_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('commerce_payment');

    // No extra payment has been added.
    $payments = $payment_storage
      ->loadMultipleByOrder($order);
    $this
      ->assertCount(0, $payments);
  }

  /**
   * @covers ::renewOrder
   */
  public function testRenewOrder() {
    $order = $this->recurringOrderManager
      ->startRecurring($this->activeSubscription);
    $next_order = $this->recurringOrderManager
      ->renewOrder($order);

    /** @var \Drupal\commerce_recurring\Plugin\Field\FieldType\BillingPeriodItem $billing_period_item */
    $billing_period_item = $order
      ->get('billing_period')
      ->first();
    $billing_period = $billing_period_item
      ->toBillingPeriod();

    /** @var \Drupal\commerce_recurring\Plugin\Field\FieldType\BillingPeriodItem $next_billing_period_item */
    $next_billing_period_item = $next_order
      ->get('billing_period')
      ->first();
    $next_billing_period = $next_billing_period_item
      ->toBillingPeriod();
    $this->activeSubscription = $this
      ->reloadEntity($this->activeSubscription);
    $this
      ->assertTrue($this->activeSubscription
      ->hasOrder($order));
    $this
      ->assertTrue($this->activeSubscription
      ->hasOrder($next_order));
    $this
      ->assertNotEmpty($this->activeSubscription
      ->getRenewedTime());
    $this
      ->assertEquals($next_billing_period
      ->getEndDate()
      ->getTimestamp(), $this->activeSubscription
      ->getNextRenewalTime());
    $this
      ->assertEquals($billing_period
      ->getEndDate(), $next_billing_period
      ->getStartDate());
    $this
      ->assertOrder($next_order, $this->activeSubscription);
    $this
      ->assertTrue($next_order
      ->hasItems());
    $order_items = $next_order
      ->getItems();
    $order_item = reset($order_items);
    $this
      ->assertEquals('recurring_product_variation', $order_item
      ->bundle());
    $this
      ->assertEquals($this->activeSubscription
      ->getTitle(), $order_item
      ->getTitle());
    $this
      ->assertEquals($this->activeSubscription
      ->getQuantity(), $order_item
      ->getQuantity());
    $this
      ->assertEquals($this->activeSubscription
      ->getUnitPrice(), $order_item
      ->getUnitPrice());
    $this
      ->assertEquals($this->variation, $order_item
      ->getPurchasedEntity());
    $this
      ->assertEquals($next_billing_period, $order_item
      ->get('billing_period')
      ->first()
      ->toBillingPeriod());

    // Confirm that the next billing period (March) is 31 days long.
    $this
      ->assertEquals(2678400, $next_billing_period
      ->getDuration());
    $this
      ->assertEquals($this->activeSubscription
      ->id(), $order_item
      ->get('subscription')->target_id);

    // Confirm that no renewal occurs for canceled subscriptions.
    $this->activeSubscription
      ->cancel(FALSE)
      ->save();
    $result = $this->recurringOrderManager
      ->renewOrder($next_order);
    $this
      ->assertNull($result);
  }

  /**
   * Asserts that the recurring order fields have the expected values.
   *
   * @param \Drupal\commerce_order\Entity\OrderInterface $order
   *   The recurring order.
   * @param \Drupal\commerce_recurring\Entity\SubscriptionInterface $subscription
   *   The subscription.
   */
  protected function assertOrder(OrderInterface $order, SubscriptionInterface $subscription) {
    $this
      ->assertEquals('recurring', $order
      ->bundle());
    $this
      ->assertEquals('draft', $order
      ->getState()
      ->getId());
    $this
      ->assertEquals($subscription
      ->getStoreId(), $order
      ->getStoreId());
    $this
      ->assertEquals($subscription
      ->getCustomerId(), $order
      ->getCustomerId());
    $this
      ->assertEquals($subscription
      ->getBillingSchedule()
      ->id(), $order
      ->get('billing_schedule')->target_id);
    $payment_method = $subscription
      ->getPaymentMethod();
    $this
      ->assertEquals($payment_method
      ->id(), $order
      ->get('payment_method')->target_id);
    $this
      ->assertEquals($payment_method
      ->getPaymentGatewayId(), $order
      ->get('payment_gateway')->target_id);
    $this
      ->assertEquals($payment_method
      ->getBillingProfile(), $order
      ->getBillingProfile());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
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::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
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::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
CommerceKernelTestBase::$store protected property The default store. 1
CommerceKernelTestBase::tearDown protected function Overrides KernelTestBase::tearDown
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.
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
DeprecationSuppressionTrait::restoreErrorHandler protected function Restores the original error handler.
DeprecationSuppressionTrait::setErrorHandler protected function Sets an error handler to suppress specified deprecation messages.
EntityKernelTestBase::$deprecatedProperties protected property The list of deprecated services.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
RecurringKernelTestBase::$billingSchedule protected property The test billing schedule.
RecurringKernelTestBase::$modules public static property Modules to enable. Overrides OrderKernelTestBase::$modules 4
RecurringKernelTestBase::$paymentGateway protected property The test payment gateway.
RecurringKernelTestBase::$paymentMethod protected property The test payment method.
RecurringKernelTestBase::$user protected property The test user.
RecurringKernelTestBase::$variation protected property The test variation.
RecurringKernelTestBase::createInitialOrder protected function Creates an order with an order item that will start a subscription.
RecurringKernelTestBase::rewindTime protected function Changes the current time. 2
RecurringOrderManagerTest::$activeSubscription protected property An active subscription.
RecurringOrderManagerTest::$recurringOrderManager protected property The recurring order manager.
RecurringOrderManagerTest::$trialSubscription protected property A trial subscription.
RecurringOrderManagerTest::assertOrder protected function Asserts that the recurring order fields have the expected values.
RecurringOrderManagerTest::setUp public function Overrides RecurringKernelTestBase::setUp
RecurringOrderManagerTest::testCloseOrder public function @covers ::closeOrder
RecurringOrderManagerTest::testCloseOrderAlreadyCanceledDoesntAddExtraPayment public function @covers ::closeOrder
RecurringOrderManagerTest::testCloseOrderAlreadyPaidMarksTheOrderAsCompleted public function @covers ::closeOrder
RecurringOrderManagerTest::testCloseOrderWithoutPaymentMethod public function @covers ::renewOrder
RecurringOrderManagerTest::testRefreshOrder public function @covers ::refreshOrder
RecurringOrderManagerTest::testRenewOrder public function @covers ::renewOrder
RecurringOrderManagerTest::testStartRecurringPostpaid public function @covers ::startRecurring @covers ::collectSubscriptions
RecurringOrderManagerTest::testStartRecurringPrepaid public function @covers ::startRecurring @covers ::collectSubscriptions
RecurringOrderManagerTest::testStartRecurringWithInvalidState public function @covers ::startRecurring
RecurringOrderManagerTest::testStartTrialPostpaid public function @covers ::startTrial @covers ::collectSubscriptions
RecurringOrderManagerTest::testStartTrialPrepaid public function @covers ::startTrial @covers ::collectSubscriptions
RecurringOrderManagerTest::testStartTrialWithInvalidBillingSchedule public function @covers ::startTrial
RecurringOrderManagerTest::testStartTrialWithInvalidState public function @covers ::startTrial
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
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. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser