/*
 * 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 java.util.Collection;

import org.apache.maven.plugin.MojoExecutionException;

/**
 * Mojo Execution exception that contains additional information regarding an error from an executed shell script.
 *
 * @author Stepan Vavra (stepan.vavra at oracle.com)
 */
public class ShellMojoExecutionException extends MojoExecutionException {

    /**
     * The error code the shell script exited with.
     */
    private final int errorCode;

    /**
     * The last lines of the output of the executed shell script.
     */
    private final Collection<String> lastLines;

    /**
     * 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 " + lastLines.size() + " lines of stderr/stdout output are: "
                + "\n" + lastLinesToString(lastLines));
        this.errorCode = errorCode;
        this.lastLines = lastLines;
    }

    public int getErrorCode() {
        return errorCode;
    }

    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();
    }
}
