Package net.sourceforge.pmd

Class AbstractRuleSetFactoryTest

java.lang.Object

net.sourceforge.pmd.AbstractRuleSetFactoryTest

public abstract class AbstractRuleSetFactoryTest
extends Object

Base test class to verify the language's rulesets. This class should be subclassed for each language.

Field Summary

Fields

Modifier and Type	Field	Description
org.junit.contrib.java.lang.system.SystemErrRule	systemErrRule
protected Set<String>	validXPathClassNames

Constructor Summary

Constructors

Constructor	Description
AbstractRuleSetFactoryTest()
AbstractRuleSetFactoryTest(String... languagesToSkip)	Constructor used when a module that depends on another module wants to filter out the dependee's rulesets.

Method Summary

Modifier and Type	Method	Description
protected static RuleSetReferenceId	createRuleSetReferenceId(String ruleSetXml)	Create a RuleSetReferenceId by the given XML string.
static void	init()	Setups the XML parser with validation.
void	testAllPMDBuiltInRulesMeetConventions()	Checks all rulesets of all languages on the classpath and verifies that all required attributes for all rules are specified.
void	testDtd()	Verifies that all rulesets are valid XML according to the DTD.
void	testReadWriteRoundTrip()	Reads and writes the rulesets to make sure, that no data is lost if the rulests are processed.
void	testXmlSchema()	Verifies that all rulesets are valid XML according to the xsd schema.

Methods inherited from class java.lang.Object

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

Field Detail

systemErrRule

public final org.junit.contrib.java.lang.system.SystemErrRule systemErrRule

validXPathClassNames

protected Set<String> validXPathClassNames

Constructor Detail

AbstractRuleSetFactoryTest

public AbstractRuleSetFactoryTest()

AbstractRuleSetFactoryTest

public AbstractRuleSetFactoryTest(String... languagesToSkip)

Constructor used when a module that depends on another module wants to filter out the dependee's rulesets.

Parameters:

languagesToSkip - Languages terse names that appear in the classpath via a dependency, but should be skipped because they aren't the primary language which the concrete instance of this class is testing.

Method Detail

init

public static void init()
                 throws Exception

Setups the XML parser with validation.

Throws:

Exception - any error

testAllPMDBuiltInRulesMeetConventions

public void testAllPMDBuiltInRulesMeetConventions()
                                           throws Exception

Checks all rulesets of all languages on the classpath and verifies that all required attributes for all rules are specified.

Throws:

Exception - any error

testXmlSchema

public void testXmlSchema()
                   throws Exception

Verifies that all rulesets are valid XML according to the xsd schema.

Throws:

Exception - any error

testDtd

public void testDtd()
             throws Exception

Verifies that all rulesets are valid XML according to the DTD.

Throws:

Exception - any error

testReadWriteRoundTrip

public void testReadWriteRoundTrip()
                            throws Exception

Reads and writes the rulesets to make sure, that no data is lost if the rulests are processed.

Throws:

Exception - any error

createRuleSetReferenceId

protected static RuleSetReferenceId createRuleSetReferenceId(String ruleSetXml)

Create a RuleSetReferenceId by the given XML string.

Parameters:

ruleSetXml - the ruleset file content as string

Returns:

the RuleSetReferenceId