org.mule.munit.plugin.maven

Class AbstractMunitMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.mule.munit.plugin.maven.AbstractMunitMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public abstract class AbstractMunitMojo
extends org.apache.maven.plugin.AbstractMojo

Base Mojo to run MUnit tests

Since:

1.0.0

Author:

Mulesoft Inc.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ARG_TOKEN
List<String>	argLines
ClasspathManager	classpathManager
org.mule.tools.model.anypoint.CloudHubDeployment	cloudHubDeployment
List<String>	dynamicPorts
Map<String,String>	effectiveSystemProperties
boolean	enableSonarReports
boolean	enableSurefireReports
Map<String,String>	environmentVariables
protected com.google.gson.Gson	gson
JarFileFactory	jarFileFactory
String	jvm
JVMLocator	jvmLocator
org.apache.maven.artifact.repository.ArtifactRepository	localRepository
protected org.apache.maven.repository.RepositorySystem	mavenRepositorySystem
MessageHandlerFactory	messageHandlerFactory
static String	MULE_ARTIFACT_JSON_FILE_NAME
MuleApplicationModelLoader	muleApplicationModelLoader
static String	MUNIT_PREVIOUS_RUN_PLACEHOLDER
String	munitDebug
boolean	munitFailIfNoTests
String	munitTags
String	munitTest
File	munitTestsDirectory
File	outputDirectory
String	pluginArtifactId
org.apache.maven.project.MavenProject	project
File	projectBaseFolder
protected org.apache.maven.project.ProjectBuilder	projectBuilder
boolean	redirectTestOutputToFile
protected static Class	REMOTE_RUNNER_CLASS
List<org.apache.maven.artifact.repository.ArtifactRepository>	remoteArtifactRepositories
org.eclipse.aether.RepositorySystem	repositorySystem
org.eclipse.aether.RepositorySystemSession	repositorySystemSession
ResultPrinterFactory	resultPrinterFactory
protected static String	RUN_CONFIGURATION_ARG
static String	RUN_CONFIGURATION_JSON
RuntimeConfiguration	runtimeConfiguration
String	runtimeProduct
String	runtimeVersion
RuntimeVersionProviderFactory	runtimeVersionProviderFactory
RuntimeVersionsLocator	runtimeVersionsLocator
org.apache.maven.execution.MavenSession	session
boolean	skipAfterFailure
boolean	skipMunitTests
File	sonarReportsFolder
static String	STARTER_CLASS_FILE
List<File>	suiteFiles
File	surefireReportsFolder
Map<String,String>	systemPropertyVariables
boolean	testFailureIgnore Set this to true to ignore a failure during testing.
File	testOutputDirectory
protected org.apache.maven.toolchain.ToolchainManager	toolchainManager
WorkingDirectoryGenerator	workingDirectoryGenerator

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractMunitMojo()

Method Summary

Modifier and Type	Method and Description
JVMStarter	createJVMStarter(File runConfigurationFile, List<String> argLines)
protected RemoteRepositoriesLocator	createRemoteRepositoriesLocator()
protected abstract org.mule.munit.remote.api.configuration.RunConfiguration	createRunConfiguration(TargetRuntime targetRuntime)
protected JVMStarter	createTestRunExecutor(org.mule.munit.remote.api.configuration.RunConfiguration runConfiguration)
void	doExecute()
void	execute()
protected void	failBuildIfNecessary(Map<TargetRuntime,RunResult> runResults)
protected abstract org.mule.munit.remote.api.project.ApplicationStructureGenerator	getApplicationStructureGenerator()
List<org.mule.tools.model.Deployment>	getDeployments()
List<String>	getEffectiveArgLines(String starterJarFileName, File log4jConfigurationFile)
protected abstract File	getMuleApplicationJsonPath()
protected org.mule.runtime.api.deployment.meta.MuleApplicationModel	getMuleApplicationModel()
protected MuleApplicationModelLoader	getMuleApplicationModelLoader()
protected abstract ResultPrinterFactory	getResultPrinterFactory()
protected Map<TargetRuntime,org.mule.munit.remote.api.configuration.RunConfiguration>	getRunConfigurations()
File	getWorkingDirectory()
protected void	handleRunResult(TargetRuntime targetRuntime, RunResult runResult)
protected boolean	hasExecutedBefore() This method avoids running MUnit more than once.
protected void	init()
protected void	saveAsJsonDataToFile(Object data, File dataLocation)
File	saveRunConfigurationToFile(org.mule.munit.remote.api.configuration.RunConfiguration runConfiguration)
protected boolean	shouldDiscoverRuntimes(Optional<DiscoverRuntimes> discoverRuntimes)
void	validateProperties()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

