Skip to content

Latest commit

 

History

History
426 lines (347 loc) · 10.4 KB

AssertCollection.md

File metadata and controls

426 lines (347 loc) · 10.4 KB

← back

Assert Content As Collection 🔸 (New)

Not Empty

The assertCollectionNotEmpty method verifies that the collection returned in the response is not empty. If it is needed, it must be called first. Once invoked, other collection-related assertions can follow. However, if any other assertCollection methods are called before assertCollectionNotEmpty, the framework will not provide this method again, as it ensures that only methods which are contextually appropriate are available.

      get()
          ...
          .act()
          .actPerform()
          .asserts()
          .assertContentAsCollection()
          .assertCollectionNotEmpty()

Empty

The assertCollectionEmpty method verifies that the collection returned in the response is empty. After this assertion, no further collection-related assertions can be performed, as it would be semantically incorrect to validate additional properties on an empty result.

      get()
          ...
          .act()
          .actPerform()
          .asserts()
          .assertContentAsCollection()
          .assertCollectionEmpty();

Size

The assertCollectionSize method verifies that the size of the collection returned in the response matches the expected size.

If assertCollectionSize and assertCollectionEquals are used together, assertCollectionSize must be called before assertCollectionEquals. After calling assertCollectionEquals, the framework will no longer offer assertCollectionSize, as it would not be logically applicable to check the size after comparing the collection's contents.

  get()
      ...
      .act()
      .actPerform()
      .asserts()
      .assertContentAsCollection()
      .assertCollectionSize(2)

Equals

The assertCollectionEquals method ensures that the collection returned in the response matches an expected List of objects both in content and order.

  • Class Specification: The class type of the objects within the collection (e.g., DemoDto.class) must be specified.
  • Expected Collection: The expected collection (e.g. EXPECTED_LIST) is provided to compare against the response.
  public record DemoObject(String name, Integer id) {}

  A1 = new DemoObject(A, 1);
  A2 = new DemoObject(A, 2);

  @GetMapping(...)
  public ResponseEntity<List<DemoObject>> getAll() {
    return new ResponseEntity<>(List.of(A1, A2), OK);
  }

  get()
      ...
      .act()
      .actPerform()
      .asserts()
      .assertContentAsCollection()
      .assertCollectionEquals(DemoObject.class, List.of(A1, A2))

Contains Any Order

The assertCollectionContainsAnyOrder method verifies that the collection returned in the response matches the expected collection, ignoring the order of the elements.

  public record DemoObject(String name, Integer id) {}

  A1 = new DemoObject(A, 1);
  A2 = new DemoObject(A, 2);

  @GetMapping(...)
  public ResponseEntity<List<DemoObject>> getAll() {
    return new ResponseEntity<>(List.of(A1, A2), OK);
  }

  get()
      ...
      .act()
      .actPerform()
      .asserts()
      .assertContentAsCollection()
      .assertCollectionContainsAnyOrder(DemoObject.class, List.of(A2, A1));

Not Contains

The assertCollectionNotContains method is used to verify that the specified objects do **not ** exist within the collection returned in the response.

  • Class Specification: The class type of the objects within the collection (e.g., DemoObject.class) must be explicitly provided to ensure accurate comparison.
  • Expected Objects: The method checks that the given objects (e.g., A3, A4) are not present in the returned collection. These objects can be specified as a single object, as varargs, or as a collection.
  public record DemoObject(String name, Integer id) {}

  A1 = new DemoObject(A, 1);
  A2 = new DemoObject(A, 2);
  A3 = new DemoObject(A, 3);
  A4 = new DemoObject(A, 4);

  @GetMapping(...)
  public ResponseEntity<List<DemoObject>> getAll() {
    return new ResponseEntity<>(List.of(A1, A2), OK);
  }

  get()
      ...
      .act()
      .actPerform()
      .asserts()
      .assertContentAsCollection()
      .assertCollectionNotContains(DemoObject.class, A3);

  get()
      ...
      .act()
      .actPerform()
      .asserts()
      .assertContentAsCollection()
      .assertCollectionNotContains(DemoObject.class, A3, A4, ...);

  get()
      ...
      .act()
      .actPerform()
      .asserts()
      .assertContentAsCollection()
      .assertCollectionNotContains(DemoObject.class, List.of(A3, A4));

Contains

