class AccessTest in Apigee Edge 8
Teams module access test.
@group apigee_edge @group apigee_edge_teams
Hierarchy
- class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\apigee_edge\Functional\ApigeeEdgeFunctionalTestBase uses ApigeeEdgeFunctionalTestTrait
- class \Drupal\Tests\apigee_edge_teams\Functional\ApigeeEdgeTeamsFunctionalTestBase
- class \Drupal\Tests\apigee_edge_teams\Functional\AccessTest
- class \Drupal\Tests\apigee_edge_teams\Functional\ApigeeEdgeTeamsFunctionalTestBase
- class \Drupal\Tests\apigee_edge\Functional\ApigeeEdgeFunctionalTestBase uses ApigeeEdgeFunctionalTestTrait
Expanded class hierarchy of AccessTest
File
- modules/
apigee_edge_teams/ tests/ src/ Functional/ AccessTest.php, line 33
Namespace
Drupal\Tests\apigee_edge_teams\FunctionalView source
class AccessTest extends ApigeeEdgeTeamsFunctionalTestBase {
/**
* The team entity storage.
*
* @var \Drupal\apigee_edge_teams\Entity\Storage\TeamStorageInterface
*/
protected $teamStorage;
/**
* The team app entity storage.
*
* @var \Drupal\apigee_edge_teams\Entity\Storage\TeamAppStorageInterface
*/
protected $teamAppStorage;
/**
* Default user.
*
* @var \Drupal\user\UserInterface
*/
protected $account;
/**
* Drupal user who is a member of the team.
*
* @var \Drupal\user\UserInterface
*/
protected $teamMemberAccount;
/**
* Drupal user who is not a member of the team.
*
* @var \Drupal\user\UserInterface
*/
protected $nonTeamMemberAccount;
/**
* The team membership manager service.
*
* @var \Drupal\apigee_edge_teams\TeamMembershipManagerInterface
*/
protected $teamMembershipManager;
/**
* Team entity to test.
*
* @var \Drupal\apigee_edge_teams\Entity\TeamInterface
*/
protected $team;
/**
* Team app entity to test.
*
* @var \Drupal\apigee_edge_teams\Entity\TeamAppInterface
*/
protected $teamApp;
/**
* Team entity routes.
*
* Keyed by route id.
*
* @var \Symfony\Component\Routing\Route[]
*/
protected $teamEntityRoutes = [];
/**
* Team app entity routes.
*
* Keyed by route id.
*
* @var \Symfony\Component\Routing\Route[]
*/
protected $teamAppEntityRoutes = [];
/**
* Administer routes defined by the teams module.
*/
protected const ADMIN_ROUTES = [
'apigee_edge_teams.settings.team',
'apigee_edge_teams.settings.team_app',
];
/**
* Team entity permission matrix.
*
* Key are site-wide permissions and values are routes without
* entity.{entity_id}. that a user should have access with the permission.
*/
protected const TEAM_PERMISSION_MATRIX = [
'view any team' => [
'canonical',
],
'create team' => [
'add_form',
],
'update any team' => [
'edit_form',
],
'delete any team' => [
'delete_form',
],
'manage team members' => [
'members',
'add_members',
'member.edit',
'member.remove',
],
];
/**
* Team membership level permission matrix.
*
* Key are team-level permissions and values are routes without
* entity.{entity_id}. that a user should have access with the permission.
*/
protected const TEAM_MEMBER_PERMISSION_MATRIX = [
'team_manage_members' => [
'members',
'add_members',
'member.edit',
'member.remove',
],
'team_app_view' => [
'canonical',
'collection_by_team',
'api_keys',
],
'team_app_create' => [
'add_form_for_team',
],
'team_app_update' => [
'edit_form',
],
'team_app_delete' => [
'delete_form',
],
'team_app_analytics' => [
'analytics',
],
'team_app_add_api_key' => [
'add_api_key_form',
],
];
/**
* User roles associated to permissions.
*
* @var \Drupal\user\RoleInterface[]
*/
protected $roles;
/**
* The team role storage.
*
* @var \Drupal\apigee_edge_teams\Entity\Storage\TeamRoleStorageInterface
*/
protected $teamRoleStorage;
/**
* The team member role storage.
*
* @var \Drupal\apigee_edge_teams\Entity\Storage\TeamMemberRoleStorageInterface
*/
protected $teamMemberRoleStorage;
/**
* The team permission handler.
*
* @var \Drupal\apigee_edge_teams\TeamPermissionHandlerInterface
*/
protected $teamPermissionHandler;
/**
* The state service.
*
* @var \Drupal\Core\State\State
*/
protected $state;
/**
* {@inheritdoc}
*/
protected static $modules = [
'apigee_edge_teams_test',
];
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
$this->teamStorage = $this->container
->get('entity_type.manager')
->getStorage('team');
$this->teamAppStorage = $this->container
->get('entity_type.manager')
->getStorage('team_app');
$this->teamRoleStorage = $this->container
->get('entity_type.manager')
->getStorage('team_role');
$this->teamMemberRoleStorage = $this->container
->get('entity_type.manager')
->getStorage('team_member_role');
$this->teamMembershipManager = $this->container
->get('apigee_edge_teams.team_membership_manager');
$this->teamPermissionHandler = $this->container
->get('apigee_edge_teams.team_permissions');
$this->state = $this->container
->get('state');
$team_entity_type = $this->container
->get('entity_type.manager')
->getDefinition('team');
$team_app_entity_type = $this->container
->get('entity_type.manager')
->getDefinition('team_app');
/** @var \Drupal\Core\Entity\Routing\EntityRouteProviderInterface $provider */
foreach ($this->container
->get('entity_type.manager')
->getRouteProviders('team') as $provider) {
foreach ($provider
->getRoutes($team_entity_type) as $id => $route) {
$this->teamEntityRoutes[$id] = $route;
}
}
/** @var \Drupal\Core\Entity\Routing\EntityRouteProviderInterface $provider */
foreach ($this->container
->get('entity_type.manager')
->getRouteProviders('team_app') as $provider) {
foreach ($provider
->getRoutes($team_app_entity_type) as $id => $route) {
$this->teamAppEntityRoutes[$id] = $route;
}
}
// Skip api key routes. These are tested separately.
$this->teamAppEntityRoutes = array_filter($this->teamAppEntityRoutes, function (Route $route) {
return strpos($route
->getPath(), '{consumer_key}') === FALSE;
});
$this->team = $this->teamStorage
->create([
'name' => mb_strtolower($this
->getRandomGenerator()
->name()),
]);
$this->team
->save();
$this->teamApp = $this->teamAppStorage
->create([
'name' => mb_strtolower($this
->getRandomGenerator()
->name()),
'companyName' => $this->team
->getName(),
]);
$this->teamApp
->save();
$this->account = $this
->createAccount();
$this->nonTeamMemberAccount = $this
->createAccount();
$this->teamMemberAccount = $this
->createAccount();
$this->teamMembershipManager
->addMembers($this->team
->getName(), [
$this->teamMemberAccount
->getEmail(),
]);
// Create roles for team permissions.
foreach (array_keys(static::TEAM_PERMISSION_MATRIX) as $permission) {
$this->roles[$permission] = $this
->createRole([
$permission,
], preg_replace('/[^a-z0-9_]+/', '_', $permission));
}
// Create roles for admin permissions.
$this->roles['administer apigee edge'] = $this
->createRole([
'administer apigee edge',
], 'administer_apigee_edge');
$this->roles['administer team'] = $this
->createRole([
'administer team',
], 'administer_team');
$this->roles['manage team apps'] = $this
->createRole([
'manage team apps',
], 'manage_team_apps');
}
/**
* {@inheritdoc}
*/
protected function tearDown() {
if ($this->team !== NULL) {
try {
$this->teamStorage
->delete([
$this->team,
]);
} catch (\Exception $exception) {
$this
->logException($exception);
}
}
if ($this->account !== NULL) {
try {
$this->account
->delete();
} catch (\Exception $exception) {
$this
->logException($exception);
}
}
if ($this->teamMemberAccount !== NULL) {
try {
$this->teamMemberAccount
->delete();
} catch (\Exception $exception) {
$this
->logException($exception);
}
}
if ($this->nonTeamMemberAccount !== NULL) {
try {
$this->nonTeamMemberAccount
->delete();
} catch (\Exception $exception) {
$this
->logException($exception);
}
}
parent::tearDown();
}
/**
* Tests team, team membership level and admin permissions, team roles.
*/
public function testAccess() {
$this
->teamAccessTest();
$this
->teamRoleAccessTest();
$this
->teamExpansionTest();
}
/**
* Tests team, team membership level and admin permissions.
*/
protected function teamAccessTest() {
// Ensure the current user is anonymous.
if ($this->loggedInUser) {
$this
->drupalLogout();
}
// Anonymous user has no access to team, team app and admin pages.
$this
->validateTeamAccess();
$this
->validateTeamAppAccess();
$this
->validateAccessToAdminRoutes(FALSE);
// The user is not a member of the team and it has no teams related
// permission. It has no access to view any team or team app related page.
$this
->drupalLogin($this->account);
$this
->validateTeamAccess();
$this
->validateTeamAppAccess();
// The user is not a member of the team. Grant every team entity related
// permission one by one and validate available UIs.
foreach (array_keys(self::TEAM_PERMISSION_MATRIX) as $permission) {
$this
->setUserPermissions([
$permission,
]);
$this
->validateTeamAccess();
$this
->validateTeamAppAccess();
}
// The user is not a member of the team but it has every team related
// permission. It has no access to view any team app page.
$this
->setUserPermissions(array_keys(self::TEAM_PERMISSION_MATRIX));
$this
->validateTeamAccess();
$this
->validateTeamAppAccess();
// The user is a member of the team but it has no team related site-wide
// permission and every team permission is also revoked.
$this->teamMembershipManager
->addMembers($this->team
->getName(), [
$this->account
->getEmail(),
]);
$this
->setUserPermissions([]);
$this
->setTeamRolePermissionsOnUi(TeamRoleInterface::TEAM_MEMBER_ROLE, []);
$this
->validateTeamAccess();
$this
->validateTeamAppAccess();
// The user is a member of the team. Check every team member level
// permission one by one.
foreach (array_keys(self::TEAM_MEMBER_PERMISSION_MATRIX) as $permission) {
$this
->setTeamRolePermissionsOnUi(TeamRoleInterface::TEAM_MEMBER_ROLE, [
$permission,
]);
$this
->validateTeamAccess();
$this
->validateTeamAppAccess();
}
// The user is not a member of the team but every team member operation is
// enabled. The user has no access to the team and team app related pages.
$this
->setTeamRolePermissionsOnUi(TeamRoleInterface::TEAM_MEMBER_ROLE, array_keys(self::TEAM_MEMBER_PERMISSION_MATRIX));
$this->teamMembershipManager
->removeMembers($this->team
->getName(), [
$this->account
->getEmail(),
]);
$this
->validateTeamAccess();
$this
->validateTeamAppAccess();
// With administer apigee edge permission the user has no access to team,
// team app and admin pages.
$this
->setUserPermissions([
'administer apigee edge',
]);
$this
->validateTeamAccess();
$this
->validateTeamAppAccess();
$this
->validateAccessToAdminRoutes(FALSE);
// With manage team apps permission the user has access to team app pages.
$this
->setUserPermissions([
'manage team apps',
]);
$this
->validateTeamAccess();
$this
->validateTeamAppAccess(TRUE);
$this
->validateAccessToAdminRoutes(FALSE);
// With administer teams permission the user has access to team, team app
// and admin pages.
$this
->setUserPermissions([
'administer team',
]);
$this
->validateTeamAccess(TRUE);
$this
->validateTeamAppAccess(TRUE);
$this
->validateAccessToAdminRoutes(TRUE);
}
/**
* Tests team roles related UIs, permissions.
*/
protected function teamRoleAccessTest() {
// Ensure the current user is anonymous.
if ($this->loggedInUser) {
$this
->drupalLogout();
}
// The user is a member of the team and it has no teams related permission.
// The user has the default "member" role in the team, the default member
// role has no permissions.
$this
->setUserPermissions([]);
$this
->setTeamRolePermissionsOnUi(TeamRoleInterface::TEAM_MEMBER_ROLE, []);
$this->teamMembershipManager
->addMembers($this->team
->getName(), [
$this->account
->getEmail(),
]);
// Create roles for every team membership level permission.
$this
->drupalLogin($this->rootUser);
foreach (array_keys(self::TEAM_MEMBER_PERMISSION_MATRIX) as $permission) {
$this
->drupalPostForm(Url::fromRoute('entity.team_role.add_form'), [
'label' => $permission,
'id' => $permission,
], 'Save');
$this
->setTeamRolePermissionsOnUi($permission, [
$permission,
]);
}
// Grant team roles to the team member one by one.
foreach (array_keys(self::TEAM_MEMBER_PERMISSION_MATRIX) as $permission) {
$this
->drupalLogin($this->rootUser);
$this->teamMemberRoleStorage
->addTeamRoles($this->account, $this->team, [
$permission,
]);
$this
->drupalLogin($this->account);
$this
->validateTeamAccess();
$this
->validateTeamAppAccess();
$this
->drupalLogout();
}
// Revoke team roles from the team member one by one.
foreach (array_keys(self::TEAM_MEMBER_PERMISSION_MATRIX) as $permission) {
$this
->drupalLogin($this->rootUser);
$this->teamMemberRoleStorage
->addTeamRoles($this->account, $this->team, [
$permission,
]);
$this
->drupalLogin($this->account);
$this
->validateTeamAccess();
$this
->validateTeamAppAccess();
$this
->drupalLogout();
}
}
/**
* Tests apigee_edge_teams_test module.
*/
protected function teamExpansionTest() {
// Ensure that the apigee_edge_teams_test module properly extends the team
// role permission UI.
$this
->drupalLogin($this->rootUser);
$this
->drupalGet(Url::fromRoute('apigee_edge_teams.settings.team.permissions'));
// Check whether the permission group labels and the permission labels and
// descriptions are visible.
$this
->assertSession()
->pageTextContains('Apigee Edge Teams: Testing');
$this
->assertSession()
->pageTextContains('Team permission test');
$this
->assertSession()
->pageTextContains('Team permission test 1');
$this
->assertSession()
->pageTextContains('This is the 1st team test permission.');
$this
->assertSession()
->pageTextContains('Team permission test 2');
$this
->assertSession()
->pageTextContains('Team permission test 3');
$this
->assertSession()
->pageTextContains('This is the 3rd team test permission.');
$this
->assertSession()
->pageTextContains('Team permission test 4');
// Change the username to grant every team permission to the user in
// apigee_edge_teams_test_apigee_edge_teams_developer_permissions_by_team_alter().
// It is not necessary to save the developer associated with this user.
$this
->disableUserPresave();
$this->account
->setUsername(APIGEE_EDGE_TEAMS_TEST_SPECIAL_USERNAME_WITH_ALL_TEAM_PERMISSIONS);
$this->account
->save();
$this
->enableUserPresave();
// Make sure that the user is no longer a member of the team anymore.
if (in_array($this->team
->id(), $this->teamMembershipManager
->getTeams($this->account
->getEmail()))) {
$this->teamMembershipManager
->removeMembers($this->team
->getName(), [
$this->account
->getEmail(),
]);
}
$this
->assertNotContains($this->team
->id(), $this->teamMembershipManager
->getTeams($this->account
->getEmail()));
$this
->drupalLogin($this->account);
// Even if the account is not member of the team it should have access all
// team related UIs that a team permission can grant access.
// (The user can still not CRUD teams but it can access to the teams list.)
$this
->validateTeamAccess();
$this
->validateTeamAppAccess();
// Now it can not just access to the team list, but it can see all teams
// in the list and access all team related UIs because it has all team
// permissions.
$this->state
->set(APIGEE_EDGE_TEAMS_TEST_SPECIAL_USERNAME_CAN_VIEW_ANY_TEAM_STATE_KEY, TRUE);
$this
->validateAccess($this->team
->toUrl(), Response::HTTP_OK);
}
/**
* Checks whether the user has access to team pages.
*
* @param bool $admin_access
* TRUE if the user has access to every team page.
*/
protected function validateTeamAccess(bool $admin_access = FALSE) {
$route_ids_with_access = [];
if ($admin_access) {
$route_ids_with_access = array_map(function (string $route_id) {
return str_replace('entity.team.', '', $route_id);
}, array_keys($this->teamEntityRoutes));
}
else {
foreach (array_keys(self::TEAM_PERMISSION_MATRIX) as $permission) {
if ($this->account
->hasPermission($permission)) {
$route_ids_with_access = array_merge($route_ids_with_access, self::TEAM_PERMISSION_MATRIX[$permission]);
}
}
if ($this
->drupalUserIsLoggedIn($this->account)) {
// Authenticated users always have access to team collection.
$route_ids_with_access[] = 'collection';
}
// Team members always have access to the team canonical page.
if (in_array($this->account
->getEmail(), $this->teamMembershipManager
->getMembers($this->team
->getName()))) {
$route_ids_with_access[] = 'canonical';
}
// The developer is not necessarily a member of the team.
if (in_array('team_manage_members', $this->teamPermissionHandler
->getDeveloperPermissionsByTeam($this->team, $this->account))) {
$route_ids_with_access = array_merge($route_ids_with_access, self::TEAM_MEMBER_PERMISSION_MATRIX['team_manage_members']);
}
}
foreach ($this->teamEntityRoutes as $route_id => $route) {
$short_route_id = str_replace('entity.team.', '', $route_id);
$rel = str_replace('_', '-', $short_route_id);
// First try to use the entity to generate the url - and with that
// make sure the url parameter resolver works on the entity.
if ($this->team
->hasLinkTemplate($rel)) {
$url = $this->team
->toUrl($rel);
if (in_array($short_route_id, $route_ids_with_access)) {
$this
->validateAccess($url, Response::HTTP_OK);
}
else {
$this
->validateAccess($url, Response::HTTP_FORBIDDEN);
}
}
else {
// If the route is not registered as link in entity links - because
// it contains a route parameter that the entity can not resolve -
// fallback to the URL resolver. At this time these are the member.edit
// and member.remove routes. Use a developer parameter in the route
// which belongs to a member of the team and which belongs to a
// non-member of the team and an email address of a non-existing
// developer.
$params = [
'team' => $this->team
->id(),
];
$this
->validateAccess(Url::fromRoute($route_id, $params + [
'developer' => $this->teamMemberAccount
->getEmail(),
]), in_array($short_route_id, $route_ids_with_access) ? Response::HTTP_OK : Response::HTTP_FORBIDDEN);
$this
->validateAccess(Url::fromRoute($route_id, $params + [
'developer' => $this->nonTeamMemberAccount
->getEmail(),
]), Response::HTTP_FORBIDDEN);
$this
->validateAccess(Url::fromRoute($route_id, $params + [
'developer' => $this
->randomMachineName() . '@example.com',
]), Response::HTTP_NOT_FOUND);
}
}
}
/**
* Checks whether the user has access to team app pages.
*
* @param bool $admin_access
* TRUE if the user has access to every team app page.
*
* @throws \Drupal\Core\Entity\EntityMalformedException
*/
protected function validateTeamAppAccess(bool $admin_access = FALSE) {
$route_ids_with_access = [];
if ($admin_access) {
$route_ids_with_access = array_map(function (string $route_id) {
return str_replace('entity.team_app.', '', $route_id);
}, array_keys($this->teamAppEntityRoutes));
}
else {
// The developer is not necessarily a member of the team.
foreach (array_keys(self::TEAM_MEMBER_PERMISSION_MATRIX) as $permission) {
if (in_array($permission, $this->teamPermissionHandler
->getDeveloperPermissionsByTeam($this->team, $this->account))) {
$route_ids_with_access = array_merge($route_ids_with_access, self::TEAM_MEMBER_PERMISSION_MATRIX[$permission]);
}
}
}
foreach ($this->teamAppEntityRoutes as $route_id => $route) {
$short_route_id = str_replace('entity.team_app.', '', $route_id);
$rel = str_replace('_', '-', $short_route_id);
// First try to use the entity to generate the url - and with that
// make sure the url parameter resolver works on the entity.
if ($this->teamApp
->hasLinkTemplate($rel)) {
$url = $this->teamApp
->toUrl($rel);
}
else {
// If the route is not registered as link in entity links - because
// it contains a route parameter that the entity can not resolve -
// fallback to the URL resolver.
$params = [
'team' => $this->team
->id(),
];
if (strpos($route
->getPath(), '{app}') !== FALSE) {
$params['app'] = $this->teamApp
->getName();
}
$url = Url::fromRoute($route_id, $params);
}
if (in_array($short_route_id, $route_ids_with_access)) {
$this
->validateAccess($url, Response::HTTP_OK);
}
else {
$this
->validateAccess($url, Response::HTTP_FORBIDDEN);
}
}
}
/**
* Checks whether the user has access to the given URL.
*
* @param \Drupal\Core\Url $url
* The Url object to check.
* @param int $expected_response_status_code
* The expected HTTP response status code.
*/
protected function validateAccess(Url $url, int $expected_response_status_code) {
$this
->drupalGet($url
->toString());
$code = $this
->getSession()
->getStatusCode();
$current_user_roles = implode(', ', $this->account
->getRoles());
$this
->assertEquals($expected_response_status_code, $code, "Visited path: {$url->getInternalPath()}. User roles: {$current_user_roles}");
}
/**
* Checks whether the user has access to admin routes.
*
* @param bool $user_has_access
* TRUE if the user has access to admin routes, else FALSE.
*/
protected function validateAccessToAdminRoutes(bool $user_has_access) {
foreach (self::ADMIN_ROUTES as $route_name) {
$this
->validateAccess(Url::fromRoute($route_name), $user_has_access ? Response::HTTP_OK : Response::HTTP_FORBIDDEN);
}
}
/**
* Sets team permissions.
*
* @param array $permissions
* Array of team permissions to give.
*/
protected function setUserPermissions(array $permissions) {
$old_roles = $this->account
->getRoles(TRUE);
foreach ($old_roles as $old_role) {
$this->account
->removeRole($old_role);
}
foreach ($permissions as $permission) {
$this->account
->addRole($this->roles[$permission]);
}
// It is not necessary to save the developer associated with this user.
$this
->disableUserPresave();
$this->account
->save();
$this
->enableUserPresave();
}
/**
* Sets team role permissions.
*
* The team role permission admin UI is tested properly while changing the
* permissions.
*
* @param string $role_name
* The ID of a team role.
* @param array $permissions
* Team role permissions to enable.
*/
protected function setTeamRolePermissionsOnUi(string $role_name, array $permissions) {
// Save the original logged in user if there is any.
// Note: The account switcher service is not working as it is expected this
// is the reason why we need this workaround.
$oldNotRootLoggedInUser = NULL;
if ($this->loggedInUser && $this->loggedInUser
->id() != $this->rootUser
->id()) {
$oldNotRootLoggedInUser = clone $this->loggedInUser;
}
// Save permissions with admin user.
if ($oldNotRootLoggedInUser === NULL || $oldNotRootLoggedInUser
->id() !== $this->rootUser
->id()) {
$this
->drupalLogin($this->rootUser);
}
$permission_changes = [];
foreach (array_keys(self::TEAM_MEMBER_PERMISSION_MATRIX) as $permission) {
$permission_changes["{$role_name}[{$permission}]"] = in_array($permission, $permissions);
}
$this
->drupalPostForm(Url::fromRoute('apigee_edge_teams.settings.team.permissions'), $permission_changes, 'Save permissions');
// Dump permission configuration to the HTML output.
$this
->drupalGet(Url::fromRoute('apigee_edge_teams.settings.team.permissions'));
// Because changes made on the UI therefore _this_ instance of the team role
// storage must be cleared manually.
$this->teamRoleStorage
->resetCache([
$role_name,
]);
// Log back in with the old, not root user.
if ($oldNotRootLoggedInUser) {
if ($oldNotRootLoggedInUser
->id() === $this->account
->id()) {
$this
->drupalLogin($this->account);
}
else {
throw new \Exception("Unable to switch back to the originally logged user because it was neither the root user nor the simple authenticated user. Its user id: {$oldNotRootLoggedInUser->id()}.");
}
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccessTest:: |
protected | property | Default user. | |
AccessTest:: |
protected static | property |
Modules to enable. Overrides ApigeeEdgeTeamsFunctionalTestBase:: |
|
AccessTest:: |
protected | property | Drupal user who is not a member of the team. | |
AccessTest:: |
protected | property | User roles associated to permissions. | |
AccessTest:: |
protected | property | The state service. | |
AccessTest:: |
protected | property | Team entity to test. | |
AccessTest:: |
protected | property | Team app entity to test. | |
AccessTest:: |
protected | property | Team app entity routes. | |
AccessTest:: |
protected | property | The team app entity storage. | |
AccessTest:: |
protected | property | Team entity routes. | |
AccessTest:: |
protected | property | Drupal user who is a member of the team. | |
AccessTest:: |
protected | property | The team member role storage. | |
AccessTest:: |
protected | property | The team membership manager service. | |
AccessTest:: |
protected | property | The team permission handler. | |
AccessTest:: |
protected | property | The team role storage. | |
AccessTest:: |
protected | property | The team entity storage. | |
AccessTest:: |
protected | constant | Administer routes defined by the teams module. | |
AccessTest:: |
protected | function | Sets team role permissions. | |
AccessTest:: |
protected | function |
Overrides ApigeeEdgeFunctionalTestBase:: |
|
AccessTest:: |
protected | function | Sets team permissions. | |
AccessTest:: |
protected | function | Tests team, team membership level and admin permissions. | |
AccessTest:: |
protected | function | Tests apigee_edge_teams_test module. | |
AccessTest:: |
protected | function | Tests team roles related UIs, permissions. | |
AccessTest:: |
protected | constant | Team membership level permission matrix. | |
AccessTest:: |
protected | constant | Team entity permission matrix. | |
AccessTest:: |
protected | function |
Overrides BrowserTestBase:: |
|
AccessTest:: |
public | function | Tests team, team membership level and admin permissions, team roles. | |
AccessTest:: |
protected | function | Checks whether the user has access to the given URL. | |
AccessTest:: |
protected | function | Checks whether the user has access to admin routes. | |
AccessTest:: |
protected | function | Checks whether the user has access to team pages. | |
AccessTest:: |
protected | function | Checks whether the user has access to team app pages. | |
ApigeeEdgeFunctionalTestBase:: |
protected | property |
For tests relying on no markup at all or at least no core markup. Overrides BrowserTestBase:: |
|
ApigeeEdgeFunctionalTestTrait:: |
protected static | property | Use the mock_api_client or not. | 9 |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | Implements link clicking properly. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | Creates a Drupal account. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function |
Creates an app for a user. Overrides ApigeeMockApiClientHelperTrait:: |
|
ApigeeEdgeFunctionalTestTrait:: |
protected | function | Creates a product. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | The corresponding developer will not be created if a Drupal user is saved. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | The same as drupalGet(), but ignores the meta refresh. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | The corresponding developer will be created if a Drupal user is saved. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | Finds a link on the current page. | |
ApigeeEdgeFunctionalTestTrait:: |
protected static | function | Returns absolute URL starts with a slash. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | Loads all apps for a given user. | 1 |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | Gets a random unique ID. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | Initializes test environment with required configuration. | |
ApigeeEdgeFunctionalTestTrait:: |
protected | function | Log the given exception using the class short name as type. | |
ApigeeEdgeUtilTestTrait:: |
protected | function | Creates a test key from environment variables, using config key storage. | |
ApigeeEdgeUtilTestTrait:: |
protected | function | Removes the active key for testing with unset API credentials. | |
ApigeeEdgeUtilTestTrait:: |
protected | function | Restores the active key. | |
ApigeeEdgeUtilTestTrait:: |
protected | function | Set active authentication keys in config. | |
ApigeeMockApiClientHelperTrait:: |
protected | property | The entity type manager. | |
ApigeeMockApiClientHelperTrait:: |
protected | property | If integration (real API connection) is enabled. | |
ApigeeMockApiClientHelperTrait:: |
protected | property | The mock response factory service. | |
ApigeeMockApiClientHelperTrait:: |
protected | property | The SDK connector service. | 1 |
ApigeeMockApiClientHelperTrait:: |
protected | property | The mock handler stack is responsible for serving queued api responses. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Add matched developer response. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Add matched org response. | |
ApigeeMockApiClientHelperTrait:: |
public | function | Adds a user to a team. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Setup. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Setup. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Helper to create a Team entity. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Initialize SDK connector. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Installs a given list of modules and rebuilds the cache. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Queues up a mock companies response. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Queues up a mock company response. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Helper to add Edge entity response to stack. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Queues up a mock developer response. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Queues up a mock developer response. | |
ApigeeMockApiClientHelperTrait:: |
protected | function | Queues up a mock developers in a company response. | |
AssertHelperTrait:: |
protected static | function | Casts MarkupInterface objects into strings. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | Asserts whether an expected cache tag was present in the last response. | |
AssertLegacyTrait:: |
protected | function | Asserts that the element with the given CSS selector is not present. | |
AssertLegacyTrait:: |
protected | function | Asserts that the element with the given CSS selector is present. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertLegacyTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertLegacyTrait:: |
protected | function | Checks that current response header equals value. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertLegacyTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertLegacyTrait:: |
protected | function | Asserts whether an expected cache tag was absent in the last response. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text is not found escaped on the loaded page. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does NOT exist with the given name or ID. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertLegacyTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertLegacyTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertLegacyTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option does NOT exist in the current page. | |
AssertLegacyTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is not found in the raw content. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS not found on the loaded page, fail otherwise. | 1 |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | 1 |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead. | |
AssertLegacyTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertLegacyTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | 1 |
AssertLegacyTrait:: |
protected | function | Asserts the page responds with the specified response code. | 1 |
AssertLegacyTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | 1 |
AssertLegacyTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertLegacyTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertLegacyTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertLegacyTrait:: |
protected | function | Passes if the internal browser's URL matches the given path. | |
AssertLegacyTrait:: |
protected | function | Builds an XPath query. | |
AssertLegacyTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertLegacyTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertLegacyTrait:: |
protected | function | Gets the current raw content. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | ||
BlockCreationTrait:: |
protected | function | Creates a block instance based on default settings. Aliased as: drupalPlaceBlock | |
BrowserHtmlDebugTrait:: |
protected | property | The Base URI to use for links to the output files. | |
BrowserHtmlDebugTrait:: |
protected | property | Class name for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Counter for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Counter storage for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Directory name for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | HTML output output enabled. | |
BrowserHtmlDebugTrait:: |
protected | property | The file name to write the list of URLs to. | |
BrowserHtmlDebugTrait:: |
protected | property | HTML output test ID. | |
BrowserHtmlDebugTrait:: |
protected | function | Formats HTTP headers as string for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | function | Returns headers in HTML output format. | 1 |
BrowserHtmlDebugTrait:: |
protected | function | Logs a HTML output message in a text file. | |
BrowserHtmlDebugTrait:: |
protected | function | Creates the directory to store browser output. | |
BrowserTestBase:: |
protected | property | The base URL. | |
BrowserTestBase:: |
protected | property | The config importer that can be used in a test. | |
BrowserTestBase:: |
protected | property | An array of custom translations suitable for drupal_rewrite_settings(). | |
BrowserTestBase:: |
protected | property | The database prefix of this test run. | |
BrowserTestBase:: |
protected | property | Mink session manager. | |
BrowserTestBase:: |
protected | property | ||
BrowserTestBase:: |
protected | property | 1 | |
BrowserTestBase:: |
protected | property | The original container. | |
BrowserTestBase:: |
protected | property | The original array of shutdown function callbacks. | |
BrowserTestBase:: |
protected | property | ||
BrowserTestBase:: |
protected | property | The profile to install as a basis for testing. | 39 |
BrowserTestBase:: |
protected | property | The app root. | |
BrowserTestBase:: |
protected | property | Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests. | |
BrowserTestBase:: |
protected | property | Time limit in seconds for the test. | |
BrowserTestBase:: |
protected | property | The translation file directory for the test environment. | |
BrowserTestBase:: |
protected | function | Clean up the Simpletest environment. | |
BrowserTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
BrowserTestBase:: |
protected | function | Translates a CSS expression to its XPath equivalent. | |
BrowserTestBase:: |
protected | function | Gets the value of an HTTP response header. | |
BrowserTestBase:: |
protected | function | Returns all response headers. | |
BrowserTestBase:: |
public static | function | Ensures test files are deletable. | |
BrowserTestBase:: |
protected | function | Gets an instance of the default Mink driver. | |
BrowserTestBase:: |
protected | function | Gets the JavaScript drupalSettings variable for the currently-loaded page. | 1 |
BrowserTestBase:: |
protected | function | Obtain the HTTP client for the system under test. | |
BrowserTestBase:: |
protected | function | Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. | 1 |
BrowserTestBase:: |
protected | function | Helper function to get the options of select field. | |
BrowserTestBase:: |
protected | function |
Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait:: |
|
BrowserTestBase:: |
public | function | Returns Mink session. | |
BrowserTestBase:: |
protected | function | Get session cookies from current session. | |
BrowserTestBase:: |
protected | function |
Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait:: |
|
BrowserTestBase:: |
protected | function | Visits the front page when initializing Mink. | 3 |
BrowserTestBase:: |
protected | function | Initializes Mink sessions. | 1 |
BrowserTestBase:: |
public | function | Installs Drupal into the Simpletest site. | 1 |
BrowserTestBase:: |
protected | function | Registers additional Mink sessions. | |
BrowserTestBase:: |
protected | function | Transforms a nested array into a flat array suitable for drupalPostForm(). | |
BrowserTestBase:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
BrowserTestBase:: |
public | function | 1 | |
BrowserTestBase:: |
public | function | Prevents serializing any properties. | |
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ContentTypeCreationTrait:: |
protected | function | Creates a custom content type based on default settings. Aliased as: drupalCreateContentType | 1 |
FunctionalTestSetupTrait:: |
protected | property | The flag to set 'apcu_ensure_unique_prefix' setting. | 1 |
FunctionalTestSetupTrait:: |
protected | property | The class loader to use for installation and initialization of setup. | |
FunctionalTestSetupTrait:: |
protected | property | The config directories used in this test. | |
FunctionalTestSetupTrait:: |
protected | property | The "#1" admin user. | |
FunctionalTestSetupTrait:: |
protected | function | Execute the non-interactive installer. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Returns all supported database driver installer objects. | |
FunctionalTestSetupTrait:: |
protected | function | Initialize various configurations post-installation. | 2 |
FunctionalTestSetupTrait:: |
protected | function | Initializes the kernel after installation. | |
FunctionalTestSetupTrait:: |
protected | function | Initialize settings created during install. | |
FunctionalTestSetupTrait:: |
protected | function | Initializes user 1 for the site to be installed. | |
FunctionalTestSetupTrait:: |
protected | function | Installs the default theme defined by `static::$defaultTheme` when needed. | |
FunctionalTestSetupTrait:: |
protected | function | Install modules defined by `static::$modules`. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Returns the parameters that will be used when Simpletest installs Drupal. | 9 |
FunctionalTestSetupTrait:: |
protected | function | Prepares the current environment for running the test. | 23 |
FunctionalTestSetupTrait:: |
protected | function | Creates a mock request and sets it on the generator. | |
FunctionalTestSetupTrait:: |
protected | function | Prepares site settings and services before installation. | 2 |
FunctionalTestSetupTrait:: |
protected | function | Resets and rebuilds the environment after setup. | |
FunctionalTestSetupTrait:: |
protected | function | Rebuilds \Drupal::getContainer(). | |
FunctionalTestSetupTrait:: |
protected | function | Resets all data structures after having enabled new modules. | |
FunctionalTestSetupTrait:: |
protected | function | Changes parameters in the services.yml file. | |
FunctionalTestSetupTrait:: |
protected | function | Sets up the base URL based upon the environment variable. | |
FunctionalTestSetupTrait:: |
protected | function | Rewrites the settings.php file of the test site. | |
NodeCreationTrait:: |
protected | function | Creates a node based on default settings. Aliased as: drupalCreateNode | |
NodeCreationTrait:: |
public | function | Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle | |
PhpunitCompatibilityTrait:: |
public | function | Returns a mock object for the specified class using the available method. | |
PhpunitCompatibilityTrait:: |
public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
RefreshVariablesTrait:: |
protected | function | Refreshes in-memory configuration and state information. | 3 |
SessionTestTrait:: |
protected | property | The name of the session cookie. | |
SessionTestTrait:: |
protected | function | Generates a session cookie name. | |
SessionTestTrait:: |
protected | function | Returns the session name in use on the child site. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
TestSetupTrait:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
TestSetupTrait:: |
protected | property | The dependency injection container used in the test. | |
TestSetupTrait:: |
protected | property | The DrupalKernel instance used in the test. | |
TestSetupTrait:: |
protected | property | The site directory of the original parent site. | |
TestSetupTrait:: |
protected | property | The private file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The public file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The site directory of this test run. | |
TestSetupTrait:: |
protected | property | Set to TRUE to strict check all configuration saved. | 2 |
TestSetupTrait:: |
protected | property | The temporary file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The test run ID. | |
TestSetupTrait:: |
protected | function | Changes the database connection to the prefixed one. | |
TestSetupTrait:: |
protected | function | Gets the config schema exclusions for this test. | |
TestSetupTrait:: |
public static | function | Returns the database connection to the site running Simpletest. | |
TestSetupTrait:: |
protected | function | Generates a database prefix for running tests. | 2 |
UiHelperTrait:: |
protected | property | The current user logged in using the Mink controlled browser. | |
UiHelperTrait:: |
protected | property | The number of meta refresh redirects to follow, or NULL if unlimited. | |
UiHelperTrait:: |
protected | property | The number of meta refresh redirects followed during ::drupalGet(). | |
UiHelperTrait:: |
public | function | Returns WebAssert object. | 1 |
UiHelperTrait:: |
protected | function | Builds an a absolute URL from a system path or a URL object. | |
UiHelperTrait:: |
protected | function | Checks for meta refresh tag and if found call drupalGet() recursively. | |
UiHelperTrait:: |
protected | function | Clicks the element with the given CSS selector. | |
UiHelperTrait:: |
protected | function | Follows a link by complete name. | |
UiHelperTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
UiHelperTrait:: |
protected | function | Retrieves a Drupal path or an absolute path. | 3 |
UiHelperTrait:: |
protected | function | Logs in a user using the Mink controlled browser. | |
UiHelperTrait:: |
protected | function | Logs a user out of the Mink controlled browser and confirms. | |
UiHelperTrait:: |
protected | function | Executes a form submission. | |
UiHelperTrait:: |
protected | function | Returns whether a given user account is logged in. | |
UiHelperTrait:: |
protected | function | Takes a path and returns an absolute path. | |
UiHelperTrait:: |
protected | function | Retrieves the plain-text content from the current page. | |
UiHelperTrait:: |
protected | function | Get the current URL from the browser. | |
UiHelperTrait:: |
protected | function | Prepare for a request to testing site. | 1 |
UiHelperTrait:: |
protected | function | Fills and submits a form. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. | |
UserCreationTrait:: |
protected | function | Creates an administrative role. | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. Aliased as: drupalCreateRole | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. Aliased as: drupalCreateUser | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. | |
XdebugRequestTrait:: |
protected | function | Adds xdebug cookies, from request setup. |