The HTF package

[Tags:lgpl, library, program, test]

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.

The documentation of the Test.Framework.Tutorial module provides a tutorial for HTF. There is also a slightly out-dated blog article (http://factisresearch.blogspot.de/2011/10/new-version-of-htf-with-diffs-colors.html) demonstrating HTF's coloring, pretty-printing and diff functionality.

HEADS UP, backwards incomatibility with prior versions:

In version 0.10.0.0, the following changes could break code compiled against version 0.9.*:

Test.Framework now longer exports all of Test.Framework.TestManager and Test.Framework.BlackBoxTest. For modules that only define tests, no changes should be necessary. However, you likely need to adjust your test runner module by importing Test.Framework.TestManager and possibly Test.Framework.BlackBoxTest.
Some reorganization in Test.Framework.TestManager and related modules, introduction of Test.Framework.TestTypes. Usually, your code should not be affected by these changes.

Starting with version 0.9.0.0, HTF uses a new strategy for collecting the testcases defined in your project (see Test.Framework.Tutorial for a description of this strategy). If you used version 0.8.* or earlier of HTF, this will break your build! However, it's rather easy to bring you project in line with the new HTF version. Here are the steps that will most likely resolve your backwards incompatibility problems:

If a module exports the allHTFTests symbol, this export must be changed to htf_thisModulesTests.
If an import declaration of some module hides the allHTFTests symbol, you can simply remove the hiding clause for allHTFTests.
If a module collects and executes tests from several other modules, the collecting module has to be changed as follows: add {-# OPTIONS_GHC -F -pgmF htfpp #-} to the top of the collecting module, import the other modules with the {-@ HTF_TESTS @-} annotation, use the symbol htf_importedTests for referencing the imported tests. See Test.Framework.Tutorial for details.

[Skip to Readme]

Properties

Versions	0.1, 0.3, 0.3.1, 0.3.2, 0.3.3, 0.3.4, 0.3.5.0, 0.4.0.0, 0.5.0.0, 0.5.0.1, 0.6.0.0, 0.6.0.1, 0.7.0.0, 0.7.0.1, 0.7.1.0, 0.8.0.0, 0.8.1.0, 0.8.1.1, 0.8.2.0, 0.8.2.1, 0.8.2.2, 0.9.0.0, 0.10.0.0, 0.10.0.1, 0.10.0.2, 0.10.0.3, 0.10.0.4, 0.10.0.5, 0.10.0.6, 0.10.0.7, 0.11.0.0, 0.11.0.1, 0.11.1.0, 0.11.1.1, 0.11.2, 0.11.2.1, 0.11.3.0, 0.11.3.1, 0.11.3.2, 0.11.3.4, 0.11.4.0, 0.12.0.0, 0.12.1.0, 0.12.2.0, 0.12.2.1, 0.12.2.2, 0.12.2.3, 0.12.2.4, 0.13.0.0, 0.13.1.0
Change log	ChangeLog
Dependencies	aeson (>=0.6), array, base (==4.*), base64-bytestring, bytestring (>=0.9), containers (>=0.5), cpphs (>=1.19), Diff (>=0.3), directory (>=1.0), haskell-src, HTF, HUnit (>=1.2.5), lifted-base (>=0.1), monad-control (>=0.3), mtl (>=1.1), old-time (>=1.0), pretty (>=1.0), process (>=1.0), QuickCheck (>=2.3), random (>=1.0), regex-compat (>=0.92), text (>=0.11), time, unix (>=2.4), vector, xmlgen (>=0.6) [details]
License	LGPL
Copyright	(c) 2005-2015 Stefan Wehr
Author	Stefan Wehr <wehr@factisresearch.com>
Maintainer	Stefan Wehr <wehr@factisresearch.com>
Category	Testing
Home page	https://github.com/skogsbaer/HTF/
Bug tracker	https://github.com/skogsbaer/HTF/issues
Source repository	head: git clone http://github.com/skogsbaer/HTF.git
Uploaded	Fri Aug 21 23:19:28 UTC 2015 by StefanWehr
Distributions	LTSHaskell:0.13.1.0, NixOS:0.13.1.0, Stackage:0.13.1.0, Tumbleweed:0.13.1.0
Downloads	20121 total (104 in the last 30 days)
Votes	0 []
Status	Docs available [build log] Last success reported on 2015-08-21 [all 1 reports] Hackage Matrix CI

Downloads

HTF-0.13.1.0.tar.gz [browse] (Cabal source package)
Package description (included in the package)

Maintainer's Corner

For package maintainers and hackage trustees

edit package information

Readme for HTF

Readme for HTF-0.13.1.0

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 git@github.com: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.