Interface
IRunnerController

Definition

Namespace:ArtOfTest.WebAii.Design.Execution.Interfaces

Assembly:ArtOfTest.WebAii.Design.dll

Syntax:

cs-api-definition
public interface IRunnerController : IDisposable

Inherited Members IDisposable.Dispose()

Properties

IsRunnerResponding

Gets a value indicating whether this instance is runner responding.

Declaration

cs-api-definition
bool IsRunnerResponding { get; }

Property Value

bool

true if this instance is runner responding; otherwise, false.

RunnerProc

The runner proc

Declaration

cs-api-definition
Process RunnerProc { get; }

Property Value

Process

Methods

Disconnect()

Cleans up the connection to the runner

Declaration

cs-api-definition
void Disconnect()

Exit()

Notifies the runner to cleanup all connections (but the process stays alive)

Declaration

cs-api-definition
void Exit()

ForceShutdown(bool)

Force shut down of the runner

Declaration

cs-api-definition
void ForceShutdown(bool performCleanup)

Parameters

performCleanup

bool

Launch(int, string, bool, BrowserType, double, out int, bool, bool)

Launch the remote runner

Declaration

cs-api-definition
bool Launch(int waitForReadyTimeout, string pathToRunner, bool isManual, BrowserType browser, double runnerResponseTimeout, out int runnerProcId, bool hideConsole = false, bool isDesignTimeRun = false)

Parameters

waitForReadyTimeout

int

pathToRunner

string

isManual

bool

browser

BrowserType

runnerResponseTimeout

double

runnerProcId

int

hideConsole

bool

isDesignTimeRun

bool

Returns

bool

Ping()

Ping the runner to see if it is still alive

Declaration

cs-api-definition
void Ping()

RaiseResetBrowser()

Notifies the runner that the browser needs to be reset for the next test

Declaration

cs-api-definition
void RaiseResetBrowser()

RaiseRunCompleted()

Notifies the runner that the client is done processing the test completion event

Declaration

cs-api-definition
void RaiseRunCompleted()

Run(Test, Settings, DesignTimeExecutionParams, string, string, ExecutionType, Guid, Guid, IntPtr, DebuggerOptions, bool, string)

Starts test execution on the runner

Declaration

cs-api-definition
void Run(Test test, Settings settings, DesignTimeExecutionParams designTimeExecutionParams, string binaryFolder, string deploymentFolder, ExecutionType exeType, Guid firstStepGuid, Guid lastStepGuid, IntPtr existingBrowserHandle, DebuggerOptions debuggerOptions, bool rerun, string trafficLogFilename = null)

Parameters

test

Test

settings

Settings

designTimeExecutionParams

DesignTimeExecutionParams

binaryFolder

string

deploymentFolder

string

exeType

ExecutionType

firstStepGuid

Guid

lastStepGuid

Guid

existingBrowserHandle

IntPtr

debuggerOptions

DebuggerOptions

rerun

bool

Indicates if the test is rerun

trafficLogFilename

string

Events

ExecutionError

Occurs when an unexpected error occurs during execution.

Declaration

cs-api-definition
event EventHandler<ExecutionErrorEventArgs> ExecutionError

Event Value

EventHandler<ExecutionErrorEventArgs>

Exited

Successfully aborted/exited the remote runner.

Declaration

cs-api-definition
event EventHandler Exited

Event Value

EventHandler

OutputDataReceived

Occurs when data is written to the hidden console window

Declaration

cs-api-definition
event EventHandler<DataReceivedEventArgs> OutputDataReceived

Event Value

EventHandler<DataReceivedEventArgs>

PingResponded

When calling ping if the runner is responsive, then this event will be called.

Declaration

cs-api-definition
event EventHandler PingResponded

Event Value

EventHandler

TestCompleted

Occurs when a test execution is complete

Declaration

cs-api-definition
event EventHandler<TestCompletedEventArgs> TestCompleted

Event Value

EventHandler<TestCompletedEventArgs>

TestFailedToCompleteError

Occurs when an unexpected error occurs in the middle or end of test execution

Declaration

cs-api-definition
event EventHandler<ExecutionErrorEventArgs> TestFailedToCompleteError

Event Value

EventHandler<ExecutionErrorEventArgs>