class NodeAccessTestBase
Defines a base class for node access kernel tests.
Hierarchy
- class \Drupal\KernelTests\KernelTestBase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\ExtensionListTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait extends \PHPUnit\Framework\TestCase- class \Drupal\Tests\node\Kernel\NodeAccessTestBase uses \Drupal\Tests\node\Traits\NodeCreationTrait, \Drupal\Tests\user\Traits\UserCreationTrait, \Drupal\Tests\node\Traits\ContentTypeCreationTrait extends \Drupal\KernelTests\KernelTestBase
 
Expanded class hierarchy of NodeAccessTestBase
File
- 
              core/modules/ node/ tests/ src/ Kernel/ NodeAccessTestBase.php, line 18 
Namespace
Drupal\Tests\node\KernelView source
abstract class NodeAccessTestBase extends KernelTestBase {
  use NodeCreationTrait {
    getNodeByTitle as drupalGetNodeByTitle;
    createNode as drupalCreateNode;
  }
  use UserCreationTrait {
    createUser as drupalCreateUser;
    createRole as drupalCreateRole;
    createAdminRole as drupalCreateAdminRole;
  }
  use ContentTypeCreationTrait {
    createContentType as drupalCreateContentType;
  }
  
  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'node',
    'datetime',
    'user',
    'system',
    'filter',
    'field',
    'text',
  ];
  
  /**
   * Access handler.
   *
   * @var \Drupal\Core\Entity\EntityAccessControlHandlerInterface
   */
  protected $accessHandler;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->installSchema('node', 'node_access');
    $this->installEntitySchema('user');
    $this->installEntitySchema('node');
    $this->installConfig('filter');
    $this->installConfig('node');
    $this->accessHandler = \Drupal::entityTypeManager()->getAccessControlHandler('node');
    // Clear permissions for authenticated users.
    $this->config('user.role.' . RoleInterface::AUTHENTICATED_ID)
      ->set('permissions', [])
      ->save();
    // Create user 1 who has special permissions.
    $this->drupalCreateUser();
    // Create a node type.
    $this->drupalCreateContentType([
      'type' => 'page',
      'name' => 'Basic page',
      'display_submitted' => FALSE,
    ]);
  }
  
  /**
   * Asserts that node access correctly grants or denies access.
   *
   * @param array $ops
   *   An associative array of the expected node access grants for the node
   *   and account, with each key as the name of an operation (e.g. 'view',
   *   'delete') and each value a Boolean indicating whether access to that
   *   operation should be granted.
   * @param \Drupal\node\NodeInterface $node
   *   The node object to check.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user account for which to check access.
   *
   * @internal
   */
  public function assertNodeAccess(array $ops, NodeInterface $node, AccountInterface $account) {
    foreach ($ops as $op => $result) {
      $this->assertEquals($result, $this->accessHandler
        ->access($node, $op, $account), $this->nodeAccessAssertMessage($op, $result, $node->language()
        ->getId()));
    }
  }
  
  /**
   * Asserts that node create access correctly grants or denies access.
   *
   * @param string $bundle
   *   The node bundle to check access to.
   * @param bool $result
   *   Whether access should be granted or not.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user account for which to check access.
   * @param string|null $langcode
   *   (optional) The language code indicating which translation of the node
   *   to check. If NULL, the untranslated (fallback) access is checked.
   *
   * @internal
   */
  public function assertNodeCreateAccess(string $bundle, bool $result, AccountInterface $account, ?string $langcode = NULL) {
    $this->assertEquals($result, $this->accessHandler
      ->createAccess($bundle, $account, [
      'langcode' => $langcode,
    ]), $this->nodeAccessAssertMessage('create', $result, $langcode));
  }
  
  /**
   * Constructs an assert message to display which node access was tested.
   *
   * @param string $operation
   *   The operation to check access for.
   * @param bool $result
   *   Whether access should be granted or not.
   * @param string|null $langcode
   *   (optional) The language code indicating which translation of the node
   *   to check. If NULL, the untranslated (fallback) access is checked.
   *
   * @return string
   *   An assert message string which contains information in plain English
   *   about the node access permission test that was performed.
   */
  public function nodeAccessAssertMessage($operation, $result, $langcode = NULL) {
    return sprintf('Node access returns %s with operation %s, language code %s.', $result ? 'true' : 'false', $operation, !empty($langcode) ? $langcode : 'empty');
  }
}Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | 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 raw text IS NOT found escaped on 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::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. | ||||
| 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. | ||||
| ContentTypeCreationTrait::createContentType | protected | function | Creates a custom content type based on default settings. | Aliased as: drupalCreateContentType | 1 | ||
| ExtensionListTestTrait::getModulePath | protected | function | Gets the path for the specified module. | ||||
| ExtensionListTestTrait::getThemePath | protected | function | Gets the path for the specified theme. | ||||
| 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. | 6 | |||
| KernelTestBase::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | 3 | |||
| KernelTestBase::$container | protected | property | |||||
| KernelTestBase::$databasePrefix | protected | property | |||||
| KernelTestBase::$keyValue | protected | property | The key_value service that must persist between container rebuilds. | ||||
| 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. | 9 | |||
| KernelTestBase::$usesSuperUserAccessPolicy | protected | property | Set to TRUE to make user 1 a super user. | 7 | |||
| 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 | protected | function | Bootstraps a kernel for a test. | 1 | |||
| 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. | 1 | |||
| 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. | 2 | |||
| KernelTestBase::getDatabasePrefix | public | function | |||||
| KernelTestBase::getExtensionsForModules | private | function | Returns Extension objects for $modules to install. | ||||
| KernelTestBase::getModulesToEnable | private static | function | Returns the modules to install 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::register | public | function | Registers test-specific services. | Overrides ServiceProviderInterface::register | 27 | ||
| 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 | Deprecated | 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 | public | function | |||||
| KernelTestBase::__sleep | public | function | Prevents serializing any properties. | ||||
| NodeAccessTestBase::$accessHandler | protected | property | Access handler. | ||||
| NodeAccessTestBase::$modules | protected static | property | Modules to install. | Overrides KernelTestBase::$modules | 5 | ||
| NodeAccessTestBase::assertNodeAccess | public | function | Asserts that node access correctly grants or denies access. | ||||
| NodeAccessTestBase::assertNodeCreateAccess | public | function | Asserts that node create access correctly grants or denies access. | ||||
| NodeAccessTestBase::nodeAccessAssertMessage | public | function | Constructs an assert message to display which node access was tested. | ||||
| NodeAccessTestBase::setUp | protected | function | Overrides KernelTestBase::setUp | 4 | |||
| NodeCreationTrait::createNode | protected | function | Creates a node based on default settings. | Aliased as: drupalCreateNode | |||
| NodeCreationTrait::getNodeByTitle | public | function | Get a node from the database based on its title. | Aliased as: drupalGetNodeByTitle | |||
| PhpUnitWarnings::$deprecationWarnings | private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | ||||
| PhpUnitWarnings::addWarning | public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | ||||
| 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. | ||||
| 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 | Deprecated | 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 | Deprecated | private | function | Checks missing module requirements. | |||
| TestRequirementsTrait::checkRequirements | Deprecated | protected | function | Check module requirements for the Drupal use case. | |||
| 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. | Aliased as: drupalCreateAdminRole | |||
| UserCreationTrait::createRole | protected | function | Creates a role with specified permissions. | Aliased as: drupalCreateRole | |||
| UserCreationTrait::createUser | protected | function | Create a user with a given set of permissions. | Aliased as: drupalCreateUser | |||
| 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. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
