Please see the documentation.


Changelog for sandwich

Unreleased changes

  • Add primed versions of createProcessWithLogging etc. with customizable log level
  • Add Test.Sandwich.Util.Process with gracefullyStopProcess and gracefullyWaitForProcess (and remove these from an internal sandwich-webdriver module).

  • Improve clock management; don’t keep incrementing it when nothing and restart it when r/R are pressed.

  • Allow any formatter except TUI to be used with –repeat N.
  • Be able to include timestamps with print formatter and failure report formatter.
  • Support vty-6.x/brick-2.x. This change adds Windows support, but forces us to do a major version bump.
  • Add timing info for setup and teardown; closes #10

  • Contexts: add pushContext and popContext helpers.

  • Logging: add readCreateProcessWithLogging

  • GHC 9.6 support

  • Windows improvements (fix “invalid argument (invalid character)”, fix console unicode output)
  • Add Alternative (ExampleT context m) instance

  • Prevent spurious messages in IOExceptions from withFile

  • Fix #61 (options not being passed from configured TUI formatter when --tui flag is used)

  • Add the –prune option (#69)

  • Be able to control sandwich-webdriver download directory.
  • Add flags to control sandwich-webdriver Selenium paths: --selenium-jar, --chrome-binary, --chromedriver-binary, --firefox-binary, --geckodriver-binary.

  • Improve semantics of multiple --filter/-f arguments. Now they get applied to the test tree sequentially.

  • Fix error symlink creation on Windows (don’t allow invalid characters).

  • Be able to accept multiple --filter/-f arguments. A test must match all of them to be run.
  • Windows support.

  • Initial release Test.Sandwich.Golden for golden testing.
  • Support Brick 1.x in addition to 0.x.

  • Add Markdown Summary formatter (useful with GitHub Actions)
  • Release sandwich-hedgehog compatibility.

  • Expose optionsDryRun and the --dry-run option.
  • Add command-line arguments for sandwich-quickcheck.
  • Add --visibility-threshold/-v option.
  • Fix an issue where TUI quit would hang in the presence of cleared results.
  • Display number of tests run in output message.
  • Catch and log exceptions in the TUI event loop.
  • Change runSandwichWithCommandLineArgs to use the print formatter by default, since we can’t figure out how to detect if we’re running under cabal test, which redirects stdout.

  • GHC 9 support

  • Add terminalUICustomExceptionFormatters.

  • Add parallelN for limiting the number of threads in a parallel.