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
– Stultuske, Commented Jan 20, 2015 at 7: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 (Not Found is 404) — ThanksForAllTheFish
– ThanksForAllTheFish, Commented Jan 20, 2015 at 7: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
– JustAC0der, Commented Jan 20, 2015 at 7: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
– Stultuske, Commented Jan 20, 2015 at 7: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
– JustAC0der, Commented Jan 20, 2015 at 7:51

JustAC0der · Accepted Answer · 2015-01-20 08:53:17Z

10

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

answered Jan 20, 2015 at 8:53

JustAC0der

3,2813 gold badges35 silver badges40 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Christian Baumann · Accepted Answer · 2022-12-27 13:23:40Z

6

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));
}

edited Dec 27, 2022 at 13:23

Christian Baumann

3,7414 gold badges24 silver badges47 bronze badges

answered Dec 21, 2017 at 10:55

Stefan Großmann

1,04611 silver badges21 bronze badges

Comments

Dharman · Accepted Answer · 2020-11-18 17:31:12Z

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, 2020 at 17:31

Dharman♦

33.9k27 gold badges106 silver badges157 bronze badges

answered Nov 18, 2020 at 17:25

Bernardo Espinosa Torres Landa

12 bronze badges

Comments

Anoop Pednekar · Accepted Answer · 2021-06-02 12:27:06Z

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 2, 2021 at 12:27

answered Jan 8, 2020 at 12:47

Anoop Pednekar

93 bronze badges

Collectives™ on Stack Overflow

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

4 Answers 4

Comments

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related