com.github.andreptb.fitnesse.util

Class FitnesseMarkup

java.lang.Object

com.github.andreptb.fitnesse.util.FitnesseMarkup

public class FitnesseMarkup
extends Object

General utilities to process FitNesse markup syntax so can be used by Selenium Fixture

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_VALUE_SEPARATOR Constant representing type separator [type]=[value]
static String	OFF_VALUE off value constant, see booleanToOnOrOff(Object)
static String	ON_VALUE on value constant, see booleanToOnOrOff(Object)
static String	SELECTOR_ATTRIBUTE_SEPARATOR Constants representing selector separators [selector]@[atributte]$[value]
static String	SELECTOR_VALUE_DENY_INDICATOR Constant representing the negation flag in SELECTOR_VALUE_SEPARATOR
static String	SELECTOR_VALUE_SEPARATOR Constant representing the value separator in selector [selector]@[atributte]->[value]

Constructor Summary

Constructors

Constructor and Description
FitnesseMarkup()

Method Summary

Modifier and Type	Method and Description
String	booleanToOnOrOff(Object value) Cleans and converts true or false value to ON_VALUE or OFF_VALUE
String	clean(Object symbol) Cleans FitNesse markup from symbols such as: Extracts a keyboard special key value from special key markup.
org.apache.commons.lang3.tuple.Pair<String,String>	cleanAndParseKeyValue(Object value, String separator) Cleans and split the value in [key][separator][value] format.
File	cleanFile(Object... value)
boolean	compare(Object expected, Object obtained) Compares two values emulating FitNesse comparisons:
String	exceptionMessage(Object originalMessage, String screenshotData, Object... args) Produces a custom SLIM response containing the original exception message along with a screenshot, probably taken when the exception occured.
String	formatWidthAndHeight(Object width, Object height)
String	imgLink(Object img) Creates img markup to be viewed in test page.
String	imgLinkFromExceptionMessage(String exceptionMessage) Creates img markup to be viewed in test page.
boolean	onOrOffToBoolean(Object value) Cleans and converts ON_VALUE or OFF_VALUE value to boolean.
org.apache.commons.lang3.tuple.Pair<Integer,Integer>	parseWidthAndHeight(String widthAndHeight)
void	registerKeyboardSpecialKey(String keyName, String keyValue) Registers a system property (System.setProperty(String, String)) allowing user to develop tests referencing special keys such as tab and enter by using variables.
org.apache.commons.lang3.tuple.Pair<String,String>	swapValueToCheck(String stringWithValue, String stringToGetValue)

Methods inherited from class java.lang.Object

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

Field Detail

SELECTOR_VALUE_SEPARATOR

public static final String SELECTOR_VALUE_SEPARATOR

Constant representing the value separator in selector [selector]@[atributte]->[value]

See Also:

Constant Field Values

SELECTOR_VALUE_DENY_INDICATOR

public static final String SELECTOR_VALUE_DENY_INDICATOR

Constant representing the negation flag in SELECTOR_VALUE_SEPARATOR

See Also:

Constant Field Values

SELECTOR_ATTRIBUTE_SEPARATOR

public static final String SELECTOR_ATTRIBUTE_SEPARATOR

Constants representing selector separators [selector]@[atributte]$[value]

See Also:

Constant Field Values

KEY_VALUE_SEPARATOR

public static final String KEY_VALUE_SEPARATOR

Constant representing type separator [type]=[value]

See Also:

Constant Field Values

ON_VALUE

public static final String ON_VALUE

on value constant, see booleanToOnOrOff(Object)

See Also:

Constant Field Values

OFF_VALUE

public static final String OFF_VALUE

off value constant, see booleanToOnOrOff(Object)

See Also:

Constant Field Values

Constructor Detail

FitnesseMarkup

public FitnesseMarkup()

Method Detail

compare

public boolean compare(Object expected,
                       Object obtained)

Compares two values emulating FitNesse comparisons:

http://fitnesse.org/FitNesse.FullReferenceGuide.UserGuide.WritingAcceptanceTests.SliM.ValueComparisons

For now supports only exact equal and regular expression comparisons

Parameters:

expected - value

obtained - value

Returns:

comparisonResult

clean

public String clean(Object symbol)

Cleans FitNesse markup from symbols such as:

• Extracts a keyboard special key value from special key markup. See #
• Extracts URL only from HTML generated links
• Extracts text from HTML wiki page creation suggestion link
• Strips undefined variable ocurrences on text
• If value is associated with

Parameters:

symbol - to be cleaned

Returns:

cleanedSymbol

imgLink

public String imgLink(Object img)

Creates img markup to be viewed in test page. Usually used by fixtures that wants to return a image link for the test result.

Parameters:

img - File containing the image

Returns:

Image link

imgLinkFromExceptionMessage

public String imgLinkFromExceptionMessage(String exceptionMessage)

Creates img markup to be viewed in test page. Extracts the image content from an exception message generated by exceptionMessage(Object, String, Object...)

Parameters:

exceptionMessage - to be parsed

Returns:

image link

registerKeyboardSpecialKey

public void registerKeyboardSpecialKey(String keyName,
                                       String keyValue)

Registers a system property (System.setProperty(String, String)) allowing user to develop tests referencing special keys such as tab and enter by using variables. For example:

If keyName="tab" and keyValue="" then ${KEY_TAB} will resolve to "<span keycode="">tab</span>"

Parameters:

keyName - Special keyboard key name

keyValue - Special keyboard key value

swapValueToCheck

public org.apache.commons.lang3.tuple.Pair<String,String> swapValueToCheck(String stringWithValue,
                                                                           String stringToGetValue)

cleanFile

public File cleanFile(Object... value)

Parameters:

value - file path parts

Returns:

normalized a file path, cleaning each path part and joining with current operating system separator

cleanAndParseKeyValue

public org.apache.commons.lang3.tuple.Pair<String,String> cleanAndParseKeyValue(Object value,
                                                                                String separator)

Cleans and split the value in [key][separator][value] format.

Parameters:

value - to parse, should be in [key][separator][value]

separator - to be used

Returns:

instance of Pair containing key and value

booleanToOnOrOff

public String booleanToOnOrOff(Object value)

Cleans and converts true or false value to ON_VALUE or OFF_VALUE

Parameters:

value - to be converted

Returns:

converted value, ON_VALUE if value is true or ON_VALUE itself

onOrOffToBoolean

public boolean onOrOffToBoolean(Object value)

Cleans and converts ON_VALUE or OFF_VALUE value to boolean.

Parameters:

value - to be converted

Returns:

converted value, true if value is ON_VALUE, false otherwise

formatWidthAndHeight

public String formatWidthAndHeight(Object width,
                                   Object height)

Parameters:

width - Numeric value representing a width value

height - Numeric value representing a height value

Returns:

formatted width and height. If width=1024 and height=768, will output 1024x768

parseWidthAndHeight

public org.apache.commons.lang3.tuple.Pair<Integer,Integer> parseWidthAndHeight(String widthAndHeight)

Parameters:

widthAndHeight - String containing width and height, separated by WIDTH_HEIGHT_SEPARATOR. Example: 1920x1080, 1280x720.

Returns:

instance of Pair containing width in Pair.getLeft() and height in Pair.getRight()

exceptionMessage

public String exceptionMessage(Object originalMessage,
                               String screenshotData,
                               Object... args)

Produces a custom SLIM response containing the original exception message along with a screenshot, probably taken when the exception occured.

Parameters:

originalMessage - message taken from the exception

screenshotData - screenshot data in base64 format

args - extra arguments to be interpolated in Format.format(Object)

Returns:

formatted message