integration_openproject/testplan.md

## Installation

### Prerequisites

- fresh NextCloud, without any previous history of having the app installed

### Run tests as

1. main admin user
2. newly created user that is member of the "admin" group

### Tests

| steps                                                  | expected outcome                     | result | comment |
|--------------------------------------------------------|--------------------------------------|--------|---------|
| install app from marketplace                           | app installs without error messages  |        |         |
| install old version of the app, upgrade to new version | upgrade works without error messages |        |         |
| enable the app using `occ` command                     | app is listed as enabled             |        |         |
| disable the app using `occ` command                    | app is listed as disabled            |        |         |
| enable the app using the WebUI                         | app is listed as enabled             |        |         |
| disable the app using the WebUI                        | app is listed as disabled            |        |         |

## Configuration
### Before configuring the app

#### Prerequisites

- fresh NextCloud, without any previous history of having the app installed
- install, but don't configure OpenProject Integration app

### Run tests as

1. main admin user
2. newly created user that is member of the "admin" group

#### Tests

| steps                               | expected outcome                                                            | result | comment |
|-------------------------------------|-----------------------------------------------------------------------------|--------|---------|
| check dashboard                     | good error message shown                                                    |        |         |
| check OpenProject sidebar of a file | good error message shown                                                    |        |         |
| check administrators settings       | OpenProject section shown, only OpenProject host can be entered             |        |         |
| check personal settings             | OpenProject section in 'Connected accounts' shown, good error message shown |        |         |

### Configuration as admin without project folders
#### Prerequisites

- NextCloud installed
- OpenProject Integration app installed
- OpenProject Integration app enabled

### Run tests as

1. main admin user
2. newly created user that is member of the "admin" group

#### Tests

| steps                                                                            | expected outcome                                                                               | result | comment |
|----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|--------|---------|
| enter invalid URL as OpenProject host                                            | good error message shown, setting not saved, next step not enabled                             |        |         |
| enter valid URL, that does not have an OpenProject listening as OpenProject host | good error message shown, setting not saved, next step not enabled                             |        |         |
| enter valid and correct OpenProject host                                         | no error message shown, setting saved, next step enabled                                       |        |         |
| enter only client Id                                                             | settings cannot be saved                                                                       |        |         |
| enter also client secret                                                         | settings can be saved, NextCloud OAuth settings are generated and shown                        |        |         |
| copy the credentials                                                             | Project folders settings is displayed, the toggle button is enabled                            |        |         |
| disable the automatically managed folders and continue                           | Project folders settings should be disabled and a button to edit the setup should be displayed |        |         |


### Configuration as admin with project folders
#### Prerequisites

- NextCloud installed
- OpenProject Integration app installed
- OpenProject Integration app enabled
- Groupfolders app installed
- Groupfolders app enabled

### Run tests as

1. main admin user
2. newly created user that is member of the "admin" group

#### Tests

| steps                                                                            | expected outcome                                                        | result | comment |
|----------------------------------------------------------------------------------|-------------------------------------------------------------------------|--------|---------|
| enter invalid URL as OpenProject host                                            | good error message shown, setting not saved, next step not enabled      |        |         |
| enter valid URL, that does not have an OpenProject listening as OpenProject host | good error message shown, setting not saved, next step not enabled      |        |         |
| enter valid and correct OpenProject host                                         | no error message shown, setting saved, next step enabled                |        |         |
| enter only client Id                                                             | settings cannot be saved                                                |        |         |
| enter also client secret                                                         | settings can be saved, NextCloud OAuth settings are generated and shown |        |         |
| copy the credentials                                                             | project folders settings is enabled, the toggle button is enabled       |        |         |
| setup the project folders                                                        | no error message shown, application password is generated and shown     |        |         |

### Connecting as user
#### Prerequisites

- NextCloud installed 
- OpenProject Integration app installed
- OpenProject Integration app enabled
- OpenProject Integration app configured as administrator

### Run tests as
1. normal user

#### Tests

