diff --git a/documentation/byo-secrets.md b/documentation/byo-secrets.md index add16af3e..a871af04f 100644 --- a/documentation/byo-secrets.md +++ b/documentation/byo-secrets.md @@ -96,7 +96,7 @@ For example, the entry for BIND looks like: 3. Add your providers other ENV variables: -Every provider requires different variables set to perform the integration tests. The list of such variables is in `integrationTest/providers.json`. +Every provider requires different variables set to perform the integration tests. The list of such variables is in `integrationTest/profiles.json`. You've already added `*_DOMAIN` to `pr_integration_tests.yml`. Now we're going to add the remaining ones. diff --git a/documentation/integration-tests.md b/documentation/integration-tests.md index 14cd604b7..9fc6ff9fc 100644 --- a/documentation/integration-tests.md +++ b/documentation/integration-tests.md @@ -8,7 +8,7 @@ For each step, it will run the config once and expect changes. It will run it ag ## Configuration -`providers.json` should have an object for each provider type under test. This is identical to the json expected in `creds.json` for dnscontrol, except it also has a "domain" field specified for the domain to test. The domain does not even need to be registered for most providers. Note that `providers.json` expects environment variables to be specified with the relevant info. +`profiles.json` should have an object for each provider type under test. This is identical to the json expected in `creds.json` for dnscontrol, except it also has a "domain" field specified for the domain to test. The domain does not even need to be registered for most providers. Note that `profiles.json` expects environment variables to be specified with the relevant info. ## Running a test @@ -19,7 +19,7 @@ For each step, it will run the config once and expect changes. It will run it ag Example: ```shell -egrep ROUTE53 providers.json +egrep ROUTE53 profiles.json ``` ```text @@ -52,7 +52,7 @@ The `start` and `end` flags are both inclusive (i.e. `-start 16 -end 20` will ru For some providers it may be necessary to increase the test timeout using `-test`. The default is 10 minutes. `0` is "no limit". Typical Go durations work too (`1h` for 1 hour, etc). ```shell -go test -timeout 0 -v -verbose -provider CLOUDNS +go test -timeout 0 -v -verbose -provider CLOUDNS ``` FYI: The order of the flags matters. Flags native to the Go testing suite (`-timeout` and `-v`) must come before flags that are part of the DNSControl integration tests (`-verbose`, `-provider`). Yeah, that sucks and is confusing. diff --git a/documentation/writing-providers.md b/documentation/writing-providers.md index 129aa4853..56c41b097 100644 --- a/documentation/writing-providers.md +++ b/documentation/writing-providers.md @@ -163,7 +163,7 @@ Integration tests use a test account and a test domain. All records will be deleted from the test domain! Use a OTE domain or a real domain that isn't otherwise in use and can be destroyed. {% endhint %} -* Edit [integrationTest/providers.json](https://github.com/StackExchange/dnscontrol/blob/main/integrationTest/providers.json): +* Edit [integrationTest/profiles.json](https://github.com/StackExchange/dnscontrol/blob/main/integrationTest/profiles.json): * Add the `creds.json` info required for this provider in the form of environment variables. Now you can run the integration tests. @@ -333,7 +333,7 @@ For example, the entry for BIND looks like: 3. Add your providers other ENV variables: -Every provider requires different variables set to perform the integration tests. The list of such variables is in `integrationTest/providers.json`. +Every provider requires different variables set to perform the integration tests. The list of such variables is in `integrationTest/profiles.json`. You've already added `*_DOMAIN` to `pr_test.yml`. Now we're going to add the remaining ones. @@ -361,7 +361,7 @@ These are the things we'll be checking when you submit the PR. Please try to co * `documentation/SUMMARY.md` * `documentation/providers.md` (the autogenerated table + the second one; make sure it is removed from the `requested` list) * `documentation/provider/`PROVIDERNAME`.md` - * `integrationTest/providers.json` + * `integrationTest/profiles.json` * `providers/_all/all.go` 3. Review the code for style issues, remove debug statements, make sure all exported functions have a comment, and generally tighten up the code. 4. Verify you're using the most recent version of anything you import. (See [Step 12](#step-12-dependencies))