You are here

Home » API reference » Commerce Invoice 8.2 » InvoiceOrderAccessCheckTest.php

class InvoiceOrderAccessCheckTest in Commerce Invoice 8.2

Tests the 'access_check.invoice_order' access checker.

@coversDefaultClass \Drupal\commerce_invoice\Access\InvoiceOrderAccessCheck

@group commerce_invoice

Hierarchy

Expanded class hierarchy of InvoiceOrderAccessCheckTest

File

tests/src/Kernel/InvoiceOrderAccessCheckTest.php, line 22

Namespace

Drupal\Tests\commerce_invoice\Kernel
View source 
class InvoiceOrderAccessCheckTest extends OrderIntegrationTest {

  /**
   * @var \Drupal\commerce_invoice\Access\InvoiceOrderAccessCheck
   */
  protected $accessChecker;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->accessChecker = $this->container
      ->get('access_check.invoice_order');
  }

  /**
   * @covers ::access
   */
  public function testAccessWithoutPermission() {
    $access = $this->accessChecker
      ->access($this
      ->getRoute(FALSE), $this
      ->getRouteMatch(), $this
      ->getAccount(FALSE));
    $this
      ->assertFalse($access
      ->isAllowed());
  }

  /**
   * @covers ::access
   */
  public function testAccessForDraftOrders() {

    // The order created in the parent ::setUp() method is in a draft state, so
    // access to create invoices for it shouldn't be allowed.
    $this
      ->assertEquals('draft', $this->order
      ->getState()
      ->getId());
    $access = $this->accessChecker
      ->access($this
      ->getRoute(), $this
      ->getRouteMatch($this->order), $this
      ->getAccount());
    $this
      ->assertFalse($access
      ->isAllowed());
  }

  /**
   * @covers ::access
   */
  public function testAccessWithPartialInvoices() {

    // The parent test class creates an order containing a single order item
    // with a quantity of 1. Increase that quantity to 3 and add an order
    // adjustment so we can test multiple invoices generated for the same order.
    $order_item = $this->order
      ->getItems()[0];
    $order_item
      ->setQuantity(3);
    $this->order
      ->setItems([
      $order_item,
    ]);
    $adjustment = new Adjustment([
      'type' => 'custom',
      'label' => 'Random fee',
      'amount' => new Price('2.00', 'USD'),
    ]);
    $this->order
      ->addAdjustment($adjustment);
    $this->order
      ->getState()
      ->applyTransitionById('place');
    $this->order
      ->save();

    // Create a partial invoice which contains an invoice item with a quantity
    // of 1.

    /** @var \Drupal\commerce_invoice\Entity\InvoiceItemInterface $invoice_item */
    $invoice_item = InvoiceItem::create([
      'type' => 'default',
    ]);
    $invoice_item
      ->populateFromOrderItem($order_item);
    $invoice_item
      ->setQuantity(1);
    $invoice_item
      ->save();
    $invoice = Invoice::create([
      'type' => 'default',
      'store_id' => $this->store
        ->id(),
      'invoice_items' => [
        $invoice_item,
      ],
      'orders' => [
        $this->order,
      ],
    ]);
    $invoice
      ->save();

    // Check that access is still allowed to add invoices this order, since the
    // order contains an extra quantity of 2 for its order item, and the
    // adjustment.
    $access = $this->accessChecker
      ->access($this
      ->getRoute(), $this
      ->getRouteMatch($this->order), $this
      ->getAccount());
    $this
      ->assertTrue($access
      ->isAllowed());

    // Create another partial invoice containing an invoice item with a quantity
    // of 1.
    $invoice_item = InvoiceItem::create([
      'type' => 'default',
    ]);
    $invoice_item
      ->populateFromOrderItem($order_item);
    $invoice_item
      ->setQuantity(1);
    $invoice_item
      ->save();
    $invoice = Invoice::create([
      'type' => 'default',
      'store_id' => $this->store
        ->id(),
      'invoice_items' => [
        $invoice_item,
      ],
      'orders' => [
        $this->order,
      ],
    ]);
    $invoice
      ->save();

    // Check that access is still allowed to add invoices for this order, since
    // the order contains an extra quantity of 1 for its order item, and the
    // adjustment.
    $access = $this->accessChecker
      ->access($this
      ->getRoute(), $this
      ->getRouteMatch($this->order), $this
      ->getAccount());
    $this
      ->assertTrue($access
      ->isAllowed());

    // Create a "final" partial invoice containing an invoice item with the
    // remaining quantity of 1, as well as the adjustment.
    $invoice_item = InvoiceItem::create([
      'type' => 'default',
    ]);
    $invoice_item
      ->populateFromOrderItem($order_item);
    $invoice_item
      ->setQuantity(1);
    $invoice_item
      ->save();
    $invoice = Invoice::create([
      'type' => 'default',
      'store_id' => $this->store
        ->id(),
      'invoice_items' => [
        $invoice_item,
      ],
      'orders' => [
        $this->order,
      ],
      'adjustments' => [
        $adjustment,
      ],
    ]);
    $invoice
      ->save();

    // Check that access is no longer allowed to add invoices for this order,
    // since the three partial invoices now contain invoice items that match the
    // quantity of 3 of the order item, as well as the order adjustment.
    $access = $this->accessChecker
      ->access($this
      ->getRoute(), $this
      ->getRouteMatch($this->order), $this
      ->getAccount());
    $this
      ->assertFalse($access
      ->isAllowed());
  }

  /**
   * Returns a route object for the access check.
   *
   * @param bool $has_requirement
   *   TRUE if the route should have the '_invoice_generate_form_access'
   *   requirement, FALSE otherwise.
   *
   * @return \Symfony\Component\Routing\Route
   *   A test route.
   */
  protected function getRoute($has_requirement = TRUE) {
    if (!$has_requirement) {
      $route = new Route('/foo');
    }
    else {
      $route = new Route('/foo', [], [
        '_invoice_generate_form_access' => 'TRUE',
      ]);
    }
    return $route;
  }

  /**
   * Returns a user account object for the access check.
   *
   * @param bool $has_permission
   *   TRUE if the account should have the 'administer commerce_invoice'
   *   permission, FALSE otherwise.
   *
   * @return \Drupal\Core\Session\AccountInterface|object|\Prophecy\Prophecy\ProphecySubjectInterface
   *   A test user account.
   */
  protected function getAccount($has_permission = TRUE) {
    $account = $this
      ->prophesize(AccountInterface::class);
    $account
      ->hasPermission('administer commerce_invoice')
      ->willReturn($has_permission);
    return $account
      ->reveal();
  }

  /**
   * Returns a route match object for the access check.
   *
   * @param \Drupal\commerce_order\Entity\OrderInterface|null $order
   *   A commerce order entity.
   * @param \Drupal\commerce_invoice\Entity\InvoiceTypeInterface|null $invoice_type
   *   An invoice type entity.
   *
   * @return \Drupal\Core\Routing\RouteMatchInterface|object|\Prophecy\Prophecy\ProphecySubjectInterface
   *   A test route match object.
   */
  protected function getRouteMatch($order = NULL, $invoice_type = NULL) {
    if (!$order) {
      $order = $this
        ->prophesize(OrderInterface::class)
        ->reveal();
    }
    if (!$invoice_type) {
      $invoice_type = $this
        ->prophesize(InvoiceTypeInterface::class);
      $invoice_type
        ->id()
        ->willReturn('default');
      $invoice_type = $invoice_type
        ->reveal();
    }

    /** @var \Drupal\Core\Routing\RouteMatchInterface|\Prophecy\Prophecy\ObjectProphecy $route_match */
    $route_match = $this
      ->prophesize(RouteMatchInterface::class);
    $route_match
      ->getRawParameter('commerce_order')
      ->willReturn($order
      ->id());
    $route_match
      ->getParameter('commerce_order')
      ->willReturn($order);
    $route_match
      ->getRawParameter('commerce_invoice_type')
      ->willReturn($invoice_type
      ->id());
    $route_match
      ->getParameter('commerce_invoice_type')
      ->willReturn($invoice_type);
    return $route_match
      ->reveal();
  }

}

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.
InvoiceKernelTestBase::register public function Registers test-specific services. Overrides KernelTestBase::register
InvoiceOrderAccessCheckTest::$accessChecker protected property
InvoiceOrderAccessCheckTest::getAccount protected function Returns a user account object for the access check.
InvoiceOrderAccessCheckTest::getRoute protected function Returns a route object for the access check.
InvoiceOrderAccessCheckTest::getRouteMatch protected function Returns a route match object for the access check.
InvoiceOrderAccessCheckTest::setUp protected function Overrides OrderIntegrationTest::setUp
InvoiceOrderAccessCheckTest::testAccessForDraftOrders public function @covers ::access
InvoiceOrderAccessCheckTest::testAccessWithoutPermission public function @covers ::access
InvoiceOrderAccessCheckTest::testAccessWithPartialInvoices public function @covers ::access
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::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.
OrderIntegrationTest::$invoiceStorage protected property The invoice storage.
OrderIntegrationTest::$modules public static property Modules to enable. Overrides InvoiceKernelTestBase::$modules
OrderIntegrationTest::$order protected property A sample order.
OrderIntegrationTest::testPaid public function Tests that the invoice total paid is updated when an order is paid.
OrderIntegrationTest::testPlace public function Tests that an invoice is generated when an order is placed.
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.
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