Michael LiandJohan Brandhorst-Satzkorn
45171a3f56
* refact(e2e): Move cleanup steps into each test The migration test needed to create some resources, but doesn't care about cleaning up because the test would take care of spinning down the docker container that it's using. To maintain flexibility going forward, we'll establish that tests are responsible for cleaning up (rather than the methods they use) * refact(e2e): Use new env var for skip check Currently, the e2e tests use the E2E_PASSWORD_AUTH_METHOD_ID environment variable to determine if the test should be skipped. However, the new migration test does not require a pre-existing boundary cluster and would not have this environment variable. As a result, we needed an alternative way to check if an e2e test should be skipped when running tests in ci. * refact(e2e): Create more common boundary methods * fix(e2e): Set to string value Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
111 lines
4.1 KiB
Markdown
111 lines
4.1 KiB
Markdown
# boundary-e2e-tests
|
|
|
|
This test suite tests Boundary in an end-to-end setting, utilizing both the Boundary CLI and the
|
|
Boundary Go API to exercise Boundary through various user workflows. It was designed to be run in a
|
|
variety of environments as long as the appropriate environment variables are set. The test suite
|
|
itself uses the standard [go test](https://pkg.go.dev/testing) library.
|
|
|
|
One method for setting up an environment is utilizing [Enos](https://github.com/hashicorp/Enos-Docs)
|
|
to create the desired infrastructure.
|
|
|
|
## Getting Started
|
|
### Enos
|
|
Setup Enos as described [here](../../../enos/README.md)
|
|
|
|
Then, use the following commands to run tests
|
|
```shell
|
|
cd enos
|
|
enos scenario list
|
|
|
|
# `Run` executes the tests and destroys the associated infrastructure in one command
|
|
enos scenario run e2e_{scenario} builder:local
|
|
|
|
# `Launch` executes the tests, but leaves the infrastructure online for debugging purposes
|
|
enos scenario launch e2e_{scenario} builder:local
|
|
enos scenario output # displays any defined enos output
|
|
enos scenario destroy # destroys infra
|
|
```
|
|
|
|
Enos scenarios set up the infrastructure, set the appropriate environment variables, and run the
|
|
specified tests in its scenario file.
|
|
|
|
Note: To run the `e2e_host_aws` scenario, you will need access to the boundary team's test AWS
|
|
account.
|
|
|
|
### Local
|
|
Set the appropriate environment variables...
|
|
```shell
|
|
export E2E_TESTS=true # This is needed for any e2e test. Otherwise, the test is skipped
|
|
export BOUNDARY_ADDR= # e.g. http://127.0.0.1:9200
|
|
export E2E_PASSWORD_AUTH_METHOD_ID= # e.g. ampw_1234567890
|
|
export E2E_PASSWORD_ADMIN_LOGIN_NAME= # e.g. "admin"
|
|
export E2E_PASSWORD_ADMIN_PASSWORD= # e.g. "password"
|
|
|
|
# For e2e/host/static
|
|
export E2E_TARGET_IP= # e.g. 192.168.0.1
|
|
export E2E_SSH_KEY_PATH= # e.g. /Users/username/key.pem
|
|
export E2E_SSH_USER= # e.g. ubuntu
|
|
|
|
# For e2e/host/aws
|
|
export E2E_AWS_ACCESS_KEY_ID=
|
|
export E2E_AWS_SECRET_ACCESS_KEY=
|
|
export E2E_AWS_HOST_SET_FILTER1= # e.g. "tag:testtag=true"
|
|
export E2E_AWS_HOST_SET_IPS1= # e.g. "[\"1.2.3.4\", \"2.3.4.5\"]"
|
|
export E2E_AWS_HOST_SET_FILTER2= # e.g. "tag:testtagtwo=test"
|
|
export E2E_AWS_HOST_SET_IPS2= # e.g. "[\"1.2.3.4\"]
|
|
export E2E_SSH_KEY_PATH= # e.g. /Users/username/key.pem
|
|
export E2E_SSH_USER= # e.g. ubuntu
|
|
|
|
# For e2e/credential/vault
|
|
export VAULT_ADDR= # e.g. http://127.0.0.1:8200
|
|
export VAULT_TOKEN=
|
|
export E2E_TARGET_IP= # e.g. 192.168.0.1
|
|
export E2E_SSH_KEY_PATH= # e.g. /Users/username/key.pem
|
|
export E2E_SSH_USER= # e.g. ubuntu
|
|
```
|
|
|
|
Then, run...
|
|
```shell
|
|
go test github.com/hashicorp/boundary/testing/e2e/target // run target tests
|
|
go test ./target/ // run target tests if running from this directory
|
|
go test github.com/hashicorp/boundary/testing/e2e/target -v // verbose
|
|
go test github.com/hashicorp/boundary/testing/e2e/target -v -run '^TestCreateTargetApi$' // run a specific test
|
|
```
|
|
|
|
## Adding Tests
|
|
|
|
Tests live under this directory. Additional tests can be added to an existing go package or a new
|
|
one can be created. If a new package is created, a new enos scenario would also need to be created.
|
|
|
|
Enos is comprised of scenarios, where a scenario is the environment you want the tests to operate
|
|
in. In one scenario, there may be a boundary cluster and a target. Another scenario might involve a
|
|
boundary cluster and a vault instance. Scenarios can be found in [boundary/enos](../../../enos/)
|
|
|
|
To run these tests in CI, the [enos-run.yml](../../../.github/workflows/enos-run.yml) github action
|
|
workflow must be updated to include the new scenario (see the `matrix`).
|
|
|
|
### Development
|
|
To assist with iterating on tests on enos launched infrastructure, you can perform the following...
|
|
|
|
Add the following snippet to print out environment variable information
|
|
```
|
|
# `c` is the output from `loadConfig()`
|
|
s, _ := json.MarshalIndent(c, "", "\t")
|
|
log.Printf("%s", s)
|
|
```
|
|
Launch an enos scenario
|
|
```
|
|
enos scenario launch e2e_{scenario} builder:local
|
|
enos scenario output
|
|
```
|
|
Take the printed environment variable information and export them into another terminal session
|
|
```
|
|
export BOUNDARY_ADDR=
|
|
export E2E_PASSWORD_AUTH_METHOD_ID=
|
|
...
|
|
```
|
|
Run your tests
|
|
```
|
|
go test -v {go package}
|
|
```
|