aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorRaveline <eraveline@gmail.com>2019-05-03 11:44:05 +0200
committerRaveline <eraveline@gmail.com>2019-05-03 11:44:24 +0200
commitd7b45e63148bb14dbbd3d61b4f5305338176dd45 (patch)
tree1b9e4edd979aad5bcc68b77c2f3d23db424c80f9
parentdd35032c658cf4136e94b18c87656a611931b0ed (diff)
downloadsqueal-hspec-d7b45e63148bb14dbbd3d61b4f5305338176dd45.tar.gz
squeal-hspec-d7b45e63148bb14dbbd3d61b4f5305338176dd45.tar.zst
squeal-hspec-d7b45e63148bb14dbbd3d61b4f5305338176dd45.zip
Add information in the README
-rw-r--r--README.md15
1 files 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 @@
1# squeal-hspec 1# squeal-hspec
2 2
3Helpers for creating database tests with hspec and squeal, inspired by Jonathan Fischoff's 3Helpers for creating database tests with hspec and squeal, inspired by Jonathan
4Fischoff's
4[hspec-pg-transact](http://hackage.haskell.org/package/hspec-pg-transact). 5[hspec-pg-transact](http://hackage.haskell.org/package/hspec-pg-transact).
5 6
6This uses @tmp-postgres@ to automatically and connect to a temporary instance of postgres on a random port. 7This uses @tmp-postgres@ to automatically and connect to a temporary instance of
8postgres on a random port.
7 9
8Current version is done to operate with Squeal 0.4.0.0. 10Current version is done to operate with Squeal 0.4.0.0.
9 11
10`describeDB` lets you initate a series of `itDB` specs which will operate in the same context. 12`describeDB` lets you initate a series of `itDB` specs which will operate in the
11It takes migrations to run and a series of fixtures to fill the database. 13same context. It takes migrations to run and a series of fixtures to fill the
14database.
15
16Setting the env var `TEST_DB_CONNECTION_STRING` will let you use a non-temporary
17database if need be. Tear down will run the `migrateDown` to make sure the test
18db doesn't get filled with invalid data.