HTF

The Haskell Test Framework

Version on this page:	0.12.2.3
LTS Haskell 23.19:	0.15.0.2
Stackage Nightly 2025-04-30:	0.15.0.2
Latest on Hackage:	0.15.0.2

See all snapshots HTF appears in

LicenseRef-LGPL licensed and maintained by Stefan Wehr

This version can be pinned in stack with:HTF-0.12.2.3@sha256:c7aad428c156e734cbb156843246d8d483a3ded0c11df82f9e7cceba0b125a82,8425

Module documentation for 0.12.2.3

Test
- Test.Framework
  - Test.Framework.AssertM
  - Test.Framework.BlackBoxTest
  - Test.Framework.CmdlineOptions
  - Test.Framework.Colors
  - Test.Framework.HUnitWrapper
  - Test.Framework.History
  - Test.Framework.JsonOutput
  - Test.Framework.Location
  - Test.Framework.Preprocessor
  - Test.Framework.Pretty
  - Test.Framework.PrettyHaskell
  - Test.Framework.QuickCheckWrapper
  - Test.Framework.TestInterface
  - Test.Framework.TestManager
  - Test.Framework.TestReporter
  - Test.Framework.TestTypes
  - Test.Framework.ThreadPool
  - Test.Framework.Tutorial
  - Test.Framework.XmlOutput

Depends on 26 packages(full list with versions):

aeson, array, base, base64-bytestring, bytestring, containers, cpphs, Diff, directory, haskell-lexer, haskell-src, HUnit, lifted-base, monad-control, mtl, old-time, pretty, process, QuickCheck, random, regex-compat, text, time, unix, vector, xmlgen

HTF - The Haskell Test Framework

Documentation: http://hackage.haskell.org/package/HTF
Source Repository: https://github.com/skogsbaer/HTF/
Issue tracker: https://github.com/skogsbaer/HTF/issues?state=open
Author: Stefan Wehr (http://www.stefanwehr.de)
License: LGPL

Summary

The Haskell Test Framework (HTF for short) lets you define unit tests (http://hunit.sourceforge.net), QuickCheck properties (http://www.cs.chalmers.se/~rjmh/QuickCheck/), and black box tests in an easy and convenient way. HTF uses a custom preprocessor that collects test definitions automatically. Furthermore, the preprocessor allows HTF to report failing test cases with exact file name and line number information. Additionally, HTF tries to produce highly readable output for failing tests: for example, it colors and pretty prints expected and actual results and provides a diff between the two values.

Look here for a short tutorial on HTF. The following slightly out-dated blog article demonstrates HTF’s coloring, pretty-printing and diff functionality.

Installation instructions

Install from http://hackage.haskell.org/ using cabal install HTF

Install from source:

  $ git clone [email protected]:skogsbaer/HTF.git
  $ cd HTF
  $ cabal install

Getting started

Read the tutorial.
Experiment with the sample project located in the sample directory of HTF’s source tree.