Skip to content
ConsoleMonster

API Reference

Class

TestRunSummary

Edit on GitHub
Namespace ConsoleMonster.TestRuns
Assembly ConsoleMonster
Source TestRunSummary.cs:26
Implements
IWidget
Modifiers sealed

The end of a test run, for the scrollback: a table of results grouped by file with a totals row (the file's status is the row's colour signal), the failures as in the live view, and a closing line with the outcome and the totals.

Inheritance

  • Object
  • TestRunSummary

Usage

Explore 8 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 4

Accepted by parameters 4

Constructors

public TestRunSummary(TestRunSnapshot snapshot) #
TestRunSummary.cs:26

Creates the summary of a snapshot.

Parameters

snapshot ConsoleMonster.TestRuns.TestRunSnapshot requiredposition: 0
The snapshot (usually taken after the run finished).

Methods

public Size Measure(Constraints constraints, RenderContext context) #
TestRunSummary.cs:32
Returns: Size

Returns the size the widget wants within the constraints.

Parameters

constraints ConsoleMonster.Layout.Constraints requiredposition: 0
The space offered.
context ConsoleMonster.Canvas.RenderContext requiredposition: 1
Profile, theme and glyphs.

Returns

The desired size, never larger than the constraints.

public Void Render(Region region, RenderContext context) #
TestRunSummary.cs:35
Returns: Void

Renders into a region. The region may be smaller or larger than the measured size.

Parameters

region ConsoleMonster.Canvas.Region requiredposition: 0
The target region.
context ConsoleMonster.Canvas.RenderContext requiredposition: 1
Profile, theme and glyphs.

Properties

public Int32 MaxFailures { get; set; } #
TestRunSummary.cs:26

The most failures listed (default 20); the rest are counted.

public Boolean ShowFailures { get; set; } #
TestRunSummary.cs:29

Whether the failures are listed (default true); off when the test framework already printed them.

Extension Methods

public static TestRunSummary WithMaxFailures(TestRunSummary testRunSummary, Int32 value) #
Returns: TestRunSummary

Sets TestRunSummary.MaxFailures: The most failures listed (default 20); the rest are counted.

Parameters

testRunSummary ConsoleMonster.TestRuns.TestRunSummary requiredposition: 0
The instance.
value System.Int32 requiredposition: 1
The value.

Returns

The same instance.

public static TestRunSummary WithShowFailures(TestRunSummary testRunSummary, Boolean value = true) #
Returns: TestRunSummary

Sets TestRunSummary.ShowFailures: Whether the failures are listed (default true); off when the test framework already printed them.

Parameters

testRunSummary ConsoleMonster.TestRuns.TestRunSummary requiredposition: 0
The instance.
value System.Boolean = true optionalposition: 1
The value (default true).

Returns

The same instance.