72a358e52f
Changes the DmlWrite type to require a PartitionKey be specified, instead of accepting an Option. This requirement was already in place - the write buffer upheld an invariant that all writes contained a partition key value (was not "None") or it panicked at runtime when attempting to enqueue the write. It is now possible to encode this invariant in the type system, which is what this change does. |
||
---|---|---|
.. | ||
cases | ||
generate | ||
src | ||
Cargo.toml | ||
README.md |
README.md
This crate contains "integration" tests for the query engine. Specifically, it runs queries against a fully created database instance, records the output, and compares it to expected output.
Some tests simply have their inputs and outputs hard coded into #[test]
annotated tests as is
Rust's norm.
The tests in src/runner
are driven somewhat more dynamically based on input files.
Cookbook: Adding a new Test
How to make a new test:
- Add a new file .sql to the
cases/in
directory - Regenerate file:
(cd generate && cargo run)
- Run the tests `` cargo test -p query_tests`
- You will get a failure message that contains examples of how to update the files
Example output
Possibly helpful commands:
# See diff
diff -du "/Users/alamb/Software/influxdb_iox/query_tests/cases/in/pushdown.expected" "/Users/alamb/Software/influxdb_iox/query_tests/cases/out/pushdown.out"
# Update expected
cp -f "/Users/alamb/Software/influxdb_iox/query_tests/cases/in/pushdown.out" "/Users/alamb/Software/influxdb_iox/query_tests/cases/out/pushdown.expected"
Cookbook: Adding a new test scenario
Each test can be defined in terms of a "setup" (a set of actions taken to prepare the state of database).
In the future, we envision more fine grained control of these setups (by implementing some of the database commands as IOX_TEST commands), but for now they are hard coded.
The SQL files refer to the setups with a specially formatted comment:
-- IOX_SETUP: OneMeasurementFourChunksWithDuplicates
To add a new setup, follow the pattern in scenario.rs of get_all_setups
.