class EntityBundleAccessCheckTest in Drupal 9

Unit test of entity access checking system.

@coversDefaultClass \Drupal\Core\Entity\EntityBundleAccessCheck

@group Access @group Entity @group legacy

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, PhpUnitCompatibilityTrait, PhpUnitWarnings
  • class \Drupal\Tests\Core\Entity\EntityBundleAccessCheckTest

File

core/tests/Drupal/Tests/Core/Entity/EntityBundleAccessCheckTest.php, line 25

Namespace

Drupal\Tests\Core\Entity

class EntityBundleAccessCheckTest extends UnitTestCase {

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

  /**
   * Data provider.
   */
  public function getBundleAndAccessResult() {
    return [
      [
        'article',
        'node:article',
        AccessResult::allowed(),
      ],
      [
        'page',
        'node:article',
        AccessResult::neutral('The entity bundle does not match the route _entity_bundles requirement.'),
      ],
      [
        'page',
        'node:article|page',
        AccessResult::allowed(),
      ],
      [
        'article',
        'node:article|page',
        AccessResult::allowed(),
      ],
      [
        'book_page',
        'node:article|page',
        AccessResult::neutral('The entity bundle does not match the route _entity_bundles requirement.'),
      ],
    ];
  }

  /**
   * @covers ::access
   *
   * @dataProvider getBundleAndAccessResult
   */
  public function testRouteAccess($bundle, $access_requirement, $access_result) {
    $route = new Route('/foo/{node}', [], [
      '_entity_bundles' => $access_requirement,
    ], [
      'parameters' => [
        'node' => [
          'type' => 'entity:node',
        ],
      ],
    ]);

    /** @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
      ->bundle()
      ->willReturn($bundle);
    $node
      ->getCacheContexts()
      ->willReturn([]);
    $node
      ->getCacheTags()
      ->willReturn([]);
    $node
      ->getCacheMaxAge()
      ->willReturn(-1);
    $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([
      'node' => 1,
    ]));
    $route_match
      ->getParameters()
      ->willReturn(new ParameterBag([
      'node' => $node,
    ]));
    $route_match = $route_match
      ->reveal();
    $access_check = new EntityBundleAccessCheck();
    $this
      ->expectDeprecation('The Drupal\\Core\\Entity\\EntityBundleAccessCheck is deprecated in drupal:9.2.0 and is removed from drupal:10.0.0. Specify the list of bundles in the entity parameter, under "bundle" key, as a sequence, instead. See https://www.drupal.org/node/3155569');
    $this
      ->assertEquals($access_result, $access_check
      ->access($route, $route_match, $account));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityBundleAccessCheckTest::getBundleAndAccessResult	public	function	Data provider.
EntityBundleAccessCheckTest::setUp	protected	function	Overrides UnitTestCase::setUp
EntityBundleAccessCheckTest::testRouteAccess	public	function	@covers ::access
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals Deprecated	protected	function	Asserts if two arrays are equal by sorting them first.
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.
UnitTestCase::setUpBeforeClass	public static	function