Test.Hspec.JUnit.Config

Documentation

data JUnitConfig

Construction

defaultJUnitConfig :: Text -> JUnitConfig

Construct a JUnitConfig given a suite name

See individual set functions for defaults.

setJUnitConfigOutputDirectory :: FilePath -> JUnitConfig -> JUnitConfig

Set the directory within which to generate the report

Default is current working directory.

setJUnitConfigOutputName :: FilePath -> JUnitConfig -> JUnitConfig

Set the name for the generated report

Default is junit.xml.

setJUnitConfigOutputFile :: FilePath -> JUnitConfig -> JUnitConfig

Set the full path to the generated report

If given, the directory and name configurations are ignored.

setJUnitConfigSuiteName :: Text -> JUnitConfig -> JUnitConfig

setJUnitConfigSourcePathPrefix :: FilePath -> JUnitConfig -> JUnitConfig

Set a prefix to apply to source paths in the report

Default is none. This can be required if you run specs from a sub-directory in a monorepository, and you need reported paths to be from the repository root.

Use

getJUnitConfigOutputFile :: JUnitConfig -> FilePath

Retrieve the full path to the generated report

getJUnitConfigSuiteName :: JUnitConfig -> Text

Retrieve the suite name given on construction

getJUnitPrefixSourcePath :: JUnitConfig -> FilePath -> FilePath

Retrieve the function to apply to reported source paths

Will be id if no prefix configured.