Influxdata
/
influxdb
mirror of https://github.com/influxdata/influxdb.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #1803 from influxdata/pd-update-contributing 

chore: update CONTRIBUTING with instructions for running and debugging end-to-end tests
pull/24376/head
kodiakhq[bot] 2021-06-24 22:18:26 +00:00 committed by GitHub
parent 4e7cf39b23 2d2768bf33
commit a605263660
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@ -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.

2
README.md
View File

@ -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