group-8.x-1.x-dev/tests/src/Kernel/GroupRoleStorageTest.php

<?php

namespace Drupal\Tests\group\Kernel;

use Drupal\group\Entity\GroupMembership;
use Drupal\group\Entity\GroupMembershipInterface;
use Drupal\group\Entity\Storage\GroupRoleStorageInterface;
use Drupal\group\PermissionScopeInterface;
use Drupal\user\RoleInterface;

/**
 * Tests the behavior of group role storage handler.
 *
 * @coversDefaultClass \Drupal\group\Entity\Storage\GroupRoleStorage
 * @group group
 */
class GroupRoleStorageTest extends GroupKernelTestBase {

  /**
   * The group to run tests with.
   *
   * @var \Drupal\group\Entity\GroupInterface
   */
  protected $group;

  /**
   * The user to get added to the test group.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $account;

  /**
   * {@inheritdoc}
   */
  protected function setUp(): void {
    parent::setUp();
    $this->group = $this->createGroup(['type' => $this->createGroupType()->id()]);
    $this->account = $this->createUser();
  }

  /**
   * Tests the loading of group roles by user and group.
   *
   * @covers ::loadByUserAndGroup
   */
  public function testLoadByUserAndGroup() {
    // Add a dummy group type with role to make sure we do not return said role.
    $this->createGroupRole([
      'group_type' => $this->createGroupType()->id(),
      'scope' => PermissionScopeInterface::OUTSIDER_ID,
      'global_role' => RoleInterface::AUTHENTICATED_ID,
    ]);

    $outsider_role = $this->createGroupRole([
      'group_type' => $this->group->bundle(),
      'scope' => PermissionScopeInterface::OUTSIDER_ID,
      'global_role' => RoleInterface::AUTHENTICATED_ID,
    ]);
    $this->compareMemberRoles([], FALSE, 'User has no individual group roles as they are not a member.');
    $this->compareMemberRoles([$outsider_role->id()], TRUE, 'User initially has synchronized outsider role.');

    // Create and assign a random Drupal role.
    $storage = $this->entityTypeManager->getStorage('user_role');
    $user_role = $storage->create([
      'id' => $this->randomMachineName(),
      'label' => $this->randomString(),
    ]);
    $storage->save($user_role);
    $this->account->addRole($user_role->id());
    $this->account->save();

    // Create an outsider role that synchronizes with the Drupal role.
    $group_role = $this->createGroupRole([
      'group_type' => $this->group->bundle(),
      'scope' => PermissionScopeInterface::OUTSIDER_ID,
      'global_role' => $user_role->id(),
    ]);
    $this->compareMemberRoles([], FALSE, 'User has no individual group roles as they are not a member.');
    $this->compareMemberRoles([$outsider_role->id(), $group_role->id()], TRUE, 'User has synchronized outsider roles.');

    // From this point on we test with the user as a member.
    $insider_role = $this->createGroupRole([
      'group_type' => $this->group->bundle(),
      'scope' => PermissionScopeInterface::INSIDER_ID,
      'global_role' => RoleInterface::AUTHENTICATED_ID,
    ]);
    $this->group->addMember($this->account);
    $this->compareMemberRoles([], FALSE, 'User still has no explicit group roles.');
    $this->compareMemberRoles([$insider_role->id()], TRUE, 'User has synchronized insider role now that they have joined the group.');

    // Grant the member a new group role and check the storage.
    $individual_role = $this->createGroupRole([
      'group_type' => $this->group->bundle(),
      'scope' => PermissionScopeInterface::INDIVIDUAL_ID,
    ]);

    $membership = $this->group->getMember($this->account);
    $membership->addRole($individual_role->id());
    $this->compareMemberRoles([$individual_role->id()], FALSE, 'User has the individual group role.');
    $this->compareMemberRoles([$individual_role->id(), $insider_role->id()], TRUE, 'User also has synchronized insider role.');
  }

