com.premiumminds.webapp.wicket.testing

Class AbstractComponentTest

java.lang.Object

org.easymock.EasyMockSupport

com.premiumminds.webapp.wicket.testing.AbstractComponentTest

All Implemented Interfaces:

Function<org.apache.wicket.Page,org.apache.wicket.ajax.AjaxRequestTarget>

public abstract class AbstractComponentTest
extends org.easymock.EasyMockSupport
implements Function<org.apache.wicket.Page,org.apache.wicket.ajax.AjaxRequestTarget>

Base class for creating unit tests for wicket components. The core of the class is based on BaseWicketTester.startComponentInPage(Component), and it uses EasyMockSupport.createMockBuilder(Class) to create a mock of AjaxRequestTarget with which to verify Ajax calls from the component. Note that AjaxRequestTarget.addListener(IListener), IRequestHandler.respond(IRequestCycle) and IRequestHandler.detach(IRequestCycle) are ignored by the mock, as they are used by the wicket framework itself.

Field Summary

Fields

Modifier and Type	Field and Description
org.junit.rules.ExpectedException	exception Rule for expecting thrown exceptions during test execution.

Fields inherited from class org.easymock.EasyMockSupport

controls

Constructor Summary

Constructors

Constructor and Description
AbstractComponentTest()

Method Summary

Modifier and Type	Method and Description
org.apache.wicket.ajax.AjaxRequestTarget	apply(org.apache.wicket.Page context) This method is a part of IContextProvider<AjaxRequestTarget, Page> implementation and is not meant to be called by user code.
protected org.apache.wicket.protocol.http.WebApplication	createApp() Creates an instance of a Wicket WebApplication in which to run the tests.
protected ExtendedWicketTester	createTester(org.apache.wicket.protocol.http.WebApplication app) Creates the Wicket tester object that will support the tests.
protected org.apache.wicket.ajax.AjaxRequestTarget	getTarget()
protected ExtendedWicketTester	getTester()
protected void	mockRequest(boolean mockRequest) Optionally creates and injects a mock AJAX request target for the component to interact with.
protected void	resetTest() Resets the test.
void	setUp() Code that runs before every test.
protected void	startFormComponentTest(org.apache.wicket.Component subject, String inputType) Starts a component for testing in a bare-bones form in a simple page.
protected void	startFormComponentTest(org.apache.wicket.Component subject, String inputType, boolean mockRequest) Starts a component for testing in a bare-bones form in a simple page.
protected void	startFormComponentTestWithMarkup(org.apache.wicket.Component subject, String inputType, org.apache.wicket.markup.IMarkupFragment markup) Starts a component for testing in a bare-bones form in a simple page.
protected void	startFormComponentTestWithMarkup(org.apache.wicket.Component subject, String inputType, org.apache.wicket.markup.IMarkupFragment markup, boolean mockRequest) Starts a component for testing in a bare-bones form in a simple page with provided markup.
protected void	startTest(org.apache.wicket.Component subject) Starts a component for testing in a bare-bones page generated by the wicket framework.
protected void	startTest(org.apache.wicket.Component subject, boolean mockRequest) Starts a component for testing in a bare-bones page generated by the wicket framework.
void	tearDown() Code that runs after every test.

Methods inherited from class org.easymock.EasyMockSupport

createControl, createControl, createMock, createMock, createMock, createMock, createMockBuilder, createNiceControl, createNiceMock, createNiceMock, createStrictControl, createStrictMock, createStrictMock, getMockedClass, injectMocks, mock, mock, mock, mock, niceMock, niceMock, partialMockBuilder, replayAll, resetAll, resetAllToDefault, resetAllToNice, resetAllToStrict, strictMock, strictMock, verifyAll, verifyAllRecordings, verifyAllUnexpectedCalls

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

exception

public org.junit.rules.ExpectedException exception

Rule for expecting thrown exceptions during test execution. Preferred over expected= in a @Test annotation. The test should call ExpectedException.expect(Class) or a similar method to specify that it expects an exception to be thrown subsequently.

Constructor Detail

AbstractComponentTest

public AbstractComponentTest()

Method Detail

setUp

public void setUp()

Code that runs before every test. If this method is overriden, the override must call super.setUp(). The preferred alternative is to simply create a differently named method and annotate it with @Before.

tearDown

public void tearDown()

Code that runs after every test. If this method is overriden, the override must call super.tearDown(). The preferred alternative is to simply create a differently named method and annotate it with @After.

createApp

protected org.apache.wicket.protocol.http.WebApplication createApp()

Creates an instance of a Wicket WebApplication in which to run the tests. Can be overriden if specific functionality is needed in the app, such as a specific home page. Note that this method is only called once, in the test constructor.

Returns:

An instance of a WebApplication.

createTester

protected ExtendedWicketTester createTester(org.apache.wicket.protocol.http.WebApplication app)

Creates the Wicket tester object that will support the tests. Can be overriden if additional functionality is required in the tester, such as replacing the default page for component tests.

Parameters:

app - The Wicket application that the tester will associate with the pages and components created

Returns:

A new instance of the tester

startTest

protected void startTest(org.apache.wicket.Component subject)

Starts a component for testing in a bare-bones page generated by the wicket framework. Creates and injects a mock AJAX request target for the component to interact with. See BaseWicketTester.startComponentInPage(Component). Note that AjaxRequestTarget.addListener(IListener), IRequestHandler.respond(IRequestCycle) and IRequestHandler.detach(IRequestCycle) are ignored by the mock, as they are used by the wicket framework itself.

Parameters:

subject - The component to be tested

startFormComponentTest

protected void startFormComponentTest(org.apache.wicket.Component subject,
                                      String inputType)

Starts a component for testing in a bare-bones form in a simple page. Creates and injects a mock AJAX request target for the component to interact with. See BaseWicketTester.startComponentInPage(Component). Note that AjaxRequestTarget.addListener(IListener), IRequestHandler.respond(IRequestCycle) and IRequestHandler.detach(IRequestCycle) are ignored by the mock, as they are used by the wicket framework itself.

Parameters:

subject - The component to be tested

inputType - The HTML type of the input to associate with the component to be tested

startFormComponentTestWithMarkup

protected void startFormComponentTestWithMarkup(org.apache.wicket.Component subject,
                                                String inputType,
                                                org.apache.wicket.markup.IMarkupFragment markup)

Starts a component for testing in a bare-bones form in a simple page. Creates and injects a mock AJAX request target for the component to interact with. See BaseWicketTester.startComponentInPage(Component). Note that AjaxRequestTarget.addListener(IListener), IRequestHandler.respond(IRequestCycle) and IRequestHandler.detach(IRequestCycle) are ignored by the mock, as they are used by the wicket framework itself.

Parameters:

subject - The component to be tested

inputType - The HTML type of the input to associate with the component to be tested

markup - The markup to use to initialize the Wicket test page.

startTest

protected void startTest(org.apache.wicket.Component subject,
                         boolean mockRequest)

Starts a component for testing in a bare-bones page generated by the wicket framework. Optionally creates and injects a mock AJAX request target for the component to interact with. See BaseWicketTester.startComponentInPage(Component). Note that AjaxRequestTarget.addListener(IListener), IRequestHandler.respond(IRequestCycle) and IRequestHandler.detach(IRequestCycle) are ignored by the mock, as they are used by the wicket framework itself.

Parameters:

subject - The component to be tested

mockRequest - If the parameter is true, a mock request is created. Use this to verify the component's calls into Ajax. If the parameter is false, a mock request is not created and the default request created by the wicket framework is used instead. Use this to call into the component from Ajax.

startFormComponentTest

protected void startFormComponentTest(org.apache.wicket.Component subject,
                                      String inputType,
                                      boolean mockRequest)

Starts a component for testing in a bare-bones form in a simple page. Optionally creates and injects a mock AJAX request target for the component to interact with. See BaseWicketTester.startComponentInPage(Component). Note that AjaxRequestTarget.addListener(IListener), IRequestHandler.respond(IRequestCycle) and IRequestHandler.detach(IRequestCycle) are ignored by the mock, as they are used by the wicket framework itself.

Parameters:

subject - The component to be tested

inputType - The HTML type of the input to associate with the component to be tested

mockRequest - If the parameter is true, a mock request is created. Use this to verify the component's calls into Ajax. If the parameter is false, a mock request is not created and the default request created by the wicket framework is used instead. Use this to call into the component from Ajax.

startFormComponentTestWithMarkup

protected void startFormComponentTestWithMarkup(org.apache.wicket.Component subject,
                                                String inputType,
                                                org.apache.wicket.markup.IMarkupFragment markup,
                                                boolean mockRequest)

Starts a component for testing in a bare-bones form in a simple page with provided markup. Optionally creates and injects a mock AJAX request target for the component to interact with. See BaseWicketTester.startComponentInPage(Component). Note that AjaxRequestTarget.addListener(IListener), IRequestHandler.respond(IRequestCycle) and IRequestHandler.detach(IRequestCycle) are ignored by the mock, as they are used by the wicket framework itself.

Parameters:

subject - The component to be tested

inputType - The HTML type of the input to associate with the component to be tested

markup - The markup to use to initialize the Wicket test page.

mockRequest - If the parameter is true, a mock request is created. Use this to verify the component's calls into Ajax. If the parameter is false, a mock request is not created and the default request created by the wicket framework is used instead. Use this to call into the component from Ajax.

getTester

protected ExtendedWicketTester getTester()

Returns:

A reference to the WicketTester object created during test set-up.

getTarget

protected org.apache.wicket.ajax.AjaxRequestTarget getTarget()
                                                      throws TestNotStartedException

Returns:

A reference to the mock Ajax request target object created by startTest(Component), startTest(Component, boolean), startFormComponentTest(Component, String) or startFormComponentTest(Component, String, boolean). The object returned is always the mock target, regardless of whether requests are currently being mocked or not.

Throws:

TestNotStartedException - if this method is called before any of those methods, or if resetTest() is called.

mockRequest

protected void mockRequest(boolean mockRequest)

Optionally creates and injects a mock AJAX request target for the component to interact with. Note that AjaxRequestTarget.addListener(IListener), IRequestHandler.respond(IRequestCycle) and IRequestHandler.detach(IRequestCycle) are ignored by the mock, as they are used by the wicket framework itself.

Parameters:

mockRequest - If the parameter is true, a mock request is created. Use this to verify the component's calls into Ajax. If the parameter is false, a mock request is not created and the default request created by the wicket framework is used instead. Use this to call into the component from Ajax.

resetTest

protected void resetTest()

Resets the test. Useful for running multiple components in the same test method.

apply

public org.apache.wicket.ajax.AjaxRequestTarget apply(org.apache.wicket.Page context)

This method is a part of IContextProvider<AjaxRequestTarget, Page> implementation and is not meant to be called by user code.

Specified by:

apply in interface Function<org.apache.wicket.Page,org.apache.wicket.ajax.AjaxRequestTarget>

See Also:

IContextProvider.get(java.lang.Object)