Class PluginTestTool

java.lang.Object
org.apache.maven.shared.test.plugin.PluginTestTool

@Deprecated @Component(role=PluginTestTool.class) public class PluginTestTool extends Object
Deprecated.
Test tool that provides a single point of access for staging a plugin artifact - along with its POM lineage - into a clean test-time local repository. This involves modifying the plugin POM to provide a stable test-time version for test-build POMs to reference, then installing the plugin jar and associated POMs (including those ancestors that are reachable using <relativePath>) into the test local repository.

WARNING: Currently, the RepositoryTool will not resolve parent POMs that exist only in your normal local repository, and are not reachable using the relativePath element. This may result in failed test builds, as one or more of the plugin's ancestor POMs cannot be resolved.

Version:
$Id$
Author:
jdcasey
  • Field Details

    • ROLE

      public static final String ROLE
      Deprecated.
      Plexus role
  • Constructor Details

    • PluginTestTool

      public PluginTestTool()
      Deprecated.
  • Method Details

    • preparePluginForIntegrationTesting

      public File preparePluginForIntegrationTesting(File pomFile, String testVersion) throws TestToolsException
      Deprecated.
      Stage the plugin, using a stable version, into a temporary local-repository directory that is generated by this method. When the plugin is staged, return the local repository base directory for use in test builds.
      Parameters:
      pomFile - current POM file
      testVersion - The test version for the plugin, used for reference in test-build POMs and fully-qualified goals
      Returns:
      The base-directory location of the generated local repository
      Throws:
      TestToolsException - if any
    • preparePluginForUnitTestingWithMavenBuilds

      public File preparePluginForUnitTestingWithMavenBuilds(File pomFile, String testVersion) throws TestToolsException
      Deprecated.
      Stage the plugin, using a stable version, into a temporary local-repository directory that is generated by this method. When the plugin is staged, return the local repository base directory for use in test builds. This method also skips unit testing during plugin jar production, since it is assumed that executing these tests would lead to a recursive test-and-build loop.
      Parameters:
      pomFile - current POM file
      testVersion - The test version for the plugin, used for reference in test-build POMs and fully-qualified goals
      Returns:
      The base-directory location of the generated local repository
      Throws:
      TestToolsException - if any
    • preparePluginForIntegrationTesting

      public File preparePluginForIntegrationTesting(File pomFile, String testVersion, File localRepositoryDir) throws TestToolsException
      Deprecated.
      Stage the plugin, using a stable version, into the specified local-repository directory. When the plugin is staged, return the local repository base directory for verification.
      Parameters:
      pomFile - current POM file
      testVersion - The test version for the plugin, used for reference in test-build POMs and fully-qualified goals
      localRepositoryDir - The base-directory location of the test local repository, into which the plugin's test version should be staged.
      Returns:
      The base-directory location of the generated local repository
      Throws:
      TestToolsException - if any
    • preparePluginForUnitTestingWithMavenBuilds

      public File preparePluginForUnitTestingWithMavenBuilds(File pomFile, String testVersion, File localRepositoryDir) throws TestToolsException
      Deprecated.
      Stage the plugin, using a stable version, into the specified local-repository directory. When the plugin is staged, return the local repository base directory for verification. This method also skips unit testing during plugin jar production, since it is assumed that executing these tests would lead to a recursive test-and-build loop.
      Parameters:
      pomFile - current POM file
      testVersion - The test version for the plugin, used for reference in test-build POMs and fully-qualified goals
      localRepositoryDir - The base-directory location of the test local repository, into which the plugin's test version should be staged.
      Returns:
      The base-directory location of the generated local repository
      Throws:
      TestToolsException - if any