org.apache.maven.plugins.checkstyle

Class AbstractCheckstyleTestCase

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

org.codehaus.plexus.PlexusTestCase

org.apache.maven.plugin.testing.AbstractMojoTestCase

org.apache.maven.plugins.checkstyle.AbstractCheckstyleTestCase

All Implemented Interfaces:

junit.framework.Test

Direct Known Subclasses:

CheckstyleReportTest

public abstract class AbstractCheckstyleTestCase
extends org.apache.maven.plugin.testing.AbstractMojoTestCase

Abstract class to test reports generation.

Constructor Summary

Constructors

Constructor and Description
AbstractCheckstyleTestCase()

Method Summary

Modifier and Type	Method and Description
protected CheckstyleReport	createReportMojo(String goal, File pluginXmlFile)
protected File	generateReport(CheckstyleReport mojo, File pluginXmlFile)
protected File	generateReport(String goal, String pluginXml) Generate the report and return the generated file
protected File	getGeneratedReport(String name) Get the generated report as file in the test maven project.
protected org.apache.maven.project.MavenProject	getTestMavenProject() Get the current Maven project
protected String	readFile(File checkstyleTestDir, String fileName) Read the contents of the specified file object into a string
protected void	setUp()
protected void	tearDown()

Methods inherited from class org.apache.maven.plugin.testing.AbstractMojoTestCase

addGuiceModules, configureMojo, configureMojo, extractPluginConfiguration, extractPluginConfiguration, getContainer, getPluginDescriptorLocation, getPluginDescriptorPath, getPublicDescriptorStream, getVariablesAndValuesFromObject, getVariablesAndValuesFromObject, getVariableValueFromObject, lookupConfiguredMojo, lookupConfiguredMojo, lookupEmptyMojo, lookupEmptyMojo, lookupMojo, lookupMojo, lookupMojo, newMavenSession, newMojoExecution, setupContainer, setupContainerConfiguration, setVariableValueToObject

Methods inherited from class org.codehaus.plexus.PlexusTestCase

customizeContainerConfiguration, customizeContext, getBasedir, getClassLoader, getConfigurationName, getCustomConfigurationName, getResourceAsStream, getTestConfiguration, getTestConfiguration, getTestFile, getTestFile, getTestPath, getTestPath, lookup, lookup, lookup, lookup, release, teardownContainer

Methods inherited from class junit.framework.TestCase

assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, countTestCases, createResult, fail, fail, failNotEquals, failNotSame, failSame, format, getName, run, run, runBare, runTest, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCheckstyleTestCase

public AbstractCheckstyleTestCase()

Method Detail

setUp

protected void setUp()
              throws Exception

Overrides:

setUp in class org.apache.maven.plugin.testing.AbstractMojoTestCase

Throws:

Exception

tearDown

protected void tearDown()
                 throws Exception

Overrides:

tearDown in class org.codehaus.plexus.PlexusTestCase

Throws:

Exception

getTestMavenProject

protected org.apache.maven.project.MavenProject getTestMavenProject()

Get the current Maven project

Returns:

the maven project

getGeneratedReport

protected File getGeneratedReport(String name)
                           throws IOException

Get the generated report as file in the test maven project.

Parameters:

name - the name of the report.

Returns:

the generated report as file

Throws:

IOException - if the return file doesnt exist

generateReport

protected File generateReport(String goal,
                              String pluginXml)
                       throws Exception

Generate the report and return the generated file

Parameters:

goal - the mojo goal.

pluginXml - the name of the xml file in "src/test/resources/plugin-configs/".

Returns:

the generated HTML file

Throws:

Exception - if any

createReportMojo

protected CheckstyleReport createReportMojo(String goal,
                                            File pluginXmlFile)
                                     throws Exception

Throws:

Exception

generateReport

protected File generateReport(CheckstyleReport mojo,
                              File pluginXmlFile)
                       throws Exception

Throws:

Exception

readFile

protected String readFile(File checkstyleTestDir,
                          String fileName)
                   throws IOException

Read the contents of the specified file object into a string

Throws:

IOException