AbstractProjectInfoTestCase (Apache Maven Project Info Reports Plugin 2.8.1 Test API)

java.lang.Object
- junit.framework.Assert
- - junit.framework.TestCase
  - - org.codehaus.plexus.PlexusTestCase
    - - org.apache.maven.plugin.testing.AbstractMojoTestCase
      - org.apache.maven.report.projectinfo.AbstractProjectInfoTestCase

All Implemented Interfaces:

junit.framework.Test

Direct Known Subclasses:

CimReportTest, DependenciesReportTest, DependencyConvergenceReportTest, DependencyManagementReportTest, IssueTrackingReportTest, LicenseReportTest, MailingListsReportTest, ModulesReportTest, PluginManagementReportTest, ProjectIndexPageReportTest, ProjectSummaryReportTest, ScmReportTest, TeamListReportTest
```
public abstract class AbstractProjectInfoTestCase
extends AbstractMojoTestCase
```
Abstract class to test reports generation with HTTPUnit framework.

Version:

$Id: AbstractProjectInfoTestCase.html 964673 2015-09-07 20:28:21Z hboutemy $

Author:

Edwin Punzalan, Vincent Siveton

Field Summary

Fields
Modifier and Type Field and Description

protected static Locale DEFAULT_LOCALE
The default locale is English.
- Fields inherited from class org.codehaus.plexus.PlexusTestCase
  basedir, container

Fields
Modifier and Type	Field and Description
`protected static Locale`	`DEFAULT_LOCALE` The default locale is English.

Constructor Summary

Constructors
Constructor and Description

AbstractProjectInfoTestCase()

Constructors
Constructor and Description
`AbstractProjectInfoTestCase()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected AbstractProjectInfoReport`	`createReportMojo(String goal, File pluginXmlFile)`
`protected File`	`generateReport(AbstractProjectInfoReport mojo, File pluginXmlFile)`
`protected File`	`generateReport(String goal, String pluginXml)` Generate the report and return the generated file
`protected InputStream`	`getCustomConfiguration()`
`protected File`	`getGeneratedReport(String name)` Get the generated report as file in the test maven project.
`protected String`	`getString(String key)` Gets a trimmed String for the given key from the resource bundle defined by Plexus.
`protected org.apache.maven.project.MavenProject`	`getTestMavenProject()` Get the current Maven project
`protected String`	`prepareTitle(String name, String title)` Gets a fully qualified title as generated by Doxia 1.6
`protected void`	`setUp()`
`protected void`	`tearDown()`

Methods inherited from class org.apache.maven.plugin.testing.AbstractMojoTestCase
configureMojo, configureMojo, extractPluginConfiguration, extractPluginConfiguration, getVariablesAndValuesFromObject, getVariablesAndValuesFromObject, getVariableValueFromObject, lookupEmptyMojo, lookupEmptyMojo, lookupMojo, lookupMojo, lookupMojo, setVariableValueToObject

Methods inherited from class org.codehaus.plexus.PlexusTestCase
createContainerInstance, customizeContext, customizeContext, getBasedir, getClassLoader, getConfiguration, getConfiguration, getContainer, getResourceAsStream, getTestFile, getTestFile, getTestPath, getTestPath, lookup, lookup, release

Methods inherited from class junit.framework.TestCase
countTestCases, createResult, getName, run, run, runBare, runTest, setName, toString

Methods inherited from class junit.framework.Assert
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, fail, fail, failNotEquals, failNotSame, failSame

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_LOCALE
```
protected static final Locale DEFAULT_LOCALE
```
    The default locale is English.
- Constructor Detail
  - AbstractProjectInfoTestCase
```
public AbstractProjectInfoTestCase()
```
- Method Detail
  - setUp
```
protected void setUp()
              throws Exception
```
    Overrides:
    
    setUp in class AbstractMojoTestCase
    
    Throws:
    
    Exception
  - getCustomConfiguration
```
protected InputStream getCustomConfiguration()
                                      throws Exception
```
    Overrides:
    
    getCustomConfiguration in class org.codehaus.plexus.PlexusTestCase
    
    Throws:
    
    Exception
  - tearDown
```
protected void tearDown()
                 throws Exception
```
    Overrides:
    
    tearDown in class org.codehaus.plexus.PlexusTestCase
    
    Throws:
    
    Exception
  - getString
```
protected String getString(String key)
```
    Gets a trimmed String for the given key from the resource bundle defined by Plexus.
    
    Parameters:
    key - the key for the desired string
    
    Returns:
    the string for the given key
  - prepareTitle
```
protected String prepareTitle(String name,
                  String title)
```
    Gets a fully qualified title as generated by Doxia 1.6
    
    Parameters:
    name - the name to prepare
    title - the title to prepare
    
    Returns:
    the prepared title as per Doxia 1.6
    Since:
    
    2.8
  - 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 AbstractProjectInfoReport createReportMojo(String goal,
                                         File pluginXmlFile)
                                              throws Exception
```
    Throws:
    
    Exception
  - generateReport
```
protected File generateReport(AbstractProjectInfoReport mojo,
                  File pluginXmlFile)
                       throws Exception
```
    Throws:
    
    Exception

Class AbstractProjectInfoTestCase

Field Summary

Fields inherited from class org.codehaus.plexus.PlexusTestCase

Constructor Summary

Method Summary

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

Methods inherited from class org.codehaus.plexus.PlexusTestCase

Methods inherited from class junit.framework.TestCase

Methods inherited from class junit.framework.Assert

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LOCALE

Constructor Detail

AbstractProjectInfoTestCase

Method Detail

setUp

getCustomConfiguration

tearDown

getString

prepareTitle

getTestMavenProject

getGeneratedReport

generateReport

createReportMojo

generateReport