  /**
   * Tests checking whether a group role is assigned to someone.
   *
   * @covers ::hasMembershipReferences
   */
  public function testHasMembershipReferences() {
    $storage = $this->entityTypeManager->getStorage('group_role');
    assert($storage instanceof GroupRoleStorageInterface);

    $group_role_a = $this->createGroupRole([
      'group_type' => $this->group->bundle(),
      'scope' => PermissionScopeInterface::INDIVIDUAL_ID,
    ]);
    $group_role_b = $this->createGroupRole([
      'group_type' => $this->group->bundle(),
      'scope' => PermissionScopeInterface::INDIVIDUAL_ID,
    ]);

    $this->assertFalse($storage->hasMembershipReferences([$group_role_a->id()]), 'Group role A is not referenced right after creation.');
    $this->assertFalse($storage->hasMembershipReferences([$group_role_b->id()]), 'Group role B is not referenced right after creation.');
    $this->assertFalse($storage->hasMembershipReferences([$group_role_a->id(), $group_role_b->id()]), 'Group roles are not referenced right after creation.');

    $this->group->addMember($this->account);
    $this->assertFalse($storage->hasMembershipReferences([$group_role_a->id()]), 'Group role A is not referenced after a member is created.');
    $this->assertFalse($storage->hasMembershipReferences([$group_role_b->id()]), 'Group role B is not referenced after a member is created.');
    $this->assertFalse($storage->hasMembershipReferences([$group_role_a->id(), $group_role_b->id()]), 'Group roles are not referenced after a member is created.');

    $membership = GroupMembership::loadSingle($this->group, $this->account);
    assert($membership instanceof GroupMembershipInterface);
    $membership->addRole($group_role_a->id());
    $this->assertTrue($storage->hasMembershipReferences([$group_role_a->id()]), 'Group role A is referenced after a member was assigned group role A.');
    $this->assertFalse($storage->hasMembershipReferences([$group_role_b->id()]), 'Group role B is not referenced after a member was assigned group role A.');
    $this->assertTrue($storage->hasMembershipReferences([$group_role_a->id(), $group_role_b->id()]), 'Group role A is referenced after a member was assigned group role A.');

    $membership->removeRole($group_role_a->id());
    $this->assertFalse($storage->hasMembershipReferences([$group_role_a->id()]), 'Group role A is not referenced after a member was revoked group role A.');
    $this->assertFalse($storage->hasMembershipReferences([$group_role_b->id()]), 'Group role B is not referenced after a member was revoked group role A.');
    $this->assertFalse($storage->hasMembershipReferences([$group_role_a->id(), $group_role_b->id()]), 'Group role A is referenced after a member was revoked group role A.');
  }

  /**
   * Tests the deleting of a group role's assignments.
   *
   * @covers ::deleteMembershipReferences
   * @depends testHasMembershipReferences
   */
  public function testDeleteMembershipReferences() {
    $storage = $this->entityTypeManager->getStorage('group_role');
    assert($storage instanceof GroupRoleStorageInterface);

    $group_role_a = $this->createGroupRole([
      'group_type' => $this->group->bundle(),
      'scope' => PermissionScopeInterface::INDIVIDUAL_ID,
    ]);
    $group_role_b = $this->createGroupRole([
      'group_type' => $this->group->bundle(),
      'scope' => PermissionScopeInterface::INDIVIDUAL_ID,
    ]);
    $group_role_c = $this->createGroupRole([
      'group_type' => $this->group->bundle(),
      'scope' => PermissionScopeInterface::INDIVIDUAL_ID,
    ]);

    $group_role_ids = [
      $group_role_a->id(),
      $group_role_b->id(),
      $group_role_c->id(),
    ];
    $this->group->addMember($this->account, ['group_roles' => $group_role_ids]);
    $this->assertTrue($storage->hasMembershipReferences([$group_role_a->id()]));
    $this->assertTrue($storage->hasMembershipReferences([$group_role_b->id()]));
    $this->assertTrue($storage->hasMembershipReferences([$group_role_c->id()]));
    $this->assertTrue($storage->hasMembershipReferences([$group_role_a->id(), $group_role_b->id(), $group_role_c->id()]));

    // Check whether the membership entity is also correct.
    $membership = GroupMembership::loadSingle($this->group, $this->account);
    assert($membership instanceof GroupMembershipInterface);
    $this->assertSame($group_role_ids, array_keys($membership->getRoles()));

    // Delete a single reference.
    $storage->deleteMembershipReferences([$group_role_a->id()]);
    $this->assertFalse($storage->hasMembershipReferences([$group_role_a->id()]));
    $this->assertTrue($storage->hasMembershipReferences([$group_role_b->id()]));
    $this->assertTrue($storage->hasMembershipReferences([$group_role_c->id()]));
    $this->assertTrue($storage->hasMembershipReferences([$group_role_a->id(), $group_role_b->id(), $group_role_c->id()]));

    // Check whether the membership entity is also updated.
    $this->assertSame([$group_role_b->id(), $group_role_c->id()], array_keys($membership->getRoles()));

    // Delete multiple references.
    $storage->deleteMembershipReferences([$group_role_b->id(), $group_role_c->id()]);
    $this->assertFalse($storage->hasMembershipReferences([$group_role_a->id()]));
    $this->assertFalse($storage->hasMembershipReferences([$group_role_b->id()]));
    $this->assertFalse($storage->hasMembershipReferences([$group_role_c->id()]));
    $this->assertFalse($storage->hasMembershipReferences([$group_role_a->id(), $group_role_b->id(), $group_role_c->id()]));

    // Check whether the membership entity is also updated.
    $this->assertSame([], array_keys($membership->getRoles()));
  }

  /**
   * Asserts that the test user's group roles match a provided list of IDs.
   *
   * @param string[] $expected
   *   The group role IDs we expect the user to have.
   * @param bool $include_synchronized
   *   Whether to include synchronized group roles.
   * @param string $message
   *   The message to display for the assertion.
   */
  protected function compareMemberRoles($expected, $include_synchronized, $message) {
    $storage = $this->entityTypeManager->getStorage('group_role');
    $group_roles = $storage->loadByUserAndGroup($this->account, $this->group, $include_synchronized);
    $this->assertEqualsCanonicalizing($expected, array_keys($group_roles), $message);
  }

}