The assertCollectionContains method is used to verify that the specified objects do exist within the collection returned in the response.

  • Class Specification: The class type of the objects within the collection (e.g., DemoObject.class) must be explicitly provided to ensure accurate comparison.
  • Expected Objects: The method checks that the given objects (e.g., A1, A2) are present in the returned collection. These objects can be specified as a single object, as varargs, or as a collection.
  public record DemoObject(String name, Integer id) {}

  A1 = new DemoObject(A, 1);
  A2 = new DemoObject(A, 2);

  @GetMapping(...)
  public ResponseEntity<List<DemoObject>> getAll() {
    return new ResponseEntity<>(List.of(A1, A2), OK);
  }

  get()
      ...
      .act()
      .actPerform()
      .asserts()
      .assertContentAsCollection()
      .assertCollectionContains(DemoObject.class, A1);

  get()
      ...
      .act()
      .actPerform()
      .asserts()
      .assertContentAsCollection()
      .assertCollectionContains(DemoObject.class, A1, A2, ...);

  get()
      ...
      .act()
      .actPerform()
      .asserts()
      .assertContentAsCollection()
      .assertCollectionContains(DemoObject.class, List.of(A1, A2));

Match All

The assertCollectionMatchAll method is used to verify that all elements in the collection match the specified conditions. This assertion allows for checking multiple attributes or conditions for every element in the collection.

  • Class Specification: The class type of the objects within the collection ( e.g., DemoMatch.class) must be defined to ensure the proper type is being validated.
  • Conditions: One or more conditions (e.g., predicates) can be provided. These conditions will be applied to each element in the collection, and the assertion will pass only if all elements satisfy the provided conditions.
  public record DemoMatch(String name, Integer id, Status status) {}

  A1_NEW = new DemoMatch(A, 1, NEW);
  A2_NEW = new DemoMatch(A, 2, NEW);

  @GetMapping(...)
  public ResponseEntity<List<DemoMatch>> getAll() {
    return new ResponseEntity<>(List.of(A1_NEW, A2_NEW), OK);
  }

  get()
      ...
      .act()
      .actPerform()
      .asserts()
      .assertContentAsCollection()
      .assertCollectionMatchAll(DemoMatch.class, element -> element.name().equals(A));

  get()
      ...
      .act()
      .actPerform()
      .asserts()
      .assertContentAsCollection()
      .assertCollectionMatchAll(DemoMatch.class,
            element -> element.name().equals(A),
            element -> element.status().equals(NEW));

Match Any

The assertCollectionMatchAny method is used to verify that at least one element in the collection matches the specified conditions. This assertion allows for checking multiple attributes or conditions, and it will pass if any element satisfies at least one of the provided conditions.

  • Class Specification: The class type of the objects within the collection ( e.g., DemoMatch.class) must be defined to ensure proper validation.
  • Conditions: One or more conditions (e.g., predicates) can be provided. The assertion will pass if any element satisfies any of the given conditions.
  public record DemoMatch(String name, Integer id, Status status) {}

  A1_NEW = new DemoMatch(A, 1, NEW);
  A2_NEW = new DemoMatch(A, 2, NEW);

  @GetMapping(...)
  public ResponseEntity<List<DemoMatch>> getAll() {
    return new ResponseEntity<>(List.of(A1_NEW, A2_NEW), OK);
  }

  get()
      ...
      .act()
      .actPerform()
      .asserts()
      .assertContentAsCollection()
      .assertCollectionMatchAny(DemoMatch.class, element -> element.name().equals(A));

  get()
      ...
      .act()
      .actPerform()
      .asserts()
      .assertContentAsCollection()
      .assertCollectionMatchAny(DemoMatch.class,
            element -> element.name().equals(A),
            element -> element.status().equals(CLOSE));

Match None

The assertCollectionMatchNone method is used to verify that no elements in the collection match the specified conditions. This assertion allows for checking multiple attributes or conditions, and it will pass if none of the elements satisfy the given conditions.

  • Class Specification: The class type of the objects within the collection ( e.g., DemoMatch.class) must be defined to ensure proper validation.
  • Conditions: One or more conditions (e.g., predicates) can be provided. The assertion will pass only if none of the elements match any of the specified conditions.
  public record DemoMatch(String name, Integer id, Status status) {}

  A1_NEW = new DemoMatch(A, 1, NEW);
  A2_NEW = new DemoMatch(A, 2, NEW);

  @GetMapping(...)
  public ResponseEntity<List<DemoMatch>> getAll() {
    return new ResponseEntity<>(List.of(A1_NEW, A2_NEW), OK);
  }

  get()
      ...
      .act()
      .actPerform()
      .asserts()
      .assertContentAsCollection()
      .assertCollectionMatchNone(DemoMatch.class, element -> element.name().equals(B));

  get()
      ...
      .act()
      .actPerform()
      .asserts()
      .assertContentAsCollection()
      .assertCollectionMatchNone(DemoMatch.class,
            element -> element.name().equals(B),
            element -> element.status().equals(CLOSE));

← back