tasty-hunit 0.9.0.1 → 0.9.1

raw patch · 4 files changed

+96/−1 lines, 4 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• CHANGELOG.md +5/−0
• Test/Tasty/HUnit.hs +2/−0
• Test/Tasty/HUnit/Steps.hs +87/−0
• tasty-hunit.cabal +2/−1

@@ -1,6 +1,11 @@ Changes ======= +Version 0.9.1+-------------++Add `testCaseSteps` for multi-step tests+ Version 0.9.0.1 --------------- 

@@ -2,12 +2,14 @@ {-# LANGUAGE TypeFamilies, DeriveDataTypeable #-} module Test.Tasty.HUnit   ( testCase+  , testCaseSteps   , module Test.Tasty.HUnit.Orig   ) where  import Test.Tasty.Providers  import Test.Tasty.HUnit.Orig+import Test.Tasty.HUnit.Steps  import Data.Typeable import Control.Exception

@@ -0,0 +1,87 @@+{-# LANGUAGE DeriveDataTypeable #-}+module Test.Tasty.HUnit.Steps (testCaseSteps) where++import Control.Applicative+import Control.Exception+import Data.IORef+import Data.Typeable (Typeable)+import Test.Tasty.HUnit.Orig+import Test.Tasty.Providers++newtype TestCaseSteps = TestCaseSteps ((String -> IO ()) -> Assertion)+  deriving Typeable++instance IsTest TestCaseSteps where+  run _ (TestCaseSteps assertionFn) _ = do+    ref <- newIORef []++    let+      stepFn :: String -> IO ()+      stepFn msg = atomicModifyIORef ref (\l -> (msg:l, ()))++    hunitResult <- try (assertionFn stepFn)++    msgs <- reverse <$> readIORef ref++    return $+      case hunitResult of++        Right {} -> testPassed (unlines msgs)++        Left (HUnitFailure errMsg) -> testFailed $+          if null msgs+            then+              errMsg+            else+              -- Indent the error msg w.r.t. step messages+              unlines $+                msgs ++ map ("  " ++) (lines errMsg)++  testOptions = return []++-- | Create a multi-step unit test.+--+-- Example:+--+-- >main = defaultMain $ testCaseSteps "Multi-step test" $ \step -> do+-- >  step "Preparing..."+-- >  -- do something+-- >+-- >  step "Running part 1"+-- >  -- do something+-- >+-- >  step "Running part 2"+-- >  -- do something+-- >  assertFailure "BAM!"+-- >+-- >  step "Running part 3"+-- >  -- do something+--+-- The @step@ calls are mere annotations. They let you see which steps were+-- performed successfully, and which step failed.+--+-- You can think of @step@+-- as 'putStrLn', except 'putStrLn' would mess up the output with the+-- console reporter and get lost with the others.+--+-- For the example above, the output will be+--+-- >Multi-step test: FAIL+-- >  Preparing...+-- >  Running part 1+-- >  Running part 2+-- >    BAM!+-- >+-- >1 out of 1 tests failed (0.00s)+--+-- Note that:+--+-- * Tasty still treats this as a single test, even though it consists of+-- multiple steps.+--+-- * The execution stops after the first failure. When we are looking at+-- a failed test, we know that all /displayed/ steps but the last one were+-- successful, and the last one failed. The steps /after/ the failed one+-- are /not displayed/, since they didn't run.+testCaseSteps :: TestName -> ((String -> IO ()) -> Assertion) -> TestTree+testCaseSteps name = singleTest name . TestCaseSteps

@@ -2,7 +2,7 @@ -- documentation, see http://haskell.org/cabal/users-guide/  name:                tasty-hunit-version:             0.9.0.1+version:             0.9.1 synopsis:            HUnit support for the Tasty test framework. description:         HUnit support for the Tasty test framework. license:             MIT@@ -25,6 +25,7 @@ library   exposed-modules:     Test.Tasty.HUnit   other-modules:       Test.Tasty.HUnit.Orig+                       Test.Tasty.HUnit.Steps   other-extensions:    TypeFamilies, DeriveDataTypeable   build-depends:       base ==4.*, tasty >= 0.8   -- hs-source-dirs: