com.vladsch.flexmark.test

Class RenderingTestCase

java.lang.Object

com.vladsch.flexmark.test.RenderingTestCase

All Implemented Interfaces:

ActualExampleModifier

Direct Known Subclasses:

FileSpecTestCase, FullSpecTestCase, SpecTestCase

public abstract class RenderingTestCase
extends Object
implements ActualExampleModifier

Field Summary

Fields

Modifier and Type	Field and Description
static com.vladsch.flexmark.util.data.DataKey<Boolean>	EMBED_TIMED
static String	EMBED_TIMED_OPTION_NAME
static com.vladsch.flexmark.util.data.DataKey<Boolean>	FAIL
static String	FAIL_OPTION_NAME
static String	FILE_EOL_OPTION_NAME
static com.vladsch.flexmark.util.data.DataKey<Boolean>	IGNORE
static String	IGNORE_OPTION_NAME
static com.vladsch.flexmark.util.data.DataKey<String>	INCLUDED_DOCUMENT
static com.vladsch.flexmark.util.data.DataKey<Boolean>	NO_FILE_EOL
static String	NO_FILE_EOL_OPTION_NAME
static com.vladsch.flexmark.util.data.DataKey<String>	SOURCE_INDENT
static com.vladsch.flexmark.util.data.DataKey<String>	SOURCE_PREFIX
static com.vladsch.flexmark.util.data.DataKey<String>	SOURCE_SUFFIX
org.junit.rules.ExpectedException	thrown
static com.vladsch.flexmark.util.data.DataKey<Boolean>	TIMED
static String	TIMED_FORMAT_STRING
static com.vladsch.flexmark.util.data.DataKey<Integer>	TIMED_ITERATIONS
static String	TIMED_ITERATIONS_NAME
static String	TIMED_OPTION_NAME

Constructor Summary

Constructors

Constructor and Description
RenderingTestCase()

Method Summary

Modifier and Type	Method and Description
String	actualAst(String ast, String optionSet)
String	actualHtml(String html, String optionSet)
String	actualSource(String source, String optionSet)
protected com.vladsch.flexmark.util.ast.IParse	adjustParserForInclusion(com.vladsch.flexmark.util.ast.IParse parserWithOptions, com.vladsch.flexmark.util.ast.Document includedDocument)
protected void	assertAst(UrlString fileUrl, String source, String expectedAst, String optionsSet)
protected void	assertRendering(String source, String expectedHtml)
protected void	assertRendering(UrlString fileUrl, String source, String expectedHtml)
protected void	assertRendering(UrlString fileUrl, String source, String expectedHtml, String optionsSet)
protected void	assertRenderingAst(UrlString fileUrl, String source, String expectedHtml, String expectedAst, String optionsSet)
String	ast(com.vladsch.flexmark.util.ast.Node node)
abstract SpecExample	example()
com.vladsch.flexmark.util.data.DataHolder	getOptions(SpecExample example, String optionSets) process comma separated list of option sets and combine them for final set to use
com.vladsch.flexmark.util.data.DataHolder	options(String optionSet) Customize options for an example
abstract com.vladsch.flexmark.util.ast.IParse	parser()
abstract com.vladsch.flexmark.util.ast.IRender	renderer()
protected void	specExample(String expected, String actual, String optionSet)
static com.vladsch.flexmark.util.sequence.BasedSequence	stripIndent(com.vladsch.flexmark.util.sequence.BasedSequence input, CharSequence sourceIndent)
protected void	testCase(com.vladsch.flexmark.util.ast.Node node, com.vladsch.flexmark.util.data.DataHolder options)
boolean	useActualHtml()

Methods inherited from class java.lang.Object

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

Field Detail

IGNORE_OPTION_NAME

public static final String IGNORE_OPTION_NAME

See Also:

Constant Field Values

FAIL_OPTION_NAME

public static final String FAIL_OPTION_NAME

See Also:

Constant Field Values

NO_FILE_EOL_OPTION_NAME

public static final String NO_FILE_EOL_OPTION_NAME

See Also:

Constant Field Values

FILE_EOL_OPTION_NAME

public static final String FILE_EOL_OPTION_NAME

See Also:

Constant Field Values

TIMED_ITERATIONS_NAME

public static final String TIMED_ITERATIONS_NAME

See Also:

Constant Field Values

TIMED_OPTION_NAME

public static final String TIMED_OPTION_NAME

See Also:

Constant Field Values

EMBED_TIMED_OPTION_NAME

public static final String EMBED_TIMED_OPTION_NAME

See Also:

Constant Field Values

TIMED_FORMAT_STRING

public static final String TIMED_FORMAT_STRING

See Also:

Constant Field Values

FAIL

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> FAIL

IGNORE

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> IGNORE

NO_FILE_EOL

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> NO_FILE_EOL

TIMED

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> TIMED

TIMED_ITERATIONS

public static final com.vladsch.flexmark.util.data.DataKey<Integer> TIMED_ITERATIONS

EMBED_TIMED

public static final com.vladsch.flexmark.util.data.DataKey<Boolean> EMBED_TIMED

INCLUDED_DOCUMENT

public static final com.vladsch.flexmark.util.data.DataKey<String> INCLUDED_DOCUMENT

SOURCE_PREFIX

public static final com.vladsch.flexmark.util.data.DataKey<String> SOURCE_PREFIX

SOURCE_SUFFIX

public static final com.vladsch.flexmark.util.data.DataKey<String> SOURCE_SUFFIX

SOURCE_INDENT

public static final com.vladsch.flexmark.util.data.DataKey<String> SOURCE_INDENT

thrown

public org.junit.rules.ExpectedException thrown

Constructor Detail

RenderingTestCase

public RenderingTestCase()

Method Detail

parser

public abstract com.vladsch.flexmark.util.ast.IParse parser()

renderer

public abstract com.vladsch.flexmark.util.ast.IRender renderer()

example

public abstract SpecExample example()

options

public com.vladsch.flexmark.util.data.DataHolder options(String optionSet)

Customize options for an example

Parameters:

optionSet - name of the options set to use

Returns:

options or null to use default

getOptions

public com.vladsch.flexmark.util.data.DataHolder getOptions(SpecExample example,
                                                            String optionSets)

process comma separated list of option sets and combine them for final set to use

Parameters:

example - spec example instance for which options are being processed

optionSets - comma separate list of option set names

Returns:

combined set from applying these options together

ast

public String ast(com.vladsch.flexmark.util.ast.Node node)

actualSource

public String actualSource(String source,
                           String optionSet)

Specified by:

actualSource in interface ActualExampleModifier

testCase

protected void testCase(com.vladsch.flexmark.util.ast.Node node,
                        com.vladsch.flexmark.util.data.DataHolder options)

actualHtml

public String actualHtml(String html,
                         String optionSet)

Specified by:

actualHtml in interface ActualExampleModifier

actualAst

public String actualAst(String ast,
                        String optionSet)

Specified by:

actualAst in interface ActualExampleModifier

specExample

protected void specExample(String expected,
                           String actual,
                           String optionSet)

adjustParserForInclusion

protected com.vladsch.flexmark.util.ast.IParse adjustParserForInclusion(com.vladsch.flexmark.util.ast.IParse parserWithOptions,
                                                                        com.vladsch.flexmark.util.ast.Document includedDocument)

assertRendering

protected void assertRendering(UrlString fileUrl,
                               String source,
                               String expectedHtml)

assertRendering

protected void assertRendering(String source,
                               String expectedHtml)

useActualHtml

public boolean useActualHtml()

Returns:

return true if actual html should be used in comparison, else only actual AST will be used in compared

stripIndent

public static com.vladsch.flexmark.util.sequence.BasedSequence stripIndent(com.vladsch.flexmark.util.sequence.BasedSequence input,
                                                                           CharSequence sourceIndent)

assertRendering

protected void assertRendering(UrlString fileUrl,
                               String source,
                               String expectedHtml,
                               String optionsSet)

assertRenderingAst

protected void assertRenderingAst(UrlString fileUrl,
                                  String source,
                                  String expectedHtml,
                                  String expectedAst,
                                  String optionsSet)

assertAst

protected void assertAst(UrlString fileUrl,
                         String source,
                         String expectedAst,
                         String optionsSet)