class AccessTest in Flag 8.4

Tests related to access to flags.

Three distinct areas: Default hook_flag_action_access(). Users flagging only content they own. UserFlagType optional self flagging tests.

@group flag

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\flag\Kernel\FlagKernelTestBase uses FlagCreateTrait, UserCreationTrait
  - class \Drupal\Tests\flag\Kernel\AccessTest

Expanded class hierarchy of AccessTest

File

tests/src/Kernel/AccessTest.php, line 18

Namespace

Drupal\Tests\flag\Kernel

View source

class AccessTest extends FlagKernelTestBase {

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installSchema('user', 'users_data', 'flag');

    // The first user is uid 1, create that to avoid that our test users
    // implicitly have all permissions even those that don't exist.
    $this
      ->createUser();
  }

  /**
   * Tests default hook_flag_action_access() mechanism.
   */
  public function testDefault() {

    // Create a flag.
    $flag = Flag::create([
      'id' => 'example',
      'label' => $this
        ->randomString(),
      'entity_type' => 'node',
      'bundles' => [
        'article',
      ],
      'flag_type' => 'entity:node',
      'link_type' => 'reload',
      'flagTypeConfig' => [],
      'linkTypeConfig' => [],
    ]);
    $flag
      ->save();

    // Create a user who may flag and unflag.
    $user_alice = $this
      ->createUser([
      'administer flags',
      'flag example',
      'unflag example',
    ]);

    // Create a user who may only flag.
    $user_jill = $this
      ->createUser([
      'administer flags',
      'flag example',
    ]);

    // Create a user who may not flag or unflag.
    $user_bob = $this
      ->createUser();
    $article = Node::create([
      'type' => 'article',
      'title' => 'Article node',
    ]);
    $article
      ->save();

    // Test with both permissions.
    $this
      ->assertTrue($flag
      ->actionAccess('flag', $user_alice, $article)
      ->isAllowed(), 'Alice can flag.');
    $this
      ->assertTrue($flag
      ->actionAccess('unflag', $user_alice, $article)
      ->isAllowed(), 'Alice can unflag.');

    // Test with only flag permission.
    $this
      ->assertTrue($flag
      ->actionAccess('flag', $user_jill, $article)
      ->isAllowed(), 'Jill can flag.');
    $this
      ->assertTrue($flag
      ->actionAccess('unflag', $user_jill, $article)
      ->isNeutral(), 'Jill cannot unflag.');

    // Test without permissions.
    $this
      ->assertTrue($flag
      ->actionAccess('flag', $user_bob, $article)
      ->isNeutral(), 'Bob cannot flag.');
    $this
      ->assertTrue($flag
      ->actionAccess('unflag', $user_bob, $article)
      ->isNeutral(), 'Bob cannot unflag..');
  }

  /**
   * Tests owners access to flaggables.
   *
   * Authors own articles - and can only flag their own work.
   * Editors own articles - but can only flag the work of others.
   */
  public function testOwnersAccess() {

    // A review flag with extra permissions set.
    $flag = Flag::create([
      'id' => 'me_myself_and_I',
      'label' => 'Self Review Flag',
      'entity_type' => 'node',
      'bundles' => [
        'article',
      ],
      'flag_type' => 'entity:node',
      'link_type' => 'reload',
      'flagTypeConfig' => [
        'extra_permissions' => [
          'owner',
        ],
      ],
      'linkTypeConfig' => [],
    ]);
    $flag
      ->save();
    $flag_id = $flag
      ->id();

    // Give authors permission to flag their own work.
    $user_author = $this
      ->createUser([
      "flag {$flag_id} own items",
      "unflag {$flag_id} own items",
    ]);

    // Editors get permission.
    $user_editor = $this
      ->createUser([
      "flag {$flag_id} other items",
      "unflag {$flag_id} other items",
    ]);

    // Article is owned by Author.
    $article_by_author = Node::create([
      'type' => 'article',
      'title' => 'Article node',
    ]);
    $article_by_author
      ->setOwner($user_author);
    $article_by_author
      ->save();

    // Article owned by editor (which NO one can flag or unflag).
    $article_by_editor = Node::create([
      'type' => 'article',
      'title' => 'Article node',
    ]);
    $article_by_editor
      ->setOwner($user_editor);
    $article_by_editor
      ->save();

    // Author can self review his or her own work.
    $this
      ->assertTrue($flag
      ->actionAccess('flag', $user_author, $article_by_author)
      ->isAllowed());
    $this
      ->assertTrue($flag
      ->actionAccess('unflag', $user_author, $article_by_author)
      ->isAllowed());

    // Author can review others work.
    $this
      ->assertTrue($flag
      ->actionAccess('flag', $user_author, $article_by_editor)
      ->isNeutral());
    $this
      ->assertTrue($flag
      ->actionAccess('unflag', $user_author, $article_by_editor)
      ->isNeutral());

    // Editors should be able to access work that is not their own.
    $this
      ->assertTrue($flag
      ->actionAccess('flag', $user_editor, $article_by_author)
      ->isAllowed());
    $this
      ->assertTrue($flag
      ->actionAccess('unflag', $user_editor, $article_by_author)
      ->isAllowed());

    // Editors should not get access to the self review flag.
    $this
      ->assertTrue($flag
      ->actionAccess('flag', $user_editor, $article_by_editor)
      ->isNeutral());
    $this
      ->assertTrue($flag
      ->actionAccess('unflag', $user_editor, $article_by_editor)
      ->isNeutral());

    // When no flaggable is supplied EntityFlagType::actionAccess() tests are
    // bypassed.
    $this
      ->assertTrue($flag
      ->actionAccess('flag', $user_author)
      ->isNeutral());
    $this
      ->assertTrue($flag
      ->actionAccess('flag', $user_editor)
      ->isNeutral());
    $this
      ->assertTrue($flag
      ->actionAccess('unflag', $user_author)
      ->isNeutral());
    $this
      ->assertTrue($flag
      ->actionAccess('unflag', $user_editor)
      ->isNeutral());
  }

  /**
   * Tests specific UserFlagType permissions.
   */
  public function testUserFlag() {

    // A flag that shows on users profiles.
    $flag = Flag::create([
      'id' => 'A flag about users',
      'label' => $this
        ->randomString(),
      'entity_type' => 'user',
      'flag_type' => 'entity:user',
      'link_type' => 'reload',
      'flagTypeConfig' => [
        'extra_permissions' => [
          'owner',
        ],
      ],
      'linkTypeConfig' => [],
    ]);
    $flag
      ->save();
    $flag_id = $flag
      ->id();

    // Create a user who may flag her own user account.
    $user_alice = $this
      ->createUser([
      "flag {$flag_id} own user account",
      "unflag {$flag_id} own user account",
    ]);

    // Create a user who may flag the work of others.
    $user_bob = $this
      ->createUser([
      "flag {$flag_id} other user accounts",
      "unflag {$flag_id} other user accounts",
    ]);

    // For Alice selfies are permitted.
    $this
      ->assertTrue($flag
      ->actionAccess('flag', $user_alice, $user_alice)
      ->isAllowed());
    $this
      ->assertTrue($flag
      ->actionAccess('unflag', $user_alice, $user_alice)
      ->isAllowed());

    // For Bob selfies are banned.
    $this
      ->assertTrue($flag
      ->actionAccess('flag', $user_bob, $user_bob)
      ->isNeutral());
    $this
      ->assertTrue($flag
      ->actionAccess('unflag', $user_bob, $user_bob)
      ->isNeutral());

    // For alice flagging other people's profiles is banned.
    $this
      ->assertTrue($flag
      ->actionAccess('flag', $user_alice, $user_bob)
      ->isNeutral());
    $this
      ->assertTrue($flag
      ->actionAccess('flag', $user_alice, $user_bob)
      ->isNeutral());

    // For Bob flagging other people's profiles is permitted.
    $this
      ->assertTrue($flag
      ->actionAccess('unflag', $user_bob, $user_alice)
      ->isAllowed());
    $this
      ->assertTrue($flag
      ->actionAccess('unflag', $user_bob, $user_alice)
      ->isAllowed());

    // When no flaggable is supplied UserFlagType::actionAccess() tests are
    // bypassed.
    $this
      ->assertTrue($flag
      ->actionAccess('flag', $user_alice)
      ->isNeutral());
    $this
      ->assertTrue($flag
      ->actionAccess('flag', $user_bob)
      ->isNeutral());
    $this
      ->assertTrue($flag
      ->actionAccess('unflag', $user_alice)
      ->isNeutral());
    $this
      ->assertTrue($flag
      ->actionAccess('unflag', $user_bob)
      ->isNeutral());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AccessTest::setUp	protected	function	Overrides FlagKernelTestBase::setUp
AccessTest::testDefault	public	function	Tests default hook_flag_action_access() mechanism.
AccessTest::testOwnersAccess	public	function	Tests owners access to flaggables.
AccessTest::testUserFlag	public	function	Tests specific UserFlagType permissions.
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.
FlagCreateTrait::createFlag	protected	function	Create a basic flag programmatically.
FlagCreateTrait::createFlagFromArray	protected	function	Creates a flag from an array.
FlagCreateTrait::createGlobalFlag	protected	function	Create a global flag programmatically.
FlagCreateTrait::getFlagType	protected	function	Get a flag type plugin ID for the given entity.
FlagCreateTrait::randomHTMLString	protected	function	Generates an HTML-safe random string.
FlagKernelTestBase::$flagService	protected	property	The flag service.
FlagKernelTestBase::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules	2
FlagKernelTestBase::getFlagFlaggings	protected	function	Get all flaggings for the given flag.
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.
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.
UserCreationTrait::checkPermissions	protected	function	Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole	protected	function	Creates an administrative role.
UserCreationTrait::createRole	protected	function	Creates a role with specified permissions.
UserCreationTrait::createUser	protected	function	Create a user with a given set of permissions.
UserCreationTrait::grantPermissions	protected	function	Grant permissions to a user role.
UserCreationTrait::setCurrentUser	protected	function	Switch the current logged in user.
UserCreationTrait::setUpCurrentUser	protected	function	Creates a random user account and sets it as current user.

You are here

class AccessTest in Flag 8.4

Hierarchy

File

Namespace

Members

API Navigation