class StockLevelTest in Commerce Stock 8

Ensure the stock level field works.

@coversDefaultClass \Drupal\commerce_stock_field\Plugin\Field\FieldType\StockLevel

@group commerce_stock

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase uses DeprecatedServicePropertyTrait, UserCreationTrait
  - class \Drupal\Tests\commerce\Kernel\CommerceKernelTestBase uses StoreCreationTrait, DeprecationSuppressionTrait
    class \Drupal\Tests\commerce_stock\Kernel\CommerceStockKernelTestBase
    class \Drupal\Tests\commerce_stock_field\Kernel\StockLevelTest uses StockLevelFieldCreationTrait, StockTransactionQueryTrait

Expanded class hierarchy of StockLevelTest

File

modules/field/tests/src/Kernel/StockLevelTest.php, line 22

Namespace

Drupal\Tests\commerce_stock_field\Kernel

View source

class StockLevelTest extends CommerceStockKernelTestBase {
  use StockLevelFieldCreationTrait;
  use StockTransactionQueryTrait;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'path',
    'commerce_product',
    'commerce_stock_field',
    'commerce_stock_local',
  ];

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

  /**
   * The stock service manager.
   *
   * @var \Drupal\commerce_stock\StockServiceManagerInterface
   */
  protected $stockServiceManager;

  /**
   * The stock checker.
   *
   * @var \Drupal\commerce_stock\StockCheckInterface
   */
  protected $checker;

  /**
   * The stock service configuration.
   *
   * @var \Drupal\commerce_stock\stockServiceConfiguration
   */
  protected $stockServiceConfiguration;

  /**
   * An array of location ids for variation1.
   *
   * @var int[]
   */
  protected $locations;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    $this->fieldName = 'test_stock_level';
    parent::setUp();
    $this
      ->installEntitySchema('commerce_stock_location');
    $this
      ->installEntitySchema('commerce_product');
    $this
      ->installEntitySchema('commerce_product_variation');
    $this
      ->installConfig([
      'commerce_product',
      'commerce_stock',
      'commerce_stock_local',
    ]);
    $this
      ->installSchema('commerce_stock_local', [
      'commerce_stock_transaction',
      'commerce_stock_transaction_type',
      'commerce_stock_location_level',
    ]);
    $location = StockLocation::create([
      'type' => 'default',
      'name' => $this
        ->randomString(),
      'status' => 1,
    ]);
    $location
      ->save();
    $configFactory = $this->container
      ->get('config.factory');
    $config = $configFactory
      ->getEditable('commerce_stock.service_manager');
    $config
      ->set('default_service_id', 'local_stock');
    $config
      ->save();
    $this->stockServiceManager = \Drupal::service('commerce_stock.service_manager');
    $entity_type = 'commerce_product_variation';
    $bundle = 'default';
    $widget_id = 'commerce_stock_level_simple';
    $this
      ->createStockLevelField($entity_type, $bundle, $widget_id);
    $variation = ProductVariation::create([
      'type' => 'default',
      'sku' => 'TEST_' . strtolower($this
        ->randomMachineName()),
      'status' => 1,
      'price' => [
        'number' => '12.00',
        'currency_code' => 'USD',
      ],
    ]);
    $variation
      ->save();
    Product::create([
      'type' => 'default',
      'variations' => [
        $variation,
      ],
      'stores' => [
        $this->store,
      ],
    ])
      ->save();
    $this->variation = $this
      ->reloadEntity($variation);
    $user = $this
      ->createUser([
      'mail' => $this
        ->randomString() . '@example.com',
    ]);
    $this->stockServiceManager
      ->createTransaction($this->variation, 1, '', 55, 0, 'EUR', StockTransactionsInterface::STOCK_IN);
    $this->checker = $this->stockServiceManager
      ->getService($this->variation)
      ->getStockChecker();
    $this->stockServiceConfiguration = $this->stockServiceManager
      ->getService($this->variation)
      ->getConfiguration();
    $context = new Context($user, $this->store);
    $this->locations = $this->stockServiceConfiguration
      ->getAvailabilityLocations($context, $this->variation);
  }

  /**
   * Test always in stock field is added to purchasable entities.
   *
   * Test that a commerce_stock_always_in_stock base field
   * is added to purchasable entities.
   */
  public function testBaseFieldisAddedtoPurchasableEntity() {
    $variation = ProductVariation::create([
      'type' => 'default',
    ]);
    $variation
      ->save();

    // This would throw an Exception, if the field isn't there.
    $field = $variation
      ->get('commerce_stock_always_in_stock');

    // Check the default value is set to FALSE.
    self::assertFalse($field
      ->getValue()[0]['value']);
  }

  /**
   * Whether setting a plain value results in increased stock level.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function testStockLevelStockIn() {
    $this->variation
      ->set('test_stock_level', 10);
    $this->variation
      ->save();
    $this
      ->assertEquals(65, $this->checker
      ->getTotalStockLevel($this->variation, $this->locations));
  }

  /**
   * Whether setting a plain negative results in reduced stock level.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function testStockLevelStockOut() {
    $this->variation
      ->set('test_stock_level', -10);
    $this->variation
      ->save();
    $this
      ->assertEquals(45, $this->checker
      ->getTotalStockLevel($this->variation, $this->locations));
  }

  /**
   * Whether a wrong value is throwing.
   */
  public function testInvalidArgumentThrows() {
    $this
      ->expectException(\InvalidArgumentException::class);
    $this->variation
      ->set('test_stock_level', 'FAIL');
  }

  /**
   * Whether all data are correctly saved with the transaction.
   */
  public function testTransactionData() {
    $test_note = $this
      ->randomString();
    $zone = 'TestZone';
    $mock_widget_values = [
      'adjustment' => '3.33',
      'stock_transaction_note' => $test_note,
      'user_id' => 7,
      'unit_cost' => [
        'amount' => 33,
        'currency_code' => 'USD',
      ],
      'zone' => $zone,
    ];
    $this->variation
      ->set('test_stock_level', $mock_widget_values);
    $this->variation
      ->save();
    $transaction = $this
      ->getLastEntityTransaction($this->variation
      ->id());
    $data = unserialize($transaction->data);
    $this
      ->assertEquals($mock_widget_values['zone'], $transaction->location_zone);
    $this
      ->assertEquals($mock_widget_values['adjustment'], $transaction->qty);
    $this
      ->assertEquals($mock_widget_values['user_id'], $transaction->related_uid);
    $this
      ->assertEquals($mock_widget_values['unit_cost']['amount'], $transaction->unit_cost);
    $this
      ->assertEquals($mock_widget_values['unit_cost']['currency_code'], $transaction->currency_code);
    $this
      ->assertEquals($mock_widget_values['stock_transaction_note'], $data['message']);
  }

  /**
   * Tests the ::generateSampleValue() method.
   */
  public function testSampeValueGenerator() {
    $i = 0;
    $fieldDefinition = $this
      ->createMock(FieldDefinitionInterface::class);
    while ($i < 100) {
      $sampleValue = StockLevel::generateSampleValue($fieldDefinition);
      $value = $sampleValue['value'];
      $this
        ->assertTrue(is_float($value));
      $this
        ->assertTrue(is_float($value));
      $this
        ->assertTrue(999 >= $value && -999 <= $value);
      $i++;
    }
  }

}

