README.md

Plan Test Runner

This module contains a testing tool for binder, planner and optimizer. Given a sequence of SQL queries as the input, the test runner will check the logical operator tree if any, and the physical operator tree if any.

The test data in YAML format is organized under tests/testdata folder.

To be notice that create materialized view is not supported, since it is not needed. Because the test runner will generate stream plan regardless the input SQL is a batch query or a streaming query.

- sql: |
    select * from t
  binder_error: "Item not found: relation \"t\""

This is a simple test case that validates the binder's behavior on an illegal SQL.

- sql: |
    create table t (v1 bigint, v2 double precision);
    select * from t;
  logical_plan: |
    LogicalProject { exprs: [$0, $1, $2], expr_alias: [None, None, None] }
      LogicalScan { table: "t", columns: ["_row_id", "v1", "v2"] }

If the SQL is valid, then test runner will compare the generated logical operator tree with the expected tree.

Update Plans

Firstly, we will need to create a placeholder in yaml testcases:

- sql: |
    create table t1 (v1 int, v2 int);
    create table t2 (v1 int, v2 int);
    create table t3 (v1 int, v2 int);
    select * from t1 join t2 on (t1.v1 = t2.v1) join t3 on (t2.v2 = t3.v2);
  logical_plan: ""
  batch_plan: ""
  stream_plan: ""

Those plans followed the input SQL are expected outputs.

./risedev apply-planner-test

Then we can find the updated tests at *.apply.yaml. If everything is okay, you may run:

./risedev do-apply-planner-test

To apply the new test results.

You may use the before key to include other testcases by id.

Run a single test

./risedev run-planner-test <yaml file name>
./risedev run-planner-test tpch # Run tpch.yaml
./risedev run-planner-test # Run all tests