diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e5a2b70002..2ec4d20d90 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -118,6 +118,19 @@ can use all the features of that crate. For example, to disable the RUST_LOG=debug,hyper::proto::h1=info,h2=info cargo test --workspace ``` +### End-to-End Tests + +There are end-to-end tests that spin up a server and make requests via the client library and API. +These aren't run via the `cargo test --workspace` command. +They can be found in `tests/end_to_end_cases` and can be run with: +``` +cargo test --test end-to-end +``` +If you are debugging a failing end-to-end test, you'll likely want to see what's happening by running it like so: +``` +cargo test --test end-to-end -- my_failing_test --nocapture +``` + ### Visually showing explain plans Some query plans are output in the log in [graphviz](https://graphviz.org/) format. To display them you can use the `tools/iplan` helper. diff --git a/README.md b/README.md index 2947cd9cde..e3f7760446 100644 --- a/README.md +++ b/README.md @@ -266,7 +266,7 @@ $ ./scripts/grpcurl -plaintext 127.0.0.1:8082 influxdata.iox.management.v1.Manag We welcome community contributions from anyone! -Read our [Contributing Guide](CONTRIBUTING.md) for instructions on how to make your first contribution. +Read our [Contributing Guide](CONTRIBUTING.md) for instructions on how to run tests and how to make your first contribution. ## Architecture and Technical Documenation