MojoRule (Maven Plugin Testing Mechanism 3.3.0 API)

java.lang.Object
- org.apache.maven.plugin.testing.MojoRule

All Implemented Interfaces:

TestRule
```
public class MojoRule
extends Object
implements TestRule
```
TestRule for usage with Junit-4.10ff. This is just a wrapper for an embedded AbstractMojoTestCase, so all protected methods of the TestCase are exhibited as public in the rule. You may annotate single tests methods with WithoutMojo to prevent the rule from firing.

Since:

2.2

Version:

$Id$

Author:

Mirko Friedenhagen

Constructor Summary

Constructors
Constructor and Description

MojoRule()

MojoRule(AbstractMojoTestCase testCase)

Constructors
Constructor and Description
`MojoRule()`
`MojoRule(AbstractMojoTestCase testCase)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`after()` May be overridden in the implementation to do stuff after the current test was run.
`Statement`	`apply(Statement base, Description description)`
`protected void`	`before()` May be overridden in the implementation to do stuff after the embedded test case is set up but before the current test is actually run.
`Mojo`	`configureMojo(Mojo mojo, org.codehaus.plexus.configuration.PlexusConfiguration pluginConfiguration)`
`Mojo`	`configureMojo(Mojo mojo, String artifactId, File pom)`
`void`	`executeMojo(File basedir, String goal)`
`void`	`executeMojo(MavenProject project, String goal, Xpp3Dom... parameters)`
`void`	`executeMojo(MavenSession session, MavenProject project, MojoExecution execution)`
`void`	`executeMojo(MavenSession session, MavenProject project, String goal, Xpp3Dom... parameters)`
`org.codehaus.plexus.configuration.PlexusConfiguration`	`extractPluginConfiguration(String artifactId, File pom)`
`org.codehaus.plexus.configuration.PlexusConfiguration`	`extractPluginConfiguration(String artifactId, Xpp3Dom pomDom)`
`org.codehaus.plexus.PlexusContainer`	`getContainer()`
`String`	`getPluginDescriptorLocation()`
`String`	`getPluginDescriptorPath()`
`InputStream`	`getPublicDescriptorStream()`
`Map<String,Object>`	`getVariablesAndValuesFromObject(Class<?> clazz, Object object)` Convenience method to obtain all variables and values from the mojo (including its superclasses) Note: the values in the map are of type Object so the caller is responsible for casting to desired types.
`Map<String,Object>`	`getVariablesAndValuesFromObject(Object object)` Convenience method to obtain all variables and values from the mojo (including its superclasses) Note: the values in the map are of type Object so the caller is responsible for casting to desired types.
`Object`	`getVariableValueFromObject(Object object, String variable)` Convenience method to obtain the value of a variable on a mojo that might not have a getter.
`<T> T`	`lookup(Class<T> role)`
`Mojo`	`lookupConfiguredMojo(File basedir, String goal)`
`Mojo`	`lookupConfiguredMojo(MavenProject project, String goal)`
`Mojo`	`lookupConfiguredMojo(MavenSession session, MojoExecution execution)`
`Mojo`	`lookupEmptyMojo(String goal, File pom)` Lookup the mojo leveraging the actual subprojects pom
`Mojo`	`lookupEmptyMojo(String goal, String pluginPom)` Lookup an empty mojo
`Mojo`	`lookupMojo(String goal, File pom)` Lookup the mojo leveraging the actual subprojects pom
`Mojo`	`lookupMojo(String goal, String pluginPom)` Lookup the mojo leveraging the subproject pom
`Mojo`	`lookupMojo(String groupId, String artifactId, String version, String goal, org.codehaus.plexus.configuration.PlexusConfiguration pluginConfiguration)`
`MavenSession`	`newMavenSession(MavenProject project)`
`MojoExecution`	`newMojoExecution(String goal)`
`MavenProject`	`readMavenProject(File basedir)`
`void`	`setupContainer()`
`org.codehaus.plexus.ContainerConfiguration`	`setupContainerConfiguration()`
`void`	`setVariableValueToObject(Object object, String variable, Object value)` Convenience method to set values to variables in objects that don't have setters

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

Constructor Detail

MojoRule
```
public MojoRule()
```

MojoRule

public MojoRule(AbstractMojoTestCase testCase)

Method Detail

before
```
protected void before()
               throws Throwable
```
May be overridden in the implementation to do stuff after the embedded test case is set up but before the current test is actually run.

Throws:

Throwable

after
```
protected void after()
```
May be overridden in the implementation to do stuff after the current test was run.

getPublicDescriptorStream

public InputStream getPublicDescriptorStream()
                                      throws Exception

Throws:: Exception

getPluginDescriptorPath

public String getPluginDescriptorPath()

getPluginDescriptorLocation

public String getPluginDescriptorLocation()

setupContainer
```
public void setupContainer()
```

setupContainerConfiguration

public org.codehaus.plexus.ContainerConfiguration setupContainerConfiguration()

getContainer

public org.codehaus.plexus.PlexusContainer getContainer()

lookupMojo

public Mojo lookupMojo(String goal,
              String pluginPom)
                throws Exception

Lookup the mojo leveraging the subproject pom

Parameters:: goal -; pluginPom -
Returns:: a Mojo instance
Throws:: Exception

lookupEmptyMojo

public Mojo lookupEmptyMojo(String goal,
                   String pluginPom)
                     throws Exception

Lookup an empty mojo

Parameters:: goal -; pluginPom -
Returns:: a Mojo instance
Throws:: Exception

lookupMojo
```
public Mojo lookupMojo(String goal,
              File pom)
                throws Exception
