You are here

Home » API reference » farmOS 2.x » InventoryTest.php

class InventoryTest in farmOS 2.x

Same name in this branch
  1. 2.x modules/core/inventory/tests/src/Functional/InventoryTest.php \Drupal\Tests\farm_inventory\Functional\InventoryTest
  2. 2.x modules/core/inventory/tests/src/Kernel/InventoryTest.php \Drupal\Tests\farm_inventory\Kernel\InventoryTest

Tests for farmOS inventory logic.

@group farm

Hierarchy

Expanded class hierarchy of InventoryTest

File

modules/core/inventory/tests/src/Kernel/InventoryTest.php, line 19

Namespace

Drupal\Tests\farm_inventory\Kernel
View source 
class InventoryTest extends KernelTestBase {
  use FarmEntityCacheTestTrait;

  /**
   * Asset inventory service.
   *
   * @var \Drupal\farm_inventory\AssetInventoryInterface
   */
  protected $assetInventory;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'asset',
    'entity_reference_revisions',
    'farm_field',
    'farm_inventory',
    'farm_inventory_test',
    'farm_log',
    'farm_log_quantity',
    'farm_quantity_standard',
    'farm_unit',
    'fraction',
    'log',
    'options',
    'quantity',
    'state_machine',
    'taxonomy',
    'text',
    'user',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->assetInventory = \Drupal::service('asset.inventory');
    $this
      ->installEntitySchema('asset');
    $this
      ->installEntitySchema('log');
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('quantity');
    $this
      ->installEntitySchema('taxonomy_term');
    $this
      ->installConfig([
      'farm_inventory_test',
      'farm_quantity_standard',
    ]);
  }

  /**
   * Test simple asset inventory.
   */
  public function testSimpleAssetInventory() {

    // Create a new asset.

    /** @var \Drupal\asset\Entity\AssetInterface $asset */
    $asset = Asset::create([
      'type' => 'container',
      'name' => $this
        ->randomMachineName(),
      'status' => 'active',
    ]);
    $asset
      ->save();

    // Populate a cache value dependent on the asset's cache tags.
    $this
      ->populateEntityTestCache($asset);

    // When an asset has no adjustment logs, it has no inventory.
    $inventory = $this->assetInventory
      ->getInventory($asset);
    $this
      ->assertEmpty($inventory, 'New assets do not have inventory.');

    // Assert that the asset's cache tags were not invalidated.
    $this
      ->assertEntityTestCache($asset, TRUE);

    // Reset the asset's inventory to 1.
    $this
      ->adjustInventory($asset, 'reset', '1');

    // Confirm that the asset now has inventory.
    $inventory = $this->assetInventory
      ->getInventory($asset);
    $this
      ->assertNotEmpty($inventory, 'Asset with an inventory adjustment has inventory.');
    $this
      ->assertEquals('1', $inventory[0]['value'], 'Asset inventory is 1.');

    // Assert that the asset's cache tags were invalidated.
    $this
      ->assertEntityTestCache($asset, FALSE);

    // Re-populate a cache value dependent on the asset's cache tags.
    $this
      ->populateEntityTestCache($asset);

    // Increment the inventory by 5.
    $this
      ->adjustInventory($asset, 'increment', '5');
    $inventory = $this->assetInventory
      ->getInventory($asset);
    $this
      ->assertEquals('6', $inventory[0]['value'], 'Asset inventory is 6.');

    // Assert that the asset's cache tags were invalidated.
    $this
      ->assertEntityTestCache($asset, FALSE);

    // Re-populate a cache value dependent on the asset's cache tags.
    $this
      ->populateEntityTestCache($asset);

    // Decrement the inventory by 1.
    $this
      ->adjustInventory($asset, 'decrement', '1');
    $inventory = $this->assetInventory
      ->getInventory($asset);
    $this
      ->assertEquals('5', $inventory[0]['value'], 'Asset inventory is 5.');

    // Assert that the asset's cache tags were invalidated.
    $this
      ->assertEntityTestCache($asset, FALSE);

    // Re-populate a cache value dependent on the asset's cache tags.
    $this
      ->populateEntityTestCache($asset);

    // Reset the inventory back to zero.
    $this
      ->adjustInventory($asset, 'reset', '0');
    $inventory = $this->assetInventory
      ->getInventory($asset);
    $this
      ->assertEquals('0', $inventory[0]['value'], 'Asset inventory is 0.');

    // Assert that the asset's cache tags were invalidated.
    $this
      ->assertEntityTestCache($asset, FALSE);

    // Add a pending adjustment, and confirm that it does not affect the current
    // inventory.
    $log = $this
      ->adjustInventory($asset, 'increment', '1');
    $log
      ->set('status', 'pending');
    $log
      ->save();

    // Re-populate a cache value dependent on the asset's cache tags.
    $this
      ->populateEntityTestCache($asset);
    $log
      ->save();
    $inventory = $this->assetInventory
      ->getInventory($asset);
    $this
      ->assertEquals('0', $inventory[0]['value'], 'Pending adjustments do not affect inventory.');

    // Assert that the asset's cache tags were not invalidated.
    $this
      ->assertEntityTestCache($asset, TRUE);

    // Add an adjustment in the future, and confirm that it does not affect
    // the current inventory.
    $log = $this
      ->adjustInventory($asset, 'increment', '1');
    $log
      ->set('timestamp', \Drupal::time()
      ->getRequestTime() + 86400);
    $log
      ->save();

    // Re-populate a cache value dependent on the asset's cache tags.
    $this
      ->populateEntityTestCache($asset);
    $log
      ->save();
    $inventory = $this->assetInventory
      ->getInventory($asset);
    $this
      ->assertEquals('0', $inventory[0]['value'], 'Future adjustments do not affect inventory.');

    // Assert that the asset's cache tags were not invalidated.
    $this
      ->assertEntityTestCache($asset, TRUE);

    // Reset to a decimal inventory.
    $this
      ->adjustInventory($asset, 'reset', '1.1');
    $inventory = $this->assetInventory
      ->getInventory($asset);
    $this
      ->assertEquals('1.1', $inventory[0]['value'], 'Asset inventory is 1.1.');

    // Assert that the asset's cache tags were invalidated.
    $this
      ->assertEntityTestCache($asset, FALSE);

    // Re-populate a cache value dependent on the asset's cache tags.
    $this
      ->populateEntityTestCache($asset);

    // Increment by a decimal value.
    $this
      ->adjustInventory($asset, 'increment', '1.4');
    $inventory = $this->assetInventory
      ->getInventory($asset);
    $this
      ->assertEquals('2.5', $inventory[0]['value'], 'Asset inventory is 2.5.');

    // Assert that the asset's cache tags were invalidated.
    $this
      ->assertEntityTestCache($asset, FALSE);

    // Re-populate a cache value dependent on the asset's cache tags.
    $this
      ->populateEntityTestCache($asset);

    // Test floating point arithmetic precision.
    $this
      ->adjustInventory($asset, 'reset', '0.1');
    $log = $this
      ->adjustInventory($asset, 'increment', '0.2');
    $inventory = $this->assetInventory
      ->getInventory($asset);
    $this
      ->assertEquals('0.3', $inventory[0]['value'], 'Inventory calculations handle floating point arithmetic properly.');

    // Assert that the asset's cache tags were invalidated.
    $this
      ->assertEntityTestCache($asset, FALSE);

    // Re-populate a cache value dependent on the asset's cache tags.
    $this
      ->populateEntityTestCache($asset);

    // Delete the last increment adjustment to use the last reset adjustment.
    $log
      ->delete();
    $inventory = $this->assetInventory
      ->getInventory($asset);
    $this
      ->assertEquals('0.1', $inventory[0]['value'], 'Asset inventory is updated when a log is deleted.');

    // Assert that the asset's cache tags were invalidated.
    $this
      ->assertEntityTestCache($asset, FALSE);
  }

  /**
   * Test multiple asset inventories with measure+units pairs.
   */
  public function testMultipleAssetInventory() {

    // Create a new asset.

    /** @var \Drupal\asset\Entity\AssetInterface $asset */
    $asset = Asset::create([
      'type' => 'container',
      'name' => $this
        ->randomMachineName(),
      'status' => 'active',
    ]);
    $asset
      ->save();

    // Create two units terms.

    /** @var \Drupal\taxonomy\Entity\Term $unit1 */
    $unit1 = Term::create([
      'name' => 'liters',
      'vid' => 'unit',
    ]);
    $unit1
      ->save();

    /** @var \Drupal\taxonomy\Entity\Term $unit2 */
    $unit2 = Term::create([
      'name' => 'hours',
      'vid' => 'unit',
    ]);
    $unit2
      ->save();

    // Reset the asset's volume (liters) inventory to 1.
    $this
      ->adjustInventory($asset, 'reset', '1', 'volume', $unit1
      ->id());

    // Confirm that the asset has one inventory, with a measure of "volume",
    // units in "liters", and a value of 1.
    $inventory = $this->assetInventory
      ->getInventory($asset);
    $this
      ->assertEquals(1, count($inventory), 'Asset has a single inventory.');
    $this
      ->assertEquals('volume', $inventory[0]['measure'], 'Asset inventory has a measure of volume.');
    $this
      ->assertEquals('liters', $inventory[0]['units'], 'Asset inventory has units in liters.');
    $this
      ->assertEquals('1', $inventory[0]['value'], 'Asset inventory is 1.');

    // Reset the asset's time (hours) inventory to 2.
    $this
      ->adjustInventory($asset, 'reset', '2', 'time', $unit2
      ->id());

    // Confirm that the asset now has two inventories.
    $inventory = $this->assetInventory
      ->getInventory($asset);
    $this
      ->assertEquals(2, count($inventory), 'Asset has a single inventory.');

    // Load the time (hours) inventory and confirm that it is 2.
    $inventory = $this->assetInventory
      ->getInventory($asset, 'time', $unit2
      ->id());
    $this
      ->assertEquals('time', $inventory[0]['measure'], 'Asset inventory has a measure of time.');
    $this
      ->assertEquals('hours', $inventory[0]['units'], 'Asset inventory has units in hours.');
    $this
      ->assertEquals('2', $inventory[0]['value'], 'Asset inventory is 2.');

    // Load the volume (liters) inventory and confirm that it is still 1.
    $inventory = $this->assetInventory
      ->getInventory($asset, 'volume', $unit1
      ->id());
    $this
      ->assertEquals('volume', $inventory[0]['measure'], 'Asset inventory has a measure of volume.');
    $this
      ->assertEquals('liters', $inventory[0]['units'], 'Asset inventory has units in liters.');
    $this
      ->assertEquals('1', $inventory[0]['value'], 'Asset inventory is 1.');

    // Load all volume inventories (without specifying units) and confirm that
    // one inventory is returned.
    $inventory = $this->assetInventory
      ->getInventory($asset, 'volume', 0);
    $this
      ->assertEquals(1, count($inventory), 'Asset has a single volume inventory.');

    // Load all liters inventories (without specifying measure) and confirm that
    // one inventory is returned.
    $inventory = $this->assetInventory
      ->getInventory($asset, '', $unit2
      ->id());
    $this
      ->assertEquals(1, count($inventory), 'Asset has a single liters inventory.');

    // Test incrementing the volume (liters) inventory.
    $this
      ->adjustInventory($asset, 'increment', '4', 'volume', $unit1
      ->id());
    $inventory = $this->assetInventory
      ->getInventory($asset, 'volume', $unit1
      ->id());
    $this
      ->assertEquals('5', $inventory[0]['value'], 'Asset inventory is 5.');
  }

  /**
   * Creates an inventory adjustment quantity + log for a given asset.
   *
   * @param \Drupal\asset\Entity\AssetInterface $asset
   *   The asset to adjust inventory for.
   * @param string $adjustment
   *   The type of adjustment ('reset', 'increment', or 'decrement').
   * @param string $value
   *   The value of the adjustment.
   * @param string $measure
   *   The quantity measure of the inventory. See quantity_measures().
   * @param int $units
   *   The quantity units of the inventory (term ID).
   *
   * @return \Drupal\log\Entity\LogInterface
   *   The log entity.
   */
  protected function adjustInventory(AssetInterface $asset, string $adjustment, string $value, string $measure = '', int $units = 0) {
    $fraction = Fraction::createFromDecimal($value);

    /** @var \Drupal\quantity\Entity\Quantity $quantity */
    $quantity = Quantity::create([
      'type' => 'standard',
      'value' => [
        'numerator' => $fraction
          ->getNumerator(),
        'denominator' => $fraction
          ->getDenominator(),
      ],
      'inventory_adjustment' => $adjustment,
      'inventory_asset' => [
        'target_id' => $asset
          ->id(),
      ],
    ]);
    if (!empty($measure)) {
      $quantity
        ->set('measure', $measure);
    }
    if (!empty($units)) {
      $quantity
        ->set('units', [
        'target_id' => $units,
      ]);
    }
    $quantity
      ->save();

    /** @var \Drupal\log\Entity\LogInterface $log */
    $log = Log::create([
      'type' => 'adjustment',
      'status' => 'done',
      'quantity' => [
        'target_id' => $quantity
          ->id(),
        'target_revision_id' => $quantity
          ->getRevisionId(),
      ],
    ]);
    $log
      ->save();
    return $log;
  }

}

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.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FarmEntityCacheTestTrait::assertEntityTestCache protected function Assert that a cache value dependent on an entity's cache tags exists.
FarmEntityCacheTestTrait::getEntityCacheId protected function Helper method to build the entity test cache ID.
FarmEntityCacheTestTrait::populateEntityTestCache protected function Populate a cache value that is dependent on an entity's cache tags.
InventoryTest::$assetInventory protected property Asset inventory service.
InventoryTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
InventoryTest::adjustInventory protected function Creates an inventory adjustment quantity + log for a given asset.
InventoryTest::setUp protected function Overrides KernelTestBase::setUp
InventoryTest::testMultipleAssetInventory public function Test multiple asset inventories with measure+units pairs.
InventoryTest::testSimpleAssetInventory public function Test simple asset inventory.
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. 3
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::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 24
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::tearDown protected function 4
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.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
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.