Rest-assured. How to check if not empty array is returned?

Question

I have the following code which should test my RESTful API:

given().baseUri("http://...").get("/categories/all")
    .then()
    .body(
        "results",  not(empty())
    );

The API returns the following response:

{
    "error": {
        "type": "NotFoundException"
    }
}

And I want the test to fail for such response. But the test passes.

How can I modify the test to make it fail? It should only pass if the API returns an object which contains a not-empty array in the "results" key. It should fail when the "results" key does not exists, contains empty array or when it contains something that is not an array.

Why not return a List instead, and use the .isEmpty() check ? — Stultuske, Jan 20 '15 at 07:43
Just a note: if you want to be RESTful, do not return error code in the body response, but use standard [HTTP return codes](http://www.w3.org/Protocols/HTTP/HTRESP.html) (`Not Found` is `404`) — ThanksForAllTheFish, Jan 20 '15 at 07:43
@Stultuske I do not fully understand your comment. Should I return a list from the REST API? But the API does not work correctly, it does not return a list and I want to check it. — JustAC0der, Jan 20 '15 at 07:48
Much depends on how you implement it. If you don't want to change the code, you can still go Arrays.asList(myArrayName); and call isEmpty() on that — Stultuske, Jan 20 '15 at 07:49
@ThanksForAllTheFish I know :) . I do return the 404 response code. The response contents only contain additional information. But in my test I want to check the "results" key anyway. — JustAC0der, Jan 20 '15 at 07:51
@Stultuske I think I found an easier, more concise way to do this. I will post it as an answer. — JustAC0der, Jan 20 '15 at 08:48

score 9 · Accepted Answer · answered Jan 20 '15 at 08:53

I came up with the following solution:

given().baseUri("http://...").get("/categories/all")
    .then()
    .body(
        "results", hasSize(greaterThan(0))
    );

It fails if "results" is an empty array or not an array. It passes if "results" is a not-empty array. It reports an error in a readable way, e.g.:

Expected: a collection with size a value greater than <0>
Actual: null

score 5 · Answer 2 · edited Dec 27 '22 at 13:23

I had a similar problem but in my case the endpoint direcly returns an array. My solution for this:

@Test
public void testNotEmpty() {
    uAssured.given()
            .when()
                .get("resources/totest")
            .then()
                .statusCode(200)
                .body("$.size()", greaterThan(0));
}

For the example above the following should work as well:

@Test
public void testNotEmpty() {
    uAssured.given()
            .when()
                .get("resources/totest")
            .then()
                .statusCode(200)
                .body("results.size()", greaterThan(0));
}

Anoop Pednekar · Answer 3 · 2021-06-02T12:27:06.573

0

To check if the array is not empty you can use the not(emptyArray) method.

   given()
  .baseUri("http://...")
  .get("/categories/all")
  .then()
  .body("results", not(emptyArray()));

use emptyArray method from org.hamcrest.Matcher

edited Jun 02 '21 at 12:27

answered Jan 08 '20 at 12:47

Anoop Pednekar

9
3

score 0 · Answer 4 · edited Nov 18 '20 at 17:31

0

I was having the same problem and what I found was that the following instruction worked:

given().baseUri("http://...").get("/categories/all")
.then()
.assertThat().body(notNullValue());

I tried everything above and had no luck.

edited Nov 18 '20 at 17:31

Dharman

30,962
25
85
135

answered Nov 18 '20 at 17:25

Bernardo Espinosa Torres Landa

1
2

Rest-assured. How to check if not empty array is returned?

4 Answers4