You are here

class GetUserGroupsTest in Organic groups 8

Tests getting the memberships of an entity.

@group og @coversDefaultClass \Drupal\og\MembershipManager

Hierarchy

Expanded class hierarchy of GetUserGroupsTest

File

tests/src/Kernel/Entity/GetUserGroupsTest.php, line 22

Namespace

Drupal\Tests\og\Kernel\Entity
View source
class GetUserGroupsTest extends KernelTestBase {
  use OgMembershipCreationTrait;

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

  /**
   * The OG membership manager.
   *
   * @var \Drupal\og\MembershipManagerInterface
   */
  protected $membershipManager;

  /**
   * A user object.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $user1;

  /**
   * A user object.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $user2;

  /**
   * A user object.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $user3;

  /**
   * A group entity.
   *
   * @var \Drupal\entity_test\Entity\EntityTest
   */
  protected $group1;

  /**
   * A group entity.
   *
   * @var \Drupal\entity_test\Entity\EntityTest
   */
  protected $group2;

  /**
   * The machine name of the group node type.
   *
   * @var string
   */
  protected $groupBundle;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->installConfig([
      'og',
    ]);
    $this
      ->installEntitySchema('og_membership');
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('entity_test');
    $this
      ->installSchema('system', 'sequences');
    $this->membershipManager = $this->container
      ->get('og.membership_manager');
    $this->groupBundle = mb_strtolower($this
      ->randomMachineName());

    // Create users.
    $this->user1 = User::create([
      'name' => $this
        ->randomString(),
    ]);
    $this->user1
      ->save();
    $this->user2 = User::create([
      'name' => $this
        ->randomString(),
    ]);
    $this->user2
      ->save();
    $this->user3 = User::create([
      'name' => $this
        ->randomString(),
    ]);
    $this->user3
      ->save();

    // Define the group content as group.
    Og::groupTypeManager()
      ->addGroup('entity_test', $this->groupBundle);

    // Create a group and associate with user 1.
    $this->group1 = EntityTest::create([
      'type' => $this->groupBundle,
      'name' => $this
        ->randomString(),
      'user_id' => $this->user1
        ->id(),
    ]);
    $this->group1
      ->save();

