You are here

Home » API reference » Commerce Core 8.2 » PromotionTest.php

class PromotionTest in Commerce Core 8.2

Same name in this branch
  1. 8.2 modules/promotion/tests/src/FunctionalJavascript/PromotionTest.php \Drupal\Tests\commerce_promotion\FunctionalJavascript\PromotionTest
  2. 8.2 modules/promotion/tests/src/Kernel/Entity/PromotionTest.php \Drupal\Tests\commerce_promotion\Kernel\Entity\PromotionTest

Tests the Promotion entity.

@coversDefaultClass \Drupal\commerce_promotion\Entity\Promotion

@group commerce

Hierarchy

Expanded class hierarchy of PromotionTest

File

modules/promotion/tests/src/Kernel/Entity/PromotionTest.php, line 21

Namespace

Drupal\Tests\commerce_promotion\Kernel\Entity
View source 
class PromotionTest extends OrderKernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'commerce_promotion',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->installEntitySchema('commerce_promotion');
    $this
      ->installEntitySchema('commerce_promotion_coupon');
    $this
      ->installSchema('commerce_promotion', [
      'commerce_promotion_usage',
    ]);
    $this
      ->installConfig([
      'commerce_promotion',
    ]);
  }

  /**
   * @covers ::getName
   * @covers ::setName
   * @covers ::getDisplayName
   * @covers ::setDisplayName
   * @covers ::getDescription
   * @covers ::setDescription
   * @covers ::getCreatedTime
   * @covers ::setCreatedTime
   * @covers ::getOrderTypes
   * @covers ::setOrderTypes
   * @covers ::getOrderTypeIds
   * @covers ::setOrderTypeIds
   * @covers ::getStores
   * @covers ::setStores
   * @covers ::setStoreIds
   * @covers ::getStoreIds
   * @covers ::getOffer
   * @covers ::setOffer
   * @covers ::getConditionOperator
   * @covers ::setConditionOperator
   * @covers ::getCouponIds
   * @covers ::getCoupons
   * @covers ::setCoupons
   * @covers ::hasCoupons
   * @covers ::addCoupon
   * @covers ::removeCoupon
   * @covers ::hasCoupon
   * @covers ::getUsageLimit
   * @covers ::setUsageLimit
   * @covers ::getUsageLimit
   * @covers ::setUsageLimit
   * @covers ::getStartDate
   * @covers ::setStartDate
   * @covers ::getEndDate
   * @covers ::setEndDate
   * @covers ::isEnabled
   * @covers ::setEnabled
   * @covers ::getOwner
   * @covers ::setOwner
   * @covers ::getOwnerId
   * @covers ::setOwnerId
   */
  public function testPromotion() {
    $order_type = OrderType::load('default');
    $promotion = Promotion::create([
      'status' => FALSE,
    ]);
    $promotion
      ->setName('My Promotion');
    $this
      ->assertEquals('My Promotion', $promotion
      ->getName());
    $promotion
      ->setDisplayName('50% off');
    $this
      ->assertEquals('50% off', $promotion
      ->getDisplayName());
    $promotion
      ->setDescription('My Promotion Description');
    $this
      ->assertEquals('My Promotion Description', $promotion
      ->getDescription());
    $promotion
      ->setCreatedTime(635879700);
    $this
      ->assertEquals(635879700, $promotion
      ->getCreatedTime());
    $promotion
      ->setOrderTypes([
      $order_type,
    ]);
    $order_types = $promotion
      ->getOrderTypes();
    $this
      ->assertEquals($order_type
      ->id(), $order_types[0]
      ->id());
    $promotion
      ->setOrderTypeIds([
      $order_type
        ->id(),
    ]);
    $this
      ->assertEquals([
      $order_type
        ->id(),
    ], $promotion
      ->getOrderTypeIds());
    $promotion
      ->setStores([
      $this->store,
    ]);
    $this
      ->assertEquals([
      $this->store,
    ], $promotion
      ->getStores());
    $promotion
      ->setStoreIds([
      $this->store
        ->id(),
    ]);
    $this
      ->assertEquals([
      $this->store
        ->id(),
    ], $promotion
      ->getStoreIds());
    $rounder = $this
      ->prophesize(RounderInterface::class)
      ->reveal();
    $offer = new OrderItemPercentageOff([
      'percentage' => '0.5',
    ], 'order_percentage_off', [], $rounder);
    $promotion
      ->setOffer($offer);
    $this
      ->assertEquals($offer
      ->getPluginId(), $promotion
      ->getOffer()
      ->getPluginId());
    $this
      ->assertEquals($offer
      ->getConfiguration(), $promotion
      ->getOffer()
      ->getConfiguration());
    $this
      ->assertEquals('AND', $promotion
      ->getConditionOperator());
    $promotion
      ->setConditionOperator('OR');
    $this
      ->assertEquals('OR', $promotion
      ->getConditionOperator());
    $coupon1 = Coupon::create([
      'code' => $this
        ->randomMachineName(),
      'status' => TRUE,
    ]);
    $coupon1
      ->save();
    $coupon2 = Coupon::create([
      'code' => $this
        ->randomMachineName(),
      'status' => TRUE,
    ]);
    $coupon2
      ->save();
    $coupon1 = Coupon::load($coupon1
      ->id());
    $coupon2 = Coupon::load($coupon2
      ->id());
    $coupons = [
      $coupon1,
      $coupon2,
    ];
    $coupon_ids = [
      $coupon1
        ->id(),
      $coupon2
        ->id(),
    ];
    $this
      ->assertFalse($promotion
      ->hasCoupons());
    $promotion
      ->setCoupons($coupons);
    $this
      ->assertTrue($promotion
      ->hasCoupons());
    $this
      ->assertEquals($coupons, $promotion
      ->getCoupons());
    $this
      ->assertEquals($coupon_ids, $promotion
      ->getCouponIds());
    $this
      ->assertTrue($promotion
      ->hasCoupon($coupon1));
    $promotion
      ->removeCoupon($coupon1);
    $this
      ->assertFalse($promotion
      ->hasCoupon($coupon1));
    $promotion
      ->addCoupon($coupon1);
    $this
      ->assertTrue($promotion
      ->hasCoupon($coupon1));

    // Check Coupon::postDelete() remove Coupon reference from promotion.
    $promotion
      ->save();

    /** @var \Drupal\commerce_promotion\Entity\PromotionInterface $promotion */
    $promotion = $this
      ->reloadEntity($promotion);
    $this
      ->assertEquals($promotion
      ->id(), 1);
    $coupon1
      ->delete();
    $this
      ->assertFalse($promotion
      ->hasCoupon($coupon1));
    $promotion
      ->setUsageLimit(10);
    $this
      ->assertEquals(10, $promotion
      ->getUsageLimit());
    $promotion
      ->setCustomerUsageLimit(2);
    $this
      ->assertEquals(2, $promotion
      ->getCustomerUsageLimit());
    $date_pattern = DateTimeItemInterface::DATETIME_STORAGE_FORMAT;
    $time = $this->container
      ->get('datetime.time');
    $default_start_date = gmdate($date_pattern, $time
      ->getRequestTime());
    $this
      ->assertEquals($default_start_date, $promotion
      ->getStartDate()
      ->format($date_pattern));
    $promotion
      ->setStartDate(new DrupalDateTime('2017-01-01 12:12:12'));
    $this
      ->assertEquals('2017-01-01 12:12:12 UTC', $promotion
      ->getStartDate()
      ->format('Y-m-d H:i:s T'));
    $this
      ->assertEquals('2017-01-01 12:12:12 CET', $promotion
      ->getStartDate('Europe/Berlin')
      ->format('Y-m-d H:i:s T'));
    $this
      ->assertNull($promotion
      ->getEndDate());
    $promotion
      ->setEndDate(new DrupalDateTime('2017-01-31 17:15:00'));
    $this
      ->assertEquals('2017-01-31 17:15:00 UTC', $promotion
      ->getEndDate()
      ->format('Y-m-d H:i:s T'));
    $this
      ->assertEquals('2017-01-31 17:15:00 CET', $promotion
      ->getEndDate('Europe/Berlin')
      ->format('Y-m-d H:i:s T'));
    $promotion
      ->setEnabled(TRUE);
    $this
      ->assertEquals(TRUE, $promotion
      ->isEnabled());
    $promotion
      ->setOwnerId(900);
    $this
      ->assertTrue($promotion
      ->getOwner()
      ->isAnonymous());
    $this
      ->assertEquals(900, $promotion
      ->getOwnerId());
    $promotion
      ->save();
    $this
      ->assertEquals(0, $promotion
      ->getOwnerId());
  }

  /**
   * @covers ::createDuplicate
   */
  public function testDuplicate() {
    $coupon = Coupon::create([
      'code' => $this
        ->randomMachineName(),
      'status' => TRUE,
    ]);
    $coupon
      ->save();
    $promotion = Promotion::create([
      'name' => '10% off',
      'coupons' => [
        $coupon,
      ],
      'status' => FALSE,
    ]);
    $promotion
      ->save();
    $this
      ->assertNotEmpty($promotion
      ->getCouponIds());
    $duplicate_promotion = $promotion
      ->createDuplicate();
    $this
      ->assertEquals('10% off', $duplicate_promotion
      ->label());
    $this
      ->assertFalse($duplicate_promotion
      ->hasCoupons());
  }

}

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.
PromotionTest::$modules public static property Modules to enable. Overrides OrderKernelTestBase::$modules
PromotionTest::setUp protected function Overrides OrderKernelTestBase::setUp
PromotionTest::testDuplicate public function @covers ::createDuplicate
PromotionTest::testPromotion public function @covers ::getName @covers ::setName @covers ::getDisplayName @covers ::setDisplayName @covers ::getDescription @covers ::setDescription @covers ::getCreatedTime @covers ::setCreatedTime @covers ::getOrderTypes @covers ::setOrderTypes @covers…
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.
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