Hackage :: [Package]

HTF: The Haskell Test Framework

[ lgpl, library, program, testing ] [ Propose Tags ]

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.

[Skip to Readme]
Versions [faq] 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, 0.13.2.1, 0.13.2.2, 0.13.2.4, 0.13.2.5
Change log ChangeLog
Dependencies aeson (>=0.11), 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-2.1-only
Copyright (c) 2005-2015 Stefan Wehr
Author Stefan Wehr <wehr@factisresearch.com>
Maintainer Stefan Wehr <wehr@factisresearch.com>
Revised Revision 1 made by HerbertValerioRiedel at Tue May 21 07:00:42 UTC 2019
Category Testing
Home page https://github.com/skogsbaer/HTF/
Bug tracker https://github.com/skogsbaer/HTF/issues
Source repo head: git clone http://github.com/skogsbaer/HTF.git
Uploaded by StefanWehr at Tue Nov 6 07:38:52 UTC 2018
Distributions LTSHaskell:0.13.2.5, NixOS:0.13.2.5, Stackage:0.13.2.5
Executables htfpp
Downloads 37772 total (973 in the last 30 days)
Rating 2.0 (votes: 1) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2018-11-06 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees

Readme for HTF-0.13.2.5

[back to package description]

HTF - The Haskell Test Framework

Build Status Hackage

Summary

The Haskell Test Framework (HTF for short) lets you define unit tests (http://hackage.haskell.org/package/HUnit), QuickCheck properties (https://hackage.haskell.org/package/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.