Tribunal.Reporter behaviour (Tribunal v1.4.0)

Copy Markdown View Source

Behaviour for eval result reporters.

Summary

Types

results()

@type results() :: %{
  summary: %{
    total: non_neg_integer(),
    passed: non_neg_integer(),
    failed: non_neg_integer(),
    pass_rate: float(),
    duration_ms: non_neg_integer()
  },
  metrics: %{
    required(atom()) => %{passed: non_neg_integer(), total: non_neg_integer()}
  },
  cases: [map()]
}

Callbacks

format(results)

@callback format(results()) :: String.t()