Skip to content

Commit

Permalink
Add integration tests for user_status API
Browse files Browse the repository at this point in the history
Signed-off-by: Jonas Meurer <jonas@freesources.org>
  • Loading branch information
mejo- committed Oct 20, 2021
1 parent 3fe267b commit 65cfe9d
Show file tree
Hide file tree
Showing 3 changed files with 112 additions and 0 deletions.
20 changes: 20 additions & 0 deletions build/integration/collaboration_features/user_status.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Feature: user_status
Background:
Given using api version "2"
And user "user0" exists
And user "user0" has status "dnd"

Scenario: listing recent user statuses with default settings
Then user statuses for "admin" list "user0" with status "dnd"

Scenario: empty recent user statuses with disabled/limited user enumeration
When parameter "shareapi_allow_share_dialog_user_enumeration" of app "core" is set to "no"
Then user statuses for "admin" are empty
When parameter "shareapi_allow_share_dialog_user_enumeration" of app "core" is set to "yes"
When parameter "shareapi_restrict_user_enumeration_to_group" of app "core" is set to "yes"
Then user statuses for "admin" are empty
When parameter "shareapi_restrict_user_enumeration_to_group" of app "core" is set to "no"
When parameter "shareapi_restrict_user_enumeration_to_phone" of app "core" is set to "yes"
Then user statuses for "admin" are empty
When parameter "shareapi_restrict_user_enumeration_to_phone" of app "core" is set to "no"
Then user statuses for "admin" list "user0" with status "dnd"
91 changes: 91 additions & 0 deletions build/integration/features/bootstrap/CollaborationContext.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
*/
use Behat\Behat\Context\Context;
use Behat\Gherkin\Node\TableNode;
use GuzzleHttp\Client;
use PHPUnit\Framework\Assert;

require __DIR__ . '/../../vendor/autoload.php';
Expand Down Expand Up @@ -70,4 +71,94 @@ protected function resetAppConfigs(): void {
$this->deleteServerConfig('core', 'shareapi_restrict_user_enumeration_full_match');
$this->deleteServerConfig('core', 'shareapi_only_share_with_group_members');
}

/**
* @Given /^user "([^"]*)" has status "([^"]*)"$/
* @param string $user
* @param string $status
*/
public function assureUserHasStatus($user, $status) {
$fullUrl = $this->baseUrl . "v{$this->apiVersion}.php/apps/user_status/api/v1/user_status/status";
$client = new Client();
$options = [
'headers' => [
'OCS-APIREQUEST' => 'true',
],
];
if ($user === 'admin') {
$options['auth'] = $this->adminUser;
} else {
$options['auth'] = [$user, $this->regularUser];
}

$options['form_params'] = [
'statusType' => $status
];

$this->response = $client->put($fullUrl, $options);
$this->theHTTPStatusCodeShouldBe(200);

$fullUrl = $this->baseUrl . "v{$this->apiVersion}.php/apps/user_status/api/v1/user_status";
unset($options['form_params']);
$this->response = $client->get($fullUrl, $options);
$this->theHTTPStatusCodeShouldBe(200);

$returnedStatus = json_decode(json_encode(simplexml_load_string($this->response->getBody()->getContents())->data), true)['status'];
Assert::assertEquals($status, $returnedStatus);
}

/**
* @param string $user
* @return null|array
*/
public function getStatusList(string $user): ?array {
$fullUrl = $this->baseUrl . "v{$this->apiVersion}.php/apps/user_status/api/v1/statuses";
$client = new Client();
$options = [
'headers' => [
'OCS-APIREQUEST' => 'true',
],
];
if ($user === 'admin') {
$options['auth'] = $this->adminUser;
} else {
$options['auth'] = [$user, $this->regularUser];
}

$this->response = $client->get($fullUrl, $options);
$this->theHTTPStatusCodeShouldBe(200);

$contents = $this->response->getBody()->getContents();
return json_decode(json_encode(simplexml_load_string($contents)->data), true);
}

/**
* @Given /^user statuses for "([^"]*)" list "([^"]*)" with status "([^"]*)"$/
* @param string $user
* @param string $statusUser
* @param string $status
*/
public function assertStatusesList(string $user, string $statusUser, string $status): void {
$statusList = $this->getStatusList($user);
Assert::assertArrayHasKey('element', $statusList, 'Returned status list empty or broken');
if (array_key_exists('userId', $statusList['element'])) {
// If only one user has a status set, the API returns their status directly
Assert::assertArrayHasKey('status', $statusList['element'], 'Returned status list empty or broken');
$filteredStatusList = [ $statusList['element']['userId'] => $statusList['element']['status'] ];
} else {
// If more than one user have their status set, the API returns an array of their statuses
$filteredStatusList = array_column($statusList['element'], 'status', 'userId');
}
Assert::assertArrayHasKey($statusUser, $filteredStatusList, 'User not listed in statuses: ' . $statusUser);
Assert::assertEquals($status, $filteredStatusList[$statusUser]);
}

/**
* @Given /^user statuses for "([^"]*)" are empty$/
* @param string $user
*/
public function assertStatusesEmpty(string $user): void {
$statusList = $this->getStatusList($user);
Assert::assertEmpty($statusList);
}
}
1 change: 1 addition & 0 deletions build/integration/features/bootstrap/Provisioning.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
* @author Sergio Bertolín <sbertolin@solidgear.es>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Vincent Petry <vincent@nextcloud.com>
* @author Jonas Meurer <jonas@freesources.org>
*
* @license GNU AGPL version 3 or any later version
*
Expand Down

0 comments on commit 65cfe9d

Please sign in to comment.