Package eu.simuline.testhelpers

Class GUIRunner.HierarchyWrapper

java.lang.Object

eu.simuline.testhelpers.GUIRunner.HierarchyWrapper

All Implemented Interfaces:

GUIRunner.Selector, java.util.EventListener, javax.swing.event.TreeSelectionListener

Enclosing class:

GUIRunner

static class GUIRunner.HierarchyWrapper
extends java.lang.Object
implements GUIRunner.Selector, javax.swing.event.TreeSelectionListener

Represents the hierarchy of testsuites and testcases as a tree hierarchyTree possibly with a single selected node given by singleSelectedNode.

Field Summary

Fields

Modifier and Type	Field	Description
private Actions	actions	This is used only by valueChanged(TreeSelectionEvent) to set the filter via Actions.setFilter(Description).
private GUIRunner.TreePathIterator	currPathIter	Represents the path to the testcase currently run.
private javax.swing.JTree	hierarchyTree	The hierarchy of testsuites and testcases as a tree.
private GUIRunner.Selector	selector	Selector to be influenced: If this is in the selected tab, selector is the tab with the TestCaseLister; otherwise it is GUIRunner.TabChangeListener.EMPTY_SELECTOR.
private javax.swing.tree.DefaultMutableTreeNode	singleSelectedNode	Represents the selected node in hierarchyTree.
private GUIRunner.TestCaseLister	testCaseLister	The the GUIRunner.TestCaseLister listing the failed test cases.
private javax.swing.tree.TreeSelectionModel	treeSelection	The selection model for hierarchyTree.

Constructor Summary

Constructors

Constructor	Description
HierarchyWrapper(Actions actions, GUIRunner.TestCaseLister testCaseLister)	Creates a new HierarchyWrapper with the given actions and testCaseLister which are used to initialize actions and testCaseLister.

Method Summary

Modifier and Type	Method	Description
void	clearSelection()	Clears the selection.
(package private) void	collapseAlongPath()	Collapses the path to the leaf currPathIter points to as much as possible in order not to hide singleSelectedNode and the leafs corresponding with singular tests which failed already (assumption failure, failure and error).
(package private) void	expandAlongPath()	Expands the path to the leaf currPathIter points to.
(package private) Actions	getActions()	Returns the action.
(package private) javax.swing.tree.TreePath	getPath()
(package private) TestCase	getRoot()
(package private) javax.swing.JTree	getTree()
(package private) void	initClassStructure(TestCase testCase)	Notifies that the structure of the test class may have been updated.
private boolean	isSelected(TestCase testCase)	Returns whether the given testcase testCase is selected in this HierarchyTree.
(package private) void	noteReportResult(TestCase testCase)	Notifies that the singular test testCase is finished.
(package private) TestCase	noteTestStartedI(Quality qual)	Notifies that an atomic test is started or ignored.
void	registerSelector(GUIRunner.Selector selector)	Acquaints this selector with another one which is notified of the selection events of this Selector.
private void	setFilter()	Sets the filter (given by a description) invoking Actions.setFilter(Description): The description is taken from singleSelectedNode.
void	setSelection(int index)	Sets selection of indexth item and clears other selections.
(package private) void	startTestRun(Description desc)	Notifies that a test run with structure given by desc is going to be run next.
private static javax.swing.tree.DefaultMutableTreeNode	testCase2treeNode(TestCase testCase)	Converts the (tree of) testcases given by testCase.
void	valueChanged(javax.swing.event.TreeSelectionEvent selEvent)	Called whenever the value of the selection changes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

hierarchyTree

private final javax.swing.JTree hierarchyTree

The hierarchy of testsuites and testcases as a tree. After creation this is a default tree, after invocation of initClassStructure(TestCase) the hierarchy reflects the given testcase. The selection model is given by treeSelection and this is the TreeSelectionListener.

treeSelection

private final javax.swing.tree.TreeSelectionModel treeSelection

The selection model for hierarchyTree. At most one entry is selected. If the entry represents a failure, the according element in GUIRunner.TestCaseLister.failureSelection is selected also.

See Also:

valueChanged(TreeSelectionEvent)

actions

private final Actions actions

This is used only by valueChanged(TreeSelectionEvent) to set the filter via Actions.setFilter(Description).

testCaseLister

private final GUIRunner.TestCaseLister testCaseLister

The the GUIRunner.TestCaseLister listing the failed test cases. This is used in noteReportResult(TestCase) only and is to notify that a certain tescase failed and is selected.

singleSelectedNode

private javax.swing.tree.DefaultMutableTreeNode singleSelectedNode

Represents the selected node in hierarchyTree. This is null if nothing selected which is also the initial value. This is set by valueChanged(TreeSelectionEvent) and updated also by initClassStructure(TestCase).

currPathIter

private GUIRunner.TreePathIterator currPathIter

Represents the path to the testcase currently run. This is null after this is created and is initialized by startTestRun(Description).

selector

private GUIRunner.Selector selector

Selector to be influenced: If this is in the selected tab, selector is the tab with the TestCaseLister; otherwise it is GUIRunner.TabChangeListener.EMPTY_SELECTOR. Set by registerSelector(GUIRunner.Selector).

Constructor Detail

HierarchyWrapper

