Class BaseWicketTester
- java.lang.Object
-
- org.apache.wicket.util.tester.BaseWicketTester
-
- Direct Known Subclasses:
WicketTester
public class BaseWicketTester extends Object
A helper class to ease unit testing of Wicket applications without the need for a servlet container. See javadoc ofWicketTester
for example usage. This class can be used as is, but JUnit users should use derived classWicketTester
.- Since:
- 1.2.6
- Author:
- Ingram Chen, Juergen Donnerstag, Frank Bille, Igor Vaynberg
- See Also:
WicketTester
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BaseWicketTester.StartComponentInPage
A page that is used as the automatically created page forstartComponentInPage(Class)
and the other variations.class
BaseWicketTester.TestFilterConfig
-
Constructor Summary
Constructors Constructor Description BaseWicketTester()
CreatesWicketTester
and automatically create aWebApplication
, but the tester will have no home page.BaseWicketTester(Class<C> homePage)
CreatesWicketTester
and automatically creates aWebApplication
.BaseWicketTester(WebApplication application)
Creates aWicketTester
.BaseWicketTester(WebApplication application, boolean init)
Creates aWicketTester
.BaseWicketTester(WebApplication application, String servletContextBasePath)
Creates aWicketTester
.BaseWicketTester(WebApplication application, javax.servlet.ServletContext servletCtx)
Creates aWicketTester
.BaseWicketTester(WebApplication application, javax.servlet.ServletContext servletCtx, boolean init)
Creates aWicketTester
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addRequestHeader(String key, String value)
Allows to set Request header value any time.void
applyRequest()
RebuildsServletWebRequest
used by wicket from the mock request used to build requests.Component
assertExists(String path)
void
assertNotExists(String path)
void
assertResultPage(Class<?> pageClass, String filename)
Asserts last renderedPage
against an expected HTML document.protected Result
checkUsability(Component component, boolean throwException)
Checks whether a component is visible and/or enabled before usagevoid
cleanupFeedbackMessages()
Cleans up feedback messages.protected void
cleanupFeedbackMessages(IFeedbackMessageFilter filter)
Cleans up feedback messages given the specified filter.void
clearFeedbackMessages()
Removes all feedback messagesvoid
clickLink(String path)
Click theLink
in the last rendered Page.void
clickLink(String path, boolean isAjax)
Click theLink
in the last rendered Page.protected String
createOriginHeader()
Build value to Origin header based on RequestCycle Urlprotected Page
createPage()
Creates aPage
to test a component withstartComponentInPage(Component, IMarkupFragment)
protected String
createPageMarkup(String componentId)
Creates the markup that will be used for the automatically createdPage
that will be used to test a component withstartComponentInPage(Class, IMarkupFragment)
void
debugComponentTrees()
Dumps theComponent
trees.void
debugComponentTrees(String filter)
Dumps theComponent
trees to log.void
destroy()
Destroys the tester.void
dumpPage()
Dumps the source of last renderedPage
.void
executeAjaxEvent(String componentPath, String event)
Simulates the firing of an Ajax event.void
executeAjaxEvent(Component component, String event)
Simulates the firing of an Ajax event.void
executeAjaxUrl(Url url)
void
executeAllTimerBehaviors(MarkupContainer page)
Simulates the firing of all ajax timer behaviors on the pagevoid
executeBehavior(AbstractAjaxBehavior behavior)
Builds and processes a request suitable for executing anAbstractAjaxBehavior
.void
executeListener(Component component)
Simulates processing URL that invokes anIRequestListener
on a component.void
executeUrl(String _url)
Starts a page, a shared resource or aIRequestListener
depending on what theIRequestMapper
s resolve for the passed url.WebApplication
getApplication()
Returns theApplication
for this environment.Component
getComponentFromLastRenderedPage(String path)
Gets the component with the given path from last rendered page.Component
getComponentFromLastRenderedPage(String path, boolean wantVisibleInHierarchy)
Component
getComponentFromLastRenderedPage(String path, boolean wantVisibleInHierarchy, boolean failOnAbsent)
Gets the component with the given path from last rendered page.String
getContentDispositionFromResponseHeader()
Retrieves the content disposition from the response header.int
getContentLengthFromResponseHeader()
Retrieves the content length from the response header.String
getContentTypeFromResponseHeader()
Retrieves the content type from the response header.List<FeedbackMessage>
getFeedbackMessages(IFeedbackMessageFilter filter)
RetrievesFeedbackMessages
.MockHttpSession
getHttpSession()
ReturnsHttpSession
for this environmentString
getLastModifiedFromResponseHeader()
Retrieves the last-modified value from the response header.Page
getLastRenderedPage()
MockHttpServletRequest
getLastRequest()
MockHttpServletResponse
getLastResponse()
String
getLastResponseAsString()
The last response as a string when a page is tested viastartPage()
methods.List<Serializable>
getMessages(int level)
RetrievesFeedbackMessages
.List<MockHttpServletRequest>
getPreviousRequests()
List<MockHttpServletResponse>
getPreviousResponses()
MockHttpServletRequest
getRequest()
RequestCycle
getRequestCycle()
protected Duration
getResourcePollFrequency()
By default Modification Watcher is disabled by default for the tests.MockHttpServletResponse
getResponse()
javax.servlet.ServletContext
getServletContext()
Returns theServletContext
for this environmentSession
getSession()
TagTester
getTagById(String id)
Retrieves aTagTester
based on an DOM id.TagTester
getTagByWicketId(String wicketId)
Retrieves aTagTester
based on awicket:id
.List<TagTester>
getTagsByWicketId(String wicketId)
Modified version of BaseWicketTester#getTagByWicketId(String) that returns all matching tags instead of just the first.String
getWicketAjaxBaseUrlEncodedInLastResponse()
This method tries to parse the last response to return the encoded base URL and will throw an exception if there none was encoded.Result
hasLabel(String path, String expectedLabelText)
assert the text ofLabel
component.Result
hasNoErrorMessage()
Asserts no error-level feedback messages.Result
hasNoFeedbackMessage(int level)
Asserts there are no feedback messages with the given level.Result
hasNoInfoMessage()
Asserts no info-level feedback messages.Result
ifContains(String pattern)
assert the content of last rendered page contains(matches) regex pattern.Result
ifContainsNot(String pattern)
assert the content of last rendered page contains(matches) regex pattern.void
invokeListener(Component component)
Simulates invoking anIRequestListener
on a component.void
invokeListener(Component component, Behavior behavior)
Simulates invoking anIRequestListener
on a component.<C extends Component>
ResultisComponent(String path, Class<C> expectedComponentClass)
assert component classResult
isComponentOnAjaxResponse(Component component)
Tests that aComponent
has been added to aAjaxRequestTarget
, usingIPartialPageRequestHandler.add(org.apache.wicket.Component...)
.Result
isDisabled(String path)
assert component disabled.Result
isEnabled(String path)
assert component enabled.protected Result
isEqual(Object expected, Object actual)
boolean
isExposeExceptions()
boolean
isFollowRedirects()
Result
isInvisible(String path)
assert component invisible.Result
isNotRequired(String path)
Asserts that a component is not required.Result
isNotRequired(FormComponent<?> component)
Asserts that a component is not required.<C extends Page>
ResultisRenderedPage(Class<C> expectedRenderedPageClass)
Asserts the last renderedPage
class.Result
isRequired(String path)
assert component required.Result
isRequired(FormComponent<?> component)
assert component required.Result
isResultPage(String expectedDocument)
Asserts last renderedPage
against an expected HTML document as aString
.boolean
isUseRequestUrlAsBase()
Result
isVisible(String path)
assert component visible.FormTester
newFormTester(String path)
Creates aFormTester
for theForm
at a given path, and fills all childFormComponent
s with blankString
s.FormTester
newFormTester(String path, boolean fillBlankString)
Creates aFormTester
for theForm
at a given path.protected Response
newServletWebResponse(ServletWebRequest servletWebRequest)
protected IPageManagerProvider
newTestPageManagerProvider()
boolean
processRequest()
boolean
processRequest(MockHttpServletRequest request)
Processes the request in mocked Wicket environment.boolean
processRequest(MockHttpServletRequest request, IRequestHandler forcedRequestHandler)
Processes the request in mocked Wicket environment.protected boolean
processRequest(MockHttpServletRequest forcedRequest, IRequestHandler forcedRequestHandler, boolean redirect)
Process the request.boolean
processRequest(IRequestHandler forcedRequestHandler)
protected Locale
servletRequestLocale()
void
setExposeExceptions(boolean exposeExceptions)
void
setFollowRedirects(boolean followRedirects)
Sets whether responses with redirects will be followed automatically.void
setLastResponse(MockHttpServletResponse response)
void
setRequest(MockHttpServletRequest request)
void
setUseRequestUrlAsBase(boolean setBaseUrl)
<C extends Component>
CstartComponentInPage(C component)
Process a component.<C extends Component>
CstartComponentInPage(C component, IMarkupFragment pageMarkup)
Process a component.<C extends Component>
CstartComponentInPage(Class<C> componentClass)
Process a component.<C extends Component>
CstartComponentInPage(Class<C> componentClass, IMarkupFragment pageMarkup)
Process a component.<C extends Page>
CstartPage(Class<C> pageClass)
Renders aPage
from its default constructor.<C extends Page>
CstartPage(Class<C> pageClass, PageParameters parameters)
Renders aPage
from its default constructor.Page
startPage(IPageProvider pageProvider)
Renders the page specified by givenIPageProvider
.<T extends Page>
TstartPage(T page)
Renders the page.ResourceReference
startResource(IResource resource)
Simulates a request to a mountedIResource
ResourceReference
startResourceReference(ResourceReference reference)
Simulates a request to a mountedResourceReference
ResourceReference
startResourceReference(ResourceReference reference, PageParameters pageParameters)
Simulates a request to a mountedResourceReference
void
submitForm(String path)
void
submitForm(Form<?> form)
Submit the given form in the last renderedPage
Url
urlFor(AjaxLink<?> link)
String
urlFor(Link<?> link)
Url
urlFor(IRequestHandler handler)
Encodes theIRequestHandler
toUrl
.
-
-
-
Constructor Detail
-
BaseWicketTester
public BaseWicketTester()
CreatesWicketTester
and automatically create aWebApplication
, but the tester will have no home page.
-
BaseWicketTester
public BaseWicketTester(Class<C> homePage)
CreatesWicketTester
and automatically creates aWebApplication
.- Type Parameters:
C
-- Parameters:
homePage
- a home pageClass
-
BaseWicketTester
public BaseWicketTester(WebApplication application)
Creates aWicketTester
.- Parameters:
application
- aWicketTester
WebApplication
object
-
BaseWicketTester
public BaseWicketTester(WebApplication application, String servletContextBasePath)
Creates aWicketTester
.- Parameters:
application
- aWicketTester
WebApplication
objectservletContextBasePath
- the absolute path on disk to the web application's contents (e.g. war root) - may benull
-
BaseWicketTester
public BaseWicketTester(WebApplication application, javax.servlet.ServletContext servletCtx)
Creates aWicketTester
.- Parameters:
application
- aWicketTester
WebApplication
objectservletCtx
- the servlet context used as backend
-
BaseWicketTester
public BaseWicketTester(WebApplication application, boolean init)
Creates aWicketTester
.- Parameters:
application
- aWicketTester
WebApplication
objectinit
- force the application to be initialized (default = true)
-
BaseWicketTester
public BaseWicketTester(WebApplication application, javax.servlet.ServletContext servletCtx, boolean init)
Creates aWicketTester
.- Parameters:
application
- aWicketTester
WebApplication
objectservletCtx
- the servlet context used as backendinit
- force the application to be initialized (default = true)
-
-
Method Detail
-
getResourcePollFrequency
protected Duration getResourcePollFrequency()
By default Modification Watcher is disabled by default for the tests.- Returns:
- the duration between two checks for changes in the resources
-
newTestPageManagerProvider
protected IPageManagerProvider newTestPageManagerProvider()
- Returns:
- page manager provider
-
getLastRenderedPage
public Page getLastRenderedPage()
- Returns:
- last rendered page
-
servletRequestLocale
protected Locale servletRequestLocale()
-
cleanupFeedbackMessages
public void cleanupFeedbackMessages()
Cleans up feedback messages. This usually happens on detach, but is disabled in unit testing so feedback messages can be examined.
-
clearFeedbackMessages
public void clearFeedbackMessages()
Removes all feedback messages
-
cleanupFeedbackMessages
protected void cleanupFeedbackMessages(IFeedbackMessageFilter filter)
Cleans up feedback messages given the specified filter.- Parameters:
filter
- filter used to cleanup messages, accepted messages will be removed
-
newServletWebResponse
protected Response newServletWebResponse(ServletWebRequest servletWebRequest)
- Parameters:
servletWebRequest
-- Returns:
- servlet web response
-
getRequest
public MockHttpServletRequest getRequest()
- Returns:
- request object
-
setRequest
public void setRequest(MockHttpServletRequest request)
- Parameters:
request
-
-
setLastResponse
public void setLastResponse(MockHttpServletResponse response)
- Parameters:
response
-
-
getSession
public Session getSession()
- Returns:
- session
-
getHttpSession
public MockHttpSession getHttpSession()
ReturnsHttpSession
for this environment- Returns:
- session
-
getApplication
public WebApplication getApplication()
Returns theApplication
for this environment.- Returns:
- application
-
getServletContext
public javax.servlet.ServletContext getServletContext()
Returns theServletContext
for this environment- Returns:
- servlet context
-
destroy
public void destroy()
Destroys the tester. RestoresThreadContext
to state before instance ofWicketTester
was created.
-
processRequest
public boolean processRequest()
- Returns:
- true, if process was executed successfully
-
processRequest
public boolean processRequest(MockHttpServletRequest request)
Processes the request in mocked Wicket environment.- Parameters:
request
- request to process- Returns:
- true, if process was executed successfully
-
processRequest
public boolean processRequest(MockHttpServletRequest request, IRequestHandler forcedRequestHandler)
Processes the request in mocked Wicket environment.- Parameters:
request
- request to processforcedRequestHandler
- optional parameter to override parsing the request URL and forceIRequestHandler
- Returns:
- true, if process was executed successfully
-
processRequest
public boolean processRequest(IRequestHandler forcedRequestHandler)
- Parameters:
forcedRequestHandler
-- Returns:
- true, if process was executed successfully
-
processRequest
protected boolean processRequest(MockHttpServletRequest forcedRequest, IRequestHandler forcedRequestHandler, boolean redirect)
Process the request. This is a fairly central function and is almost always invoked for executing the request.You may subclass processRequest it, to monitor or change any pre-configured value. Request headers can be configured more easily by calling
addRequestHeader(String, String)
.- Parameters:
forcedRequest
- Can be null.forcedRequestHandler
- Can be null.redirect
-- Returns:
- true, if process was executed successfully
-
addRequestHeader
public final void addRequestHeader(String key, String value)
Allows to set Request header value any time. They'll be applied (add/modify) on process executionprocessRequest(MockHttpServletRequest, IRequestHandler, boolean)
. They are reset immediately after and thus are not re-used for a sequence of requests.Deletion (not replace) of pre-configured header value can be achieved by subclassing
processRequest(MockHttpServletRequest, IRequestHandler, boolean)
and modifying the request header directly.- Parameters:
key
-value
-
-
startPage
public Page startPage(IPageProvider pageProvider)
Renders the page specified by givenIPageProvider
. After render the page instance can be retrieved usinggetLastRenderedPage()
and the rendered document will be available ingetLastResponse()
. Depending onRequestCycleSettings.RenderStrategy
invoking this method can mean that a redirect will happen before the actual render.- Parameters:
pageProvider
-- Returns:
- last rendered page
-
startPage
public <T extends Page> T startPage(T page)
Renders the page.- Parameters:
page
-- Returns:
- Page
- See Also:
startPage(IPageProvider)
-
startResource
public ResourceReference startResource(IResource resource)
Simulates a request to a mountedIResource
- Parameters:
resource
- the resource to test- Returns:
- the used
ResourceReference
for the simulation
-
startResourceReference
public ResourceReference startResourceReference(ResourceReference reference)
Simulates a request to a mountedResourceReference
- Parameters:
reference
- the resource reference to test- Returns:
- the tested resource reference
-
startResourceReference
public ResourceReference startResourceReference(ResourceReference reference, PageParameters pageParameters)
Simulates a request to a mountedResourceReference
- Parameters:
reference
- the resource reference to testpageParameters
- the parameters passed to the resource reference- Returns:
- the tested resource reference
-
getLastResponse
public MockHttpServletResponse getLastResponse()
- Returns:
- last response or
null
if no response has been produced yet.
-
getLastResponseAsString
public String getLastResponseAsString()
The last response as a string when a page is tested viastartPage()
methods.In case the processed component was not a
Page
then the automatically created page markup gets removed. If you need the whole returned markup in this case usegetLastResponse()
.getDocument()
- Returns:
- last response as String.
-
getWicketAjaxBaseUrlEncodedInLastResponse
public String getWicketAjaxBaseUrlEncodedInLastResponse() throws IOException, ParseException
This method tries to parse the last response to return the encoded base URL and will throw an exception if there none was encoded.- Returns:
- Wicket-Ajax-BaseURL set on last response by
AbstractDefaultAjaxBehavior
- Throws:
IOException
ParseException
-
getPreviousRequests
public List<MockHttpServletRequest> getPreviousRequests()
- Returns:
- list of prior requests
-
getPreviousResponses
public List<MockHttpServletResponse> getPreviousResponses()
- Returns:
- list of prior responses
-
setFollowRedirects
public void setFollowRedirects(boolean followRedirects)
Sets whether responses with redirects will be followed automatically.- Parameters:
followRedirects
-
-
isFollowRedirects
public boolean isFollowRedirects()
- Returns:
true
if redirect responses will be followed automatically,false
otherwise.
-
urlFor
public Url urlFor(IRequestHandler handler)
Encodes theIRequestHandler
toUrl
. It should be safe to call this method outside request thread as log as no registeredIRequestMapper
requires aRequestCycle
.- Parameters:
handler
-- Returns:
Url
for handler.
-
executeListener
public void executeListener(Component component)
Simulates processing URL that invokes anIRequestListener
on a component. After the listener is invoked the page containing the component will be rendered (with an optional redirect - depending onRequestCycleSettings.RenderStrategy
).- Parameters:
component
-
-
invokeListener
public void invokeListener(Component component)
Simulates invoking anIRequestListener
on a component. As opposed to theexecuteListener(Component)
method, current request/response objects will be used After the listener is invoked the page containing the component will be rendered (with an optional redirect - depending onRequestCycleSettings.RenderStrategy
).- Parameters:
component
-
-
invokeListener
public void invokeListener(Component component, Behavior behavior)
Simulates invoking anIRequestListener
on a component. As opposed to theexecuteListener(Component)
method, current request/response objects will be used After the listener is invoked the page containing the component will be rendered (with an optional redirect - depending onRequestCycleSettings.RenderStrategy
).- Parameters:
component
-behavior
-
-
executeBehavior
public void executeBehavior(AbstractAjaxBehavior behavior)
Builds and processes a request suitable for executing anAbstractAjaxBehavior
.- Parameters:
behavior
- anAbstractAjaxBehavior
to execute
-
createOriginHeader
protected String createOriginHeader()
Build value to Origin header based on RequestCycle Url- Returns:
- Origin header
-
executeAjaxUrl
public void executeAjaxUrl(Url url)
- Parameters:
url
-
-
startPage
public final <C extends Page> C startPage(Class<C> pageClass)
Renders aPage
from its default constructor.- Type Parameters:
C
-- Parameters:
pageClass
- a testPage
class with default constructor- Returns:
- the rendered
Page
-
startPage
public final <C extends Page> C startPage(Class<C> pageClass, PageParameters parameters)
Renders aPage
from its default constructor.- Type Parameters:
C
-- Parameters:
pageClass
- a testPage
class with default constructorparameters
- the parameters to use for the class.- Returns:
- the rendered
Page
-
newFormTester
public FormTester newFormTester(String path)
Creates aFormTester
for theForm
at a given path, and fills all childFormComponent
s with blankString
s.- Parameters:
path
- path toFormComponent
- Returns:
- a
FormTester
instance for testing theForm
- See Also:
newFormTester(String, boolean)
-
newFormTester
public FormTester newFormTester(String path, boolean fillBlankString)
Creates aFormTester
for theForm
at a given path.- Parameters:
path
- path toFormComponent
fillBlankString
- specifies whether to fill all childFormComponent
s with blankString
s- Returns:
- a
FormTester
instance for testing theForm
- See Also:
FormTester
-
startComponentInPage
public final <C extends Component> C startComponentInPage(Class<C> componentClass)
Process a component. A web page will be automatically created with the markup created increatePageMarkup(String)
.Note: the instantiated component will have an auto-generated id. To reach any of its children use their relative path to the component itself. For example if the started component has a child a Link component with id "link" then after starting the component you can click it with:
tester.clickLink("link")
- Type Parameters:
C
- the type of the component- Parameters:
componentClass
- the class of the component to be tested- Returns:
- The component processed
- See Also:
startComponentInPage(org.apache.wicket.Component)
-
startComponentInPage
public final <C extends Component> C startComponentInPage(Class<C> componentClass, IMarkupFragment pageMarkup)
Process a component. A web page will be automatically created with thepageMarkup
provided. In case pageMarkup is null, the markup will be automatically created withcreatePageMarkup(String)
.Note: the instantiated component will have an auto-generated id. To reach any of its children use their relative path to the component itself. For example if the started component has a child a Link component with id "link" then after starting the component you can click it with:
tester.clickLink("link")
- Type Parameters:
C
- the type of the component- Parameters:
componentClass
- the class of the component to be testedpageMarkup
- the markup for the Page that will be automatically created. May benull
.- Returns:
- The component processed
-
startComponentInPage
public final <C extends Component> C startComponentInPage(C component)
Process a component. A web page will be automatically created with markup created by thecreatePageMarkup(String)
.Note: the component id is set by the user. To reach any of its children use this id + their relative path to the component itself. For example if the started component has id compId and a Link child component component with id "link" then after starting the component you can click it with:
tester.clickLink("compId:link")
- Type Parameters:
C
- the type of the component- Parameters:
component
- the component to be tested- Returns:
- The component processed
- See Also:
startComponentInPage(Class)
-
startComponentInPage
public final <C extends Component> C startComponentInPage(C component, IMarkupFragment pageMarkup)
Process a component. A web page will be automatically created with thepageMarkup
provided. In casepageMarkup
is null, the markup will be automatically created withcreatePageMarkup(String)
.Note: the component id is set by the user. To reach any of its children use this id + their relative path to the component itself. For example if the started component has id compId and a Link child component component with id "link" then after starting the component you can click it with:
tester.clickLink("compId:link")
- Type Parameters:
C
- the type of the component- Parameters:
component
- the component to be testedpageMarkup
- the markup for the Page that will be automatically created. May benull
.- Returns:
- The component processed
-
createPageMarkup
protected String createPageMarkup(String componentId)
Creates the markup that will be used for the automatically createdPage
that will be used to test a component withstartComponentInPage(Class, IMarkupFragment)
-
createPage
protected Page createPage()
Creates aPage
to test a component withstartComponentInPage(Component, IMarkupFragment)
- Returns:
- a
Page
which will contain the component under test as a single child
-
getComponentFromLastRenderedPage
public Component getComponentFromLastRenderedPage(String path, boolean wantVisibleInHierarchy)
-
getComponentFromLastRenderedPage
public Component getComponentFromLastRenderedPage(String path, boolean wantVisibleInHierarchy, boolean failOnAbsent)
Gets the component with the given path from last rendered page. This method fails in case the component couldn't be found.- Parameters:
path
- Path to componentwantVisibleInHierarchy
- if true component needs to be visible in hierarchy elsenull
is returned- Returns:
- The component at the path
- See Also:
MarkupContainer.get(String)
-
getComponentFromLastRenderedPage
public Component getComponentFromLastRenderedPage(String path)
Gets the component with the given path from last rendered page. This method fails in case the component couldn't be found, and it will return null if the component was found, but is not visible.- Parameters:
path
- Path to component- Returns:
- The component at the path
- See Also:
MarkupContainer.get(String)
-
hasLabel
public Result hasLabel(String path, String expectedLabelText)
assert the text ofLabel
component.- Parameters:
path
- path toLabel
componentexpectedLabelText
- expected label text- Returns:
- a
Result
-
isComponent
public <C extends Component> Result isComponent(String path, Class<C> expectedComponentClass)
assert component class- Type Parameters:
C
-- Parameters:
path
- path to componentexpectedComponentClass
- expected component class- Returns:
- a
Result
-
isVisible
public Result isVisible(String path)
assert component visible.- Parameters:
path
- path to component- Returns:
- a
Result
-
isInvisible
public Result isInvisible(String path)
assert component invisible.- Parameters:
path
- path to component- Returns:
- a
Result
-
isEnabled
public Result isEnabled(String path)
assert component enabled.- Parameters:
path
- path to component- Returns:
- a
Result
-
isDisabled
public Result isDisabled(String path)
assert component disabled.- Parameters:
path
- path to component- Returns:
- a
Result
-
assertExists
public Component assertExists(String path)
-
assertNotExists
public void assertNotExists(String path)
-
isRequired
public Result isRequired(String path)
assert component required.- Parameters:
path
- path to component- Returns:
- a
Result
-
isRequired
public Result isRequired(FormComponent<?> component)
assert component required.- Parameters:
component
- a form component- Returns:
- a
Result
-
isNotRequired
public Result isNotRequired(String path)
Asserts that a component is not required.- Parameters:
path
- path to component- Returns:
- a
Result
-
isNotRequired
public Result isNotRequired(FormComponent<?> component)
Asserts that a component is not required.- Parameters:
component
- a form component- Returns:
- a
Result
-
ifContains
public Result ifContains(String pattern)
assert the content of last rendered page contains(matches) regex pattern.- Parameters:
pattern
- reqex pattern to match- Returns:
- a
Result
-
ifContainsNot
public Result ifContainsNot(String pattern)
assert the content of last rendered page contains(matches) regex pattern.- Parameters:
pattern
- reqex pattern to match- Returns:
- a
Result
-
clickLink
public void clickLink(String path)
Click theLink
in the last rendered Page.Simulate that AJAX is enabled.
- Parameters:
path
- Click theLink
in the last rendered Page.- See Also:
clickLink(String, boolean)
-
clickLink
public void clickLink(String path, boolean isAjax)
Click theLink
in the last rendered Page.This method also works for
AjaxLink
,AjaxFallbackLink
andAjaxSubmitLink
.On AjaxLinks and AjaxFallbackLinks the onClick method is invoked with a valid AjaxRequestTarget. In that way you can test the flow of your application when using AJAX.
When clicking an AjaxSubmitLink the form, which the AjaxSubmitLink is attached to is first submitted, and then the onSubmit method on AjaxSubmitLink is invoked. If you have changed some values in the form during your test, these will also be submitted. This should not be used as a replacement for the
FormTester
to test your forms. It should be used to test that the code in your onSubmit method in AjaxSubmitLink actually works.This method is also able to simulate that AJAX (javascript) is disabled on the client. This is done by setting the isAjax parameter to false. If you have an AjaxFallbackLink you can then check that it doesn't fail when invoked as a normal link.
- Parameters:
path
- path toLink
componentisAjax
- Whether to simulate that AJAX (javascript) is enabled or not. If it's false then AjaxLink and AjaxSubmitLink will fail, since it wouldn't work in real life. AjaxFallbackLink will be invoked with null as the AjaxRequestTarget parameter.
-
submitForm
public void submitForm(Form<?> form)
Submit the given form in the last renderedPage
Note: Form request parameters have to be set explicitly.
- Parameters:
form
- path to component
-
submitForm
public void submitForm(String path)
Submits theForm
in the last renderedPage
.Note: Form request parameters have to be set explicitely.
- Parameters:
path
- path to component
-
isRenderedPage
public <C extends Page> Result isRenderedPage(Class<C> expectedRenderedPageClass)
Asserts the last renderedPage
class.- Type Parameters:
C
-- Parameters:
expectedRenderedPageClass
- expected class of last rendered page- Returns:
- a
Result
-
assertResultPage
public void assertResultPage(Class<?> pageClass, String filename) throws Exception
Asserts last renderedPage
against an expected HTML document.Use
-Dwicket.replace.expected.results=true
to automatically replace the expected output file.- Parameters:
pageClass
- used to load theFile
(relative toclazz
package)filename
- expected outputFile
name- Throws:
Exception
-
isResultPage
public Result isResultPage(String expectedDocument)
Asserts last renderedPage
against an expected HTML document as aString
.- Parameters:
expectedDocument
- expected output- Returns:
- a
Result
-
hasNoErrorMessage
public Result hasNoErrorMessage()
Asserts no error-level feedback messages.- Returns:
- a
Result
- See Also:
hasNoFeedbackMessage(int)
-
hasNoInfoMessage
public Result hasNoInfoMessage()
Asserts no info-level feedback messages.- Returns:
- a
Result
- See Also:
hasNoFeedbackMessage(int)
-
hasNoFeedbackMessage
public Result hasNoFeedbackMessage(int level)
Asserts there are no feedback messages with the given level.- Parameters:
level
- the level of the feedback message- Returns:
- a
Result
-
getMessages
public List<Serializable> getMessages(int level)
RetrievesFeedbackMessages
.- Parameters:
level
- level of feedback message, for example:FeedbackMessage.DEBUG or FeedbackMessage.INFO.. etc
- Returns:
List
of messages (asString
s)- See Also:
FeedbackMessage
-
getFeedbackMessages
public List<FeedbackMessage> getFeedbackMessages(IFeedbackMessageFilter filter)
RetrievesFeedbackMessages
.- Parameters:
filter
- A filter that decides which messages to collect- Returns:
List
of messages (asString
s)- See Also:
FeedbackMessage
-
dumpPage
public void dumpPage()
Dumps the source of last renderedPage
.
-
debugComponentTrees
public void debugComponentTrees()
Dumps theComponent
trees.
-
debugComponentTrees
public void debugComponentTrees(String filter)
Dumps theComponent
trees to log. Show only theComponent
s whose paths contain the filterString
.- Parameters:
filter
- a filterString
-
isComponentOnAjaxResponse
public Result isComponentOnAjaxResponse(Component component)
Tests that aComponent
has been added to aAjaxRequestTarget
, usingIPartialPageRequestHandler.add(org.apache.wicket.Component...)
. This method actually tests that aComponent
is on the Ajax response sent back to the client.PLEASE NOTE! This method doesn't actually insert the
Component
in the client DOM tree, using JavaScript. But it shouldn't be needed because you have to trust that the Wicket Ajax JavaScript just works.- Parameters:
component
- theComponent
to test- Returns:
- a
Result
-
executeAjaxEvent
public void executeAjaxEvent(String componentPath, String event)
Simulates the firing of an Ajax event.- Parameters:
componentPath
- theComponent
pathevent
- the event which we simulate being fired. Ifevent
isnull
, the test will fail.- Since:
- 1.2.3
- See Also:
executeAjaxEvent(Component, String)
-
executeAllTimerBehaviors
public void executeAllTimerBehaviors(MarkupContainer page)
Simulates the firing of all ajax timer behaviors on the page- Parameters:
page
- the page which timers will be executed
-
executeAjaxEvent
public void executeAjaxEvent(Component component, String event)
Simulates the firing of an Ajax event. You add an Ajax event to aComponent
by using:... component.add(new AjaxEventBehavior("ondblclick") { public void onEvent(AjaxRequestTarget) {} }); ...
You can then test that the code insideonEvent
actually does what it's supposed to, using theWicketTester
:... tester.executeAjaxEvent(component, "ondblclick"); // Test that the code inside onEvent is correct. ...
This also works withAjaxFormSubmitBehavior
, where it will "submit" theForm
before executing the command.PLEASE NOTE! This method doesn't actually insert the
Component
in the client DOM tree, using JavaScript.- Parameters:
component
- theComponent
that has theAjaxEventBehavior
we want to test. If theComponent
isnull
, the test will fail.event
- the event to simulate being fired. Ifevent
isnull
, the test will fail.
-
getTagByWicketId
public TagTester getTagByWicketId(String wicketId)
Retrieves aTagTester
based on awicket:id
. If moreComponent
s exist with the samewicket:id
in the markup, only the first one is returned.- Parameters:
wicketId
- thewicket:id
to search for- Returns:
- the
TagTester
for the tag which has the givenwicket:id
-
getTagsByWicketId
public List<TagTester> getTagsByWicketId(String wicketId)
Modified version of BaseWicketTester#getTagByWicketId(String) that returns all matching tags instead of just the first.- Parameters:
wicketId
-- Returns:
- List of Tags
-
getTagById
public TagTester getTagById(String id)
Retrieves aTagTester
based on an DOM id. If moreComponent
s exist with the same id in the markup, only the first one is returned.- Parameters:
id
- the DOM id to search for.- Returns:
- the
TagTester
for the tag which has the given DOM id
-
getContentTypeFromResponseHeader
public String getContentTypeFromResponseHeader()
Retrieves the content type from the response header.- Returns:
- the content type from the response header
-
getContentLengthFromResponseHeader
public int getContentLengthFromResponseHeader()
Retrieves the content length from the response header.- Returns:
- the content length from the response header
-
getLastModifiedFromResponseHeader
public String getLastModifiedFromResponseHeader()
Retrieves the last-modified value from the response header.- Returns:
- the last-modified value from the response header
-
getContentDispositionFromResponseHeader
public String getContentDispositionFromResponseHeader()
Retrieves the content disposition from the response header.- Returns:
- the content disposition from the response header
-
applyRequest
public void applyRequest()
RebuildsServletWebRequest
used by wicket from the mock request used to build requests. Sometimes this method is useful when changes need to be checked without processing a request.
-
isEqual
protected final Result isEqual(Object expected, Object actual)
- Parameters:
expected
-actual
-- Returns:
- fail with message if not equal
-
checkUsability
protected Result checkUsability(Component component, boolean throwException)
Checks whether a component is visible and/or enabled before usage- Parameters:
component
-throwException
-- Returns:
- result
-
getRequestCycle
public RequestCycle getRequestCycle()
- Returns:
- request cycle
-
getResponse
public MockHttpServletResponse getResponse()
- Returns:
- servlet response
-
getLastRequest
public MockHttpServletRequest getLastRequest()
- Returns:
- last request
-
isExposeExceptions
public boolean isExposeExceptions()
- Returns:
- true, if exceptions are exposed
-
setExposeExceptions
public void setExposeExceptions(boolean exposeExceptions)
- Parameters:
exposeExceptions
-
-
isUseRequestUrlAsBase
public boolean isUseRequestUrlAsBase()
- Returns:
- useRequestUrlAsBase
-
setUseRequestUrlAsBase
public void setUseRequestUrlAsBase(boolean setBaseUrl)
- Parameters:
setBaseUrl
-
-
executeUrl
public void executeUrl(String _url)
Starts a page, a shared resource or aIRequestListener
depending on what theIRequestMapper
s resolve for the passed url.- Parameters:
_url
- the url to resolve and execute
-
-