class PermissionAccessCheckTest in Drupal 9

@coversDefaultClass \Drupal\user\Access\PermissionAccessCheck @group Routing @group Access

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, PhpUnitCompatibilityTrait, PhpUnitWarnings
  • class \Drupal\Tests\user\Unit\PermissionAccessCheckTest

File

core/modules/user/tests/src/Unit/PermissionAccessCheckTest.php, line 17

Namespace

Drupal\Tests\user\Unit

class PermissionAccessCheckTest extends UnitTestCase {

  /**
   * The tested access checker.
   *
   * @var \Drupal\user\Access\PermissionAccessCheck
   */
  public $accessCheck;

  /**
   * The dependency injection container.
   *
   * @var \Symfony\Component\DependencyInjection\ContainerBuilder
   */
  protected $container;

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

  /**
   * Provides data for the testAccess method.
   *
   * @return array
   */
  public function providerTestAccess() {
    return [
      [
        [],
        FALSE,
      ],
      [
        [
          '_permission' => 'allowed',
        ],
        TRUE,
        [
          'user.permissions',
        ],
      ],
      [
        [
          '_permission' => 'denied',
        ],
        FALSE,
        [
          'user.permissions',
        ],
        "The 'denied' permission is required.",
      ],
      [
        [
          '_permission' => 'allowed+denied',
        ],
        TRUE,
        [
          'user.permissions',
        ],
      ],
      [
        [
          '_permission' => 'allowed+denied+other',
        ],
        TRUE,
        [
          'user.permissions',
        ],
      ],
      [
        [
          '_permission' => 'allowed,denied',
        ],
        FALSE,
        [
          'user.permissions',
        ],
        "The following permissions are required: 'allowed' AND 'denied'.",
      ],
    ];
  }

  /**
   * Tests the access check method.
   *
   * @dataProvider providerTestAccess
   * @covers ::access
   */
  public function testAccess($requirements, $access, array $contexts = [], $message = '') {
    $access_result = AccessResult::allowedIf($access)
      ->addCacheContexts($contexts);
    if (!empty($message)) {
      $access_result
        ->setReason($message);
    }
    $user = $this
      ->createMock('Drupal\\Core\\Session\\AccountInterface');
    $user
      ->expects($this
      ->any())
      ->method('hasPermission')
      ->willReturnMap([
      [
        'allowed',
        TRUE,
      ],
      [
        'denied',
        FALSE,
      ],
      [
        'other',
        FALSE,
      ],
    ]);
    $route = new Route('', [], $requirements);
    $this
      ->assertEquals($access_result, $this->accessCheck
      ->access($route, $user));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PermissionAccessCheckTest::$accessCheck	public	property	The tested access checker.
PermissionAccessCheckTest::$container	protected	property	The dependency injection container.
PermissionAccessCheckTest::providerTestAccess	public	function	Provides data for the testAccess method.
PermissionAccessCheckTest::setUp	protected	function	Overrides UnitTestCase::setUp
PermissionAccessCheckTest::testAccess	public	function	Tests the access check method.
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