Write unit and fuzz tests for your Elm code, in Elm.
Elm JavaScript
Latest commit 73335af Feb 19, 2017 @mgold mgold committed on GitHub Merge pull request #126 from elm-community/refactor-fuzz-test-runner
Refactor fuzz test runner

README.md

elm-test Travis build Status

Write unit and fuzz tests for your Elm code, in Elm.

Quick Start

Here are three example tests:

suite : Test
suite =
    describe "The String module"
        [ describe "String.reverse" -- Nest as many descriptions as you like.
            [ test "has no effect on a palindrome" <|
                \() ->
                    let
                        palindrome =
                            "hannah"
                    in
                        Expect.equal palindrome (String.reverse palindrome)

            -- Expect.equal is designed to be used in pipeline style, like this.
            , test "reverses a known string" <|
                \() ->
                    "ABCDEFG"
                        |> String.reverse
                        |> Expect.equal "GFEDCBA"

            -- fuzz runs the test 100 times with randomly-generated inputs!
            , fuzz string "restores the original string if you run it again" <|
                \randomlyGeneratedString ->
                    randomlyGeneratedString
                        |> String.reverse
                        |> String.reverse
                        |> Expect.equal randomlyGeneratedString
            ]
        ]

This code uses a few common functions:

  • describe to add a description string to a list of tests
  • test to write a unit test
  • Expect to determine if a test should pass or fail
  • fuzz to run a function that produces a test several times with randomly-generated inputs

Check out a large real-world test suite for more.

Running tests locally

There are several ways you can run tests locally:

Here's how to set up and run your tests using the CLI test runner:

  1. Run npm install -g elm-test if you haven't already.
  2. cd into the project's root directory that has your elm-package.json.
  3. Run elm-test init. It will create a tests directory inside this one, with some files in it.
  4. Copy all the dependencies from elm-package.json into tests/elm-package.json. These dependencies need to stay in sync, so make sure whenever you change your dependencies in your current elm-package.json, you make the same change to tests/elm-package.json.
  5. Run elm-test.
  6. Edit tests/Tests.elm to introduce new tests.

Running tests on CI

Here are some examples of running tests on CI servers:

Strategies for effective testing

  • Make impossible states unrepresentable so that you don't have to test that they can't occur.
  • When doing TDD, treat compiler errors as a red test. So feel free to write the test you wish you had even if it means calling functions that don't exist yet!
  • How do you know when to stop testing? This is an engineering tradeoff without a perfect answer. If you don't feel confident in the correctness of your code, write more tests. If you feel you are wasting time testing better spent writing your application, stop writing tests for now.
  • Prefer fuzz tests to unit tests, when possible. But don't be afraid to supplement them with unit tests for tricky cases and regressions.
  • For simple functions, it's okay to copy the implementation to the test; this is a useful regression check. But if the implementation isn't obviously right, try to write tests that don't duplicate the suspect logic. The great thing about fuzz tests is that you don't have to arrive at the exact same value as the code under test, just state something that will be true of that value.
  • If you're writing a library that wraps an existing standard or protocol, use examples from the specification or docs as unit tests. Anything in your README should be backed by a unit test (sadly there's no easy way to keep them in sync).
  • Not even your test modules can import unexposed functions, so test them only as the exposed interface uses them. Don't expose a function just to test it. Every exposed function should have tests. (If you practice TDD, this happens automatically!)
  • elm-test is designed to test functions, but you can also test views using elm-html-test. For integration or end-to-end testing, use your favorite PhantomJS or Selenium webdriver, such as Capybara.

Upgrading

From 0.17

You will need to delete elm-stuff and tests/elm-stuff.

If you are using the Node runner, you will need to install the latest version (npm update -g elm-test) and pull down the new Main.elm: curl -o tests/Main.elm https://raw.githubusercontent.com/rtfeldman/node-test-runner/master/templates/Main.elm

From the old elm-test

legacy-elm-test provides a drop-in replacement for the ElmTest 1.0 API, except implemented in terms of the current elm-test. It also includes support for elm-check tests.

This lets you use the latest test runners right now, and upgrade incrementally.

Releases

Version Notes
3.1.0 Add Expect.all
3.0.0 Update for Elm 0.18; switch the argument order of Fuzz.andMap.
2.1.0 Switch to rose trees for Fuzz.andThen, other API additions.
2.0.0 Scratch-rewrite to project-fuzzball
1.0.0 ElmTest initial release