TestUtil.java

/*
This file is part of Reactive Cascade which is released under The MIT License.
See license.md , https://github.com/futurice/cascade and http://reactivecascade.com for details.
This is open source for the common good. Please contribute improvements by pull request or contact paulirotta@gmail.com
*/
package com.reactivecascade.util;

import android.support.annotation.NonNull;

import com.reactivecascade.i.IAltFuture;

import java.util.concurrent.TimeUnit;

import static com.reactivecascade.Async.SHOW_ERROR_STACK_TRACES;

/**
 * Intergration test utilities.
 * <p>
 * Although there is technically nothing preventing these from running during normal program operation
 * it is not advised. These methods may suspend one thread while waiting for a result run on another
 * thread. This is classic {@link java.util.concurrent.Future} behavior, but use of {@link IAltFuture}
 * is much safer and more performant in a production environment especially since the number of threads
 * is strictly controlled and tuned to the device in which the application is running.
 * <p>
 * Created by phou on 6/2/2015.
 */
public class TestUtil {
    public TestUtil() {
    }

    /**
     * Run a unit of work on the specified thread
     *
     * @param altFuture
     * @param <IN>
     * @param <OUT>
     * @return
     * @throws Exception
     */
    public <IN, OUT> OUT awaitDone(@NonNull IAltFuture<IN, OUT> altFuture,
                                   long timeoutMillis) throws Exception {
        return new AltFutureFuture<>(altFuture).get(timeoutMillis, TimeUnit.MILLISECONDS);
    }

    /**
     * Run a unit of work on the specified thread
     * <p>
     * Error logging will be termporarily disabled during this test to avoid intentional and potentially
     * confusing messages appearing. This has termporary, global side effects and is not compatible
     *
     * @param altFuture
     * @param <IN>
     * @param <OUT>
     * @return
     * @throws Exception
     */
    public <IN, OUT> OUT awaitDoneNoErrorStackTraces(@NonNull IAltFuture<IN, OUT> altFuture,
                                                     long timeoutMillis) throws Exception {
        SHOW_ERROR_STACK_TRACES = false;
        try {
            return awaitDone(altFuture, timeoutMillis);
        } finally {
            SHOW_ERROR_STACK_TRACES = true;
        }
    }
}