You are here

Home » API reference » Group 2.0.x » GroupContentCreateAccessTest.php

class GroupContentCreateAccessTest in Group 2.0.x

Same name and namespace in other branches
  1. 8 tests/src/Kernel/GroupContentCreateAccessTest.php \Drupal\Tests\group\Kernel\GroupContentCreateAccessTest

Tests the group content create access for groups.

@group group

Hierarchy

Expanded class hierarchy of GroupContentCreateAccessTest

File

tests/src/Kernel/GroupContentCreateAccessTest.php, line 16

Namespace

Drupal\Tests\group\Kernel
View source 
class GroupContentCreateAccessTest extends GroupKernelTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'group_test_plugin',
    'node',
  ];

  /**
   * The access manager.
   *
   * @var \Drupal\Core\Access\AccessManagerInterface
   */
  protected $accessManager;

  /**
   * The route provider.
   *
   * @var \Drupal\Core\Routing\RouteProviderInterface
   */
  protected $routeProvider;

  /**
   * The group type to run this test on.
   *
   * @var \Drupal\group\Entity\GroupTypeInterface
   */
  protected $groupType;

  /**
   * The group admin role.
   *
   * @var \Drupal\group\Entity\GroupRoleInterface
   */
  protected $adminRole;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installSchema('node', [
      'node_access',
    ]);
    $this
      ->installEntitySchema('node');
    $this
      ->installEntitySchema('entity_test_with_owner');
    $this
      ->createNodeType([
      'type' => 'page',
    ]);
    $this->accessManager = $this->container
      ->get('access_manager');
    $this->routeProvider = $this->container
      ->get('router.route_provider');
    $this->groupType = $this
      ->createGroupType([
      'id' => 'create_access_test',
      'creator_membership' => FALSE,
    ]);

    // Enable the test plugins on the group type.

    /** @var \Drupal\group\Entity\Storage\GroupContentTypeStorageInterface $storage */
    $storage = $this->entityTypeManager
      ->getStorage('group_content_type');
    $storage
      ->save($storage
      ->createFromPlugin($this->groupType, 'entity_test_as_content'));
    $storage
      ->save($storage
      ->createFromPlugin($this->groupType, 'node_as_content:page'));
    $this->adminRole = $this->entityTypeManager
      ->getStorage('group_role')
      ->create([
      'id' => 'create_access_test-admin',
      'label' => 'Create test admin',
      'weight' => 0,
      'group_type' => $this->groupType
        ->id(),
    ]);
    $this->adminRole
      ->grantPermission('administer group')
      ->save();
  }

  /**
   * Tests access to the create/add overview page.
   *
   * @dataProvider pageAccessProvider
   */
  public function testPageAccess($route, $outsider_permissions, $member_permissions, $outsider_access, $member_access, $admin_access, $message) {
    $outsider = $this
      ->createUser();
    $member = $this
      ->createUser();
    $admin = $this
      ->createUser();
    $this->groupType
      ->getOutsiderRole()
      ->grantPermissions($outsider_permissions)
      ->save();
    $this->groupType
      ->getMemberRole()
      ->grantPermissions($member_permissions)
      ->save();
    $group = $this
      ->createGroup([
      'type' => $this->groupType
        ->id(),
    ]);
    $group
      ->addMember($member);
    $group
      ->addMember($admin, [
      'group_roles' => [
        $this->adminRole
          ->id(),
      ],
    ]);
    $request = $this
      ->createRequest($route, $group);
    $this
      ->assertSame($outsider_access, $this->accessManager
      ->checkRequest($request, $outsider), $message);
    $this
      ->assertSame($member_access, $this->accessManager
      ->checkRequest($request, $member), $message);
    $this
      ->assertSame($admin_access, $this->accessManager
      ->checkRequest($request, $admin), $message);
  }

  /**
   * Data provider for testPageAccess().
   *
   * @return array
   *   A list of testPageAccess method arguments.
   */
  public function pageAccessProvider() {
    $cases = [];
    $cases['create-page-access-one'] = [
      'entity.group_content.create_page',
      [],
      [
        'create entity_test_as_content entity',
      ],
      FALSE,
      TRUE,
      TRUE,
      'Testing the _group_content_create_any_entity_access route access check with create access from one plugin',
    ];
    $cases['create-page-access-multi'] = [
      'entity.group_content.create_page',
      [],
      [
        'create entity_test_as_content entity',
        'create node_as_content:page entity',
      ],
      FALSE,
      TRUE,
      TRUE,
      'Testing the _group_content_create_any_entity_access route access check with create access from multiple plugins',
    ];
    $cases['create-page-with-add-access'] = [
      'entity.group_content.create_page',
      [],
      [
        'create entity_test_as_content relation',
      ],
      FALSE,
      FALSE,
      TRUE,
      'Testing the _group_content_create_any_entity_access route access check with add access from one plugin',
    ];
    $cases['add-page-access-one'] = [
      'entity.group_content.add_page',
      [],
      [
        'create entity_test_as_content relation',
      ],
      FALSE,
      TRUE,
      TRUE,
      'Testing the _group_content_create_any_access route access check with add access from one plugin',
    ];
    $cases['add-page-access-multi'] = [
      'entity.group_content.add_page',
      [],
      [
        'create entity_test_as_content relation',
        'create node_as_content:page relation',
      ],
      FALSE,
      TRUE,
      TRUE,
      'Testing the _group_content_create_any_access route access check with add access from multiple plugins',
    ];
    $cases['add-page-with-create-access'] = [
      'entity.group_content.add_page',
      [],
      [
        'create entity_test_as_content entity',
      ],
      FALSE,
      FALSE,
      TRUE,
      'Testing the _group_content_create_any_access route access check with create access from one plugin',
    ];
    return $cases;
  }

  /**
   * Tests access to the create/add form.
   *
   * @dataProvider formAccessProvider
   */
  public function testFormAccess($route, $outsider_permissions, $member_permissions, $outsider_access, $member_access, $admin_access, $message) {
    $outsider = $this
      ->createUser();
    $member = $this
      ->createUser();
    $admin = $this
      ->createUser();
    $this->groupType
      ->getOutsiderRole()
      ->grantPermissions($outsider_permissions)
      ->save();
    $this->groupType
      ->getMemberRole()
      ->grantPermissions($member_permissions)
      ->save();
    $group = $this
      ->createGroup([
      'type' => $this->groupType
        ->id(),
    ]);
    $group
      ->addMember($member);
    $group
      ->addMember($admin, [
      'group_roles' => [
        $this->adminRole
          ->id(),
      ],
    ]);
    $request = $this
      ->createRequest($route, $group, 'entity_test_as_content');
    $this
      ->assertSame($outsider_access, $this->accessManager
      ->checkRequest($request, $outsider), $message);
    $this
      ->assertSame($member_access, $this->accessManager
      ->checkRequest($request, $member), $message);
    $this
      ->assertSame($admin_access, $this->accessManager
      ->checkRequest($request, $admin), $message);
  }

  /**
   * Data provider for testFormAccess().
   *
   * @return array
   *   A list of testFormAccess method arguments.
   */
  public function formAccessProvider() {
    $cases = [];
    $cases['create-form-access'] = [
      'entity.group_content.create_form',
      [],
      [
        'create entity_test_as_content entity',
      ],
      FALSE,
      TRUE,
      TRUE,
      'Testing the _group_content_create_entity_access route access check with create access',
    ];
    $cases['create-form-access-wrong-plugin'] = [
      'entity.group_content.create_form',
      [],
      [
        'create node_as_content:page entity',
      ],
      FALSE,
      FALSE,
      TRUE,
      'Testing the _group_content_create_entity_access route access check with create access from the wrong plugin',
    ];
    $cases['create-form-with-add-access'] = [
      'entity.group_content.create_form',
      [],
      [
        'create entity_test_as_content relation',
      ],
      FALSE,
      FALSE,
      TRUE,
      'Testing the _group_content_create_entity_access route access check with add access',
    ];
    $cases['add-form-access'] = [
      'entity.group_content.add_form',
      [],
      [
        'create entity_test_as_content relation',
      ],
      FALSE,
      TRUE,
      TRUE,
      'Testing the _group_content_create_access route access check with add access',
    ];
    $cases['add-form-access-wrong-plugin'] = [
      'entity.group_content.add_form',
      [],
      [
        'create node_as_content:page relation',
      ],
      FALSE,
      FALSE,
      TRUE,
      'Testing the _group_content_create_access route access check with add access from the wrong plugin',
    ];
    $cases['add-form-with-create-access'] = [
      'entity.group_content.add_form',
      [],
      [
        'create entity_test_as_content entity',
      ],
      FALSE,
      FALSE,
      TRUE,
      'Testing the _group_content_create_access route access check with create access',
    ];
    return $cases;
  }

  /**
   * Creates a request for a specific route.
   *
   * @param string $route_name
   *   The route name.
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group.
   * @param string|null $plugin_id
   *   (optional) The plugin ID.
   *
   * @return \Symfony\Component\HttpFoundation\Request
   *   The request.
   */
  protected function createRequest($route_name, GroupInterface $group, $plugin_id = NULL) {
    $params = [
      'group' => $group
        ->id(),
    ];
    $attributes = [
      'group' => $group,
    ];
    if ($plugin_id) {
      $params['plugin_id'] = $plugin_id;
      $attributes['plugin_id'] = $plugin_id;
    }
    $attributes[RouteObjectInterface::ROUTE_NAME] = $route_name;
    $attributes[RouteObjectInterface::ROUTE_OBJECT] = $this->routeProvider
      ->getRouteByName($route_name);
    $attributes['_raw_variables'] = new ParameterBag($params);
    $request = Request::create(Url::fromRoute($route_name, $params)
      ->toString());
    $request->attributes
      ->add($attributes);

    // Push the request to the request stack so `current_route_match` works.
    $this->container
      ->get('request_stack')
      ->push($request);
    return $request;
  }

  /**
   * Creates a node type.
   *
   * @param array $values
   *   (optional) The values used to create the entity.
   *
   * @return \Drupal\node\Entity\NodeType
   *   The created node type entity.
   */
  protected function createNodeType(array $values = []) {
    $storage = $this->entityTypeManager
      ->getStorage('node_type');
    $node_type = $storage
      ->create($values + [
      'type' => $this
        ->randomMachineName(),
      'label' => $this
        ->randomString(),
    ]);
    $storage
      ->save($node_type);
    return $node_type;
  }

}

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.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated 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.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
GroupContentCreateAccessTest::$accessManager protected property The access manager.
GroupContentCreateAccessTest::$adminRole protected property The group admin role.
GroupContentCreateAccessTest::$groupType protected property The group type to run this test on.
GroupContentCreateAccessTest::$modules public static property @todo Refactor tests to not automatically use group_test_config unless they have a good reason to. Overrides GroupKernelTestBase::$modules
GroupContentCreateAccessTest::$routeProvider protected property The route provider.
GroupContentCreateAccessTest::createNodeType protected function Creates a node type.
GroupContentCreateAccessTest::createRequest protected function Creates a request for a specific route.
GroupContentCreateAccessTest::formAccessProvider public function Data provider for testFormAccess().
GroupContentCreateAccessTest::pageAccessProvider public function Data provider for testPageAccess().
GroupContentCreateAccessTest::setUp protected function Overrides GroupKernelTestBase::setUp
GroupContentCreateAccessTest::testFormAccess public function Tests access to the create/add form.
GroupContentCreateAccessTest::testPageAccess public function Tests access to the create/add overview page.
GroupKernelTestBase::$pluginManager protected property The group relation plugin manager.
GroupKernelTestBase::createGroup protected function Creates a group.
GroupKernelTestBase::createGroupType protected function Creates a group type.
GroupKernelTestBase::getCurrentUser protected function Gets the current user so you can run some checks against them.
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. 3
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::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 24
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 4
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser