class GetMembershipsTest in Organic groups 8

Tests retrieving OgMembership entities associated with a given user.

@group og @coversDefaultClass \Drupal\og\Og

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\og\Kernel\Entity\GetMembershipsTest uses OgMembershipCreationTrait

Expanded class hierarchy of GetMembershipsTest

File

tests/src/Kernel/Entity/GetMembershipsTest.php, line 21

Namespace

Drupal\Tests\og\Kernel\Entity

View source

class GetMembershipsTest extends KernelTestBase {
  use OgMembershipCreationTrait;

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

  /**
   * Test groups.
   *
   * @var \Drupal\Core\Entity\EntityInterface[]
   */
  protected $groups = [];

  /**
   * Test users.
   *
   * @var \Drupal\user\UserInterface[]
   */
  protected $users;

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

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->installConfig([
      'og',
    ]);
    $this
      ->installEntitySchema('node');
    $this
      ->installEntitySchema('og_membership');
    $this
      ->installEntitySchema('user');
    $this
      ->installSchema('system', 'sequences');
    $this
      ->installSchema('user', [
      'users_data',
    ]);
    $this->entityTypeManager = $this->container
      ->get('entity_type.manager');

    // Create group admin user.
    $group_admin = User::create([
      'name' => $this
        ->randomString(),
    ]);
    $group_admin
      ->save();

    // Create two groups.
    for ($i = 0; $i < 2; $i++) {
      $bundle = "node_{$i}";
      NodeType::create([
        'name' => $this
          ->randomString(),
        'type' => $bundle,
      ])
        ->save();
      Og::groupTypeManager()
        ->addGroup('node', $bundle);
      $group = Node::create([
        'title' => $this
          ->randomString(),
        'type' => $bundle,
        'uid' => $group_admin
          ->id(),
      ]);
      $group
        ->save();
      $this->groups[] = $group;
    }

