Safe Haskell	None
Language	Haskell2010

System.Taffybar.Test.UtilSpec

Contents

Mock commands
Environment setup
- Running subprocesses
Concurrency
OS Resources
Other test helpers
- Logging for tests

Synopsis

spec :: Spec
withMockCommand :: FilePath -> String -> IO a -> IO a
writeScript :: FilePath -> String -> IO ()
withEnv :: [(String, Maybe String -> Maybe String)] -> IO a -> IO a
withSetEnv :: [(String, String)] -> IO a -> IO a
prependPath :: FilePath -> Maybe String -> Maybe String
withService :: MonadUnliftIO m => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> m a) -> m a
setStdoutCond :: Priority -> ProcessConfig i o e -> ProcessConfig i () e
setStderrCond :: Priority -> ProcessConfig i o e -> ProcessConfig i o ()
setServiceDefaults :: Priority -> ProcessConfig i o e -> ProcessConfig () () ()
makeServiceDefaults :: FilePath -> [String] -> IO (ProcessConfig () () ())
listLiveThreads :: IO [(ThreadId, (String, Maybe ThreadStatus))]
diffLiveThreads :: Eq a => [(a, b)] -> [(a, b)] -> [(a, b)]
listFds :: MonadIO m => m [(Int, FilePath)]
tryIOMaybe :: MonadUnliftIO m => m a -> m (Maybe a)
laxTimeout :: (HasCallStack, MonadUnliftIO m) => Int -> m a -> m (Maybe a)
laxTimeout' :: (HasCallStack, MonadUnliftIO m) => Int -> m a -> m a
newtype DodgyEq a = DodgyEq {
- unDodgyEq :: a
}
logSetup :: HasCallStack => SpecWith a -> SpecWith a
specLogSetup :: IO ()
specLogSetupPrio :: Priority -> IO ()
specLog :: MonadIO m => String -> m ()
specLogAt :: MonadIO m => Priority -> String -> m ()
getSpecLogPriority :: MonadIO m => m Priority
data Priority
- = DEBUG
- | INFO
- | NOTICE
- | WARNING
- | ERROR
- | CRITICAL
- | ALERT
- | EMERGENCY

Documentation

spec :: Spec Source #

Mock commands

withMockCommand Source #

Arguments

:: FilePath	Name of command - should not contain slashes
-> String	Contents of script
-> IO a	Action to run with command available in search path
-> IO a

Run the given IO action with the PATH environment variable set up so that executing the given command name will run a script.

writeScript :: FilePath -> String -> IO () Source #

Write a text file, make it executable. It ought to have a shebang line.

Environment setup

withEnv :: [(String, Maybe String -> Maybe String)] -> IO a -> IO a Source #

Run an IO action with the given environment variables set up according to their current value. Nothing denotes an unset environment variable. After the IO action completes, environment variables are restored to their previous state.

withSetEnv :: [(String, String)] -> IO a -> IO a Source #

prependPath :: FilePath -> Maybe String -> Maybe String Source #

Use this as a modifier function argument of withEnv to ensure that the given directory is prepended to a search path variable.

Running subprocesses

withService :: MonadUnliftIO m => ProcessConfig stdin stdout stderr -> (Process stdin stdout stderr -> m a) -> m a Source #

Like withProcessTerm_, except that if the process exits -- for whatever reason -- before the action completes, then it's an error. It will immediately cancel the action and throw an ExitCodeException.

setStdoutCond :: Priority -> ProcessConfig i o e -> ProcessConfig i () e Source #

setStderrCond :: Priority -> ProcessConfig i o e -> ProcessConfig i o () Source #

setServiceDefaults :: Priority -> ProcessConfig i o e -> ProcessConfig () () () Source #

makeServiceDefaults :: FilePath -> [String] -> IO (ProcessConfig () () ()) Source #

Concurrency

listLiveThreads :: IO [(ThreadId, (String, Maybe ThreadStatus))] Source #

diffLiveThreads :: Eq a => [(a, b)] -> [(a, b)] -> [(a, b)] Source #

OS Resources

listFds :: MonadIO m => m [(Int, FilePath)] Source #

Other test helpers

tryIOMaybe :: MonadUnliftIO m => m a -> m (Maybe a) Source #

laxTimeout :: (HasCallStack, MonadUnliftIO m) => Int -> m a -> m (Maybe a) Source #

laxTimeout' :: (HasCallStack, MonadUnliftIO m) => Int -> m a -> m a Source #

newtype DodgyEq a Source #

A wrapper to provide Eq for types which only have Show.

Constructors

DodgyEq
Fields unDodgyEq :: a

Instances

Instances details

Show (DodgyEq a) Source #
Instance details Defined in System.Taffybar.Test.UtilSpec Methods showsPrec :: Int -> DodgyEq a -> ShowS Source # show :: DodgyEq a -> String Source # showList :: [DodgyEq a] -> ShowS Source #
Eq (DodgyEq a) Source #
Instance details Defined in System.Taffybar.Test.UtilSpec Methods (==) :: DodgyEq a -> DodgyEq a -> Bool Source # (/=) :: DodgyEq a -> DodgyEq a -> Bool Source #

Logging for tests

logSetup :: HasCallStack => SpecWith a -> SpecWith a Source #

Setup logging before running the specs.

specLogSetup :: IO () Source #

Get log levels from environment variables and set up formatters.

specLogSetupPrio :: Priority -> IO () Source #

Like specLogSetup, but with a default minimum priority.

specLog :: MonadIO m => String -> m () Source #

Log a test message.

specLogAt :: MonadIO m => Priority -> String -> m () Source #

Log a test message at the given level.

getSpecLogPriority :: MonadIO m => m Priority Source #

Find out the configured log level for specs.

data Priority Source #

Priorities are used to define how important a log message is. Users can filter log messages based on priorities.

These have their roots on the traditional syslog system. The standard definitions are given below, but you are free to interpret them however you like. They are listed here in ascending importance order.

Constructors

DEBUG	Debug messages
INFO	Information
NOTICE	Normal runtime conditions
WARNING	General Warnings
ERROR	General Errors
CRITICAL	Severe situations
ALERT	Take immediate action
EMERGENCY	System is unusable