Skip to content

[tests-only][full-ci] added test to invite groups and users in one request #8012

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
PrajwolAmatya wants to merge 3 commits into from
Closed

[tests-only][full-ci] added test to invite groups and users in one request #8012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8c3d0da
Added test for sending share invitation to user with role
grgprarup Dec 18, 2023
3fad333
Added test for sending share invitation to group with role
grgprarup Dec 19, 2023
6025953
add test for invite groups and users in one request
PrajwolAmatya Dec 19, 2023
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
103 changes: 103 additions & 0 deletions tests/TestHelpers/GraphHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,13 @@ public static function getSpaceIdRegex(): string {
return self::getUUIDv4Regex() . '\\\$' . self::getUUIDv4Regex();
}

/**
* @return string
*/
public static function getShareIdRegex(): string {
return self::getUUIDv4Regex() . ':' . self::getUUIDv4Regex() . ':' . self::getUUIDv4Regex();
}

/**
* Key name can consist of @@@
* This function separate such key and return its actual value from actual drive response which can be used for assertion
Expand Down Expand Up @@ -1532,4 +1539,100 @@ public static function getPermissionsList(
self::getRequestHeaders()
);
}

/**
* Get the role id by name
*
* @param string $baseUrl
* @param string $xRequestId
* @param string $user
* @param string $password
* @param string $role
*
* @return string
*
*/
public static function getRoleIdByName(
string $baseUrl,
string $xRequestId,
string $user,
string $password,
string $role
) : string {
$url = self::getBetaFullUrl($baseUrl, "roleManagement/permissions/roleDefinitions");

$response = HttpRequestHelper::get(
$url,
$xRequestId,
$user,
$password,
self::getRequestHeaders(),
);

$roles = \json_decode($response->getBody()->getContents(), true, 512, JSON_THROW_ON_ERROR);

if (isset($roles)) {
foreach ($roles as $item) {
if ($item["displayName"] === $role) {
return $item["id"];
}
}
}
}

/**
* @param string $baseUrl
* @param string $xRequestId
* @param string $user
* @param string $password
* @param string $spaceId
* @param string $itemId
* @param array $shareeId
* @param array|null $shareType
* @param string|null $role
*
* @return ResponseInterface
* @throws \JsonException
*/
public static function sendSharingInvitation(
string $baseUrl,
string $xRequestId,
string $user,
string $password,
string $spaceId,
string $itemId,
array $shareeId,
?array $shareType,
?string $role
): ResponseInterface {
$url = self::getBetaFullUrl($baseUrl, "drives/$spaceId/items/$itemId/invite");
$body = [];

for ($i = 0; $i < count($shareeId); $i++) {
if ($shareType[$i] === 'group') {
$body['recipients'][] = [
"@libre.graph.recipient.type"=> "group",
"objectId" => $shareeId[$i]
];
} else {
$body['recipients'][] = [
'objectId' => $shareeId[$i]
];
}
}

if ($role !== null) {
$roleId = self::getRoleIdByName($baseUrl, $xRequestId, $user, $password, $role);
$body['roles'] = [$roleId];
}

return HttpRequestHelper::post(
$url,
$xRequestId,
$user,
$password,
self::getRequestHeaders(),
\json_encode($body)
);
}
}
215 changes: 215 additions & 0 deletions tests/acceptance/features/apiSharingNg/shareInvitations.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,215 @@
Feature: Send a sharing invitations
As the owner of a resource
I want to be able to send invitations to other users
So that they can have access to it

https://owncloud.dev/libre-graph-api/#/drives.permissions/Invite

Background:
Given these users have been created with default attributes and without skeleton files:
| username |
| Alice |
| Brian |


