Skip to content
This repository has been archived by the owner on Aug 18, 2024. It is now read-only.

Test that an exception is thrown when a membership is saved using invalid roles #499

Merged
merged 3 commits into from
Jun 13, 2019
Merged

Test that an exception is thrown when a membership is saved using invalid roles #499

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f5ea073
Test that an exception is thrown when a membership is saved using inv…
pfrenssen May 11, 2019
46fa1bd
Merge remote-tracking branch 'gizra/8.x-1.x' into test-membership-wit…
pfrenssen May 13, 2019
e627f6c
Merge remote-tracking branch 'origin/8.x-1.x' into test-membership-wi…
pfrenssen Jun 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
162 changes: 154 additions & 8 deletions tests/src/Kernel/Entity/OgMembershipTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace Drupal\Tests\og\Kernel\Entity;

use Drupal\entity_test\Entity\EntityTest;
use Drupal\entity_test\Entity\EntityTestMul;
use Drupal\KernelTests\KernelTestBase;
use Drupal\node\Entity\Node;
use Drupal\node\Entity\NodeType;
Expand Down Expand Up @@ -37,7 +38,7 @@ class OgMembershipTest extends KernelTestBase {
/**
* Test group.
*
* @var \Drupal\Core\Entity\EntityInterface
* @var \Drupal\Core\Entity\ContentEntityInterface
*/
protected $group;

Expand All @@ -62,6 +63,13 @@ class OgMembershipTest extends KernelTestBase {
*/
protected $entityTypeManager;

/**
* The group type manager.
*
* @var \Drupal\og\GroupTypeManagerInterface
*/
protected $groupTypeManager;

/**
* {@inheritdoc}
*/
Expand All @@ -71,11 +79,14 @@ protected function setUp() {
$this->installConfig(['og']);
$this->installEntitySchema('og_membership');
$this->installEntitySchema('entity_test');
$this->installEntitySchema('entity_test_mul');
$this->installEntitySchema('node');
$this->installEntitySchema('user');
$this->installSchema('system', 'sequences');

$this->entityTypeManager = $this->container->get('entity_type.manager');
$this->groupTypeManager = $this->container->get('og.group_type_manager');

$storage = $this->entityTypeManager->getStorage('user');
// Insert a row for the anonymous user.
// @see user_install().
Expand All @@ -88,7 +99,7 @@ protected function setUp() {

// Create a bundle and add as a group.
$group = EntityTest::create([
'type' => mb_strtolower($this->randomMachineName()),
'type' => 'test_bundle',
'name' => $this->randomString(),
'user_id' => $owner->id(),
]);
Expand All @@ -97,7 +108,7 @@ protected function setUp() {
$this->group = $group;

// Add that as a group.
Og::groupTypeManager()->addGroup('entity_test', $group->bundle());
$this->groupTypeManager->addGroup('entity_test', $group->bundle());

// Create test user.
$user = User::create(['name' => $this->randomString()]);
Expand Down Expand Up @@ -195,7 +206,7 @@ public function testMembershipStaticCache() {
'name' => $this->randomString(),
]);
$another_group->save();
Og::groupTypeManager()->addGroup('entity_test', $another_group->bundle());
$this->groupTypeManager->addGroup('entity_test', $another_group->bundle());

$membership = Og::createMembership($this->group, $this->user);
$membership->save();
Expand Down Expand Up @@ -240,6 +251,9 @@ public function testSetNoGroupException() {

/**
* Test that it is possible to create groups without an owner.
*
* @todo This test is not related to the OgMembership entity. It should be
* moved to a more appropriate test class.
*/
public function testNoOwnerException() {
// Create a bundle and add as a group.
Expand All @@ -251,7 +265,7 @@ public function testNoOwnerException() {
$group->save();

// Add that as a group.
Og::groupTypeManager()->addGroup('node', $bundle);
$this->groupTypeManager->addGroup('node', $bundle);
$entity = Node::create([
'title' => $this->randomString(),
'type' => $bundle,
Expand Down Expand Up @@ -291,7 +305,7 @@ public function testSaveExistingMembership() {

$group->save();

Og::groupTypeManager()->addGroup('entity_test', $group->bundle());
$this->groupTypeManager->addGroup('entity_test', $group->bundle());

/** @var \Drupal\og\OgMembershipInterface $membership */
$membership1 = Og::createMembership($group, $this->user);
Expand All @@ -316,7 +330,7 @@ public function testSaveRoleWithWrongGroupType($group_entity_type_id, $group_bun

$group->save();

Og::groupTypeManager()->addGroup('entity_test', $group->bundle());
$this->groupTypeManager->addGroup('entity_test', $group->bundle());

$wrong_role = OgRole::create()
->setGroupType($group_entity_type_id)
Expand Down Expand Up @@ -417,6 +431,138 @@ public function isRoleValidProvider() {
];
}

/**
* Tests an exception is thrown when saving a membership with invalid roles.
*
* @param array $roles_metadata
* An array of test role metadata.
*
* @covers ::save
* @expectedException \Drupal\Core\Entity\EntityStorageException
* @dataProvider saveMembershipWithInvalidRolesProvider
*/
public function testSaveMembershipWithInvalidRoles(array $roles_metadata): void {
$test_groups = ['test_group' => $this->group];

// Create a second test group that has the same entity type but a different
// bundle so we can test that roles created for this group will throw an
// exception.
$group = EntityTest::create([
'type' => 'a_different_group_bundle',
'name' => $this->randomString(),
]);
$group->save();
$this->groupTypeManager->addGroup($group->getEntityTypeId(), $group->bundle());
$test_groups['different_bundle'] = $group;

// Create a third test group that has a different entity type but the same
// bundle so we can test that roles created for this group will throw an
// exception.
$group = EntityTestMul::create([
'type' => 'test_bundle',
'name' => $this->randomString(),
]);
$group->save();
$this->groupTypeManager->addGroup($group->getEntityTypeId(), $group->bundle());
$test_groups['different_entity_type'] = $group;

// Create the roles as defined in the test case.
$roles = [];
foreach ($roles_metadata as $role_metadata) {
$group = $test_groups[$role_metadata['group']];
$role = OgRole::loadByGroupAndName($group, $role_metadata['role_name']);

// Create the role if it was not created automatically.
if (empty($role)) {
$role = OgRole::create([
'group_type' => $group->getEntityTypeId(),
'group_bundle' => $group->bundle(),
'name' => $role_metadata['role_name'],
]);
$role->save();
}
$roles[] = $role;
}

// Create a membership with the test group and roles. This should throw an
// exception since the roles are invalid.
OgMembership::create()
->setOwner($this->user)
->setGroup($this->group)
->setRoles($roles)
->save();
}

/**
* Provides test data for saving a membership with invalid roles.
*
* @return array
* An array of test data, each item is an associative array of role metadata
* with the following keys:
* - group: the group to associate with the role. Can be 'test_group',
* 'different_bundle', or 'different_entity_type'.
* - role_name: the role name.
*/
public function saveMembershipWithInvalidRolesProvider(): array {
return [
// A membership can not be saved for an anonymous user.
[
[
[
'group' => 'test_group',
'role_name' => OgRoleInterface::ANONYMOUS,
],
],
],
// A membership with multiple roles can not be saved if any of the roles
// is for an anonymous user.
[
[
[
'group' => 'test_group',
'role_name' => OgRoleInterface::ADMINISTRATOR,
],
[
'group' => 'test_group',
'role_name' => 'custom_role',
],
[
'group' => 'test_group',
'role_name' => OgRoleInterface::ANONYMOUS,
],
],
],
// A membership can not be saved when one of the roles references a
// different bundle.
[
[
[
'group' => 'test_group',
'role_name' => OgRoleInterface::ADMINISTRATOR,
],
[
'group' => 'different_bundle',
'role_name' => OgRoleInterface::ADMINISTRATOR,
],
],
],
// A membership can not be saved when one of the roles references a
// different entity type.
[
[
[
'group' => 'test_group',
'role_name' => OgRoleInterface::ADMINISTRATOR,
],
[
'group' => 'different_entity_type',
'role_name' => OgRoleInterface::ADMINISTRATOR,
],
],
],
];
}

/**
* Tests the exception thrown if the validity of a role cannot be established.
*
Expand Down Expand Up @@ -448,7 +594,7 @@ public function testSaveSameMembershipTwice() {

$group->save();

Og::groupTypeManager()->addGroup('entity_test', $group->bundle());
$this->groupTypeManager->addGroup('entity_test', $group->bundle());

/** @var \Drupal\og\OgMembershipInterface $membership */
$membership = Og::createMembership($group, $this->user);
Expand Down