You are here

class StockLevelWidgetsTest in Commerce Stock 8

Same name in this branch
  1. 8 modules/ui/tests/Functional/StockLevelWidgetsTest.php \Drupal\Tests\commerce_stock_ui\Functional\StockLevelWidgetsTest
  2. 8 modules/field/tests/src/Functional/StockLevelWidgetsTest.php \Drupal\Tests\commerce_stock_field\Functional\StockLevelWidgetsTest

Provides tests for the stock level widget.

@group commerce_stock

Hierarchy

Expanded class hierarchy of StockLevelWidgetsTest

File

modules/field/tests/src/Functional/StockLevelWidgetsTest.php, line 16

Namespace

Drupal\Tests\commerce_stock_field\Functional
View source
class StockLevelWidgetsTest extends StockLevelFieldTestBase {
  use StockTransactionQueryTrait;
  use StockLevelFieldCreationTrait;

  /**
   * Tests the default simple transaction widget.
   */
  public function testSimpleTransactionStockLevelWidget() {
    $entity_type = "commerce_product_variation";
    $bundle = 'default';
    $widget_id = "commerce_stock_level_simple_transaction";
    $default_note = $this
      ->randomString(200);
    $widget_settings = [
      'custom_transaction_note' => FALSE,
      'default_transaction_note' => $default_note,
      'step' => '1',
    ];
    $this
      ->configureFormDisplay($widget_id, $widget_settings, $entity_type, $bundle);

    // Test adding a new variation on the variations tab.
    $this
      ->drupalGet('admin/commerce/products');
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Add product');

    // Create a product.
    $store_ids = EntityHelper::extractIds($this->stores);
    $title = $this
      ->randomMachineName();
    $edit = [
      'title[0][value]' => $title,
    ];
    foreach ($store_ids as $store_id) {
      $edit['stores[target_id][value][' . $store_id . ']'] = $store_id;
    }
    $this
      ->submitForm($edit, 'Save and add variations');
    $this
      ->assertNotEmpty($this
      ->getSession()
      ->getPage()
      ->hasLink('Add variation'));
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Add variation');
    $this
      ->assertSession()
      ->pageTextContains(t('Add variation'));

    // Ensure the stock part of the form is healty.
    $this
      ->assertSession()
      ->fieldExists('commerce_stock_always_in_stock[value]');
    $this
      ->assertSession()
      ->checkboxNotChecked('commerce_stock_always_in_stock[value]');
    $this
      ->assertSession()
      ->fieldExists($this->fieldName . '[0][adjustment]');
    $this
      ->assertSession()
      ->fieldExists($this->fieldName . '[0][stock_transaction_note]');
    $this
      ->assertSession()
      ->fieldDisabled($this->fieldName . '[0][stock_transaction_note]');
    $this
      ->assertSession()
      ->fieldValueEquals($this->fieldName . '[0][stock_transaction_note]', $default_note);
    $this
      ->assertSession()
      ->buttonExists('Save');
    $variation_sku = $this
      ->randomMachineName();
    $title = $this
      ->randomString();
    $this
      ->getSession()
      ->getPage()
      ->fillField('sku[0][value]', $variation_sku);
    $this
      ->getSession()
      ->getPage()
      ->fillField('price[0][number]', '9.99');
    $this
      ->getSession()
      ->getPage()
      ->fillField('title[0][value]', $title);
    $adjustment = 2;
    $this
      ->getSession()
      ->getPage()
      ->fillField($this->fieldName . '[0][adjustment]', $adjustment);
    $this
      ->submitForm([], t('Save'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $variation_in_table = $this
      ->getSession()
      ->getPage()
      ->find('xpath', '//table/tbody/tr/td[text()="' . $variation_sku . '"]');
    $this
      ->assertNotEmpty($variation_in_table);

    /** @var \Drupal\Core\Entity\EntityStorageInterface $storage */
    $storage = \Drupal::entityTypeManager()
      ->getStorage('commerce_product_variation');
    $result = $storage
      ->loadByProperties([
      'sku' => $variation_sku,
    ]);
    $variation = array_shift($result);
    $transaction = $this
      ->getLastEntityTransaction($variation
      ->id());
    $this
      ->assertEquals($adjustment, $transaction->qty);
    $this
      ->assertEquals($this->adminUser
      ->id(), $transaction->related_uid);

    // Test the widget on variation edit form.
    $this
      ->drupalGet($this->variation
      ->toUrl('edit-form'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->fieldExists('commerce_stock_always_in_stock[value]');
    $this
      ->assertSession()
      ->checkboxNotChecked('commerce_stock_always_in_stock[value]');

    // Check the defaults.
    $this
      ->assertSession()
      ->fieldExists($this->fieldName . '[0][adjustment]');
    $this
      ->assertSession()
      ->fieldExists($this->fieldName . '[0][stock_transaction_note]');
    $this
      ->assertSession()
      ->fieldValueEquals($this->fieldName . '[0][stock_transaction_note]', $default_note);
    $adjustment = 6;
    $new_price_amount = '1.11';
    $variations_edit = [
      'price[0][number]' => $new_price_amount,
      $this->fieldName . '[0][adjustment]' => $adjustment,
    ];
    $this
      ->submitForm($variations_edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $transaction = $this
      ->getLastEntityTransaction($this->variation
      ->id());
    $data = unserialize($transaction->data);
    $this
      ->assertEquals($adjustment, $transaction->qty);
    $this
      ->assertEquals($this->adminUser
      ->id(), $transaction->related_uid);
    $this
      ->assertEquals($default_note, $data['message']);
    $widget_settings = [
      'custom_transaction_note' => TRUE,
      'default_transaction_note' => $default_note,
      'step' => '1',
    ];
    $this
      ->configureFormDisplay($widget_id, $widget_settings, $entity_type, $bundle);
    $this
      ->drupalGet($this->variation
      ->toUrl('edit-form'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->fieldExists($this->fieldName . '[0][adjustment]');
    $this
      ->assertSession()
      ->fieldExists($this->fieldName . '[0][stock_transaction_note]');
    self::expectException(ExpectationException::class);
    $this
      ->assertSession()
      ->fieldDisabled($this->fieldName . '[0][stock_transaction_note]');
    $this
      ->assertSession()
      ->fieldValueEquals($this->fieldName . '[0][stock_transaction_note]', $default_note);
    $adjustment = -3;
    $edit = [
      $this->fieldName . '[0][adjustment]' => $adjustment,
      $this->fieldName . '[0][stock_transaction_note]' => 'CustomNote',
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $transaction = $this
      ->getLastEntityTransaction($this->variation
      ->id());
    $data = unserialize($transaction->data);
    $this
      ->assertEquals($adjustment, $transaction->qty);
    $this
      ->assertEquals($this->adminUser
      ->id(), $transaction->related_uid);
    $this
      ->assertEquals('CustomNote', $data['message']);
  }

  /**
   * Tests the default simple transaction widget in single variation mode.
   */
  public function testSimpleTransactionStockLevelWidgetSingleVariationMode() {
    $entity_type = "commerce_product_variation";
    $bundle = 'default';
    $widget_id = "commerce_stock_level_simple_transaction";
    $default_note = $this
      ->randomString(200);
    $widget_settings = [
      'custom_transaction_note' => FALSE,
      'default_transaction_note' => $default_note,
      'step' => '1',
    ];
    $this
      ->configureFormDisplay($widget_id, $widget_settings, $entity_type, $bundle);
    $this
      ->drupalGet('admin/commerce/config/product-types/default/edit');
    $edit = [
      'multipleVariations' => FALSE,
    ];
    $this
      ->submitForm($edit, t('Save'));
    $this
      ->drupalGet('admin/commerce/products');
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Add product');
    $this
      ->assertSession()
      ->buttonNotExists('Save and add variations');
    $this
      ->assertSession()
      ->fieldExists('variations[entity][sku][0][value]');

    // On product add form, there should be no stock level input field.
    $this
      ->assertSession()
      ->fieldNotExists('variations[entity][' . $this->fieldName . '][0][adjustment]');
    $this
      ->assertSession()
      ->fieldNotExists('variations[entity][' . $this->fieldName . '][0][stock_transaction_note]');
    $store_id = $this->stores[0]
      ->id();
    $title = $this
      ->randomMachineName();
    $sku = strtolower($this
      ->randomMachineName());
    $edit = [
      'title[0][value]' => $title,
      'stores[target_id][value][' . $store_id . ']' => $store_id,
      'variations[entity][sku][0][value]' => $sku,
      'variations[entity][price][0][number]' => '99.99',
      'variations[entity][title][0][value]' => $title . '_testvariation',
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->saveHtmlOutput();

    // Check if product was created. Remember we created
    // product 1 in test setup.
    $product = Product::load(2);
    $this
      ->assertNotEmpty($product);
    $this
      ->assertEquals($title, $product
      ->getTitle());

    // On product edit form, we should have a stock widget.
    $this
      ->drupalGet($product
      ->toUrl('edit-form'));
    $this
      ->assertSession()
      ->fieldExists('variations[entity][commerce_stock_always_in_stock][value]');
    $this
      ->assertSession()
      ->checkboxNotChecked('variations[entity][commerce_stock_always_in_stock][value]');
    $this
      ->assertSession()
      ->fieldExists('variations[entity][' . $this->fieldName . '][0][adjustment]');
    $this
      ->assertSession()
      ->fieldExists('variations[entity][' . $this->fieldName . '][0][stock_transaction_note]');
    $this
      ->assertSession()
      ->fieldDisabled('variations[entity][' . $this->fieldName . '][0][stock_transaction_note]');
    $this
      ->assertSession()
      ->fieldValueEquals('variations[entity][' . $this->fieldName . '][0][stock_transaction_note]', $default_note);
    $adjustment = 6;
    $edit = [
      'title[0][value]' => 'New title',
      'variations[entity][price][0][number]' => '199.99',
      'variations[entity][' . $this->fieldName . '][0][adjustment]' => $adjustment,
      'variations[entity][title][0][value]' => $title . '_testvariation',
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->saveHtmlOutput();
    \Drupal::entityTypeManager()
      ->getStorage('commerce_product')
      ->resetCache([
      2,
    ]);
    \Drupal::entityTypeManager()
      ->getStorage('commerce_product_variation')
      ->resetCache([
      1,
    ]);
    $product = Product::load(2);
    $this
      ->assertNotEmpty($product);
    $variation = $product
      ->getDefaultVariation();
    $this
      ->assertNotEmpty($variation);
    $transaction = $this
      ->getLastEntityTransaction($variation
      ->id());
    $this
      ->assertEquals($adjustment, $transaction->qty);
    $this
      ->assertEquals($this->adminUser
      ->id(), $transaction->related_uid);
  }

  /**
   * Testing the commerce_stock_level_absolute widget.
   */
  public function testAbsoluteStockLevelWidget() {
    $entity_type = "commerce_product_variation";
    $bundle = 'default';
    $default_note = $this
      ->randomString(100);
    $widget_id = "commerce_stock_level_absolute";
    $widget_settings = [
      'custom_transaction_note' => FALSE,
      'default_transaction_note' => $default_note,
      'step' => '1',
    ];
    $this
      ->configureFormDisplay($widget_id, $widget_settings, $entity_type, $bundle);
    $this
      ->drupalGet($this->variation
      ->toUrl('edit-form'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->fieldExists($this->fieldName . '[0][stock_level]');
    $this
      ->assertSession()
      ->fieldNotExists($this->fieldName . '[0][adjustment]');
    $this
      ->assertSession()
      ->fieldExists($this->fieldName . '[0][stock_transaction_note]');
    $this
      ->assertSession()
      ->fieldDisabled($this->fieldName . '[0][stock_transaction_note]');
    $this
      ->assertSession()
      ->fieldValueEquals($this->fieldName . '[0][stock_transaction_note]', $default_note);
    $stock_level = 15;
    $new_price_amount = '1.11';
    $variations_edit = [
      'price[0][number]' => $new_price_amount,
      $this->fieldName . '[0][stock_level]' => $stock_level,
    ];
    $this
      ->submitForm($variations_edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $transaction = $this
      ->getLastEntityTransaction($this->variation
      ->id());
    $data = unserialize($transaction->data);

    // We setup our variation with an initial stock of 10. So setting the
    // absolute level to 15 should result in a transaction with 5.
    $this
      ->assertEquals(5, $transaction->qty);
    $this
      ->assertEquals($this->adminUser
      ->id(), $transaction->related_uid);
    $this
      ->assertEquals($default_note, $data['message']);

    // If the absolute stock level is the same as before, it shouldn't trigger
    // any transaction.
    $this
      ->drupalGet($this->variation
      ->toUrl('edit-form'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $stock_level = 15;
    $variations_edit = [
      $this->fieldName . '[0][stock_level]' => $stock_level,
    ];
    $this
      ->submitForm($variations_edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $transaction2 = $this
      ->getLastEntityTransaction($this->variation
      ->id());
    $this
      ->assertEquals($transaction->id, $transaction2->id);
    $this
      ->drupalGet($this->variation
      ->toUrl('edit-form'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Empty absolute stock_level shoudn't trigger any transaction.
    $stock_level = '';
    $edit = [
      $this->fieldName . '[0][stock_level]' => $stock_level,
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $transaction3 = $this
      ->getLastEntityTransaction($this->variation
      ->id());
    $this
      ->assertEquals($transaction->id, $transaction3->id);
    $widget_settings = [
      'custom_transaction_note' => TRUE,
      'default_transaction_note' => $default_note,
      'step' => '1',
    ];
    $this
      ->configureFormDisplay($widget_id, $widget_settings, $entity_type, $bundle);
    $this
      ->drupalGet($this->variation
      ->toUrl('edit-form'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->fieldExists($this->fieldName . '[0][stock_level]');
    $this
      ->assertSession()
      ->fieldNotExists($this->fieldName . '[0][adjustment]');
    $this
      ->assertSession()
      ->fieldExists($this->fieldName . '[0][stock_transaction_note]');
    self::expectException(ExpectationException::class);
    $this
      ->assertSession()
      ->fieldDisabled($this->fieldName . '[0][stock_transaction_note]');
    $this
      ->assertSession()
      ->fieldValueEquals($this->fieldName . '[0][stock_transaction_note]', $default_note);
    $stock_level = 5;
    $edit = [
      $this->fieldName . '[0][stock_level]' => $stock_level,
      $this->fieldName . '[0][stock_transaction_note]' => 'CustomNote',
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $transaction = $this
      ->getLastEntityTransaction($this->variation
      ->id());
    $data = unserialize($transaction->data);
    $this
      ->assertEquals(-10, $transaction->qty);
    $this
      ->assertEquals($this->adminUser
      ->id(), $transaction->related_uid);
    $this
      ->assertEquals('CustumNote', $data['message']);

    // Testing that zero value, results in a transaction.
    $this
      ->drupalGet($this->variation
      ->toUrl('edit-form'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $stock_level = 0;
    $edit = [
      $this->fieldName . '[0][stock_level]' => $stock_level,
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $transaction = $this
      ->getLastEntityTransaction($this->variation
      ->id());
    $this
      ->assertEquals(-5, $transaction->qty);
  }

  /**
   * Tests the absolute stock level widget in single variation mode.
   */
  public function testAbsoluteTransactionStockLevelWidgetSingleVariationMode() {
    $entity_type = "commerce_product_variation";
    $bundle = 'default';
    $default_note = $this
      ->randomString(100);
    $widget_id = "commerce_stock_level_absolute";
    $widget_settings = [
      'custom_transaction_note' => FALSE,
      'default_transaction_note' => $default_note,
      'step' => '1',
    ];
    $this
      ->configureFormDisplay($widget_id, $widget_settings, $entity_type, $bundle);
    $this
      ->drupalGet('admin/commerce/config/product-types/default/edit');
    $edit = [
      'multipleVariations' => FALSE,
    ];
    $this
      ->submitForm($edit, t('Save'));
    $this
      ->drupalGet('admin/commerce/products');
    $this
      ->getSession()
      ->getPage()
      ->clickLink('Add product');
    $this
      ->assertSession()
      ->buttonNotExists('Save and add variations');
    $this
      ->assertSession()
      ->fieldExists('variations[entity][sku][0][value]');

    // On product add form, there should be no stock level input field.
    $this
      ->assertSession()
      ->fieldNotExists('variations[entity][' . $this->fieldName . '][0][stock_level]');
    $this
      ->assertSession()
      ->fieldNotExists('variations[entity][' . $this->fieldName . '][0][stock_transaction_note]');
    $store_id = $this->stores[0]
      ->id();
    $title = $this
      ->randomMachineName();
    $sku = strtolower($this
      ->randomMachineName());
    $edit = [
      'title[0][value]' => $title,
      'stores[target_id][value][' . $store_id . ']' => $store_id,
      'variations[entity][sku][0][value]' => $sku,
      'variations[entity][price][0][number]' => '99.99',
      'variations[entity][title][0][value]' => $title . '_testvariation',
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Check if product was created. Remember we created
    // product 1 in test setup.
    $product = Product::load(2);
    $this
      ->assertNotEmpty($product);
    $this
      ->assertEquals($title, $product
      ->getTitle());

    // On product edit form, we should have a stock widget.
    $this
      ->drupalGet($product
      ->toUrl('edit-form'));
    $this
      ->assertSession()
      ->fieldExists('variations[entity][commerce_stock_always_in_stock][value]');
    $this
      ->assertSession()
      ->checkboxNotChecked('variations[entity][commerce_stock_always_in_stock][value]');
    $this
      ->assertSession()
      ->fieldExists('variations[entity][' . $this->fieldName . '][0][stock_level]');
    $this
      ->assertSession()
      ->fieldExists('variations[entity][' . $this->fieldName . '][0][stock_transaction_note]');
    $this
      ->assertSession()
      ->fieldDisabled('variations[entity][' . $this->fieldName . '][0][stock_transaction_note]');
    $this
      ->assertSession()
      ->fieldValueEquals('variations[entity][' . $this->fieldName . '][0][stock_transaction_note]', $default_note);
    $stock_level = 15;
    $edit = [
      'title[0][value]' => 'New title',
      'variations[entity][price][0][number]' => '199.99',
      'variations[entity][' . $this->fieldName . '][0][stock_level]' => $stock_level,
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    \Drupal::entityTypeManager()
      ->getStorage('commerce_product')
      ->resetCache([
      2,
    ]);
    \Drupal::entityTypeManager()
      ->getStorage('commerce_product_variation')
      ->resetCache([
      1,
    ]);
    $product = Product::load(2);
    $this
      ->assertNotEmpty($product);
    $variation = $product
      ->getDefaultVariation();
    $this
      ->assertNotEmpty($variation);
    $transaction = $this
      ->getLastEntityTransaction($variation
      ->id());
    $this
      ->assertEquals(15, $transaction->qty);
    $this
      ->assertEquals($this->adminUser
      ->id(), $transaction->related_uid);
    $this
      ->drupalGet($product
      ->toUrl('edit-form'));
    $stock_level = 5;
    $edit = [
      'variations[entity][' . $this->fieldName . '][0][stock_level]' => $stock_level,
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $transaction = $this
      ->getLastEntityTransaction($variation
      ->id());
    $this
      ->assertEquals(-10, $transaction->qty);
  }

  /**
   * Testing the commerce_stock_level_absolute widget.
   */
  public function testLinkToTransactionFormWidget() {
    $entity_type = "commerce_product_variation";
    $bundle = 'default';
    $widget_id = "commerce_stock_level_transaction_form_link";
    $widget_settings = [];
    $this
      ->configureFormDisplay($widget_id, $widget_settings, $entity_type, $bundle);
    $this
      ->drupalGet($this->variation
      ->toUrl('edit-form'));
    $this
      ->assertSession()
      ->linkExists(t('transaction form'));
    $this
      ->clickLink(t('transaction form'));
    $path = '/admin/commerce/config/stock/transactions2';
    $this
      ->assertSession()
      ->addressEquals($path);
  }

  /**
   * Test the deprecated simple widget.
   */
  public function testDeprecatedWidget() {
    $entity_type = "commerce_product_variation";
    $bundle = 'default';
    $widget_id = "commerce_stock_level_simple";
    $widget_settings = [
      'entry_system' => 'basic',
      'transaction_note' => FALSE,
      'context_fallback' => FALSE,
    ];
    $this
      ->configureFormDisplay($widget_id, $widget_settings, $entity_type, $bundle);
    $this
      ->drupalGet($this->variation
      ->toUrl('edit-form'));

    // Ensure the stock part of the form is healty.
    $this
      ->assertSession()
      ->fieldExists('commerce_stock_always_in_stock[value]');
    $this
      ->assertSession()
      ->checkboxNotChecked('commerce_stock_always_in_stock[value]');
    $this
      ->assertSession()
      ->fieldExists($this->fieldName . '[0][adjustment]');
    $adjustment = 5;
    $new_price_amount = '1.11';
    $variations_edit = [
      'price[0][number]' => $new_price_amount,
      $this->fieldName . '[0][adjustment]' => $adjustment,
    ];
    $this
      ->submitForm($variations_edit, 'Save');
    $transaction = $this
      ->getLastEntityTransaction($this->variation
      ->id());
    $this
      ->assertEquals($adjustment, $transaction->qty);
    $this
      ->assertEquals($this->adminUser
      ->id(), $transaction->related_uid);
    $widget_settings = [
      'entry_system' => 'simple',
      'transaction_note' => FALSE,
      'context_fallback' => FALSE,
    ];
    $this
      ->configureFormDisplay($widget_id, $widget_settings, $entity_type, $bundle);
    $this
      ->drupalGet($this->variation
      ->toUrl('edit-form'));
    $this
      ->assertSession()
      ->fieldExists($this->fieldName . '[0][stock_level]');
    $stock_level = 20;
    $edit = [
      $this->fieldName . '[0][stock_level]' => $stock_level,
    ];
    $this
      ->submitForm($edit, 'Save');
    $transaction = $this
      ->getLastEntityTransaction($this->variation
      ->id());

    // We setup our variation with an initial stock of 15. So setting the
    // absolute level to 20 should result in a transaction with 5.
    $this
      ->assertEquals(5, $transaction->qty);
    $this
      ->assertEquals($this->adminUser
      ->id(), $transaction->related_uid);
    $widget_settings = [
      'entry_system' => 'transactions',
      'transaction_note' => FALSE,
      'context_fallback' => FALSE,
    ];
    $this
      ->configureFormDisplay($widget_id, $widget_settings, $entity_type, $bundle);
    $this
      ->drupalGet($this->variation
      ->toUrl('edit-form'));
    $this
      ->assertSession()
      ->linkExists('New transaction');
  }

}

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::$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.
EntityReferenceTestTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
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.
StockBrowserTestBase::$product protected property The product to test against.
StockBrowserTestBase::$profile protected property The testing profile. Overrides BrowserTestBase::$profile
StockBrowserTestBase::$stockServiceManager protected property The stock service manager.
StockBrowserTestBase::$stores protected property The stores to test against.
StockBrowserTestBase::$variations protected property Array of product variations.
StockBrowserTestBase::setUp protected function Overrides CommerceBrowserTestBase::setUp 2
StockBrowserTestBase::waitForAjaxToFinish protected function Waits for jQuery to become active and animations to complete.
StockLevelFieldCreationTrait::$fieldName protected property The name of the test field.
StockLevelFieldCreationTrait::attachStockLevelField protected function Attaches a stock level field to an entity.
StockLevelFieldCreationTrait::configureFormDisplay protected function Set, update and configure the widget for the stock level field.
StockLevelFieldCreationTrait::configureViewDisplay protected function Set, update and configure the widget for the stock level field.
StockLevelFieldCreationTrait::createStockLevelField protected function Creates a new stock level field.
StockLevelFieldCreationTrait::getFieldname protected function Return the field name.
StockLevelFieldTestBase::$modules public static property Modules to enable. Overrides StockBrowserTestBase::$modules 1
StockLevelFieldTestBase::$variation protected property The test product variation.
StockLevelFieldTestBase::getAdministratorPermissions protected function Gets the permissions for the admin user. Overrides StockBrowserTestBase::getAdministratorPermissions
StockLevelFieldTestBase::setup protected function Setting up the test. 1
StockLevelWidgetsTest::testAbsoluteStockLevelWidget public function Testing the commerce_stock_level_absolute widget.
StockLevelWidgetsTest::testAbsoluteTransactionStockLevelWidgetSingleVariationMode public function Tests the absolute stock level widget in single variation mode.
StockLevelWidgetsTest::testDeprecatedWidget public function Test the deprecated simple widget.
StockLevelWidgetsTest::testLinkToTransactionFormWidget public function Testing the commerce_stock_level_absolute widget.
StockLevelWidgetsTest::testSimpleTransactionStockLevelWidget public function Tests the default simple transaction widget.
StockLevelWidgetsTest::testSimpleTransactionStockLevelWidgetSingleVariationMode public function Tests the default simple transaction widget in single variation mode.
StockTransactionQueryTrait::getLastEntityTransaction protected function Return the last transaction for a entity.
StockTransactionQueryTrait::getLastTransaction protected function Return the last transaction in the table.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
StoreCreationTrait::createStore protected function Creates a store for the test.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.