Pgmicro testing

How to write tests, when to use each type of test, and how to run them. Contains information about conversion of `.test` to `.sqltest`, and how to write `.sqltest` and rust tests

install
source · Clone the upstream repo
git clone https://github.com/glommer/pgmicro
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/glommer/pgmicro "$T" && mkdir -p ~/.claude/skills && cp -r "$T/.claude/skills/testing" ~/.claude/skills/glommer-pgmicro-testing && rm -rf "$T"
manifest: .claude/skills/testing/SKILL.md
source content

Testing Guide

Test Types & When to Use

TypeLocationUse Case
.sqltest
testing/sqltests/tests/
SQL compatibility. Preferred for new tests
TCL
.test
testing/
Legacy SQL compat (being phased out)
Rust integration
tests/integration/
Regression tests, complex scenarios
Fuzz
tests/fuzz/
Complex features, edge case discovery

Note: TCL tests are being phased out in favor of testing/sqltests. The

.sqltest
format allows the same test cases to run against multiple backends (CLI, Rust bindings, etc.).

Running Tests

# Main test suite (TCL compat, sqlite3 compat, Python wrappers)
make test

# Single TCL test
make test-single TEST=select.test

# SQL test runner
make -C testing/sqltests run-cli

# OR
cargo run -p test-runner -- run <test-file or directory>

# Rust unit/integration tests (full workspace)
cargo test

Writing Tests

.sqltest (Preferred)

@database :default:

test example-addition {
    SELECT 1 + 1;
}
expect {
    2
}

test example-multiple-rows {
    SELECT id, name FROM users WHERE id < 3;
}
expect {
    1|alice
    2|bob
}

Location:

testing/sqltests/tests/*.sqltest

You must start converting TCL tests with the

convert
command from the test runner (e.g
cargo run -- convert <TCL_test_path> -o <out_dir>
). It is not always accurate, but it will convert most of the tests. If some conversion emits a warning you will have to write by hand whatever is missing from it (e.g unroll a for each loop by hand). Then you need to verify the tests work by running them with
make -C testing/sqltests run-rust
, and adjust their output if something was wrong with the conversion. Also, we use harcoded databases in TCL, but with
.sqltest
we generate the database with a different seed, so you will probably need to change the expected test result to match the new database query output. Avoid changing the SQL statements from the test, just change the expected result

TCL

do_execsql_test_on_specific_db {:memory:} test-name {
  SELECT 1 + 1;
} {2}

Location:

testing/*.test

Rust Integration

// tests/integration/test_foo.rs
#[test]
fn test_something() {
    let conn = Connection::open_in_memory().unwrap();
    // ...
}

Key Rules

  • Every functional change needs a test
  • Test must fail without change, pass with it
  • Prefer in-memory DBs:
    :memory:
    (sqltest) or
    {:memory:}
    (TCL)
  • Don't invent new test formats. Follow existing patterns
  • Write tests first when possible

Test Database Schema

testing/system/testing.db
has
users
and
products
tables. See docs/testing.md for schema.

Logging During Tests

RUST_LOG=none,turso_core=trace make test

Output:

testing/system/test.log
. Warning: very verbose.