ZuLiangWang/sqlness

An ergonomic, opinionated framework for SQL integration test.

sqlness

SQL integration test harNESS

An ergonomic, opinionated framework for SQL integration test.

Use as library

First add sqlness to your project:

cargo add sqlness

Then implement Database and EnvController trait to setup your tests.

Users can refer basic.rs for a complete example.

This is the directory structure of examples

$ 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:

1. Collect all environments(first-level directory) under basic-case.
2. Run tests(.sql files) under environment one after one.
   1. Before execution it will read {testcase}.result(create one if not exists) to memory for compare.
   2. During execution it will collect query response and write to {testcase}.result
   3. After execution it will compare the generated {testcase}.result with previous one, PASS when they are the same, and FAIL otherwise.
3. Report result.

Usually result files should be tracked in git, whenever there are failed tests, users should

1. Update result to latest version(e.g. git add) if the newer result is right, or
2. 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.

Use as CLI

If the tested database supports common wire protocol(such as MySQL), users can choose to use sqlness-cli to run integration tests without writing any code.

$ cargo install sqlness-cli

$ sqlness-cli -h
A cli to run sqlness tests

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 <TYPE>          Which DBMS to test against [default: mysql] [possible values: mysql]
  -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

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.