edu.illinois.starts.jdeps

Class RunMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.surefire.AbstractSurefireMojo

org.apache.maven.plugin.surefire.SurefirePlugin

edu.illinois.starts.jdeps.DiffMojo

edu.illinois.starts.jdeps.RunMojo

All Implemented Interfaces:

StartsConstants, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.plugin.surefire.SurefireExecutionParameters, org.apache.maven.plugin.surefire.SurefireReportParameters

Direct Known Subclasses:

StartsMojo

@Mojo(name="run",
      requiresDependencyResolution=TEST)
public class RunMojo
extends DiffMojo
implements StartsConstants

Prepares for test runs by writing non-affected tests in the excludesFile.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	artifactsDir The directory in which to store STARTS artifacts that are needed between runs.
protected Set<String>	changedClasses
protected DependencyFormat	depFormat Allows to switch the format in which we want to store the test dependencies.
protected boolean	filterLib Set this to "false" to not filter out "sun.*" and "java.*" classes from jdeps parsing.
protected String	graphCache Path to directory that contains the result of running jdeps on third-party and standard library jars that an application may need, e.g., those in M2_REPO.
protected String	graphFile Output filename for the graph, if printGraph == true.
protected List<Pair>	jarCheckSums
protected String	loggingLevel Log levels as defined in java.util.logging.Level.
protected Set<String>	nonAffectedTests
protected boolean	printGraph Set this to "false" to not print the graph obtained from jdeps parsing.
protected boolean	retestAll Set this option to "true" to run all tests, not just the affected ones.
protected boolean	updateRunChecksums Set this to "false" to prevent checksums from being persisted to disk.
protected boolean	useThirdParty Set this to "false" to not add jdeps edges from 3rd party-libraries.
protected boolean	writeChangedClasses Set this to "true" to save changedClasses to a file on disk.
protected boolean	writeNonAffected Set this to "true" to save nonAffectedTests to a file on disk.

Fields inherited from class edu.illinois.starts.jdeps.DiffMojo

cleanBytes, zlcFormat

Fields inherited from class org.apache.maven.plugin.surefire.AbstractSurefireMojo

basedir, FORK_NUMBER_PLACEHOLDER, skip, skipExec, skipTests, testClassesDirectory, THREAD_NUMBER_PLACEHOLDER

Fields inherited from interface edu.illinois.starts.constants.StartsConstants

ABSTRACT_SUREFIRE_MOJO_BIN, ABSTRACT_SUREFIRE_MOJO_VM, ARGLINE_FIELD, CHANGED_CLASSES, CHECK_IF_ALL_AFFECTED, CLASS_EXTENSION, CLASSES, COLON, COMMA, DOT, EMPTY, EXCLUDES_FIELD, EXECUTE_MDESC, EXECUTE_MNAME, FALSE, JAR_CHECKSUMS, JAR_EXTENSION, JAVA_HOME, MILLISECOND, MOJO_EXECUTION_EXCEPTION_BIN, NO_TESTS_ARE_SELECTED_TO_RUN, PROFILE_END_OF_RUN_MOJO, PROFILE_RUN_MOJO_TOTAL, PROFILE_STARTS_MOJO_UPDATE_TIME, PROFILE_TEST_RUNNING_TIME, PROFILE_UPDATE_FOR_NEXT_RUN_TOTAL, SF_CLASSPATH, STARS_RUN_STARS, STARTS_AFFECTED_TESTS, STARTS_DIRECTORY_PATH, STARTS_EXCLUDE_PROPERTY, STARTS_NAME, SUREFIRE_INTERCEPTOR_CLASS_VM, SUREFIRE_PLUGIN_BIN, SUREFIRE_PLUGIN_VM, TEST_CLASSES, TIME_COMPUTING_NON_AFFECTED, TRUE, WHITE_SPACE

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

ROLE

Constructor Summary

Constructors

Constructor and Description
RunMojo()

Method Summary

Modifier and Type	Method and Description
ClassLoader	createClassLoader(org.apache.maven.surefire.booter.Classpath sfClassPath)
void	execute()
protected List<String>	getAllClasses()
String	getArtifactsDir()
org.apache.maven.surefire.booter.Classpath	getSureFireClassPath()
List	getTestClasses(String methodName)
edu.illinois.starts.jdeps.BaseMojo.Result	prepareForNextRun(String sfPathString, org.apache.maven.surefire.booter.Classpath sfClassPath, List<String> classesToAnalyze, Set<String> nonAffected, boolean computeUnreached)
protected void	printResult(Set<String> set, String title)
protected void	run()
protected void	setChangedAndNonaffected()
void	setIncludesExcludes()

Methods inherited from class edu.illinois.starts.jdeps.DiffMojo

computeChangeData, printToTerminal, save, updateForNextRun

Methods inherited from class org.apache.maven.plugin.surefire.SurefirePlugin

getBasedir, getClassesDirectory, getDebugForkedProcess, getDefaultIncludes, getExcludesFile, getFailIfNoSpecifiedTests, getForkedProcessExitTimeoutInSeconds, getForkedProcessTimeoutInSeconds, getIncludes, getIncludesFile, getMojoArtifact, getParallelTestsTimeoutForcedInSeconds, getParallelTestsTimeoutInSeconds, getPluginName, getReportFormat, getReportSchemaLocation, getReportsDirectory, getRerunFailingTestsCount, getRunOrder, getShutdown, getSkipAfterFailureCount, getSuiteXmlFiles, getTest, getTestClassesDirectory, handleSummary, hasSuiteXmlFiles, isPrintSummary, isSkip, isSkipExec, isSkipExecution, isSkipTests, isTestFailureIgnore, isUseFile, isUseManifestOnlyJar, isUseSystemClassLoader, setBasedir, setClassesDirectory, setDebugForkedProcess, setFailIfNoSpecifiedTests, setForkedProcessExitTimeoutInSeconds, setForkedProcessTimeoutInSeconds, setIncludes, setParallelTestsTimeoutForcedInSeconds, setParallelTestsTimeoutInSeconds, setPrintSummary, setReportFormat, setReportsDirectory, setRunOrder, setSkip, setSkipExec, setSkipTests, setSuiteXmlFiles, setTest, setTestClassesDirectory, setTestFailureIgnore, setUseFile, setUseManifestOnlyJar, setUseSystemClassLoader, suiteXmlFiles

Methods inherited from class org.apache.maven.plugin.surefire.AbstractSurefireMojo

addPluginSpecificChecksumItems, cleanupForkConfiguration, convertWithCoreCount, createCopyAndReplaceForkNumPlaceholder, createProviders, effectiveIsEnableAssertions, getAdditionalClasspathElements, getArgLine, getArtifactFactory, getArtifactResolver, getClassLoaderConfiguration, getClasspathDependencyExcludes, getClasspathDependencyScopeExclude, getConsoleLogger, getDependenciesToScan, getEffectiveForkCount, getEnvironmentVariables, getExcludedGroups, getExcludes, getFailIfNoTests, getForkCount, getForkMode, getGroups, getJunitArtifactName, getJvm, getLocalRepository, getMetadataSource, getObjectFactory, getParallel, getPerCoreThreadCount, getPluginArtifactMap, getPluginDescriptor, getProject, getProjectArtifactMap, getProjectBuildDirectory, getRemoteRepositories, getReportNameSuffix, getSession, getSpecificTests, getStatisticsFile, getSystemProperties, getSystemPropertiesFile, getSystemPropertyVariables, getTempDir, getTestNGArtifactName, getTestSourceDirectory, getThreadCount, getThreadCountClasses, getThreadCountMethods, getThreadCountSuites, getToolchainManager, getUseUnlimitedThreads, getWorkingDirectory, hasExecutedBefore, isAnyConcurrencySelected, isAnyGroupsSelected, isChildDelegation, isDisableXmlReport, isEnableAssertions, isForking, isMavenParallel, isParallelOptimized, isRedirectTestOutputToFile, isReuseForks, isTrimStackTrace, logDebugOrCliShowErrors, logReportsDirectory, setAdditionalClasspathElements, setArgLine, setArtifactFactory, setArtifactResolver, setChildDelegation, setClasspathDependencyExcludes, setClasspathDependencyScopeExclude, setDependenciesToScan, setDisableXmlReport, setEnableAssertions, setEnvironmentVariables, setExcludedGroups, setExcludes, setFailIfNoTests, setForkMode, setGroups, setJunitArtifactName, setLocalRepository, setMetadataSource, setObjectFactory, setParallel, setParallelOptimized, setPerCoreThreadCount, setPluginArtifactMap, setProject, setProjectArtifactMap, setProjectBuildDirectory, setProperties, setRedirectTestOutputToFile, setRemoteRepositories, setReportNameSuffix, setSession, setSystemProperties, setSystemPropertiesFile, setSystemPropertyVariables, setTempDir, setTestNGArtifactName, setTestSourceDirectory, setThreadCount, setThreadCountClasses, setThreadCountMethods, setThreadCountSuites, setToolchainManager, setTrimStackTrace, setUseUnlimitedThreads, setWorkingDirectory

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

