From d39c58e5e24249cbe27018155e488548cfc01001 Mon Sep 17 00:00:00 2001 From: Hugh Cole-Baker Date: Tue, 7 Nov 2023 15:33:13 +0000 Subject: [PATCH] docs: document other env vars for make test-acc Fully running the acceptance tests uses more than just a project, there are tests which interact with accounts and orgs, so we should probably document how to get them to run here. --- CHANGELOG.md | 1 + CONTRIBUTING.md | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index aac8e1de9..bc545371d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ nav_order: 1 - Migrate `aiven_service_integration` to the Plugin Framework - Deprecating `project_user`, `account_team` and `account_team_member` resources +- Improve contributing documentation on running acceptance tests. ## [4.9.1] - 2023-10-03 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 061be8806..2c07f49c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,11 +31,15 @@ Run the tests with the command below: make test ``` +Acceptance tests interact with the real Aiven API and require an API token and existing project, account and organization on Aiven to create resources in. A non-default API URL can be used by setting the `AIVEN_WEB_URL` environment variable to e.g. `https://your.custom.api:443`. + Run the acceptance tests with the commands below: ```bash export AIVEN_TOKEN="your-token" export AIVEN_PROJECT_NAME="your-project-name" +export AIVEN_ACCOUNT_NAME="your-existing-account-name" +export AIVEN_ORGANIZATION_NAME="your-existing-org-name" # run all acceptance tests make test-acc