Commit 3a6bbc8c authored by catch's avatar catch

Issue #2843772 by Wim Leers, arshadcn: EntityResource: Provide comprehensive...

Issue #2843772 by Wim Leers, arshadcn: EntityResource: Provide comprehensive test coverage for DateFormat entity
parent 3958a93e
<?php
namespace Drupal\Tests\hal\Functional\EntityResource\DateFormat;
use Drupal\Tests\rest\Functional\AnonResourceTestTrait;
use Drupal\Tests\rest\Functional\EntityResource\DateFormat\DateFormatResourceTestBase;
/**
* @group hal
*/
class DateFormatHalJsonAnonTest extends DateFormatResourceTestBase {
use AnonResourceTestTrait;
/**
* {@inheritdoc}
*/
public static $modules = ['hal'];
/**
* {@inheritdoc}
*/
protected static $format = 'hal_json';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'application/hal+json';
}
<?php
namespace Drupal\Tests\hal\Functional\EntityResource\DateFormat;
use Drupal\Tests\rest\Functional\BasicAuthResourceTestTrait;
use Drupal\Tests\rest\Functional\EntityResource\DateFormat\DateFormatResourceTestBase;
/**
* @group hal
*/
class DateFormatHalJsonBasicAuthTest extends DateFormatResourceTestBase {
use BasicAuthResourceTestTrait;
/**
* {@inheritdoc}
*/
public static $modules = ['hal', 'basic_auth'];
/**
* {@inheritdoc}
*/
protected static $format = 'hal_json';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'application/hal+json';
/**
* {@inheritdoc}
*/
protected static $auth = 'basic_auth';
}
<?php
namespace Drupal\Tests\hal\Functional\EntityResource\DateFormat;
use Drupal\Tests\rest\Functional\CookieResourceTestTrait;
use Drupal\Tests\rest\Functional\EntityResource\DateFormat\DateFormatResourceTestBase;
/**
* @group hal
*/
class DateFormatHalJsonCookieTest extends DateFormatResourceTestBase {
use CookieResourceTestTrait;
/**
* {@inheritdoc}
*/
public static $modules = ['hal'];
/**
* {@inheritdoc}
*/
protected static $format = 'hal_json';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'application/hal+json';
/**
* {@inheritdoc}
*/
protected static $auth = 'cookie';
}
<?php
namespace Drupal\Tests\rest\Functional\EntityResource\DateFormat;
use Drupal\Tests\rest\Functional\AnonResourceTestTrait;
/**
* @group rest
*/
class DateFormatJsonAnonTest extends DateFormatResourceTestBase {
use AnonResourceTestTrait;
/**
* {@inheritdoc}
*/
protected static $format = 'json';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'application/json';
}
<?php
namespace Drupal\Tests\rest\Functional\EntityResource\DateFormat;
use Drupal\Tests\rest\Functional\BasicAuthResourceTestTrait;
/**
* @group rest
*/
class DateFormatJsonBasicAuthTest extends DateFormatResourceTestBase {
use BasicAuthResourceTestTrait;
/**
* {@inheritdoc}
*/
public static $modules = ['basic_auth'];
/**
* {@inheritdoc}
*/
protected static $format = 'json';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'application/json';
/**
* {@inheritdoc}
*/
protected static $auth = 'basic_auth';
}
<?php
namespace Drupal\Tests\rest\Functional\EntityResource\DateFormat;
use Drupal\Tests\rest\Functional\CookieResourceTestTrait;
/**
* @group rest
*/
class DateFormatJsonCookieTest extends DateFormatResourceTestBase {
use CookieResourceTestTrait;
/**
* {@inheritdoc}
*/
protected static $format = 'json';
/**
* {@inheritdoc}
*/
protected static $mimeType = 'application/json';
/**
* {@inheritdoc}
*/
protected static $auth = 'cookie';
}
<?php
namespace Drupal\Tests\rest\Functional\EntityResource\DateFormat;
use Drupal\Core\Datetime\Entity\DateFormat;
use Drupal\Tests\rest\Functional\EntityResource\EntityResourceTestBase;
/**
* ResourceTestBase for DateFormat entity.
*/
abstract class DateFormatResourceTestBase extends EntityResourceTestBase {
/**
* {@inheritdoc}
*/
public static $modules = [];
/**
* {@inheritdoc}
*/
protected static $entityTypeId = 'date_format';
/**
* The DateFormat entity.
*
* @var \Drupal\Core\Datetime\DateFormatInterface
*/
protected $entity;
/**
* {@inheritdoc}
*/
protected function setUpAuthorization($method) {
$this->grantPermissionsToTestedRole(['administer site configuration']);
}
/**
* {@inheritdoc}
*/
protected function createEntity() {
// Create a date format.
$date_format = DateFormat::create([
'id' => 'llama',
'label' => 'Llama',
'pattern' => 'F d, Y',
]);
$date_format->save();
return $date_format;
}
/**
* {@inheritdoc}
*/
protected function getExpectedNormalizedEntity() {
return [
'dependencies' => [],
'id' => 'llama',
'label' => 'Llama',
'langcode' => 'en',
'locked' => FALSE,
'pattern' => 'F d, Y',
'status' => TRUE,
'uuid' => $this->entity->uuid(),
];
}
/**
* {@inheritdoc}
*/
protected function getNormalizedPostEntity() {
// @todo Update in https://www.drupal.org/node/2300677.
}
}
......@@ -14,18 +14,23 @@
*/
class DateFormatAccessControlHandler extends EntityAccessControlHandler {
/**
* {@inheritdoc}
*/
protected $viewLabelOperation = TRUE;
/**
* {@inheritdoc}
*/
protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
// There are no restrictions on viewing a date format.
if ($operation == 'view') {
// There are no restrictions on viewing the label of a date format.
if ($operation === 'view label') {
return AccessResult::allowed();
}
// Locked date formats cannot be updated or deleted.
elseif (in_array($operation, ['update', 'delete'])) {
if ($entity->isLocked()) {
return AccessResult::forbidden()->addCacheableDependency($entity);
return AccessResult::forbidden('The DateFormat config entity is locked.')->addCacheableDependency($entity);
}
else {
return parent::checkAccess($entity, $operation, $account)->addCacheableDependency($entity);
......
<?php
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\simpletest\UserCreationTrait;
/**
* @coversDefaultClass \Drupal\system\DateFormatAccessControlHandler
* @group system
*/
class DateFormatAccessControlHandlerTest extends KernelTestBase {
use UserCreationTrait {
createUser as drupalCreateUser;
}
/**
* Modules to enable.
*
* @var array
*/
public static $modules = [
'system',
'user',
];
/**
* The date_format access control handler.
*
* @var \Drupal\Core\Entity\EntityAccessControlHandlerInterface
*/
protected $accessControlHandler;
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
$this->installEntitySchema('date_format');
$this->installEntitySchema('user');
$this->installSchema('system', 'sequences');
$this->accessControlHandler = $this->container->get('entity_type.manager')->getAccessControlHandler('date_format');
}
/**
* @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 a ID >1.
$root_user = $this->drupalCreateUser();
if ($which_user === 'user1') {
$user = $root_user;
}
else {
$permissions = ($which_user === 'admin')
? ['administer site configuration']
: [];
$user = $this->drupalCreateUser($permissions);
}
$entity_values = ($which_entity === 'unlocked')
? ['locked' => FALSE]
: ['locked' => TRUE];
$entity_values['id'] = $this->randomMachineName();
$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));
}
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 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."),
],
'permissionless + locked' => [
'permissionless',
'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' => [
'admin',
'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' => [
'admin',
'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']),
],
'user1 + unlocked' => [
'user1',
'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']),
],
'user1 + locked' => [
'user1',
'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']),
],
];
}
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment