class ProtectionRuleUnitTest in User protect 8

Various unit tests for protection rules.

@group userprotect

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\userprotect\Kernel\Entity\ProtectionRuleUnitTest

Expanded class hierarchy of ProtectionRuleUnitTest

File

tests/src/Kernel/Entity/ProtectionRuleUnitTest.php, line 19

Namespace

Drupal\Tests\userprotect\Kernel\Entity

View source

class ProtectionRuleUnitTest extends KernelTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'user',
    'userprotect',
    'field',
  ];

  /**
   * The user protection plugin manager.
   *
   * @var \Drupal\userprotect\Plugin\UserProtection\UserProtectionManager
   */
  protected $manager;

  /**
   * The protection rule to test on.
   *
   * @var \Drupal\userprotect\Entity\ProtectionRuleInterface
   */
  protected $protectionRule;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->manager = UserProtect::pluginManager();
    $this->protectionRule = ProtectionRule::create([
      'name' => 'dummy',
      'label' => 'Dummy',
      'protections' => [
        'user_mail' => [
          'status' => TRUE,
        ],
      ],
      'protectedEntityTypeId' => 'user_role',
      'protectedEntityId' => 'administrator',
    ]);
  }

  /**
   * Tests id().
   */
  public function testId() {
    $this
      ->assertIdentical('dummy', $this->protectionRule
      ->id());
  }

  /**
   * Tests setProtectedEntityTypeId() and getProtectedEntityTypeId().
   */
  public function testProtectedEntityTypeId() {
    $this
      ->assertIdentical('user_role', $this->protectionRule
      ->getProtectedEntityTypeId());
    $entity_type = 'user';
    $this
      ->assertInstanceOf(ProtectionRuleInterface::class, $this->protectionRule
      ->setProtectedEntityTypeId($entity_type));
    $this
      ->assertIdentical($entity_type, $this->protectionRule
      ->getProtectedEntityTypeId());
  }

  /**
   * Tests setProtectedEntityId() and getProtectedEntityId().
   */
  public function testProtectedEntityId() {
    $this
      ->assertIdentical('administrator', $this->protectionRule
      ->getProtectedEntityId());
    $entity_id = 'authenticated';
    $this
      ->assertInstanceOf(ProtectionRuleInterface::class, $this->protectionRule
      ->setProtectedEntityId($entity_id));
    $this
      ->assertIdentical($entity_id, $this->protectionRule
      ->getProtectedEntityId());
  }

  /**
   * Tests setBypassRoles() and getBypassRoles().
   */
  public function testBypassRoles() {
    $this
      ->assertIdentical([], $this->protectionRule
      ->getBypassRoles());
    $roles = [
      'administrator',
    ];
    $this
      ->assertInstanceOf(ProtectionRuleInterface::class, $this->protectionRule
      ->setBypassRoles($roles));
    $this
      ->assertIdentical($roles, $this->protectionRule
      ->getBypassRoles());
  }

  /**
   * Tests getProtection().
   */
  public function testGetProtection() {
    $this
      ->assertInstanceOf(UserProtectionInterface::class, $this->protectionRule
      ->getProtection('user_mail'));
  }

  /**
   * Tests getProtections().
   */
  public function testGetProtections() {
    $this
      ->assertInstanceOf(UserProtectionPluginCollection::class, $this->protectionRule
      ->getProtections());
  }

  /**
   * Tests enableProtection().
   */
  public function testEnableProtection() {
    $this
      ->assertInstanceOf(ProtectionRuleInterface::class, $this->protectionRule
      ->enableProtection('user_name'));
    $this
      ->assertTrue($this->protectionRule
      ->hasProtection('user_name'));
  }

  /**
   * Tests disableProtection().
   */
  public function testDisableProtection() {
    $this
      ->assertInstanceOf(ProtectionRuleInterface::class, $this->protectionRule
      ->disableProtection('user_mail'));
    $this
      ->assertFalse($this->protectionRule
      ->hasProtection('user_mail'));
  }

  /**
   * Tests toArray().
   */
  public function testToArray() {
    $array = $this->protectionRule
      ->toArray();
    $this
      ->assertIdentical('dummy', $array['name']);
    $this
      ->assertIdentical('Dummy', $array['label']);
    $expected_protections = [
      'user_mail' => [
        'status' => TRUE,
      ],
    ];
    $this
      ->assertIdentical($expected_protections, $array['protections']);
    $this
      ->assertIdentical('user_role', $array['protectedEntityTypeId']);
    $this
      ->assertIdentical('administrator', $array['protectedEntityId']);
  }

  /**
   * Tests getPermissionName().
   */
  public function testGetPermissionName() {
    $this
      ->assertIdentical('userprotect.dummy.bypass', $this->protectionRule
      ->getPermissionName());
  }

  /**
   * Tests appliesTo().
   */
  public function testAppliesTo() {

    // Create an user with administrator role.
    $values = [
      'uid' => 3,
      'name' => 'lorem',
      'roles' => [
        'administrator',
      ],
    ];
    $lorem = User::create($values);

    // Create an authenticated user.
    $values = [
      'uid' => 4,
      'name' => 'ipsum',
    ];
    $ipsum = User::create($values);

    // Assert that the protection rule applies to the user with the
    // administrator role and not to the authenticated user.
    $this
      ->assertTrue($this->protectionRule
      ->appliesTo($lorem));
    $this
      ->assertFalse($this->protectionRule
      ->appliesTo($ipsum));

    // Create an user based protection rule.
    $user_protection_rule = ProtectionRule::create([
      'name' => 'dummy',
      'label' => 'Dummy',
      'protections' => [
        'user_mail' => [
          'status' => TRUE,
        ],
      ],
      'protectedEntityTypeId' => 'user',
      'protectedEntityId' => 4,
    ]);

    // Assert that the protection rule applies to "ipsum", but no to "lorem".
    $this
      ->assertFalse($user_protection_rule
      ->appliesTo($lorem));
    $this
      ->assertTrue($user_protection_rule
      ->appliesTo($ipsum));
  }

  /**
   * Tests hasProtection().
   */
  public function testHasProtection() {

    // The protection rule was created with only the protection "user_mail"
    // enabled.
    $this
      ->assertTrue($this->protectionRule
      ->hasProtection('user_mail'));
    $this
      ->assertFalse($this->protectionRule
      ->hasProtection('user_name'));
    $this
      ->assertFalse($this->protectionRule
      ->hasProtection('non_existing_plugin_id'));
  }

  /**
   * Tests isProtected().
   */
  public function testIsProtected() {

    // Create an user with administrator role.
    $values = [
      'uid' => 3,
      'name' => 'lorem',
      'roles' => [
        'administrator',
      ],
    ];
    $lorem = User::create($values);

    // Create an authenticated user.
    $values = [
      'uid' => 4,
      'name' => 'ipsum',
    ];
    $ipsum = User::create($values);

    // Create an operating account.
    $account = new UserSession();

    // Assert that the operation is protected on the user with the administrator
    // role and not on the authenticated user.
    $this
      ->assertTrue($this->protectionRule
      ->isProtected($lorem, 'user_mail', $account));
    $this
      ->assertFalse($this->protectionRule
      ->isProtected($ipsum, 'user_mail', $account));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertContentTrait::$content	protected	property	The current raw content.
AssertContentTrait::$drupalSettings	protected	property	The drupalSettings value from the current raw $content.
AssertContentTrait::$elements	protected	property	The XML structure parsed from the current raw $content.	1
AssertContentTrait::$plainTextContent	protected	property	The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds	protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped	protected	function	Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion	protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption	protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected	protected	function	Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern	protected	function	Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw	protected	function	Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle	protected	function	Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText	protected	function	Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern	protected	function	Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput	protected	function	Asserts themed output.
AssertContentTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertContentTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper	protected	function	Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertContentTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings	protected	function	Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent	protected	function	Gets the current raw content.
AssertContentTrait::getSelectedItem	protected	function	Get the selected value from a select field.
AssertContentTrait::getTextContent	protected	function	Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl	protected	function	Get the current URL from the cURL handler.	1
AssertContentTrait::parse	protected	function	Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace	protected	function	Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings	protected	function	Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent	protected	function	Sets the raw content (e.g. HTML).
AssertContentTrait::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings	protected static	function	Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose	protected	function
ConfigTestTrait::configImporter	protected	function	Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig	protected	function	Copies configuration objects from source storage to target storage.
KernelTestBase::$backupGlobals	protected	property	Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes	protected	property	Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist	protected	property	Contains a few static class properties for performance.
KernelTestBase::$classLoader	protected	property
KernelTestBase::$configImporter	protected	property	@todo Move into Config test base class.	7
KernelTestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container	protected	property
KernelTestBase::$databasePrefix	protected	property
KernelTestBase::$preserveGlobalState	protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root	protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess	protected	property	Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory	protected	property
KernelTestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	6
KernelTestBase::$vfsRoot	protected	property	The virtual filesystem root directory.
KernelTestBase::assertPostConditions	protected	function		1
KernelTestBase::bootEnvironment	protected	function	Bootstraps a basic test environment.
KernelTestBase::bootKernel	private	function	Bootstraps a kernel for a test.
KernelTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo	protected	function	Returns the Database connection info to be used for this test.	1
KernelTestBase::getDatabasePrefix	public	function
KernelTestBase::getExtensionsForModules	private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable	private static	function	Returns the modules to enable for this test.
KernelTestBase::initFileCache	protected	function	Initializes the FileCache component.
KernelTestBase::installConfig	protected	function	Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema	protected	function	Installs the storage schema for a specific entity type.
KernelTestBase::installSchema	protected	function	Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated	protected	function	Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	26
KernelTestBase::render	protected	function	Renders a render array.	1
KernelTestBase::setInstallProfile	protected	function	Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting	protected	function	Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass	public static	function		1
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	2
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		6
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated	public	function	BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
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.
ProtectionRuleUnitTest::$manager	protected	property	The user protection plugin manager.
ProtectionRuleUnitTest::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules
ProtectionRuleUnitTest::$protectionRule	protected	property	The protection rule to test on.
ProtectionRuleUnitTest::setUp	protected	function	Overrides KernelTestBase::setUp
ProtectionRuleUnitTest::testAppliesTo	public	function	Tests appliesTo().
ProtectionRuleUnitTest::testBypassRoles	public	function	Tests setBypassRoles() and getBypassRoles().
ProtectionRuleUnitTest::testDisableProtection	public	function	Tests disableProtection().
ProtectionRuleUnitTest::testEnableProtection	public	function	Tests enableProtection().
ProtectionRuleUnitTest::testGetPermissionName	public	function	Tests getPermissionName().
ProtectionRuleUnitTest::testGetProtection	public	function	Tests getProtection().
ProtectionRuleUnitTest::testGetProtections	public	function	Tests getProtections().
ProtectionRuleUnitTest::testHasProtection	public	function	Tests hasProtection().
ProtectionRuleUnitTest::testId	public	function	Tests id().
ProtectionRuleUnitTest::testIsProtected	public	function	Tests isProtected().
ProtectionRuleUnitTest::testProtectedEntityId	public	function	Tests setProtectedEntityId() and getProtectedEntityId().
ProtectionRuleUnitTest::testProtectedEntityTypeId	public	function	Tests setProtectedEntityTypeId() and getProtectedEntityTypeId().
ProtectionRuleUnitTest::testToArray	public	function	Tests toArray().
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
RandomGeneratorTrait::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName	protected	function	Generates a unique random string containing letters and numbers.	1
RandomGeneratorTrait::randomObject	public	function	Generates a random PHP object.
RandomGeneratorTrait::randomString	public	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.

You are here

class ProtectionRuleUnitTest in User protect 8

Hierarchy

File

Namespace

Members

API Navigation