Methods inherited from interface org.apache.maven.plugin.surefire.SurefireReportParameters

getFailIfNoTests, setFailIfNoTests

Field Detail

updateRunChecksums

@Parameter(property="updateRunChecksums",
           defaultValue="true")
protected boolean updateRunChecksums

Set this to "false" to prevent checksums from being persisted to disk. This is useful for "dry runs" where one may want to see the non-affected tests that STARTS writes to the Surefire excludesFile, without updating test dependencies.

retestAll

@Parameter(property="retestAll",
           defaultValue="false")
protected boolean retestAll

Set this option to "true" to run all tests, not just the affected ones. This option is useful in cases where one is interested to measure the time to run all tests, while at the same time measuring the times for analyzing what tests to select and reporting the number of tests it would select. Note: Run with "-DstartsLogging=FINER" or "-DstartsLogging=FINEST" so that the "selected-tests" file, which contains the list of tests that would be run if this option is set to false, will be written to disk.

writeNonAffected

@Parameter(property="writeNonAffected",
           defaultValue="false")
protected boolean writeNonAffected

Set this to "true" to save nonAffectedTests to a file on disk. This improves the time for updating test dependencies in offline mode by not running computeChangeData() twice. Note: Running with "-DstartsLogging=FINEST" also saves nonAffectedTests to a file on disk.

writeChangedClasses

@Parameter(property="writeChangedClasses",
           defaultValue="false")
protected boolean writeChangedClasses

Set this to "true" to save changedClasses to a file on disk. Note: Running with "-DstartsLogging=FINEST" also saves changedClasses to a file on disk.

nonAffectedTests

protected Set<String> nonAffectedTests

changedClasses

protected Set<String> changedClasses

jarCheckSums

protected List<Pair> jarCheckSums

filterLib

@Parameter(property="filterLib",
           defaultValue="true")
protected boolean filterLib

Set this to "false" to not filter out "sun.*" and "java.*" classes from jdeps parsing.

useThirdParty

@Parameter(property="useThirdParty",
           defaultValue="false")
protected boolean useThirdParty

Set this to "false" to not add jdeps edges from 3rd party-libraries.

artifactsDir

protected String artifactsDir

The directory in which to store STARTS artifacts that are needed between runs.

depFormat

@Parameter(property="depFormat",
           defaultValue="ZLC")
protected DependencyFormat depFormat

Allows to switch the format in which we want to store the test dependencies. A full list of what we currently support can be found in

See Also:

DependencyFormat

graphCache

@Parameter(property="gCache",
           defaultValue="${basedir}${file.separator}jdeps-cache")
protected String graphCache

Path to directory that contains the result of running jdeps on third-party and standard library jars that an application may need, e.g., those in M2_REPO.

printGraph

@Parameter(property="printGraph",
           defaultValue="true")
protected boolean printGraph

Set this to "false" to not print the graph obtained from jdeps parsing. When "true" the graph is written to file after the run.

graphFile

@Parameter(defaultValue="graph",
           readonly=true,
           required=true)
protected String graphFile

Output filename for the graph, if printGraph == true.

loggingLevel

@Parameter(property="startsLogging",
           defaultValue="CONFIG")
protected String loggingLevel

Log levels as defined in java.util.logging.Level.

Constructor Detail

RunMojo

public RunMojo()

Method Detail

execute

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

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class DiffMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

run

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

Throws:

org.apache.maven.plugin.MojoExecutionException

setChangedAndNonaffected

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

Throws:

org.apache.maven.plugin.MojoExecutionException

printResult

protected void printResult(Set<String> set,
                           String title)

getArtifactsDir

public String getArtifactsDir()
                       throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

setIncludesExcludes

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

Throws:

org.apache.maven.plugin.MojoExecutionException

getTestClasses

public List getTestClasses(String methodName)

createClassLoader

public ClassLoader createClassLoader(org.apache.maven.surefire.booter.Classpath sfClassPath)

getSureFireClassPath

public org.apache.maven.surefire.booter.Classpath getSureFireClassPath()
                                                                throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

prepareForNextRun

public edu.illinois.starts.jdeps.BaseMojo.Result prepareForNextRun(String sfPathString,
                                                                   org.apache.maven.surefire.booter.Classpath sfClassPath,
                                                                   List<String> classesToAnalyze,
                                                                   Set<String> nonAffected,
                                                                   boolean computeUnreached)
                                                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getAllClasses

protected List<String> getAllClasses()