class EntityFormDisplayAccessControlHandlerTest in Drupal 8

@coversDefaultClass \Drupal\Core\Entity\Entity\Access\EntityFormDisplayAccessControlHandler @group Entity

Hierarchy

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

File

core/tests/Drupal/Tests/Core/Entity/Access/EntityFormDisplayAccessControlHandlerTest.php, line 27

Namespace

Drupal\Tests\Core\Entity\Access

class EntityFormDisplayAccessControlHandlerTest extends UnitTestCase {

  /**
   * The field storage config access controller to test.
   *
   * @var \Drupal\field\FieldStorageConfigAccessControlHandler
   */
  protected $accessControlHandler;

  /**
   * The mock module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The mock account without field storage config access.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $anon;

  /**
   * The mock account with EntityFormDisplay access.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $member;

  /**
   * The mock account with EntityFormDisplay access via parent access check.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $parent_member;

  /**
   * The EntityFormDisplay entity used for testing.
   *
   * @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface
   */
  protected $entity;

  /**
   * Returns a mock Entity Type Manager.
   *
   * @return \Drupal\Core\Entity\EntityTypeManagerInterface
   *   The mocked entity type manager.
   */
  protected function getEntityTypeManager() {
    $entity_type_manager = $this
      ->prophesize(EntityTypeManagerInterface::class);
    return $entity_type_manager
      ->reveal();
  }

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->anon = $this
      ->createMock(AccountInterface::class);
    $this->anon
      ->expects($this
      ->any())
      ->method('hasPermission')
      ->will($this
      ->returnValue(FALSE));
    $this->anon
      ->expects($this
      ->any())
      ->method('id')
      ->will($this
      ->returnValue(0));
    $this->member = $this
      ->createMock(AccountInterface::class);
    $this->member
      ->expects($this
      ->any())
      ->method('hasPermission')
      ->will($this
      ->returnValueMap([
      [
        'administer foobar form display',
        TRUE,
      ],
    ]));
    $this->member
      ->expects($this
      ->any())
      ->method('id')
      ->will($this
      ->returnValue(2));
    $this->parent_member = $this
      ->createMock(AccountInterface::class);
    $this->parent_member
      ->expects($this
      ->any())
      ->method('hasPermission')
      ->will($this
      ->returnValueMap([
      [
        'Llama',
        TRUE,
      ],
    ]));
    $this->parent_member
      ->expects($this
      ->any())
      ->method('id')
      ->will($this
      ->returnValue(3));
    $entity_form_display_entity_type = $this
      ->createMock(ConfigEntityTypeInterface::class);
    $entity_form_display_entity_type
      ->expects($this
      ->any())
      ->method('getAdminPermission')
      ->will($this
      ->returnValue('Llama'));
    $entity_form_display_entity_type
      ->expects($this
      ->any())
      ->method('getKey')
      ->will($this
      ->returnValueMap([
      [
        'langcode',
        'langcode',
      ],
    ]));
    $entity_form_display_entity_type
      ->expects($this
      ->any())
      ->method('entityClassImplements')
      ->will($this
      ->returnValue(TRUE));
    $entity_form_display_entity_type
      ->expects($this
      ->any())
      ->method('getConfigPrefix')
      ->willReturn('');
    $this->moduleHandler = $this
      ->createMock(ModuleHandlerInterface::class);
    $this->moduleHandler
      ->expects($this
      ->any())
      ->method('getImplementations')
      ->will($this
      ->returnValue([]));
    $this->moduleHandler
      ->expects($this
      ->any())
      ->method('invokeAll')
      ->will($this
      ->returnValue([]));
    $storage_access_control_handler = new EntityFormDisplayAccessControlHandler($entity_form_display_entity_type);
    $storage_access_control_handler
      ->setModuleHandler($this->moduleHandler);
    $entity_type_manager = $this
      ->createMock(EntityTypeManagerInterface::class);
    $entity_type_manager
      ->expects($this
      ->any())
      ->method('getStorage')
      ->willReturnMap([
      [
        'entity_display',
        $this
          ->createMock(EntityStorageInterface::class),
      ],
    ]);
    $entity_type_manager
      ->expects($this
      ->any())
      ->method('getAccessControlHandler')
      ->willReturnMap([
      [
        'entity_display',
        $storage_access_control_handler,
      ],
    ]);
    $entity_type_manager
      ->expects($this
      ->any())
      ->method('getDefinition')
      ->will($this
      ->returnValue($entity_form_display_entity_type));
    $entity_field_manager = $this
      ->createMock(EntityFieldManagerInterface::class);
    $entity_field_manager
      ->expects($this
      ->any())
      ->method('getFieldDefinitions')
      ->will($this
      ->returnValue([]));
    $container = new Container();
    $container
      ->set('entity_type.manager', $entity_type_manager);
    $container
      ->set('entity_field.manager', $entity_field_manager);
    $container
      ->set('language_manager', $this
      ->createMock(LanguageManagerInterface::class));
    $container
      ->set('plugin.manager.field.widget', $this
      ->prophesize(PluginManagerInterface::class));
    $container
      ->set('plugin.manager.field.field_type', $this
      ->createMock(FieldTypePluginManagerInterface::class));
    $container
      ->set('plugin.manager.field.formatter', $this
      ->prophesize(FormatterPluginManager::class));
    $container
      ->set('uuid', $this
      ->createMock(UuidInterface::class));
    $container
      ->set('renderer', $this
      ->createMock(RendererInterface::class));
    $container
      ->set('cache_contexts_manager', $this
      ->prophesize(CacheContextsManager::class));
    \Drupal::setContainer($container);
    $this->entity = new EntityFormDisplay([
      'targetEntityType' => 'foobar',
      'bundle' => 'bazqux',
      'mode' => 'default',
      'id' => 'foobar.bazqux.default',
      'uuid' => '6f2f259a-f3c7-42ea-bdd5-111ad1f85ed1',
    ], 'entity_display');
    $this->accessControlHandler = $storage_access_control_handler;
  }

  /**
   * Assert method to verify the access by operations.
   *
   * @param array $allow_operations
   *   A list of allowed operations.
   * @param \Drupal\Core\Session\AccountInterface $user
   *   The account to use for get access.
   */
  public function assertAllowOperations(array $allow_operations, AccountInterface $user) {
    foreach ([
      'view',
      'update',
      'delete',
    ] as $operation) {
      $expected = in_array($operation, $allow_operations);
      $actual = $this->accessControlHandler
        ->access($this->entity, $operation, $user);
      $this
        ->assertSame($expected, $actual, "Access problem with '{$operation}' operation.");
    }
  }

  /**
   * @covers ::access
   * @covers ::checkAccess
   */
  public function testAccess() {
    $this
      ->assertAllowOperations([], $this->anon);
    $this
      ->assertAllowOperations([
      'view',
      'update',
      'delete',
    ], $this->member);
    $this
      ->assertAllowOperations([
      'view',
      'update',
      'delete',
    ], $this->parent_member);
    $this->entity
      ->enforceIsNew(TRUE)
      ->save();

    // Unfortunately, EntityAccessControlHandler has a static cache, which we
    // therefore must reset manually.
    $this->accessControlHandler
      ->resetCache();
    $this
      ->assertAllowOperations([], $this->anon);
    $this
      ->assertAllowOperations([
      'view',
      'update',
    ], $this->member);
    $this
      ->assertAllowOperations([
      'view',
      'update',
    ], $this->parent_member);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityFormDisplayAccessControlHandlerTest::$accessControlHandler	protected	property	The field storage config access controller to test.
EntityFormDisplayAccessControlHandlerTest::$anon	protected	property	The mock account without field storage config access.
EntityFormDisplayAccessControlHandlerTest::$entity	protected	property	The EntityFormDisplay entity used for testing.
EntityFormDisplayAccessControlHandlerTest::$member	protected	property	The mock account with EntityFormDisplay access.
EntityFormDisplayAccessControlHandlerTest::$moduleHandler	protected	property	The mock module handler.
EntityFormDisplayAccessControlHandlerTest::$parent_member	protected	property	The mock account with EntityFormDisplay access via parent access check.
EntityFormDisplayAccessControlHandlerTest::assertAllowOperations	public	function	Assert method to verify the access by operations.
EntityFormDisplayAccessControlHandlerTest::getEntityTypeManager	protected	function	Returns a mock Entity Type Manager.
EntityFormDisplayAccessControlHandlerTest::setUp	protected	function	Overrides UnitTestCase::setUp	1
EntityFormDisplayAccessControlHandlerTest::testAccess	public	function	@covers ::access @covers ::checkAccess
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.