    // Create test users with different membership states in the two groups.
    $matrix = [
      // A user which is an active member of the first group.
      [
        OgMembershipInterface::STATE_ACTIVE,
        NULL,
      ],
      // A user which is a pending member of the second group.
      [
        NULL,
        OgMembershipInterface::STATE_PENDING,
      ],
      // A user which is an active member of both groups.
      [
        OgMembershipInterface::STATE_ACTIVE,
        OgMembershipInterface::STATE_ACTIVE,
      ],
      // A user which is a pending member of the first group and blocked in the
      // second group.
      [
        OgMembershipInterface::STATE_PENDING,
        OgMembershipInterface::STATE_BLOCKED,
      ],
      // A user which is not subscribed to either of the two groups.
      [
        NULL,
        NULL,
      ],
    ];
    foreach ($matrix as $user_key => $states) {
      $user = User::create([
        'name' => $this
          ->randomString(),
      ]);
      $user
        ->save();
      $this->users[$user_key] = $user;
      foreach ($states as $group_key => $state) {
        $group = $this->groups[$group_key];
        if ($state) {
          $this
            ->createOgMembership($group, $user, NULL, $state);
        }
      }
    }
  }

  /**
   * Tests retrieval of OG Membership entities associated with a given user.
   *
   * @param int $index
   *   The array index in the $this->users array of the user to test.
   * @param array $states
   *   Array with the states to retrieve.
   * @param array $expected
   *   An array containing the expected results to be returned.
   *
   * @covers ::getMemberships
   * @dataProvider membershipDataProvider
   */
  public function testGetMemberships($index, array $states, array $expected) {
    $result = Og::getMemberships($this->users[$index], $states);

    // Check that the correct number of results is returned.
    $this
      ->assertEquals(count($expected), count($result));

    // Inspect the results that were returned.
    foreach ($result as $key => $membership) {

      // Check that all result items are OgMembership objects.
      $this
        ->assertInstanceOf('Drupal\\og\\OgMembershipInterface', $membership);

      // Check that the results are keyed by OgMembership ID.
      $this
        ->assertEquals($membership
        ->id(), $key);
    }

    // Check that all expected results are returned.
    foreach ($expected as $expected_group) {
      $expected_id = $this->groups[$expected_group]
        ->id();
      foreach ($result as $membership) {
        if ($membership
          ->getGroupId() === $expected_id) {

          // Test successful: the expected result was found.
          continue 2;
        }
      }
      $this
        ->fail("The expected group with ID {$expected_id} was not found.");
    }
  }

  /**
   * Provides test data to test retrieval of memberships.
   *
   * @return array
   *   An array of test properties. Each property is an indexed array with the
   *   following items:
   *   - The key of the user in the $this->users array for which to retrieve
   *     memberships.
   *   - An array of membership states to filter on.
   *   - An array containing the expected results to be returned.
   */
  public function membershipDataProvider() {
    return [
      // The first user is an active member of the first group.
      // Query default values. The group should be returned.
      [
        0,
        [],
        [
          0,
        ],
      ],
      // Filter by active state.
      [
        0,
        [
          OgMembershipInterface::STATE_ACTIVE,
        ],
        [
          0,
        ],
      ],
      // Filter by active + pending state.
      [
        0,
        [
          OgMembershipInterface::STATE_ACTIVE,
          OgMembershipInterface::STATE_PENDING,
        ],
        [
          0,
        ],
      ],
      // Filter by blocked + pending state. Since the user is active this should
      // not return any matches.
      [
        0,
        [
          OgMembershipInterface::STATE_BLOCKED,
          OgMembershipInterface::STATE_PENDING,
        ],
        [],
      ],
      // The second user is a pending member of the second group.
      // Query default values. The group should be returned.
      [
        1,
        [],
        [
          1,
        ],
      ],
      // Filter by pending state.
      [
        1,
        [
          OgMembershipInterface::STATE_PENDING,
        ],
        [
          1,
        ],
      ],
      // Filter by active state. The user is pending so this should not return
      // any matches.
      [
        1,
        [
          OgMembershipInterface::STATE_ACTIVE,
        ],
        [],
      ],
      // The third user is an active member of both groups.
      // Query default values. Both groups should be returned.
      [
        2,
        [],
        [
          0,
          1,
        ],
      ],
      // Filter by active state.
      [
        2,
        [
          OgMembershipInterface::STATE_ACTIVE,
        ],
        [
          0,
          1,
        ],
      ],
      // Filter by blocked state. This should not return any matches.
      [
        2,
        [
          OgMembershipInterface::STATE_BLOCKED,
        ],
        [],
      ],
      // The fourth user is a pending member of the first group and blocked in
      // the second group.
      // Query default values. Both groups should be returned.
      [
        3,
        [],
        [
          0,
          1,
        ],
      ],
      // Filter by active state. No results should be returned.
      [
        3,
        [
          OgMembershipInterface::STATE_ACTIVE,
        ],
        [],
      ],
      // Filter by pending state.
      [
        3,
        [
          OgMembershipInterface::STATE_PENDING,
        ],
        [
          0,
        ],
      ],
      // Filter by blocked state.
      [
        3,
        [
          OgMembershipInterface::STATE_BLOCKED,
        ],
        [
          1,
        ],
      ],
      // Filter by combinations of states.
      [
        3,
        [
          OgMembershipInterface::STATE_ACTIVE,
          OgMembershipInterface::STATE_PENDING,
        ],
        [
          0,
        ],
      ],
      [
        3,
        [
          OgMembershipInterface::STATE_ACTIVE,
          OgMembershipInterface::STATE_PENDING,
          OgMembershipInterface::STATE_BLOCKED,
        ],
        [
          0,
          1,
        ],
      ],
      [
        3,
        [
          OgMembershipInterface::STATE_ACTIVE,
          OgMembershipInterface::STATE_BLOCKED,
        ],
        [
          1,
        ],
      ],
      [
        3,
        [
          OgMembershipInterface::STATE_PENDING,
          OgMembershipInterface::STATE_BLOCKED,
        ],
        [
          0,
          1,
        ],
      ],
      // A user which is not subscribed to either of the two groups.
      [
        4,
        [],
        [],
      ],
      [
        4,
        [
          OgMembershipInterface::STATE_ACTIVE,
        ],
        [],
      ],
      [
        4,
        [
          OgMembershipInterface::STATE_BLOCKED,
        ],
        [],
      ],
      [
        4,
        [
          OgMembershipInterface::STATE_PENDING,
        ],
        [],
      ],
      [
        4,
        [
          OgMembershipInterface::STATE_ACTIVE,
          OgMembershipInterface::STATE_PENDING,
          OgMembershipInterface::STATE_BLOCKED,
        ],
        [],
      ],
    ];
  }

  /**
   * Tests that memberships are deleted when a user is deleted.
   */
  public function testOrphanedMembershipsDeletion() {
    foreach ($this->users as $user) {

      // Keep track of the user ID before deleting the user.
      $user_id = $user
        ->id();
      $user
        ->delete();

      // Check that the memberships for the user are deleted from the database.
      $memberships = $this->entityTypeManager
        ->getStorage('og_membership')
        ->getQuery()
        ->condition('uid', $user_id)
        ->execute();
      $this
        ->assertEmpty($memberships);
    }
  }

}

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.
GetMembershipsTest::$entityTypeManager	protected	property	The entity type manager.
GetMembershipsTest::$groups	protected	property	Test groups.
GetMembershipsTest::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules
GetMembershipsTest::$users	protected	property	Test users.
GetMembershipsTest::membershipDataProvider	public	function	Provides test data to test retrieval of memberships.
GetMembershipsTest::setUp	protected	function	Overrides KernelTestBase::setUp
GetMembershipsTest::testGetMemberships	public	function	Tests retrieval of OG Membership entities associated with a given user.
GetMembershipsTest::testOrphanedMembershipsDeletion	public	function	Tests that memberships are deleted when a user is deleted.
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.

You are here

class GetMembershipsTest in Organic groups 8

Hierarchy

File

Namespace

Members

API Navigation