Class ProjectTool
java.lang.Object
org.apache.maven.shared.test.plugin.ProjectTool
Deprecated.
Testing tool used to read MavenProject instances from pom.xml files, and to create plugin jar
files (package phase of the normal build process) for distribution to a test local repository
directory.
- Version:
- $Id$
- Author:
- jdcasey
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected org.apache.maven.shared.test.plugin.ProjectTool.PomInfo
manglePomForTesting
(File pomFile, String testVersion, boolean skipUnitTests) Deprecated.Inject a special version for testing, to allow tests to unambiguously reference the plugin currently under test.org.apache.maven.project.MavenProject
packageProjectArtifact
(File pomFile, String testVersion, boolean skipUnitTests) Deprecated.Run the plugin's Maven build up to the package phase, in order to produce a jar file for distribution to a test-time local repository.org.apache.maven.project.MavenProject
packageProjectArtifact
(File pomFile, String testVersion, boolean skipUnitTests, File logFile) Deprecated.Run the plugin's Maven build up to the package phase, in order to produce a jar file for distribution to a test-time local repository.org.apache.maven.project.MavenProject
readProject
(File pomFile) Deprecated.Construct a MavenProject instance from the specified POM file.org.apache.maven.project.MavenProject
readProject
(File pomFile, File localRepositoryBasedir) Deprecated.Construct a MavenProject instance from the specified POM file, using the specified local repository directory to resolve ancestor POMs as needed.org.apache.maven.project.MavenProject
readProjectWithDependencies
(File pomFile) Deprecated.Construct a MavenProject instance from the specified POM file with dependencies.org.apache.maven.project.MavenProject
readProjectWithDependencies
(File pomFile, File localRepositoryBasedir) Deprecated.Construct a MavenProject instance from the specified POM file with dependencies, using the specified local repository directory to resolve ancestor POMs as needed.
-
Field Details
-
ROLE
Deprecated.Plexus role -
INTEGRATION_TEST_DEPLOYMENT_REPO_URL
Deprecated.- See Also:
-
-
Constructor Details
-
ProjectTool
public ProjectTool()Deprecated.
-
-
Method Details
-
readProject
Deprecated.Construct a MavenProject instance from the specified POM file.- Parameters:
pomFile
- current POM file- Returns:
- the Maven project from a file
- Throws:
TestToolsException
- if any
-
readProject
public org.apache.maven.project.MavenProject readProject(File pomFile, File localRepositoryBasedir) throws TestToolsException Deprecated.Construct a MavenProject instance from the specified POM file, using the specified local repository directory to resolve ancestor POMs as needed.- Parameters:
pomFile
- current POM filelocalRepositoryBasedir
-- Returns:
- the Maven project from a file and a local repo
- Throws:
TestToolsException
- if any
-
readProjectWithDependencies
public org.apache.maven.project.MavenProject readProjectWithDependencies(File pomFile) throws TestToolsException Deprecated.Construct a MavenProject instance from the specified POM file with dependencies.- Parameters:
pomFile
- current POM file- Returns:
- the Maven project with dependencies from a file
- Throws:
TestToolsException
- if any
-
readProjectWithDependencies
public org.apache.maven.project.MavenProject readProjectWithDependencies(File pomFile, File localRepositoryBasedir) throws TestToolsException Deprecated.Construct a MavenProject instance from the specified POM file with dependencies, using the specified local repository directory to resolve ancestor POMs as needed.- Parameters:
pomFile
- current POM filelocalRepositoryBasedir
-- Returns:
- the Maven project with dependencies from a file and a local repo
- Throws:
TestToolsException
- if any
-
packageProjectArtifact
public org.apache.maven.project.MavenProject packageProjectArtifact(File pomFile, String testVersion, boolean skipUnitTests) throws TestToolsException Deprecated.Run the plugin's Maven build up to the package phase, in order to produce a jar file for distribution to a test-time local repository. The testVersion parameter specifies the version to be used in the <version/> element of the plugin configuration, and also in fully qualified, unambiguous goal invocations (as in org.apache.maven.plugins:maven-eclipse-plugin:test:eclipse).- Parameters:
pomFile
- The plugin's POMtestVersion
- The version to use for testing this plugin. To promote test resiliency, this version should remain unchanged, regardless of what plugin version is under development.skipUnitTests
- In cases where test builds occur during the unit-testing phase (usually a bad testing smell), the plugin jar must be produced without running unit tests. Otherwise, the testing process will result in a recursive loop of building a plugin jar and trying to unit test it during the build. In these cases, set this flag totrue
.- Returns:
- The resulting MavenProject, after the test version and skip flag (for unit tests) have been appropriately configured.
- Throws:
TestToolsException
- if any
-
packageProjectArtifact
public org.apache.maven.project.MavenProject packageProjectArtifact(File pomFile, String testVersion, boolean skipUnitTests, File logFile) throws TestToolsException Deprecated.Run the plugin's Maven build up to the package phase, in order to produce a jar file for distribution to a test-time local repository. The testVersion parameter specifies the version to be used in the <version/> element of the plugin configuration, and also in fully qualified, unambiguous goal invocations (as in org.apache.maven.plugins:maven-eclipse-plugin:test:eclipse).- Parameters:
pomFile
- The plugin's POMtestVersion
- The version to use for testing this plugin. To promote test resiliency, this version should remain unchanged, regardless of what plugin version is under development.skipUnitTests
- In cases where test builds occur during the unit-testing phase (usually a bad testing smell), the plugin jar must be produced without running unit tests. Otherwise, the testing process will result in a recursive loop of building a plugin jar and trying to unit test it during the build. In these cases, set this flag totrue
.logFile
- The file to which build output should be logged, in order to allow later inspection in case this build fails.- Returns:
- The resulting MavenProject, after the test version and skip flag (for unit tests) have been appropriately configured.
- Throws:
TestToolsException
- if any
-
manglePomForTesting
protected org.apache.maven.shared.test.plugin.ProjectTool.PomInfo manglePomForTesting(File pomFile, String testVersion, boolean skipUnitTests) throws TestToolsException Deprecated.Inject a special version for testing, to allow tests to unambiguously reference the plugin currently under test. If test builds will be executed from the unit-testing phase, also inject <skip>true</skip> into the configuration of themaven-surefire-plugin
to allow production of a test-only version of the plugin jar without running unit tests.- Parameters:
pomFile
- The plugin POMtestVersion
- The version that allows test builds to reference the plugin under testskipUnitTests
- If true, configure the surefire plugin to skip unit tests- Returns:
- Information about mangled POM, including the temporary file to which it was written.
- Throws:
TestToolsException
- if any
-