Test.Hspec.Dirstream

Documentation

testFiles

Arguments

:: (Eq a, Show a)

=> FilePath

Base directory

-> (FilePath -> Bool)

Filter on file extensions

-> (String -> Either a String)

Function to process a file

-> SpecWith ()

Helper function to generate a spec. The spec runs on the given directory, filtering by the given function. It then compares their output to the text of the file with .out as the new extension.

As an example, consider the directory structure

test/data
├── file.hs
└── file.out

If we have a function called formatFile and we run

testFiles "test/data" (hasExtension "hs") formatFile

This would read test/data/file.hs, format the file if it can, and compare the output to the contents of test/data/file.out.

testFilesErr :: (Show b, Eq b) => FilePath -> PathFilter -> (String -> Either String b) -> SpecWith ()

This function simply tests that each file returns a Left value and that the error message contained therein matches the contents of the appropriate file.

testFilesIO :: FilePath -> PathFilter -> (String -> IO String) -> SpecWith ()

testFilesPure :: (Show b, Eq b) => FilePath -> PathFilter -> PathProducer -> FileProcessor a b -> SpecWith ()

A very general means of testing files, where the check function is pure.

Configuration helper functions

dirFiles :: PathProducer

allFiles :: PathProducer

Helper functions for dealing with file extensions

extension :: FilePath -> Maybe Text

Get a FilePath’s last extension, or Nothing if it has no extensions.

hasExtension :: Text -> FilePath -> Bool

Types and type synonyms

data FileProcessor a b

Constructors

FileProc

Fields

• reader :: FilePath -> IO a

  A function to read files

• processor :: a -> b

  A function to process files after they have been read

• check :: b -> Bool

  A predicate to check the output.

type PathFilter = FilePath -> Bool

type Recursor = FilePath -> ListT SafeSpecM FilePath

type PathProducer = String -> PathFilter -> Producer String SafeSpecM ()

type SafeSpecM = SafeT (SpecM ())

Orphan instances

MonadIO (SpecM a)

Methods

liftIO :: IO a -> SpecM a a

MonadThrow (SpecM a)

Methods

throwM :: Exception e => e -> SpecM a a

MonadCatch (SpecM a)

Methods

catch :: Exception e => SpecM a a -> (e -> SpecM a a) -> SpecM a a

MonadMask (SpecM a)

Methods

mask :: ((forall b. SpecM a b -> SpecM a b) -> SpecM a b) -> SpecM a b

uninterruptibleMask :: ((forall b. SpecM a b -> SpecM a b) -> SpecM a b) -> SpecM a b

generalBracket :: SpecM a a -> (a -> ExitCase b -> SpecM a c) -> (a -> SpecM a b) -> SpecM a (b, c)