| steps                                                                         | expected outcome                                                                                                                                | result | comment |
|-------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|--------|---------|
| check dashboard                                                               | button to connect to OpenProject shown                                                                                                          |        |         |
| check OpenProject sidebar of a file                                           | button to connect to OpenProject shown                                                                                                          |        |         |
| check personal settings                                                       | button to connect to OpenProject shown                                                                                                          |        |         |
| if connected, disconnect from OP, connect to OP through the file sidebar      | oauth connection process successful, message shown that connection was established, after connection redirected to the sidebar of the same file |        |         |
| if connected, disconnect from OP, connect to OP through the dashboard         | oauth connection process successful, message shown that connection was established, after connection redirected to dashboard                    |        |         |
| if connected, disconnect from OP, connect to OP through the personal settings | oauth connection process successful, message shown that connection was established, after connection redirected to settings page                |        |         |
| connect to OP, check personal settings                                        | button to disconnect from OpenProject shown                                                                                                     |        |         |
| connect to OP, check dashboard                                                | notifications listed, or message that there are no notifications                                                                                |        |         |
| connect to OP, check file sidebar of a file                                   | message saying that no workpackages are linked yet                                                                                              |        |         |

### Edit configuration as admin
#### Prerequisites

- NextCloud installed
- OpenProject Integration app installed
- OpenProject Integration app enabled
- OpenProject Integration app configured as administrator
- multiple NC users connected to OpenProject
- Groupfolders app installed
- Groupfolders app enabled

### Run tests as

1. main admin user
2. newly created user that is member of the "admin" group

#### Tests

| steps                  | expected outcome                                                                                              | result | comment |
|------------------------|---------------------------------------------------------------------------------------------------------------|--------|---------|
| edit OP host           | OAuth client can still be used from OP side if OP is reachable by the new URL                                 |        |         |
| edit OP OAuth settings | warning shown, on confirmation all NC users disconnected from OP                                              |        |         |
| reset NC OAuth client  | warning shown, on confirmation, old OAuth client deleted and new NC OAuth client created (check in OAuth app) |        |         | 
| edit app password      | warning shown, on confirmation a new app password is generated                                                |        |         | 

## Usage

### Prerequisites

- NextCloud installed
- OpenProject Integration app installed
- OpenProject Integration app enabled
- OpenProject Integration app configured as administrator
- multiple NC users connected to OpenProject

### Run tests as
1. normal user

### Dashboard

#### Tests

| steps                                                                    | expected outcome                                                                                       | result | comment |
|--------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|--------|---------|
| generate some notifications in OP, display the OP dashboard in NC        | all OP notifications listed (not aggregated), every item links to the corresponding notification in OP |        |         |
| generate more than 6 notifications in OP, display the OP dashboard in NC | 6 OP notifications listed and a link to the OP notification center                                     |        |         |
| mark all notifications in OP as read, display the OP dashboard in NC     | no OP notifications listed but a good message saying that there are no notifications                   |        |         |

variations: check different NC themes

### Files

#### Tests

| steps                                                                            | expected outcome                                 | result | comment |
|----------------------------------------------------------------------------------|--------------------------------------------------|--------|---------|
| search for a WP                                                                  | WP that fit the search and only those are listed |        |         |
| link a WP to a file                                                              | WP displayed in list                             |        |         |
| link multiple WP to a file                                                       | WP listed correctly                              |        |         |
| link multiple WP to a file, go to an other file, come back to the original file  | WP listed correctly                              |        |         |
| link multiple WP to a file, delete some WP                                       | WP listed correctly                              |        |         |
| link multiple WP to a file, search for similar WP like the listed ones           | connected WP are not listed in the search        |        |         |

### Search

### Prerequisites

- enable unified search in "OpenProject Integration" section of "Connected accounts"

