Add xit and xdescribe (close #252)

CHANGES.markdown

@@ -1,4 +1,5 @@
 ## Changes next
+  - Add `xit` and `xdescribe` (see #252)
   - Run around-hook for Bool and Result (see #252)
   - More graceful shutdown on ctrl-c (see #270)
   - Report exceptions in `beforeAll` operations only once

hspec-core/src/Test/Hspec/Core/Hooks.hs

@@ -17,7 +17,9 @@ module Test.Hspec.Core.Hooks (
 import           Control.Exception (SomeException, finally, throwIO, try)
 import           Control.Concurrent.MVar
 
-import           Test.Hspec.Core.Spec
+import           Test.Hspec.Core.Example
+import           Test.Hspec.Core.Tree
+import           Test.Hspec.Core.Spec.Monad
 
 -- | Run a custom action before every spec item.
 before :: IO a -> SpecWith a -> Spec

hspec-core/src/Test/Hspec/Core/Spec.hs

@@ -12,6 +12,8 @@ module Test.Hspec.Core.Spec (
 , it
 , pending
 , pendingWith
+, xit
+, xdescribe
 , parallel
 
 -- * The @SpecM@ monad
@@ -30,13 +32,21 @@ import           Data.CallStack
 import           Test.Hspec.Expectations (Expectation)
 
 import           Test.Hspec.Core.Example
+import           Test.Hspec.Core.Hooks
 import           Test.Hspec.Core.Tree
 import           Test.Hspec.Core.Spec.Monad
 
 -- | The @describe@ function combines a list of specs into a larger spec.
 describe :: String -> SpecWith a -> SpecWith a
 describe label spec = runIO (runSpecM spec) >>= fromSpecList . return . specGroup label
 
+-- |
+-- Changing `describe` to `xdescribe` marks all spec items of the corresponding subtree as pending.
+--
+-- This can be used to temporarily disable spec items.
+xdescribe :: String -> SpecWith a -> SpecWith a
+xdescribe label spec = before_ pending $ describe label spec
+
 -- | The @it@ function creates a spec item.
 --
 -- A spec item consists of:
@@ -51,12 +61,19 @@ describe label spec = runIO (runSpecM spec) >>= fromSpecList . return . specGrou
 it :: (HasCallStack, Example a) => String -> a -> SpecWith (Arg a)
 it label action = fromSpecList [specItem label action]
 
+-- |
+-- Changing `it` to `xit` marks the corresponding spec item as pending.
+--
+-- This can be used to temporarily disable a spec item.
+xit :: (HasCallStack, Example a) => String -> a -> SpecWith (Arg a)
+xit label action = before_ pending $ it label action
+
 -- | `parallel` marks all spec items of the given spec to be safe for parallel
 -- evaluation.
 parallel :: SpecWith a -> SpecWith a
 parallel = mapSpecItem_ $ \item -> item {itemIsParallelizable = True}
 
--- | `pending` can be used to indicate that an example is /pending/.
+-- | `pending` can be used to mark a spec item as pending.
 --
 -- If you want to textually specify a behavior but do not have an example yet,
 -- use this:
@@ -69,6 +86,6 @@ pending = E.throwIO (Pending Nothing)
 
 -- |
 -- `pendingWith` is similar to `pending`, but it takes an additional string
--- argument that can be used to specify the reason for why it's pending.
+-- argument that can be used to specify the reason for why the spec item is pending.
 pendingWith :: String -> Expectation
 pendingWith = E.throwIO . Pending . Just

hspec-core/test/Test/Hspec/Core/SpecSpec.hs

@@ -31,6 +31,12 @@ spec = do
         [Node d _] <- runSpecM (H.describe "" (pure ()))
         d `shouldBe` "(no description given)"
 
+  describe "xdescribe" $ do
+    it "creates a tree of pending examples" $ do
+      [Node _ [Leaf item]] <- runSpecM (H.xdescribe "" $ H.it "whatever" True)
+      Right r <- itemExample item defaultParams ($ ()) noOpProgressCallback
+      r `shouldBe` Pending Nothing
+
   describe "it" $ do
     it "takes a description of a desired behavior" $ do
       [Leaf item] <- runSpecM (H.it "whatever" True)
@@ -56,6 +62,12 @@ spec = do
         [Leaf item] <- runSpecM (H.it "" True)
         itemRequirement item `shouldBe` "(unspecified behavior)"
 
+  describe "xit" $ do
+    it "creates a pending example" $ do
+      [Leaf item] <- runSpecM (H.xit "whatever" True)
+      Right r <- itemExample item defaultParams ($ ()) noOpProgressCallback
+      r `shouldBe` Pending Nothing
+
   describe "pending" $ do
     it "specifies a pending example" $ do
       r <- runSpec $ do

src/Test/Hspec.hs

@@ -22,11 +22,21 @@ module Test.Hspec (
 , it
 , specify
 , example
-, pending
-, pendingWith
 , parallel
 , runIO
 
+-- * Pending spec items
+-- |
+-- During a test run a /pending/ spec item is:
+--
+-- 1. not executed
+--
+-- 1. reported as \"pending\"
+, pending
+, pendingWith
+, xit
+, xdescribe
+
 -- * Hooks
 , ActionWith
 , before