Merge "J-577: Improved error message + increased the minimal heap size for Tomcat of shutdown hook leak test."

Author: pavelbucek

test-framework/maven/container-runner-maven-plugin/src/main/groovy/org/glassfish/jersey/test/maven/runner/RunnerMojo.groovy

@@ -39,7 +39,7 @@
  */
 package org.glassfish.jersey.test.maven.runner
 
-import org.apache.maven.plugin.Mojo
+import com.google.common.collect.EvictingQueue
 import org.apache.maven.plugin.MojoExecutionException
 import org.apache.maven.plugin.MojoFailureException
 import org.apache.maven.plugins.annotations.Parameter
@@ -54,7 +54,7 @@ import java.util.regex.Pattern
  *
  * @author Stepan Vavra (stepan.vavra at oracle.com)
  */
-trait RunnerMojo implements Mojo {
+trait RunnerMojo implements SuperRunnerMojo {
 
     /**
      * The Maven project to analyze.
@@ -106,7 +106,10 @@ trait RunnerMojo implements Mojo {
     @Parameter(defaultValue = "false", name = "skipStartAndStop", property = "jersey.runner.skipStartAndStop")
     boolean skipStartAndStop
 
-    @Parameter(defaultValue = "\${project.build.directory}/tmp")
+    /**
+     * The location of a directory where a content of executed shell scripts is dumped.
+     */
+    @Parameter(defaultValue = "\${project.build.directory}/tmp", name = "scriptsDirectory")
     String scriptsDirectory
 
     /**
@@ -179,9 +182,10 @@ trait RunnerMojo implements Mojo {
         outputStream.write(shellContent)
         outputStream.close()
 
-        def lastLine = ""
+        def lastLinesQueue = EvictingQueue.<String>create(lastLinesCount)
+
         process.in.eachLine {
-            lastLine = it
+            lastLinesQueue.add(it)
             if (getLog()?.isDebugEnabled() && it.startsWith("+")) {
                 getLog().debug(it)
             } else {
@@ -194,7 +198,7 @@ trait RunnerMojo implements Mojo {
         if (process.exitValue() != 0 && exceptionOnError) {
             throw new ShellMojoExecutionException("The shell script: '" + shell + "' ended with non-zero exit value!",
                     process.exitValue(),
-                    lastLine)
+                    lastLinesQueue)
         }
 
         return process.exitValue()

test-framework/maven/container-runner-maven-plugin/src/main/groovy/org/glassfish/jersey/test/maven/runner/ShellMojoExecutionException.java

@@ -39,6 +39,8 @@
  */
 package org.glassfish.jersey.test.maven.runner;
 
+import java.util.Collection;
+
 import org.apache.maven.plugin.MojoExecutionException;
 
 /**
@@ -51,35 +53,44 @@ public class ShellMojoExecutionException extends MojoExecutionException {
     /**
      * The error code the shell script exited with.
      */
-    private int errorCode;
+    private final int errorCode;
 
     /**
-     * The last line of the output of the executed shell script.
+     * The last lines of the output of the executed shell script.
      */
-    private String lastLine;
-
-    public ShellMojoExecutionException(final String message, final Throwable cause, final int errorCode, final String lastLine) {
-        super(message
-                        + "\nError exit code: " + errorCode + "."
-                        + "\nThe last line of stderr/stdout output is: " + lastLine,
-                cause);
-        this.errorCode = errorCode;
-        this.lastLine = lastLine;
-    }
+    private final Collection<String> lastLines;
 
-    public ShellMojoExecutionException(final String message, final int errorCode, final String lastLine) {
+    /**
+     * Constructs shell mojo exection exception.
+     *
+     * @param message The message that will be prepended to a default mojo exectuion exception message.
+     * @param errorCode The error code.
+     * @param lastLines The collection of last lines that will be also part of the exception message.
+     */
+    public ShellMojoExecutionException(final String message, final int errorCode, final Collection<String> lastLines) {
         super(message
                 + "\nError exit code: " + errorCode + "."
-                + "\nThe last line of stderr/stdout output is: " + lastLine);
+                + "\nThe last " + lastLines.size() + " lines of stderr/stdout output are: "
+                + "\n" + lastLinesToString(lastLines));
         this.errorCode = errorCode;
-        this.lastLine = lastLine;
+        this.lastLines = lastLines;
     }
 
     public int getErrorCode() {
         return errorCode;
     }
 
-    public String getLastLine() {
-        return lastLine;
+    public Collection<String> getLastLines() {
+        return lastLines;
+    }
+
+    private static String lastLinesToString(Collection<String> collection) {
+        StringBuilder sb = new StringBuilder();
+        int lineNumber = 1;
+        for (String string : collection) {
+            sb.append("Line ").append(lineNumber++).append(": ");
+            sb.append(string).append("\n");
+        }
+        return sb.toString();
     }
 }

test-framework/maven/container-runner-maven-plugin/src/main/groovy/org/glassfish/jersey/test/maven/runner/SuperRunnerMojo.groovy

@@ -0,0 +1,63 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
+ *
+ * The contents of this file are subject to the terms of either the GNU
+ * General Public License Version 2 only ("GPL") or the Common Development
+ * and Distribution License("CDDL") (collectively, the "License").  You
+ * may not use this file except in compliance with the License.  You can
+ * obtain a copy of the License at
+ * http://glassfish.java.net/public/CDDL+GPL_1_1.html
+ * or packager/legal/LICENSE.txt.  See the License for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing the software, include this License Header Notice in each
+ * file and include the License file at packager/legal/LICENSE.txt.
+ *
+ * GPL Classpath Exception:
+ * Oracle designates this particular file as subject to the "Classpath"
+ * exception as provided by Oracle in the GPL Version 2 section of the License
+ * file that accompanied this code.
+ *
+ * Modifications:
+ * If applicable, add the following below the License Header, with the fields
+ * enclosed by brackets [] replaced by your own identifying information:
+ * "Portions Copyright [year] [name of copyright owner]"
+ *
+ * Contributor(s):
+ * If you wish your version of this file to be governed by only the CDDL or
+ * only the GPL Version 2, indicate your decision by adding "[Contributor]
+ * elects to include this software in this distribution under the [CDDL or GPL
+ * Version 2] license."  If you don't indicate a single choice of license, a
+ * recipient has the option to distribute your version of this file under
+ * either the CDDL, the GPL Version 2 or to extend the choice of license to
+ * its licensees as provided above.  However, if you add GPL Version 2 code
+ * and therefore, elected the GPL Version 2 license, then the option applies
+ * only if the new code is made subject to such option by the copyright
+ * holder.
+ */
+
+package org.glassfish.jersey.test.maven.runner
+
+import org.apache.maven.plugin.Mojo
+import org.apache.maven.plugins.annotations.Parameter
+
+/**
+ * This trait serves as a field container only as a workaround for failing Traits with more than 10 fields (see
+ * http://stackoverflow.com/questions/27259633/using-groovy-trait-in-grails-test-fails)
+ *
+ * @author Stepan Vavra (stepan.vavra at oracle.com)
+ */
+trait SuperRunnerMojo implements Mojo {
+
+    /**
+     * The number of lines of stderr/stdout to print when an execution failure occurs.
+     */
+    @Parameter(defaultValue = "10", name = "lastLinesCount")
+    int lastLinesCount
+
+    void setLastLinesCount(final int lastLinesCount) {
+        this.lastLinesCount = lastLinesCount
+    }
+}

tests/mem-leaks/test-cases/shutdown-hook-leak/pom.xml

@@ -56,7 +56,7 @@
 
     <properties>
         <memleak.jvm.maxheap>128m</memleak.jvm.maxheap>
-        <memleak.tomcat.maxheap>64m</memleak.tomcat.maxheap>
+        <memleak.tomcat.maxheap>128m</memleak.tomcat.maxheap>
         <memleak.test.timeout>120000</memleak.test.timeout>
     </properties>