TestRunner

java.lang.Object
- junit.runner.BaseTestRunner
- - junit.textui.TestRunner

All Implemented Interfaces:

TestListener
```
public class TestRunner
extends BaseTestRunner
```
A command line based tool to run tests.
```
 java junit.textui.TestRunner [-wait] TestCaseClass
 
```
TestRunner expects the name of a TestCase class as argument. If this class defines a static suite method it will be invoked and the returned test is run. Otherwise all the methods starting with "test" having no arguments are run.
When the wait command line argument is given TestRunner waits until the users types RETURN.
TestRunner prints a trace as the tests are executed followed by a summary at the end.

Field Summary

Fields
Modifier and Type Field and Description

static int EXCEPTION_EXIT

static int FAILURE_EXIT

static int SUCCESS_EXIT
- Fields inherited from class junit.runner.BaseTestRunner
  SUITE_METHODNAME

Fields
Modifier and Type	Field and Description
`static int`	`EXCEPTION_EXIT`
`static int`	`FAILURE_EXIT`
`static int`	`SUCCESS_EXIT`

Constructor Summary

Constructors
Constructor and Description
`TestRunner()` Constructs a TestRunner.
`TestRunner(java.io.PrintStream writer)` Constructs a TestRunner using the given stream for all the output
`TestRunner(ResultPrinter printer)` Constructs a TestRunner using the given ResultPrinter all the output

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected TestResult`	`createTestResult()` Creates the TestResult to be used for the test run.
`TestResult`	`doRun(Test test)`
`TestResult`	`doRun(Test suite, boolean wait)`
`TestSuiteLoader`	`getLoader()` Always use the StandardTestSuiteLoader.
`static void`	`main(java.lang.String[] args)`
`protected void`	`pause(boolean wait)`
`static void`	`run(java.lang.Class testClass)` Runs a suite extracted from a TestCase subclass.
`static TestResult`	`run(Test test)` Runs a single test and collects its results.
`static void`	`runAndWait(Test suite)` Runs a single test and waits until the user types RETURN.
`protected void`	`runFailed(java.lang.String message)` Override to define how to handle a failed loading of a test suite.
`protected TestResult`	`runSingleMethod(java.lang.String testCase, java.lang.String method, boolean wait)`
`void`	`setPrinter(ResultPrinter printer)`
`TestResult`	`start(java.lang.String[] args)` Starts a test run.
`void`	`testEnded(java.lang.String testName)`
`void`	`testFailed(int status, Test test, java.lang.Throwable t)`
`void`	`testStarted(java.lang.String testName)`

Methods inherited from class junit.runner.BaseTestRunner
addError, addFailure, clearStatus, elapsedTimeAsString, endTest, extractClassName, getFilteredTrace, getFilteredTrace, getPreference, getPreference, getPreferences, getTest, inMac, inVAJava, loadSuiteClass, processArguments, savePreferences, setLoading, setPreference, setPreferences, showStackRaw, startTest, truncate, useReloadingTestSuiteLoader

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- SUCCESS_EXIT
```
public static final int SUCCESS_EXIT
```
  See Also:
  
  Constant Field Values
- FAILURE_EXIT
```
public static final int FAILURE_EXIT
```
  See Also:
  
  Constant Field Values
- EXCEPTION_EXIT
```
public static final int EXCEPTION_EXIT
```
  See Also:
  
  Constant Field Values

Constructor Detail
- TestRunner
```
public TestRunner()
```
  Constructs a TestRunner.
- TestRunner
```
public TestRunner(java.io.PrintStream writer)
```
  Constructs a TestRunner using the given stream for all the output
- TestRunner
```
public TestRunner(ResultPrinter printer)
```
  Constructs a TestRunner using the given ResultPrinter all the output

Method Detail

run

public static void run(java.lang.Class testClass)

Runs a suite extracted from a TestCase subclass.

run

public static TestResult run(Test test)

Runs a single test and collects its results. This method can be used to start a test run from your program.

 public static void main (String[] args) {
     test.textui.TestRunner.run(suite());
 }

runAndWait
```
public static void runAndWait(Test suite)
```
Runs a single test and waits until the user types RETURN.

getLoader
```
public TestSuiteLoader getLoader()
```
Always use the StandardTestSuiteLoader. Overridden from BaseTestRunner.

Overrides:

getLoader in class BaseTestRunner

testFailed

public void testFailed(int status,
                       Test test,
                       java.lang.Throwable t)

Specified by:: testFailed in class BaseTestRunner

testStarted
```
public void testStarted(java.lang.String testName)
```
Specified by:

testStarted in class BaseTestRunner

testEnded
```
public void testEnded(java.lang.String testName)
```
Specified by:

testEnded in class BaseTestRunner

createTestResult
```
protected TestResult createTestResult()
```
Creates the TestResult to be used for the test run.

doRun
```
public TestResult doRun(Test test)
```

doRun

public TestResult doRun(Test suite,
                        boolean wait)

pause
```
protected void pause(boolean wait)
```

main

public static void main(java.lang.String[] args)

start
```
public TestResult start(java.lang.String[] args)
                 throws java.lang.Exception
```
Starts a test run. Analyzes the command line arguments and runs the given test suite.

Throws:

java.lang.Exception

runSingleMethod

protected TestResult runSingleMethod(java.lang.String testCase,
                                     java.lang.String method,
                                     boolean wait)
                              throws java.lang.Exception

Throws:: java.lang.Exception

runFailed
```
protected void runFailed(java.lang.String message)
```
Description copied from class: BaseTestRunner

Override to define how to handle a failed loading of a test suite.

Specified by:

runFailed in class BaseTestRunner

setPrinter

public void setPrinter(ResultPrinter printer)

Class TestRunner

Field Summary

Fields inherited from class junit.runner.BaseTestRunner

Constructor Summary

Method Summary

Methods inherited from class junit.runner.BaseTestRunner

Methods inherited from class java.lang.Object

Field Detail

SUCCESS_EXIT

FAILURE_EXIT

EXCEPTION_EXIT

Constructor Detail

TestRunner

TestRunner

TestRunner

Method Detail

run

run

runAndWait

getLoader

testFailed

testStarted

testEnded

createTestResult

doRun

doRun

pause

main

start

runSingleMethod

runFailed

setPrinter