package org.apache.maven.plugin.invoker;

 import java.util.ArrayList;

 import java.util.Iterator;

 import java.util.List;

 import org.apache.maven.plugin.AbstractMojo;

 import org.apache.maven.plugin.MojoExecutionException;

 /**

  * Display help information on maven-invoker-plugin.<br/> Call <pre>  mvn invoker:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</pre> to display parameter details.

  *

  * @version generated on Thu Sep 25 22:08:39 CEST 2008

  * @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.4.3)

  * @goal help

  * @requiresProject false

  */

 public class HelpMojo

     extends AbstractMojo

 {

     /**

      * If <code>true</code>, display all settable properties for each goal.

      * 

      * @parameter expression="${detail}" default-value="false"

      */

     private boolean detail;

     /**

      * The name of the goal for which to show help. If unspecified, all goals will be displayed.

      * 

      * @parameter expression="${goal}"

      */

     private java.lang.String goal;

     /**

      * The maximum length of a display line, should be positive.

      * 

      * @parameter expression="${lineLength}" default-value="80"

      */

     private int lineLength;

     /**

      * The number of spaces per indentation level, should be positive.

      * 

      * @parameter expression="${indentSize}" default-value="2"

      */

     private int indentSize;

     /** {@inheritDoc} */

     public void execute()

         throws MojoExecutionException

     {

         if ( lineLength <= 0 )

         {

             getLog().warn( "The parameter 'lineLength' should be positive, using '80' as default." );

             lineLength = 80;

         }

         if ( indentSize <= 0 )

         {

             getLog().warn( "The parameter 'indentSize' should be positive, using '2' as default." );

             indentSize = 2;

         }

         StringBuffer sb = new StringBuffer();

         append( sb, "org.apache.maven.plugins:maven-invoker-plugin:1.3", 0 );

         append( sb, "", 0 );

         append( sb, "Maven Invoker Plugin 1.3", 0 );

         append( sb, "The Maven Invoker Plugin is used to run a set of Maven projects. The plugin can determine whether each project execution is successful, and optionally can verify the output generated from a given project execution.", 1 );

         append( sb, "", 0 );

         if ( goal == null || goal.length() <= 0 )

         {

             append( sb, "This plugin has 3 goals:", 0 );

             append( sb, "", 0 );

         }

         if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )

         {

             append( sb, "invoker:help", 0 );

             append( sb, "Display help information on maven-invoker-plugin.\nCall\n\u00a0\u00a0mvn\u00a0invoker:help\u00a0-Ddetail=true\u00a0-Dgoal=<goal-name>\nto display parameter details.", 1 );

             append( sb, "", 0 );

             if ( detail )

             {

                 append( sb, "Available parameters:", 1 );

                 append( sb, "", 0 );

                 append( sb, "detail (Default: false)", 2 );

                 append( sb, "If true, display all settable properties for each goal.", 3 );

                 append( sb, "", 0 );

                 append( sb, "goal", 2 );

                 append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );

                 append( sb, "", 0 );

                 append( sb, "lineLength (Default: 80)", 2 );

                 append( sb, "The maximum length of a display line, should be positive.", 3 );

                 append( sb, "", 0 );

                 append( sb, "indentSize (Default: 2)", 2 );

                 append( sb, "The number of spaces per indentation level, should be positive.", 3 );

                 append( sb, "", 0 );

             }

         }

         if ( goal == null || goal.length() <= 0 || "install".equals( goal ) )

         {

             append( sb, "invoker:install", 0 );

             append( sb, "Installs the project artifacts of the main build into the local repository as a preparation to run the sub projects. More precisely, all artifacts of the project itself, all its locally reachable parent POMs and all its dependencies from the reactor will be installed to the local repository.", 1 );

             append( sb, "", 0 );

             if ( detail )

             {

                 append( sb, "Available parameters:", 1 );

                 append( sb, "", 0 );

                 append( sb, "localRepositoryPath", 2 );

                 append( sb, "The path to the local repository into which the project artifacts should be installed for the integration tests. If not set, the regular local repository will be used. To prevent soiling of your regular local repository with possibly broken artifacts, it is strongly recommended to use an isolated repository for the integration tests (e.g. ${project.build.directory}/it-repo).", 3 );

                 append( sb, "", 0 );

             }

         }

         if ( goal == null || goal.length() <= 0 || "run".equals( goal ) )

         {

             append( sb, "invoker:run", 0 );

             append( sb, "Searches for integration test Maven projects, and executes each, collecting a log in the project directory, and outputting the results to the command line.", 1 );

             append( sb, "", 0 );

             if ( detail )

             {

                 append( sb, "Available parameters:", 1 );

                 append( sb, "", 0 );

                 append( sb, "addTestClassPath (Default: false)", 2 );

                 append( sb, "A flag whether the test class path of the project under test should be included in the class path of the pre-/post-build scripts. If set to false, the class path of script interpreter consists only of the runtime dependencies of the Maven Invoker Plugin. If set the true, the project\'s test class path will be prepended to the interpreter class path. Among others, this feature allows the scripts to access utility classes from the test sources of your project.", 3 );

                 append( sb, "", 0 );

                 append( sb, "cloneAllFiles (Default: false)", 2 );

                 append( sb, "Some files are normally excluded when copying the IT projects from the directory specified by the parameter projectsDirectory to the directory given by cloneProjectsTo (e.g. .svn, CVS, *~, etc). Setting this parameter to true will cause all files to be copied to the cloneProjectsTo directory.", 3 );

                 append( sb, "", 0 );

                 append( sb, "cloneProjectsTo", 2 );

                 append( sb, "Directory to which projects should be cloned prior to execution. If not specified, each integration test will be run in the directory in which the corresponding IT POM was found. In this case, you most likely want to configure your SCM to ignore target and build.log in the test\'s base directory.", 3 );

                 append( sb, "", 0 );

                 append( sb, "debug (Default: false)", 2 );

                 append( sb, "Whether to show debug statements in the build output.", 3 );

                 append( sb, "", 0 );

                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );

                 append( sb, "The file encoding for the pre-/post-build scripts and the list files for goals and profiles.", 3 );

                 append( sb, "", 0 );

                 append( sb, "filterProperties", 2 );

                 append( sb, "A list of additional properties which will be used to filter tokens in POMs and goal files.", 3 );

                 append( sb, "", 0 );

                 append( sb, "goals", 2 );

                 append( sb, "The list of goals to execute on each project. Default value is: package.", 3 );

                 append( sb, "", 0 );

                 append( sb, "goalsFile (Default: goals.txt)", 2 );

                 append( sb, "Deprecated. As of version 1.2, the key invoker.goals from the properties file specified by the parameter invokerPropertiesFile should be used instead.", 3 );

                 append( sb, "", 0 );

                 append( sb, "The name of the project-specific file that contains the enumeration of goals to execute for that test.", 3 );

                 append( sb, "", 0 );

                 append( sb, "ignoreFailures (Default: false)", 2 );

                 append( sb, "A flag controlling whether failures of the sub builds should fail the main build, too. If set to true, the main build will proceed even if one or more sub builds failed.", 3 );

                 append( sb, "", 0 );

                 append( sb, "interpolationsProperties", 2 );

                 append( sb, "Deprecated. As of version 1.3, the parameter filterProperties should be used instead.", 3 );

                 append( sb, "", 0 );

                 append( sb, "List of properties which will be used to interpolate goal files.", 3 );

                 append( sb, "", 0 );

                 append( sb, "invokerPropertiesFile (Default: invoker.properties)", 2 );

                 append( sb, "The name of an optional test-specific file that contains properties used to configure the invocation of an integration test. This properties file may be used to specify settings for an individual test invocation. Any property present in the file will override the corresponding setting from the plugin configuration. The values of the properties are filtered and may use expressions like ${project.version} to reference project properties or values from the parameter filterProperties. The snippet below describes the supported properties:\n#\u00a0A\u00a0comma\u00a0or\u00a0space\u00a0separated\u00a0list\u00a0of\u00a0goals/phases\u00a0to\u00a0execute,\u00a0may\n#\u00a0specify\u00a0an\u00a0empty\u00a0list\u00a0to\u00a0execute\u00a0the\u00a0default\u00a0goal\u00a0of\u00a0the\u00a0IT\u00a0project\ninvoker.goals=clean\u00a0install\n\n#\u00a0Optionally,\u00a0a\u00a0list\u00a0of\u00a0goals\u00a0to\u00a0run\u00a0during\u00a0further\u00a0invocations\u00a0of\u00a0Maven\ninvoker.goals.2=${project.groupId}:${project.artifactId}:${project.version}:run\n\n#\u00a0A\u00a0comma\u00a0or\u00a0space\u00a0separated\u00a0list\u00a0of\u00a0profiles\u00a0to\u00a0activate\ninvoker.profiles=its,jdk15\n\n#\u00a0The\u00a0value\u00a0for\u00a0the\u00a0environment\u00a0variable\u00a0MAVEN_OPTS\ninvoker.mavenOpts=-Dfile.encoding=UTF-16\u00a0-Xms32m\u00a0-Xmx256m\n\n#\u00a0Possible\u00a0values\u00a0are\u00a0\'fail-fast\'\u00a0(default),\u00a0\'fail-at-end\'\u00a0and\u00a0\'fail-never\'\ninvoker.failureBehavior=fail-never\n\n#\u00a0The\u00a0expected\u00a0result\u00a0of\u00a0the\u00a0build,\u00a0possible\u00a0values\u00a0are\u00a0\'success\'\u00a0(default)\u00a0and\u00a0\'failure\'\ninvoker.buildResult=failure\n\n#\u00a0A\u00a0boolean\u00a0value\u00a0controlling\u00a0the\u00a0-N\u00a0flag,\u00a0defaults\u00a0to\u00a0\'false\'\ninvoker.nonRecursive=false\n", 3 );

                 append( sb, "", 0 );

                 append( sb, "invokerTest", 2 );

                 append( sb, "A comma separated list of project names to run. Specify this parameter to run individual tests by file name, overriding the setupIncludes, pomIncludes and pomExcludes parameters. Each pattern you specify here will be used to create an include pattern formatted like ${projectsDirectory}/pattern, so you can just type -Dinvoker.test=FirstTest,SecondTest to run builds in ${projectsDirectory}/FirstTest and ${projectsDirectory}/SecondTest.", 3 );

                 append( sb, "", 0 );

                 append( sb, "javaHome", 2 );

                 append( sb, "The JAVA_HOME environment variable to use for forked Maven invocations. Defaults to the current Java home directory.", 3 );

                 append( sb, "", 0 );

                 append( sb, "localRepositoryPath (Default: ${settings.localRepository})", 2 );

                 append( sb, "The local repository for caching artifacts. It is strongly recommended to specify a path to an isolated repository like ${project.build.directory}/it-repo. Otherwise, your ordinary local repository will be used, potentially soiling it with broken artifacts.", 3 );

                 append( sb, "", 0 );

                 append( sb, "mavenHome", 2 );

                 append( sb, "The home directory of the Maven installation to use for the forked builds. Defaults to the current Maven installation.", 3 );

                 append( sb, "", 0 );

                 append( sb, "mavenOpts", 2 );

                 append( sb, "The MAVEN_OPTS environment variable to use when invoking Maven. This value can be overridden for individual integration tests by using invokerPropertiesFile.", 3 );

                 append( sb, "", 0 );

                 append( sb, "noLog (Default: false)", 2 );

                 append( sb, "Suppress logging to the build.log file.", 3 );

                 append( sb, "", 0 );

                 append( sb, "pom", 2 );

                 append( sb, "A single POM to build, skipping any scanning parameters and behavior.", 3 );

                 append( sb, "", 0 );

                 append( sb, "pomExcludes", 2 );

                 append( sb, "Exclude patterns for searching the integration test directory. This parameter is meant to be set from the POM. By default, no POM files are excluded. For the convenience of using an include pattern like *, the custom settings file specified by the parameter settingsFile will always be excluded automatically.", 3 );

                 append( sb, "", 0 );

                 append( sb, "pomIncludes", 2 );

                 append( sb, "Include patterns for searching the integration test directory for projects. This parameter is meant to be set from the POM. If this parameter is not set, the plugin will search for all pom.xml files one directory below projectsDirectory (i.e. */pom.xml).\n\nStarting with version 1.3, mere directories can also be matched by these patterns. For example, the include pattern * will run Maven builds on all immediate sub directories of projectsDirectory, regardless if they contain a pom.xml. This allows to perform builds that need/should not depend on the existence of a POM.", 3 );

                 append( sb, "", 0 );

                 append( sb, "postBuildHookScript (Default: postbuild)", 2 );

                 append( sb, "Relative path of a cleanup/verification hook script to run after executing the build. This script may be written with either BeanShell or Groovy (since 1.3). If the file extension is omitted (e.g. verify), the plugin searches for the file by trying out the well-known extensions .bsh and .groovy. If this script exists for a particular project but returns any value different from true or throws an exception, the corresponding build is flagged as a failure.", 3 );

                 append( sb, "", 0 );

                 append( sb, "preBuildHookScript (Default: prebuild)", 2 );

                 append( sb, "Relative path of a pre-build hook script to run prior to executing the build. This script may be written with either BeanShell or Groovy (since 1.3). If the file extension is omitted (e.g. prebuild), the plugin searches for the file by trying out the well-known extensions .bsh and .groovy. If this script exists for a particular project but returns any value different from true or throws an exception, the corresponding build is flagged as a failure. In this case, neither Maven nor the post-build hook script will be invoked.", 3 );

                 append( sb, "", 0 );

                 append( sb, "profiles", 2 );

                 append( sb, "List of profile identifiers to explicitly trigger in the build.", 3 );

                 append( sb, "", 0 );

                 append( sb, "profilesFile (Default: profiles.txt)", 2 );

                 append( sb, "Deprecated. As of version 1.2, the key invoker.profiles from the properties file specified by the parameter invokerPropertiesFile should be used instead.", 3 );

                 append( sb, "", 0 );

                 append( sb, "The name of the project-specific file that contains the enumeration of profiles to use for that test. If the file exists and is empty no profiles will be used even if the parameter profiles is set.", 3 );

                 append( sb, "", 0 );

                 append( sb, "projectsDirectory (Default: ${basedir}/src/it/)", 2 );

                 append( sb, "Directory to search for integration tests.", 3 );

                 append( sb, "", 0 );

                 append( sb, "properties", 2 );

                 append( sb, "Common set of properties to pass in on each project\'s command line, via -D parameters.", 3 );

                 append( sb, "", 0 );

                 append( sb, "settingsFile", 2 );

                 append( sb, "Path to an alternate settings.xml to use for Maven invocation with all ITs. Note that the <localRepository> element of this settings file is always ignored, i.e. the path given by the parameter localRepositoryPath is dominant.", 3 );

                 append( sb, "", 0 );

                 append( sb, "setupIncludes", 2 );

                 append( sb, "Include patterns for searching the projects directory for projects that need to be run before the other projects. This parameter allows to declare projects that perform setup tasks like installing utility artifacts into the local repository. Projects matched by these patterns are implicitly excluded from the scan for ordinary projects. Also, the exclusions defined by the parameter pomExcludes apply to the setup projects, too. Default value is: setup*/pom.xml.", 3 );

                 append( sb, "", 0 );

                 append( sb, "showErrors (Default: false)", 2 );

                 append( sb, "Whether to show errors in the build output.", 3 );

                 append( sb, "", 0 );

                 append( sb, "skipInvocation (Default: false)", 2 );

                 append( sb, "Flag used to suppress certain invocations. This is useful in tailoring the build using profiles.", 3 );

                 append( sb, "", 0 );

                 append( sb, "streamLogs (Default: false)", 2 );

                 append( sb, "Flag used to determine whether the build logs should be output to the normal mojo log.", 3 );

                 append( sb, "", 0 );

                 append( sb, "suppressSummaries (Default: false)", 2 );

                 append( sb, "Flag used to suppress the summary output notifying of successes and failures. If set to true, the only indication of the build\'s success or failure will be the effect it has on the main build (if it fails, the main build should fail as well). If streamLogs is enabled, the sub-build summary will also provide an indication.", 3 );

                 append( sb, "", 0 );

                 append( sb, "testProperties", 2 );

                 append( sb, "Deprecated. As of version 1.1, use the properties parameter instead.", 3 );

                 append( sb, "", 0 );

                 append( sb, "Common set of test properties to pass in on each IT\'s command line, via -D parameters.", 3 );

                 append( sb, "", 0 );

                 append( sb, "testPropertiesFile (Default: test.properties)", 2 );

                 append( sb, "Location of a properties file that defines CLI properties for the test.", 3 );

                 append( sb, "", 0 );

             }

         }

         if ( getLog().isInfoEnabled() )

         {

             getLog().info( sb.toString() );

         }

     }

     /**

      * <p>Repeat a String <code>n</code> times to form a new string.</p>

      *

      * @param str String to repeat

      * @param repeat number of times to repeat str

      * @return String with repeated String

      * @throws NegativeArraySizeException if <code>repeat < 0</code>

      * @throws NullPointerException if str is <code>null</code>

      */

     private static String repeat( String str, int repeat )

     {

         StringBuffer buffer = new StringBuffer( repeat * str.length() );

         for ( int i = 0; i < repeat; i++ )

         {

             buffer.append( str );

         }

         return buffer.toString();

     }

     /** 

      * Append a description to the buffer by respecting the indentSize and lineLength parameters.

      * <b>Note</b>: The last character is always a new line.

      * 

      * @param sb The buffer to append the description, not <code>null</code>.

      * @param description The description, not <code>null</code>.

      * @param indent The base indentation level of each line, must not be negative.

      */

     private void append( StringBuffer sb, String description, int indent )

     {

         for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )

         {

             sb.append( it.next().toString() ).append( '\n' );

         }

     }

     /** 

      * Splits the specified text into lines of convenient display length.

      * 

      * @param text The text to split into lines, must not be <code>null</code>.

      * @param indent The base indentation level of each line, must not be negative.

      * @param indentSize The size of each indentation, must not be negative.

      * @param lineLength The length of the line, must not be negative.

      * @return The sequence of display lines, never <code>null</code>.

      * @throws NegativeArraySizeException if <code>indent < 0</code>

      */

     private static List toLines( String text, int indent, int indentSize, int lineLength )

     {

         List lines = new ArrayList();

         String ind = repeat( "\t", indent );

         String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );

         for ( int i = 0; i < plainLines.length; i++ )

         {

             toLines( lines, ind + plainLines[i], indentSize, lineLength );

         }

         return lines;

     }

     /** 

      * Adds the specified line to the output sequence, performing line wrapping if necessary.

      * 

      * @param lines The sequence of display lines, must not be <code>null</code>.

      * @param line The line to add, must not be <code>null</code>.

      * @param indentSize The size of each indentation, must not be negative.

      * @param lineLength The length of the line, must not be negative.

      */

     private static void toLines( List lines, String line, int indentSize, int lineLength )

     {

         int lineIndent = getIndentLevel( line );

         StringBuffer buf = new StringBuffer( 256 );

         String[] tokens = line.split( " +" );

         for ( int i = 0; i < tokens.length; i++ )

         {

             String token = tokens[i];

             if ( i > 0 )

             {

                 if ( buf.length() + token.length() >= lineLength )

                 {

                     lines.add( buf.toString() );

                     buf.setLength( 0 );

                     buf.append( repeat( " ", lineIndent * indentSize ) );

                 }

                 else

                 {

                     buf.append( ' ' );

                 }

             }

             for ( int j = 0; j < token.length(); j++ )

             {

                 char c = token.charAt( j );

                 if ( c == '\t' )

                 {

                     buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );

                 }

                 else if ( c == '\u00A0' )

                 {

                     buf.append( ' ' );

                 }

                 else

                 {

                     buf.append( c );

                 }

             }

         }

         lines.add( buf.toString() );

     }

     /** 

      * Gets the indentation level of the specified line.

      * 

      * @param line The line whose indentation level should be retrieved, must not be <code>null</code>.

      * @return The indentation level of the line.

      */

     private static int getIndentLevel( String line )

     {

         int level = 0;

         for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )

         {

             level++;

         }

         for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )

         {

             if ( line.charAt( i ) == '\t' )

             {

                 level++;

                 break;

             }

         }

         return level;

     }

 }