Timothy Messier
c8bf1917f5
Now when initializing the test database for sql tests, it will load the colors persona data into the database. This will provide a data set that tests can use without needing to call `wtt_load`. The main motivation is to allow for a separation of setup and test execution that requires crossing a transaction boundary. The pgTap tests are required to exectue as a single transaction, so that the rollback can reset the state, and each test can be isolated. However, can cause issues with some test senarios, particuarly with the use of some times releated functions like `current_timestamp` and `now` which return the time that the current transaction started. This creates an issue if a test relies on some setup that sets a time via `now`, then an update that expects a new time via `now`. See: https://www.postgresql.org/docs/13/functions-datetime.html#FUNCTIONS-DATETIME-CURRENT
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
postgrescontainer and initialize it. - Start a docker
pgtapcontainer 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 TEST=tests/setup/wtt_load.sql
# run a single test file with the database already created.
make run-tests TEST=tests/setup/wtt_load.sql
# run a directory of tests
make TEST=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'
Different versions of postgres can easily be tested:
make PG_DOCKER_TAG=latest
make PG_DOCKER_TAG=13-alpine
make PG_DOCKER_TAG=12-alpine
make PG_DOCKER_TAG=11-alpine