6 releases
0.6.1 | Jun 24, 2024 |
---|---|
0.6.0 | Mar 29, 2024 |
0.5.0 | Jul 4, 2023 |
0.4.3 | Apr 6, 2023 |
0.4.2 | Mar 13, 2023 |
#38 in #test-framework
367 downloads per month
79KB
1.5K
SLoC
sqlness
SQL integration test harNESS
An ergonomic, opinionated framework for SQL integration test.
Usage
SQLNESS can be used as library or as command lines tool directly, it support MySQL/PostgreSQL wire protocol.
Use as library
First add sqlness to your project:
cargo add sqlness
Then implement Database
and EnvController
trait to setup your tests. Refer basic.rs for a complete example.
Use as CLI
$ cargo install sqlness-cli
$ sqlness-cli -h
SQLNESS command line tool
Usage: sqlness-cli [OPTIONS] --case-dir <CASE_DIR> --ip <IP> --port <PORT>
Options:
-c, --case-dir <CASE_DIR> Directory of test cases
-i, --ip <IP> IP of database to test against
-p, --port <PORT> Port of database to test against
-u, --user <USER> User of database to test against
-P, --password <PASSWORD> Password of database to test against
-d, --db <DB> DB name of database to test against
-t, --type <DB_TYPE> Which DBMS to test against [default: mysql] [possible values: mysql, postgresql]
-h, --help Print help
-V, --version Print version
One example used in our CI is
sqlness-cli -c tests -i 127.0.0.1 -p 3306 -u root -P 1a2b3c -d public
It will test against a MySQL server listening on 127.0.0.1:3306
Testcase structures
This is the directory structure of testcase for basic-example:
$ tree examples/
examples/
├── basic-case # Testcase root directory
│ └── simple # One environment
│ ├── config.toml # Config file for current environment, optional
│ ├── select.result # Output result file
│ └── select.sql # Input SQL testcase
├── basic.rs # Entrypoint of this example
When run it via
cargo run --example basic
It will do following things:
- Collect all environments(first-level directory) under
basic-case
. - Run tests(
.sql
files) under environment one after one.- Before execution it will read
{testcase}.result
(create one if not exists) to memory for compare. - During execution it will collect query response and write to
{testcase}.result
- After execution it will compare the generated
{testcase}.result
with previous one, PASS when they are the same, and FAIL otherwise.
- Before execution it will read
- Report result.
Usually result
files should be tracked in git, whenever there are failed tests, users should
- Update
result
to latest version(e.g.git add
) if the newer result is right, or - Restore
result
back to original version (e.g.git checkout
), troubleshoot bugs in database implementation, and run tests again
Flowchart below illustrates the typical steps when write a test.
Below is the output of this example:
Run testcase...
Start, env:simple, config:Some("examples/basic-case/simple/config.toml").
Test case "examples/basic-case/simple/select" finished, cost: 0ms
Environment simple run finished, cost:1ms
Stop, env:simple.
MyDB stopped.
Who is using
- CeresDB, a high-performance, distributed, cloud native time-series database that can handle both time-series and analytics workloads.
- GreptimeDB, an open-source, cloud-native, distributed time-series database.
If you’re using sqlness and like to be added to this list, welcome to open a PR.
License
This project is under Apache License 2.0.
Dependencies
~25–41MB
~668K SLoC