This post explains how to configure your Haskell project for testing, using Cabal and Travis CI.
I’d like to learn Haskell, but I had a really hard time yesterday to setup the testing environment correctly. So I want to share my experience with you, to make life easier. In this post, we’ll go through the following steps:
- Adapt project structure to Cabal
- Configure test
- Enable Travis CI
Adapt Project Structure to Cabal
Cabal is a system for building and packaging Haskell libraries and
programs. Before this blog post, I didn’t know about Cabal and my project have
only 2 Haskell files on the top level folder. You can initialize the Cabal
structure and generate related files using interactive command line tool
cabal init. Once done, editing the
<project>.cabal file to
add or modify the content.
Then you need to move the Haskell source files *.hs into the
$ find src -type f
If everything works, try configuring and building the package:
$ cabal configure
$ cabal build
Install if it works:
$ cabal install
For the testing part, I followed Cabal’s documentation: §126.96.36.199 Test
suites. It’s very simple, just declare an additional section in your
<project>.cabal, as test-suite. (Note: replace test-suite by
test won’t work):
hs-source-dirs: src, test
In the above section, multiple fields have been declared:
typefield indicates the type of test-suite is exitcode-stdio-1.0. It means test suite can indicate test failure with a non-zero exit code when run. It may also provide human-readable log information through the standard output and error channels. The exitcode-stdio-1.0 type requires the
main-isfield indicates the main program to run.
hs-source-dirsfield indicates the haskell source directories are src and test.
build-dependsfield indicates the dependencies when building this module.
other-modulesfield indicates a list of modules used by the component but not exposed to users.
default-languagefield indicates the default language version. It should be aligned with the Library section.
Note: you must run
cabal install --enable-tests, then you can run
to run your tests.
Travis CI has a complet documentation page about Building a Haskell Project. In my case, I need to precise the language as Haskell, since Travis CI didn’t detect it correctly (without precision, it used Java and Gradle mistakenly). And I also flatten GHC versions list into oneline. Here’s the result: