1
0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00

DOCS: Warn against common integration test mistake (#2653)

This commit is contained in:
Tom Limoncelli
2023-11-27 18:04:48 -05:00
committed by GitHub
parent e783d7024c
commit b5010e7d9c
5 changed files with 8 additions and 4 deletions

View File

@ -252,7 +252,7 @@ in the source code.
To run the integration test with the BIND provider: To run the integration test with the BIND provider:
```shell ```shell
cd integrationTest/ cd integrationTest # NOTE: Not needed if already in that subdirectory
go test -v -verbose -provider BIND go test -v -verbose -provider BIND
``` ```
@ -275,6 +275,7 @@ For example, this will run the tests on Amazon AWS Route53:
export R53_DOMAIN=dnscontroltest-r53.com # Use a test domain. export R53_DOMAIN=dnscontroltest-r53.com # Use a test domain.
export R53_KEY_ID=CHANGE_TO_THE_ID export R53_KEY_ID=CHANGE_TO_THE_ID
export R53_KEY='CHANGE_TO_THE_KEY' export R53_KEY='CHANGE_TO_THE_KEY'
cd integrationTest # NOTE: Not needed if already in that subdirectory
go test -v -verbose -provider ROUTE53 go test -v -verbose -provider ROUTE53
``` ```

View File

@ -14,7 +14,7 @@ For each step, it will run the config once and expect changes. It will run it ag
1. The integration tests need a test domain to run on. All the records of this domain will be deleted! 1. The integration tests need a test domain to run on. All the records of this domain will be deleted!
2. Define all environment variables expected for the provider you wish to run. I setup a local `.env` file with the appropriate values and use [zoo](https://github.com/jsonmaur/zoo) to run my commands. 2. Define all environment variables expected for the provider you wish to run. I setup a local `.env` file with the appropriate values and use [zoo](https://github.com/jsonmaur/zoo) to run my commands.
3. run `go test -v -provider $NAME` where $NAME is the name of the provider you wish to run. 3. run `cd integrationTest && go test -v -provider $NAME` where $NAME is the name of the provider you wish to run.
Example: Example:
@ -35,6 +35,7 @@ export ROUTE53_DOMAIN="testdomain.tld"
``` ```
```shell ```shell
cd integrationTest # NOTE: Not needed if already in that subdirectory
go test -v -verbose -provider ROUTE53 go test -v -verbose -provider ROUTE53
``` ```

View File

@ -265,6 +265,7 @@ This flag is intended for use with legacy domains where the integration test cre
have access to read/edit Workers. This flag will eventually go away. have access to read/edit Workers. This flag will eventually go away.
```shell ```shell
cd integrationTest # NOTE: Not needed if already in that subdirectory
go test -v -verbose -provider CLOUDFLAREAPI -cfworkers=false go test -v -verbose -provider CLOUDFLAREAPI -cfworkers=false
``` ```

View File

@ -57,11 +57,11 @@ dnscontrol get-zones --format=nameonly hexonet HEXONET all
``` ```
```shell ```shell
# Review the output. Pick one domain and set HEXONET_DOMAIN. # Review the output. Pick one domain and set HEXONET_DOMAIN.
cd integrationTest/
export HEXONET_DOMAIN=yodream.com # Pick a domain name. export HEXONET_DOMAIN=yodream.com # Pick a domain name.
export HEXONET_ENTITY=OTE export HEXONET_ENTITY=OTE
export HEXONET_UID=test.user export HEXONET_UID=test.user
export HEXONET_PW=test.passw0rd export HEXONET_PW=test.passw0rd
cd integrationTest # NOTE: Not needed if already in that subdirectory
go test -v -verbose -provider HEXONET go test -v -verbose -provider HEXONET
``` ```

View File

@ -181,7 +181,7 @@ Integration tests use a test account and a real domain.
For example, this will run the tests using BIND: For example, this will run the tests using BIND:
```shell ```shell
cd integrationTest/ cd integrationTest # NOTE: Not needed if already in that subdirectory
go test -v -verbose -provider BIND go test -v -verbose -provider BIND
``` ```
@ -193,6 +193,7 @@ This will run the tests on Amazon AWS Route53:
export R53_DOMAIN=dnscontroltest-r53.com # Use a test domain. export R53_DOMAIN=dnscontroltest-r53.com # Use a test domain.
export R53_KEY_ID='CHANGE_TO_THE_ID' export R53_KEY_ID='CHANGE_TO_THE_ID'
export R53_KEY='CHANGE_TO_THE_KEY' export R53_KEY='CHANGE_TO_THE_KEY'
cd integrationTest # NOTE: Not needed if already in that subdirectory
go test -v -verbose -provider ROUTE53 go test -v -verbose -provider ROUTE53
``` ```