ESpec.Example

Defines macros ‘example’ and ‘it’. These macros defines function with random name which will be called when example runs. Example structs %ESpec.Example are accumulated in @examples attribute

Source

Summary

__struct__()

Expampe struct. description - the description of example, module - spec module, function - random function name, opts - options, file - spec file path, line - the line where example is defined, context - example context. Accumulator for ‘contexts’ and ‘lets’, status - example status (:new, :success, :failure, :pending), result - the value returned by example block or the pending message error - store an error

context_descriptions(example)

Description with contexts

example(description)

Macros for pending exaples

example(description, list2)

Example options only

example(description, opts, list3)

Adds example to @examples and defines function to wrap the spec. Sends ‘double-underscore __‘ variable to the example block

failure(results)

Filters failed examples

fexample(list1)
fexample(description, list2)
fexample(description, opts, list3)
fit(list1)
fit(description, list2)
fit(description, opts, list3)

Macros for focused examples

focus(list1)
focus(description, list2)
focus(description, opts, list3)
fspecify(list1)
fspecify(description, list2)
fspecify(description, opts, list3)
it(description)
it(description_or_opts, list2)
it(description, opts, list3)

Aliases for example

pending(description)
pending_message(example, contexts)
pendings(results)

Filters pending examples

skip_message(example, contexts)
specify(description)
specify(description_or_opts, list2)
specify(description, opts, list3)
success(results)

Filters success examples

xexample(list1)
xexample(description, list2)
xexample(description, opts, list3)
xit(list1)
xit(description, list2)
xit(description, opts, list3)

Macros for skipped examples

xspecify(list1)
xspecify(description, list2)
xspecify(description, opts, list3)

Functions

__struct__()

Specs:

  • __struct__ :: %ESpec.Example{context: term, description: term, error: term, file: term, function: term, line: term, module: term, opts: term, result: term, status: term}

Expampe struct. description - the description of example, module - spec module, function - random function name, opts - options, file - spec file path, line - the line where example is defined, context - example context. Accumulator for ‘contexts’ and ‘lets’, status - example status (:new, :success, :failure, :pending), result - the value returned by example block or the pending message error - store an error

Source
context_descriptions(example)

Description with contexts.

Source
failure(results)

Filters failed examples

Source
pending_message(example, contexts)
Source
pendings(results)

Filters pending examples

Source
skip_message(example, contexts)
Source
success(results)

Filters success examples

Source

Macros

example(description)

Macros for pending exaples

Source
example(description, list2)

Example options only

Source
example(description, opts, list3)

Adds example to @examples and defines function to wrap the spec. Sends ‘double-underscore __‘ variable to the example block.

Source
fexample(list1)
Source
fexample(description, list2)
Source
fexample(description, opts, list3)
Source
fit(list1)
Source
fit(description, list2)
Source
fit(description, opts, list3)

Macros for focused examples

Source
focus(list1)
Source
focus(description, list2)
Source
focus(description, opts, list3)
Source
fspecify(list1)
Source
fspecify(description, list2)
Source
fspecify(description, opts, list3)
Source
it(description)
Source
it(description_or_opts, list2)
Source
it(description, opts, list3)

Aliases for example

Source
pending(description)
Source
specify(description)
Source
specify(description_or_opts, list2)
Source
specify(description, opts, list3)
Source
xexample(list1)
Source
xexample(description, list2)
Source
xexample(description, opts, list3)
Source
xit(list1)
Source
xit(description, list2)
Source
xit(description, opts, list3)

Macros for skipped examples

Source
xspecify(list1)
Source
xspecify(description, list2)
Source
xspecify(description, opts, list3)
Source