Materialize/test/version-consistency/README.md

Version consistency tests

Overview

These tests aim to ensure that no unknown inconsistencies with an earlier version of mz exist.

Getting started

To launch the tests using mzcompose, run

bin/mzcompose --find version-consistency down -v && bin/mzcompose --find version-consistency run default

To start the tests from a shell, use

bin/version-consistency-test --max-runtime-in-sec 60

Test explain plans

Use --output-query-mode=EXPLAIN or --output-query-mode=EXPLAIN_PHYSICAL to test explain plans. You might want to set --avoid-expressions-expecting-db-error and reduce the number of columns per query with --max-cols-per-query.

Query generation

Queries are generated using the output consistency test framework, which is also used to ensure consistency between data-flow rendering and constant folding evaluations. See this README for more details on query generation.

To ignore known inconsistencies, extend the VersionConsistencyIgnoreFilter.