    // Create a group and associate with user 2.
    $this->group2 = EntityTest::create([
      'type' => $this->groupBundle,
      'name' => $this
        ->randomString(),
      'user_id' => $this->user2
        ->id(),
    ]);
    $this->group2
      ->save();
  }

  /**
   * Tests group owners have the correct groups.
   *
   * @todo Convert Og::isMember() calls to $this->membershipManager->isMember().
   */
  public function testOwnerGroupsOnly() {
    $actual = $this->membershipManager
      ->getUserGroups($this->user1
      ->id());
    $this
      ->assertCount(1, $actual['entity_test']);
    $this
      ->assertGroupExistsInResults($this->group1, $actual);

    // Also check isMember.
    $this
      ->assertTrue(Og::isMember($this->group1, $this->user1));
    $this
      ->assertFalse(Og::isMember($this->group1, $this->user2));
    $actual = $this->membershipManager
      ->getUserGroups($this->user2
      ->id());
    $this
      ->assertCount(1, $actual['entity_test']);
    $this
      ->assertGroupExistsInResults($this->group2, $actual);

    // Also check isMember.
    $this
      ->assertTrue(Og::isMember($this->group2, $this->user2));
    $this
      ->assertFalse(Og::isMember($this->group2, $this->user1));
  }

  /**
   * Tests other groups users are added to.
   *
   * @todo Convert Og::isMember() calls to $this->membershipManager->isMember().
   */
  public function testOtherGroups() {

    // Should not be a part of any groups.
    $this
      ->assertEquals([], $this->membershipManager
      ->getUserGroups($this->user3
      ->id()));
    $this
      ->assertFalse(Og::isMember($this->group1, $this->user3));
    $this
      ->assertFalse(Og::isMember($this->group2, $this->user3));

    // Invalidate the caches so the static cache is cleared and group data is
    // fetched again for the user.
    Og::invalidateCache();

    // Add user to group 1 should now return that group only.
    $this
      ->createOgMembership($this->group1, $this->user3);
    $actual = $this->membershipManager
      ->getUserGroups($this->user3
      ->id());
    $this
      ->assertCount(1, $actual['entity_test']);
    $this
      ->assertGroupExistsInResults($this->group1, $actual);
    $this
      ->assertTrue(Og::isMember($this->group1, $this->user3));
    $this
      ->assertFalse(Og::isMember($this->group2, $this->user3));
    Og::invalidateCache();

    // Add to group 2 should also return that.
    $this
      ->createOgMembership($this->group2, $this->user3);
    $actual = $this->membershipManager
      ->getUserGroups($this->user3
      ->id());
    $this
      ->assertCount(2, $actual['entity_test']);
    $this
      ->assertGroupExistsInResults($this->group1, $actual);
    $this
      ->assertGroupExistsInResults($this->group2, $actual);
    $this
      ->assertTrue(Og::isMember($this->group1, $this->user3));
    $this
      ->assertTrue(Og::isMember($this->group2, $this->user3));
  }

  /**
   * Tests member methods for states that other groups users are added to.
   *
   * @todo Convert Og::isMember() calls to $this->membershipManager->isMember().
   */
  public function testIsMemberStates() {

    // Add user to group 1 should now return that group only.
    $membership = $this
      ->createOgMembership($this->group1, $this->user3);

    // Default param is ACTIVE.
    $this
      ->assertTrue(Og::isMember($this->group1, $this->user3));
    $this
      ->assertFalse(Og::isMember($this->group1, $this->user3, [
      OgMembershipInterface::STATE_PENDING,
    ]));
    $this
      ->assertFalse(Og::isMember($this->group1, $this->user3, [
      OgMembershipInterface::STATE_BLOCKED,
    ]));
    $this
      ->assertFalse(Og::isMember($this->group1, $this->user3, [
      OgMembershipInterface::STATE_PENDING,
      OgMembershipInterface::STATE_BLOCKED,
    ]));
    $this
      ->assertFalse(Og::isMemberPending($this->group1, $this->user3));
    $this
      ->assertFalse(Og::isMemberBlocked($this->group1, $this->user3));

    // Change the membership state to PENDING.
    $membership
      ->setState(OgMembershipInterface::STATE_PENDING)
      ->save();
    Og::invalidateCache();
    $this
      ->assertTrue(Og::isMember($this->group1, $this->user3, [
      OgMembershipInterface::STATE_PENDING,
    ]));
    $this
      ->assertTrue(Og::isMemberPending($this->group1, $this->user3));
    $this
      ->assertTrue(Og::isMember($this->group1, $this->user3, [
      OgMembershipInterface::STATE_PENDING,
      OgMembershipInterface::STATE_BLOCKED,
    ]));
    $this
      ->assertFalse(Og::isMember($this->group1, $this->user3));
    $this
      ->assertFalse(Og::isMember($this->group1, $this->user3, [
      OgMembershipInterface::STATE_BLOCKED,
    ]));
    $this
      ->assertFalse(Og::isMemberBlocked($this->group1, $this->user3));

    // Change the membership state to BLOCKED.
    $membership
      ->setState(OgMembershipInterface::STATE_BLOCKED)
      ->save();
    Og::invalidateCache();
    $this
      ->assertTrue(Og::isMember($this->group1, $this->user3, [
      OgMembershipInterface::STATE_BLOCKED,
    ]));
    $this
      ->assertTrue(Og::isMemberBlocked($this->group1, $this->user3));
    $this
      ->assertTrue(Og::isMember($this->group1, $this->user3, [
      OgMembershipInterface::STATE_PENDING,
      OgMembershipInterface::STATE_BLOCKED,
    ]));
    $this
      ->assertFalse(Og::isMember($this->group1, $this->user3));
    $this
      ->assertFalse(Og::isMember($this->group1, $this->user3, [
      OgMembershipInterface::STATE_PENDING,
    ]));
    $this
      ->assertFalse(Og::isMemberPending($this->group1, $this->user3));
  }

  /**
   * Tests retrieval of groups filtered by roles.
   *
   * @covers ::getUserGroupIdsByRoleIds
   */
  public function testGetGroupsByRoles() {

    // Create a test role.
    $extra_role_1 = OgRole::create();
    $extra_role_1
      ->setName('extra_role_1')
      ->setLabel(mb_strtolower($this
      ->randomString()))
      ->setGroupType('entity_test')
      ->setGroupBundle($this->groupBundle)
      ->save();

    // Retrieve the default role for a member.
    $member_role = OgRole::getRole('entity_test', $this->groupBundle, OgRoleInterface::AUTHENTICATED);

    // Create memberships for the test user in the groups. The user will have
    // the normal member role in group 1 and both the normal member role and the
    // test role in group 2. In group 2 the user will have the blocked status so
    // we can test filtering by status.
    $this
      ->createOgMembership($this->group1, $this->user3);
    $this
      ->createOgMembership($this->group2, $this->user3, [
      $extra_role_1
        ->getName(),
    ], OgMembershipInterface::STATE_BLOCKED);

    // By default only active memberships are retrieved, so if we ask the
    // groups where the user is a normal member of the result should not include
    // group 2 where our test user is blocked.
    $groups = $this->membershipManager
      ->getUserGroupIdsByRoleIds($this->user3
      ->id(), [
      $member_role
        ->id(),
    ]);
    $this
      ->assertCount(1, $groups['entity_test']);
    $actual = reset($groups['entity_test']);
    $this
      ->assertEquals($this->group1
      ->id(), $actual);

    // When asking for the groups where our user has the test role, the result
    // should not include the blocked membership, so it should be empty.
    $groups = $this->membershipManager
      ->getUserGroupsByRoleIds($this->user3
      ->id(), [
      $extra_role_1
        ->id(),
    ]);
    $this
      ->assertCount(0, $groups);

    // Include all states.
    $groups = $this->membershipManager
      ->getUserGroupIdsByRoleIds($this->user3
      ->id(), [
      $member_role
        ->id(),
    ], OgMembershipInterface::ALL_STATES, FALSE);
    $this
      ->assertCount(2, $groups['entity_test']);

    // Request any of multiple roles.
    $groups = $this->membershipManager
      ->getUserGroupsByRoleIds($this->user3
      ->id(), [
      $member_role
        ->id(),
      $extra_role_1
        ->id(),
    ], OgMembershipInterface::ALL_STATES, FALSE);
    $this
      ->assertCount(2, $groups['entity_test']);

    // Request all of multiple roles.
    $groups = $this->membershipManager
      ->getUserGroupsByRoleIds($this->user3
      ->id(), [
      $member_role
        ->id(),
      $extra_role_1
        ->id(),
    ], OgMembershipInterface::ALL_STATES, TRUE);
    $this
      ->assertCount(1, $groups['entity_test']);
    $actual = reset($groups['entity_test']);
    $this
      ->assertEquals($this->group2
      ->id(), $actual
      ->id());
  }

  /**
   * Asserts whether a group ID exists in some results.
   *
   * Assumes entity_type is used.
   *
   * @param \Drupal\entity_test\Entity\EntityTest $group_to_check
   *   The group entity to check.
   * @param array $results
   *   Array keyed by the entity type, and with the group entities as values.
   */
  protected function assertGroupExistsInResults(EntityTest $group_to_check, array $results) {
    $found = FALSE;
    foreach ($results['entity_test'] as $group) {
      if ($group
        ->id() == $group_to_check
        ->id()) {
        $found = TRUE;
        break;
      }
    }
    $this
      ->assertTrue($found);
  }

}

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.
GetUserGroupsTest::$group1 protected property A group entity.
GetUserGroupsTest::$group2 protected property A group entity.
GetUserGroupsTest::$groupBundle protected property The machine name of the group node type.
GetUserGroupsTest::$membershipManager protected property The OG membership manager.
GetUserGroupsTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
GetUserGroupsTest::$user1 protected property A user object.
GetUserGroupsTest::$user2 protected property A user object.
GetUserGroupsTest::$user3 protected property A user object.
GetUserGroupsTest::assertGroupExistsInResults protected function Asserts whether a group ID exists in some results.
GetUserGroupsTest::setUp protected function Overrides KernelTestBase::setUp
GetUserGroupsTest::testGetGroupsByRoles public function Tests retrieval of groups filtered by roles.
GetUserGroupsTest::testIsMemberStates public function Tests member methods for states that other groups users are added to.
GetUserGroupsTest::testOtherGroups public function Tests other groups users are added to.
GetUserGroupsTest::testOwnerGroupsOnly public function Tests group owners have the correct groups.
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.
OgMembershipCreationTrait::createOgMembership protected function Creates a test membership.
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.