class PermissionEventTest in Organic groups 8

Same name in this branch

8 tests/src/Unit/PermissionEventTest.php \Drupal\Tests\og\Unit\PermissionEventTest
8 tests/src/Kernel/PermissionEventTest.php \Drupal\Tests\og\Kernel\PermissionEventTest

Tests the implementations of the PermissionEvent in 'og' and 'og_ui'.

@group 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\PermissionEventTest

Expanded class hierarchy of PermissionEventTest

File

tests/src/Kernel/PermissionEventTest.php, line 23

Namespace

Drupal\Tests\og\Kernel

View source

class PermissionEventTest extends KernelTestBase {

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

  /**
   * The Symfony event dispatcher.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $eventDispatcher;

  /**
   * The bundle ID used for the test group.
   *
   * @var string
   */
  protected $groupBundleId;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->eventDispatcher = $this->container
      ->get('event_dispatcher');

    // Create a group content entity type. The type and name of this bundle are
    // used to create the group content permissions.
    NodeType::create([
      'type' => 'test_group_content',
      'name' => 'Test Group Content',
    ])
      ->save();
  }

  /**
   * Tests that the two OG modules can provide their own OG permissions.
   *
   * Some permissions (such as 'subscribe', 'manage members', etc.) are
   * available for all group types. In addition to this there are also OG
   * permissions for creating, editing and deleting the group content that
   * associated with the group.
   *
   * In this test we will check that the correct permissions are generated for
   * our test group (which includes permissions to create, edit and delete group
   * content of type 'test_group_content'), as well as a control group which
   * doesn't have any group content - in this case it should only return the
   * default permissions that are available to all group types.
   *
   * @param array $group_content_bundle_ids
   *   An array of group content bundle IDs that are associated with the test
   *   group.
   * @param array $expected_permissions
   *   An array of permission names that are expected to be returned.
   * @param \Drupal\og\PermissionInterface[] $expected_full_permissions
   *   An array of full permissions that are expected to be returned. This is a
   *   subset of the permissions. It is not necessary to test the full
   *   permission data for each entry, testing the data for only a couple of
   *   permissions is sufficient.
   *
   * @dataProvider permissionEventDataProvider
   */
  public function testPermissionEventIntegration(array $group_content_bundle_ids, array $expected_permissions, array $expected_full_permissions) {

    // Retrieve the permissions from the listeners.

    /** @var \Drupal\og\Event\PermissionEvent $permission_event */
    $event = new PermissionEvent($this
      ->randomMachineName(), $this
      ->randomMachineName(), $group_content_bundle_ids);
    $permission_event = $this->eventDispatcher
      ->dispatch(PermissionEventInterface::EVENT_NAME, $event);
    $actual_permissions = array_keys($permission_event
      ->getPermissions());

    // Sort the permission arrays so they can be compared.
    sort($expected_permissions);
    sort($actual_permissions);
    $this
      ->assertEquals($expected_permissions, $actual_permissions);

    // When testing the group content bundles, check that the bundle info has
    // been correctly retrieved from the group content bundle that was created
    // in the setUp() and used to create the permissions.
    foreach ($expected_full_permissions as $permission) {
      $this
        ->assertPermission($permission, $permission_event
        ->getPermission($permission
        ->getName()));
    }
  }

  /**
   * Provides expected results for the testPermissionEventIntegration test.
   *
   * @return array
   *   An array of test properties. Each property is an indexed array with the
   *   following items:
   *   - An array of group content bundle IDs that are associated with the
   *     test group. Used to check if group content permissions are correctly
   *     provided.
   *   - An array of permission names that are expected to be returned. Used to
   *     check that the correct permissions are returned.
   *   - An array of full permissions that are expected to be returned. This is
   *     a subset of the permissions. It is not necessary to test the full
   *     permission data for each entry, testing the data for only 1 or 2
   *     permissions is sufficient.
   */
  public function permissionEventDataProvider() {

    // Test permissions that should be available for both test groups.
    $default_permissions = [
      'add user',
      OgAccess::ADMINISTER_GROUP_PERMISSION,
      OgAccess::DELETE_GROUP_PERMISSION,
      OgAccess::UPDATE_GROUP_PERMISSION,
      'approve and deny subscription',
      'manage members',
      'administer permissions',
      'subscribe without approval',
      'subscribe',
    ];

    // Test permissions that should only be available for the test group that
    // has group content.
    $group_content_permissions = [
      'create test_group_content content',
      'delete any test_group_content content',
      'delete own test_group_content content',
      'edit any test_group_content content',
      'edit own test_group_content content',
    ];

    // A full permission that should be available in both test groups. This is
    // used to test that all properties are correctly applied.
    $group_level_permission = new GroupPermission([
      'name' => OgAccess::ADMINISTER_GROUP_PERMISSION,
      'title' => $this
        ->t('Administer group'),
      'description' => $this
        ->t('Manage group members and content in the group.'),
      'default roles' => [
        OgRoleInterface::ADMINISTRATOR,
      ],
      'restrict access' => TRUE,
    ]);

    // A full permission that should only be available for the test group that
    // has group content.
    $group_content_operation_permission = new GroupContentOperationPermission([
      'name' => 'create test_group_content content',
      'title' => $this
        ->t('%bundle: Create new content', [
        '%bundle' => 'Test Group Content',
      ]),
      'entity type' => 'node',
      'bundle' => 'test_group_content',
      'operation' => 'create',
    ]);
    return [
      // Test retrieving permissions for a group that has no group content types
      // associated with it.
      [
        [],
        // It should only return the default permissions.
        $default_permissions,
        // The list of permissions should only contain the group level
        // permission ('administer group'). and the group content permission
        // ('create test_group_content node').
        [
          $group_level_permission,
        ],
      ],
      // Test retrieving permissions for a group that has a group content type
      // associated with it.
      [
        [
          'node' => [
            'test_group_content',
          ],
        ],
        // It should return the default permissions as well as the permissions
        // to create, delete and update group content.
        array_merge($default_permissions, $group_content_permissions),
        // The list of permissions should contain both the group level
        // permission ('administer group') and the group content permission
        // ('create test_group_content node').
        [
          $group_level_permission,
          $group_content_operation_permission,
        ],
      ],
    ];
  }

  /**
   * Implementation of the global t() function.
   *
   * The global t() function is not available in scope of the data provider, so
   * it is mocked here as a simple string replacement.
   *
   * @see t()
   */
  public function t($string, array $args = [], array $options = []) {
    return new FormattableMarkup($string, $args);
  }

  /**
   * Asserts that the two permissions are identical.
   *
   * @param \Drupal\og\PermissionInterface $expected
   *   The expected permission.
   * @param \Drupal\og\PermissionInterface $actual
   *   The actual permission.
   */
  protected function assertPermission(PermissionInterface $expected, PermissionInterface $actual) {
    foreach ($this
      ->getPermissionProperties($expected) as $property) {
      $this
        ->assertEquals($expected
        ->get($property), $actual
        ->get($property), "The {$property} property is equal.");
    }
  }

  /**
   * Returns the property names that are used for the given Permission object.
   *
   * @param \Drupal\og\PermissionInterface $permission
   *   The Permission object for which to return the properties.
   *
   * @return array
   *   An array of property names.
   */
  protected function getPermissionProperties(PermissionInterface $permission) {
    $shared_permissions = [
      'default roles',
      'description',
      'name',
      'restrict access',
      'title',
    ];
    if ($permission instanceof GroupPermission) {
      return array_merge($shared_permissions, [
        'roles',
      ]);
    }
    return array_merge($shared_permissions, [
      'entity type',
      'bundle',
      'operation',
      'owner',
    ]);
  }

}

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.
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.
PermissionEventTest::$eventDispatcher	protected	property	The Symfony event dispatcher.
PermissionEventTest::$groupBundleId	protected	property	The bundle ID used for the test group.
PermissionEventTest::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules
PermissionEventTest::assertPermission	protected	function	Asserts that the two permissions are identical.
PermissionEventTest::getPermissionProperties	protected	function	Returns the property names that are used for the given Permission object.
PermissionEventTest::permissionEventDataProvider	public	function	Provides expected results for the testPermissionEventIntegration test.
PermissionEventTest::setUp	protected	function	Overrides KernelTestBase::setUp
PermissionEventTest::t	public	function	Implementation of the global t() function.
PermissionEventTest::testPermissionEventIntegration	public	function	Tests that the two OG modules can provide their own OG permissions.
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 PermissionEventTest in Organic groups 8

Hierarchy

File

Namespace

Members

API Navigation