Copyright	(C) 2017 Merijn Verstraaten
License	BSD-style (see the file LICENSE)
Maintainer	Merijn Verstraaten <merijn@inconsistent.nl>
Stability	experimental
Portability	haha
Safe Haskell	Trustworthy
Language	Haskell2010

Test.Tasty.Travis

Description

Travis CI support for tasty.

This module provides a tasty test reporter which functions as a drop-in replacement for defaultMainWithIngredients from tasty. It detects whether the "TRAVIS" environment variable is set to "true". If so, it produces output as configured. If not, it falls back to the consoleTestReporter.

Synopsis

travisTestReporter :: TravisConfig -> [Ingredient] -> TestTree -> IO ()
data TravisConfig = TravisConfig {
- travisQuiet :: Bool
- travisHideSuccesses :: Bool
- travisUseColour :: Bool
- travisFoldGroup :: FoldGroup
- travisFoldWhen :: FoldWhen
- travisSummaryWhen :: SummaryWhen
- travisTestOptions :: OptionSet -> OptionSet
}
defaultConfig :: TravisConfig
data FoldGroup
- = FoldMoreThan Int
- | FoldBelow Int
- | FoldTop Int
- | FoldAll
data FoldWhen
- = FoldNever
- | FoldSuccess
- | FoldAlways
data SummaryWhen
- = SummaryNever
- | SummaryFailures
- | SummaryAlways

Documentation

travisTestReporter :: TravisConfig -> [Ingredient] -> TestTree -> IO () Source #

A Tasty test runner whose output can be controlled with a TravisConfig. Defaults to the regular console reporting when the TRAVIS environment variable is not set to "true".

Usage:

travisTestReporter yourConfig [] yourTestTree

data TravisConfig Source #

Configuration for the output generated on Travis CI.

Constructors

TravisConfig

Fields

travisQuiet :: Bool
Do not report individual tests, only overall pass/fail Statistics.
travisHideSuccesses :: Bool
If True, only report failures.
travisUseColour :: Bool
If True, generate coloured output
travisFoldGroup :: FoldGroup
How to group folds.
travisFoldWhen :: FoldWhen
When to fold.
travisSummaryWhen :: SummaryWhen
When to print a summary for a fold.
travisTestOptions :: OptionSet -> OptionSet
Set/unset options when running on Travis. Functions like PlusTestOptions when running on Travis, does nothing otherwise.

defaultConfig :: TravisConfig Source #

Default Travis configuration. Coloured output. Folds all successes away. Adds summaries for folds with failures (which don't happen in this config).

data FoldGroup Source #

Control which parts of the test tree are folded away.

Constructors

FoldMoreThan Int	Fold groups with more than N entries (groups or tests).
FoldBelow Int	Fold groups more than N levels from the root.
FoldTop Int	Fold groups N or less levels from the root.
FoldAll	Fold all groups.

Instances

Eq FoldGroup Source #
Instance details Methods (==) :: FoldGroup -> FoldGroup -> Bool # (/=) :: FoldGroup -> FoldGroup -> Bool #
Show FoldGroup Source #
Instance details Methods showsPrec :: Int -> FoldGroup -> ShowS # show :: FoldGroup -> String # showList :: [FoldGroup] -> ShowS #

data FoldWhen Source #

Control when the tests/groups specified by FoldGroup are folded.

Constructors

FoldNever	Never fold output.
FoldSuccess	Fold all groups that have 0 failures.
FoldAlways	Always fold groups.

Instances

Eq FoldWhen Source #
Instance details Methods (==) :: FoldWhen -> FoldWhen -> Bool # (/=) :: FoldWhen -> FoldWhen -> Bool #
Show FoldWhen Source #
Instance details Methods showsPrec :: Int -> FoldWhen -> ShowS # show :: FoldWhen -> String # showList :: [FoldWhen] -> ShowS #

data SummaryWhen Source #

Control when a summary is printed before a fold.

Constructors

SummaryNever	Never print summaries.
SummaryFailures	Print summaries before folds with failures.
SummaryAlways	Always print summaries before folds.

Instances

Eq SummaryWhen Source #
Instance details Methods (==) :: SummaryWhen -> SummaryWhen -> Bool # (/=) :: SummaryWhen -> SummaryWhen -> Bool #
Show SummaryWhen Source #
Instance details Methods showsPrec :: Int -> SummaryWhen -> ShowS # show :: SummaryWhen -> String # showList :: [SummaryWhen] -> ShowS #