ARG_TOKEN

protected static final String ARG_TOKEN

See Also:

Constant Field Values

RUN_CONFIGURATION_ARG

protected static final String RUN_CONFIGURATION_ARG

See Also:

Constant Field Values

RUN_CONFIGURATION_JSON

public static final String RUN_CONFIGURATION_JSON

See Also:

Constant Field Values

STARTER_CLASS_FILE

public static final String STARTER_CLASS_FILE

See Also:

Constant Field Values

MUNIT_PREVIOUS_RUN_PLACEHOLDER

public static final String MUNIT_PREVIOUS_RUN_PLACEHOLDER

See Also:

Constant Field Values

REMOTE_RUNNER_CLASS

protected static final Class REMOTE_RUNNER_CLASS

MULE_ARTIFACT_JSON_FILE_NAME

public static final String MULE_ARTIFACT_JSON_FILE_NAME

See Also:

Constant Field Values

munitTest

@Parameter(property="munit.test")
public String munitTest

munitTags

@Parameter(property="munit.tags")
public String munitTags

munitFailIfNoTests

@Parameter(property="munit.failIfNoTests",
           defaultValue="true")
public boolean munitFailIfNoTests

munitDebug

@Parameter(property="munit.debug")
public String munitDebug

runtimeVersion

@Parameter(property="runtimeVersion")
public String runtimeVersion

runtimeProduct

@Parameter(property="runtimeProduct")
public String runtimeProduct

skipMunitTests

@Parameter(defaultValue="${skipMunitTests}")
public boolean skipMunitTests

munitTestsDirectory

@Parameter(defaultValue="${project.build.directory}/test-mule/munit")
public File munitTestsDirectory

project

@Parameter(property="project",
           required=true)
public org.apache.maven.project.MavenProject project

session

@Parameter(defaultValue="${session}",
           readonly=true)
public org.apache.maven.execution.MavenSession session

repositorySystemSession

@Parameter(defaultValue="${repositorySystemSession}",
           readonly=true)
public org.eclipse.aether.RepositorySystemSession repositorySystemSession

pluginArtifactId

@Parameter(defaultValue="${plugin.artifactId}")
public String pluginArtifactId

redirectTestOutputToFile

@Parameter(property="redirectTestOutputToFile",
           defaultValue="false")
public boolean redirectTestOutputToFile

testOutputDirectory

@Parameter(defaultValue="${project.build.directory}/munit-reports/output/")
public File testOutputDirectory

enableSurefireReports

@Parameter(property="enableSurefireReports",
           defaultValue="true")
public boolean enableSurefireReports

enableSonarReports

@Parameter(property="enableSonarReports",
           defaultValue="true")
public boolean enableSonarReports

surefireReportsFolder

@Parameter(defaultValue="${project.build.directory}/surefire-reports/")
public File surefireReportsFolder

sonarReportsFolder

@Parameter(defaultValue="${project.build.directory}/sonar-reports/")
public File sonarReportsFolder

skipAfterFailure

@Parameter(property="skipAfterFailure",
           defaultValue="false")
public boolean skipAfterFailure

jvm

@Parameter(property="munit.jvm")
public String jvm

argLines

@Parameter(property="argLines")
public List<String> argLines

systemPropertyVariables

@Parameter(property="system.property.variables")
public Map<String,String> systemPropertyVariables

environmentVariables

@Parameter(property="environment.variables")
public Map<String,String> environmentVariables

dynamicPorts

@Parameter(property="dynamic.ports")
public List<String> dynamicPorts

testFailureIgnore

@Parameter(property="maven.test.failure.ignore",
           defaultValue="false")
public boolean testFailureIgnore

Set this to true to ignore a failure during testing. Its use is NOT RECOMMENDED, but quite convenient on occasion.

runtimeConfiguration

@Parameter
public RuntimeConfiguration runtimeConfiguration

toolchainManager

@Component
protected org.apache.maven.toolchain.ToolchainManager toolchainManager

repositorySystem

@Component
public org.eclipse.aether.RepositorySystem repositorySystem

projectBuilder

@Component
protected org.apache.maven.project.ProjectBuilder projectBuilder

mavenRepositorySystem

@Component
protected org.apache.maven.repository.RepositorySystem mavenRepositorySystem

