ExUnit v1.5.1 ExUnit.Formatter View Source
Helper functions for formatting and the formatting protocols.
Formatters are GenServer
s specified during ExUnit configuration
that receive a series of events as casts.
The following events are possible:
{:suite_started, opts}
- the suite has started with the specified options to the runner.{:suite_finished, run_us, load_us}
- the suite has finished.run_us
andload_us
are the run and load times in microseconds respectively.{:case_started, test_case}
- a test case has started. SeeExUnit.TestCase
for details.{:case_finished, test_case}
- a test case has finished. SeeExUnit.TestCase
for details.{:test_started, test}
- a test has started. SeeExUnit.Test
for details.{:test_finished, test}
- a test has finished. SeeExUnit.Test
for details.
Link to this section Summary
Functions
Formats filters used to constrain cases to be run
Receives a test case and formats its failure
Receives a test and formats its failure
Formats time taken running the test suite
Link to this section Types
Link to this section Functions
Formats filters used to constrain cases to be run.
Examples
iex> format_filters([run: true, slow: false], :include)
"Including tags: [run: true, slow: false]"
Receives a test case and formats its failure.
Receives a test and formats its failure.
Formats time taken running the test suite.
It receives the time spent running the tests and optionally the time spent loading the test suite.
Examples
iex> format_time(10000, nil)
"Finished in 0.01 seconds"
iex> format_time(10000, 20000)
"Finished in 0.03 seconds (0.02s on load, 0.01s on tests)"
iex> format_time(10000, 200000)
"Finished in 0.2 seconds (0.2s on load, 0.01s on tests)"