og-8.x-1.x-dev/tests/src/Kernel/Action/BlockOgMembershipActionTest.php

<?php

declare(strict_types=1);

namespace Drupal\Tests\og\Kernel\Action;

use Drupal\og\OgMembershipInterface;

/**
 * Tests the BlockOgMembership action plugin.
 *
 * @group og
 * @coversDefaultClass \Drupal\og\Plugin\Action\BlockOgMembership
 */
class BlockOgMembershipActionTest extends ActionTestBase {

  /**
   * {@inheritdoc}
   */
  protected string $pluginId = 'og_membership_block_action';

  /**
   * Checks if the action can be performed correctly.
   *
   * @param string $membership
   *   The membership on which to perform the action.
   *
   * @covers ::execute
   * @dataProvider executeProvider
   */
  public function testExecute(?string $membership = NULL): void {
    $membership = $this->memberships[$membership];
    /** @var \Drupal\og\Plugin\Action\AddSingleOgMembershipRole $plugin */
    $plugin = $this->getPlugin();
    $plugin->execute($membership);

    $this->assertEquals(OgMembershipInterface::STATE_BLOCKED, $membership->getState());
  }

  /**
   * {@inheritdoc}
   */
  public static function executeProvider(): array {
    return [
      ['member'],
      ['pending'],
      ['group_administrator'],
      ['group_moderator'],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function accessProvider(): array {
    return [
      // Access should be provided if the membership is not already blocked and
      // does not belong to the group owner, and the user executing the action
      // is a privileged user.
      ['uid1', 'member'],
      ['uid1', 'pending'],
      ['uid1', 'group_administrator'],
      ['uid1', 'group_moderator'],
      ['administrator', 'member'],
      ['administrator', 'pending'],
      ['administrator', 'group_administrator'],
      ['administrator', 'group_moderator'],
      ['group_administrator', 'member'],
      ['group_administrator', 'pending'],
      ['group_administrator', 'group_administrator'],
      ['group_administrator', 'group_moderator'],
      ['group_moderator', 'member'],
      ['group_moderator', 'pending'],
      ['group_moderator', 'group_administrator'],
      ['group_moderator', 'group_moderator'],
      ['group_owner', 'member', TRUE],
      ['group_owner', 'pending', TRUE],
      ['group_owner', 'group_administrator', TRUE],
      ['group_owner', 'group_moderator', TRUE],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function noAccessProvider(): array {
    return [
      // Access is denied to users that are not privileged, and if the
      // membership is already blocked, or if it belongs to the group owner.
      ['uid1', 'blocked'],
      ['uid1', 'group_owner'],
      ['administrator', 'blocked'],
      ['administrator', 'group_owner'],
      ['group_administrator', 'blocked'],
      ['group_administrator', 'group_owner'],
      ['group_moderator', 'blocked'],
      ['group_moderator', 'group_owner'],
      ['group_owner', 'blocked', TRUE],
      ['group_owner', 'group_owner', TRUE],
      ['anonymous', 'member'],
      ['anonymous', 'pending'],
      ['anonymous', 'blocked'],
      ['anonymous', 'group_administrator'],
      ['anonymous', 'group_moderator'],
      ['anonymous', 'group_owner'],
      ['authenticated', 'member'],
      ['authenticated', 'pending'],
      ['authenticated', 'blocked'],
      ['authenticated', 'group_administrator'],
      ['authenticated', 'group_moderator'],
      ['authenticated', 'group_owner'],
      ['member', 'member'],
      ['member', 'pending'],
      ['member', 'blocked'],
      ['member', 'group_administrator'],
      ['member', 'group_moderator'],
      ['member', 'group_owner'],
      ['pending', 'member'],
      ['pending', 'pending'],
      ['pending', 'blocked'],
      ['pending', 'group_administrator'],
      ['pending', 'group_moderator'],
      ['pending', 'group_owner'],
      ['blocked', 'member'],
      ['blocked', 'pending'],
      ['blocked', 'blocked'],
      ['blocked', 'group_administrator'],
      ['blocked', 'group_moderator'],
      ['blocked', 'group_owner'],
      ['group_owner', 'member', FALSE],
      ['group_owner', 'pending', FALSE],
      ['group_owner', 'blocked', FALSE],
      ['group_owner', 'group_administrator', FALSE],
      ['group_owner', 'group_moderator', FALSE],
      ['group_owner', 'group_owner', FALSE],
    ];
  }

}