influxdb/query_tests
Stuart Carnie 66047f4372
feat: InfluxQL learns how to plan some InfluxQL queries (#6520)
* feat: InfluxQL learns how to plan some queries

Also added a means to test the planner and execution

* chore: Update module docs

* chore: Document the planner functions

* chore: Update end_to_end_cases crate

* chore: Clarify why `SLIMIT` and `SOFFSET` return `NotImplemented`

* chore: Address lint issues

* chore: Fix rustdoc link issue

* chore: Remove InfluxQL tests from query_tests crate

Will follow conventions established by @carols10cents when
new query_tests crate is merged.

* chore: `now` field

`now` is a DataFusion built-in scalar function

* chore: remove unused code

* chore: Add additional arithmetic expression tests

* chore: Establish pattern for identifying and tracking InfluxQL issues

* chore: Add tests for case sensitivity issues

* chore: group tests into modules and functions

This avoids mass rewriting of insta snapshots as new
tests are added to each function. When tests are added in the middle,
existing snapshots are renamed (-N+1, -N+2, etc) resulting in
having to review numerous additional snapshots.
2023-01-11 02:50:49 +00:00
..
cases chore: Upgrade datafusion (#6467) 2023-01-03 15:29:11 +00:00
generate fix: ensure querier cache is refreshed for partition sort key (#4660) 2022-05-25 10:44:42 +00:00
src fix: use `create_at` to order querier chunks under kafkaless (#6554) 2023-01-10 17:15:08 +00:00
Cargo.toml feat: InfluxQL learns how to plan some InfluxQL queries (#6520) 2023-01-11 02:50:49 +00:00
README.md fix: Remove db crate from query_tests 2022-05-06 11:30:36 -04:00

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:

  1. Add a new file .sql to the cases/in directory
  2. Regenerate file: (cd generate && cargo run)
  3. Run the tests `` cargo test -p query_tests`
  4. 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.