/*
Copyright 2011-2014 Cray Inc. All Rights Reserved

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

 * Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.

 * Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.

 * Neither the name Cray Inc. nor the names of its contributors may be
  used to endorse or promote products derived from this software
  without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 */

package net.sf.sparql.benchmarking.runners.operations;

import net.sf.sparql.benchmarking.operations.Operation;
import net.sf.sparql.benchmarking.options.Options;
import net.sf.sparql.benchmarking.runners.Runner;
import net.sf.sparql.benchmarking.stats.OperationRun;

/**
 * An operation runner that will retry the given operation if it produces an
 * error
 * 
 * @author rvesse
 * 
 */
public class RetryingOperationRunner extends DefaultOperationRunner {

    private int maxRetries;

    /**
     * Creates a new runner
     * 
     * @param maxRetries
     *            Maximum number of retries, a value of 0 means no retries in
     *            which case behaviour is equivalent to the base class
     *            {@link DefaultOperationRunner}
     */
    public RetryingOperationRunner(int maxRetries) {
        if (maxRetries < 0)
            throw new IllegalArgumentException("maxRetries must be >= 0");
        this.maxRetries = maxRetries;
    }

    @Override
    public <T extends Options> OperationRun run(Runner<T> runner, T options, Operation op) {
        if (this.maxRetries == 0) {
            return super.run(runner, options, op);
        } else {
            OperationRun r = null;
            for (int attempt = 1; attempt <= this.maxRetries + 1; attempt++) {
                r = super.run(runner, options, op);

                // Stop as soon as successful
                if (r.wasSuccessful())
                    break;

                // If not successful and we still have retries available to us
                // report that we are retrying
                if (attempt < this.maxRetries) {
                    runner.reportProgress(options, String.format("Operation %s errored on attempt %d of %d, retrying...",
                            op.getName(), attempt, this.maxRetries + 1));
                } else {
                    runner.reportProgress(options,
                            String.format("Operation %s errored on all %d attempts", op.getName(), this.maxRetries + 1));
                }
            }
            return r;
        }
    }
}

@@ -3174,32 +3174,455 @@
 .maxRetries) %7B%0D%0A
+                    // See whether we should retry%0D%0A                    // By default this is always true if we haven't exhausted%0D%0A                    // our retries but derived implementations may choose to%0D%0A                    // override the shouldRetry() method to indicate that only%0D%0A                    // certain kinds of errors result in a retry%0D%0A                    if (shouldRetry(runner, options, op, r)) %7B%0D%0A    
                 
@@ -3662,32 +3662,66 @@
 , String.format(
+%0D%0A                                
 %22Operation %25s er
@@ -3760,18 +3760,545 @@
 ing...%22,
-%0D%0A
+ op.getName(), attempt,%0D%0A                                this.maxRetries + 1));%0D%0A                    %7D else %7B%0D%0A                        // We are not retrying further even though we have%0D%0A                        // retries available%0D%0A                        runner.reportProgress(%0D%0A                                options,%0D%0A                                String.format(%0D%0A                                        %22Operation %25s errored on attempt %25d of %25d and runner indicated it did not want to make further retries%22,%0D%0A            
         
@@ -4356,32 +4356,55 @@
 Retries + 1));%0D%0A
+                    %7D%0D%0A
                 
@@ -4662,12 +4662,760 @@
 %0D%0A    %7D%0D
+%0A%0D%0A    /**%0D%0A     * Decides whether the runner should continue retrying%0D%0A     * %3Cp%3E%0D%0A     * The default implementation always returns %7B@code true%7D but derived%0D%0A     * implementations may want to override this if they only wish to carry out%0D%0A     * retries under certain circumstances.%0D%0A     * %3C/p%3E%0D%0A     * %0D%0A     * @param runner%0D%0A     *            Runner%0D%0A     * @param options%0D%0A     *            Options%0D%0A     * @param op%0D%0A     *            Operation%0D%0A     * @param run%0D%0A     *            Results of the most recent failed run%0D%0A     * @return True if the runner should retry, false otherwise%0D%0A     */%0D%0A    protected %3CT extends Options%3E boolean shouldRetry(Runner%3CT%3E runner, T options, Operation op, OperationRun run) %7B%0D%0A        return true;%0D%0A    %7D%0D
 %0A%7D%0D%0A

Make RetryingOperationRunner easier to extend