Test.Syd.Def.Scenario

Define a test for each file in the given directory.

Subdirectories are ignored, use scenarioDirRecur to descend into them or scenarioDirOfDirs to treat each of them as a scenario.

If the directory is empty or absent, this defines a single failing test instead, because that usually means the scenario files were omitted by accident.

The scenario is given relative to the directory, so it is the name to say the test is about and joining it to the directory is what reads it. Neither has to be recovered from the other.

Example:

  let dir = [reldir|test_resources/even|]
  scenarioDir dir $ \rf ->
    it "contains an even number" $ do
      s <- readFile (fromRelFile (dir </> rf))
      n <- readIO s
      (n :: Int) `shouldSatisfy` even

Define a test for each file in the given directory, recursively.

If the directory contains no files, or is absent, this defines a single failing test instead, because that usually means the scenario files were omitted by accident.

Example:

  let dir = [reldir|test_resources/odd|]
  scenarioDirRecur dir $ \rf ->
    it "contains an odd number" $ do
      s <- readFile (fromRelFile (dir </> rf))
      n <- readIO s
      (n :: Int) `shouldSatisfy` odd

Define a test for each subdirectory of the given directory.

Use this when a single scenario consists of more than one file. Files in the given directory itself are ignored, and so is any nesting below the subdirectories: each subdirectory is one scenario, whatever it contains.

If there are no subdirectories, or the directory is absent, this defines a single failing test instead, because that usually means the scenarios were omitted by accident.

Example:

  let dir = [reldir|test_resources/same|]
  scenarioDirOfDirs dir $ \rd ->
    it "contains two files with the same contents" $ do
      a <- readFile (fromRelFile (dir </> rd </> [relfile|a|]))
      b <- readFile (fromRelFile (dir </> rd </> [relfile|b|]))
      a `shouldBe` b