org.xwiki.test.page

Class PageTest

java.lang.Object

org.xwiki.test.page.PageTest

@OldcoreTest
 @PageComponentList
public class PageTest
extends Object

A testing framework to write integration tests for wiki pages. The philosophy is that these tests will use the real code / components to the max and tests should only need to mock the environment (database, file system, REST calls, remote SOLR, etc). Tests should extend this class and call loadPage(org.xwiki.model.reference.DocumentReference) or renderPage(org.xwiki.model.reference.DocumentReference) to load and render a page located in the classpath.

Since:

7.3M1

Version:

$Id: 07b780afe3d68cf753d56c26e4a919758d377332 $

Field Summary

Fields

Modifier and Type	Field and Description
protected org.xwiki.test.mockito.MockitoComponentManager	componentManager The Component Manager to use for getting Component instances or registering Mock Components in the test, provided for ease of use (can also be retrieved through oldcore).
protected com.xpn.xwiki.XWikiContext	context The configured XWiki Context, provided for ease of use (can also be retrieved through oldcore).
protected com.xpn.xwiki.test.MockitoOldcore	oldcore
protected XWikiServletRequestStub	request The stubbed request used to simulate a real Servlet Request.
protected XWikiServletResponseStub	response The stubbed response used to simulate a real Servlet Response.
protected com.xpn.xwiki.XWiki	xwiki The mocked XWiki instance, provided for ease of use (can also be retrieved through oldcore).

Constructor Summary

Constructors

Constructor and Description
PageTest()

Method Summary

Modifier and Type	Method and Description
void	configureComponentsBeforeOldcoreRuleForPageTest(org.xwiki.test.mockito.MockitoComponentManager componentManager) Set up of Components after the Components declared in ComponentList have been handled but before MockitoOldcore.before(Class) has been called (i.e.
protected com.xpn.xwiki.doc.XWikiDocument	loadPage(org.xwiki.model.reference.DocumentReference documentReference)
protected void	registerVelocityTool(String name, Object tool) Adds a tool to the Velocity context.
protected org.jsoup.nodes.Document	renderHTMLPage(org.xwiki.model.reference.DocumentReference reference) Load the provided document reference, render the loaded document and parse the result using Jsoup.
protected org.jsoup.nodes.Document	renderHTMLPage(com.xpn.xwiki.doc.XWikiDocument document) Render the provided document and parse the result using Jsoup.
protected String	renderPage(org.xwiki.model.reference.DocumentReference reference)
protected void	setOutputSyntax(org.xwiki.rendering.syntax.Syntax syntax) Sets the Syntax with which the Document to test will be rendered into.
void	setUpComponentsForPageTest(org.xwiki.test.mockito.MockitoComponentManager componentManager) Set up components before Components declared in ComponentList are handled.

Methods inherited from class java.lang.Object

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

Field Detail

oldcore

@InjectMockitoOldcore
protected com.xpn.xwiki.test.MockitoOldcore oldcore

request

protected XWikiServletRequestStub request

The stubbed request used to simulate a real Servlet Request.

response

protected XWikiServletResponseStub response

The stubbed response used to simulate a real Servlet Response.

xwiki

protected com.xpn.xwiki.XWiki xwiki

The mocked XWiki instance, provided for ease of use (can also be retrieved through oldcore).

context

protected com.xpn.xwiki.XWikiContext context

The configured XWiki Context, provided for ease of use (can also be retrieved through oldcore).

componentManager

@InjectComponentManager
protected org.xwiki.test.mockito.MockitoComponentManager componentManager

The Component Manager to use for getting Component instances or registering Mock Components in the test, provided for ease of use (can also be retrieved through oldcore).

Constructor Detail

PageTest

public PageTest()

Method Detail

setUpComponentsForPageTest

@BeforeComponent
public void setUpComponentsForPageTest(org.xwiki.test.mockito.MockitoComponentManager componentManager)
                                                 throws Exception

Set up components before Components declared in ComponentList are handled.

Parameters:

componentManager - the component manager to use to register mock components

Throws:

Exception - in case of errors

configureComponentsBeforeOldcoreRuleForPageTest

@AfterComponent
public void configureComponentsBeforeOldcoreRuleForPageTest(org.xwiki.test.mockito.MockitoComponentManager componentManager)
                                                                     throws Exception

Set up of Components after the Components declared in ComponentList have been handled but before MockitoOldcore.before(Class) has been called (i.e. before it has created Mocks and configured Components).

Parameters:

componentManager - the component manager

Throws:

Exception - in case of errors

loadPage

protected com.xpn.xwiki.doc.XWikiDocument loadPage(org.xwiki.model.reference.DocumentReference documentReference)
                                            throws Exception

Parameters:

documentReference - the reference of the Document to load from the ClassLoader

Returns:

the loaded document

Throws:

Exception - in case of errors

renderPage

protected String renderPage(org.xwiki.model.reference.DocumentReference reference)
                     throws Exception

Parameters:

reference - the reference of the Document to load and render (and thus load from the Classloader)

Returns:

the result of rendering the Document corresponding to the passed reference

Throws:

Exception - in case of errors

renderHTMLPage

protected org.jsoup.nodes.Document renderHTMLPage(org.xwiki.model.reference.DocumentReference reference)
                                           throws Exception

Load the provided document reference, render the loaded document and parse the result using Jsoup.

Parameters:

reference - the reference of the Document to load, render, and parse (and thus load from the Classloader)

Returns:

the result of the parsing of the rendered result using Jsoup

Throws:

Exception - in case of errors

renderHTMLPage

protected org.jsoup.nodes.Document renderHTMLPage(com.xpn.xwiki.doc.XWikiDocument document)
                                           throws Exception

Render the provided document and parse the result using Jsoup.

Parameters:

document - the document to render and parse

Returns:

the result of the parsing of the rendered result using Jsoup

Throws:

Exception - in case of errors

setOutputSyntax

protected void setOutputSyntax(org.xwiki.rendering.syntax.Syntax syntax)
                        throws Exception

Sets the Syntax with which the Document to test will be rendered into. If not called, the Document will be rendered as XHTML.

Parameters:

syntax - the Syntax to render the Document into

Throws:

Exception - in case of errors

registerVelocityTool

protected void registerVelocityTool(String name,
                                    Object tool)
                             throws Exception

Adds a tool to the Velocity context.

Parameters:

name - the name of the tool

tool - the tool to register; can be a mock

Throws:

Exception - in case of errors

Since:

7.4M1