Require a psql test arg to run tests

Without this the stackage and nix tests will fail as they will
not have a test psql instance for these tests.

Author: andrevdm

.github/workflows/haskell-ci.yml

@@ -204,7 +204,7 @@ jobs:
 
       - name: tests
         run: |
-          PGPASSWORD=test PGDATABASE=test PGUSER=test $CABAL v2-test $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --test-show-details=direct
+          PGPASSWORD=test PGDATABASE=test PGUSER=test $CABAL run $ARG_COMPILER $ARG_TESTS $ARG_BENCH --test-show-details=direct test:tests psql
 
       - name: cabal check
         run: |

Makefile

@@ -31,6 +31,10 @@ stack-ghcid:
 stack-ghcid-quiet:
 	$(stack) exec -- ghcid -c "stack ghci $(package):lib --ghci-options='-ignore-dot-ghci -fobject-code -fno-warn-unused-do-bind -fno-warn-unused-matches -fno-warn-unused-local-binds -fno-warn-unused-imports -j6 +RTS -A128m -n2m -qg' --main-is $(package):exe:$(exe)"
 
+stack-test:
+	$(stack) test --ta "psql"
+
+
 
 cabal-run:
 	cabal run $(exe)
@@ -44,5 +48,8 @@ cabal-build-fast:
 cabal-ghcid:
 	ghcid --lint -c "cabal repl --repl-options='-ignore-dot-ghci' --repl-options='-fobject-code' --repl-options='-fno-warn-unused-do-bind' --repl-options='-j6' "
 
+cabal-test:
+	cabal run --test-show-details=direct test:tests psql
+
 
 .PHONY : stack-build stack-build-dirty stack-run stack-ghci stack-ghcid stack-check-nightly cabal-ghcid cabal-build cabal-run cabal-build-fast

Readme.markdown

@@ -158,11 +158,14 @@ The following command builds the library, the standalone binary and the test pac
 cabal configure --enable-tests && cabal build -j
 ```
 
-To execute the tests, you need a running PostgreSQL server with an empty
-database called _test_. Tests are executed through cabal as follows:
+To execute the tests, you need a running PostgreSQL server. You need to set the correct
+environment varaiables for the psql connection.
+
+Tests are executed through cabal as follows:
 
 ```bash
-cabal configure --enable-tests && cabal test
+cabal configure --enable-tests 
+PGHOST=localhost PGDATABASE=test make-cabal test
 ```
 
 To build with stack use the following command
@@ -174,9 +177,12 @@ stack build
 To run the tests with stack use the following command
 
 ```bash
-stack test
+PGHOST=localhost PGDATABASE=test make stack-test
 ```
 
+NB note that the **psql** test argument must be set for the test suite to run. This is so that other CI environments like
+stackage or nix that wont have a running test psql instance will not fail on these tests
+
 
 # Changes from the original postgresql-simple-migration (version 0.1)
 

postgresql-migration.cabal

@@ -1,6 +1,6 @@
 cabal-version:              3.0
 name:                       postgresql-migration
-version:                    0.2.1.2
+version:                    0.2.1.3
 synopsis:                   PostgreSQL Schema Migrations
 homepage:                   https://github.com/andrevdm/postgresql-migration
 Bug-reports:                https://github.com/andrevdm/postgresql-migration/issues

test/Main.hs

@@ -10,6 +10,7 @@
 -- The test entry-point for postgresql-migration.
 
 {-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE LambdaCase #-}
 
 module Main
     ( main
@@ -21,14 +22,28 @@ import qualified Database.PostgreSQL.Simple.MigrationTest as V2
 import qualified Database.PostgreSQL.Simple.TransactionPerRunTest as V2TrnRun
 import qualified Database.PostgreSQL.Simple.TransactionPerStepTest as V2TrnStep
 import           Database.PostgreSQL.Simple.Util          (withTransactionRolledBack)
+import qualified System.Environment as Env
+
 import           Test.Hspec                               (hspec)
 
 main :: IO ()
 main = do
-    conRollback <- connectPostgreSQL ""
-    withTransactionRolledBack conRollback (hspec (V2.migrationSpec conRollback))
-    withTransactionRolledBack conRollback (hspec (V1.migrationSpec conRollback))
-    withTransactionRolledBack conRollback (hspec (V2TrnRun.migrationSpec conRollback))
+  Env.getArgs >>= \case
+    ("psql":as) -> Env.withArgs as $ do
+      conRollback <- connectPostgreSQL ""
+      withTransactionRolledBack conRollback (hspec (V2.migrationSpec conRollback))
+      withTransactionRolledBack conRollback (hspec (V1.migrationSpec conRollback))
+      withTransactionRolledBack conRollback (hspec (V2TrnRun.migrationSpec conRollback))
+
+      conPerStep <- connectPostgreSQL ""
+      hspec (V2TrnStep.migrationSpec conPerStep)
+
+    _ -> do
+      putStrLn "Skipping tests, no 'psql' argument provided"
+      putStrLn "  To run the tests please use one of the following make commands"
+      putStrLn "   make cabal-test"
+      putStrLn "   make stack-test"
+      putStrLn "  or directly"
+      putStrLn "   stack test --ta psql"
+      putStrLn "   cabal run --test-show-details=direct test:tests psql"
 
-    conPerStep <- connectPostgreSQL ""
-    hspec (V2TrnStep.migrationSpec conPerStep)