MenuAccessControlHandlerTest.php in Drupal 9

Namespace

Drupal\Tests\system\Kernel

File

core/modules/system/tests/src/Kernel/MenuAccessControlHandlerTest.php

<?php

namespace Drupal\Tests\system\Kernel;

use Drupal\Core\Access\AccessResult;
use Drupal\Core\Cache\Context\CacheContextsManager;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\KernelTests\KernelTestBase;
use Drupal\system\Entity\Menu;
use Drupal\Tests\user\Traits\UserCreationTrait;

/**
 * @coversDefaultClass \Drupal\system\MenuAccessControlHandler
 * @group system
 */
class MenuAccessControlHandlerTest extends KernelTestBase {
  use UserCreationTrait {
    createUser as drupalCreateUser;
  }

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'system',
    'user',
  ];

  /**
   * The menu access control handler.
   *
   * @var \Drupal\Core\Entity\EntityAccessControlHandlerInterface
   */
  protected $accessControlHandler;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->installEntitySchema('menu');
    $this
      ->installEntitySchema('user');
    $this
      ->installSchema('system', 'sequences');
    $this->accessControlHandler = $this->container
      ->get('entity_type.manager')
      ->getAccessControlHandler('menu');
  }

  /**
   * @covers ::checkAccess
   * @covers ::checkCreateAccess
   * @dataProvider testAccessProvider
   */
  public function testAccess($which_user, $which_entity, $view_label_access_result, $view_access_result, $update_access_result, $delete_access_result, $create_access_result) {

    // We must always create user 1, so that a "normal" user has an ID >1.
    $root_user = $this
      ->drupalCreateUser();
    if ($which_user === 'user1') {
      $user = $root_user;
    }
    else {
      $permissions = $which_user === 'admin' ? [
        'administer menu',
      ] : [];
      $user = $this
        ->drupalCreateUser($permissions);
    }
    $entity_values = $which_entity === 'unlocked' ? [
      'locked' => FALSE,
    ] : [
      'locked' => TRUE,
    ];
    $entity_values['id'] = 'llama';
    $entity = Menu::create($entity_values);
    $entity
      ->save();
    static::assertEquals($view_label_access_result, $this->accessControlHandler
      ->access($entity, 'view label', $user, TRUE));
    static::assertEquals($view_access_result, $this->accessControlHandler
      ->access($entity, 'view', $user, TRUE));
    static::assertEquals($update_access_result, $this->accessControlHandler
      ->access($entity, 'update', $user, TRUE));
    static::assertEquals($delete_access_result, $this->accessControlHandler
      ->access($entity, 'delete', $user, TRUE));
    static::assertEquals($create_access_result, $this->accessControlHandler
      ->createAccess(NULL, $user, [], TRUE));
  }
  public function testAccessProvider() {
    $c = new ContainerBuilder();
    $cache_contexts_manager = $this
      ->prophesize(CacheContextsManager::class);
    $cache_contexts_manager
      ->assertValidTokens()
      ->willReturn(TRUE);
    $cache_contexts_manager
      ->reveal();
    $c
      ->set('cache_contexts_manager', $cache_contexts_manager);
    \Drupal::setContainer($c);
    return [
      'permissionless + unlocked' => [
        'permissionless',
        'unlocked',
        AccessResult::allowed(),
        AccessResult::neutral()
          ->addCacheContexts([
          'user.permissions',
        ])
          ->setReason("The 'administer menu' permission is required."),
        AccessResult::neutral()
          ->addCacheContexts([
          'user.permissions',
        ])
          ->setReason("The 'administer menu' permission is required."),
        AccessResult::neutral()
          ->addCacheContexts([
          'user.permissions',
        ])
          ->setReason("The 'administer menu' permission is required.")
          ->addCacheTags([
          'config:system.menu.llama',
        ]),
        AccessResult::neutral()
          ->addCacheContexts([
          'user.permissions',
        ])
          ->setReason("The 'administer menu' permission is required."),
      ],
      'permissionless + locked' => [
        'permissionless',
        'locked',
        AccessResult::allowed(),
        AccessResult::neutral()
          ->addCacheContexts([
          'user.permissions',
        ])
          ->setReason("The 'administer menu' permission is required."),
        AccessResult::neutral()
          ->addCacheContexts([
          'user.permissions',
        ])
          ->setReason("The 'administer menu' permission is required."),
        AccessResult::forbidden()
          ->addCacheTags([
          'config:system.menu.llama',
        ])
          ->setReason("The Menu config entity is locked."),
        AccessResult::neutral()
          ->addCacheContexts([
          'user.permissions',
        ])
          ->setReason("The 'administer menu' permission is required."),
      ],
      'admin + unlocked' => [
        'admin',
        'unlocked',
        AccessResult::allowed(),
        AccessResult::allowed()
          ->addCacheContexts([
          'user.permissions',
        ]),
        AccessResult::allowed()
          ->addCacheContexts([
          'user.permissions',
        ]),
        AccessResult::allowed()
          ->addCacheContexts([
          'user.permissions',
        ])
          ->addCacheTags([
          'config:system.menu.llama',
        ]),
        AccessResult::allowed()
          ->addCacheContexts([
          'user.permissions',
        ]),
      ],
      'admin + locked' => [
        'admin',
        'locked',
        AccessResult::allowed(),
        AccessResult::allowed()
          ->addCacheContexts([
          'user.permissions',
        ]),
        AccessResult::allowed()
          ->addCacheContexts([
          'user.permissions',
        ]),
        AccessResult::forbidden()
          ->addCacheTags([
          'config:system.menu.llama',
        ])
          ->setReason("The Menu config entity is locked."),
        AccessResult::allowed()
          ->addCacheContexts([
          'user.permissions',
        ]),
      ],
      'user1 + unlocked' => [
        'user1',
        'unlocked',
        AccessResult::allowed(),
        AccessResult::allowed()
          ->addCacheContexts([
          'user.permissions',
        ]),
        AccessResult::allowed()
          ->addCacheContexts([
          'user.permissions',
        ]),
        AccessResult::allowed()
          ->addCacheContexts([
          'user.permissions',
        ])
          ->addCacheTags([
          'config:system.menu.llama',
        ]),
        AccessResult::allowed()
          ->addCacheContexts([
          'user.permissions',
        ]),
      ],
      'user1 + locked' => [
        'user1',
        'locked',
        AccessResult::allowed(),
        AccessResult::allowed()
          ->addCacheContexts([
          'user.permissions',
        ]),
        AccessResult::allowed()
          ->addCacheContexts([
          'user.permissions',
        ]),
        AccessResult::forbidden()
          ->addCacheTags([
          'config:system.menu.llama',
        ])
          ->setReason("The Menu config entity is locked."),
        AccessResult::allowed()
          ->addCacheContexts([
          'user.permissions',
        ]),
      ],
    ];
  }

}

Classes

Name	Description
MenuAccessControlHandlerTest	@coversDefaultClass \Drupal\system\MenuAccessControlHandler @group system