Skip to content

Commit

Permalink
docs: document other env vars for make test-acc
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
sigmaris authored and Serpentiel committed Nov 8, 2023
1 parent e47b5b5 commit f323637
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 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_ORGANIZATION_NAME="your-existing-org-name"
export AIVEN_ACCOUNT_NAME="$AIVEN_ORGANIZATION_NAME"

# run all acceptance tests
make test-acc
Expand Down

0 comments on commit f323637

Please sign in to comment.