DateFormatAccessControlHandlerTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\system\Kernel;

use Drupal\Core\Access\AccessResult;
use Drupal\Core\Cache\Context\CacheContextsManager;
use Drupal\Core\Datetime\Entity\DateFormat;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\KernelTests\KernelTestBase;
use Drupal\Tests\user\Traits\UserCreationTrait;
use Prophecy\Prophet;

/**
 * @coversDefaultClass \Drupal\system\DateFormatAccessControlHandler
 * @group system
 */
class DateFormatAccessControlHandlerTest extends KernelTestBase {
  use UserCreationTrait {
    createUser as drupalCreateUser;
  }
  
  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'system',
    'user',
  ];
  
  /**
   * The date_format access control handler.
   *
   * @var \Drupal\Core\Entity\EntityAccessControlHandlerInterface
   */
  protected $accessControlHandler;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->installEntitySchema('user');
    $this->accessControlHandler = $this->container
      ->get('entity_type.manager')
      ->getAccessControlHandler('date_format');
  }
  
  /**
   * @covers ::checkAccess
   * @covers ::checkCreateAccess
   * @dataProvider providerTestAccess
   */
  public function testAccess($permissions, $which_entity, $view_label_access_result, $view_access_result, $update_access_result, $delete_access_result, $create_access_result) : void {
    $user = $this->drupalCreateUser($permissions);
    $entity_values = $which_entity === 'unlocked' ? [
      'locked' => FALSE,
    ] : [
      'locked' => TRUE,
    ];
    $entity_values['id'] = $entity_values['label'] = $this->randomMachineName();
    $entity_values['pattern'] = 'Y-m-d';
    $entity = DateFormat::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));
  }
  
  /**
   * Provides test cases for access control based on user permissions and entity lock status.
   *
   * @return array
   *   An array of test cases.
   */
  public static function providerTestAccess() : array {
    $originalContainer = \Drupal::hasContainer() ? \Drupal::getContainer() : NULL;
    $c = new ContainerBuilder();
    $cache_contexts_manager = (new Prophet())->prophesize(CacheContextsManager::class);
    $cache_contexts_manager->assertValidTokens()
      ->willReturn(TRUE);
    $cache_contexts_manager->reveal();
    $c->set('cache_contexts_manager', $cache_contexts_manager);
    \Drupal::setContainer($c);
    $data = [
      'No permission + unlocked' => [
        [],
        'unlocked',
        AccessResult::allowed(),
        AccessResult::neutral()->addCacheContexts([
          'user.permissions',
        ])
          ->setReason("The 'administer site configuration' permission is required."),
        AccessResult::neutral()->addCacheContexts([
          'user.permissions',
        ])
          ->setReason("The 'administer site configuration' permission is required.")
          ->addCacheTags([
          'rendered',
        ]),
        AccessResult::neutral()->addCacheContexts([
          'user.permissions',
        ])
          ->setReason("The 'administer site configuration' permission is required.")
          ->addCacheTags([
          'rendered',
        ]),
        AccessResult::neutral()->addCacheContexts([
          'user.permissions',
        ])
          ->setReason("The 'administer site configuration' permission is required."),
      ],
      'no permission + locked' => [
        [],
        'locked',
        AccessResult::allowed(),
        AccessResult::neutral()->addCacheContexts([
          'user.permissions',
        ])
          ->setReason("The 'administer site configuration' permission is required."),
        AccessResult::forbidden()->addCacheTags([
          'rendered',
        ])
          ->setReason("The DateFormat config entity is locked."),
        AccessResult::forbidden()->addCacheTags([
          'rendered',
        ])
          ->setReason("The DateFormat config entity is locked."),
        AccessResult::neutral()->addCacheContexts([
          'user.permissions',
        ])
          ->setReason("The 'administer site configuration' permission is required."),
      ],
      'admin + unlocked' => [
        [
          'administer site configuration',
        ],
        'unlocked',
        AccessResult::allowed(),
        AccessResult::allowed()->addCacheContexts([
          'user.permissions',
        ]),
        AccessResult::allowed()->addCacheContexts([
          'user.permissions',
        ])
          ->addCacheTags([
          'rendered',
        ]),
        AccessResult::allowed()->addCacheContexts([
          'user.permissions',
        ])
          ->addCacheTags([
          'rendered',
        ]),
        AccessResult::allowed()->addCacheContexts([
          'user.permissions',
        ]),
      ],
      'admin + locked' => [
        [
          'administer site configuration',
        ],
        'locked',
        AccessResult::allowed(),
        AccessResult::allowed()->addCacheContexts([
          'user.permissions',
        ]),
        AccessResult::forbidden()->addCacheTags([
          'rendered',
        ])
          ->setReason("The DateFormat config entity is locked."),
        AccessResult::forbidden()->addCacheTags([
          'rendered',
        ])
          ->setReason("The DateFormat config entity is locked."),
        AccessResult::allowed()->addCacheContexts([
          'user.permissions',
        ]),
      ],
    ];
    // Restore the original container if needed.
    if ($originalContainer) {
      \Drupal::setContainer($originalContainer);
    }
    return $data;
  }

}