me.alb_i986.selenium.tinafw.tests

Class HtmlReportBuilder

java.lang.Object

me.alb_i986.selenium.tinafw.tests.HtmlReportBuilder

public class HtmlReportBuilder
extends Object

Encapsulates the logic for generating the HTML of a report. HtmlReportBuilder is designed with a fluent interface to allow clients to build a report by chaining the different parts of the report in any order (e.g.: title, info, screenshot, page source). There is one constrain, though:

• beginReport() must be called first (and never again)
• endReport() must be called last

It provides syntax highlighting (e.g. for page sources) thanks to google-code-prettify.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
HtmlReportBuilder(PrintWriter writer)

Method Summary

Modifier and Type	Method and Description
HtmlReportBuilder	beginReport() Begin the report by opening the tags html, head, body, table.
void	endReport() End the report by closing the tags table, body, html.
HtmlReportBuilder	info(String key, String value) Print the given <key, value> pair in its own line.
HtmlReportBuilder	pageSource(String pageSource) Print the given page source with pretty syntax highlighting.
HtmlReportBuilder	screenshot(String screenshotAsBase64) Prints a table row containing an img with the screenshot embedded in base64 format.
HtmlReportBuilder	title(String title) Print the title of the report.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.apache.log4j.Logger logger

Constructor Detail

HtmlReportBuilder

public HtmlReportBuilder(PrintWriter writer)

Method Detail

beginReport

public HtmlReportBuilder beginReport()

Begin the report by opening the tags html, head, body, table.

Returns:

this

endReport

public void endReport()

End the report by closing the tags table, body, html.

title

public HtmlReportBuilder title(String title)

Print the title of the report. If the given title is null, write an error message in place of the title.

Parameters:

title -

Returns:

this

pageSource

public HtmlReportBuilder pageSource(String pageSource)

Print the given page source with pretty syntax highlighting. If the arg is null, then print an error message in the report.

Parameters:

pageSource -

Returns:

this

screenshot

public HtmlReportBuilder screenshot(String screenshotAsBase64)

Prints a table row containing an img with the screenshot embedded in base64 format. If the argument is null, an error message will be printed.

Parameters:

screenshotAsBase64 - the screenshot as returned by TakesScreenshot.getScreenshotAs(org.openqa.selenium.OutputType)

See Also:

Data_URI_scheme @ Wikipedia

info

public HtmlReportBuilder info(String key,
                              String value)

Print the given <key, value> pair in its own line.

Parameters:

key -

value -

Returns:

this