org.doctester

Class DocTester

java.lang.Object

org.doctester.DocTester

All Implemented Interfaces:

RenderMachineCommands, TestBrowser

public abstract class DocTester
extends Object
implements TestBrowser, RenderMachineCommands

Field Summary

Fields

Modifier and Type	Field and Description
protected static RenderMachine	renderMachine
org.junit.rules.TestRule	testWatcher

Constructor Summary

Constructors

Constructor and Description
DocTester()

Method Summary

Modifier and Type	Method and Description
void	clearCookies() The TestBrowser persists the cookie storage during multiple calls.
static void	finishDocTest()
List<org.apache.http.cookie.Cookie>	getCookies()
org.apache.http.cookie.Cookie	getCookieWithName(String name) Get cookie with a specific name.
RenderMachine	getRenderMachine() You may override this method if you want to supply your own rendering machine for your class or classes.
TestBrowser	getTestBrowser() You may override this method if you want to supply your own testbrowser for your class or classes.
void	initRenderingMachineIfNull()
Response	makeRequest(Request httpRequest) Make calls via this testBrowser.
void	say(String textAsParagraph) A text that will be wrapped inside a paragraph.
<T> void	sayAndAssertThat(String message, String reason, T actual, org.hamcrest.Matcher<? super T> matcher)
<T> void	sayAndAssertThat(String message, T actual, org.hamcrest.Matcher<? super T> matcher)
List<org.apache.http.cookie.Cookie>	sayAndGetCookies()
org.apache.http.cookie.Cookie	sayAndGetCookieWithName(String name)
Response	sayAndMakeRequest(Request httpRequest)
void	sayNextSection(String textAsH1) A text that will be wrapped inside a h1.
void	sayRaw(String rawHtml) If you want to let the renderer render some raw custom html use this method.
void	setClassNameForDocTesterOutputFile(String name) Alternative way to set the output file name.
void	setupForTestCaseMethod()
Url	testServerUrl() Convenience method that allows you to write tests with the testbrowser in a fluent way.

Methods inherited from class java.lang.Object

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

Field Detail

testWatcher

public org.junit.rules.TestRule testWatcher

renderMachine

protected static RenderMachine renderMachine

Constructor Detail

DocTester

public DocTester()

Method Detail

setupForTestCaseMethod

public void setupForTestCaseMethod()

initRenderingMachineIfNull

public void initRenderingMachineIfNull()

finishDocTest

public static void finishDocTest()

say

public final void say(String textAsParagraph)

Description copied from interface: RenderMachineCommands

A text that will be wrapped inside a paragraph. No escaping is done. You can use your own html tags inside the text.

Specified by:

say in interface RenderMachineCommands

Parameters:

textAsParagraph - A text that may contain html tags like "This is my bold text".

sayNextSection

public final void sayNextSection(String textAsH1)

Description copied from interface: RenderMachineCommands

A text that will be wrapped inside a h1. No escaping is done. You can use your own html tags inside the text.

Specified by:

sayNextSection in interface RenderMachineCommands

Parameters:

textAsH1 - A text that may contain html tags like "This is my headline text".

sayRaw

public final void sayRaw(String rawHtml)

Description copied from interface: RenderMachineCommands

If you want to let the renderer render some raw custom html use this method.

Specified by:

sayRaw in interface RenderMachineCommands

Parameters:

rawHtml - A raw plain html String like "

Another headline

"

sayAndAssertThat

public final <T> void sayAndAssertThat(String message,
                                       String reason,
                                       T actual,
                                       org.hamcrest.Matcher<? super T> matcher)

Specified by:

sayAndAssertThat in interface RenderMachineCommands

sayAndAssertThat

public final <T> void sayAndAssertThat(String message,
                                       T actual,
                                       org.hamcrest.Matcher<? super T> matcher)

Specified by:

sayAndAssertThat in interface RenderMachineCommands

getCookies

public final List<org.apache.http.cookie.Cookie> getCookies()

Specified by:

getCookies in interface TestBrowser

Returns:

all cookies saved by this TestBrowser.

sayAndGetCookies

public final List<org.apache.http.cookie.Cookie> sayAndGetCookies()

Specified by:

sayAndGetCookies in interface RenderMachineCommands

Returns:

all cookies saved by this TestBrowser.

getCookieWithName

public final org.apache.http.cookie.Cookie getCookieWithName(String name)

Description copied from interface: TestBrowser

Get cookie with a specific name.

Specified by:

getCookieWithName in interface TestBrowser

Parameters:

name - Name of the cookie

Returns:

The value of the cookie or null if not there

sayAndGetCookieWithName

public final org.apache.http.cookie.Cookie sayAndGetCookieWithName(String name)

Specified by:

sayAndGetCookieWithName in interface RenderMachineCommands

clearCookies

public final void clearCookies()

Description copied from interface: TestBrowser

The TestBrowser persists the cookie storage during multiple calls. If you want to wipe out the CookieStorage you can call this method.

Specified by:

clearCookies in interface TestBrowser

makeRequest

public final Response makeRequest(Request httpRequest)

Description copied from interface: TestBrowser

Make calls via this testBrowser. Use Request.GET(), Request.POST()... and so on to make GET, POST and so on requests.

Specified by:

makeRequest in interface TestBrowser

Parameters:

httpRequest - The request to perform

Returns:

The response of this request.

sayAndMakeRequest

public final Response sayAndMakeRequest(Request httpRequest)

Specified by:

sayAndMakeRequest in interface RenderMachineCommands

getTestBrowser

public TestBrowser getTestBrowser()

You may override this method if you want to supply your own testbrowser for your class or classes.

Returns:

a TestBrowser that will be used for each test method.

getRenderMachine

public RenderMachine getRenderMachine()

You may override this method if you want to supply your own rendering machine for your class or classes.

Returns:

a RenderMachine that generates output and lives for a whole test class.

testServerUrl

public Url testServerUrl()

Convenience method that allows you to write tests with the testbrowser in a fluent way. sayAndMakeRequest( Request .GET() .url(testServerUrl().path("search").addQueryParameter("q", "toys")));

Returns:

a valid host name of your test server (eg http://localhost:8127). This will be used in the testServerUrl() method.

setClassNameForDocTesterOutputFile

public void setClassNameForDocTesterOutputFile(String name)

Alternative way to set the output file name. This can be handy when DocTester is not part of JUnit lifecycle.

Parameters:

name - alternative name of output file