You are here

Home » API reference » Commerce Shipping 8.2 » ShippingOrderManagerTest.php

class ShippingOrderManagerTest in Commerce Shipping 8.2

Tests the shipping order manager.

@coversDefaultClass \Drupal\commerce_shipping\ShippingOrderManager @group commerce_shipping

Hierarchy

Expanded class hierarchy of ShippingOrderManagerTest

File

tests/src/Kernel/ShippingOrderManagerTest.php, line 23

Namespace

Drupal\Tests\commerce_shipping\Kernel
View source 
class ShippingOrderManagerTest extends ShippingKernelTestBase {

  /**
   * A non shippable order.
   *
   * @var \Drupal\commerce_order\Entity\OrderInterface
   */
  protected $nonShippableOrder;

  /**
   * A shippable order.
   *
   * @var \Drupal\commerce_order\Entity\OrderInterface
   */
  protected $shippableOrder;

  /**
   * A shipping method.
   *
   * @var \Drupal\commerce_shipping\Entity\ShippingMethodInterface
   */
  protected $shippingMethod;

  /**
   * The shipping order manager.
   *
   * @var \Drupal\commerce_shipping\ShippingOrderManagerInterface
   */
  protected $shippingOrderManager;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $shipping_method = ShippingMethod::create([
      'stores' => $this->store
        ->id(),
      'name' => 'Example',
      'plugin' => [
        'target_plugin_id' => 'flat_rate',
        'target_plugin_configuration' => [
          'rate_label' => 'Flat rate',
          'rate_amount' => new Price('1', 'USD'),
        ],
      ],
      'status' => TRUE,
      'weight' => 1,
    ]);
    $shipping_method
      ->save();
    $this->shippingMethod = $this
      ->reloadEntity($shipping_method);
    $order_item = OrderItem::create([
      'type' => 'test',
      'quantity' => 1,
      'unit_price' => new Price('12.00', 'USD'),
    ]);
    $order_item
      ->save();

    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
    $order = Order::create([
      'type' => 'default',
      'state' => 'draft',
      'store_id' => $this->store
        ->id(),
      'order_items' => [
        $order_item,
      ],
    ]);
    $order
      ->save();
    $this->nonShippableOrder = $this
      ->reloadEntity($order);
    $variation = ProductVariation::create([
      'type' => 'default',
      'sku' => 'test-product-02',
      'title' => 'Mug',
      'price' => new Price('10', 'USD'),
    ]);
    $variation
      ->save();
    $another_order_item = OrderItem::create([
      'type' => 'default',
      'quantity' => 2,
      'title' => $variation
        ->getOrderItemTitle(),
      'purchased_entity' => $variation,
      'unit_price' => new Price('10', 'USD'),
    ]);
    $another_order_item
      ->save();

