You are here

Home » API reference » Book access 1.x » BookAccessDefaultsTest.php

class BookAccessDefaultsTest in Book access 1.x

Tests the BookAccessDefaults entity.

@group book_access

Hierarchy

Expanded class hierarchy of BookAccessDefaultsTest

File

tests/src/Kernel/BookAccessDefaultsTest.php, line 14

Namespace

Drupal\book_access
View source 
class BookAccessDefaultsTest extends KernelTestBase {
  use RandomGeneratorTrait;

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'system',
    'node',
    'user',
    'book',
    'book_access',
  ];

  /**
   * The storage manager.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $defaultStorage;

  /**
   * Create a role.
   *
   * @return \Drupal\Core\Entity\EntityBase|\Drupal\Core\Entity\EntityInterface
   *   The role
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function createRole() {
    $role1 = Role::create([
      'id' => 'test_role1',
      'name' => $this
        ->randomString(),
    ]);
    $role1
      ->save();
    return $role1;
  }

  /**
   * Setup common code for test cases.
   */
  protected function setup() : void {
    parent::setUp();
    $this
      ->installSchema('system', 'sequences');
    $this
      ->installConfig('system');
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('node');
    $this
      ->installConfig('user');
    $this
      ->installConfig('book');
    $this
      ->installConfig('book_access');
    $this->defaultStorage = \Drupal::entityTypeManager()
      ->getStorage('book_access_defaults');
  }

  /**
   * Test that default config is created on install.   *.
   */
  public function testInstallCreatesDefaultConfig() {
    $query = $this->defaultStorage
      ->getQuery();
    $results = $query
      ->condition('grant_type', 'author')
      ->execute();
    $this
      ->assertIsArray($results, "Results are not available. Not an array");
    $this
      ->assertEqual(count($results), 1, "One result expected.");
    $query = \Drupal::entityTypeManager()
      ->getStorage('book_access_defaults')
      ->getQuery();
    $results = $query
      ->condition('grant_type', 'role')
      ->execute();
    $this
      ->assertIsArray($results, "Results are not available. Not an array");
    $this
      ->assertEqual(count($results), 3, "Three results expected.");
  }

  /**
   * Test that config can be updated.
   */
  public function testUpdatingConfig() {

    // Load initial config.
    $query = $this->defaultStorage
      ->getQuery();

    // Load authenticated role, expect FALSE for grant_add_child.
    $results = $query
      ->condition('role_id', 'authenticated')
      ->execute();
    $this
      ->assertIsArray($results, "Results are not available. Not an array");
    $this
      ->assertEqual(count($results), 1, "One result expected.");

    /** @var $config \Drupal\book_access\Entity\BookAccessDefaultsInterface */
    $config = $this->defaultStorage
      ->load(current($results));
    $grants = $config
      ->getGrants();
    $this
      ->assertEqual($grants['grant_add_child'], FALSE, "Grant add child expected FALSE.");

    // Update config.
    $grants['grant_add_child'] = TRUE;
    $config
      ->set('grants', $grants)
      ->save();

    // Reload, expect TRUE this time for grant_add_child.
    $query2 = $this->defaultStorage
      ->getQuery();
    $results = $query2
      ->condition('role_id', 'authenticated')
      ->execute();
    $this
      ->assertIsArray($results, "Results are not available. Not an array");
    $this
      ->assertEqual(count($results), 1, "One result expected.");

    /** @var $config \Drupal\book_access\Entity\BookAccessDefaultsInterface */
    $config = $this->defaultStorage
      ->load(current($results));
    $grants = $config
      ->getGrants();
    $this
      ->assertEqual($grants['grant_add_child'], TRUE, "Grant add child expected TRUE.");
  }

  /**
   * Test that adding a new role adds the corresponding BookAccessDefaults.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function testAddingRoleAddsConfig() {
    $role1 = $this
      ->createRole();
    $query = $this->defaultStorage
      ->getQuery();

    // Load BookAccessDefaults for new role.
    $results = $query
      ->condition('role_id', $role1
      ->id())
      ->execute();
    $this
      ->assertIsArray($results, "Results are not available. Not an array");
    $this
      ->assertEqual(count($results), 1, "One result expected.");
  }

  /**
   * Test that deleting a role deletes the corresponding BookAccessDefaults.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function testDeletingRoleDeletesConfig() {
    $role1 = $this
      ->createRole();
    $query = $this->defaultStorage
      ->getQuery();

    // Load BookAccessDefaults for new role.
    $results = $query
      ->condition('role_id', $role1
      ->id())
      ->execute();
    $this
      ->assertIsArray($results, "Results are not available. Not an array");
    $this
      ->assertEqual(count($results), 1, "One result expected.");
    $config = $this->defaultStorage
      ->load(current($results));
    $config_id = $config
      ->id();
    $role1
      ->delete();

    // Reload config.
    $config = NULL;
    $query = $this->defaultStorage
      ->getQuery();
    $results = $query
      ->condition('id', $config_id)
      ->execute();
    $this
      ->assertEqual(count($results), 0, "Zero results expected.");
  }

}

Members

Namesort descending 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.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
BookAccessDefaultsTest::$defaultStorage protected property The storage manager.
BookAccessDefaultsTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
BookAccessDefaultsTest::createRole public function Create a role.
BookAccessDefaultsTest::setup protected function Setup common code for test cases.
BookAccessDefaultsTest::testAddingRoleAddsConfig public function Test that adding a new role adds the corresponding BookAccessDefaults.
BookAccessDefaultsTest::testDeletingRoleDeletesConfig public function Test that deleting a role deletes the corresponding BookAccessDefaults.
BookAccessDefaultsTest::testInstallCreatesDefaultConfig public function Test that default config is created on install. *.
BookAccessDefaultsTest::testUpdatingConfig public function Test that config can be updated.
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.
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. 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. 3
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::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 24
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::setUp protected function 334
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 4
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
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::$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.