class RulesAdminAccessTest in Rules 8.3

Tests access control for the configuration interface of Rules plugins.

@group Rules

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\rules\Unit\Integration\RulesIntegrationTestBase
    • class \Drupal\Tests\rules\Unit\Integration\RulesAction\RulesAdminAccessTest

File

tests/src/Unit/Integration/RulesAction/RulesAdminAccessTest.php, line 15

Namespace

Drupal\Tests\rules\Unit\Integration\RulesAction

class RulesAdminAccessTest extends RulesIntegrationTestBase {

  /**
   * Test administrative access to plugin configuration UI.
   */
  public function testRespectsAdminPermissions() {

    // 3 user classes to test.
    $super_admin = $this
      ->prophesize(AccountInterface::class);
    $super_admin
      ->hasPermission(Argument::any())
      ->willReturn(TRUE);
    $power_user = $this
      ->prophesize(AccountInterface::class);
    $power_user
      ->hasPermission('admin this plugin')
      ->willReturn(TRUE);
    $power_user
      ->hasPermission(Argument::any())
      ->willReturn(FALSE);
    $joe_user = $this
      ->prophesize(AccountInterface::class);
    $joe_user
      ->hasPermission(Argument::any())
      ->willReturn(FALSE);

    // Our plug-in will behave as if it has the annotation property
    // 'configuration_access'. getPluginDefinition should be called only
    // twice, since the super admin should get approval before it is called.
    // I use getMockBuilder since I need the actual code from the
    // RulesActionBase class for the test.
    $action = $this
      ->getMockBuilder(RulesActionBase::class)
      ->disableOriginalConstructor()
      ->setMethods([
      'getPluginDefinition',
    ])
      ->getMockForAbstractClass();
    $action
      ->expects($this
      ->exactly(2))
      ->method('getPluginDefinition')
      ->willReturn([
      'plugin_id' => 'some_action',
      'configure_permissions' => [
        'admin this plugin',
      ],
    ]);
    $user = $super_admin
      ->reveal();
    $this
      ->assertTrue($action
      ->checkConfigurationAccess($user), "Super-user has admin access");
    $user = $power_user
      ->reveal();
    $this
      ->assertTrue($action
      ->checkConfigurationAccess($user), "Power-user has admin access");
    $user = $joe_user
      ->reveal();
    $this
      ->assertFalse($action
      ->checkConfigurationAccess($user), "Ordinary user lacks admin access");
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
RulesAdminAccessTest::testRespectsAdminPermissions	public	function	Test administrative access to plugin configuration UI.
RulesIntegrationTestBase::$actionManager	protected	property
RulesIntegrationTestBase::$cacheBackend	protected	property
RulesIntegrationTestBase::$classResolver	protected	property	The class resolver mock for the typed data manager.
RulesIntegrationTestBase::$conditionManager	protected	property
RulesIntegrationTestBase::$container	protected	property	The Drupal service container.
RulesIntegrationTestBase::$dataFetcher	protected	property	The data fetcher service.
RulesIntegrationTestBase::$dataFilterManager	protected	property	The data filter manager.
RulesIntegrationTestBase::$enabledModules	protected	property	Array object keyed with module names and TRUE as value.
RulesIntegrationTestBase::$entityFieldManager	protected	property
RulesIntegrationTestBase::$entityTypeBundleInfo	protected	property
RulesIntegrationTestBase::$entityTypeManager	protected	property
RulesIntegrationTestBase::$logger	protected	property	A mocked Rules logger.channel.rules_debug service.	6
RulesIntegrationTestBase::$messenger	protected	property	The messenger service.
RulesIntegrationTestBase::$moduleHandler	protected	property
RulesIntegrationTestBase::$namespaces	protected	property	All setup'ed namespaces.
RulesIntegrationTestBase::$placeholderResolver	protected	property	The placeholder resolver service.
RulesIntegrationTestBase::$rulesDataProcessorManager	protected	property
RulesIntegrationTestBase::$rulesExpressionManager	protected	property
RulesIntegrationTestBase::$typedDataManager	protected	property
RulesIntegrationTestBase::constructModulePath	protected	function	Determines the path to a module's class files.
RulesIntegrationTestBase::enableModule	protected	function	Fakes the enabling of a module and adds its namespace for plugin loading.
RulesIntegrationTestBase::getTypedData	protected	function	Returns a typed data object.
RulesIntegrationTestBase::prophesizeEntity	protected	function	Helper method to mock irrelevant cache methods on entities.
RulesIntegrationTestBase::setUp	protected	function	Overrides UnitTestCase::setUp	22
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.