Add support for top level assertions

Author: robotdan

src/test/java/org/primeframework/mvc/GlobalTest.java

@@ -1368,6 +1368,39 @@ public void get_redirects_nested() throws Exception {
                 .assertBodyIsEmpty())
         )
     );
+
+    // Perform assertions on top-level
+    test.simulate(() -> simulator
+        .test("/router/meta-refresh")
+        .get()
+        .assertStatusCode(200)
+        .assertHTML(html -> html.assertElementExists("meta[http-equiv=Refresh]"))
+
+        // top-level
+        .followMetaRefresh()
+        .assertStatusCode(302)
+        .assertRedirect("/router/redirect/1")
+
+        // nested
+        .followRedirect(r2 -> r2
+            .assertStatusCode(302)
+            .assertRedirect("/router/redirect/2")
+            .followRedirect()
+            .assertStatusCode(302)
+            .assertRedirect("/router/redirect/3"))
+        .followRedirect(r4 -> r4
+            .assertStatusCode(302)
+            .assertRedirect("/router/redirect/4")
+            .followRedirect(r5 -> r5
+                .assertStatusCode(302)
+                .assertRedirect("/router/redirect/5")))
+
+        // top-level
+        .followRedirect()
+        .assertStatusCode(200)
+        .assertBodyIsEmpty()
+
+    );
   }
 
   @Test

src/test/java/org/primeframework/mvc/test/RequestResult.java