Scenario Outline: send sharing invitation to user with different roles via the Graph API
Given user "Alice" has uploaded file with content "to share" to "/textfile1.txt"
And user "Alice" has created folder "FolderToShare"
When user "Alice" sends the following share invitation using the Graph API:
| resourceType | <resource-type> |
| resource | <path> |
| space | Personal |
| sharee | Brian |
| shareType | user |
| role | <role> |
Then the HTTP status code should be "200"
And the JSON data of the response should match
"""
{
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"roles",
"grantedToV2"
],
"properties": {
"id": {
"type": "string",
"pattern": "^%share_id_pattern%$"
},
"roles": {
"type": "array",
"items": {
"type": "string",
"pattern": "^%role_id_pattern%$"
}
},
"grantedToV2": {
"type": "object",
"required": [
"user"
],
"properties": {
"user": {
"type": "object",
"required": [
"id",
"displayName"
],
"properties": {
"id": {
"type": "string",
"pattern": "^%user_id_pattern%$"
},
"displayName": {
"type": "string",
"enum": [
"Brian Murphy"
]
}
}
}
}
}
}
}
}
}
}
"""
Examples:
| role | resource-type | path |
| Viewer | file | /textfile1.txt |
| Editor | file | /textfile1.txt |
| Co Owner | file | /textfile1.txt |
| Uploader | file | /textfile1.txt |
| Manager | file | /textfile1.txt |
| Viewer | folder | FolderToShare |
| Editor | folder | FolderToShare |
| Co Owner | folder | FolderToShare |
| Uploader | folder | FolderToShare |
| Manager | folder | FolderToShare |


Scenario Outline: send sharing invitation to group with different roles via the Graph API
Given user "Carol" has been created with default attributes and without skeleton files
And group "grp1" has been created
And the following users have been added to the following groups
| username | groupname |
| Brian | grp1 |
| Carol | grp1 |
And user "Alice" has uploaded file with content "to share" to "/textfile1.txt"
And user "Alice" has created folder "FolderToShare"
When user "Alice" sends the following share invitation using the Graph API:
| resourceType | <resource-type> |
| resource | <path> |
| space | Personal |
| sharee | grp1 |
| shareType | group |
| role | <role> |
Then the HTTP status code should be "200"
And the JSON data of the response should match
"""
{
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"roles",
"grantedToV2"
],
"properties": {
"id": {
"type": "string",
"pattern": "^%share_id_pattern%$"
},
"roles": {
"type": "array",
"items": {
"type": "string",
"pattern": "^%role_id_pattern%$"
}
},
"grantedToV2": {
"type": "object",
"required": [
"group"
],
"properties": {
"group": {
"type": "object",
"required": [
"id",
"displayName"
],
"properties": {
"id": {
"type": "string",
"pattern": "^%group_id_pattern%$"
},
"displayName": {
"type": "string",
"enum": [
"grp1"
]
}
}
}
}
}
}
}
}
}
}
"""
Examples:
| role | resource-type | path |
| Viewer | file | /textfile1.txt |
| Editor | file | /textfile1.txt |
| Co Owner | file | /textfile1.txt |
| Uploader | file | /textfile1.txt |
| Manager | file | /textfile1.txt |
| Viewer | folder | FolderToShare |
| Editor | folder | FolderToShare |
| Co Owner | folder | FolderToShare |
| Uploader | folder | FolderToShare |
| Manager | folder | FolderToShare |


Scenario: send sharing invitation to user and group at once via the Graph API
Given these users have been created with default attributes and without skeleton files:
| username |
| Carol |
| Bob |
And the administrator has assigned the role "Admin" to user "Alice" using the Graph API
And user "Alice" has created a group "grp1" using the Graph API
And the administrator "Alice" has added the following users to a group "grp1" at once using the Graph API
| username |
| Brian |
| Carol |
And user "Alice" has uploaded file with content "to share" to "/textfile1.txt"
When user "Alice" sends the following share invitation using the Graph API:
| resourceType | file |
| resource | /textfile1.txt |
| space | Personal |
| sharee | grp1, Bob |
| shareType | group, user |
| role | Viewer |
Then the HTTP status code should be "200"
And the JSON data of the response should match
16 changes: 16 additions & 0 deletions tests/acceptance/features/bootstrap/FeatureContext.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2783,6 +2783,22 @@ public function substituteInLineCodes(
$this, "getGroupIdByGroupName"
],
"parameter" => [$group]
],
[
"code" => "%role_id_pattern%",
"function" => [
__NAMESPACE__ . '\TestHelpers\GraphHelper',
"getUUIDv4Regex"
],
"parameter" => []
],
[
"code" => "%share_id_pattern%",
"function" => [
__NAMESPACE__ . '\TestHelpers\GraphHelper',
"getShareIdRegex"
],
"parameter" => []
]
];
if ($user !== null) {
Expand Down
Loading