Package com.sun.javatest
Class Harness
java.lang.Object
com.sun.javatest.Harness
The object responsible for coordinating the execution of a test run.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
This exception is used to report problems while executing a test run.static interface
This interface provides a means for Harness to report on events that might be of interest as it executes. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add an observer to be notified during the execution of a test run.boolean
batch
(Parameters params) Run the tests defined by a new set of parameters.int
getAutostopThreshold
(int n) Get the backup policy object used by this harness, used to determine the policy for backing up files before overwriting them.static File
Get the class directory or jar file containing JT Harness.long
Get the time at which cleanup of the entire run was completed.long
Find time since the start of the current or last run.getEnv()
Get the current test environment being used by the harness.long
Find out the estimated time required to complete the remaining tests.long
Get the time at which the last run finished.Get the current parameters of the harness.Get the current set of results.long
Get the time at which the last run start.Returns test tree iterator containing useful info and stats about the test runint
Find out how many tests to run have been located so far.long
long
boolean
Indicates whether the harness has located all the tests it will execute.boolean
Was the harness invoked in batch mode? If it is not in batch mode, this typically implies that the user is using an interactive GUI interface.boolean
Check if the harness is currently executing a test suite or not.boolean
Check if a trace file should be generated while performing a test run.void
notifyOfTheFinalStats
(Map<TestFilter, List<TestDescription>> filterStats, int... stats) Informs all the observers of the final stats gathered after the test runvoid
Remove a previously registered observer so that it will no longer be notified during the execution of a test run.void
setAutostopThreshold
(int n) Set the threshold for automatic halting of a test run.void
Set the backup policy object to be used by this harness, used to determine the policy for backing up files before overwriting them.static void
setClassDir
(File classDir) Specify the class directory or jar file containing JT Harness.void
setTracingRequired
(boolean b) Set whether a trace file should be generated while performing a test run.void
start
(Parameters p) Start running all the tests defined by a new set of parameters.void
stop()
Stop the harness executing any tests.void
Wait until the harness completes the current task.
-
Field Details
-
DEBUG_OBSERVER_CLASSNAME_SYS_PROP
- See Also:
-
-
Constructor Details
-
Harness
Deprecated.Use Harness() insteadInstantiate a harness.- Parameters:
classDir
- The class dir to put in the environment for otherJVM tests- See Also:
-
Harness
public Harness()Instantiate a harness.
-
-
Method Details
-
getClassDir
Get the class directory or jar file containing JT Harness.- Returns:
- the class directory or jar file containing JT Harness
- See Also:
-
setClassDir
Specify the class directory or jar file containing JT Harness.- Parameters:
classDir
- the class directory or jar file containing JT Harness- See Also:
-
getBackupPolicy
Get the backup policy object used by this harness, used to determine the policy for backing up files before overwriting them.- Returns:
- the backup policy object used by this harness
- See Also:
-
setBackupPolicy
Set the backup policy object to be used by this harness, used to determine the policy for backing up files before overwriting them.- Parameters:
bp
- the backup policy object used by this harness- See Also:
-
isTracingRequired
public boolean isTracingRequired()Check if a trace file should be generated while performing a test run.- Returns:
- true if and only if a trace file should be generated
- See Also:
-
setTracingRequired
public void setTracingRequired(boolean b) Set whether a trace file should be generated while performing a test run.- Parameters:
b
- whether or not a trace file should be generated- See Also:
-
getParameters
Get the current parameters of the harness.- Returns:
- null if the parameters have not been set.
-
getEnv
Get the current test environment being used by the harness. This is similar to getParameters().getEnv(), except that the environment returned here has some standard additional fields set by the harness itself.- Returns:
- null if the environment has not been set.
-
getResultTable
Get the current set of results. This will either be the set of results from which are currently running, or the results from the last run.- Returns:
- null if no results are currently available. This will be the case if the Harness has not been run, or the parameters have been changed without doing a new run.
-
addObserver
Add an observer to be notified during the execution of a test run. Observers are notified of events in the reverse order they were added -- the most recently added observer gets notified first.- Parameters:
o
- the observer to be added- See Also:
-
removeObserver
Remove a previously registered observer so that it will no longer be notified during the execution of a test run. It is safe for observers to remove themselves during a notification; most obviously, an observer may remove itself during finishedTesting() or finishedTestRun().- Parameters:
o
- the observer to be removed- See Also:
-
start
Start running all the tests defined by a new set of parameters. The tests are run asynchronously, in a separate worker thread.- Parameters:
p
- The parameters to be set when the tests are run. Any errors in the parameters are reported to any registered observers.- Throws:
Harness.Fault
- if the harness is currently running tests and so cannot start running any more tests right now.- See Also:
-
waitUntilDone
Wait until the harness completes the current task.- Throws:
InterruptedException
- if the thread making the call is interrupted.
-
stop
public void stop()Stop the harness executing any tests. If no tests are running, the method does nothing; otherwise it notifies any observers, and interrupts the thread doing the work. The worker may carry on for a short time after this method is called, while it waits for all the related tasks to complete.- See Also:
-
batch
Run the tests defined by a new set of parameters.- Parameters:
params
- The parameters to be used; they will be validated first.- Returns:
- true if and only if all the selected tests were executed successfully, and all passed
- Throws:
Harness.Fault
- if the harness is currently running tests and cannot start running any more tests right now.- See Also:
-
isRunning
public boolean isRunning()Check if the harness is currently executing a test suite or not.- Returns:
- true if and only if the harness is currently executing a test suite.
- See Also:
-
isBatchRun
public boolean isBatchRun()Was the harness invoked in batch mode? If it is not in batch mode, this typically implies that the user is using an interactive GUI interface.- Returns:
- True if the harness is running and was invoked in batch mode.
- Throws:
IllegalStateException
- If the harness is not running, care should be taken to handle this in case the run terminates.
-
isAllTestsFound
public boolean isAllTestsFound()Indicates whether the harness has located all the tests it will execute. If true, then getTestsFoundCount() will return the number of test which will be executed during this test run; assuming the harness does not halt for special cases (errors, user request, etc...). If false, getTestsFoundCount() returns the number of tests located so far.- Returns:
- True if all tests have been located. False if the harness is still looking for tests. Always false if the harness is not running.
- See Also:
-
getElapsedTime
public long getElapsedTime()Find time since the start of the current or last run. If no run is in progress, this is the time it took to complete the last run.- Returns:
- Zero if no run has ever been started yet. Elapsed time in milliseconds otherwise.
-
getStartTime
public long getStartTime()Get the time at which the last run start.- Returns:
- Time when the last run started in milliseconds. -1 if there is no previous run.
- See Also:
-
getFinishTime
public long getFinishTime()Get the time at which the last run finished. This is the time when the last test completed, and does not include post-run cleanup time.- Returns:
- Time when the last run finished in milliseconds. -1 if there is no previous run or a run is in progress.
- See Also:
-
getCleanupFinishTime
public long getCleanupFinishTime()Get the time at which cleanup of the entire run was completed. This is after the time when the last test completed.- Returns:
- Time when the run finished in milliseconds. -1 if there is no previous run or a run is in progress.
- See Also:
-
getTotalCleanupTime
public long getTotalCleanupTime() -
getTotalSetupTime
public long getTotalSetupTime() -
getEstimatedTime
public long getEstimatedTime()Find out the estimated time required to complete the remaining tests.- Returns:
- A time estimate in milliseconds. Zero if no run is in progress or no estimate is available.
-
getTestsFoundCount
public int getTestsFoundCount()Find out how many tests to run have been located so far. Data will pertain to the previous run (if any) if isRunning() is false. The return will be zero if isRunning() is false and there is no previous run for this instance of the Harness.- Returns:
- Number of tests which the harness will try to run. Greater than or equal to zero and less than or equal to the total number of tests in the testsuite.
- See Also:
-
getTestIterator
Returns test tree iterator containing useful info and stats about the test run- Returns:
- test tree iterator containing test run data
-
setAutostopThreshold
public void setAutostopThreshold(int n) Set the threshold for automatic halting of a test run. The current algorithm is to begin at zero, add one for every failure, five for every error and subtract two for each pass. This value must be set before the run begins, do not change it during a run.- See Also:
-
getAutostopThreshold
public int getAutostopThreshold(int n) - See Also:
-
getTestsIterator
public ReadAheadIterator<TestResult> getTestsIterator(TestResultTable.TreeIterator iter) throws Harness.Fault - Throws:
Harness.Fault
-
notifyOfTheFinalStats
Informs all the observers of the final stats gathered after the test run- Parameters:
filterStats
- the final statistics about happened test filteringstats
- status type is the number of element, value is the number or tests with that type of status
-