From d7b45e63148bb14dbbd3d61b4f5305338176dd45 Mon Sep 17 00:00:00 2001 From: Raveline Date: Fri, 3 May 2019 11:44:05 +0200 Subject: Add information in the README --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e254c58..02ed812 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,18 @@ # squeal-hspec -Helpers for creating database tests with hspec and squeal, inspired by Jonathan Fischoff's +Helpers for creating database tests with hspec and squeal, inspired by Jonathan +Fischoff's [hspec-pg-transact](http://hackage.haskell.org/package/hspec-pg-transact). -This uses @tmp-postgres@ to automatically and connect to a temporary instance of postgres on a random port. +This uses @tmp-postgres@ to automatically and connect to a temporary instance of +postgres on a random port. Current version is done to operate with Squeal 0.4.0.0. -`describeDB` lets you initate a series of `itDB` specs which will operate in the same context. -It takes migrations to run and a series of fixtures to fill the database. +`describeDB` lets you initate a series of `itDB` specs which will operate in the +same context. It takes migrations to run and a series of fixtures to fill the +database. + +Setting the env var `TEST_DB_CONNECTION_STRING` will let you use a non-temporary +database if need be. Tear down will run the `migrateDown` to make sure the test +db doesn't get filled with invalid data. -- cgit v1.2.3