Test.Hspec.Golden · hspec-golden-0.2.2.0

datadata Golden str

Golden tests parameters

import           Data.Text (Text)
import qualified Data.Text.IO as T

goldenText :: String -> Text -> Golden Text
goldenText name actualOutput =
  Golden {
    output = actualOutput,
    encodePretty = prettyText,
    writeToFile = T.writeFile,
    readFromFile = T.readFile,
    goldenFile = ".specific-golden-dir" / name / "golden",
    actualFile = Just (".specific-golden-dir" / name / "actual"),
    failFirstTime = False
  }

describe "myTextFunc" $
  it "generates the right output with the right params" $
    goldenText "myTextFunc" (myTextFunc params)

Constructors

Golden
- output :: str
  Output
- encodePretty :: str -> String
  Makes the comparison pretty when the test fails
- writeToFile :: FilePath -> str -> IO ()
  How to write into the golden file the file
- readFromFile :: FilePath -> IO str
  How to read the file,
- goldenFile :: FilePath
  Where to read/write the golden file for this test.
- actualFile :: Maybe FilePath
  Where to save the actual file for this test. If it is Nothing then no file is written.
- failFirstTime :: Bool
  Whether to record a failure the first time this test is run

Instances8Example, Arg, …

Eq str => Example (IO (Golden str))Defined in hspec-golden-0.2.2.0 · Test.Hspec.Golden
Eq str => Example (Golden str)Defined in hspec-golden-0.2.2.0 · Test.Hspec.Golden
Eq str => Example (arg -> IO (Golden str))Defined in hspec-golden-0.2.2.0 · Test.Hspec.Golden
Eq str => Example (arg -> Golden str)Defined in hspec-golden-0.2.2.0 · Test.Hspec.Golden
type Arg (IO (Golden str)) = ()Defined in hspec-golden-0.2.2.0 · Test.Hspec.Golden
type Arg (Golden str) = ()Defined in hspec-golden-0.2.2.0 · Test.Hspec.Golden
type Arg (arg -> IO (Golden str)) = argDefined in hspec-golden-0.2.2.0 · Test.Hspec.Golden
type Arg (arg -> Golden str) = argDefined in hspec-golden-0.2.2.0 · Test.Hspec.Golden

valuedefaultGolden :: String -> String -> Golden String

#

An example of Golden tests which output is String

 describe "html" $ do
   context "given a valid generated html" $
     it "generates html" $
       defaultGolden "html" someHtml

valuegolden

:: String
Test description
-> IO String
Content (return content for pure functions)
-> Spec

#

A helper function to create a golden test.

 describe "function" $
   golden "some name" $
     return content