HierarchyWrapper(Actions actions,
                 GUIRunner.TestCaseLister testCaseLister)

Creates a new HierarchyWrapper with the given actions and testCaseLister which are used to initialize actions and testCaseLister.

Parameters:

actions - the Actions to be written into actions.

testCaseLister - TestCaseLister to be written into testCaseLister.

Method Detail

testCase2treeNode

private static javax.swing.tree.DefaultMutableTreeNode testCase2treeNode(TestCase testCase)

Converts the (tree of) testcases given by testCase. ****

getRoot

TestCase getRoot()

getActions

Actions getActions()

Returns the action. Invoked by the enclosing GUIRunner.

See Also:

GUIRunner.testRunStarted(Description), GUIRunner.testRunFinished(long), GUIRunner.testRunAborted()

initClassStructure

void initClassStructure(TestCase testCase)

Notifies that the structure of the test class may have been updated.

Converts the overall test case hierarchy testCase into a a tree node hierarchy invoking testCase2treeNode(TestCase). This defines the tree model of the hierarchy hierarchyTree. The selected node singleSelectedNode is set to the root.

Since currPathIter points to the first testcase run, it is set to null. Finally, actions is notified about the test to be run next which is specified by the testcase given by the selected node. by invoking setFilter().

Parameters:

testCase - a description of the test structure defined in the test class which is a hierarchy of suites and singular tests.

setFilter

private void setFilter()

Sets the filter (given by a description) invoking Actions.setFilter(Description): The description is taken from singleSelectedNode.

startTestRun

void startTestRun(Description desc)

Notifies that a test run with structure given by desc is going to be run next.

Sets the quality of the testcases given by singleSelectedNode recursively to Quality.Scheduled and sets currPathIter.

Parameters:

desc - describes the (hierarchy of) tests to be run. This is a sub-hierarchy of the one given by the test class. This parameter is purely formally because it is given by singleSelectedNode.

expandAlongPath

void expandAlongPath()

Expands the path to the leaf currPathIter points to. This is invoked by noteTestStartedI(Quality) when a testcase is started or ignored.

See Also:

collapseAlongPath()

collapseAlongPath

void collapseAlongPath()

Collapses the path to the leaf currPathIter points to as much as possible in order not to hide singleSelectedNode and the leafs corresponding with singular tests which failed already (assumption failure, failure and error). This is invoked by noteReportResult(TestCase) when a testcase is finished or after being ignored.

See Also:

expandAlongPath()

getTree

javax.swing.JTree getTree()

getPath

javax.swing.tree.TreePath getPath()

noteTestStartedI

TestCase noteTestStartedI(Quality qual)

Notifies that an atomic test is started or ignored.

To Updates currPathIter pointing to the current testcase and expands along the path given by the current testcase. Then sets the quality of the according testcase to qual and updates the according tree node.

Parameters:

qual - the quality of the testcase: This is Quality.Started or Quality.Ignored.

Returns:

the current testcase.

noteReportResult

void noteReportResult(TestCase testCase)

Notifies that the singular test testCase is finished.

Collapses the current path invoking collapseAlongPath(), updates the tree node currPathIter points to and notifies testCaseLister if testCase failed and is selected invoking GUIRunner.TestCaseLister.addSelectedTestCaseByNeed(TestCase).

Parameters:

testCase - The testcase comprising the result of the singular test finished.

isSelected

private boolean isSelected(TestCase testCase)

Returns whether the given testcase testCase is selected in this HierarchyTree.

Returns:

whether the given testcase testCase is selected in this HierarchyTree.

setSelection

public void setSelection(int index)

Description copied from interface: GUIRunner.Selector

Sets selection of indexth item and clears other selections.

Specified by:

setSelection in interface GUIRunner.Selector

Parameters:

index - a non-negative int value representing the index of a testcase. **** CAUTION: This presupposes that in a tree only the leaves can be selected.

clearSelection

public void clearSelection()

Description copied from interface: GUIRunner.Selector

Clears the selection.

Specified by:

clearSelection in interface GUIRunner.Selector

registerSelector

public void registerSelector(GUIRunner.Selector selector)

Description copied from interface: GUIRunner.Selector

Acquaints this selector with another one which is notified of the selection events of this Selector. The one in the foreground is notified directly by a mouse event, whereas the one in the background is selected via registration. The one in the background in turn notifies the empty selector GUIRunner.TabChangeListener.EMPTY_SELECTOR which takes no actions.

Specified by:

registerSelector in interface GUIRunner.Selector

Parameters:

selector - another Selector.

See Also:

GUIRunner.TabChangeListener.setSelUnSel(int)

valueChanged

public void valueChanged(javax.swing.event.TreeSelectionEvent selEvent)

Called whenever the value of the selection changes. Note that deselection is treated as selection of the root, so w.l.o.g, we have to consider selections only.

If an entry is selected, singleSelectedNode holds the selected node. Next selector is notified of the selection:

• if a failure is selected (which is a leaf) triggers according selection in the failure list, otherwise triggers a deselection.

Both have further effects invoking GUIRunner.TestCaseLister.valueChanged(ListSelectionEvent).

Finally, invokes setFilter() setting the filter for the next test run.

Specified by:

valueChanged in interface javax.swing.event.TreeSelectionListener