| steps                                                      | expected outcome                             | result | comment |
|------------------------------------------------------------|----------------------------------------------|--------|---------|
| search for WP in NC unified search                         | related WP are listed in the search results  |        |         |
| search for WP in NC unified search, click on one of the WP | link takes user to the WP details view in OP |        |         |
OP#42726 manual testplan (#133) 2022-06-22 12:26:04 +03:00			`## Installation`

			`### Prerequisites`

			`- fresh NextCloud, without any previous history of having the app installed`

			`### Run tests as`

			`1. main admin user`
			`2. newly created user that is member of the "admin" group`

			`### Tests`

			`\| steps \| expected outcome \| result \| comment \|`
			`\|--------------------------------------------------------\|--------------------------------------\|--------\|---------\|`
			`\| install app from marketplace \| app installs without error messages \| \| \|`
			`\| install old version of the app, upgrade to new version \| upgrade works without error messages \| \| \|`
			\| enable the app using `occ` command \| app is listed as enabled \| \| \|
			\| disable the app using `occ` command \| app is listed as disabled \| \| \|
			`\| enable the app using the WebUI \| app is listed as enabled \| \| \|`
			`\| disable the app using the WebUI \| app is listed as disabled \| \| \|`

			`## Configuration`
			`### Before configuring the app`

			`#### Prerequisites`

			`- fresh NextCloud, without any previous history of having the app installed`
