com.vladsch.flexmark.test

Class RenderingTestCase

java.lang.Object

com.vladsch.flexmark.test.RenderingTestCase

Direct Known Subclasses:

FileSpecTestCase, FullSpecTestCase, SpecTestCase

public abstract class RenderingTestCase
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static com.vladsch.flexmark.util.options.DataKey<Boolean>	FAIL
static String	FAIL_OPTION_NAME
static String	FILE_EOL_OPTION_NAME
static com.vladsch.flexmark.util.options.DataKey<Boolean>	IGNORE
static String	IGNORE_OPTION_NAME
static com.vladsch.flexmark.util.options.DataKey<Boolean>	NO_FILE_EOL
static String	NO_FILE_EOL_OPTION_NAME
org.junit.rules.ExpectedException	thrown

Constructor Summary

Constructors

Constructor and Description
RenderingTestCase()

Method Summary

Modifier and Type	Method and Description
protected void	actualAst(String ast, String optionSet)
protected void	actualHtml(String html, String optionSet)
protected void	actualSource(String html, String optionSet)
protected void	assertAst(String source, String expectedAst, String optionsSet)
protected void	assertRendering(String source, String expectedHtml)
protected void	assertRendering(String source, String expectedHtml, String optionsSet)
protected void	assertRenderingAst(String source, String expectedHtml, String expectedAst, String optionsSet)
String	ast(com.vladsch.flexmark.ast.Node node)
abstract SpecExample	example()
com.vladsch.flexmark.util.options.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.options.DataHolder	options(String optionSet) Customize options for an example
abstract com.vladsch.flexmark.IParse	parser()
abstract com.vladsch.flexmark.IRender	renderer()
protected void	specExample(String expected, String actual, String optionSet)
protected void	testCase(com.vladsch.flexmark.ast.Node node, com.vladsch.flexmark.util.options.DataHolder options)
protected 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

FAIL

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

IGNORE

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

NO_FILE_EOL

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

thrown

public org.junit.rules.ExpectedException thrown

Constructor Detail

RenderingTestCase

public RenderingTestCase()

Method Detail

parser

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

renderer

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

example

public abstract SpecExample example()

options

public com.vladsch.flexmark.util.options.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.options.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.ast.Node node)

actualSource

protected void actualSource(String html,
                            String optionSet)

testCase

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

actualHtml

protected void actualHtml(String html,
                          String optionSet)

actualAst

protected void actualAst(String ast,
                         String optionSet)

specExample

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

assertRendering

protected void assertRendering(String source,
                               String expectedHtml)

useActualHtml

protected boolean useActualHtml()

Returns:

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

assertRendering

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

assertRenderingAst

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

assertAst

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