@@ -1304,7 +1304,7 @@ public RequestResult delegateIfTrue(boolean test, ThrowingFunction<RequestResult
    *
    * @param selector The selector used to find the form in the DOM
    * @param result   A consumer for the request result from following the redirect.
-   * @return This.
+   * @return the request result returned by this action, or the last nested result.
    */
   public RequestResult executeFormPostInResponseBody(String selector, ThrowingConsumer<RequestResult> result)
       throws Exception {
@@ -1318,7 +1318,7 @@ public RequestResult executeFormPostInResponseBody(String selector, ThrowingCons
    * @param selector  The selector used to find the form in the DOM
    * @param domHelper A consumer for the DOM Helper
    * @param result    A consumer for the request result from following the redirect.
-   * @return This.
+   * @return the request result returned by this action, or the last nested result.
    */
   public RequestResult executeFormPostInResponseBody(String selector, ThrowingConsumer<DOMHelper> domHelper,
                                                      ThrowingConsumer<RequestResult> result)
@@ -1334,7 +1334,7 @@ public RequestResult executeFormPostInResponseBody(String selector, ThrowingCons
    *
    * @param selector The selector used to find the form in the DOM
    * @param result   A consumer for the request result from following the redirect.
-   * @return This.
+   * @return the request result returned by this action, or the last nested result.
    */
   public RequestResult executeFormPostInResponseBodyReturnPostResult(String selector, ThrowingConsumer<RequestResult> result)
       throws Exception {
@@ -1349,7 +1349,7 @@ public RequestResult executeFormPostInResponseBodyReturnPostResult(String select
    * @param selector  The selector used to find the form in the DOM
    * @param domHelper A consumer for the DOM Helper
    * @param result    A consumer for the request result from following the redirect.
-   * @return This.
+   * @return the request result returned by this action, or the last nested result.
    */
   public RequestResult executeFormPostInResponseBodyReturnPostResult(String selector, ThrowingConsumer<DOMHelper> domHelper,
                                                                      ThrowingConsumer<RequestResult> result)
@@ -1363,7 +1363,7 @@ public RequestResult executeFormPostInResponseBodyReturnPostResult(String select
    * Prefer {@link #followMetaRefresh(ThrowingConsumer)}.
    *
    * @param result A consumer for the request result from following the redirect.
-   * @return This.
+   * @return the request result returned by this action, or the last nested result.
    */
   public RequestResult executeMetaRefreshReturnResult(ThrowingConsumer<RequestResult> result) throws Exception {
     return handleFollowMetaRefresh(result);
@@ -1375,7 +1375,7 @@ public RequestResult executeMetaRefreshReturnResult(ThrowingConsumer<RequestResu
    * Prefer {@link #followRedirect(ThrowingConsumer)}
    *
    * @param consumer The request result from following the redirect.
-   * @return This.
+   * @return the request result returned by this action, or the last nested result.
    */
   public RequestResult executeRedirect(ThrowingConsumer<RequestResult> consumer) throws Exception {
     _followRedirect(consumer);
@@ -1388,7 +1388,7 @@ public RequestResult executeRedirect(ThrowingConsumer<RequestResult> consumer) t
    * Prefer {@link #followRedirect(ThrowingConsumer)}
    *
    * @param consumer The request result from following the redirect.
-   * @return This.
+   * @return the request result returned by this action, or the last nested result.
    */
   public RequestResult executeRedirectReturnResult(ThrowingConsumer<RequestResult> consumer) throws Exception {
     return _followRedirect(consumer);
@@ -1398,22 +1398,40 @@ public RequestResult executeRedirectReturnResult(ThrowingConsumer<RequestResult>
    * Attempt to follow a meta-refresh
    *
    * @param result A consumer for the request result from following the redirect.
-   * @return This.
+   * @return the request result returned by this action, or the last nested result.
    */
   public RequestResult followMetaRefresh(ThrowingConsumer<RequestResult> result) throws Exception {
     return handleFollowMetaRefresh(result);
   }
 
+  /**
+   * Attempt to follow a meta-refresh
+   *
+   * @return the request result returned by this action, or the last nested result.
+   */
+  public RequestResult followMetaRefresh() throws Exception {
+    return handleFollowMetaRefresh(null);
+  }
+
   /**
    * Follow the redirect and accept a consumer to assert on the response.
    *
    * @param consumer The request result from following the redirect.
-   * @return This.
+   * @return the request result returned by this action, or the last nested redirect.
    */
   public RequestResult followRedirect(ThrowingConsumer<RequestResult> consumer) throws Exception {
     return _followRedirect(consumer);
   }
 
+  /**
+   * Follow the redirect and accept a consumer to assert on the response.
+   *
+   * @return the request result returned by this action, or the last nested redirect.
+   */
+  public RequestResult followRedirect() throws Exception {
+    return _followRedirect(null);
+  }
+
   /**
    * Retrieves the instance of the given type from the Guice Injector.
    *
@@ -1613,24 +1631,23 @@ public RequestResult setup(ThrowingRunnable runnable) throws Exception {
    * Attempt to submit the form found in the response body and return the result.
    *
    * @param selector The selector used to find the form in the DOM
-   * @param result   The request result
-   * @return This.
+   * @return the request result returned by this action, or the last nested result.
    */
-  public RequestResult submitForm(String selector, ThrowingConsumer<RequestResult> result) throws Exception {
-    return _submitForm(selector, null, result);
+  public RequestResult submitForm(String selector, ThrowingConsumer<RequestResult> consumer) throws Exception {
+    return _submitForm(selector, null, consumer);
   }
 
   /**
    * Attempt to submit the form found in the response body and return the result.
    *
    * @param selector  The selector used to find the form in the DOM
    * @param domHelper A consumer for the DOM Helper
-   * @param result    The request result
-   * @return This.
+   * @param consumer  The request result consumer
+   * @return the request result returned by this action, or the last nested result.
    */
-  public RequestResult submitForm(String selector, ThrowingConsumer<DOMHelper> domHelper, ThrowingConsumer<RequestResult> result)
+  public RequestResult submitForm(String selector, ThrowingConsumer<DOMHelper> domHelper, ThrowingConsumer<RequestResult> consumer)
       throws Exception {
-    return _submitForm(selector, domHelper, result);
+    return _submitForm(selector, domHelper, consumer);
   }
 
   private RequestResult _assertBodyContains(boolean escape, String... strings) {
@@ -1738,7 +1755,9 @@ private RequestResult _followRedirect(ThrowingConsumer<RequestResult> consumer)
 
     result.chained = chained;
     chained.add(result);
-    consumer.accept(result);
+    if (consumer != null) {
+      consumer.accept(result);
+    }
     return chained.getLast();
   }
 
@@ -1808,7 +1827,10 @@ private RequestResult _submitForm(String selector, ThrowingConsumer<DOMHelper> d
 
     result.chained = chained;
     result.chained.add(result);
-    consumer.accept(result);
+    if (consumer != null) {
+      consumer.accept(result);
+    }
+
     return chained.getLast();
   }
 
@@ -1942,7 +1964,9 @@ private RequestResult handleFollowMetaRefresh(ThrowingConsumer<RequestResult> co
 
               result.chained = chained;
               result.chained.add(result);
-              consumer.accept(result);
+              if (consumer != null) {
+                consumer.accept(result);
+              }
               return result.chained.getLast();
             }
           }