ConsoleWriter

Overview

ConsoleWriter is a class hat is used to write results of a test run to console.

Use case

You can use this class to represent test result as string and output it to console:

    //locates all tests
    var Discovered := Discovery.DiscoverTests;
    //Executes tests
    var Completed := Runner.RunTests(Discovered);
    var Writer := new ConsoleWriter(Completed);
    Writer.WriteFull;
    Writer.WriteLine("=========");
    Writer.WriteSummary;

    Writer.OutputToConsole;

Location

Reference:
- RemObjects.Elements.EUnit.dll .NET, .NET Standard 2.0
- remobjects.elements.eunit.jar Cooper
- EUnit.fx Island, macOS-x86_64
- libEUnit.fx Toffee
Namespace: RemObjects.Elements.EUnit
Ancestry: BaseWriter | StringWriter | ConsoleWriter

constructor .NET, .NET Standard 2.0, Cooper, Island, macOS-x86_64

Creates a new instance of the class with specified parameters.

constructor(TestResults: ITestResult)

ConsoleWriter(ITestResult TestResults)

init(_ TestResults: ITestResult)

ConsoleWriter(ITestResult TestResults)

Sub New(TestResults As ITestResult)

Parameters:

TestResults: Reference to a test result.

description override (declared in StringWriter) Toffee

func description(description ) -> NSString

Parameters:

Gets reference to a test result assosiated with this writer.

property Items: ITestResult read;

ITestResult Items { get; }

var Items: ITestResult { get{} }

ITestResult Items { __get; }

ReadOnly Property Items() As ITestResult

Gets current text output.

property Output: String read;

var Output: String { get{} }

ReadOnly Property Output() As String

OutputToConsole virtual

Writes current output to console.

PlatformString toString()

Writes all test results that matches the conditions defined by the specified predicate.

method Write(Filter: Predicate<ITestResult>)

void Write(Predicate<ITestResult> Filter)

func Write(_ Filter: Predicate<ITestResult>)

void Write(Predicate<ITestResult> Filter)

Sub Write(Filter As Predicate<ITestResult>)

Parameters:

Filter: Block that defines the conditions of the elements to search for.

WriteElement protected virtual (declared in StringWriter)

Writes specified elemet.

method WriteElement(Item: ITestResult)

void WriteElement(ITestResult Item)

func WriteElement(_ Item: ITestResult)

void WriteElement(ITestResult Item)

Sub WriteElement(Item As ITestResult)

Parameters:

Item: Element to write.

WriteFailed virtual (declared in BaseWriter)

Writes only tests that failed.

// .NET, .NET Standard 2.0, Island
method WriteFailed(TestcaseOnly: Boolean := false)
// macOS-x86_64
method WriteFailed(TestcaseOnly: Boolean)

// .NET, .NET Standard 2.0, Island
void WriteFailed(Boolean TestcaseOnly = false)
// macOS-x86_64
void WriteFailed(Boolean TestcaseOnly)

func WriteFailed(_ TestcaseOnly: Boolean = false)

void WriteFailed(Boolean TestcaseOnly)

// .NET, .NET Standard 2.0, Island
Sub WriteFailed(TestcaseOnly As Boolean = false)
// macOS-x86_64
Sub WriteFailed(TestcaseOnly As Boolean)

Parameters:

TestcaseOnly: Value that indicates whether this method will write only testcases or all types of tests.

WriteFull virtual (declared in BaseWriter)

Writes full test result tree.

method WriteLine(Item: String)

void WriteLine(String Item)

func WriteLine(_ Item: String)

void WriteLine(String Item)

Sub WriteLine(Item As String)

Parameters:

Item:

Writes specified line of text.

method WriteLine(Line: String)

void WriteLine(String Line)

func WriteLine(_ Line: String)

void WriteLine(String Line)

Sub WriteLine(Line As String)

Parameters:

Line: String that will be written.

WriteNode protected override (declared in StringWriter)

method WriteNode(Node: ITestResult; Filter: Predicate<ITestResult>)

void WriteNode(ITestResult Node, Predicate<ITestResult> Filter)

func WriteNode(_ Node: ITestResult, _ Filter: Predicate<ITestResult>)

void WriteNode(ITestResult Node, Predicate<ITestResult> Filter)

Sub WriteNode(Node As ITestResult, Filter As Predicate<ITestResult>)

Parameters:

Node:
Filter:

WriteSuite protected override (declared in StringWriter)

Writes specified suite items.

method WriteSuite(Item: ITestResult)

void WriteSuite(ITestResult Item)

func WriteSuite(_ Item: ITestResult)

void WriteSuite(ITestResult Item)

Sub WriteSuite(Item As ITestResult)

Parameters:

Item: Reference to a test suite to write.

WriteSummary virtual (declared in BaseWriter)

Writes summary of the test run.

// .NET, .NET Standard 2.0, Island
method WriteSummary(IncludeAll: Boolean := false)
// macOS-x86_64
method WriteSummary(IncludeAll: Boolean)

// .NET, .NET Standard 2.0, Island
void WriteSummary(Boolean IncludeAll = false)
// macOS-x86_64
void WriteSummary(Boolean IncludeAll)

func WriteSummary(_ IncludeAll: Boolean = false)

void WriteSummary(Boolean IncludeAll)

// .NET, .NET Standard 2.0, Island
Sub WriteSummary(IncludeAll As Boolean = false)
// macOS-x86_64
Sub WriteSummary(IncludeAll As Boolean)

Parameters:

IncludeAll: Value that indicates whether all items should be calculated or only tests and testcases.

WriteTest protected override (declared in StringWriter)

Writes specified test items.

method WriteTest(Item: ITestResult)

void WriteTest(ITestResult Item)

func WriteTest(_ Item: ITestResult)

void WriteTest(ITestResult Item)

Sub WriteTest(Item As ITestResult)

Parameters:

Item: Reference to a test to write.

WriteTestcase protected override (declared in StringWriter)

Writes specified testcase items.

method WriteTestcase(Item: ITestResult)

void WriteTestcase(ITestResult Item)

func WriteTestcase(_ Item: ITestResult)

void WriteTestcase(ITestResult Item)

Sub WriteTestcase(Item As ITestResult)

Parameters:

Item: Reference to a testcase to write.

Gets reference to a test result assosiated with this writer.

property Items: ITestResult read;

ITestResult Items { get; }

var Items: ITestResult { get{} }

ITestResult Items { __get; }

ReadOnly Property Items() As ITestResult

Gets current text output.

property Output: String read;

var Output: String { get{} }

ReadOnly Property Output() As String

constructor .NET, .NET Standard 2.0, Cooper, Island, macOS-x86_64

Creates a new instance of the class with specified parameters.

constructor(TestResults: ITestResult)

ConsoleWriter(ITestResult TestResults)

init(_ TestResults: ITestResult)

ConsoleWriter(ITestResult TestResults)

Sub New(TestResults As ITestResult)

Parameters:

TestResults: Reference to a test result.

description override (declared in StringWriter) Toffee

func description(description ) -> NSString

Parameters:

OutputToConsole virtual

Writes current output to console.

PlatformString toString()

Writes all test results that matches the conditions defined by the specified predicate.

method Write(Filter: Predicate<ITestResult>)

void Write(Predicate<ITestResult> Filter)

func Write(_ Filter: Predicate<ITestResult>)

void Write(Predicate<ITestResult> Filter)

Sub Write(Filter As Predicate<ITestResult>)

Parameters:

Filter: Block that defines the conditions of the elements to search for.

WriteElement protected virtual (declared in StringWriter)

Writes specified elemet.

method WriteElement(Item: ITestResult)

void WriteElement(ITestResult Item)

func WriteElement(_ Item: ITestResult)

void WriteElement(ITestResult Item)

