eunit.3erl man page

eunit — This module is the main EUnit user interface.

Description

This module is the main EUnit user interface.

Exports

start() -> term()

Starts the EUnit server. Normally, you don't need to call this function; it is started automatically.

stop() -> term()

Stops the EUnit server. Normally, you don't need to call this function.

test(Tests) -> term()

Equivalent to test(Tests, []).

test(Tests::term(), Options::[term()]) -> ok | {error, term()}

Runs a set of tests. The format of Tests is described in the section EUnit test representation of the overview.

Example:

  eunit:test(fred)

runs all tests in the module fred and also any tests in the module fred_tests, if that module exists.

Options:

verbose:

Displays more details about the running tests.

Options in the environment variable EUNIT are also included last in the option list, i.e., have lower precedence than those in Options.

See also: test/1.

Authors

Mickaël Rémond <mickael.remond@process-one.net>

Richard Carlsson <carlsson.richard@gmail.com>

Referenced By

eunit_surefire.3erl(3).

eunit 2.3.7 Erlang Module Definition