mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-01-02 18:30:14 -06:00
Code Issues Packages Projects Releases Wiki Activity

[test-only]ApiTest. Deprovisioning notification tests (#6994)

Browse Source 
* add create/delete notification tests

* fix grammar

---------

Co-authored-by: Swikriti Tripathi <swikriti808@gmail.com>
This commit is contained in:
Viktor Scharf
2023-08-14 09:16:04 +02:00
committed by GitHub
parent 806e0d09db
commit 0258b2bfff
2 changed files with 254 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

171
tests/acceptance/features/apiNotification/deprovisioningNotification.feature Normal file
View File

@@ -0,0 +1,171 @@
Feature: Deprovisioning notification
As a user admin
I want to inform users about shutting down and deprovisioning the instance
So they can download and save their data in time
Background:
Given these users have been created with default attributes and without skeleton files:
| username |
| Alice |
Scenario: administrator creates a deprovisioning notification about shutting down the instance
When the administrator creates a deprovisioning notification
Then the HTTP status code should be "200"
When user "Alice" lists all notifications
Then the HTTP status code should be "200"
And the JSON response should contain a notification message with the subject "Instance will be shut down and deprovisioned" and the message-details should match
"""
{
"type": "object",
"required": [
"app",
"datetime",
"message",
"messageRich",
"messageRichParameters",
"notification_id",
"object_id",
"object_type",
"subject",
"subjectRich",
"user"
],
"properties": {
"app": {
"type": "string",
"enum": [
"userlog"
]
},
"message": {
"type": "string",
"enum": [
"Attention! The instance will be shut down and deprovisioned on 2043-07-04T11:23:12Z. Download all your data before that date as no access past that date is possible."
]
},
"messageRich": {
"type": "string",
"enum": [
"Attention! The instance will be shut down and deprovisioned on {date}. Download all your data before that date as no access past that date is possible."
]
},
"messageRichParameters": {
"type": "object"
},
"notification_id": {
"type": "string",
"enum": [
"deprovision"
]
},
"object_id": {
"type": "string"
},
"object_type": {
"type": "string",
"enum": [
"resource"
]
},
"subject": {
"type": "string",
"enum": [
"Instance will be shut down and deprovisioned"
]
},
"subjectRich": {
"type": "string",
"enum": [
"Instance will be shut down and deprovisioned"
]
},
"user": {
"type": "string"
}
}
}
"""
Scenario Outline: non-admin user tries to create a deprovisioning notification
Given the administrator has assigned the role "<role>" to user "Alice" using the Graph API
When user "Alice" tries to create a deprovisioning notification
Then the HTTP status code should be "404"
And user "Alice" should not have any notification
Examples:
| role |
| Space Admin |
| User |
| User Light |
Scenario Outline: get a deprovisioning notification in various languages
Given the administrator has created a deprovisioning notification
And user "Alice" has switched the system language to "<language>"
When user "Alice" lists all notifications
Then the HTTP status code should be "200"
And the JSON response should contain a notification message with the subject "<subject>" and the message-details should match
"""
{
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string",
"enum": [
"<message>"
]
}
}
}
"""
Examples:
| language | subject | message |
| de | Instanz wird heruntergefahren und außer Betrieb genommen werden. | Achtung! Diese Instanz wird am 2043-07-04T11:23:12Z heruntergefahren und außer Betrieb genommen werden. Laden Sie Ihre Daten vor diesem Tag herunter, da Sie danach nicht mehr darauf zugreifen können. |
| es | La instancia se cerrará y se desaprovisionará | ¡Atención! La instancia se cerrará y se desaprovisionará el 2043-07-04T11:23:12Z. Descarga todos tus datos antes de esa fecha, puesto que el acceso pasada la fecha no será posible. |
Scenario: deprovisioning notification reappears again even after being marked as read
Given the administrator has created a deprovisioning notification
And user "Alice" has deleted all notifications
When user "Alice" lists all notifications
Then the HTTP status code should be "200"
And the JSON response should contain a notification message with the subject "Instance will be shut down and deprovisioned" and the message-details should match
"""
{
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string",
"enum": [
"Attention! The instance will be shut down and deprovisioned on 2043-07-04T11:23:12Z. Download all your data before that date as no access past that date is possible."
]
}
}
}
"""
Scenario: administrator tries to delete the deprovisioning notification
Given the administrator has created a deprovisioning notification
When the administrator deletes the deprovisioning notification
Then the HTTP status code should be "200"
And user "Alice" should not have any notification
Scenario Outline: non-admin user tries to delete the deprovisioning notification
Given the administrator has assigned the role "<role>" to user "Alice" using the Graph API
When user "Alice" tries to delete the deprovisioning notification
Then the HTTP status code should be "404"
And user "Alice" should not have any notification
Examples:
| role |
| Space Admin |
| User |
| User Light |

83
tests/acceptance/features/bootstrap/NotificationContext.php
View File

@@ -27,6 +27,7 @@ class NotificationContext implements Context {
private SpacesContext $spacesContext;
private SettingsContext $settingsContext;
private string $notificationEndpointPath = '/apps/notifications/api/v1/notifications?format=json';
private string $globalNotificationEndpointPath = '/apps/notifications/api/v1/notifications/global';
private array $notificationIds;
@@ -44,6 +45,15 @@ class NotificationContext implements Context {
return \end($this->notificationIds);
}
/**
* @AfterScenario
*
* @return void
*/
public function deleteDeprovisioningNotification(): void {
$this->userDeletesDeprovisioningNotification();
}
/**
* @var string
*/
@@ -127,6 +137,20 @@ class NotificationContext implements Context {
$this->featureContext->setResponse($this->userDeletesNotification($user));
}
/**
* @Given user :user has deleted all notifications
*
* @param string $user
*
* @return void
* @throws GuzzleException
* @throws JsonException
*/
public function userHasDeletedAllNotifications(string $user):void {
$this->userDeletesAllNotifications($user);
$this->featureContext->thenTheHTTPStatusCodeShouldBe(200);
}
/**
* @When user :user deletes a notification related to resource :resource with subject :subject
*
@@ -490,4 +514,63 @@ class NotificationContext implements Context {
$e->getMessage();
}
}
/**
* @When the administrator creates a deprovisioning notification
* @When user :user tries to create a deprovisioning notification
*
* @param string|null $user
*
* @return void
*/
public function userCreatesDeprovisioningNotification(?string $user = null):void {
$payload["type"] = "deprovision";
$payload["data"] = ["deprovision_date" => "2043-07-04T11:23:12Z"];
$response = OcsApiHelper::sendRequest(
$this->featureContext->getBaseUrl(),
$user ? $this->featureContext->getActualUsername($user) : $this->featureContext->getAdminUsername(),
$user ? $this->featureContext->getPasswordForUser($user) : $this->featureContext->getAdminPassword(),
'POST',
$this->globalNotificationEndpointPath,
'',
json_encode($payload),
2
);
$this->featureContext->setResponse($response);
}
/**
* @Given the administrator has created a deprovisioning notification
*
* @return void
*/
public function userHasCreatedDeprovisioningNotification():void {
$this->userCreatesDeprovisioningNotification();
$this->featureContext->thenTheHTTPStatusCodeShouldBe(200);
}
/**
* @When the administrator deletes the deprovisioning notification
* @When user :user tries to delete the deprovisioning notification
*
* @param string|null $user
*
* @return void
*/
public function userDeletesDeprovisioningNotification(?string $user = null):void {
$payload["ids"] = ["deprovision"];
$response = OcsApiHelper::sendRequest(
$this->featureContext->getBaseUrl(),
$user ? $this->featureContext->getActualUsername($user) : $this->featureContext->getAdminUsername(),
$user ? $this->featureContext->getPasswordForUser($user) : $this->featureContext->getAdminPassword(),
'DELETE',
$this->globalNotificationEndpointPath,
'',
json_encode($payload),
2
);
$this->featureContext->setResponse($response);
}
}