Improve docs for running local integration tests #8145
Conversation
The instructions for using local-integration-test.sh were incomplete. Improve them to reflect the current requirements for using the script.
tests/README.md
Outdated
|
|
||
| This script requires that `govc` is [installed][govc-install] and available on | ||
| your `PATH`; that `docker` is installed, available on your `PATH`, and usable by | ||
| your current user; and that the following environment variables are defined: |
There was a problem hiding this comment.
This script also requires drone.
| @@ -1,10 +1,29 @@ | |||
| # VIC Engine Integration & Functional Test Suite | |||
|
|
|||
| To run the integration tests locally: | |||
| Integration tests can be run locally in several different ways. | |||
There was a problem hiding this comment.
We're going to need a glossary of terms that defines what we mean by unit/functional/integration/scenario/etc. Not for this PR, but reading the usage reminded me.
There was a problem hiding this comment.
A glossary would be helpful, but we now introduce these terms in CONTRIBUTING.md.
tests/README.md
Outdated
|
|
||
| ## Automatic with defaults | ||
|
|
||
| Use ./local-integration-test.sh | ||
| The recommended way to run integration tests is [local-integration-test.sh][sh]. |
There was a problem hiding this comment.
The recommended way to run integration tests locally is ....
tests/README.md
Outdated
| Use ./local-integration-test.sh | ||
| The recommended way to run integration tests is [local-integration-test.sh][sh]. | ||
|
|
||
| This script requires that `govc` is [installed][govc-install] and available on |
There was a problem hiding this comment.
The script file currently requires a minimum version of 0.9.0 and will provide a sane error if the version isn't met.
There was a problem hiding this comment.
In part because the script provides a sane error, I chose not to document that requirement here. (This is already wordy enough, and I hope that someone following these instructions will download the latest version.)
tests/README.md
Outdated
| The recommended way to run integration tests is [local-integration-test.sh][sh]. | ||
|
|
||
| This script requires that `govc` is [installed][govc-install] and available on | ||
| your `PATH`; that `docker` is installed, available on your `PATH`, and usable by |
There was a problem hiding this comment.
There is also a minimum version of docker client required but I'm not actually sure what that was. I think it was 1.13.0 (a customer has had issues with cert validation via IP with 1.13.1) but should confirm.
There was a problem hiding this comment.
Is this version requirement imposed by the product, the tests, or the script?
| in the target environment. | ||
| * `PUBLIC_NETWORK` (optional): The public network tests should use, if multiple | ||
| exist in the target environment. | ||
|
|
There was a problem hiding this comment.
I think there are some assumptions about bridge network as well, and use of specific VLAN ranges that were added when shifting to VC as a primary environment. I'm not sure that these have been fully parameterized out or written to function in the absence of VC or VLAN support.
There was a problem hiding this comment.
As far as I can tell, I don't do any explicit configuration of the bridge network when configuring my VC or running these tests. It's possible this happens automatically as a result of the way my VC is created— if I figure out what configuration is required, I'll update these instructions.
| 3. If there is an existing VCH available, it is possible to bypass the VCH installation/deletion by adding a TARGET_VCH into the list of test secrets. |
There was a problem hiding this comment.
I believe this is only available for Group1 at this time.
There was a problem hiding this comment.
Probably. I don't think I've actually changed this section though (other than my editor adding the missing newline at the end of the file) and there are enough other things to update here that it's probably worth creating a separate PR.
The instructions for using local-integration-test.sh were incomplete. Improve them to reflect the current requirements for using the script.