Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.Tasty.Extras

Synopsis

newtype Layer a r = Layer {
- unLayer ∷ F ((,) a) r
}
embed ∷ MonadFree ((,) a) m ⇒ a → m ()
nestWith ∷ ([a] → a) → Layer a () → Layer a ()
newtype TestNestedM r = TestNestedM {
- unTestNestedM ∷ ReaderT [FilePath] (Layer TestTree) r
}
type TestNested = TestNestedM ()
runTestNestedM ∷ [String] → TestNested → TestTree
testNestedNamedM ∷ FilePath → String → TestNested → TestNested
testNestedM ∷ FilePath → TestNested → TestNested
testNestedGhcM ∷ TestNested → TestNested
runTestNested ∷ [String] → [TestNested] → TestTree
testNestedNamed ∷ FilePath → String → [TestNested] → TestNested
testNested ∷ FilePath → [TestNested] → TestNested
testNestedGhc ∷ [TestNested] → TestNested
goldenVsText ∷ TestName → FilePath → Text → TestTree
goldenVsTextM ∷ TestName → FilePath → IO Text → TestTree
goldenVsDoc ∷ TestName → FilePath → Doc ann → TestTree
goldenVsDocM ∷ TestName → FilePath → IO (Doc ann) → TestTree
nestedGoldenVsText ∷ TestName → FilePath → Text → TestNested
nestedGoldenVsTextPredM ∷ TestName → FilePath → IO Text → (Text → Text → Bool) → TestNested
nestedGoldenVsTextM ∷ TestName → FilePath → IO Text → TestNested
nestedGoldenVsDoc ∷ TestName → FilePath → Doc ann → TestNested
nestedGoldenVsDocM ∷ TestName → FilePath → IO (Doc ann) → TestNested
makeVersionedFilePath ∷ [FilePath] → FilePath → FilePath

Documentation

newtype Layer a r Source #

A monad allowing one to emit elements of type a. Semantically equivalent to Writer (DList a) r, but:

is faster, being based on the Church-encoded free monad
implements Monoid, so that all the Data.Foldable convenience is supported
has better ergonomics as it doesn't require the user to wrap a values into DLists

This type is also semantically equivalent to Stream (Of a) Identity r.

Useful for monadically creating tree-like structures, for example the following

import Data.Tree
yield = embed . pure
main = putStrLn . drawTree . Node "a" . toList $ do
    yield "b"
    nestWith (Node "c") $ do
        yield "d"
        yield "e"
    yield "f"

will produce

-a
|
+- b
|
+- c
|  |
|  +- d
|  |
|  `- e
|
`- f

Constructors

Layer
Fields unLayer ∷ F ((,) a) r

Instances

Instances details

Applicative (Layer a) Source #
Instance details Defined in Test.Tasty.Extras Methods pure ∷ a0 → Layer a a0 Source # (<>) ∷ Layer a (a0 → b) → Layer a a0 → Layer a b Source # liftA2 ∷ (a0 → b → c) → Layer a a0 → Layer a b → Layer a c Source # (>) ∷ Layer a a0 → Layer a b → Layer a b Source # (<*) ∷ Layer a a0 → Layer a b → Layer a a0 Source #
Functor (Layer a) Source #
Instance details Defined in Test.Tasty.Extras Methods fmap ∷ (a0 → b) → Layer a a0 → Layer a b Source # (<$) ∷ a0 → Layer a b → Layer a a0 Source #
Monad (Layer a) Source #
Instance details Defined in Test.Tasty.Extras Methods (>>=) ∷ Layer a a0 → (a0 → Layer a b) → Layer a b Source # (>>) ∷ Layer a a0 → Layer a b → Layer a b Source # return ∷ a0 → Layer a a0 Source #
MonadFree ((,) a) (Layer a) Source #
Instance details Defined in Test.Tasty.Extras Methods wrap ∷ (a, Layer a a0) → Layer a a0 Source #
unit ~ () ⇒ Monoid (Layer a unit) Source #
Instance details Defined in Test.Tasty.Extras Methods mempty ∷ Layer a unit Source # mappend ∷ Layer a unit → Layer a unit → Layer a unit Source # mconcat ∷ [Layer a unit] → Layer a unit Source #
unit ~ () ⇒ Semigroup (Layer a unit) Source #
Instance details Defined in Test.Tasty.Extras Methods (<>) ∷ Layer a unit → Layer a unit → Layer a unit Source # sconcat ∷ NonEmpty (Layer a unit) → Layer a unit Source # stimes ∷ Integral b ⇒ b → Layer a unit → Layer a unit Source #
unit ~ () ⇒ IsList (Layer a unit) Source #
Instance details Defined in Test.Tasty.Extras Associated Types type Item (Layer a unit) Source # Methods fromList ∷ [Item (Layer a unit)] → Layer a unit Source # fromListN ∷ Int → [Item (Layer a unit)] → Layer a unit Source # toList ∷ Layer a unit → [Item (Layer a unit)] Source #
type Item (Layer a unit) Source #
Instance details Defined in Test.Tasty.Extras type Item (Layer a unit) = a

embed ∷ MonadFree ((,) a) m ⇒ a → m () Source #

Embed the given value into a Layer-like type (either Layer itself or a monad transformer stack with Layer at the bottom).

nestWith ∷ ([a] → a) → Layer a () → Layer a () Source #

Collapse the given Layer into a single element by converting it into a list, applying the given function to the result and embedding it back.

