org.apache.maven.plugins.javadoc

Class JavadocReportTest

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

org.codehaus.plexus.PlexusTestCase

org.apache.maven.plugin.testing.AbstractMojoTestCase

org.apache.maven.plugins.javadoc.JavadocReportTest

All Implemented Interfaces:

junit.framework.Test

public class JavadocReportTest
extends AbstractMojoTestCase

Test JavadocReport class.

Author:

Maria Odea Ching, Vincent Siveton

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPTIONS_UMLAUT_ENCODING

Constructor Summary

Constructors

Constructor and Description
JavadocReportTest()

Method Summary

Modifier and Type	Method and Description
protected void	setUp()
void	testCustomConfiguration() Test javadoc plugin using custom configuration.
void	testDefaultConfiguration() Test when default configuration is provided for the plugin
void	testDocfiles() Test the recursion and exclusion of the doc-files subdirectories.
void	testDoclets() Method to test the doclet artifact configuration
void	testExceptions()
void	testHeaderFooter() Test newline in the header/footer parameter
void	testHelpfile() Method to test the <helpfile/> parameter.
void	testIncludesExcludes()
void	testJavadocResources() Test the javadoc resources.
void	testJdk5() Method to test the jdk5 javadoc
void	testJdk6() Method to test the jdk6 javadoc
void	testNewline() Test newline in various string parameters
void	testOptionsUmlautEncoding() Method to test when the options file has umlauts.
void	testPom() Test the javadoc for a POM project.
void	testProxy() Method to test proxy support in the javadoc
void	testQuotedPath() Method to test when the path to the project sources has an apostrophe (')
void	testStylesheetfile() Method to test the <stylesheetfile/> parameter.
void	testSubpackages() Method for testing the subpackages and excludePackageNames parameter
void	testTag() Test the javadoc with tag.
void	testTagletArtifacts() Method to test the <tagletArtifacts/> parameter.
void	testTaglets() Method to test the taglet artifact configuration
void	testToFindJavadoc() Test to find the javadoc executable when java.home is not in the JDK_HOME.
void	testValidateOptions() Method to test error or conflict in Javadoc options and in standard doclet options.

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, tearDown, 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

Field Detail

OPTIONS_UMLAUT_ENCODING

public static final String OPTIONS_UMLAUT_ENCODING

See Also:

Constant Field Values

Constructor Detail

JavadocReportTest

public JavadocReportTest()

Method Detail

setUp

protected void setUp()
              throws Exception

Overrides:

setUp in class AbstractMojoTestCase

Throws:

Exception

testDefaultConfiguration

public void testDefaultConfiguration()
                              throws Exception

Test when default configuration is provided for the plugin

Throws:

Exception - if any

testSubpackages

public void testSubpackages()
                     throws Exception

Method for testing the subpackages and excludePackageNames parameter

Throws:

Exception - if any

testIncludesExcludes

public void testIncludesExcludes()
                          throws Exception

Throws:

Exception

testDocfiles

public void testDocfiles()
                  throws Exception

Test the recursion and exclusion of the doc-files subdirectories.

Throws:

Exception - if any

testCustomConfiguration

public void testCustomConfiguration()
                             throws Exception

Test javadoc plugin using custom configuration. noindex, notree and nodeprecated parameters were set to true.

Throws:

Exception - if any

testDoclets

public void testDoclets()
                 throws Exception

Method to test the doclet artifact configuration

Throws:

Exception - if any

testQuotedPath

public void testQuotedPath()
                    throws Exception

Method to test when the path to the project sources has an apostrophe (')

Throws:

Exception - if any

testOptionsUmlautEncoding

public void testOptionsUmlautEncoding()
                               throws Exception

Method to test when the options file has umlauts.

Throws:

Exception - if any

testExceptions

public void testExceptions()
                    throws Exception

Throws:

Exception - if any

testTaglets

public void testTaglets()
                 throws Exception

Method to test the taglet artifact configuration

Throws:

Exception - if any

testJdk5

public void testJdk5()
              throws Exception

Method to test the jdk5 javadoc

Throws:

Exception - if any

testToFindJavadoc

public void testToFindJavadoc()
                       throws Exception

Test to find the javadoc executable when java.home is not in the JDK_HOME. In this case, try to use the JAVA_HOME environment variable.

Throws:

Exception - if any

testJavadocResources

public void testJavadocResources()
                          throws Exception

Test the javadoc resources.

Throws:

Exception - if any

testPom

public void testPom()
             throws Exception

Test the javadoc for a POM project.

Throws:

Exception - if any

testTag

public void testTag()
             throws Exception

Test the javadoc with tag.

Throws:

Exception - if any

testHeaderFooter

public void testHeaderFooter()
                      throws Exception

Test newline in the header/footer parameter

Throws:

Exception - if any

testNewline

public void testNewline()
                 throws Exception

Test newline in various string parameters

Throws:

Exception - if any

testJdk6

public void testJdk6()
              throws Exception

Method to test the jdk6 javadoc

Throws:

Exception - if any

testProxy

public void testProxy()
               throws Exception

Method to test proxy support in the javadoc

Throws:

Exception - if any

testValidateOptions

public void testValidateOptions()
                         throws Exception

Method to test error or conflict in Javadoc options and in standard doclet options.

Throws:

Exception - if any

testTagletArtifacts

public void testTagletArtifacts()
                         throws Exception

Method to test the <tagletArtifacts/> parameter.

Throws:

Exception - if any

testStylesheetfile

public void testStylesheetfile()
                        throws Exception

Method to test the <stylesheetfile/> parameter.

Throws:

Exception - if any

testHelpfile

public void testHelpfile()
                  throws Exception

Method to test the <helpfile/> parameter.

Throws:

Exception - if any