Members

Name	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.
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.
StockLevelTest::$checker	protected	property	The stock checker.
StockLevelTest::$locations	protected	property	An array of location ids for variation1.
StockLevelTest::$modules	public static	property	Modules to enable. Overrides CommerceStockKernelTestBase::$modules
StockLevelTest::$stockServiceConfiguration	protected	property	The stock service configuration.
StockLevelTest::$stockServiceManager	protected	property	The stock service manager.
StockLevelTest::$variation	protected	property	A test variation.
StockLevelTest::setUp	protected	function	Overrides CommerceKernelTestBase::setUp
StockLevelTest::testBaseFieldisAddedtoPurchasableEntity	public	function	Test always in stock field is added to purchasable entities.
StockLevelTest::testInvalidArgumentThrows	public	function	Whether a wrong value is throwing.
StockLevelTest::testSampeValueGenerator	public	function	Tests the ::generateSampleValue() method.
StockLevelTest::testStockLevelStockIn	public	function	Whether setting a plain value results in increased stock level.
StockLevelTest::testStockLevelStockOut	public	function	Whether setting a plain negative results in reduced stock level.
StockLevelTest::testTransactionData	public	function	Whether all data are correctly saved with the transaction.
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.
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

You are here

class StockLevelTest in Commerce Stock 8

Hierarchy

File

Namespace

Members

API Navigation