9 files changed, 268 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..2449568
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+.stack-work/
+squeal-hspec.cabal
+*~
\ No newline at end of file
diff --git a/ChangeLog.md b/ChangeLog.md
new file mode 100644
index 0000000..f9a2fd7
--- /dev/null
+++ b/ChangeLog.md
@@ -0,0 +1,3 @@
+# Changelog for squeal-hspec
+
+## Unreleased changes
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..102126f
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,30 @@
+Copyright Author name here (c) 2019
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of Author name here nor the names of other
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..56f44b9
--- /dev/null
+++ b/README.md
@@ -0,0 +1 @@
+# squeal-hspec
diff --git a/Setup.hs b/Setup.hs
new file mode 100644
index 0000000..9a994af
--- /dev/null
+++ b/Setup.hs
@@ -0,0 +1,2 @@
+import Distribution.Simple
+main = defaultMain
diff --git a/package.yaml b/package.yaml
new file mode 100644
index 0000000..fb93c52
--- /dev/null
+++ b/package.yaml
@@ -0,0 +1,44 @@
+name:                squeal-hspec
+version:             0.1.0.0
+github:              "githubuser/squeal-hspec"
+license:             BSD3
+author:              "Author name here"
+maintainer:          "example@example.com"
+copyright:           "2019 Author name here"
+
+extra-source-files:
+- README.md
+- ChangeLog.md
+
+# Metadata used when publishing your package
+# synopsis:            Short description of your package
+# category:            Web
+
+# To avoid duplicated efforts in documentation and dealing with the
+# complications of embedding Haddock markup inside cabal files, it is
+# common to point users to the README.md file.
+description:         Please see the README on GitHub at <https://github.com/githubuser/squeal-hspec#readme>
+
+dependencies:
+- base >= 4.7 && < 5
+- bytestring
+- squeal-postgresql
+- hspec
+- tmp-postgres
+- monad-control
+- transformers-base
+- generics-sop
+
+library:
+  source-dirs: src
+
+tests:
+  squeal-hspec-test:
+    main:                Spec.hs
+    source-dirs:         test
+    ghc-options:
+    - -threaded
+    - -rtsopts
+    - -with-rtsopts=-N
+    dependencies:
+    - squeal-hspec
diff --git a/src/Squeal/PostgreSQL/Hspec.hs b/src/Squeal/PostgreSQL/Hspec.hs
new file mode 100644
index 0000000..44011b7
--- /dev/null
+++ b/src/Squeal/PostgreSQL/Hspec.hs
@@ -0,0 +1,114 @@
+{-|
+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.
+
+Tests can be written with 'itDB' which is wrapper around 'it' that uses the passed in 'TestDB' to run a db transaction automatically for the test.
+
+The libary also provides a few other functions for more fine grained control over running transactions in tests.
+-}
+{-# LANGUAGE DataKinds        #-}
+{-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE KindSignatures   #-}
+{-# LANGUAGE MonoLocalBinds   #-}
+{-# LANGUAGE RankNTypes       #-}
+{-# LANGUAGE RecordWildCards  #-}
+{-# LANGUAGE TypeInType       #-}
+{-# LANGUAGE TypeOperators    #-}
+module Squeal.PostgreSQL.Hspec
+where
+
+import           Control.Exception
+import           Control.Monad
+import           Control.Monad.Base          (liftBase)
+import           Control.Monad.Trans.Control (MonadBaseControl)
+import qualified Data.ByteString.Char8       as BSC
+import qualified Database.Postgres.Temp      as Temp
+import           Generics.SOP                (K)
+import           Squeal.PostgreSQL
+import           Squeal.PostgreSQL.Migration
+import           Squeal.PostgreSQL.Pool
+import           Test.Hspec
+
+data TestDB a = TestDB
+  { tempDB :: Temp.DB
+  -- ^ Handle for temporary @postgres@ process
+  , pool   :: Pool a
+  -- ^ Pool of 50 connections to the temporary @postgres@
+  }
+
+type Migrations schema m a = (MonadBaseControl IO m) =>
+  PQ (("schema_migrations" ::: Table MigrationsTable) ': '[])
+     (("schema_migrations" ::: Table MigrationsTable) ': schema) m a
+
+type Fixtures schema = (Pool (K Connection schema) -> IO ())
+type Actions schema a = PoolPQ schema IO a
+type SquealContext (schema :: SchemaType) = TestDB (K Connection schema)
+
+-- | Start a temporary @postgres@ process and create a pool of connections to it
+setupDB
+  :: Migrations schema IO a
+  -> Fixtures schema
+  -> IO (SquealContext schema)
+setupDB migration fixtures = do
+  tempDB <- either throwIO return =<< Temp.startAndLogToTmp []
+  let connectionString = BSC.pack (Temp.connectionString tempDB)
+  putStrLn $ Temp.connectionString tempDB
+  let singleStripe = 1
+      keepConnectionForOneHour = 3600
+      poolSizeOfFifty = 50
+  pool <- createConnectionPool
+     connectionString
+     singleStripe
+     keepConnectionForOneHour
+     poolSizeOfFifty
+  withConnection connectionString migration
+  fixtures pool
+  pure TestDB {..}
+
+-- | Drop all the connections and shutdown the @postgres@ process
+teardownDB :: TestDB a -> IO ()
+teardownDB TestDB {..} = do
+  destroyAllResources pool
+  void $ Temp.stop tempDB
+
+-- | Run an 'IO' action with a connection from the pool
+withPool :: TestDB (K Connection schema) -> Actions schema a -> IO a
+withPool testDB = liftBase . flip runPoolPQ (pool testDB)
+
+-- | Run an 'DB' transaction, using 'transactionally_'
+withDB :: Actions schema a -> TestDB (K Connection schema) -> IO a
+withDB action testDB =
+  runPoolPQ (transactionally_ action) (pool testDB)
+
+-- | Flipped version of 'withDB'
+runDB :: TestDB (K Connection schema) -> Actions schema a -> IO a
+runDB = flip withDB
+
+-- | Helper for writing tests. Wrapper around 'it' that uses the passed
+--   in 'TestDB' to run a db transaction automatically for the test.
+itDB :: String -> Actions schema a -> SpecWith (TestDB (K Connection schema))
+itDB msg action = it msg $ void . withDB action
+
+-- | Wraps 'describe' with a
+--
+-- @
+--   'beforeAll' ('setupDB' migrate)
+-- @
+--
+-- hook for creating a db and a
+--
+-- @
+--   'afterAll' 'teardownDB'
+-- @
+--
+-- hook for stopping a db.
+describeDB
+  :: Migrations schema IO a
+  -> Fixtures schema
+  -> String
+  -> SpecWith (SquealContext schema)
+  -> Spec
+describeDB migrate fixture str =
+  beforeAll (setupDB migrate fixture) . afterAll teardownDB . describe str
diff --git a/stack.yaml b/stack.yaml
new file mode 100644
index 0000000..913ef7a
--- /dev/null
+++ b/stack.yaml
@@ -0,0 +1,69 @@
+# This file was automatically generated by 'stack init'
+#
+# Some commonly used options have been documented as comments in this file.
+# For advanced use and comprehensive documentation of the format, please see:
+# https://docs.haskellstack.org/en/stable/yaml_configuration/
+
+# Resolver to choose a 'specific' stackage snapshot or a compiler version.
+# A snapshot resolver dictates the compiler version and the set of packages
+# to be used for project dependencies. For example:
+#
+# resolver: lts-3.5
+# resolver: nightly-2015-09-21
+# resolver: ghc-7.10.2
+# resolver: ghcjs-0.1.0_ghc-7.10.2
+#
+# The location of a snapshot can be provided as a file or url. Stack assumes
+# a snapshot provided as a file might change, whereas a url resource does not.
+#
+# resolver: ./custom-snapshot.yaml
+# resolver: https://example.com/snapshots/2018-01-01.yaml
+resolver: lts-12.20
+
+# User packages to be built.
+# Various formats can be used as shown in the example below.
+#
+# packages:
+# - some-directory
+# - https://example.com/foo/bar/baz-0.0.2.tar.gz
+# - location:
+#    git: https://github.com/commercialhaskell/stack.git
+#    commit: e7b331f14bcffb8367cd58fbfc8b40ec7642100a
+# - location: https://github.com/commercialhaskell/stack/commit/e7b331f14bcffb8367cd58fbfc8b40ec7642100a
+#  subdirs:
+#  - auto-update
+#  - wai
+packages:
+    - '.'
+
+# Dependency packages to be pulled from upstream that are not in the resolver
+# using the same syntax as the packages field.
+# (e.g., acme-missiles-0.3)
+extra-deps:
+    - squeal-postgresql-0.4.0.0                                                                                           
+    - records-sop-0.1.0.2                                                                                                 
+    - tmp-postgres-0.1.1.0                                                                                                
+
+# Override default flag values for local packages and extra-deps
+# flags: {}
+
+# Extra package databases containing global packages
+# extra-package-dbs: []
+
+# Control whether we use the GHC we find on the path
+# system-ghc: true
+#
+# Require a specific version of stack, using version ranges
+# require-stack-version: -any # Default
+# require-stack-version: ">=1.7"
+#
+# Override the architecture used by stack, especially useful on Windows
+# arch: i386
+# arch: x86_64
+#
+# Extra directories used by stack for building
+# extra-include-dirs: [/path/to/dir]
+# extra-lib-dirs: [/path/to/dir]
+#
+# Allow a newer minor version of GHC than the snapshot specifies
+# compiler-check: newer-minor
diff --git a/test/Spec.hs b/test/Spec.hs
new file mode 100644
index 0000000..cd4753f
--- /dev/null
+++ b/test/Spec.hs
@@ -0,0 +1,2 @@
+main :: IO ()
+main = putStrLn "Test suite not yet implemented"