Skip to content

Commit da1a228

Browse files
committed
docs: addresses review of copilot
Signed-off-by: nabim777 <nabinalemagar019@gmail.com>
1 parent 2bb1e85 commit da1a228

1 file changed

Lines changed: 27 additions & 27 deletions

File tree

docs/testing/smoke_testing.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The need for this smoke testing (manual) is that we do not have e2e test setup t
2121
- [4. Create a WorkPackage from Nextcloud](#4-create-a-workpackage-from-nextcloud)
2222
- [5. Check notification in `OpenProject` widget in Nextcloud](#5-check-notification-in-openproject-widget-in-nextcloud)
2323
- [6. Setup and check project folder in Nextcloud (with project folder setup)](#6-setup-and-check-project-folder-in-nextcloud-with-project-folder-setup)
24-
- [7. Check New folder with automatically managed permissions in OpenProject](#7-check-new-folder-with-automatically-managed-permissions-in-openproject)
24+
- [7. Setup and Check New folder with automatically managed permissions in OpenProject](#7-setup-and-check-new-folder-with-automatically-managed-permissions-in-openproject)
2525

2626
- [App Upgrade Testing](#app-upgrade-testing)
2727
- [Upgrade Steps](#upgrade-steps)
@@ -37,7 +37,7 @@ The need for this smoke testing (manual) is that we do not have e2e test setup t
3737
### A1. Oauth configuration
3838
- [ ] Keep two browser tabs open: one for `OpenProject` and one for `Nextcloud`.
3939
- [ ] In `OpenProject`, as a user `admin`, navigate to `Administration > Files` and add a new `Nextcloud` storage:
40-
- Add name to `Nextcloud` and host to `<nextcloud_host>`.
40+
- Add name to `Nextcloud` and host to `<nextcloud-host>`.
4141
- Select `Two-way OAuth 2.0 authorization code flow` as the authentication method.
4242
- Click `Save and Continue` — note the generated `OpenProject OAuth Client ID` and `Client Secret`.
4343
- [ ] In `Nextcloud`, as a user `admin`, navigate to `Administration Settings > OpenProject`:
@@ -68,32 +68,32 @@ The need for this smoke testing (manual) is that we do not have e2e test setup t
6868

6969
### A4. Connect OpenProject with Nextcloud
7070
- [ ] Complete step [Test No A1](#a1-oauth-configuration).
71-
- [ ] Complete step [Test No A3](#A3-Add-File-storage-Nextcloud-to-an-OpenProject-project).
71+
- [ ] Complete step [Test No A3](#a3-add-file-storage-nextcloud-to-an-openproject-project).
7272
- [ ] As a user `admin`, navigate to `Demo Project > Work Packages` and open any work package by clicking its ID.
7373
- [ ] Navigate to `Files` tab, and login to `Nextcloud`.
7474
- [ ] `OpenProject` admin is connected to `Nextcloud` as a `Nextcloud` admin.
7575
- [ ] Add the created `OpenProject` user as the member of `Demo Project` project (admin can add members to a project).
76-
- [ ] Login as created user in both openproject and nextcloud.
76+
- [ ] Login as created user in both `Openproject` and `Nextcloud`.
7777
- [ ] Try to connect the created `OpenProject` user as created `Nextcloud` user.
7878
- [ ] `OpenProject` user should be connected as a `Nextcloud` user.
7979

8080
### A5. Complete the common smoke tests
8181
- [ ] Complete [smoke tests 1-7](#common-smoke-test-steps).
8282

83-
### A7. Check the integration script for oauth set up
83+
### A6. Check the integration script for oauth set up
8484

8585
> Before running the script, make sure that your `Nextcloud` and `OpenProject` instances are up and running.
8686
8787
- [ ] Run the `integration_setup.sh` script to set up integration without project folder with the following command:
8888
```bash
89-
SETUP_PROJECT_FOLDER=true \
89+
SETUP_PROJECT_FOLDER=false \
9090
NEXTCLOUD_HOST=<nextcloud_instance_url> \
9191
OPENPROJECT_HOST=<openproject_instance_url> \
9292
OP_ADMIN_USERNAME=admin \
93-
OP_ADMIN_PASSWORD=admin \
94-
NC_ADMIN_USERNAME=admin \
95-
NC_ADMIN_PASSWORD=admin \
96-
OPENPROJECT_STORAGE_NAME=Nextcloud \
93+
OP_ADMIN_PASSWORD=admin \
94+
NC_ADMIN_USERNAME=admin \
95+
NC_ADMIN_PASSWORD=admin \
96+
OPENPROJECT_STORAGE_NAME=Nextcloud \
9797
bash integration_setup.sh
9898
```
9999
- [ ] Upon success, try step [Test No A2](#A2-Connect-Nextcloud-with-OpenProject) (Skip first check).
@@ -112,11 +112,11 @@ bash integration_setup.sh
112112
- [ ] Install and enable `OIDC Identity Provider`(`oidc`) and `OpenID Connect user backend`(`user_oidc`) apps.
113113
- [ ] Create a new user( with username, display name, password, and email).
114114
- [ ] Check whether `oidc_provider_bearer_validation` exists and is set to `true` by running `php occ config:list`.
115-
> **Note:** This requires the OIDC Identity Provider app >= v1.4.0 . Access tokens and JWT tokens can be validated.
115+
> **Note:** This requires the OIDC Identity Provider app >= v1.4.0. Access tokens and JWT tokens can be validated.
116116
- [ ] If the setting does not exist or is set to `false`, run:
117117
- `php occ config:system:set user_oidc --type boolean --value="true" oidc_provider_bearer_validation`
118118
- [ ] Go to `Administration > OpenID Connect` and enable `store login tokens` option.
119-
- [ ] Go to `Administation > OpenID Connect Provider`.
119+
- [ ] Go to `Administration > OpenID Connect Provider`.
120120
- Click the button `+ Add client`.
121121
- Add a client name (not an identifier) such as `openproject`.
122122
- Add a redirect URL: `<openproject_host>/auth/oidc-<idp_displayname_from_openproject>/callback`.
@@ -142,14 +142,14 @@ bash integration_setup.sh
142142
- [ ] Create a file storage type `Nextcloud` by clicking the button `+ Storage` and choosing `Nextcloud`.
143143
- [ ] Add name it as `Nextcloud`.
144144
- [ ] Add Host as `<nextcloud-host>`.
145-
- [ ] Choose authentication Method option as `Single-Sign-On through OpenID Connect Identity Provider`.
145+
- [ ] Set authentication Method to `Single-Sign-On through OpenID Connect Identity Provider`.
146146
- [ ] Then, select the option `Use access token obtained during user log in`.
147147
- [ ] Uncheck project folder (automatically managed folder).
148148
- [ ] Click on button `Finish setup`.
149149

150150
#### B.1.3. Setup integration (Without project folder setup)
151-
- [ ] Complete step [Test No B.1.1](#B11-Configure-Nextcloud).
152-
- [ ] Complete step [Test No B.1.2](#B12-Add-Nextcloud-Idp-in-OpenProject).
151+
- [ ] Complete step [Test No B.1.1](#b11-configure-nextcloud).
152+
- [ ] Complete step [Test No B.1.2](#b12-Add-nextcloud-idp-in-openProject-without-project-folder-setup).
153153
- [ ] In `Nextcloud`, as a user `admin`, go to `Administration > OpenProject`.
154154
- [ ] Add openproject host.
155155
- [ ] Under `Authentication Method`, select `Single-Sign-On through OpenID Connect Identity Provider`.
@@ -159,7 +159,7 @@ bash integration_setup.sh
159159

160160
#### B.1.4. Login to OpenProject using Nextcloud user
161161
- [ ] Complete step [Test No B.1.1](#B11-Configure-Nextcloud).
162-
- [ ] Complete step [Test No B.1.2](#B12-Add-Nextcloud-Idp-in-OpenProject).
162+
- [ ] Complete step [Test No B.1.2](#b12-Add-nextcloud-idp-in-openProject-without-project-folder-setup).
163163
- [ ] Complete step [Test No B.1.3](#b13-Setup-integration-Without-project-folder-setup).
164164
- [ ] In `nextcloud`, login as nextcloud-created user.
165165
- [ ] In `openproject`, use the SSO button on the login page to sign in as the nextcloud-created user.
@@ -169,7 +169,7 @@ bash integration_setup.sh
169169

170170
#### B.1.5. Verify Connection of Nextcloud user with OpenProject
171171
- [ ] Complete step [Test No B.1.1](#B11-Configure-Nextcloud).
172-
- [ ] Complete step [Test No B.1.2](#B12-Add-Nextcloud-Idp-in-OpenProject).
172+
- [ ] Complete step [Test No B.1.2](#b12-Add-nextcloud-idp-in-openProject-without-project-folder-setup).
173173
- [ ] Complete step [Test No B.1.3](#b13-Setup-integration-Without-project-folder-setup).
174174
- [ ] Complete step [Test No B.1.4](#b14-Login-to-OpenProject-using-Nextcloud-user).
175175
- [ ] In nextcloud, login as nextcloud-created user.
@@ -210,34 +210,34 @@ bash integration_setup.sh
210210
- [ ] Create a file storage type `Nextcloud` by clicking the button `+ Storage` and choosing Nextcloud
211211
- [ ] Add name as `Nextcloud`.
212212
- [ ] Add Host as `<nextcloud-host>`
213-
- [ ] Choose authentication Method option as Single-Sign-On through OpenID Connect Identity Provider.
213+
- [ ] Set authentication method to `Single-Sign-On through OpenID Connect Identity Provider`.
214214
- [ ] Then, select the option `Use access token obtained during user log in`.
215215
- [ ] Uncheck project folder (automatically managed folder).
216216
- [ ] Click on button `Finish setup`.
217217
- [ ] Navigate to `Project settings > Files` of a project (for example, `Demo Project`) and add `Nextcloud` as a file storage.
218-
- [ ] If you are using [Docker setup](../../dev/), default `Keycloak` users already exist (`alice` and `brian`, password: `1234`), so you can skip the user-creation steps below and go directly to step [B.2.4](#b24-setup-integration-token-exchange-disabled-in-nexcloud).
218+
- [ ] If you are using [Docker setup](../../dev/), default `Keycloak` users already exist (`alice` and `brian`, password: `1234`), so you can skip the user-creation steps below and go directly to step [B.2.4](#b24-setup-integration-token-exchange-disabled-in-nextcloud).
219219
- [ ] In Keycloak, go to the user management section. For example, if your realm name is `opnc`, navigate to: `opnc > Users`.
220220
- [ ] Then create a user.
221221
- [ ] In `Openproject`, login as keycloak-created user.
222222
- [ ] In `OpenProject`, log out, then log in as a user `admin`.
223223
- [ ] As an `OpenProject` admin, add keycloak-created user as a member in one of the project (for example, `Demo Project`).
224224

225-
#### B.2.4. Setup integration (token exchange disabled) in Nexcloud
225+
#### B.2.4. Setup integration (token exchange disabled) in Nextcloud
226226
- [ ] As a user `admin`, go to `Administration > OpenProject`.
227227
- [ ] Under `Authentication Method`, select `Single-Sign-On through OpenID Connect Identity Provider`.
228228
- [ ] In `Authentication settings`, select `provider Type` as `Keycloak`.
229229
- [ ] Disable `token exchange`.
230230

231231
#### B.2.5. Verify Connection in nextcloud
232-
- [ ] first, Complete steps **B.2.1** to **B.2.4**.
232+
- [ ] First, complete steps **B.2.1** to **B.2.4**.
233233
- [ ] In nextcloud, login as keycloak-created user.
234234
- [ ] Navigate to `Settings > Openproject`.
235235
- [ ] Should show user is connected as an OpenProject user.
236236

237237
#### B.2.6. Complete the common smoke tests
238238
- [ ] Complete [smoke tests 1-7](#common-smoke-test-steps).
239239

240-
#### B.2.7.Setup integration (token exchange enabled)
240+
#### B.2.7. Setup integration (token exchange enabled)
241241
- [ ] Complete step [Test No B.2.1](#b21-Configure-Keycloak).
242242
- [ ] Complete step [Test No B.2.2](#b22-Configure-Nextcloud).
243243
- [ ] Complete step [Test No B.2.3](#b23-Add-Keycloak-IDP-in-OpenProject).
@@ -273,7 +273,7 @@ bash integration_setup.sh
273273
> To add the Nextcloud storage, delete the 'nextcloud' file storage from OpenProject, reset the Nextcloud config, and run the script again.
274274
275275
- [ ] Complete step [Test No B.1.1](#B11-Configure-Nextcloud) (only the first , second and thrid steps are required).
276-
- [ ] Complete step [Test No B.1.2](#B12-Add-Nextcloud-Idp-in-OpenProject) (only the first and second steps are required).
276+
- [ ] Complete step [Test No B.1.2](#b12-Add-nextcloud-idp-in-openProject-without-project-folder-setup) (only the first and second steps are required).
277277
- [ ] Run the `integration_oidc_setup.sh` script to set up integration without project folder with the following command:
278278

279279
```bash
@@ -369,7 +369,7 @@ bash integration_oidc_setup.sh
369369

370370
## Common Smoke Test Steps
371371

372-
### 1. Link/Unlink a work package for a file/folder in Openproject
372+
### 1. Link/Unlink a work package for a file/folder
373373
- [ ] Select a file, navigate to sidebar `OpenProject` tab.
374374
- [ ] Search for any of the work packages in the `Demo Project`.
375375
- [ ] Work packages are listed.
@@ -392,7 +392,7 @@ bash integration_oidc_setup.sh
392392
- [ ] Also Navigate to `Nextcloud` and see in the `OpenProject` tab for file (local.txt), the work package should be linked.
393393

394394
### 4. Create a WorkPackage from Nextcloud
395-
- [ ] In `Nextcloud`, select a file amd open the sidebar `OpenProject` tab.
395+
- [ ] In `Nextcloud`, select a file and open the sidebar `OpenProject` tab.
396396
- [ ] Click `Create and link new work package`.
397397
- [ ] Select `Demo Project`, fill up the modal form and create.
398398
- [ ] Work package should be created and linked to the selected file.
@@ -404,8 +404,8 @@ bash integration_oidc_setup.sh
404404
- [ ] Now as an `OpenProject` admin, assign any of the `Demo Project` work packages to the created `OpenProject` user.
405405
- [ ] The `Nextcloud` user should receive a notification regarding the assignment.
406406

407-
#### 6. Setup and check project folder in Nextcloud (with project folder setup)
408-
- [ ] Enable `teamfolders` application in `Nextcloud`.
407+
### 6. Setup and check project folder in Nextcloud (with project folder setup)
408+
- [ ] Enable the Nextcloud `groupfolders` app (`Team folders`) in `Nextcloud`.
409409
- [ ] Enable `Automatically managed folders` switch in admin setting and set project folder.
410410
- [ ] Application password should be generated (copy this password as this will be needed in the next step).
411411
- [ ] Verify that `OpenProject` user and `OpenProject` group are created with user `OpenProject` as sub-admin of the group.

0 commit comments

Comments
 (0)