You are here

Home » API reference » Organic Groups Menu (OG Menu) 8 » OgMenuAccessTest.php

class OgMenuAccessTest in Organic Groups Menu (OG Menu) 8

Tests access to operations on OG Menu instances.

@group og_menu

Hierarchy

Expanded class hierarchy of OgMenuAccessTest

File

tests/src/Kernel/OgMenuAccessTest.php, line 22

Namespace

Drupal\Tests\og_menu\Kernel
View source 
class OgMenuAccessTest extends KernelTestBase {

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

  /**
   * An array of test users.
   *
   * @var \Drupal\user\Entity\User[]
   */
  protected $users;

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

  /**
   * The bundle ID of the test group.
   *
   * @var string
   */
  protected $groupBundle;

  /**
   * A test OG Menu.
   *
   * @var \Drupal\og_menu\Entity\OgMenu
   */
  protected $ogMenu;

  /**
   * A test OG Menu instance.
   *
   * @var \Drupal\og_menu\Entity\OgMenuInstance
   */
  protected $ogMenuInstance;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installConfig([
      'og',
    ]);
    $this
      ->installEntitySchema('entity_test');
    $this
      ->installEntitySchema('og_membership');
    $this
      ->installEntitySchema('ogmenu');
    $this
      ->installEntitySchema('ogmenu_instance');
    $this
      ->installEntitySchema('user');
    $this
      ->installSchema('system', 'sequences');

    // Create a first user. This will be UID 1 who has super powers.
    $this->users['uid1'] = User::create([
      'name' => $this
        ->randomString(),
    ]);
    $this->users['uid1']
      ->save();

    // Create an 'OG administrator' user who has the global
    // 'administer organic groups' permission.
    // This user should be able to access everything related to any group.

    /** @var RoleInterface $og_menu_admin_role */
    $admin_role = Role::create([
      'id' => $this
        ->randomMachineName(),
      'label' => $this
        ->randomString(),
    ]);
    $admin_role
      ->grantPermission('administer organic groups')
      ->save();
    $this->users['ogadmin'] = User::create([
      'name' => $this
        ->randomString(),
      'roles' => [
        $admin_role
          ->id(),
      ],
    ]);
    $this->users['ogadmin']
      ->save();

    // Create an 'OG Menu administrator' user who will get the global
    // permissions to manage any OG menu.

    /** @var RoleInterface $og_menu_admin_role */
    $og_menu_admin_role = Role::create([
      'id' => $this
        ->randomMachineName(),
      'label' => $this
        ->randomString(),
    ]);
    $og_menu_admin_role
      ->grantPermission('administer group')
      ->grantPermission('administer og menu')
      ->save();
    $this->users['ogmenuadmin'] = User::create([
      'name' => $this
        ->randomString(),
      'roles' => [
        $og_menu_admin_role
          ->id(),
      ],
    ]);
    $this->users['ogmenuadmin']
      ->save();

    // Create a 'group administrator' user who is a normal authenticated user
    // but has the administrator role within a particular group. By default this
    // user should be able to access everything related to their own group.
    $this->users['groupadmin'] = User::create([
      'name' => $this
        ->randomString(),
    ]);
    $this->users['groupadmin']
      ->save();

    // Create a 'group member' user who is a normal authenticated user and a
    // member of a particular group. This user should only be able to access
    // operations for which permission has been explicitly granted.
    $this->users['groupmember'] = User::create([
      'name' => $this
        ->randomString(),
    ]);
    $this->users['groupmember']
      ->save();

    // Create an 'authenticated' user who does not have any special permissions.
    $this->users['authenticated'] = User::create([
      'name' => $this
        ->randomString(),
    ]);
    $this->users['authenticated']
      ->save();

    // Create a test group. We use the 'entity test' entity which is a bit
    // easier to set up since it has fake bundles.
    $this->groupBundle = mb_strtolower($this
      ->randomMachineName());
    Og::groupTypeManager()
      ->addGroup('entity_test', $this->groupBundle);

    // Create a group and associate with the group administrator. This user will
    // be subscribed to the group and inherit the administrator role
    // automatically.
    $this->group = EntityTest::create([
      'type' => $this->groupBundle,
      'name' => $this
        ->randomString(),
      'user_id' => $this->users['groupadmin']
        ->id(),
    ]);
    $this->group
      ->save();

    // Subscribe the group member to the group.

    /** @var OgMembership $membership */
    $membership = OgMembership::create([
      'type' => OgMembershipInterface::TYPE_DEFAULT,
    ]);
    $membership
      ->setOwner($this->users['groupmember'])
      ->setGroup($this->group)
      ->save();

    // Add an OG Menu.
    $this->ogMenu = OgMenu::create([
      'label' => $this
        ->randomString(),
      'id' => $this
        ->randomMachineName(),
    ]);
    $this->ogMenu
      ->save();

