Package net.sourceforge.pmd.testframework

Class RuleTst

java.lang.Object

net.sourceforge.pmd.testframework.RuleTst

Direct Known Subclasses:

PmdRuleTst, SimpleAggregatorTst

public abstract class RuleTst
extends Object

Advanced methods for test cases

Constructor Summary

Constructors

Constructor	Description
RuleTst()

Method Summary

Modifier and Type	Method	Description
TestDescriptor[]	extractTestsFromXml(net.sourceforge.pmd.Rule rule)	Extract a set of tests from an XML file.
TestDescriptor[]	extractTestsFromXml(net.sourceforge.pmd.Rule rule, String testsFileName)
TestDescriptor[]	extractTestsFromXml(net.sourceforge.pmd.Rule rule, String testsFileName, String baseDirectory)	Extract a set of tests from an XML file with the given name.
net.sourceforge.pmd.Rule	findRule(String ruleSet, String ruleName)	Find a rule in a certain ruleset by name
protected String	getCleanRuleName(net.sourceforge.pmd.Rule rule)	getResourceAsStream tries to find the XML file in weird locations if the ruleName includes the package, so we strip it here.
protected List<net.sourceforge.pmd.Rule>	getRules()
protected net.sourceforge.pmd.Rule	reinitializeRule(net.sourceforge.pmd.Rule rule)	Code to be executed if the rule is reinitialised.
void	runTest(TestDescriptor test)	Run the rule on the given code, and check the expected number of violations.
void	runTestFromString(String code, net.sourceforge.pmd.Rule rule, net.sourceforge.pmd.Report report, net.sourceforge.pmd.lang.LanguageVersion languageVersion)	Run the rule on the given code and put the violations in the report.
void	runTestFromString(String code, net.sourceforge.pmd.Rule rule, net.sourceforge.pmd.Report report, net.sourceforge.pmd.lang.LanguageVersion languageVersion, boolean isUseAuxClasspath)
void	runTestFromString(TestDescriptor test, net.sourceforge.pmd.Rule rule, net.sourceforge.pmd.Report report)
void	runTests(net.sourceforge.pmd.Rule rule)	Run a set of tests defined in an XML test-data file for a rule.
void	runTests(net.sourceforge.pmd.Rule rule, String testsFileName)	Run a set of tests defined in a XML test-data file.
void	runTests(TestDescriptor[] tests)	Run a set of tests of a certain sourceType.
protected void	setUp()

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleTst

public RuleTst()

Method Detail

setUp

protected void setUp()

getRules

protected List<net.sourceforge.pmd.Rule> getRules()

findRule

public net.sourceforge.pmd.Rule findRule(String ruleSet,
                                         String ruleName)

Find a rule in a certain ruleset by name

runTest

public void runTest(TestDescriptor test)

Run the rule on the given code, and check the expected number of violations.

reinitializeRule

protected net.sourceforge.pmd.Rule reinitializeRule(net.sourceforge.pmd.Rule rule)

Code to be executed if the rule is reinitialised.

Parameters:

rule - The rule to reinitialise

Returns:

The rule once it has been reinitialised

runTestFromString

public void runTestFromString(String code,
                              net.sourceforge.pmd.Rule rule,
                              net.sourceforge.pmd.Report report,
                              net.sourceforge.pmd.lang.LanguageVersion languageVersion)

Run the rule on the given code and put the violations in the report.

runTestFromString

public void runTestFromString(String code,
                              net.sourceforge.pmd.Rule rule,
                              net.sourceforge.pmd.Report report,
                              net.sourceforge.pmd.lang.LanguageVersion languageVersion,
                              boolean isUseAuxClasspath)

runTestFromString

public void runTestFromString(TestDescriptor test,
                              net.sourceforge.pmd.Rule rule,
                              net.sourceforge.pmd.Report report)

getCleanRuleName

protected String getCleanRuleName(net.sourceforge.pmd.Rule rule)

getResourceAsStream tries to find the XML file in weird locations if the ruleName includes the package, so we strip it here.

extractTestsFromXml

public TestDescriptor[] extractTestsFromXml(net.sourceforge.pmd.Rule rule)

Extract a set of tests from an XML file. The file should be ./xml/RuleName.xml relative to the test class. The format is defined in test-data.xsd.

extractTestsFromXml

public TestDescriptor[] extractTestsFromXml(net.sourceforge.pmd.Rule rule,
                                            String testsFileName)

extractTestsFromXml

public TestDescriptor[] extractTestsFromXml(net.sourceforge.pmd.Rule rule,
                                            String testsFileName,
                                            String baseDirectory)

Extract a set of tests from an XML file with the given name. The file should be ./xml/[testsFileName].xml relative to the test class. The format is defined in test-data.xsd.

runTests

public void runTests(net.sourceforge.pmd.Rule rule)

Run a set of tests defined in an XML test-data file for a rule. The file should be ./xml/RuleName.xml relative to the test-class. The format is defined in test-data.xsd.

runTests

public void runTests(net.sourceforge.pmd.Rule rule,
                     String testsFileName)

Run a set of tests defined in a XML test-data file. The file should be ./xml/[testsFileName].xml relative to the test-class. The format is defined in test-data.xsd.

runTests

public void runTests(TestDescriptor[] tests)

Run a set of tests of a certain sourceType.