From 65cfe9df4650fbc877d2104a7f3c21e002e87b5d Mon Sep 17 00:00:00 2001 From: Jonas Meurer Date: Tue, 19 Oct 2021 10:56:07 +0200 Subject: [PATCH] Add integration tests for user_status API Signed-off-by: Jonas Meurer --- .../user_status.feature | 20 ++++ .../bootstrap/CollaborationContext.php | 91 +++++++++++++++++++ .../features/bootstrap/Provisioning.php | 1 + 3 files changed, 112 insertions(+) create mode 100644 build/integration/collaboration_features/user_status.feature diff --git a/build/integration/collaboration_features/user_status.feature b/build/integration/collaboration_features/user_status.feature new file mode 100644 index 0000000000000..759d6e31795fb --- /dev/null +++ b/build/integration/collaboration_features/user_status.feature @@ -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" diff --git a/build/integration/features/bootstrap/CollaborationContext.php b/build/integration/features/bootstrap/CollaborationContext.php index 17eb820c77dbc..4ac3b6e39717e 100644 --- a/build/integration/features/bootstrap/CollaborationContext.php +++ b/build/integration/features/bootstrap/CollaborationContext.php @@ -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'; @@ -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); + } } diff --git a/build/integration/features/bootstrap/Provisioning.php b/build/integration/features/bootstrap/Provisioning.php index e51339c081e02..1b01a636918aa 100644 --- a/build/integration/features/bootstrap/Provisioning.php +++ b/build/integration/features/bootstrap/Provisioning.php @@ -13,6 +13,7 @@ * @author Sergio Bertolín * @author Thomas Müller * @author Vincent Petry + * @author Jonas Meurer * * @license GNU AGPL version 3 or any later version *