    // Add an OG Menu Instance.
    $this->ogMenuInstance = OgMenuInstance::create([
      'id' => $this
        ->randomMachineName(),
      'type' => $this->ogMenu
        ->id(),
      OgGroupAudienceHelperInterface::DEFAULT_FIELD => $this->group
        ->id(),
    ]);
    $this->ogMenuInstance
      ->save();
  }

  /**
   * Test access to the administration section.
   */
  public function testOgMenuEntityAccess() {
    $expected_operations = [
      'uid1' => [
        'create' => TRUE,
        'update' => TRUE,
        'view' => TRUE,
        'delete' => TRUE,
      ],
      'ogadmin' => [
        'create' => FALSE,
        'update' => FALSE,
        'view' => FALSE,
        'delete' => FALSE,
      ],
      'ogmenuadmin' => [
        'create' => TRUE,
        'update' => TRUE,
        'view' => TRUE,
        'delete' => TRUE,
      ],
      'groupadmin' => [
        'create' => FALSE,
        'update' => FALSE,
        'view' => FALSE,
        'delete' => FALSE,
      ],
      'groupmember' => [
        'create' => FALSE,
        'update' => FALSE,
        'view' => FALSE,
        'delete' => FALSE,
      ],
      'authenticated' => [
        'create' => FALSE,
        'update' => FALSE,
        'view' => FALSE,
        'delete' => FALSE,
      ],
    ];
    foreach ($expected_operations as $user_key => $operations) {
      \Drupal::currentUser()
        ->setAccount($this->users[$user_key]);
      foreach ($operations as $operation => $expected) {
        $message = "User {$user_key} " . ($expected ? 'has' : 'does not have') . " access to the {$operation} operation.";
        $this
          ->assertEquals($expected, $this->ogMenu
          ->access($operation), $message);
      }
    }
    $this
      ->assertFalse($this->ogMenu
      ->access('update'));
  }

  /**
   * Tests deletion of unsaved entities.
   */
  public function testDeleteUnsavedAccess() {

    // Create an OG Menu but do not save it.
    $ogmenu = OgMenu::create([
      'label' => $this
        ->randomString(),
      'id' => $this
        ->randomMachineName(),
    ]);

    // Create an OG Menu Instance but don't save it.
    $ogmenu_instance = OgMenuInstance::create([
      'id' => $this
        ->randomMachineName(),
      'type' => $ogmenu
        ->id(),
    ]);

    // Note we are not testing UID 1 which has access to everything, even to
    // nonsensical operations such as this.
    $user_keys = [
      'ogadmin',
      'ogmenuadmin',
      'groupadmin',
      'groupmember',
      'authenticated',
    ];
    foreach ($user_keys as $user_key) {
      \Drupal::currentUser()
        ->setAccount($this->users[$user_key]);
      foreach ([
        'ogmenu',
        'ogmenu_instance',
      ] as $entity_type) {
        $message = "User {$user_key} should not be able to delete an unsaved {$entity_type} entity.";
        $this
          ->assertFalse(${$entity_type}
          ->access('delete'), $message);
      }
    }
  }

  /**
   * Tests that unsupported operations do not grant access.
   */
  public function testUnsupportedOperation() {

    // In the context of a group UID1 and the OG admin are 'superadmins' which
    // have access to everything, even to unsupported operations.
    $user_keys = [
      'uid1' => TRUE,
      'ogadmin' => TRUE,
      'ogmenuadmin' => FALSE,
      'groupadmin' => FALSE,
      'groupmember' => FALSE,
      'authenticated' => FALSE,
    ];
    foreach ($user_keys as $user_key => $expected_access) {
      $message = "User {$user_key} should " . ($expected_access ? '' : 'not') . " be granted access to an unsupported operation by default.";
      $this
        ->assertEquals($expected_access, $this->ogMenuInstance
        ->access('some-non-existing-operation', $this->users[$user_key]), $message);
    }
  }

}

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.
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.
OgMenuAccessTest::$group protected property A test group.
OgMenuAccessTest::$groupBundle protected property The bundle ID of the test group.
OgMenuAccessTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
OgMenuAccessTest::$ogMenu protected property A test OG Menu.
OgMenuAccessTest::$ogMenuInstance protected property A test OG Menu instance.
OgMenuAccessTest::$users protected property An array of test users.
OgMenuAccessTest::setUp protected function Overrides KernelTestBase::setUp
OgMenuAccessTest::testDeleteUnsavedAccess public function Tests deletion of unsaved entities.
OgMenuAccessTest::testOgMenuEntityAccess public function Test access to the administration section.
OgMenuAccessTest::testUnsupportedOperation public function Tests that unsupported operations do not grant access.
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.