Crates.io | sqlness-cli |
lib.rs | sqlness-cli |
version | 0.6.1 |
source | src |
created_at | 2023-03-08 07:10:40.310104 |
updated_at | 2024-06-24 02:56:16.48853 |
description | SQLNESS command line tool |
homepage | https://github.com/CeresDB/sqlness |
repository | https://github.com/CeresDB/sqlness |
max_upload_size | |
id | 804323 |
size | 77,517 |
SQL integration test harNESS
An ergonomic, opinionated framework for SQL integration test.
SQLNESS can be used as library or as command lines tool directly, it support MySQL/PostgreSQL wire protocol.
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.
$ 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
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:
basic-case
..sql
files) under environment one after one.
{testcase}.result
(create one if not exists) to memory for compare.{testcase}.result
{testcase}.result
with previous one, PASS when they are the same, and FAIL otherwise.Usually result
files should be tracked in git, whenever there are failed tests, users should
result
to latest version(e.g. git add
) if the newer result is right, orresult
back to original version (e.g. git checkout
), troubleshoot bugs in database implementation, and run tests againFlowchart 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.
If you’re using sqlness and like to be added to this list, welcome to open a PR.
This project is under Apache License 2.0.