class PermissionHandlerTest in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/user/tests/src/Unit/PermissionHandlerTest.php \Drupal\Tests\user\Unit\PermissionHandlerTest
Tests the permission handler.
@group user
@coversDefaultClass \Drupal\user\PermissionHandler
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \Drupal\Tests\PHPUnit_Framework_TestCase
- class \Drupal\Tests\user\Unit\PermissionHandlerTest
Expanded class hierarchy of PermissionHandlerTest
File
- core/
modules/ user/ tests/ src/ Unit/ PermissionHandlerTest.php, line 27 - Contains \Drupal\Tests\user\Unit\PermissionHandlerTest.
Namespace
Drupal\Tests\user\UnitView source
class PermissionHandlerTest extends UnitTestCase {
/**
* The tested permission handler.
*
* @var \Drupal\Tests\user\Unit\TestPermissionHandler|\Drupal\user\PermissionHandler
*/
protected $permissionHandler;
/**
* The mocked module handler.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface|\PHPUnit_Framework_MockObject_MockObject
*/
protected $moduleHandler;
/**
* The mocked string translation.
*
* @var \Drupal\Tests\user\Unit\TestTranslationManager
*/
protected $stringTranslation;
/**
* The mocked controller resolver.
*
* @var \Drupal\Core\Controller\ControllerResolverInterface|\PHPUnit_Framework_MockObject_MockObject
*/
protected $controllerResolver;
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
$this->stringTranslation = new TestTranslationManager();
$this->controllerResolver = $this
->getMock('Drupal\\Core\\Controller\\ControllerResolverInterface');
}
/**
* Provides an extension object for a given module with a human name.
*
* @param string $module
* The module machine name.
* @param string $name
* The module human name.
*
* @return \Drupal\Core\Extension\Extension
* The extension object.
*/
protected function mockModuleExtension($module, $name) {
$extension = new Extension($this->root, $module, "modules/{$module}");
$extension->info['name'] = $name;
return $extension;
}
/**
* Tests permissions provided by YML files.
*
* @covers ::__construct
* @covers ::getPermissions
* @covers ::buildPermissionsYaml
* @covers ::moduleProvidesPermissions
*/
public function testBuildPermissionsYaml() {
vfsStreamWrapper::register();
$root = new vfsStreamDirectory('modules');
vfsStreamWrapper::setRoot($root);
$this->moduleHandler = $this
->getMock('Drupal\\Core\\Extension\\ModuleHandlerInterface');
$this->moduleHandler
->expects($this
->once())
->method('getModuleDirectories')
->willReturn(array(
'module_a' => vfsStream::url('modules/module_a'),
'module_b' => vfsStream::url('modules/module_b'),
'module_c' => vfsStream::url('modules/module_c'),
));
$url = vfsStream::url('modules');
mkdir($url . '/module_a');
file_put_contents($url . '/module_a/module_a.permissions.yml', "access_module_a: single_description");
mkdir($url . '/module_b');
file_put_contents($url . '/module_b/module_b.permissions.yml', "'access module b':\n title: 'Access B'\n description: 'bla bla'\n");
mkdir($url . '/module_c');
file_put_contents($url . '/module_c/module_c.permissions.yml', "'access_module_c':\n title: 'Access C'\n description: 'bla bla'\n 'restrict access': TRUE\n");
$modules = array(
'module_a',
'module_b',
'module_c',
);
$extensions = array(
'module_a' => $this
->mockModuleExtension('module_a', 'Module a'),
'module_b' => $this
->mockModuleExtension('module_b', 'Module b'),
'module_c' => $this
->mockModuleExtension('module_c', 'Module c'),
);
$this->moduleHandler
->expects($this
->any())
->method('getImplementations')
->with('permission')
->willReturn(array());
$this->moduleHandler
->expects($this
->any())
->method('getModuleList')
->willReturn(array_flip($modules));
$this->controllerResolver
->expects($this
->never())
->method('getControllerFromDefinition');
$this->permissionHandler = new TestPermissionHandler($this->moduleHandler, $this->stringTranslation, $this->controllerResolver);
// Setup system_rebuild_module_data().
$this->permissionHandler
->setSystemRebuildModuleData($extensions);
$actual_permissions = $this->permissionHandler
->getPermissions();
$this
->assertPermissions($actual_permissions);
$this
->assertTrue($this->permissionHandler
->moduleProvidesPermissions('module_a'));
$this
->assertTrue($this->permissionHandler
->moduleProvidesPermissions('module_b'));
$this
->assertTrue($this->permissionHandler
->moduleProvidesPermissions('module_c'));
$this
->assertFalse($this->permissionHandler
->moduleProvidesPermissions('module_d'));
}
/**
* Tests permissions sort inside a module.
*
* @covers ::__construct
* @covers ::getPermissions
* @covers ::buildPermissionsYaml
* @covers ::sortPermissions
*/
public function testBuildPermissionsSortPerModule() {
vfsStreamWrapper::register();
$root = new vfsStreamDirectory('modules');
vfsStreamWrapper::setRoot($root);
$this->moduleHandler = $this
->getMock('Drupal\\Core\\Extension\\ModuleHandlerInterface');
$this->moduleHandler
->expects($this
->once())
->method('getModuleDirectories')
->willReturn([
'module_a' => vfsStream::url('modules/module_a'),
'module_b' => vfsStream::url('modules/module_b'),
'module_c' => vfsStream::url('modules/module_c'),
]);
$this->moduleHandler
->expects($this
->exactly(3))
->method('getName')
->will($this
->returnValueMap([
[
'module_a',
'Module a',
],
[
'module_b',
'Module b',
],
[
'module_c',
'A Module',
],
]));
$url = vfsStream::url('modules');
mkdir($url . '/module_a');
file_put_contents($url . '/module_a/module_a.permissions.yml', "access_module_a2: single_description2\naccess_module_a1: single_description1");
mkdir($url . '/module_b');
file_put_contents($url . '/module_b/module_b.permissions.yml', "access_module_a3: single_description");
mkdir($url . '/module_c');
file_put_contents($url . '/module_c/module_c.permissions.yml', "access_module_a4: single_description");
$modules = [
'module_a',
'module_b',
'module_c',
];
$this->moduleHandler
->expects($this
->once())
->method('getModuleList')
->willReturn(array_flip($modules));
$permissionHandler = new TestPermissionHandler($this->moduleHandler, $this->stringTranslation, $this->controllerResolver);
$actual_permissions = $permissionHandler
->getPermissions();
$this
->assertEquals([
'access_module_a4',
'access_module_a1',
'access_module_a2',
'access_module_a3',
], array_keys($actual_permissions));
}
/**
* Tests dynamic callback permissions provided by YML files.
*
* @covers ::__construct
* @covers ::getPermissions
* @covers ::buildPermissionsYaml
*/
public function testBuildPermissionsYamlCallback() {
vfsStreamWrapper::register();
$root = new vfsStreamDirectory('modules');
vfsStreamWrapper::setRoot($root);
$this->moduleHandler = $this
->getMock('Drupal\\Core\\Extension\\ModuleHandlerInterface');
$this->moduleHandler
->expects($this
->once())
->method('getModuleDirectories')
->willReturn(array(
'module_a' => vfsStream::url('modules/module_a'),
'module_b' => vfsStream::url('modules/module_b'),
'module_c' => vfsStream::url('modules/module_c'),
));
$url = vfsStream::url('modules');
mkdir($url . '/module_a');
file_put_contents($url . '/module_a/module_a.permissions.yml', "permission_callbacks:\n - 'Drupal\\user\\Tests\\TestPermissionCallbacks::singleDescription'\n");
mkdir($url . '/module_b');
file_put_contents($url . '/module_b/module_b.permissions.yml', "permission_callbacks:\n - 'Drupal\\user\\Tests\\TestPermissionCallbacks::titleDescription'\n");
mkdir($url . '/module_c');
file_put_contents($url . '/module_c/module_c.permissions.yml', "permission_callbacks:\n - 'Drupal\\user\\Tests\\TestPermissionCallbacks::titleDescriptionRestrictAccess'\n");
$modules = array(
'module_a',
'module_b',
'module_c',
);
$extensions = array(
'module_a' => $this
->mockModuleExtension('module_a', 'Module a'),
'module_b' => $this
->mockModuleExtension('module_b', 'Module b'),
'module_c' => $this
->mockModuleExtension('module_c', 'Module c'),
);
$this->moduleHandler
->expects($this
->any())
->method('getImplementations')
->with('permission')
->willReturn(array());
$this->moduleHandler
->expects($this
->any())
->method('getModuleList')
->willReturn(array_flip($modules));
$this->controllerResolver
->expects($this
->at(0))
->method('getControllerFromDefinition')
->with('Drupal\\user\\Tests\\TestPermissionCallbacks::singleDescription')
->willReturn(array(
new TestPermissionCallbacks(),
'singleDescription',
));
$this->controllerResolver
->expects($this
->at(1))
->method('getControllerFromDefinition')
->with('Drupal\\user\\Tests\\TestPermissionCallbacks::titleDescription')
->willReturn(array(
new TestPermissionCallbacks(),
'titleDescription',
));
$this->controllerResolver
->expects($this
->at(2))
->method('getControllerFromDefinition')
->with('Drupal\\user\\Tests\\TestPermissionCallbacks::titleDescriptionRestrictAccess')
->willReturn(array(
new TestPermissionCallbacks(),
'titleDescriptionRestrictAccess',
));
$this->permissionHandler = new TestPermissionHandler($this->moduleHandler, $this->stringTranslation, $this->controllerResolver);
// Setup system_rebuild_module_data().
$this->permissionHandler
->setSystemRebuildModuleData($extensions);
$actual_permissions = $this->permissionHandler
->getPermissions();
$this
->assertPermissions($actual_permissions);
}
/**
* Tests a YAML file containing both static permissions and a callback.
*/
public function testPermissionsYamlStaticAndCallback() {
vfsStreamWrapper::register();
$root = new vfsStreamDirectory('modules');
vfsStreamWrapper::setRoot($root);
$this->moduleHandler = $this
->getMock('Drupal\\Core\\Extension\\ModuleHandlerInterface');
$this->moduleHandler
->expects($this
->once())
->method('getModuleDirectories')
->willReturn(array(
'module_a' => vfsStream::url('modules/module_a'),
));
$url = vfsStream::url('modules');
mkdir($url . '/module_a');
file_put_contents($url . '/module_a/module_a.permissions.yml', "'access module a':\n title: 'Access A'\n description: 'bla bla'\npermission_callbacks:\n - 'Drupal\\user\\Tests\\TestPermissionCallbacks::titleDescription'\n");
$modules = array(
'module_a',
);
$extensions = array(
'module_a' => $this
->mockModuleExtension('module_a', 'Module a'),
);
$this->moduleHandler
->expects($this
->any())
->method('getImplementations')
->with('permission')
->willReturn(array());
$this->moduleHandler
->expects($this
->any())
->method('getModuleList')
->willReturn(array_flip($modules));
$this->controllerResolver
->expects($this
->once())
->method('getControllerFromDefinition')
->with('Drupal\\user\\Tests\\TestPermissionCallbacks::titleDescription')
->willReturn(array(
new TestPermissionCallbacks(),
'titleDescription',
));
$this->permissionHandler = new TestPermissionHandler($this->moduleHandler, $this->stringTranslation, $this->controllerResolver);
// Setup system_rebuild_module_data().
$this->permissionHandler
->setSystemRebuildModuleData($extensions);
$actual_permissions = $this->permissionHandler
->getPermissions();
$this
->assertCount(2, $actual_permissions);
$this
->assertEquals($actual_permissions['access module a']['title'], 'Access A');
$this
->assertEquals($actual_permissions['access module a']['provider'], 'module_a');
$this
->assertEquals($actual_permissions['access module a']['description'], 'bla bla');
$this
->assertEquals($actual_permissions['access module b']['title'], 'Access B');
$this
->assertEquals($actual_permissions['access module b']['provider'], 'module_a');
$this
->assertEquals($actual_permissions['access module b']['description'], 'bla bla');
}
/**
* Checks that the permissions are like expected.
*
* @param array $actual_permissions
* The actual permissions
*/
protected function assertPermissions(array $actual_permissions) {
$this
->assertCount(3, $actual_permissions);
$this
->assertEquals($actual_permissions['access_module_a']['title'], 'single_description');
$this
->assertEquals($actual_permissions['access_module_a']['provider'], 'module_a');
$this
->assertEquals($actual_permissions['access module b']['title'], 'Access B');
$this
->assertEquals($actual_permissions['access module b']['provider'], 'module_b');
$this
->assertEquals($actual_permissions['access_module_c']['title'], 'Access C');
$this
->assertEquals($actual_permissions['access_module_c']['provider'], 'module_c');
$this
->assertEquals($actual_permissions['access_module_c']['restrict access'], TRUE);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
PermissionHandlerTest:: |
protected | property | The mocked controller resolver. | |
PermissionHandlerTest:: |
protected | property | The mocked module handler. | |
PermissionHandlerTest:: |
protected | property | The tested permission handler. | |
PermissionHandlerTest:: |
protected | property | The mocked string translation. | |
PermissionHandlerTest:: |
protected | function | Checks that the permissions are like expected. | |
PermissionHandlerTest:: |
protected | function | Provides an extension object for a given module with a human name. | |
PermissionHandlerTest:: |
protected | function |
Overrides UnitTestCase:: |
|
PermissionHandlerTest:: |
public | function | Tests permissions sort inside a module. | |
PermissionHandlerTest:: |
public | function | Tests permissions provided by YML files. | |
PermissionHandlerTest:: |
public | function | Tests dynamic callback permissions provided by YML files. | |
PermissionHandlerTest:: |
public | function | Tests a YAML file containing both static permissions and a callback. | |
UnitTestCase:: |
protected | property | The random generator. | |
UnitTestCase:: |
protected | property | The app root. | |
UnitTestCase:: |
protected | function | Asserts if two arrays are equal by sorting them first. | |
UnitTestCase:: |
protected | function | Mocks a block with a block plugin. | |
UnitTestCase:: |
protected | function | Returns a stub class resolver. | |
UnitTestCase:: |
public | function | Returns a stub config factory that behaves according to the passed in array. | |
UnitTestCase:: |
public | function | Returns a stub config storage that returns the supplied configuration. | |
UnitTestCase:: |
protected | function | Sets up a container with a cache tags invalidator. | |
UnitTestCase:: |
protected | function | Gets the random generator for the utility methods. | |
UnitTestCase:: |
public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase:: |
public | function | Generates a unique random string containing letters and numbers. |