Coverage Report

Coverage Report - org.apache.maven.plugins.surefire.report.HelpMojo

Classes in this File

Line Coverage

Branch Coverage

Complexity

HelpMojo

0/236

0/70

6.833

 package org.apache.maven.plugins.surefire.report;
 
 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-surefire-report-plugin.<br/> Call <pre>  mvn surefire-report:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</pre> to display parameter details.
  *
  * @version generated on Tue Jan 24 23:21:56 CET 2012
  * @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.8)
  * @goal help
  * @requiresProject false
  * @threadSafe
  */
 @SuppressWarnings( "all" )
 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-surefire-report-plugin:2.12", 0 );
         append( sb, "", 0 );
 
         append( sb, "Maven Surefire Report Plugin", 0 );
         append( sb, "Surefire is a test framework project.", 1 );
         append( sb, "", 0 );
 
         if ( goal == null || goal.length() <= 0 )
         {
             append( sb, "This plugin has 4 goals:", 0 );
             append( sb, "", 0 );
         }
 
         if ( goal == null || goal.length() <= 0 || "failsafe-report-only".equals( goal ) )
         {
             append( sb, "surefire-report:failsafe-report-only", 0 );
             append( sb, "Creates a nicely formatted Failsafe Test Report in html format. This goal does not run the tests, it only builds the reports. See http://jira.codehaus.org/browse/SUREFIRE-257", 1 );
             append( sb, "", 0 );
             if ( detail )
             {
                 append( sb, "Available parameters:", 1 );
                 append( sb, "", 0 );
 
                 append( sb, "aggregate (Default: false)", 2 );
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
                 append( sb, "Expression: ${aggregate}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "alwaysGenerateFailsafeReport (Default: false)", 2 );
                 append( sb, "If set to true the failsafe report will be generated even when there are no failsafe result files. Defaults to false to preserve legacy behaviour pre 2.10", 3 );
                 append( sb, "Expression: ${alwaysGenerateFailsafeReport}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "linkXRef (Default: true)", 2 );
                 append( sb, "Whether to link the XRef if found.", 3 );
                 append( sb, "Expression: ${linkXRef}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "outputDirectory", 2 );
                 append( sb, "Location where generated html will be created.", 3 );
                 append( sb, "Expression: ${project.reporting.outputDirectory}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "outputName (Default: failsafe-report)", 2 );
                 append( sb, "The filename to use for the report.", 3 );
                 append( sb, "Required: Yes", 3 );
                 append( sb, "Expression: ${outputName}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "project", 2 );
                 append( sb, "Maven Project", 3 );
                 append( sb, "Required: Yes", 3 );
                 append( sb, "Expression: ${project}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "reportsDirectories", 2 );
                 append( sb, "Directories containing the XML Report files that will be parsed and rendered to HTML format.", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "reportsDirectory", 2 );
                 append( sb, "(Deprecated, use reportsDirectories) This directory contains the XML Report files that will be parsed and rendered to HTML format.", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "showSuccess (Default: true)", 2 );
                 append( sb, "If set to false, only failures are shown.", 3 );
                 append( sb, "Required: Yes", 3 );
                 append( sb, "Expression: ${showSuccess}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "skipFailsafeReport (Default: false)", 2 );
                 append( sb, "If set to true the failsafe report generation will be skipped.", 3 );
                 append( sb, "Expression: ${skipFailsafeReport}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "xrefLocation (Default: ${project.reporting.outputDirectory}/xref-test)", 2 );
                 append( sb, "Location of the Xrefs to link.", 3 );
                 append( sb, "", 0 );
             }
         }
 
         if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )
         {
             append( sb, "surefire-report:help", 0 );
             append( sb, "Display help information on maven-surefire-report-plugin.\nCall\n\u00a0\u00a0mvn\u00a0surefire-report: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, "Expression: ${detail}", 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, "Expression: ${goal}", 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, "Expression: ${indentSize}", 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, "Expression: ${lineLength}", 3 );
                 append( sb, "", 0 );
             }
         }
 
         if ( goal == null || goal.length() <= 0 || "report".equals( goal ) )
         {
             append( sb, "surefire-report:report", 0 );
             append( sb, "Creates a nicely formatted Surefire Test Report in html format.", 1 );
             append( sb, "", 0 );
             if ( detail )
             {
                 append( sb, "Available parameters:", 1 );
                 append( sb, "", 0 );
 
                 append( sb, "aggregate (Default: false)", 2 );
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
                 append( sb, "Expression: ${aggregate}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "alwaysGenerateSurefireReport (Default: true)", 2 );
                 append( sb, "If set to true the surefire report will be generated even when there are no surefire result files. Defaulyts to true to preserve legacy behaviour pre 2.10.", 3 );
                 append( sb, "Expression: ${alwaysGenerateSurefireReport}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "linkXRef (Default: true)", 2 );
                 append( sb, "Whether to link the XRef if found.", 3 );
                 append( sb, "Expression: ${linkXRef}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "outputDirectory", 2 );
                 append( sb, "Location where generated html will be created.", 3 );
                 append( sb, "Expression: ${project.reporting.outputDirectory}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "outputName (Default: surefire-report)", 2 );
                 append( sb, "The filename to use for the report.", 3 );
                 append( sb, "Required: Yes", 3 );
                 append( sb, "Expression: ${outputName}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "project", 2 );
                 append( sb, "Maven Project", 3 );
                 append( sb, "Required: Yes", 3 );
                 append( sb, "Expression: ${project}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "reportsDirectories", 2 );
                 append( sb, "Directories containing the XML Report files that will be parsed and rendered to HTML format.", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "reportsDirectory", 2 );
                 append( sb, "(Deprecated, use reportsDirectories) This directory contains the XML Report files that will be parsed and rendered to HTML format.", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "showSuccess (Default: true)", 2 );
                 append( sb, "If set to false, only failures are shown.", 3 );
                 append( sb, "Required: Yes", 3 );
                 append( sb, "Expression: ${showSuccess}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "skipSurefireReport (Default: false)", 2 );
                 append( sb, "If set to true the surefire report generation will be skipped.", 3 );
                 append( sb, "Expression: ${skipSurefireReport}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "xrefLocation (Default: ${project.reporting.outputDirectory}/xref-test)", 2 );
                 append( sb, "Location of the Xrefs to link.", 3 );
                 append( sb, "", 0 );
             }
         }
 
         if ( goal == null || goal.length() <= 0 || "report-only".equals( goal ) )
         {
             append( sb, "surefire-report:report-only", 0 );
             append( sb, "Creates a nicely formatted Surefire Test Report in html format. This goal does not run the tests, it only builds the reports. This is a workaround for http://jira.codehaus.org/browse/SUREFIRE-257", 1 );
             append( sb, "", 0 );
             if ( detail )
             {
                 append( sb, "Available parameters:", 1 );
                 append( sb, "", 0 );
 
                 append( sb, "aggregate (Default: false)", 2 );
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
                 append( sb, "Expression: ${aggregate}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "alwaysGenerateSurefireReport (Default: true)", 2 );
                 append( sb, "If set to true the surefire report will be generated even when there are no surefire result files. Defaulyts to true to preserve legacy behaviour pre 2.10.", 3 );
                 append( sb, "Expression: ${alwaysGenerateSurefireReport}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "linkXRef (Default: true)", 2 );
                 append( sb, "Whether to link the XRef if found.", 3 );
                 append( sb, "Expression: ${linkXRef}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "outputDirectory", 2 );
                 append( sb, "Location where generated html will be created.", 3 );
                 append( sb, "Expression: ${project.reporting.outputDirectory}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "outputName (Default: surefire-report)", 2 );
                 append( sb, "The filename to use for the report.", 3 );
                 append( sb, "Required: Yes", 3 );
                 append( sb, "Expression: ${outputName}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "project", 2 );
                 append( sb, "Maven Project", 3 );
                 append( sb, "Required: Yes", 3 );
                 append( sb, "Expression: ${project}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "reportsDirectories", 2 );
                 append( sb, "Directories containing the XML Report files that will be parsed and rendered to HTML format.", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "reportsDirectory", 2 );
                 append( sb, "(Deprecated, use reportsDirectories) This directory contains the XML Report files that will be parsed and rendered to HTML format.", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "showSuccess (Default: true)", 2 );
                 append( sb, "If set to false, only failures are shown.", 3 );
                 append( sb, "Required: Yes", 3 );
                 append( sb, "Expression: ${showSuccess}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "skipSurefireReport (Default: false)", 2 );
                 append( sb, "If set to true the surefire report generation will be skipped.", 3 );
                 append( sb, "Expression: ${skipSurefireReport}", 3 );
                 append( sb, "", 0 );
 
                 append( sb, "xrefLocation (Default: ${project.reporting.outputDirectory}/xref-test)", 2 );
                 append( sb, "Location of the Xrefs to link.", 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<String> lines = new ArrayList<String>();
 
         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<String> 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;
     }
 }

1		package org.apache.maven.plugins.surefire.report;
2
3		import java.util.ArrayList;
4		import java.util.Iterator;
5		import java.util.List;
6
7		import org.apache.maven.plugin.AbstractMojo;
8		import org.apache.maven.plugin.MojoExecutionException;
9
10		/**
11		* Display help information on maven-surefire-report-plugin.<br/> Call <pre> mvn surefire-report:help -Ddetail=true -Dgoal=<goal-name></pre> to display parameter details.
12		*
13		* @version generated on Tue Jan 24 23:21:56 CET 2012
14		* @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.8)
15		* @goal help
16		* @requiresProject false
17		* @threadSafe
18		*/
19		@SuppressWarnings( "all" )
20	0	public class HelpMojo
21		extends AbstractMojo
22		{
23		/**
24		* If <code>true</code>, display all settable properties for each goal.
25		*
26		* @parameter expression="${detail}" default-value="false"
27		*/
28		private boolean detail;
29
30		/**
31		* The name of the goal for which to show help. If unspecified, all goals will be displayed.
32		*
33		* @parameter expression="${goal}"
34		*/
35		private java.lang.String goal;
36
37		/**
38		* The maximum length of a display line, should be positive.
39		*
40		* @parameter expression="${lineLength}" default-value="80"
41		*/
42		private int lineLength;
43
44		/**
45		* The number of spaces per indentation level, should be positive.
46		*
47		* @parameter expression="${indentSize}" default-value="2"
48		*/
49		private int indentSize;
50
51
52		/** {@inheritDoc} */
53		public void execute()
54		throws MojoExecutionException
55		{
56	0	if ( lineLength <= 0 )
57		{
58	0	getLog().warn( "The parameter 'lineLength' should be positive, using '80' as default." );
59	0	lineLength = 80;
60		}
61	0	if ( indentSize <= 0 )
62		{
63	0	getLog().warn( "The parameter 'indentSize' should be positive, using '2' as default." );
64	0	indentSize = 2;
65		}
66
67	0	StringBuffer sb = new StringBuffer();
68
69	0	append( sb, "org.apache.maven.plugins:maven-surefire-report-plugin:2.12", 0 );
70	0	append( sb, "", 0 );
71
72	0	append( sb, "Maven Surefire Report Plugin", 0 );
73	0	append( sb, "Surefire is a test framework project.", 1 );
74	0	append( sb, "", 0 );
75
76	0	if ( goal == null \|\| goal.length() <= 0 )
77		{
78	0	append( sb, "This plugin has 4 goals:", 0 );
79	0	append( sb, "", 0 );
80		}
81
82	0	if ( goal == null \|\| goal.length() <= 0 \|\| "failsafe-report-only".equals( goal ) )
83		{
84	0	append( sb, "surefire-report:failsafe-report-only", 0 );
85	0	append( sb, "Creates a nicely formatted Failsafe Test Report in html format. This goal does not run the tests, it only builds the reports. See http://jira.codehaus.org/browse/SUREFIRE-257", 1 );
86	0	append( sb, "", 0 );
87	0	if ( detail )
88		{
89	0	append( sb, "Available parameters:", 1 );
90	0	append( sb, "", 0 );
91
92	0	append( sb, "aggregate (Default: false)", 2 );
93	0	append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
94	0	append( sb, "Expression: ${aggregate}", 3 );
95	0	append( sb, "", 0 );
96
97	0	append( sb, "alwaysGenerateFailsafeReport (Default: false)", 2 );
98	0	append( sb, "If set to true the failsafe report will be generated even when there are no failsafe result files. Defaults to false to preserve legacy behaviour pre 2.10", 3 );
99	0	append( sb, "Expression: ${alwaysGenerateFailsafeReport}", 3 );
100	0	append( sb, "", 0 );
101
102	0	append( sb, "linkXRef (Default: true)", 2 );
103	0	append( sb, "Whether to link the XRef if found.", 3 );
104	0	append( sb, "Expression: ${linkXRef}", 3 );
105	0	append( sb, "", 0 );
106
107	0	append( sb, "outputDirectory", 2 );
108	0	append( sb, "Location where generated html will be created.", 3 );
109	0	append( sb, "Expression: ${project.reporting.outputDirectory}", 3 );
110	0	append( sb, "", 0 );
111
112	0	append( sb, "outputName (Default: failsafe-report)", 2 );
113	0	append( sb, "The filename to use for the report.", 3 );
114	0	append( sb, "Required: Yes", 3 );
115	0	append( sb, "Expression: ${outputName}", 3 );
116	0	append( sb, "", 0 );
117
118	0	append( sb, "project", 2 );
119	0	append( sb, "Maven Project", 3 );
120	0	append( sb, "Required: Yes", 3 );
121	0	append( sb, "Expression: ${project}", 3 );
122	0	append( sb, "", 0 );
123
124	0	append( sb, "reportsDirectories", 2 );
125	0	append( sb, "Directories containing the XML Report files that will be parsed and rendered to HTML format.", 3 );
126	0	append( sb, "", 0 );
127
128	0	append( sb, "reportsDirectory", 2 );
129	0	append( sb, "(Deprecated, use reportsDirectories) This directory contains the XML Report files that will be parsed and rendered to HTML format.", 3 );
130	0	append( sb, "", 0 );
131
132	0	append( sb, "showSuccess (Default: true)", 2 );
133	0	append( sb, "If set to false, only failures are shown.", 3 );
134	0	append( sb, "Required: Yes", 3 );
135	0	append( sb, "Expression: ${showSuccess}", 3 );
136	0	append( sb, "", 0 );
137
138	0	append( sb, "skipFailsafeReport (Default: false)", 2 );
139	0	append( sb, "If set to true the failsafe report generation will be skipped.", 3 );
140	0	append( sb, "Expression: ${skipFailsafeReport}", 3 );
141	0	append( sb, "", 0 );
142
143	0	append( sb, "xrefLocation (Default: ${project.reporting.outputDirectory}/xref-test)", 2 );
144	0	append( sb, "Location of the Xrefs to link.", 3 );
145	0	append( sb, "", 0 );
146		}
147		}
148
149	0	if ( goal == null \|\| goal.length() <= 0 \|\| "help".equals( goal ) )
150		{
151	0	append( sb, "surefire-report:help", 0 );
152	0	append( sb, "Display help information on maven-surefire-report-plugin.\nCall\n\u00a0\u00a0mvn\u00a0surefire-report:help\u00a0-Ddetail=true\u00a0-Dgoal=<goal-name>\nto display parameter details.", 1 );
153	0	append( sb, "", 0 );
154	0	if ( detail )
155		{
156	0	append( sb, "Available parameters:", 1 );
157	0	append( sb, "", 0 );
158
159	0	append( sb, "detail (Default: false)", 2 );
160	0	append( sb, "If true, display all settable properties for each goal.", 3 );
161	0	append( sb, "Expression: ${detail}", 3 );
162	0	append( sb, "", 0 );
163
164	0	append( sb, "goal", 2 );
165	0	append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );
166	0	append( sb, "Expression: ${goal}", 3 );
167	0	append( sb, "", 0 );
168
169	0	append( sb, "indentSize (Default: 2)", 2 );
170	0	append( sb, "The number of spaces per indentation level, should be positive.", 3 );
171	0	append( sb, "Expression: ${indentSize}", 3 );
172	0	append( sb, "", 0 );
173
174	0	append( sb, "lineLength (Default: 80)", 2 );
175	0	append( sb, "The maximum length of a display line, should be positive.", 3 );
176	0	append( sb, "Expression: ${lineLength}", 3 );
177	0	append( sb, "", 0 );
178		}
179		}
180
181	0	if ( goal == null \|\| goal.length() <= 0 \|\| "report".equals( goal ) )
182		{
183	0	append( sb, "surefire-report:report", 0 );
184	0	append( sb, "Creates a nicely formatted Surefire Test Report in html format.", 1 );
185	0	append( sb, "", 0 );
186	0	if ( detail )
187		{
188	0	append( sb, "Available parameters:", 1 );
189	0	append( sb, "", 0 );
190
191	0	append( sb, "aggregate (Default: false)", 2 );
192	0	append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
193	0	append( sb, "Expression: ${aggregate}", 3 );
194	0	append( sb, "", 0 );
195
196	0	append( sb, "alwaysGenerateSurefireReport (Default: true)", 2 );
197	0	append( sb, "If set to true the surefire report will be generated even when there are no surefire result files. Defaulyts to true to preserve legacy behaviour pre 2.10.", 3 );
198	0	append( sb, "Expression: ${alwaysGenerateSurefireReport}", 3 );
199	0	append( sb, "", 0 );
200
201	0	append( sb, "linkXRef (Default: true)", 2 );
202	0	append( sb, "Whether to link the XRef if found.", 3 );
203	0	append( sb, "Expression: ${linkXRef}", 3 );
204	0	append( sb, "", 0 );
205
206	0	append( sb, "outputDirectory", 2 );
207	0	append( sb, "Location where generated html will be created.", 3 );
208	0	append( sb, "Expression: ${project.reporting.outputDirectory}", 3 );
209	0	append( sb, "", 0 );
210
211	0	append( sb, "outputName (Default: surefire-report)", 2 );
212	0	append( sb, "The filename to use for the report.", 3 );
213	0	append( sb, "Required: Yes", 3 );
214	0	append( sb, "Expression: ${outputName}", 3 );
215	0	append( sb, "", 0 );
216
217	0	append( sb, "project", 2 );
218	0	append( sb, "Maven Project", 3 );
219	0	append( sb, "Required: Yes", 3 );
220	0	append( sb, "Expression: ${project}", 3 );
221	0	append( sb, "", 0 );
222
223	0	append( sb, "reportsDirectories", 2 );
224	0	append( sb, "Directories containing the XML Report files that will be parsed and rendered to HTML format.", 3 );
225	0	append( sb, "", 0 );
226
227	0	append( sb, "reportsDirectory", 2 );
228	0	append( sb, "(Deprecated, use reportsDirectories) This directory contains the XML Report files that will be parsed and rendered to HTML format.", 3 );
229	0	append( sb, "", 0 );
230
231	0	append( sb, "showSuccess (Default: true)", 2 );
232	0	append( sb, "If set to false, only failures are shown.", 3 );
233	0	append( sb, "Required: Yes", 3 );
234	0	append( sb, "Expression: ${showSuccess}", 3 );
235	0	append( sb, "", 0 );
236
237	0	append( sb, "skipSurefireReport (Default: false)", 2 );
238	0	append( sb, "If set to true the surefire report generation will be skipped.", 3 );
239	0	append( sb, "Expression: ${skipSurefireReport}", 3 );
240	0	append( sb, "", 0 );
241
242	0	append( sb, "xrefLocation (Default: ${project.reporting.outputDirectory}/xref-test)", 2 );
243	0	append( sb, "Location of the Xrefs to link.", 3 );
244	0	append( sb, "", 0 );
245		}
246		}
247
248	0	if ( goal == null \|\| goal.length() <= 0 \|\| "report-only".equals( goal ) )
249		{
250	0	append( sb, "surefire-report:report-only", 0 );
251	0	append( sb, "Creates a nicely formatted Surefire Test Report in html format. This goal does not run the tests, it only builds the reports. This is a workaround for http://jira.codehaus.org/browse/SUREFIRE-257", 1 );
252	0	append( sb, "", 0 );
253	0	if ( detail )
254		{
255	0	append( sb, "Available parameters:", 1 );
256	0	append( sb, "", 0 );
257
258	0	append( sb, "aggregate (Default: false)", 2 );
259	0	append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
260	0	append( sb, "Expression: ${aggregate}", 3 );
261	0	append( sb, "", 0 );
262
263	0	append( sb, "alwaysGenerateSurefireReport (Default: true)", 2 );
264	0	append( sb, "If set to true the surefire report will be generated even when there are no surefire result files. Defaulyts to true to preserve legacy behaviour pre 2.10.", 3 );
265	0	append( sb, "Expression: ${alwaysGenerateSurefireReport}", 3 );
266	0	append( sb, "", 0 );
267
268	0	append( sb, "linkXRef (Default: true)", 2 );
269	0	append( sb, "Whether to link the XRef if found.", 3 );
270	0	append( sb, "Expression: ${linkXRef}", 3 );
271	0	append( sb, "", 0 );
272
273	0	append( sb, "outputDirectory", 2 );
274	0	append( sb, "Location where generated html will be created.", 3 );
275	0	append( sb, "Expression: ${project.reporting.outputDirectory}", 3 );
276	0	append( sb, "", 0 );
277
278	0	append( sb, "outputName (Default: surefire-report)", 2 );
279	0	append( sb, "The filename to use for the report.", 3 );
280	0	append( sb, "Required: Yes", 3 );
281	0	append( sb, "Expression: ${outputName}", 3 );
282	0	append( sb, "", 0 );
283
284	0	append( sb, "project", 2 );
285	0	append( sb, "Maven Project", 3 );
286	0	append( sb, "Required: Yes", 3 );
287	0	append( sb, "Expression: ${project}", 3 );
288	0	append( sb, "", 0 );
289
290	0	append( sb, "reportsDirectories", 2 );
291	0	append( sb, "Directories containing the XML Report files that will be parsed and rendered to HTML format.", 3 );
292	0	append( sb, "", 0 );
293
294	0	append( sb, "reportsDirectory", 2 );
295	0	append( sb, "(Deprecated, use reportsDirectories) This directory contains the XML Report files that will be parsed and rendered to HTML format.", 3 );
296	0	append( sb, "", 0 );
297
298	0	append( sb, "showSuccess (Default: true)", 2 );
299	0	append( sb, "If set to false, only failures are shown.", 3 );
300	0	append( sb, "Required: Yes", 3 );
301	0	append( sb, "Expression: ${showSuccess}", 3 );
302	0	append( sb, "", 0 );
303
304	0	append( sb, "skipSurefireReport (Default: false)", 2 );
305	0	append( sb, "If set to true the surefire report generation will be skipped.", 3 );
306	0	append( sb, "Expression: ${skipSurefireReport}", 3 );
307	0	append( sb, "", 0 );
308
309	0	append( sb, "xrefLocation (Default: ${project.reporting.outputDirectory}/xref-test)", 2 );
310	0	append( sb, "Location of the Xrefs to link.", 3 );
311	0	append( sb, "", 0 );
312		}
313		}
314
315	0	if ( getLog().isInfoEnabled() )
316		{
317	0	getLog().info( sb.toString() );
318		}
319	0	}
320
321		/**
322		* <p>Repeat a String <code>n</code> times to form a new string.</p>
323		*
324		* @param str String to repeat
325		* @param repeat number of times to repeat str
326		* @return String with repeated String
327		* @throws NegativeArraySizeException if <code>repeat < 0</code>
328		* @throws NullPointerException if str is <code>null</code>
329		*/
330		private static String repeat( String str, int repeat )
331		{
332	0	StringBuffer buffer = new StringBuffer( repeat * str.length() );
333
334	0	for ( int i = 0; i < repeat; i++ )
335		{
336	0	buffer.append( str );
337		}
338
339	0	return buffer.toString();
340		}
341
342		/**
343		* Append a description to the buffer by respecting the indentSize and lineLength parameters.
344		* <b>Note</b>: The last character is always a new line.
345		*
346		* @param sb The buffer to append the description, not <code>null</code>.
347		* @param description The description, not <code>null</code>.
348		* @param indent The base indentation level of each line, must not be negative.
349		*/
350		private void append( StringBuffer sb, String description, int indent )
351		{
352	0	for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )
353		{
354	0	sb.append( it.next().toString() ).append( '\n' );
355		}
356	0	}
357
358		/**
359		* Splits the specified text into lines of convenient display length.
360		*
361		* @param text The text to split into lines, must not be <code>null</code>.
362		* @param indent The base indentation level of each line, must not be negative.
363		* @param indentSize The size of each indentation, must not be negative.
364		* @param lineLength The length of the line, must not be negative.
365		* @return The sequence of display lines, never <code>null</code>.
366		* @throws NegativeArraySizeException if <code>indent < 0</code>
367		*/
368		private static List toLines( String text, int indent, int indentSize, int lineLength )
369		{
370	0	List<String> lines = new ArrayList<String>();
371
372	0	String ind = repeat( "\t", indent );
373	0	String[] plainLines = text.split( "(\r\n)\|(\r)\|(\n)" );
374	0	for ( int i = 0; i < plainLines.length; i++ )
375		{
376	0	toLines( lines, ind + plainLines[i], indentSize, lineLength );
377		}
378
379	0	return lines;
380		}
381
382		/**
383		* Adds the specified line to the output sequence, performing line wrapping if necessary.
384		*
385		* @param lines The sequence of display lines, must not be <code>null</code>.
386		* @param line The line to add, must not be <code>null</code>.
387		* @param indentSize The size of each indentation, must not be negative.
388		* @param lineLength The length of the line, must not be negative.
389		*/
390		private static void toLines( List<String> lines, String line, int indentSize, int lineLength )
391		{
392	0	int lineIndent = getIndentLevel( line );
393	0	StringBuffer buf = new StringBuffer( 256 );
394	0	String[] tokens = line.split( " +" );
395	0	for ( int i = 0; i < tokens.length; i++ )
396		{
397	0	String token = tokens[i];
398	0	if ( i > 0 )
399		{
400	0	if ( buf.length() + token.length() >= lineLength )
401		{
402	0	lines.add( buf.toString() );
403	0	buf.setLength( 0 );
404	0	buf.append( repeat( " ", lineIndent * indentSize ) );
405		}
406		else
407		{
408	0	buf.append( ' ' );
409		}
410		}
411	0	for ( int j = 0; j < token.length(); j++ )
412		{
413	0	char c = token.charAt( j );
414	0	if ( c == '\t' )
415		{
416	0	buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
417		}
418	0	else if ( c == '\u00A0' )
419		{
420	0	buf.append( ' ' );
421		}
422		else
423		{
424	0	buf.append( c );
425		}
426		}
427		}
428	0	lines.add( buf.toString() );
429	0	}
430
431		/**
432		* Gets the indentation level of the specified line.
433		*
434		* @param line The line whose indentation level should be retrieved, must not be <code>null</code>.
435		* @return The indentation level of the line.
436		*/
437		private static int getIndentLevel( String line )
438		{
439	0	int level = 0;
440	0	for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
441		{
442	0	level++;
443		}
444	0	for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
445		{
446	0	if ( line.charAt( i ) == '\t' )
447		{
448	0	level++;
449	0	break;
450		}
451		}
452	0	return level;
453		}
454		}