ExUnit v1.0.5 ExUnit
Basic unit testing framework for Elixir.
Example
A basic setup for ExUnit is shown below:
# File: assertion_test.exs
# 1) Start ExUnit.
ExUnit.start
# 2) Create a new test module (test case) and use [`ExUnit.Case`](ExUnit.Case.html).
defmodule AssertionTest do
# 3) Notice we pass `async: true`, this runs the test case
# concurrently with other test cases
use ExUnit.Case, async: true
# 4) Use the `test` macro instead of `def` for clarity.
test "the truth" do
assert true
end
end
To run the tests above, run the file
using elixir
from the command line. Assuming you named the file
assertion_test.exs
, you can run it as:
bin/elixir assertion_test.exs
Case, Callbacks and Assertions
See ExUnit.Case
and ExUnit.Callbacks
for more information about defining test cases.
The ExUnit.Assertions
module contains
a set of macros to easily generate assertions with appropriate
error messages.
Integration with Mix
Mix is the project management and build tool for Elixir. Invoking mix test
from the command line will run the tests in each file matching the pattern
*_test.exs
found in the test
directory of your project.
You must create a test_helper.exs
file inside the
test
directory and put the code common to all tests there.
The minimum example of a test_helper.exs
file would be:
# test/test_helper.exs
ExUnit.start
Mix will load the test_helper.exs
file before executing the tests.
It is not necessary to require
the test_helper.exs
file in your test
files. See Mix.Tasks.Test
for more information.
Summary
Functions
Returns ExUnit configuration
Configures ExUnit
API used to run the tests. It is invoked automatically
if ExUnit is started via ExUnit.start/1
Starts ExUnit and automatically runs tests right before the
VM terminates. It accepts a set of options to configure ExUnit
(the same ones accepted by configure/1
)
Types
failed :: {Exception.kind, reason :: term, stacktrace :: [tuple]}
Functions
Configures ExUnit.
Options
ExUnit supports the following options:
:colors
- a keyword list of colors to be used by some formatters. The only option so far is[enabled: boolean]
which defaults toIO.ANSI.enabled?/1
:formatters
- the formatters that will print results; defaults to[ExUnit.CLIFormatter]
:max_cases
- maximum number of cases to run in parallel; defaults to:erlang.system_info(:schedulers_online)
:trace
- set ExUnit into trace mode, this sets:max_cases
to1
and prints each test case and test while running:autorun
- if ExUnit should run by default on exit; defaults totrue
:include
- specify which tests are run by skipping tests that do not match the filter:exclude
- specify which tests are run by skipping tests that match the filter:seed
- an integer seed value to randomize the test suite
API used to run the tests. It is invoked automatically
if ExUnit is started via ExUnit.start/1
.
Returns a map containing the number of tests and the number of failures.
Starts ExUnit and automatically runs tests right before the
VM terminates. It accepts a set of options to configure ExUnit
(the same ones accepted by configure/1
).
If you want to run tests manually, you can set :autorun
to false
.