edu.illinois.starts.jdeps

Class DiffMojo

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

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:

ImpactedMojo, RunMojo, SelectMojo

@Mojo(name="diff",
      requiresDirectInvocation=true,
      requiresDependencyResolution=TEST)
 @Execute(phase=TEST_COMPILE)
public class DiffMojo
extends org.apache.maven.plugin.surefire.SurefirePlugin
implements StartsConstants

Finds types that have changed since the last time they were analyzed.

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 boolean	cleanBytes Set this to "false" to disable smart hashing, i.e., to *not* strip Bytecode files of debug info prior to computing checksums.
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 String	loggingLevel Log levels as defined in java.util.logging.Level.
protected boolean	printGraph Set this to "false" to not print the graph obtained from jdeps parsing.
protected boolean	useThirdParty Set this to "false" to not add jdeps edges from 3rd party-libraries.
protected ZLCFormat	zlcFormat Format of the ZLC dependency file deps.zlc Set to "INDEXED" to store indices of tests Set to "PLAIN_TEXT" to store full URLs of tests

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
DiffMojo()

Method Summary

Modifier and Type	Method and Description
protected Pair<Set<String>,Set<String>>	computeChangeData(boolean writeChanged)
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)
void	printToTerminal(List<String> testClasses, Set<String> affectedTests)
void	save(String artifactsDir, Set<String> affectedTests, List<String> testClasses, String sfPathString, edu.illinois.yasgl.DirectedGraph<String> graph)
void	setIncludesExcludes()
protected void	updateForNextRun(Set<String> nonAffected)

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

cleanBytes

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

Set this to "false" to disable smart hashing, i.e., to *not* strip Bytecode files of debug info prior to computing checksums. See the "Smart Checksums" Sections in the Ekstazi paper: http://dl.acm.org/citation.cfm?id=2771784

zlcFormat

@Parameter(property="zlcFormat",
           defaultValue="PLAIN_TEXT")
protected ZLCFormat zlcFormat

Format of the ZLC dependency file deps.zlc Set to "INDEXED" to store indices of tests Set to "PLAIN_TEXT" to store full URLs of tests

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

DiffMojo

public DiffMojo()

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 org.apache.maven.plugin.surefire.AbstractSurefireMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

computeChangeData

protected Pair<Set<String>,Set<String>> computeChangeData(boolean writeChanged)
                                                   throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

updateForNextRun

protected void updateForNextRun(Set<String> nonAffected)
                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

printToTerminal

public void printToTerminal(List<String> testClasses,
                            Set<String> affectedTests)

save

public void save(String artifactsDir,
                 Set<String> affectedTests,
                 List<String> testClasses,
                 String sfPathString,
                 edu.illinois.yasgl.DirectedGraph<String> graph)

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()