You are here

Home » API reference » Organic groups 8 » OgRoleTest.php

class OgRoleTest in Organic groups 8

Same name in this branch
  1. 8 tests/src/Unit/OgRoleTest.php \Drupal\Tests\og\Unit\OgRoleTest
  2. 8 tests/src/Kernel/Entity/OgRoleTest.php \Drupal\Tests\og\Kernel\Entity\OgRoleTest

Test OG role creation.

@group og

Hierarchy

Expanded class hierarchy of OgRoleTest

File

tests/src/Kernel/Entity/OgRoleTest.php, line 20

Namespace

Drupal\Tests\og\Kernel\Entity
View source 
class OgRoleTest extends KernelTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'entity_test',
    'field',
    'node',
    'og',
    'system',
    'user',
  ];

  /**
   * The entity storage handler for Action entities.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $actionStorage;

  /**
   * The group type manager.
   *
   * @var \Drupal\og\GroupTypeManagerInterface
   */
  protected $groupTypeManager;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Test group types.
   *
   * @var \Drupal\Core\Config\Entity\ConfigEntityBundleBase[]
   */
  protected $groupTypes;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Installing needed schema.
    $this
      ->installConfig([
      'og',
    ]);
    $this
      ->installEntitySchema('entity_test');
    $this->actionStorage = $this->container
      ->get('entity_type.manager')
      ->getStorage('action');
    $this->groupTypeManager = $this->container
      ->get('og.group_type_manager');
    $this->entityTypeManager = $this->container
      ->get('entity_type.manager');

    // Create two test group types.
    foreach ([
      'node_type',
      'entity_test_bundle',
    ] as $entity_type_id) {
      $definition = $this->entityTypeManager
        ->getDefinition($entity_type_id);
      $values = [
        $definition
          ->getKey('id') => 'group',
        $definition
          ->getKey('label') => 'Group',
      ];
      $group_type = $this->entityTypeManager
        ->getStorage($entity_type_id)
        ->create($values);
      $group_type
        ->save();
      $this->groupTypes[$entity_type_id] = $group_type;
    }
  }

  /**
   * Testing OG role creation.
   */
  public function testRoleCreate() {

    /** @var \Drupal\og\Entity\OgRole $og_role */
    $og_role = OgRole::create();
    $og_role
      ->setName('content_editor')
      ->setLabel('Content editor')
      ->grantPermission(OgAccess::ADMINISTER_GROUP_PERMISSION);
    try {
      $og_role
        ->save();
      $this
        ->fail('Creating OG role without group type/bundle is not allowed.');
    } catch (ConfigValueException $e) {
      $this
        ->assertTrue(TRUE, 'OG role without bundle/group was not saved.');
    }
    $og_role
      ->setGroupType('node')
      ->setGroupBundle('group')
      ->save();

    /** @var \Drupal\og\Entity\OgRole $saved_role */
    $saved_role = $this
      ->loadUnchangedOgRole('node-group-content_editor');
    $this
      ->assertNotEmpty($saved_role, 'The role was created with the expected ID.');
    $this
      ->assertEquals($og_role
      ->id(), $saved_role
      ->id());

    // Checking creation of the role.
    $this
      ->assertEquals($og_role
      ->getPermissions(), [
      OgAccess::ADMINISTER_GROUP_PERMISSION,
    ]);

    // Check if the role is correctly recognized as a non-default role.
    $this
      ->assertFalse($og_role
      ->isRequired());

    // When a role is created the two accompanying actions to add or remove this
    // role to a membership should also be created.
    $action_ids = [
      'og_membership_add_single_role_action.content_editor',
      'og_membership_remove_single_role_action.content_editor',
    ];

    /** @var \Drupal\Core\Action\ActionInterface[] $actions */
    $actions = Action::loadMultiple($action_ids);
    foreach ($action_ids as $action_id) {
      $this
        ->assertTrue(array_key_exists($action_id, $actions));
      $this
        ->assertEquals($action_id, $actions[$action_id]
        ->id());
    }

    // Try to create the same role again.
    try {
      $og_role = OgRole::create();
      $og_role
        ->setName('content_editor')
        ->setLabel('Content editor')
        ->setGroupType('node')
        ->setGroupBundle('group')
        ->grantPermission(OgAccess::ADMINISTER_GROUP_PERMISSION)
        ->save();
      $this
        ->fail('OG role with the same ID can be saved.');
    } catch (EntityStorageException $e) {
      $this
        ->assertTrue(TRUE, "OG role with the same ID can not be saved.");
    }

    // Create a role assigned to a group type.
    $og_role = OgRole::create();
    $og_role
      ->setName('content_editor')
      ->setLabel('Content editor')
      ->setGroupType('entity_test_with_bundle')
      ->setGroupBundle('group')
      ->save();
    $this
      ->assertEquals('entity_test_with_bundle-group-content_editor', $og_role
      ->id());

    // Confirm role can be re-saved.
    $og_role
      ->save();

    // Confirm a role's ID cannot be changed.
    try {
      $og_role
        ->setId($og_role
        ->id() . 'foo');
      $this
        ->fail('Existing OG role ID can change.');
    } catch (OgRoleException $e) {
    }

    // Try to create the same role again.
    try {
      $og_role = OgRole::create();
      $og_role
        ->setName('content_editor')
        ->setLabel('Content editor')
        ->setGroupType('entity_test_with_bundle')
        ->setGroupBundle('group')
        ->save();
      $this
        ->fail('OG role with the same ID on the same group can be saved.');
    } catch (EntityStorageException $e) {
      $this
        ->assertTrue(TRUE, "OG role with the same ID on the same group can not be saved.");
    }

    // Try to save a role with an ID instead of a name. This is how the Config
    // system will create a role from data stored in a YAML file.
    $og_role = OgRole::create([
      'id' => 'entity_test_with_bundle-group-configurator',
      'label' => 'Configurator',
      'group_type' => 'entity_test_with_bundle',
      'group_bundle' => 'group',
    ]);
    $og_role
      ->save();
    $this
      ->assertNotEmpty($this
      ->loadUnchangedOgRole('entity_test_with_bundle-group-configurator'));

    // Check that we can retrieve the role name correctly. This was not
    // explicitly saved but it should be possible to derive this from the ID.
    $this
      ->assertEquals('configurator', $og_role
      ->getName());

    // When a role is saved with an ID that does not matches the pattern
    // 'entity type-bundle-role name' then an exception should be thrown.
    try {
      $og_role = OgRole::create();
      $og_role
        ->setId('entity_test_with_bundle-group-wrong_id')
        ->setName('content_editor')
        ->setLabel('Content editor')
        ->setGroupType('entity_test_with_bundle')
        ->setGroupBundle('group')
        ->save();
      $this
        ->fail('OG role with a non-matching ID can be saved.');
    } catch (ConfigValueException $e) {
      $this
        ->assertTrue(TRUE, "OG role with a non-matching ID can not be saved.");
    }

    // Delete the first group type. Doing this should automatically delete the
    // role that depends on the group type. The actions should still be present
    // since there still is one role left that references this role name.
    $this->groupTypes['node_type']
      ->delete();
    $role = OgRole::getRole('node', 'group', 'content_editor');
    $this
      ->assertEmpty($role);
    foreach ($action_ids as $action_id) {
      $action = $this->actionStorage
        ->loadUnchanged($action_id);
      $this
        ->assertEquals($action_id, $action
        ->id());
    }

    // Delete the last role that references the content editor. Now the two
    // actions should also be deleted.
    OgRole::getRole('entity_test_with_bundle', 'group', 'content_editor')
      ->delete();
    foreach ($action_ids as $action_id) {
      $action = $this->actionStorage
        ->loadUnchanged($action_id);
      $this
        ->assertEmpty($action);
    }
  }

  /**
   * Tests the creation and deletion of required roles.
   */
  public function testRequiredRoles() {

    // Check that the required roles are created when a new group type is
    // declared.
    foreach ([
      'node',
      'entity_test_with_bundle',
    ] as $entity_type_id) {
      $this->groupTypeManager
        ->addGroup($entity_type_id, 'group');
    }
    $required_roles = [];
    foreach ([
      OgRole::ANONYMOUS,
      OgRole::AUTHENTICATED,
    ] as $role_name) {
      foreach ([
        'node',
        'entity_test_with_bundle',
      ] as $group_type) {
        $role_id = "{$group_type}-group-{$role_name}";
        $required_role = OgRole::load($role_id);

        // Check that the role is actually a required role.
        $this
          ->assertTrue($required_role
          ->isRequired());

        // Check that the other data is correct.
        $this
          ->assertEquals($group_type, $required_role
          ->getGroupType());
        $this
          ->assertEquals('group', $required_role
          ->getGroupBundle());
        $this
          ->assertEquals($role_name, $required_role
          ->getName());

        // Keep track of the role so we can later test if they can be deleted.
        $required_roles[] = $required_role;
      }
    }

    // Required roles cannot be deleted, so an exception should be thrown when
    // trying to delete them when the group type still exists.
    foreach ($required_roles as $required_role) {
      try {
        $required_role
          ->delete();
        $this
          ->fail('A default role cannot be deleted.');
      } catch (OgRoleException $e) {
      }
    }

    // Delete the group types.
    foreach ($this->groupTypes as $group_type) {
      $group_type
        ->delete();
    }

    // The required roles are dependent on the group types so this action should
    // result in the deletion of the roles.
    foreach ($required_roles as $required_role) {
      $this
        ->assertEmpty($this
        ->loadUnchangedOgRole($required_role
        ->id()));
    }
  }

  /**
   * Loads the unchanged OgRole directly from the database.
   *
   * @param string $id
   *   The ID of the role to load.
   *
   * @return \Drupal\Core\Entity\EntityInterface|null
   *   The role, or NULL if there is no such role.
   */
  protected function loadUnchangedOgRole($id) {
    return $this->entityTypeManager
      ->getStorage('og_role')
      ->loadUnchanged($id);
  }

}

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.
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.
OgRoleTest::$actionStorage protected property The entity storage handler for Action entities.
OgRoleTest::$entityTypeManager protected property The entity type manager.
OgRoleTest::$groupTypeManager protected property The group type manager.
OgRoleTest::$groupTypes protected property Test group types.
OgRoleTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
OgRoleTest::loadUnchangedOgRole protected function Loads the unchanged OgRole directly from the database.
OgRoleTest::setUp protected function Overrides KernelTestBase::setUp
OgRoleTest::testRequiredRoles public function Tests the creation and deletion of required roles.
OgRoleTest::testRoleCreate public function Testing OG role creation.
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.