Conferer

Conferer

  • Get Started
  • Tutorial
  • Docs

›FromConfig

Quickstart

  • Getting started

Tutorial

  • Quick tutorial
  • Multiple configs and generics

Core concepts

  • Core concepts
  • Sources
  • FromConfig

Sources

  • Basic Sources
  • Util sources
  • Json source
  • Dhall source
  • Yaml source

FromConfig

  • List FromConfig
  • File FromConfig
  • Overriding any FromConfig
  • Aeson (JSON) FromConfig
  • Warp FromConfig
  • Snap FromConfig
  • Hspec FromConfig
  • Hedis FromConfig
Edit

Hspec FromConfig

Hspec FromConfig

This FromConfig instance provides support for parsing Hspec's Config.

Configurable values

ignoreConfigFile :: Bool

Ignore .hspec config files

Default: False

dryRun :: Bool

Do a dry run instead of actually running the tests

Default: False

focusedOnly :: Bool

Run tests only if they are focused

Default: False

failOnFocused :: Bool

Fail if any test is focused

Default: False

printCpuTime :: Bool

Print the cpu runtime at the end of the tests

Default: False

fastFail :: Bool

Fail whole suite as soon as any test fails

Default: False

randomize :: Bool

Randomize execution order

Default: False

failureReport :: Maybe FilePath

Specify path for hspec to report errors

Default: Nothing

rerun :: Bool

rerun all examples that failed in the previous test run

Default: False

rerunAllOnSuccess :: Bool

run the whole test suite after a previously failing rerun succeeds for the first time

Default: False

filterPredicate :: Maybe (Path -> Bool) (NOT CONFIGURABLE BY USER YET)

A predicate that is used to filter the spec before it is run. Only examples that satisfy the predicate are run.

Default: Nothing

skipPredicate :: Maybe (Path -> Bool) (NOT CONFIGURABLE BY USER YET)

A predicate that is used to filter the spec before it is run. Only examples that satisfy the predicate are run.

Default: ``

quickCheckSeed :: Maybe Integer

The seed for quickcheck. Nothing means it's random

Default: Nothing

quickCheckMaxSuccess :: Maybe Int

Maximum successful runs to quit. Nothing means no limit

Default: Nothing

quickCheckMaxDiscardRatio :: Maybe Int

Maximum discard ration for quickcheck. Nothing means no limit.

Default: Nothing

quickCheckMaxSize :: Maybe Int

Maximum check size for quickcheck. Nothing means no limit.

Default: Nothing

smallCheckDepth :: Int

Depth for smallcheck.

Default: 5 extracted from smallcheck's defaults

colorMode :: ColorMode

Whether tests results should be printed with colors, may be one of the following:

  • auto: Use colors only when terminal emulator supports it
  • always: Always use colors
  • never: Never use colors

Default: auto

diff :: Bool

Show colorized diffs.

Default: True

formatter :: Maybe Formatter

Formatter for test results, Nothing means using the default formatter (deprecated after hspec >= 2.8.0, use format)

  • silent: Hide details from each test and only print summary
  • specdoc: Show all test names in a hierarchical structure colored acording to test results
  • progress: Show dots as tests progress
  • failed-examples: Only show list of failed tests
  • checks: Show all test names in a hierarchical structure using unicode checks for test results (requires hspec >= 2.7.10).

Default: Nothing

htmlOutput :: Bool

Use html format as output.

Default: False

outputFile :: Either Handle FilePath

Where should the hspec results end up, deprecated after hspec >= 2.8.0

Default: Left stdout

concurrentJobs :: Maybe Int

Number of concurrent jobs to use, Nothing means numbers of cpus

Default: Nothing

randomize :: Bool

Randomize execution order

Default: False

printSlowItems :: Integer

Print the N slowest spec items

Default: 10

quickCheckMaxShrinks :: Maybe Int

Max shrink for quickcheck

Default: Nothing

times :: Bool

Report times for individual spec items

Default: False

format :: Maybe (FormatConfig -> IO Format)

Similar to formatter and will replace it at some point.

Although it's a function it has some well known defaults that can be configured using strings.

  • silent: Hide details from each test and only print summary
  • specdoc: Show all test names in a hierarchical structure colored acording to test results
  • progress: Show dots as tests progress
  • failed-examples: Only show list of failed tests
  • checks: Show all test names in a hierarchical structure using unicode checks for test results (requires hspec >= 2.7.10).

Default: Nothing

Last updated on 8/3/2021 by Lucas David Traverso
← Snap FromConfigHedis FromConfig →
  • Hspec FromConfig
  • Configurable values
    • ignoreConfigFile :: Bool
    • dryRun :: Bool
    • focusedOnly :: Bool
    • failOnFocused :: Bool
    • printCpuTime :: Bool
    • fastFail :: Bool
    • randomize :: Bool
    • failureReport :: Maybe FilePath
    • rerun :: Bool
    • rerunAllOnSuccess :: Bool
    • filterPredicate :: Maybe (Path -> Bool) (NOT CONFIGURABLE BY USER YET)
    • skipPredicate :: Maybe (Path -> Bool) (NOT CONFIGURABLE BY USER YET)
    • quickCheckSeed :: Maybe Integer
    • quickCheckMaxSuccess :: Maybe Int
    • quickCheckMaxDiscardRatio :: Maybe Int
    • quickCheckMaxSize :: Maybe Int
    • smallCheckDepth :: Int
    • colorMode :: ColorMode
    • diff :: Bool
    • formatter :: Maybe Formatter
    • htmlOutput :: Bool
    • outputFile :: Either Handle FilePath
    • concurrentJobs :: Maybe Int
    • randomize :: Bool
    • printSlowItems :: Integer
    • quickCheckMaxShrinks :: Maybe Int
    • times :: Bool
    • format :: Maybe (FormatConfig -> IO Format)
Conferer
Docs
Quick TutorialCore Concepts
Community
Issue tracker
More
GitHub
Copyright © 2024 Lucas David Traverso