Sub WriteElement(Item As ITestResult)

Parameters:

Item: Element to write.

WriteFailed virtual (declared in BaseWriter)

Writes only tests that failed.

// .NET, .NET Standard 2.0, Island
method WriteFailed(TestcaseOnly: Boolean := false)
// macOS-x86_64
method WriteFailed(TestcaseOnly: Boolean)

// .NET, .NET Standard 2.0, Island
void WriteFailed(Boolean TestcaseOnly = false)
// macOS-x86_64
void WriteFailed(Boolean TestcaseOnly)

func WriteFailed(_ TestcaseOnly: Boolean = false)

void WriteFailed(Boolean TestcaseOnly)

// .NET, .NET Standard 2.0, Island
Sub WriteFailed(TestcaseOnly As Boolean = false)
// macOS-x86_64
Sub WriteFailed(TestcaseOnly As Boolean)

Parameters:

TestcaseOnly: Value that indicates whether this method will write only testcases or all types of tests.

WriteFull virtual (declared in BaseWriter)

Writes full test result tree.

method WriteLine(Item: String)

void WriteLine(String Item)

func WriteLine(_ Item: String)

void WriteLine(String Item)

Sub WriteLine(Item As String)

Parameters:

Item:

Writes specified line of text.

method WriteLine(Line: String)

void WriteLine(String Line)

func WriteLine(_ Line: String)

void WriteLine(String Line)

Sub WriteLine(Line As String)

Parameters:

Line: String that will be written.

WriteNode protected override (declared in StringWriter)

method WriteNode(Node: ITestResult; Filter: Predicate<ITestResult>)

void WriteNode(ITestResult Node, Predicate<ITestResult> Filter)

func WriteNode(_ Node: ITestResult, _ Filter: Predicate<ITestResult>)

void WriteNode(ITestResult Node, Predicate<ITestResult> Filter)

Sub WriteNode(Node As ITestResult, Filter As Predicate<ITestResult>)

Parameters:

Node:
Filter:

WriteSuite protected override (declared in StringWriter)

Writes specified suite items.

method WriteSuite(Item: ITestResult)

void WriteSuite(ITestResult Item)

func WriteSuite(_ Item: ITestResult)

void WriteSuite(ITestResult Item)

Sub WriteSuite(Item As ITestResult)

Parameters:

Item: Reference to a test suite to write.

WriteSummary virtual (declared in BaseWriter)

Writes summary of the test run.

// .NET, .NET Standard 2.0, Island
method WriteSummary(IncludeAll: Boolean := false)
// macOS-x86_64
method WriteSummary(IncludeAll: Boolean)

// .NET, .NET Standard 2.0, Island
void WriteSummary(Boolean IncludeAll = false)
// macOS-x86_64
void WriteSummary(Boolean IncludeAll)

func WriteSummary(_ IncludeAll: Boolean = false)

void WriteSummary(Boolean IncludeAll)

// .NET, .NET Standard 2.0, Island
Sub WriteSummary(IncludeAll As Boolean = false)
// macOS-x86_64
Sub WriteSummary(IncludeAll As Boolean)

Parameters:

IncludeAll: Value that indicates whether all items should be calculated or only tests and testcases.

WriteTest protected override (declared in StringWriter)

Writes specified test items.

method WriteTest(Item: ITestResult)

void WriteTest(ITestResult Item)

func WriteTest(_ Item: ITestResult)

void WriteTest(ITestResult Item)

Sub WriteTest(Item As ITestResult)

Parameters:

Item: Reference to a test to write.

WriteTestcase protected override (declared in StringWriter)

Writes specified testcase items.

method WriteTestcase(Item: ITestResult)

void WriteTestcase(ITestResult Item)

func WriteTestcase(_ Item: ITestResult)

void WriteTestcase(ITestResult Item)

Sub WriteTestcase(Item As ITestResult)

Parameters:

Item: Reference to a testcase to write.