    /** @var \Drupal\commerce_order\Entity\OrderInterface $another_order */
    $another_order = Order::create([
      'type' => 'default',
      'state' => 'draft',
      'store_id' => $this->store
        ->id(),
      'order_items' => [
        $another_order_item,
      ],
    ]);
    $another_order
      ->save();
    $this->shippableOrder = $this
      ->reloadEntity($another_order);
    $this->shippingOrderManager = $this->container
      ->get('commerce_shipping.order_manager');
  }

  /**
   * @covers ::createProfile
   */
  public function testCreateProfile() {
    $profile = $this->shippingOrderManager
      ->createProfile($this->shippableOrder);
    $this
      ->assertEquals('customer', $profile
      ->bundle());
    $profile_type = ProfileType::create([
      'id' => 'customer_shipping',
      'label' => $this
        ->randomString(),
    ]);
    $profile_type
      ->setThirdPartySetting('commerce_order', 'customer_profile_type', TRUE);
    $profile_type
      ->save();
    $shipment_type = ShipmentType::load('default');
    $shipment_type
      ->setProfileTypeId('customer_shipping');
    $shipment_type
      ->save();
    $profile = $this->shippingOrderManager
      ->createProfile($this->shippableOrder);
    $this
      ->assertEquals('customer_shipping', $profile
      ->bundle());
  }

  /**
   * @covers ::getProfile
   */
  public function testGetProfile() {
    $shipping_profile = Profile::create([
      'type' => 'customer',
      'address' => [
        'country_code' => 'FR',
      ],
    ]);
    $shipping_profile
      ->save();
    $shipping_profile = $this
      ->reloadEntity($shipping_profile);
    $shipment = Shipment::create([
      'type' => 'default',
      'order_id' => $this->shippableOrder
        ->id(),
      'title' => 'Shipment',
      'shipping_method' => $this->shippingMethod,
      'shipping_profile' => $shipping_profile,
      'tracking_code' => 'ABC123',
      'items' => [
        new ShipmentItem([
          'order_item_id' => 1,
          'title' => 'T-shirt (red, large)',
          'quantity' => 2,
          'weight' => new Weight('40', 'kg'),
          'declared_value' => new Price('30', 'USD'),
        ]),
      ],
      'amount' => new Price('5', 'USD'),
      'state' => 'draft',
    ]);
    $shipment
      ->save();
    $profile = $this->shippingOrderManager
      ->getProfile($this->nonShippableOrder);
    $this
      ->assertNull($profile);
    $this->shippableOrder
      ->set('shipments', [
      $shipment,
    ]);
    $this->shippableOrder
      ->save();
    $profile = $this->shippingOrderManager
      ->getProfile($this->shippableOrder);
    $this
      ->assertEquals($shipping_profile
      ->id(), $profile
      ->id());
  }

  /**
   * @covers ::hasShipments
   */
  public function testHasShipments() {
    $this
      ->assertFalse($this->shippingOrderManager
      ->hasShipments($this->nonShippableOrder));
    $this
      ->assertFalse($this->shippingOrderManager
      ->hasShipments($this->shippableOrder));
    $shipping_profile = Profile::create([
      'type' => 'customer',
      'address' => [
        'country_code' => 'FR',
      ],
    ]);
    $shipping_profile
      ->save();
    $shipments = $this->shippingOrderManager
      ->pack($this->shippableOrder, $shipping_profile);
    $this->shippableOrder
      ->set('shipments', $shipments);
    $this
      ->assertTrue($this->shippingOrderManager
      ->hasShipments($this->shippableOrder));
    $this->shippableOrder
      ->set('shipments', []);
    $this
      ->assertFalse($this->shippingOrderManager
      ->hasShipments($this->shippableOrder));
  }

  /**
   * @covers ::isShippable
   */
  public function testIsShippable() {
    $this
      ->assertFalse($this->shippingOrderManager
      ->isShippable($this->nonShippableOrder));
    $this
      ->assertTrue($this->shippingOrderManager
      ->isShippable($this->shippableOrder));
  }

  /**
   * @covers ::pack
   */
  public function testPack() {
    $shipping_profile = Profile::create([
      'type' => 'customer',
      'address' => [
        'country_code' => 'FR',
      ],
    ]);
    $shipping_profile
      ->save();
    $shipping_profile = $this
      ->reloadEntity($shipping_profile);
    $shipments = $this->shippingOrderManager
      ->pack($this->shippableOrder, $shipping_profile);
    $this
      ->assertCount(1, $shipments);

    /** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment */
    $shipment = $shipments[0];
    $this
      ->assertEquals('Mug', $shipment
      ->getItems()[0]
      ->getTitle());
    $this
      ->assertTrue($shipment
      ->getData('owned_by_packer'));
    $this
      ->assertEquals($shipping_profile, $shipment
      ->getShippingProfile());
    $this->shippableOrder
      ->set('shipments', $shipments);
    $variation = ProductVariation::create([
      'type' => 'default',
      'sku' => 'test-product-01',
      'title' => 'Hat',
      'price' => new Price('10', 'USD'),
    ]);
    $variation
      ->save();
    $order_item = OrderItem::create([
      'type' => 'default',
      'quantity' => 2,
      'title' => $variation
        ->getOrderItemTitle(),
      'purchased_entity' => $variation,
      'unit_price' => new Price('10', 'USD'),
    ]);
    $order_item
      ->save();
    $this->shippableOrder
      ->addItem($order_item);

    // The first shipment should be reused, and a second one created.
    $shipment_id = $shipment
      ->id();
    $shipments = $this->shippingOrderManager
      ->pack($this->shippableOrder, $shipping_profile);
    $this
      ->assertCount(2, $shipments);
    $first_shipment = $shipments[0];
    $this
      ->assertEquals($shipment_id, $first_shipment
      ->id());
    $this
      ->assertEquals('Mug', $first_shipment
      ->getItems()[0]
      ->getTitle());
    $this
      ->assertTrue($first_shipment
      ->getData('owned_by_packer'));
    $second_shipment = $shipments[1];
    $this
      ->assertEquals('Hat', $second_shipment
      ->getItems()[0]
      ->getTitle());
    $this
      ->assertTrue($second_shipment
      ->getData('owned_by_packer'));
    $shipments = $this->shippingOrderManager
      ->pack($this->nonShippableOrder);
    $this
      ->assertEmpty($shipments);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
CommerceKernelTestBase::$store protected property The default store. 1
CommerceKernelTestBase::tearDown protected function Overrides KernelTestBase::tearDown
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
DeprecationSuppressionTrait::restoreErrorHandler protected function Restores the original error handler.
DeprecationSuppressionTrait::setErrorHandler protected function Sets an error handler to suppress specified deprecation messages.
EntityKernelTestBase::$deprecatedProperties protected property The list of deprecated services.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
ShippingKernelTestBase::$modules public static property Modules to enable. Overrides OrderKernelTestBase::$modules 9
ShippingOrderManagerTest::$nonShippableOrder protected property A non shippable order.
ShippingOrderManagerTest::$shippableOrder protected property A shippable order.
ShippingOrderManagerTest::$shippingMethod protected property A shipping method.
ShippingOrderManagerTest::$shippingOrderManager protected property The shipping order manager.
ShippingOrderManagerTest::setUp protected function Overrides ShippingKernelTestBase::setUp
ShippingOrderManagerTest::testCreateProfile public function @covers ::createProfile
ShippingOrderManagerTest::testGetProfile public function @covers ::getProfile
ShippingOrderManagerTest::testHasShipments public function @covers ::hasShipments
ShippingOrderManagerTest::testIsShippable public function @covers ::isShippable
ShippingOrderManagerTest::testPack public function @covers ::pack
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