class ViewsFieldAccessTest in Field Permissions 8

Same name and namespace in other branches

8.2 tests/src/Kernel/ViewsFieldAccessTest.php \Drupal\Tests\field_permissions\Kernel\ViewsFieldAccessTest

Test that custom and private field access works with views.

@group field_permissions

The normal field access base class is not extended because it hard-codes some assumptions about checking field access (it relies on logic in the entity_test.module hooks).

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\views\Kernel\ViewsKernelTestBase uses ViewResultAssertionTrait
  - class \Drupal\Tests\field_permissions\Kernel\ViewsFieldAccessTest

Expanded class hierarchy of ViewsFieldAccessTest

File

tests/src/Kernel/ViewsFieldAccessTest.php, line 26

Namespace

Drupal\Tests\field_permissions\Kernel

View source

class ViewsFieldAccessTest extends ViewsKernelTestBase {

  /**
   * Stores an user entity with access to fields.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $userWithAccess;

  /**
   * Stores an user entity without access to fields.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $userWithoutAccess;

  /**
   * Role with access.
   *
   * @var \Drupal\user\RoleInterface
   */
  protected $roleWithAccess;

  /**
   * Role without access.
   *
   * @var \Drupal\user\RoleInterface
   */
  protected $roleWithoutAccess;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'field_permissions',
    'entity_test',
    'text',
    'field',
    'filter',
  ];

  /**
   * A field to test with.
   *
   * @var \Drupal\field\FieldStorageConfigInterface
   */
  protected $fieldStorage;

  /**
   * Field config on entity_test.
   *
   * @var \Drupal\field\FieldConfigInterface
   */
  protected $field;

  /**
   * An entity to test with.
   *
   * @var \Drupal\entity_test\Entity\EntityTest
   */
  protected $entity;

  /**
   * {@inheritdoc}
   */
  public function setUp($import_test_views = TRUE) {
    parent::setUp($import_test_views);
    $this
      ->installEntitySchema('entity_test');
    $this
      ->installEntitySchema('user');
    $this
      ->installConfig('filter');

    // Add a field to test, with default permissions initially.
    $this->fieldStorage = FieldStorageConfig::create([
      'field_name' => 'test_field',
      'type' => 'text',
      'entity_type' => 'entity_test',
    ]);
    $this->fieldStorage
      ->setThirdPartySetting('field_permissions', 'permission_type', FieldPermissionTypeInterface::ACCESS_PUBLIC);
    $this->fieldStorage
      ->save();
    $this->field = FieldConfig::create([
      'field_name' => 'test_field',
      'entity_type' => 'entity_test',
      'bundle' => 'entity_test',
    ]);
    $this->field
      ->save();

    // The roles are identical to start. Individual test methods will grant and
    // revoke permissions as needed.
    $role_with_access = Role::create([
      'id' => 'with_access',
      'permissions' => [
        'view test entity',
      ],
    ]);
    $role_with_access
      ->save();
    $this->roleWithAccess = $role_with_access;
    $role_without_access = Role::create([
      'id' => 'without_access',
      'permissions' => [
        'view test entity',
      ],
    ]);
    $role_without_access
      ->save();
    $this->roleWithoutAccess = $role_without_access;
    $this->userWithAccess = User::create([
      'name' => $this
        ->randomMachineName(),
      'roles' => [
        $role_with_access
          ->id(),
      ],
    ]);
    $this->userWithAccess
      ->save();
    $this->userWithoutAccess = User::create([
      'name' => $this
        ->randomMachineName(),
      'roles' => [
        $role_without_access
          ->id(),
      ],
    ]);
    $this->userWithoutAccess
      ->save();
    $this->entity = EntityTest::create([
      $this->fieldStorage
        ->getName() => [
        'value' => 'Test value',
        'format' => filter_default_format(),
      ],
    ]);
    $this->entity
      ->save();
  }

  /**
   * Test default (public) permissions.
   */
  public function testPublicPermissions() {
    $this
      ->assertFieldAccess();
  }

  /**
   * Tests custom permissions.
   */
  public function testCustomPermissions() {
    $this->fieldStorage
      ->setThirdPartySetting('field_permissions', 'permission_type', FieldPermissionTypeInterface::ACCESS_CUSTOM)
      ->save();
    $this->roleWithAccess
      ->grantPermission('view ' . $this->fieldStorage
      ->getName())
      ->save();
    $this
      ->assertFieldAccess();
  }

  /**
   * Tests private permissions.
   */
  public function testPrivatePermissions() {
    $this->fieldStorage
      ->setThirdPartySetting('field_permissions', 'permission_type', FieldPermissionTypeInterface::ACCESS_PRIVATE)
      ->save();

    // First check with the dedicated permission.
    $this->roleWithAccess
      ->grantPermission('access private fields')
      ->save();
    $this
      ->assertFieldAccess();

    // Now check with actual ownership.
    $this->roleWithAccess
      ->revokePermission('access private fields')
      ->save();
    $this->entity
      ->setOwner($this->userWithAccess)
      ->save();
    $this
      ->assertFieldAccess();
  }

  /**
   * Checks views field access on the test entity and field.
   */
  protected function assertFieldAccess() {

    /** @var \Drupal\Core\Entity\EntityTypeInterface $entity_type */
    $entity_type = $this->container
      ->get('entity_type.manager')
      ->getDefinition('entity_test');
    $view_id = $this
      ->randomMachineName();
    $data_table = $entity_type
      ->getDataTable();
    $base_table = $data_table ?: $entity_type
      ->getBaseTable();
    $field_name = $this->fieldStorage
      ->getName();
    $field_content = $this->entity->{$field_name}->value;
    $entity = View::create([
      'id' => $view_id,
      'base_table' => $base_table,
      'display' => [
        'default' => [
          'display_plugin' => 'default',
          'id' => 'default',
          'display_options' => [
            'fields' => [
              $field_name => [
                'table' => $base_table . '__' . $field_name,
                'field' => $field_name,
                'id' => $field_name,
                'plugin_id' => 'field',
                'type' => 'text_default',
              ],
            ],
          ],
        ],
      ],
    ]);
    $entity
      ->save();

    /** @var \Drupal\Core\Session\AccountSwitcherInterface $account_switcher */
    $account_switcher = $this->container
      ->get('account_switcher');

    /** @var \Drupal\Core\Render\RendererInterface $renderer */
    $renderer = $this->container
      ->get('renderer');
    $account_switcher
      ->switchTo($this->userWithAccess);
    $executable = Views::getView($view_id);
    $build = $executable
      ->preview();
    $this
      ->setRawContent($renderer
      ->renderRoot($build));
    $this
      ->assertText($field_content);
    $this
      ->assertArrayHasKey($field_name, $executable->field);
    $account_switcher
      ->switchTo($this->userWithoutAccess);
    $executable = Views::getView($view_id);
    $build = $executable
      ->preview();
    $this
      ->setRawContent($renderer
      ->renderRoot($build));

    // If this is a public permission, then the no access user can see it too.
    if ($this->fieldStorage
      ->getThirdPartySetting('field_permissions', 'permission_type') === FieldPermissionTypeInterface::ACCESS_PUBLIC) {
      $this
        ->assertText($field_content);
    }
    else {
      $this
        ->assertNoText($field_content);
    }
  }

}

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.
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.
ViewResultAssertionTrait::assertIdenticalResultset	protected	function	Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper	protected	function	Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset	protected	function	Verifies that a result set returned by a View differs from certain values.
ViewsFieldAccessTest::$entity	protected	property	An entity to test with.
ViewsFieldAccessTest::$field	protected	property	Field config on entity_test.
ViewsFieldAccessTest::$fieldStorage	protected	property	A field to test with.
ViewsFieldAccessTest::$modules	public static	property	Modules to enable. Overrides ViewsKernelTestBase::$modules
ViewsFieldAccessTest::$roleWithAccess	protected	property	Role with access.
ViewsFieldAccessTest::$roleWithoutAccess	protected	property	Role without access.
ViewsFieldAccessTest::$userWithAccess	protected	property	Stores an user entity with access to fields.
ViewsFieldAccessTest::$userWithoutAccess	protected	property	Stores an user entity without access to fields.
ViewsFieldAccessTest::assertFieldAccess	protected	function	Checks views field access on the test entity and field.
ViewsFieldAccessTest::setUp	public	function	Overrides ViewsKernelTestBase::setUp
ViewsFieldAccessTest::testCustomPermissions	public	function	Tests custom permissions.
ViewsFieldAccessTest::testPrivatePermissions	public	function	Tests private permissions.
ViewsFieldAccessTest::testPublicPermissions	public	function	Test default (public) permissions.
ViewsKernelTestBase::$testViews	public static	property	Views to be enabled.	126
ViewsKernelTestBase::dataSet	protected	function	Returns a very simple test dataset.	8
ViewsKernelTestBase::executeView	protected	function	Executes a view with debugging.
ViewsKernelTestBase::orderResultSet	protected	function	Orders a nested array containing a result set based on a given column.
ViewsKernelTestBase::schemaDefinition	protected	function	Returns the schema definition.	6
ViewsKernelTestBase::setUpFixtures	protected	function	Sets up the configuration and schema of views and views_test_data modules.	7
ViewsKernelTestBase::viewsData	protected	function	Returns the views data definition.	22

You are here

class ViewsFieldAccessTest in Field Permissions 8

Hierarchy

See also

File

Namespace

Members

API Navigation