class GroupRoleSynchronizationTest in Group 8

Same name and namespace in other branches

2.0.x tests/src/Kernel/GroupRoleSynchronizationTest.php \Drupal\Tests\group\Kernel\GroupRoleSynchronizationTest

Tests whether group roles are actually synchronized.

@group group

View source

class GroupRoleSynchronizationTest extends GroupKernelTestBase {

  /**
   * The group role synchronizer service.
   *
   * @var \Drupal\group\GroupRoleSynchronizer
   */
  protected $groupRoleSynchronizer;

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

    // The sheer functionality of the synchronizer service is tested elsewhere
    // in \Drupal\Tests\group\Unit\GroupRoleSynchronizerTest, so we can rely on
    // it for the sake of this test.
    $this->groupRoleSynchronizer = $this->container
      ->get('group_role.synchronizer');
  }

  /**
   * Creates a user role.
   *
   * @param string $id
   *   The ID of the user role to create. Label will be set to the ID with the
   *   first letter converted to upper case.
   *
   * @return \Drupal\user\RoleInterface
   *   The created user role.
   */
  protected function createUserRole($id) {
    $role = $this->entityTypeManager
      ->getStorage('user_role')
      ->create([
      'id' => $id,
      'label' => ucfirst($id),
    ]);
    $role
      ->save();
    return $role;
  }

  /**
   * Tests whether a new user role syncs to group roles.
   *
   * @covers \Drupal\group\Entity\Storage\GroupRoleStorage::createSynchronized
   * @uses group_user_role_insert
   */
  public function testUserRoleCreation() {
    $role = $this
      ->createUserRole('editor');
    $defaultGroupRoleId = $this->groupRoleSynchronizer
      ->getGroupRoleId('default', $role
      ->id());
    $otherGroupRoleId = $this->groupRoleSynchronizer
      ->getGroupRoleId('other', $role
      ->id());
    $group_roles = $this->entityTypeManager
      ->getStorage('group_role')
      ->loadMultiple();
    $this
      ->assertArrayHasKey($defaultGroupRoleId, $group_roles, 'Synchronized role found for default group type');
    $this
      ->assertArrayHasKey($otherGroupRoleId, $group_roles, 'Synchronized role found for other group type');
    $this
      ->assertEquals($role
      ->label(), $group_roles[$otherGroupRoleId]
      ->label(), 'Synchronized roles share the same label');
    $this
      ->assertEquals($role
      ->getWeight(), $group_roles[$otherGroupRoleId]
      ->getWeight(), 'Synchronized roles share the same weight');
  }

  /**
   * Tests whether an updated user role syncs to group roles.
   *
   * @covers \Drupal\group\Entity\Storage\GroupRoleStorage::updateSynchronizedLabels
   * @depends testUserRoleCreation
   * @uses group_user_role_update
   */
  public function testUserRoleUpdate() {
    $role = $this
      ->createUserRole('editor');
    $role
      ->set('label', 'Super-editor');
    $role
      ->save();
    $defaultGroupRoleId = $this->groupRoleSynchronizer
      ->getGroupRoleId('default', $role
      ->id());
    $group_role = $this->entityTypeManager
      ->getStorage('group_role')
      ->load($defaultGroupRoleId);
    $this
      ->assertEquals('Super-editor', $group_role
      ->label(), 'Updated synchronized roles share the same label');
  }

  /**
   * Tests whether a deleted user role syncs to group roles.
   *
   * @coversNothing
   */
  public function testUserRoleDelete() {
    $role = $this
      ->createUserRole('editor');
    $role
      ->delete();
    $defaultGroupRoleId = $this->groupRoleSynchronizer
      ->getGroupRoleId('default', 'editor');
    $group_roles = $this->entityTypeManager
      ->getStorage('group_role')
      ->loadMultiple();
    $this
      ->assertArrayNotHasKey($defaultGroupRoleId, $group_roles, 'Synchronized role not found for deleted global role');
  }

  /**
   * Tests whether a new group type receives synchronized group roles.
   *
   * @covers \Drupal\group\Entity\Storage\GroupRoleStorage::createSynchronized
   * @uses \Drupal\group\Entity\GroupType::postSave
   */
  public function testGroupTypeCreation() {
    $role = $this
      ->createUserRole('editor');
    $group_type = $this->entityTypeManager
      ->getStorage('group_type')
      ->create([
      'id' => $this
        ->randomMachineName(),
      'label' => $this
        ->randomString(),
    ]);
    $group_type
      ->save();
    $group_roles = $this->entityTypeManager
      ->getStorage('group_role')
      ->loadMultiple();
    $group_role_id = $this->groupRoleSynchronizer
      ->getGroupRoleId($group_type
      ->id(), $role
      ->id());
    $this
      ->assertArrayHasKey($group_role_id, $group_roles, 'Synchronized role found for new group type');
  }

  /**
   * Tests whether a module with user roles receives synchronized group roles.
   *
   * @covers \Drupal\group\Entity\Storage\GroupRoleStorage::createSynchronized
   * @uses group_modules_installed
   */
  public function testModuleInstalled() {
    $defaultGroupRoleId = $this->groupRoleSynchronizer
      ->getGroupRoleId('default', 'test');
    $otherGroupRoleId = $this->groupRoleSynchronizer
      ->getGroupRoleId('other', 'test');
    $group_roles = $this->entityTypeManager
      ->getStorage('group_role')
      ->loadMultiple();
    $this
      ->assertArrayHasKey($defaultGroupRoleId, $group_roles, 'Synchronized role found for default group type');
    $this
      ->assertArrayHasKey($otherGroupRoleId, $group_roles, 'Synchronized role found for other group type');
    $this
      ->assertEquals('Test', $group_roles[$otherGroupRoleId]
      ->label(), 'Synchronized roles share the same label');
    $this
      ->assertEquals(99, $group_roles[$otherGroupRoleId]
      ->getWeight(), 'Synchronized roles share the same weight');
  }

  /**
   * Tests whether an imported group type receives synchronized group roles.
   *
   * @covers \Drupal\group\Entity\Storage\GroupRoleStorage::createSynchronized
   * @uses \Drupal\group\EventSubscriber\ConfigSubscriber::onConfigImport
   */
  public function testConfigImport() {
    $role = $this
      ->createUserRole('editor');

    // The system.site key is required for import validation.
    // See: https://www.drupal.org/project/drupal/issues/2995062
    $this
      ->installConfig([
      'system',
    ]);

    // Simulate config data to import.
    $active = $this->container
      ->get('config.storage');
    $sync = $this->container
      ->get('config.storage.sync');
    $this
      ->copyConfig($active, $sync);

    // Manually add the 'import' group type to the synchronization directory.
    $test_dir = __DIR__ . '/../../modules/group_test_config/sync';
    $sync_dir = Settings::get('config_sync_directory');
    $file_system = $this->container
      ->get('file_system');
    $file_system
      ->copy("{$test_dir}/group.type.import.yml", "{$sync_dir}/group.type.import.yml");
    $file_system
      ->copy("{$test_dir}/user.role.import.yml", "{$sync_dir}/user.role.import.yml");
    $file_system
      ->copy("{$test_dir}/group.role.import-eea2d6f47.yml", "{$sync_dir}/group.role.import-eea2d6f47.yml");

    // Import the content of the sync directory.
    $this
      ->configImporter()
      ->import();

    // Check that the synchronized group roles give priority to the Yaml files.
    $group_role_id = $this->groupRoleSynchronizer
      ->getGroupRoleId('import', 'import');

    /** @var \Drupal\group\Entity\GroupRoleInterface $from_yaml */
    $from_yaml = $this->entityTypeManager
      ->getStorage('group_role')
      ->load($group_role_id);
    $this
      ->assertEquals([
      'view group',
    ], $from_yaml
      ->getPermissions(), 'Synchronized role was created from Yaml file.');

    // Check that synchronized group roles are being created without Yaml files.
    $group_roles = $this->entityTypeManager
      ->getStorage('group_role')
      ->loadMultiple();
    $group_role_id = $this->groupRoleSynchronizer
      ->getGroupRoleId('import', $role
      ->id());
    $this
      ->assertArrayHasKey($group_role_id, $group_roles, 'Synchronized role found for imported group type');
  }

}

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.
DeprecatedServicePropertyTrait::__get	public	function	Allows to access deprecated/removed properties.
EntityKernelTestBase::$deprecatedProperties	protected	property	The list of deprecated services.
EntityKernelTestBase::$entityTypeManager	protected	property	The entity type manager service.	1
EntityKernelTestBase::$generatedIds	protected	property	A list of generated identifiers.
EntityKernelTestBase::$state	protected	property	The state service.
EntityKernelTestBase::createUser	protected	function	Creates a user.
EntityKernelTestBase::generateRandomEntityId	protected	function	Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo	protected	function	Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule	protected	function	Installs a module and refreshes services.
EntityKernelTestBase::refreshServices	protected	function	Refresh services.	1
EntityKernelTestBase::reloadEntity	protected	function	Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule	protected	function	Uninstalls a module and refreshes services.
GroupKernelTestBase::$modules	public static	property	@todo Refactor tests to not automatically use group_test_config unless they have a good reason to. Overrides EntityKernelTestBase::$modules	10
GroupKernelTestBase::$pluginManager	protected	property	The content enabler plugin manager.
GroupKernelTestBase::createGroup	protected	function	Creates a group.
GroupKernelTestBase::createGroupType	protected	function	Creates a group type.
GroupKernelTestBase::getCurrentUser	protected	function	Gets the current user so you can run some checks against them.
GroupRoleSynchronizationTest::$groupRoleSynchronizer	protected	property	The group role synchronizer service.
GroupRoleSynchronizationTest::createUserRole	protected	function	Creates a user role.
GroupRoleSynchronizationTest::setUp	protected	function	Overrides GroupKernelTestBase::setUp
GroupRoleSynchronizationTest::testConfigImport	public	function	Tests whether an imported group type receives synchronized group roles.
GroupRoleSynchronizationTest::testGroupTypeCreation	public	function	Tests whether a new group type receives synchronized group roles.
GroupRoleSynchronizationTest::testModuleInstalled	public	function	Tests whether a module with user roles receives synchronized group roles.
GroupRoleSynchronizationTest::testUserRoleCreation	public	function	Tests whether a new user role syncs to group roles.
GroupRoleSynchronizationTest::testUserRoleDelete	public	function	Tests whether a deleted user role syncs to group roles.
GroupRoleSynchronizationTest::testUserRoleUpdate	public	function	Tests whether an updated user role syncs to group roles.
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::__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. Aliased as: drupalCheckPermissions
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. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser	protected	function	Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser	protected	function	Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser

You are here

class GroupRoleSynchronizationTest in Group 8

Hierarchy

File

Namespace

Members

API Navigation