ExUnit v1.5.1 ExUnit.Filters View Source

Conveniences for parsing and evaluating filters.

Link to this section Summary

Types

t()

Functions

eval(include, exclude, tags, collection)

Evaluates the include and exclude filters against the given tags

normalize(include, exclude)

Normalizes include and excludes to remove duplicates and keep precedence

parse(filters)

Parses the given filters, as one would receive from the command line

parse_path(file)

Parses filters out of a path

Link to this section Types

t()

t() :: [{atom(), Regex.t() | String.Chars.t()} | atom()]

Link to this section Functions

eval(include, exclude, tags, collection)

eval(t(), t(), map(), [ExUnit.Test.t()]) :: :ok | {:error, binary()}

Evaluates the include and exclude filters against the given tags.

Some filters, like :line, may require the whole test collection to find the closest line, that’s why it must also be passed as argument.

Filters can either be a regular expression or any data structure that implements to String.Chars, which is invoked before comparing the filter with the tag value.

Examples

iex> ExUnit.Filters.eval([foo: "bar"], [:foo], %{foo: "bar"}, [])
:ok

iex> ExUnit.Filters.eval([foo: "bar"], [:foo], %{foo: "baz"}, [])
{:error, "due to foo filter"}

normalize(include, exclude)

normalize(t() | nil, t() | nil) :: {t(), t()}

Normalizes include and excludes to remove duplicates and keep precedence.

Examples

iex> ExUnit.Filters.normalize(nil, nil)
{[], []}

iex> ExUnit.Filters.normalize([:foo, :bar, :bar], [:foo, :baz])
{[:foo, :bar], [:baz]}

parse(filters)

parse([String.t()]) :: t()

Parses the given filters, as one would receive from the command line.

Examples

iex> ExUnit.Filters.parse(["foo:bar", "baz", "line:9", "bool:true"])
[{:foo, "bar"}, :baz, {:line, "9"}, {:bool, "true"}]

parse_path(file)

parse_path(String.t()) :: {String.t(), any()}

Parses filters out of a path.

Determines whether a given file path (supplied to ExUnit/Mix as arguments on the command line) includes a line number filter, and if so returns the appropriate ExUnit configuration options.