class EntityAccessCheckTest in Drupal 8

Unit test of entity access checking system.

@coversDefaultClass \Drupal\Core\Entity\EntityAccessCheck

@group Access @group Entity

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\Core\Entity\EntityAccessCheckTest

File

core/tests/Drupal/Tests/Core/Entity/EntityAccessCheckTest.php, line 26

Namespace

Drupal\Tests\Core\Entity

class EntityAccessCheckTest extends UnitTestCase {

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    $cache_contexts_manager = $this
      ->prophesize(CacheContextsManager::class)
      ->reveal();
    $container = new Container();
    $container
      ->set('cache_contexts_manager', $cache_contexts_manager);
    \Drupal::setContainer($container);
  }

  /**
   * Tests the method for checking access to routes.
   */
  public function testAccess() {
    $route = new Route('/foo/{var_name}', [], [
      '_entity_access' => 'var_name.update',
    ], [
      'parameters' => [
        'var_name' => [
          'type' => 'entity:node',
        ],
      ],
    ]);

    /** @var \Drupal\Core\Session\AccountInterface $account */
    $account = $this
      ->prophesize(AccountInterface::class)
      ->reveal();

    /** @var \Drupal\node\NodeInterface|\Prophecy\Prophecy\ObjectProphecy $route_match */
    $node = $this
      ->prophesize(NodeInterface::class);
    $node
      ->access('update', $account, TRUE)
      ->willReturn(AccessResult::allowed());
    $node = $node
      ->reveal();

    /** @var \Drupal\Core\Routing\RouteMatchInterface|\Prophecy\Prophecy\ObjectProphecy $route_match */
    $route_match = $this
      ->prophesize(RouteMatchInterface::class);
    $route_match
      ->getRawParameters()
      ->willReturn(new ParameterBag([
      'var_name' => 1,
    ]));
    $route_match
      ->getParameters()
      ->willReturn(new ParameterBag([
      'var_name' => $node,
    ]));
    $route_match = $route_match
      ->reveal();
    $access_check = new EntityAccessCheck();
    $this
      ->assertEquals(AccessResult::allowed(), $access_check
      ->access($route, $route_match, $account));
  }

  /**
   * @covers ::access
   */
  public function testAccessWithTypePlaceholder() {
    $route = new Route('/foo/{entity_type}/{var_name}', [], [
      '_entity_access' => 'var_name.update',
    ], [
      'parameters' => [
        'var_name' => [
          'type' => 'entity:{entity_type}',
        ],
      ],
    ]);

    /** @var \Drupal\Core\Session\AccountInterface $account */
    $account = $this
      ->prophesize(AccountInterface::class)
      ->reveal();

    /** @var \Drupal\node\NodeInterface|\Prophecy\Prophecy\ObjectProphecy $node */
    $node = $this
      ->prophesize(NodeInterface::class);
    $node
      ->access('update', $account, TRUE)
      ->willReturn(AccessResult::allowed());
    $node = $node
      ->reveal();

    /** @var \Drupal\Core\Routing\RouteMatchInterface|\Prophecy\Prophecy\ObjectProphecy $route_match */
    $route_match = $this
      ->createRouteMatchForObject($node);
    $access_check = new EntityAccessCheck();
    $this
      ->assertEquals(AccessResult::allowed(), $access_check
      ->access($route, $route_match, $account));
  }

  /**
   * @covers ::access
   */
  public function testAccessWithDifferentRouteParameters() {
    $route = new Route('/foo/{var_name}', [], [
      '_entity_access' => 'var_name.update',
    ], [
      'parameters' => [
        'var_name' => [
          'type' => 'entity:node',
        ],
      ],
    ]);

    /** @var \Drupal\Core\Session\AccountInterface $account */
    $account = $this
      ->prophesize(AccountInterface::class)
      ->reveal();
    $access_check = new EntityAccessCheck();

    // Confirm an EntityInterface route parameter's ::access() is called.

    /** @var \Drupal\Core\Entity\EntityInterface|\Prophecy\Prophecy\ObjectProphecy $node */
    $node = $this
      ->prophesize(EntityInterface::class);
    $node
      ->access('update', $account, TRUE)
      ->willReturn(AccessResult::allowed());
    $route_match = $this
      ->createRouteMatchForObject($node
      ->reveal());
    $this
      ->assertEquals(AccessResult::allowed(), $access_check
      ->access($route, $route_match, $account));

    // AccessibleInterface is not entity-like: ::access() should not be called.

    /** @var \Drupal\Core\Access\AccessibleInterface|\Prophecy\Prophecy\ObjectProphecy $node */
    $node = $this
      ->prophesize(AccessibleInterface::class);
    $node
      ->access('update', $account, TRUE)
      ->willReturn(AccessResult::allowed());
    $route_match = $this
      ->createRouteMatchForObject($node
      ->reveal());
    $this
      ->assertEquals(AccessResult::neutral(), $access_check
      ->access($route, $route_match, $account));
  }

  /**
   * Wrap any object with a route match, and return that.
   *
   * @param object $object
   *   Any object, including prophesized mocks based on interfaces.
   *
   * @return \Drupal\Core\Routing\RouteMatchInterface
   *   A prophesized RouteMatchInterface.
   */
  private function createRouteMatchForObject(\stdClass $object) {
    $route_match = $this
      ->prophesize(RouteMatchInterface::class);
    $route_match
      ->getRawParameters()
      ->willReturn(new ParameterBag([
      'entity_type' => 'node',
      'var_name' => 1,
    ]));
    $route_match
      ->getParameters()
      ->willReturn(new ParameterBag([
      'entity_type' => 'node',
      'var_name' => $object,
    ]));
    return $route_match
      ->reveal();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityAccessCheckTest::createRouteMatchForObject	private	function	Wrap any object with a route match, and return that.
EntityAccessCheckTest::setUp	protected	function	Overrides UnitTestCase::setUp
EntityAccessCheckTest::testAccess	public	function	Tests the method for checking access to routes.
EntityAccessCheckTest::testAccessWithDifferentRouteParameters	public	function	@covers ::access
EntityAccessCheckTest::testAccessWithTypePlaceholder	public	function	@covers ::access
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.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated	protected	function	Mocks a block with a block plugin.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.