trait Runner extends AnyRef
Represents one run of a suite of tests.
The run represented by a Runner has a lifecycle. The run
begins when the Runner is instantiated by the framework and
returned to the client during a Framework.runner invocation.
The run continues until the client invokes done on the
Runner. Before invoking done, the client can
invoke the tasks method as many times at it wants, but once
done has been invoked, the Runner enters "spent"
mode. Any subsequent invocations of tasks will be met with an
IllegalStateException.
In Scala.js, the client may request multiple instances of
Runner, where one of these instances is considered the master.
The slaves receive a communication channel to the master. Once the master's
done method is invoked, nothing may be invoked on the slaves
or the master. Slaves can be de-comissioned before the master terminates.
- Alphabetic
- By Inheritance
- Runner
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
args: Array[String]
Returns the arguments that were used to create this
Runner.Returns the arguments that were used to create this
Runner.- returns
an array of argument that is used to create this Runner.
-
abstract
def
deserializeTask(task: String, deserializer: (String) ⇒ TaskDef): Task
Scala.js specific: Deserialize a task that has been serialized by
serializeTaskof another or thisRunner.Scala.js specific: Deserialize a task that has been serialized by
serializeTaskof another or thisRunner.The resulting task must associate with this runner.
-
abstract
def
done(): String
Indicates the client is done with this
Runnerinstance.Indicates the client is done with this
Runnerinstance.After invoking the
donemethod on aRunnerinstance, the client should no longer invoke thetaskmethods on that instance. (If the client does invoketaskafterdone, it will be rewarded with anIllegalStateException.)Similarly, after returning from
done, the test framework should no longer write any messages to theLogger, nor fire any more events to theEventHandler, passed toFramework.runner. If the test framework has not completed writing log messages or firing events when the client invokesdone, the framework should not return fromdoneuntil it is finished sending messages and events, and may block the thread that invokeddoneuntil it is actually done.In short, by invoking
done, the client indicates it is done invoking thetaskmethods for this run. By returning fromdone, the test framework indicates it is done writing log messages and firing events for this run.If the client invokes
donemore than once on the sameRunnerinstance, the test framework should on subsequent invocations should throwIllegalStateException.The test framework may send a summary (i.e., a message giving total tests succeeded, failed, and so on) to the user via a log message. If so, it should return the summary from
done. If not, it should return an empty string. The client may use the return value ofdoneto decide whether to display its own summary message.The test framework may return a multi-lines string (i.e., a message giving total tests succeeded, failed and so on) to the client.
In Scala.js, the client must not call this method before all execute methods of all Tasks have called their completion continuation. Otherwise, the Framework should throw an IllegalStateException (since it cannot block).
Further, if this is the master, the client must not call this method before, all done methods of all slaves have returned (otherwise, IllegalStateException). If this is a slave, the returned string is ignored.
- returns
a possibly multi-line summary string, or the empty string if no summary is provided
-
abstract
def
receiveMessage(msg: String): Option[String]
Scala.js specific: Invoked on the master
Runner, if a slave sends a message (through the channel provided by the client).Scala.js specific: Invoked on the master
Runner, if a slave sends a message (through the channel provided by the client).The master may send a message back to the sending slave by returning the message in a Some.
Invoked on a slave
Runner, if the master responds to a message (sent by the slave via the supplied closure inslaveRunner). The return value of the call is ignored in this case. -
abstract
def
remoteArgs(): Array[String]
Remote args that will be passed to
Runnerin a sub-process as remoteArgs.Remote args that will be passed to
Runnerin a sub-process as remoteArgs.- returns
an array of strings that will be passed to
Runnerin a sub-process asremoteArgs.
-
abstract
def
serializeTask(task: Task, serializer: (TaskDef) ⇒ String): String
Scala.js specific: Serialize a task created by
tasksor returned fromexecute.Scala.js specific: Serialize a task created by
tasksor returned fromexecute.The resulting string will be passed to the
deserializeTaskmethod of another runner. After calling this method, the passed task is invalid and should dissociate from this runner. -
abstract
def
tasks(taskDefs: Array[TaskDef]): Array[Task]
Returns an array of tasks that when executed will run tests and suites determined by the passed
TaskDefs.Returns an array of tasks that when executed will run tests and suites determined by the passed
TaskDefs.Each returned task, when executed, will run tests and suites determined by the test class name, fingerprints, "explicitly specified" field, and selectors of one of the passed
TaskDefs.This
tasksmethod may be called withTaskDefs containing the same value fortestClassNamebut different fingerprints. For example, if both a class and its companion object were test classes, thetasksmethod could be passed an array containingTaskDefs with the same name but with a different value forfingerprint.isModule.A test framework may "reject" a requested task by returning no
Taskfor thatTaskDef.- taskDefs
the
TaskDefs for requested tasks- returns
an array of
Tasks
- Exceptions thrown
java.lang.IllegalStateExceptionif invoked afterdonehas been invoked.
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )