Skip to content

Commit 3b8ab7f

Browse files
committed
review feedback
1 parent 0b24296 commit 3b8ab7f

File tree

2 files changed

+32
-23
lines changed

2 files changed

+32
-23
lines changed

CONTRIBUTION.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,8 +165,14 @@ To make your contribution, follow these steps:
165165
6. The pull request will be reviewed by the repo maintainers. If you need to make further changes, make additional commits to keep commit history. When the PR is merged, commits will be squashed.
166166

167167
> [!TIP]
168-
> Separate bigger changes into multiple smaller PRs. You will get earlier feedback, and it's easier for us to review your PR.
169-
> If you already want feedback during the implementation process, feel free to create a draft PR, so that we can have a look.
168+
>
169+
> To ensure smooth review and integration of your code contributions, follow these guidelines:
170+
>
171+
> **Break down large changes into smaller PRs**: Separate new feature or bigger changes into multiple smaller Pull Requests.
172+
> This allows us to provide earlier feedback and makes it easier to review your PR.
173+
>
174+
> **Create a draft PR for early feedback**: If you want feedback during the implementation process, create a draft PR so we can have a look.
175+
170176

171177
## Bug Reports
172178

README.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -222,23 +222,13 @@ Terraform acceptance tests are run using the command `make test-acceptance-tf`.
222222

223223
Additionally:
224224

225-
- For the authorization service:
226-
- The env var `TF_ACC_ORGANIZATION_ID` must be set with ID of the STACKIT test organization to test it.
227-
- The env var `TF_ACC_TEST_PROJECT_SERVICE_ACCOUNT_EMAIL` must be set as the email of the service account
228-
229-
- For the iaas service:
230-
- The env var `TF_ACC_ORGANIZATION_ID` must be set with ID of the STACKIT test organization to test it.
231-
232-
- For the serverbackup and serverupdate service:
233-
- The env var `TF_ACC_SERVER_ID` must be set with the ID of a Server within `TF_ACC_PROJECT_ID` with enabled STACKIT Server Agent
234-
235-
- For the Resource Manager service:
236-
- A service account with permissions to create and delete projects is required
237-
- The env var `TF_ACC_TEST_PROJECT_SERVICE_ACCOUNT_EMAIL` must be set as the email of the service account
238-
- The env var `TF_ACC_TEST_PROJECT_SERVICE_ACCOUNT_TOKEN` must be set as a valid token of the service account. Can also be set in the credentials file used by authentication (see [Authentication](#authentication) for more details)
239-
- The env var `TF_ACC_TEST_PROJECT_PARENT_CONTAINER_ID` must be set as a valid project parent container id under which projects and folders will be created. A folder within an organization or the organization itself.
240-
- The env var `TF_ACC_TEST_PROJECT_PARENT_UUID` must be set as a valid project parent uuid under which projects and folders will be created. A folder within an organization or the organization itself.
241-
- The env var `TF_ACC_PROJECT_ID` is ignored
225+
| Env var | Value | Example value | needed for Acc tests of the following services |
226+
|---------------------------------------------|---------------------------------------------------------------------------------------------------------|----------------------------------------|------------------------------------------------|
227+
| `TF_ACC_ORGANIZATION_ID` | ID of the STACKIT test organization | `5353ccfa-a984-4b96-a71d-b863dd2b7087` | `authorization`, `iaas` |
228+
| `TF_ACC_TEST_PROJECT_SERVICE_ACCOUNT_EMAIL` | Email of the STACKIT service account | `[email protected]` | `authorization`, `resourcemanager` |
229+
| `TF_ACC_SERVER_ID` | ID of a STACKIT Server with STACKIT Server Agent enabled | `5353ccfa-a984-4b96-a71d-b863dd2b7087` | `serverbackup`, `serverupdate` |
230+
| `TF_ACC_TEST_PROJECT_PARENT_CONTAINER_ID` | Container ID of the project parent container (folder within an organization or the organization itself) | `organization-d2b7087` | `resourcemanager` |
231+
| `TF_ACC_TEST_PROJECT_PARENT_UUID` | UUID ID of the project parent container (folder within an organization or the organization itself) | `5353ccfa-a984-4b96-a71d-b863dd2b7087` | `resourcemanager` |
242232

243233
### Run Acceptance Tests of a single service
244234

@@ -252,10 +242,23 @@ Set the env var `TF_ACC=1`, to enable the acceptance tests.
252242

253243
Start the acceptance tests:
254244

255-
```sh
256-
$ go test -timeout=60m -v stackit/internal/services/<service>/<service>_acc_test.go
257-
```
258-
or
245+
1. Configure your env vars in a file, e.g.
246+
```sh
247+
# acc-tests.env
248+
export TF_ACC="1"
249+
export TF_ACC_REGION="eu01"
250+
...
251+
```
252+
2. Read the env vars from the file
253+
```sh
254+
source acc-tests.env
255+
```
256+
3. Start the acceptance tests
257+
```sh
258+
$ go test -timeout=60m -v stackit/internal/services/<service>/<service>_acc_test.go
259+
```
260+
261+
Alternative, set your env vars inline and start the acceptance test:
259262
```sh
260263
$ TF_ACC=1 \
261264
TF_ACC_PROJECT_ID=<PROJECT_ID> \

0 commit comments

Comments
 (0)