Package ratpack.test.exec

Interface ExecHarness

    • Method Detail

      • harness

        static ExecHarness harness()
        Creates a new execution harness. 
        
 import ratpack.exec.Promise;
 import ratpack.test.exec.ExecHarness;
 import ratpack.exec.ExecResult;

 import static org.junit.jupiter.api.Assertions.assertEquals;

 public class Example {

   // An async callback based API
   static class AsyncApi {

     static interface Callback<T> {
       void receive(T value);
     }

     public <T> void returnAsync(T value, Callback<? super T> callback) {
       new Thread(() -> callback.receive(value)).run();
     }
   }

   // Our service class that wraps the raw async API
   // In the real app this is created by the DI container (e.g. Guice)
   static class AsyncService {
     private final AsyncApi asyncApi = new AsyncApi();

     // Our method under test
     public <T> Promise<T> promise(final T value) {
       return Promise.async(downstream -> asyncApi.returnAsync(value, downstream::success));
     }
   }

   public static void main(String[] args) throws Throwable {
     // the harness must be close()'d when finished with to free resources
     try (ExecHarness harness = ExecHarness.harness()) {

       // set up the code under test
       final AsyncService service = new AsyncService();

       // exercise the async code using the harness, blocking until the promised value is available
       ExecResult<String> result = harness.yield(execution -> service.promise("foo"));

       assertEquals("foo", result.getValue());
     }
   }
 }
        When using Ratpack's RxJava integration, ExecHarness can be used to test rx.Observable instances by first converting them to a promise. See the ratpack.rx2.RxRatpack.single(Observable) documentation for an example of testing observables.
        Returns:
        a new execution harness

      • harness

        static ExecHarness harness​(int numThreads)
        Create a harness with the provided number of computation threads.
        Parameters:
        numThreads - the number of computation threads
        Returns:
        an execution harness

      • harness

        static ExecHarness harness​(Action<? super ExecControllerSpec> definition)
        Create a harness that is backed by an execution controller with the provided configuration
        Parameters:
        definition - the controller specification
        Returns:
        an execution harness
        Since:
        2.0

      • yield

        default <T> ExecResult<T> yield​(Function<? super Execution,​? extends Promise<T>> func)
                         throws Exception
        Synchronously returns a promised value.

        The given function will execute in a separate thread. The calling thread will block, waiting for the promised value to be provided.

        Type Parameters:
        T - the type of promised value
        Parameters:
        func - a function that exercises some code that returns a promise
        Returns:
        the result of the execution
        Throws:
        Exception - any thrown by the function

      • yield

        <T> ExecResult<T> yield​(Action<? super RegistrySpec> registry,
                        Function<? super Execution,​? extends Promise<T>> func)
                 throws Exception
        Synchronously returns a promised value.

        The given function will execute in a separate thread. The calling thread will block, waiting for the promised value to be provided.

        Type Parameters:
        T - the type of promised value
        Parameters:
        registry - the intial contents of the execution registry
        func - a function that exercises some code that returns a promise
        Returns:
        the result of the execution
        Throws:
        Exception - any thrown by the function

      • yieldSingle

        static <T> ExecResult<T> yieldSingle​(Function<? super Execution,​? extends Promise<T>> func)
                              throws Exception
        Creates an exec harness, executes the given function with it before closing it, then returning execution result.
        Type Parameters:
        T - the type of promised value
        Parameters:
        func - a function that exercises some code that returns a promise
        Returns:
        the result of the execution
        Throws:
        Exception - any thrown by the function, or the promise failure exception

      • yieldSingle

        static <T> ExecResult<T> yieldSingle​(Action<? super RegistrySpec> registry,
                                     Function<? super Execution,​? extends Promise<T>> func)
                              throws Exception
        Creates an exec harness, executes the given function with it before closing it, then returning execution result.
        Type Parameters:
        T - the type of promised value
        Parameters:
        registry - the intial contents of the execution registry
        func - a function that exercises some code that returns a promise
        Returns:
        the result of the execution
        Throws:
        Exception - any thrown by the function, or the promise failure exception

      • run

        default void run​(Action<? super Execution> action)
          throws Exception
        Initiates an execution and blocks until it completes. If an uncaught exception is thrown during the execution, it will be thrown by this method.

        This method is useful for testing an execution that has some detectable side effect, as this method does not return the “result” of the execution.

        Parameters:
        action - the start of the execution
        Throws:
        Exception - any thrown during the execution that is not explicitly caught
        See Also:
        runSingle(Action), yield(Function)

      • run

        void run​(Action<? super RegistrySpec> registry,
         Action<? super Execution> action)
  throws Exception
        Initiates an execution and blocks until it completes. If an uncaught exception is thrown during the execution, it will be thrown by this method.

        This method is useful for testing an execution that has some detectable side effect, as this method does not return the “result” of the execution.

        Parameters:
        registry - the intial contents of the execution registry
        action - the start of the execution
        Throws:
        Exception - any thrown during the execution that is not explicitly caught
        See Also:
        runSingle(Action), yield(Function)

      • close

        void close()
        Shuts down the thread pool backing this harness.
        Specified by:
        close in interface AutoCloseable