HTF: The Haskell Test Framework

[ lgpl, library, program, testing ] [ Propose Tags ] [ Report a vulnerability ]

The Haskell Test Framework (HTF for short) lets you define and organize unit tests, QuickCheck properties, and black box tests in an easy and convenient way. HTF uses a custom preprocessor that collects test definitions automatically.

HTF produces highly readable output for failing test cases: it provides exact file name and line number information, it colors and pretty prints expected and actual results, and it displays a diff highlighting the mismatching parts.

The documentation of the Test.Framework.Tutorial module provides a tutorial for HTF. The sample directory in the HTF repo provides a good starting point for a project using HTF.


[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 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, 0.14.0.0, 0.14.0.1, 0.14.0.2, 0.14.0.3, 0.14.0.4, 0.14.0.5, 0.14.0.6, 0.14.0.7, 0.15.0.0, 0.15.0.1, 0.15.0.2
Change log ChangeLog
Dependencies aeson (>=0.11), array, base (>=4.10 && <5), 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]
Tested with ghc ==9.4.4, ghc ==9.2.6, ghc ==9.0.2, ghc ==8.10.7, ghc ==8.8.4, ghc ==8.6.5, ghc ==8.4.4, ghc ==8.2.2
License LGPL-2.1-only
Copyright (c) 2005-2024 Stefan Wehr
Author Stefan Wehr
Maintainer Stefan Wehr
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 2024-05-03T04:09:35Z
Distributions Arch:0.15.0.1, LTSHaskell:0.15.0.2, NixOS:0.15.0.2, Stackage:0.15.0.2
Reverse Dependencies 7 direct, 7 indirect [details]
Executables htfpp
Downloads 68819 total (98 in the last 30 days)
Rating 2.0 (votes: 1) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2024-05-03 [all 1 reports]

Readme for HTF-0.15.0.2

[back to package description]

HTF - The Haskell Test Framework

Build Status Hackage

Summary

The Haskell Test Framework (HTF for short) lets you define and organize 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.

HTF produces highly readable output for failing test cases: it provides exact file name and line number information, it colors and pretty prints expected and actual results, and it displays a diff highlighting the mismatching parts.

Getting started

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