refactors package structure and adds more java doc

server/src/test/java/e2e/JsonArrSearchTest.java

@@ -11,9 +11,9 @@
 import io.littlehorse.sdk.wfsdk.Workflow;
 import io.littlehorse.test.LHTest;
 import io.littlehorse.test.LHWorkflow;
-import io.littlehorse.test.SearchResultCaptor;
 import io.littlehorse.test.WorkflowVerifier;
 import io.littlehorse.test.internal.TestExecutionContext;
+import io.littlehorse.test.internal.step.SearchResultCaptor;
 import java.util.List;
 import java.util.function.Function;
 import org.junit.jupiter.api.Test;

server/src/test/java/e2e/UserTaskTest.java

@@ -36,9 +36,9 @@
 import io.littlehorse.test.LHTest;
 import io.littlehorse.test.LHUserTaskForm;
 import io.littlehorse.test.LHWorkflow;
-import io.littlehorse.test.SearchResultCaptor;
 import io.littlehorse.test.WorkflowVerifier;
 import io.littlehorse.test.internal.TestExecutionContext;
+import io.littlehorse.test.internal.step.SearchResultCaptor;
 import java.time.Duration;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.function.Function;

server/src/test/java/e2e/WfRunSearchTest.java

@@ -23,9 +23,9 @@
 import io.littlehorse.sdk.worker.LHTaskMethod;
 import io.littlehorse.test.LHTest;
 import io.littlehorse.test.LHWorkflow;
-import io.littlehorse.test.SearchResultCaptor;
 import io.littlehorse.test.WorkflowVerifier;
 import io.littlehorse.test.internal.TestExecutionContext;
+import io.littlehorse.test.internal.step.SearchResultCaptor;
 import java.util.List;
 import java.util.function.Function;
 import org.assertj.core.api.Assertions;

test-utils/src/main/java/io/littlehorse/test/CapturedResult.java

@@ -1,10 +1,17 @@
 package io.littlehorse.test;
 
+import io.littlehorse.test.internal.step.VerifyTaskRunOutputsStep;
+
+/**
+ * {@code CapturedResult} is a wrapper for a response. see {@link VerifyTaskRunOutputsStep.SearchResultCaptor}
+ * @param <T> Search response type
+ */
 public interface CapturedResult<T> {
 
+    /**
+     * Returns the search response value
+     */
     T get();
 
-    void set(T result);
-
     Class<T> type();
 }

test-utils/src/main/java/io/littlehorse/test/LHTest.java

@@ -26,5 +26,8 @@
 @ExtendWith(LHExtension.class)
 public @interface LHTest {
 
+    /**
+     * An array of external events that will be registered during bootstrapping.
+     */
     String[] externalEventNames() default {};
 }

test-utils/src/main/java/io/littlehorse/test/internal/step/CapturedResultImpl.java

@@ -0,0 +1,30 @@
+package io.littlehorse.test.internal.step;
+
+import io.littlehorse.test.CapturedResult;
+
+class CapturedResultImpl<T> implements CapturedResult<T> {
+
+    private T value;
+    private final Class<T> target;
+
+    public CapturedResultImpl(Class<T> target) {
+        this.target = target;
+    }
+
+    @Override
+    public T get() {
+        return value;
+    }
+
+    public void set(T result) {
+        if (value != null) {
+            throw new IllegalStateException("Already has value");
+        }
+        value = result;
+    }
+
+    @Override
+    public Class<T> type() {
+        return target;
+    }
+}

test-utils/src/main/java/io/littlehorse/test/SearchResultCaptor.java → test-utils/src/main/java/io/littlehorse/test/internal/step/SearchResultCaptor.java

@@ -1,10 +1,21 @@
-package io.littlehorse.test;
+package io.littlehorse.test.internal.step;
 
 import com.google.protobuf.Message;
+import io.littlehorse.test.CapturedResult;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.atomic.AtomicInteger;
 
+/**
+ * {@code SearchResultCaptor} intercepts search result at any point of the workflow execution.
+ * <blockquote><pre>
+ *  workflowVerifier.prepareRun(myWorkflow)
+ *        .doSearch(SearchWfSpecRequest.class, searchResultCaptor.capture(), searchRequest)
+ *        .start();
+ *  CapturedResult<WfSpecIdList> capturedResult =  searchResultCaptor.getValue();
+ * </pre></blockquote>
+ * @param <T> Search response type.
+ */
 public final class SearchResultCaptor<T extends Message> {
     private final Class<T> target;
     private final AtomicInteger currentIndex = new AtomicInteger();
@@ -19,18 +30,30 @@ public static <T extends Message> SearchResultCaptor<T> of(final Class<T> target
         return new SearchResultCaptor<>(target);
     }
 
+    /**
+     * Captures the result within a {@code Step}
+     * @return search response
+     */
     public CapturedResult<T> capture() {
-        CapturedResult<T> captured = new CapturedResultImpl();
+        CapturedResult<T> captured = new CapturedResultImpl(target);
         results.add(captured);
         return captured;
     }
 
+    /**
+     * Ignores the result
+     */
     public CapturedResult<T> skip() {
         SkipResult skipResult = new SkipResult();
         results.add(skipResult);
         return skipResult;
     }
 
+    /**
+     * Returns current value.
+     * Note: this method guarantees the order of the values during the execution.
+     * @return search response
+     */
     public CapturedResult<T> getValue() {
         CapturedResult<T> result;
         do {
@@ -44,36 +67,13 @@ public CapturedResult<T> getValue() {
         return result;
     }
 
-    private final class CapturedResultImpl implements CapturedResult<T> {
-        private T value;
-
-        @Override
-        public T get() {
-            return value;
-        }
-
-        @Override
-        public void set(T result) {
-            if (value != null) {
-                throw new IllegalStateException("Already has value");
-            }
-            value = result;
-        }
-
-        @Override
-        public Class<T> type() {
-            return target;
-        }
-    }
-
     private final class SkipResult implements CapturedResult<T> {
 
         @Override
         public T get() {
             throw new UnsupportedOperationException();
         }
 
-        @Override
         public void set(T result) {
             // skip
         }

test-utils/src/main/java/io/littlehorse/test/internal/step/SearchStep.java

@@ -9,14 +9,17 @@
 
 public class SearchStep<I, O> implements Step {
 
-    private final CapturedResult<O> resultHolder;
+    private final CapturedResultImpl<O> resultHolder;
     private final Function<TestExecutionContext, I> requestBuilder;
 
     private final Method targetRpc;
 
     public SearchStep(
             Class<I> requestType, Function<TestExecutionContext, I> requestBuilder, CapturedResult<O> resultHolder) {
-        this.resultHolder = resultHolder;
+        if (!(resultHolder instanceof CapturedResultImpl)) {
+            throw new IllegalArgumentException("resultHolder must be CapturedResultImpl");
+        }
+        this.resultHolder = (CapturedResultImpl) resultHolder;
         this.requestBuilder = requestBuilder;
         this.targetRpc = findTargetRpc(requestType, resultHolder.type());
     }