Refactor the name of the project to follow uppar camel case (#434) Signed-off-by: Swikriti Tripathi <swikriti808@gmail.com> 2023-07-12 06:52:35 +03:00			`- install, but don't configure OpenProject Integration app`
OP#42726 manual testplan (#133) 2022-06-22 12:26:04 +03:00
			`### Run tests as`

			`1. main admin user`
			`2. newly created user that is member of the "admin" group`

			`#### Tests`

			`\| steps \| expected outcome \| result \| comment \|`
			`\|-------------------------------------\|-----------------------------------------------------------------------------\|--------\|---------\|`
			`\| check dashboard \| good error message shown \| \| \|`
			`\| check OpenProject sidebar of a file \| good error message shown \| \| \|`
			`\| check administrators settings \| OpenProject section shown, only OpenProject host can be entered \| \| \|`
			`\| check personal settings \| OpenProject section in 'Connected accounts' shown, good error message shown \| \| \|`

Update manual test plan (#449) Signed-off-by: Swikriti Tripathi <swikriti808@gmail.com> 2023-08-07 09:44:57 +03:00			`### Configuration as admin without project folders`
OP#42726 manual testplan (#133) 2022-06-22 12:26:04 +03:00			`#### Prerequisites`

			`- NextCloud installed`
Refactor the name of the project to follow uppar camel case (#434) Signed-off-by: Swikriti Tripathi <swikriti808@gmail.com> 2023-07-12 06:52:35 +03:00			`- OpenProject Integration app installed`
			`- OpenProject Integration app enabled`
OP#42726 manual testplan (#133) 2022-06-22 12:26:04 +03:00
			`### Run tests as`

			`1. main admin user`
			`2. newly created user that is member of the "admin" group`

			`#### Tests`

Update manual test plan (#449) Signed-off-by: Swikriti Tripathi <swikriti808@gmail.com> 2023-08-07 09:44:57 +03:00			`\| steps \| expected outcome \| result \| comment \|`
			`\|----------------------------------------------------------------------------------\|------------------------------------------------------------------------------------------------\|--------\|---------\|`
			`\| enter invalid URL as OpenProject host \| good error message shown, setting not saved, next step not enabled \| \| \|`
			`\| enter valid URL, that does not have an OpenProject listening as OpenProject host \| good error message shown, setting not saved, next step not enabled \| \| \|`
			`\| enter valid and correct OpenProject host \| no error message shown, setting saved, next step enabled \| \| \|`
			`\| enter only client Id \| settings cannot be saved \| \| \|`
			`\| enter also client secret \| settings can be saved, NextCloud OAuth settings are generated and shown \| \| \|`
			`\| copy the credentials \| Project folders settings is displayed, the toggle button is enabled \| \| \|`
			`\| disable the automatically managed folders and continue \| Project folders settings should be disabled and a button to edit the setup should be displayed \| \| \|`


			`### Configuration as admin with project folders`
			`#### Prerequisites`

			`- NextCloud installed`
			`- OpenProject Integration app installed`
			`- OpenProject Integration app enabled`
			`- Groupfolders app installed`
			`- Groupfolders app enabled`

			`### Run tests as`

			`1. main admin user`
			`2. newly created user that is member of the "admin" group`

			`#### Tests`

OP#42726 manual testplan (#133) 2022-06-22 12:26:04 +03:00			`\| steps \| expected outcome \| result \| comment \|`
			`\|----------------------------------------------------------------------------------\|-------------------------------------------------------------------------\|--------\|---------\|`
			`\| enter invalid URL as OpenProject host \| good error message shown, setting not saved, next step not enabled \| \| \|`
			`\| enter valid URL, that does not have an OpenProject listening as OpenProject host \| good error message shown, setting not saved, next step not enabled \| \| \|`
			`\| enter valid and correct OpenProject host \| no error message shown, setting saved, next step enabled \| \| \|`
			`\| enter only client Id \| settings cannot be saved \| \| \|`
			`\| enter also client secret \| settings can be saved, NextCloud OAuth settings are generated and shown \| \| \|`
Update manual test plan (#449) Signed-off-by: Swikriti Tripathi <swikriti808@gmail.com> 2023-08-07 09:44:57 +03:00			`\| copy the credentials \| project folders settings is enabled, the toggle button is enabled \| \| \|`
			`\| setup the project folders \| no error message shown, application password is generated and shown \| \| \|`
OP#42726 manual testplan (#133) 2022-06-22 12:26:04 +03:00
			`### Connecting as user`
			`#### Prerequisites`

Update manual test plan (#449) Signed-off-by: Swikriti Tripathi <swikriti808@gmail.com> 2023-08-07 09:44:57 +03:00			`- NextCloud installed`
Refactor the name of the project to follow uppar camel case (#434) Signed-off-by: Swikriti Tripathi <swikriti808@gmail.com> 2023-07-12 06:52:35 +03:00			`- OpenProject Integration app installed`
			`- OpenProject Integration app enabled`
			`- OpenProject Integration app configured as administrator`
OP#42726 manual testplan (#133) 2022-06-22 12:26:04 +03:00
			`### Run tests as`
			`1. normal user`

			`#### Tests`

			`\| steps \| expected outcome \| result \| comment \|`
			`\|-------------------------------------------------------------------------------\|-------------------------------------------------------------------------------------------------------------------------------------------------\|--------\|---------\|`
			`\| check dashboard \| button to connect to OpenProject shown \| \| \|`
			`\| check OpenProject sidebar of a file \| button to connect to OpenProject shown \| \| \|`
			`\| check personal settings \| button to connect to OpenProject shown \| \| \|`
			`\| if connected, disconnect from OP, connect to OP through the file sidebar \| oauth connection process successful, message shown that connection was established, after connection redirected to the sidebar of the same file \| \| \|`
			`\| if connected, disconnect from OP, connect to OP through the dashboard \| oauth connection process successful, message shown that connection was established, after connection redirected to dashboard \| \| \|`
			`\| if connected, disconnect from OP, connect to OP through the personal settings \| oauth connection process successful, message shown that connection was established, after connection redirected to settings page \| \| \|`
			`\| connect to OP, check personal settings \| button to disconnect from OpenProject shown \| \| \|`
			`\| connect to OP, check dashboard \| notifications listed, or message that there are no notifications \| \| \|`
			`\| connect to OP, check file sidebar of a file \| message saying that no workpackages are linked yet \| \| \|`

			`### Edit configuration as admin`
			`#### Prerequisites`

			`- NextCloud installed`
Refactor the name of the project to follow uppar camel case (#434) Signed-off-by: Swikriti Tripathi <swikriti808@gmail.com> 2023-07-12 06:52:35 +03:00			`- OpenProject Integration app installed`
			`- OpenProject Integration app enabled`
			`- OpenProject Integration app configured as administrator`
OP#42726 manual testplan (#133) 2022-06-22 12:26:04 +03:00			`- multiple NC users connected to OpenProject`
Update manual test plan (#449) Signed-off-by: Swikriti Tripathi <swikriti808@gmail.com> 2023-08-07 09:44:57 +03:00			`- Groupfolders app installed`
			`- Groupfolders app enabled`
OP#42726 manual testplan (#133) 2022-06-22 12:26:04 +03:00
			`### Run tests as`

			`1. main admin user`
			`2. newly created user that is member of the "admin" group`

			`#### Tests`

			`\| steps \| expected outcome \| result \| comment \|`
			`\|------------------------\|---------------------------------------------------------------------------------------------------------------\|--------\|---------\|`
			`\| edit OP host \| OAuth client can still be used from OP side if OP is reachable by the new URL \| \| \|`
Update manual test plan (#449) Signed-off-by: Swikriti Tripathi <swikriti808@gmail.com> 2023-08-07 09:44:57 +03:00			`\| edit OP OAuth settings \| warning shown, on confirmation all NC users disconnected from OP \| \| \|`
OP#42726 manual testplan (#133) 2022-06-22 12:26:04 +03:00			`\| reset NC OAuth client \| warning shown, on confirmation, old OAuth client deleted and new NC OAuth client created (check in OAuth app) \| \| \|`
Update manual test plan (#449) Signed-off-by: Swikriti Tripathi <swikriti808@gmail.com> 2023-08-07 09:44:57 +03:00			`\| edit app password \| warning shown, on confirmation a new app password is generated \| \| \|`
OP#42726 manual testplan (#133) 2022-06-22 12:26:04 +03:00
			`## Usage`

			`### Prerequisites`

			`- NextCloud installed`
Refactor the name of the project to follow uppar camel case (#434) Signed-off-by: Swikriti Tripathi <swikriti808@gmail.com> 2023-07-12 06:52:35 +03:00			`- OpenProject Integration app installed`
			`- OpenProject Integration app enabled`
			`- OpenProject Integration app configured as administrator`
OP#42726 manual testplan (#133) 2022-06-22 12:26:04 +03:00			`- multiple NC users connected to OpenProject`

			`### Run tests as`
			`1. normal user`

			`### Dashboard`

			`#### Tests`

			`\| steps \| expected outcome \| result \| comment \|`
			`\|--------------------------------------------------------------------------\|--------------------------------------------------------------------------------------------------------\|--------\|---------\|`
			`\| generate some notifications in OP, display the OP dashboard in NC \| all OP notifications listed (not aggregated), every item links to the corresponding notification in OP \| \| \|`
			`\| generate more than 6 notifications in OP, display the OP dashboard in NC \| 6 OP notifications listed and a link to the OP notification center \| \| \|`
			`\| mark all notifications in OP as read, display the OP dashboard in NC \| no OP notifications listed but a good message saying that there are no notifications \| \| \|`

			`variations: check different NC themes`

			`### Files`

			`#### Tests`

			`\| steps \| expected outcome \| result \| comment \|`
			`\|----------------------------------------------------------------------------------\|--------------------------------------------------\|--------\|---------\|`
			`\| search for a WP \| WP that fit the search and only those are listed \| \| \|`
			`\| link a WP to a file \| WP displayed in list \| \| \|`
			`\| link multiple WP to a file \| WP listed correctly \| \| \|`
			`\| link multiple WP to a file, go to an other file, come back to the original file \| WP listed correctly \| \| \|`
			`\| link multiple WP to a file, delete some WP \| WP listed correctly \| \| \|`
			`\| link multiple WP to a file, search for similar WP like the listed ones \| connected WP are not listed in the search \| \| \|`

			`### Search`

			`### Prerequisites`

Refactor the name of the project to follow uppar camel case (#434) Signed-off-by: Swikriti Tripathi <swikriti808@gmail.com> 2023-07-12 06:52:35 +03:00			`- enable unified search in "OpenProject Integration" section of "Connected accounts"`
OP#42726 manual testplan (#133) 2022-06-22 12:26:04 +03:00
			`\| steps \| expected outcome \| result \| comment \|`
			`\|------------------------------------------------------------\|----------------------------------------------\|--------\|---------\|`
			`\| search for WP in NC unified search \| related WP are listed in the search results \| \| \|`
			`\| search for WP in NC unified search, click on one of the WP \| link takes user to the WP details view in OP \| \| \|`