Muex.Reporter (Muex v0.13.1)

View Source

Reports mutation testing results to the terminal.

Provides progress updates and final summaries of mutation testing runs.

Summary

Types

partial()

Marks a run that stopped starting mutants at its --deadline-minutes: mutations_run of mutations_total mutants that needed a test run were run. Mutants judged equivalent before the run are results but are in neither count.

Functions

partial_text(map)

The sentence that marks a partial run, for the terminal (stderr) and HTML.

print_progress(result, index, total)

Prints progress for a single mutation result.

print_summary(results)

Prints a summary of mutation testing results.

summary_line(results)

Returns a one-line, uncolored summary of the results, such as "Mutation Score: 75.0% (4 mutants: 3 killed, 1 survived, 0 invalid, 0 timed out)".

Types

partial()

@type partial() :: %{
  mutations_run: non_neg_integer(),
  mutations_total: non_neg_integer()
}

Marks a run that stopped starting mutants at its --deadline-minutes: mutations_run of mutations_total mutants that needed a test run were run. Mutants judged equivalent before the run are results but are in neither count.

Functions

partial_text(map)

@spec partial_text(partial()) :: String.t()

The sentence that marks a partial run, for the terminal (stderr) and HTML.

summary_line(results)

@spec summary_line([map()]) :: String.t()

Returns a one-line, uncolored summary of the results, such as "Mutation Score: 75.0% (4 mutants: 3 killed, 1 survived, 0 invalid, 0 timed out)".

Equivalent and no-coverage mutants are counted only when there are any, as in print_summary/1. Printed in place of the full summary when the report is written to a file.