outputDirectory

@Parameter(property="project.build.directory",
           required=true)
public File outputDirectory

localRepository

@Parameter(readonly=true,
           required=true,
           defaultValue="${localRepository}")
public org.apache.maven.artifact.repository.ArtifactRepository localRepository

remoteArtifactRepositories

@Parameter(readonly=true,
           required=true,
           defaultValue="${project.remoteArtifactRepositories}")
public List<org.apache.maven.artifact.repository.ArtifactRepository> remoteArtifactRepositories

projectBaseFolder

@Parameter(defaultValue="${project.basedir}")
public File projectBaseFolder

cloudHubDeployment

@Parameter
public org.mule.tools.model.anypoint.CloudHubDeployment cloudHubDeployment

gson

protected com.google.gson.Gson gson

suiteFiles

public List<File> suiteFiles

jvmLocator

public JVMLocator jvmLocator

jarFileFactory

public JarFileFactory jarFileFactory

classpathManager

public ClasspathManager classpathManager

messageHandlerFactory

public MessageHandlerFactory messageHandlerFactory

effectiveSystemProperties

public Map<String,String> effectiveSystemProperties

workingDirectoryGenerator

public WorkingDirectoryGenerator workingDirectoryGenerator

muleApplicationModelLoader

public MuleApplicationModelLoader muleApplicationModelLoader

runtimeVersionProviderFactory

public RuntimeVersionProviderFactory runtimeVersionProviderFactory

runtimeVersionsLocator

public RuntimeVersionsLocator runtimeVersionsLocator

resultPrinterFactory

public ResultPrinterFactory resultPrinterFactory

Constructor Detail

AbstractMunitMojo

public AbstractMunitMojo()

Method Detail

init

protected void init()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

hasExecutedBefore

protected boolean hasExecutedBefore()

This method avoids running MUnit more than once. This could happen because other phases such as the coverage-report, can trigger the "test" phase since it needs its information.

Returns:

true if the MUnit run has already happened before

doExecute

public void doExecute()
               throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

createTestRunExecutor

protected JVMStarter createTestRunExecutor(org.mule.munit.remote.api.configuration.RunConfiguration runConfiguration)
                                    throws IOException

Throws:

IOException

handleRunResult

protected void handleRunResult(TargetRuntime targetRuntime,
                               RunResult runResult)

failBuildIfNecessary

protected void failBuildIfNecessary(Map<TargetRuntime,RunResult> runResults)
                             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getResultPrinterFactory

protected abstract ResultPrinterFactory getResultPrinterFactory()

getApplicationStructureGenerator

protected abstract org.mule.munit.remote.api.project.ApplicationStructureGenerator getApplicationStructureGenerator()
                                                                                                             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getMuleApplicationJsonPath

protected abstract File getMuleApplicationJsonPath()

createRunConfiguration

protected abstract org.mule.munit.remote.api.configuration.RunConfiguration createRunConfiguration(TargetRuntime targetRuntime)
                                                                                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getRunConfigurations

protected Map<TargetRuntime,org.mule.munit.remote.api.configuration.RunConfiguration> getRunConfigurations()
                                                                                                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

shouldDiscoverRuntimes

protected boolean shouldDiscoverRuntimes(Optional<DiscoverRuntimes> discoverRuntimes)

getEffectiveArgLines

public List<String> getEffectiveArgLines(String starterJarFileName,
                                         File log4jConfigurationFile)

createJVMStarter

public JVMStarter createJVMStarter(File runConfigurationFile,
                                   List<String> argLines)
                            throws IOException

Throws:

IOException

saveRunConfigurationToFile

public File saveRunConfigurationToFile(org.mule.munit.remote.api.configuration.RunConfiguration runConfiguration)
                                throws IOException

Throws:

IOException

saveAsJsonDataToFile

protected void saveAsJsonDataToFile(Object data,
                                    File dataLocation)

getMuleApplicationModelLoader

protected MuleApplicationModelLoader getMuleApplicationModelLoader()
                                                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getMuleApplicationModel

protected org.mule.runtime.api.deployment.meta.MuleApplicationModel getMuleApplicationModel()
                                                                                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getWorkingDirectory

public File getWorkingDirectory()

createRemoteRepositoriesLocator

protected RemoteRepositoriesLocator createRemoteRepositoriesLocator()

getDeployments

public List<org.mule.tools.model.Deployment> getDeployments()

validateProperties

public void validateProperties()
                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException