-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | test-sandbox support for the test-framework package
--   
--   Interfaces the test-sandbox with the test-framework packages to allow
--   writing system tests in Haskell in a standard fashion.
--   
--   The environment is preserved between test cases. This enables the
--   user, for instance, to start a process in one test and stop it in
--   another.
--   
--   Usage examples can be found on the github page:
--   <a>http://gree.github.io/haskell-test-sandbox/</a>
--   
--   A full example project is available at:
--   <a>https://git.gree-dev.net/benjamin-surma/flare-tests/</a>
--   
--   Extensive documentation is available in the source code itself.
@package test-framework-sandbox
@version 0.0.1.2

module Test.Framework.Providers.Sandbox.Internals
data SandboxTestResult
Passed :: SandboxTestResult
Skipped :: SandboxTestResult
Failure :: String -> SandboxTestResult
data SandboxTestRunning
Running :: SandboxTestRunning
data SandboxTest
SandboxTest :: SandboxTestResult -> SandboxTest
SandboxCleaning :: (MVar Int) -> SandboxTest
withTest :: String -> Sandbox b -> Sandbox b
prettyPrintVariable :: String
testVariable :: String
testLevelVariable :: String
indent :: String
printTestName :: Int -> String -> IO ()
printTestResult :: Either String a -> IO ()
putStrColor :: ColorIntensity -> Color -> String -> IO ()
sandboxSeed :: Maybe Seed -> Maybe SandboxSeed
sandboxTestOptions :: TestOptions -> SandboxTestOptions
putOptions :: Either String (RunnerOptions, [String]) -> Sandbox ()
instance Typeable SandboxTestResult
instance Typeable SandboxTestRunning
instance Typeable SandboxTest
instance Testlike SandboxTestRunning SandboxTestResult SandboxTest
instance TestResultlike SandboxTestRunning SandboxTestResult
instance Show SandboxTestRunning
instance Show SandboxTestResult

module Test.Framework.Providers.Sandbox

-- | Executes tests in the Sandbox monad.
sandboxTests :: String -> Sandbox Test -> Test

-- | Creates a test from a Sandbox action. Any exception (or error thrown
--   with throwError) will mark the test as failed.
sandboxTest :: String -> Sandbox () -> Sandbox Test

-- | Groups tests in the Sandbox monad.
sandboxTestGroup :: String -> [Sandbox Test] -> Sandbox Test

-- | Variant of sandboxTestGroup: tests will be skipped if the condition is
--   not verified.
sandboxTestGroup' :: String -> Sandbox Bool -> [Sandbox Test] -> Sandbox Test

-- | Displays a progress update during a test.
yieldProgress :: String -> Sandbox ()