From aa5f76f142beb19069994d64342afb6b7157c1d0 Mon Sep 17 00:00:00 2001 From: Matt Glaman Date: Sun, 4 Jun 2017 13:12:48 -0500 Subject: [PATCH] Issue #2881791 by mglaman: Expand promotion availability test coverage --- modules/promotion/src/Entity/Promotion.php | 8 +- .../tests/src/Kernel/Entity/PromotionTest.php | 66 ------- .../tests/src/Kernel/PromotionAvailabilityTest.php | 213 +++++++++++++++++++++ 3 files changed, 219 insertions(+), 68 deletions(-) create mode 100644 modules/promotion/tests/src/Kernel/PromotionAvailabilityTest.php diff --git a/modules/promotion/src/Entity/Promotion.php b/modules/promotion/src/Entity/Promotion.php index c18abbf6d..10aed002a 100644 --- a/modules/promotion/src/Entity/Promotion.php +++ b/modules/promotion/src/Entity/Promotion.php @@ -260,7 +260,8 @@ public function setUsageLimit($usage_limit) { * {@inheritdoc} */ public function getStartDate() { - return $this->get('start_date')->date; + // @todo use `date` property once https://www.drupal.org/node/2632040 fixed. + return DrupalDateTime::createFromFormat(DATETIME_DATE_STORAGE_FORMAT, $this->get('start_date')->value); } /** @@ -275,7 +276,10 @@ public function setStartDate(DrupalDateTime $start_date) { * {@inheritdoc} */ public function getEndDate() { - return $this->get('end_date')->date; + // @todo use `date` property once https://www.drupal.org/node/2632040 fixed. + if (!$this->get('end_date')->isEmpty()) { + return DrupalDateTime::createFromFormat(DATETIME_DATE_STORAGE_FORMAT, $this->get('end_date')->value); + } } /** diff --git a/modules/promotion/tests/src/Kernel/Entity/PromotionTest.php b/modules/promotion/tests/src/Kernel/Entity/PromotionTest.php index fee252b3f..90b4eb879 100644 --- a/modules/promotion/tests/src/Kernel/Entity/PromotionTest.php +++ b/modules/promotion/tests/src/Kernel/Entity/PromotionTest.php @@ -2,14 +2,10 @@ namespace Drupal\Tests\commerce_promotion\Kernel\Entity; -use Drupal\commerce_order\Entity\Order; -use Drupal\commerce_order\Entity\OrderItem; use Drupal\commerce_order\Entity\OrderItemType; use Drupal\commerce_order\Entity\OrderType; -use Drupal\commerce_price\Price; use Drupal\commerce_promotion\Entity\Coupon; use Drupal\commerce_promotion\Entity\Promotion; -use Drupal\Component\Datetime\TimeInterface; use Drupal\Core\Datetime\DrupalDateTime; use Drupal\Tests\commerce\Kernel\CommerceKernelTestBase; @@ -153,66 +149,4 @@ public function testPromotion() { $this->assertEquals(TRUE, $promotion->isEnabled()); } - /** - * @covers ::available - */ - public function testAvailability() { - $this->installSchema('commerce_promotion', ['commerce_promotion_usage']); - $order_item = OrderItem::create([ - 'type' => 'test', - 'quantity' => 1, - 'unit_price' => new Price('12.00', 'USD'), - ]); - $order_item->save(); - $order = Order::create([ - 'type' => 'default', - 'state' => 'draft', - 'mail' => 'test@example.com', - 'ip_address' => '127.0.0.1', - 'order_number' => '6', - 'store_id' => $this->store, - 'uid' => $this->createUser(), - 'order_items' => [$order_item], - ]); - $order->setRefreshState(Order::REFRESH_SKIP); - $order->save(); - - $promotion = Promotion::create([ - 'order_types' => ['default'], - 'stores' => [$this->store->id()], - 'usage_limit' => 1, - 'start_date' => '2017-01-01', - 'status' => TRUE, - ]); - $promotion->save(); - $this->assertTrue($promotion->available($order)); - - $promotion->setEnabled(FALSE); - $this->assertFalse($promotion->available($order)); - $promotion->setEnabled(TRUE); - - $promotion->setOrderTypeIds(['test']); - $this->assertFalse($promotion->available($order)); - $promotion->setOrderTypeIds(['default']); - - $promotion->setStoreIds(['90']); - $this->assertFalse($promotion->available($order)); - $promotion->setStoreIds([$this->store->id()]); - - $fake_time = $this->prophesize(TimeInterface::class); - $fake_time->getRequestTime()->willReturn(mktime(0, 0, 0, '01', '15', '2016')); - $this->container->set('datetime.time', $fake_time->reveal()); - $this->assertFalse($promotion->available($order)); - - $fake_time = $this->prophesize(TimeInterface::class); - $fake_time->getRequestTime()->willReturn(mktime(0, 0, 0, '01', '15', '2017')); - $this->container->set('datetime.time', $fake_time->reveal()); - $promotion->setEndDate(new DrupalDateTime('2017-01-14')); - $this->assertFalse($promotion->available($order)); - $promotion->setEndDate(NULL); - - \Drupal::service('commerce_promotion.usage')->addUsage($order, $promotion); - $this->assertFalse($promotion->available($order)); - } - } diff --git a/modules/promotion/tests/src/Kernel/PromotionAvailabilityTest.php b/modules/promotion/tests/src/Kernel/PromotionAvailabilityTest.php new file mode 100644 index 000000000..23244c325 --- /dev/null +++ b/modules/promotion/tests/src/Kernel/PromotionAvailabilityTest.php @@ -0,0 +1,213 @@ +installEntitySchema('profile'); + $this->installEntitySchema('commerce_order'); + $this->installEntitySchema('commerce_order_item'); + $this->installEntitySchema('commerce_promotion'); + $this->installEntitySchema('commerce_promotion_coupon'); + $this->installSchema('commerce_promotion', ['commerce_promotion_usage']); + $this->installConfig([ + 'profile', + 'commerce_order', + 'commerce_promotion', + ]); + + OrderItemType::create([ + 'id' => 'test', + 'label' => 'Test', + 'orderType' => 'default', + ])->save(); + + $order_item = OrderItem::create([ + 'type' => 'test', + 'quantity' => 1, + 'unit_price' => new Price('12.00', 'USD'), + ]); + $order_item->save(); + $order = Order::create([ + 'type' => 'default', + 'state' => 'draft', + 'mail' => 'test@example.com', + 'ip_address' => '127.0.0.1', + 'order_number' => '6', + 'store_id' => $this->store, + 'uid' => $this->createUser(), + 'order_items' => [$order_item], + ]); + $order->setRefreshState(Order::REFRESH_SKIP); + $order->save(); + $this->order = $this->reloadEntity($order); + } + + /** + * Tests a promotion is available immediately with default start date. + */ + public function testDefaultStartDate() { + $promotion = Promotion::create([ + 'order_types' => ['default'], + 'stores' => [$this->store->id()], + 'usage_limit' => 1, + 'status' => TRUE, + ]); + $promotion->save(); + $this->assertTrue($promotion->available($this->order)); + + // The default start date fails around midnight due to core's handling + // of computed date field values. + // @see property once https://www.drupal.org/node/2632040 + $now = (new \DateTime())->setTime(20, 00); + $this->container->get('request_stack')->getCurrentRequest()->server->set('REQUEST_TIME', $now->getTimestamp()); + $promotion = Promotion::create([ + 'order_types' => ['default'], + 'stores' => [$this->store->id()], + 'usage_limit' => 1, + 'status' => TRUE, + ]); + $promotion->save(); + $this->assertTrue($promotion->available($this->order)); + } + + /** + * Tests a promotion is available with an early start date. + */ + public function testEarlierStartDate() { + $this->testDefaultStartDate(); + $promotion = Promotion::create([ + 'order_types' => ['default'], + 'stores' => [$this->store->id()], + 'usage_limit' => 1, + 'start_date' => '2017-01-01', + 'status' => TRUE, + ]); + $promotion->save(); + $this->assertTrue($promotion->available($this->order)); + } + + /** + * Tests a promotion is not available with a later start date. + */ + public function testLaterStartDate() { + $next_week = new DrupalDateTime(); + $next_week->modify('+1 week'); + $promotion = Promotion::create([ + 'order_types' => ['default'], + 'stores' => [$this->store->id()], + 'usage_limit' => 1, + 'start_date' => $next_week->format(DATETIME_DATE_STORAGE_FORMAT), + 'status' => TRUE, + ]); + $promotion->save(); + $this->assertFalse($promotion->available($this->order)); + } + + /** + * Tests the usage count wrapped within ::available. + */ + public function testUsageCount() { + $promotion = Promotion::create([ + 'order_types' => ['default'], + 'stores' => [$this->store->id()], + 'usage_limit' => 2, + 'status' => TRUE, + ]); + $promotion->save(); + $this->assertTrue($promotion->available($this->order)); + + \Drupal::service('commerce_promotion.usage')->addUsage($this->order, $promotion); + $this->assertTrue($promotion->available($this->order)); + \Drupal::service('commerce_promotion.usage')->addUsage($this->order, $promotion); + $this->assertFalse($promotion->available($this->order)); + } + + /** + * Test all of the availability items. + */ + public function testAvailability() { + $original_time_service = $this->container->get('datetime.time'); + + $promotion = Promotion::create([ + 'order_types' => ['default'], + 'stores' => [$this->store->id()], + 'usage_limit' => 2, + 'status' => TRUE, + ]); + $promotion->save(); + $this->assertTrue($promotion->available($this->order)); + + $promotion->setEnabled(FALSE); + $this->assertFalse($promotion->available($this->order)); + $promotion->setEnabled(TRUE); + + $promotion->setOrderTypeIds(['test']); + $this->assertFalse($promotion->available($this->order)); + $promotion->setOrderTypeIds(['default']); + + $promotion->setStoreIds(['90']); + $this->assertFalse($promotion->available($this->order)); + $promotion->setStoreIds([$this->store->id()]); + + $fake_time = $this->prophesize(TimeInterface::class); + $fake_time->getRequestTime()->willReturn(mktime(0, 0, 0, '01', '15', '2016')); + $this->container->set('datetime.time', $fake_time->reveal()); + $this->assertFalse($promotion->available($this->order)); + + $fake_time = $this->prophesize(TimeInterface::class); + $fake_time->getRequestTime()->willReturn(mktime(0, 0, 0, '01', '15', '2017')); + $this->container->set('datetime.time', $fake_time->reveal()); + $promotion->setEndDate(new DrupalDateTime('2017-01-14')); + $this->assertFalse($promotion->available($this->order)); + $promotion->setEndDate(NULL); + $this->container->set('datetime.time', $original_time_service); + + \Drupal::service('commerce_promotion.usage')->addUsage($this->order, $promotion); + $this->assertTrue($promotion->available($this->order)); + \Drupal::service('commerce_promotion.usage')->addUsage($this->order, $promotion); + $this->assertFalse($promotion->available($this->order)); + } + +}