newtype TestNestedM r Source #

Constructors

TestNestedM
Fields unTestNestedM ∷ ReaderT [FilePath] (Layer TestTree) r

Instances

Instances details

Applicative TestNestedM Source #
Instance details Defined in Test.Tasty.Extras Methods pure ∷ a → TestNestedM a Source # (<>) ∷ TestNestedM (a → b) → TestNestedM a → TestNestedM b Source # liftA2 ∷ (a → b → c) → TestNestedM a → TestNestedM b → TestNestedM c Source # (>) ∷ TestNestedM a → TestNestedM b → TestNestedM b Source # (<*) ∷ TestNestedM a → TestNestedM b → TestNestedM a Source #
Functor TestNestedM Source #
Instance details Defined in Test.Tasty.Extras Methods fmap ∷ (a → b) → TestNestedM a → TestNestedM b Source # (<$) ∷ a → TestNestedM b → TestNestedM a Source #
Monad TestNestedM Source #
Instance details Defined in Test.Tasty.Extras Methods (>>=) ∷ TestNestedM a → (a → TestNestedM b) → TestNestedM b Source # (>>) ∷ TestNestedM a → TestNestedM b → TestNestedM b Source # return ∷ a → TestNestedM a Source #
unit ~ () ⇒ Monoid (TestNestedM unit) Source #
Instance details Defined in Test.Tasty.Extras Methods mempty ∷ TestNestedM unit Source # mappend ∷ TestNestedM unit → TestNestedM unit → TestNestedM unit Source # mconcat ∷ [TestNestedM unit] → TestNestedM unit Source #
unit ~ () ⇒ Semigroup (TestNestedM unit) Source #
Instance details Defined in Test.Tasty.Extras Methods (<>) ∷ TestNestedM unit → TestNestedM unit → TestNestedM unit Source # sconcat ∷ NonEmpty (TestNestedM unit) → TestNestedM unit Source # stimes ∷ Integral b ⇒ b → TestNestedM unit → TestNestedM unit Source #
MonadFree ((,) TestTree) TestNestedM Source #
Instance details Defined in Test.Tasty.Extras Methods wrap ∷ (TestTree, TestNestedM a) → TestNestedM a Source #
MonadReader [FilePath] TestNestedM Source #
Instance details Defined in Test.Tasty.Extras Methods ask ∷ TestNestedM [FilePath] Source # local ∷ ([FilePath] → [FilePath]) → TestNestedM a → TestNestedM a Source # reader ∷ ([FilePath] → a) → TestNestedM a Source #

type TestNested = TestNestedM () Source #

A TestTree of tests under some name prefix.

runTestNestedM ∷ [String] → TestNested → TestTree Source #

Run a TestNested computation to produce a TestTree (without actually executing the tests).

testNestedNamedM Source #

Arguments

∷ FilePath	The name of the folder.
→ String	The name of the test group to render in CLI.
→ TestNested
→ TestNested

Descend into a folder.

testNestedM ∷ FilePath → TestNested → TestNested Source #

Descend into a folder for a TestNested computation.

testNestedGhcM ∷ TestNested → TestNested Source #

Like testNestedM but adds a subdirectory corresponding to the GHC version being used.

runTestNested ∷ [String] → [TestNested] → TestTree Source #

Run a list of TestNested computation to produce a TestTree (without actually executing the tests).

testNestedNamed Source #

Arguments

∷ FilePath	The name of the folder.
→ String	The name of the test group to render in CLI.
→ [TestNested]
→ TestNested

Descend into a folder for a list of tests.

testNested ∷ FilePath → [TestNested] → TestNested Source #

Descend into a folder for a list of TestNested computations.

testNestedGhc ∷ [TestNested] → TestNested Source #

Like testNested but adds a subdirectory corresponding to the GHC version being used.

goldenVsText ∷ TestName → FilePath → Text → TestTree Source #

Check the contents of a file against a Text.

goldenVsTextM ∷ TestName → FilePath → IO Text → TestTree Source #

Check the contents of a file against a Text.

goldenVsDoc ∷ TestName → FilePath → Doc ann → TestTree Source #

Check the contents of a file against a Doc.

goldenVsDocM ∷ TestName → FilePath → IO (Doc ann) → TestTree Source #

Check the contents of a file against a Doc.

nestedGoldenVsText ∷ TestName → FilePath → Text → TestNested Source #

Check the contents of a file under a name prefix against a Text.

nestedGoldenVsTextPredM Source #

Arguments

∷ TestName	The name of the test
→ FilePath	The file extension
→ IO Text	The text-producing action to execute
→ (Text → Text → Bool)	How to compare golden file contents with the produced text
→ TestNested

Compare the contents of a file under a name prefix against a Text using a predicate.

nestedGoldenVsTextM ∷ TestName → FilePath → IO Text → TestNested Source #

Check the contents of a file under a name prefix against a Text.

nestedGoldenVsDoc ∷ TestName → FilePath → Doc ann → TestNested Source #

Check the contents of a file under a name prefix against a Text.

nestedGoldenVsDocM ∷ TestName → FilePath → IO (Doc ann) → TestNested Source #

Check the contents of a file under a name prefix against a Text.

makeVersionedFilePath ∷ [FilePath] → FilePath → FilePath Source #

Given a lists of FilePaths and a filename, concatenate the members of the list together, append the GHC version number, then append the filename. We use this to create GHC-version-dependent golden files.