```
Lookup the mojo leveraging the actual subprojects pom

Parameters:
goal -
pom -

Returns:
a Mojo instance

Throws:

Exception

lookupEmptyMojo

public Mojo lookupEmptyMojo(String goal,
                   File pom)
                     throws Exception

Lookup the mojo leveraging the actual subprojects pom

Parameters:: goal -; pom -
Returns:: a Mojo instance
Throws:: Exception

lookupMojo

public Mojo lookupMojo(String groupId,
              String artifactId,
              String version,
              String goal,
              org.codehaus.plexus.configuration.PlexusConfiguration pluginConfiguration)
                throws Exception

Throws:: Exception

lookupConfiguredMojo

public Mojo lookupConfiguredMojo(MavenProject project,
                        String goal)
                          throws Exception

Throws:: Exception

lookupConfiguredMojo

public Mojo lookupConfiguredMojo(MavenSession session,
                        MojoExecution execution)
                          throws Exception,
                                 org.codehaus.plexus.component.configurator.ComponentConfigurationException

Throws:: Exception; org.codehaus.plexus.component.configurator.ComponentConfigurationException

newMavenSession

public MavenSession newMavenSession(MavenProject project)

newMojoExecution

public MojoExecution newMojoExecution(String goal)

extractPluginConfiguration

public org.codehaus.plexus.configuration.PlexusConfiguration extractPluginConfiguration(String artifactId,
                                                                               File pom)
                                                                                 throws Exception

Throws:: Exception

extractPluginConfiguration

public org.codehaus.plexus.configuration.PlexusConfiguration extractPluginConfiguration(String artifactId,
                                                                               Xpp3Dom pomDom)
                                                                                 throws Exception

Throws:: Exception

configureMojo

public Mojo configureMojo(Mojo mojo,
                 String artifactId,
                 File pom)
                   throws Exception

Throws:: Exception

configureMojo

public Mojo configureMojo(Mojo mojo,
                 org.codehaus.plexus.configuration.PlexusConfiguration pluginConfiguration)
                   throws Exception

Throws:: Exception

getVariableValueFromObject
```
public Object getVariableValueFromObject(Object object,
                                String variable)
                                  throws IllegalAccessException
```
Convenience method to obtain the value of a variable on a mojo that might not have a getter. NOTE: the caller is responsible for casting to to what the desired type is.

Parameters:
object -
variable -

Returns:
object value of variable

Throws:

IllegalArgumentException

IllegalAccessException

getVariablesAndValuesFromObject
```
public Map<String,Object> getVariablesAndValuesFromObject(Object object)
                                                   throws IllegalAccessException
```
Convenience method to obtain all variables and values from the mojo (including its superclasses) Note: the values in the map are of type Object so the caller is responsible for casting to desired types.

Parameters:
object -

Returns:
map of variable names and values

Throws:

IllegalAccessException

getVariablesAndValuesFromObject
```
public Map<String,Object> getVariablesAndValuesFromObject(Class<?> clazz,
                                                 Object object)
                                                   throws IllegalAccessException
```
Convenience method to obtain all variables and values from the mojo (including its superclasses) Note: the values in the map are of type Object so the caller is responsible for casting to desired types.

Parameters:
clazz -
object -

Returns:
map of variable names and values

Throws:

IllegalAccessException

setVariableValueToObject

public void setVariableValueToObject(Object object,
                            String variable,
                            Object value)
                              throws IllegalAccessException

Convenience method to set values to variables in objects that don't have setters

Parameters:: object -; variable -; value -
Throws:: IllegalAccessException

apply

public Statement apply(Statement base,
              Description description)

Specified by:: apply in interface TestRule

readMavenProject

public MavenProject readMavenProject(File basedir)
                              throws Exception

Throws:: Exception
Since:: 3.1.0

executeMojo

public void executeMojo(File basedir,
               String goal)
                 throws Exception

Throws:: Exception
Since:: 3.1.0

lookupConfiguredMojo

public Mojo lookupConfiguredMojo(File basedir,
                        String goal)
                          throws Exception,
                                 org.codehaus.plexus.component.configurator.ComponentConfigurationException

Throws:: Exception; org.codehaus.plexus.component.configurator.ComponentConfigurationException
Since:: 3.1.0

lookup

public final <T> T lookup(Class<T> role)
               throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Throws:: org.codehaus.plexus.component.repository.exception.ComponentLookupException
Since:: 3.1.0

executeMojo

public void executeMojo(MavenProject project,
               String goal,
               Xpp3Dom... parameters)
                 throws Exception

Throws:: Exception
Since:: 3.2.0

executeMojo

public void executeMojo(MavenSession session,
               MavenProject project,
               String goal,
               Xpp3Dom... parameters)
                 throws Exception

Throws:: Exception
Since:: 3.2.0

executeMojo

public void executeMojo(MavenSession session,
               MavenProject project,
               MojoExecution execution)
                 throws Exception

Throws:: Exception
Since:: 3.2.0

Class MojoRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MojoRule

MojoRule

Method Detail

before

after

getPublicDescriptorStream

getPluginDescriptorPath

getPluginDescriptorLocation

setupContainer

setupContainerConfiguration

getContainer

lookupMojo

lookupEmptyMojo

lookupMojo

lookupEmptyMojo

lookupMojo

lookupConfiguredMojo

lookupConfiguredMojo

newMavenSession

newMojoExecution

extractPluginConfiguration

extractPluginConfiguration

configureMojo

configureMojo

getVariableValueFromObject

getVariablesAndValuesFromObject

getVariablesAndValuesFromObject

setVariableValueToObject

apply

readMavenProject

executeMojo

lookupConfiguredMojo

lookup

executeMojo

executeMojo

executeMojo