History

Timothy Messier 3609658edd perf(session): Avoid select when canceling session (#5140 ) When a resource relating to a session is deleted, notably a target, host, or auth_token, the corresponding sessions are marked as canceled via a database trigger that calls the cancel_session function. This function was performing a select as part of the insert call to ensure that it would not attempt to insert a session_sate of canceled if it was an invalid state transition. However, since this function was first introduced, there has been additional constraints added that would prevent an invalid state transition. In addition, performing a select as part of an insert increases the chances for contention with other queries that interact with the session_state table, especially since a large number of sessions and session_state rows can be included in a single transaction when things like auth_tokens or targets get deleted. Now, the cancel_function will perform the insert, and catch any of the potential violations, allowing the query to continue without needing to perform the select, thus reduction the potential for contention.		2 years ago
..
initdb.d	feat(host/plugin): Implement worker filter	2 years ago
tests	perf(session): Avoid select when canceling session (#5140 )	2 years ago
Makefile	add tests for sql ip address columns to ensure ipv6 capabiltiy (#5062 )	2 years ago
README.md	fix(db): Fix time zone consistency issues in monthly billing views	3 years ago

README.md

SQL Tests

This test suite is used to test behavior of the database logic. In particular the data warehouse implementation is completely in sql via plpgsql, functions, and triggers. This test suite is also implemented directly in sql.

Organization

initdb.d: contains init scripts/sql that is run on the test database when it starts. It ensures the sql migrations are run and creates test helper functions.
tests: contains the tests. Each file can contain only a single test that runs in a transaction so it can rollback.

The tests leverage the pgTap postgres extension to make assertions and provide more readable test output.

Usage

To run the test run make or make test. This will:

Start a docker postgres container and initialize it.
Start a docker pgtap container to execute the tests.

When writing new tests it can be faster to keep the database up and just re-run the tests. This can be done by running:

# starts database docker image in the background
make database-up

# runs the tests, call this multiple times while implementing new tests.
make run-tests

# to clean up
make clean

You can also run individual tests:

# run a single test file
make TESTS=tests/setup/wtt_load.sql

# run a single test file with the database already created.
make run-tests TESTS=tests/setup/wtt_load.sql

# run a directory of tests
make TESTS=tests/setup/*.sql

You can pass through options to pg_prove. See the docs for available options, i.e:

# run tests in parallel with verbose output
make PROVE_OPTS='-j9 -v'

By default the database docker container does not use a host port. This can be changed using an environment variable:

$ export SQL_TEST_DB_PORT=5433
$ make database-up
$ make run-tests

Different versions of postgres can easily be tested:

make PG_DOCKER_TAG=latest
make PG_DOCKER_TAG=14-alpine
make PG_DOCKER_TAG=13-alpine
make PG_DOCKER_TAG=12-alpine