JsonUtils (Grails 7.0.10)

org.apache.grails.testing.http.client.utils.JsonUtils

```
@groovy.transform.CompileStatic
class JsonUtils
extends java.lang.Object
```
Utility method for handling JSON.
JSON assertion helpers used by HTTP test response expectations.

This utility provides two styles of validation:
- Tree equality via verifyJsonTree(java.net.http.HttpResponse, Object) and #verifyJsonTree(java.net.http.HttpResponse, CharSequence), where object key order is ignored.
- Subset matching via verifyJsonTreeContains(java.net.http.HttpResponse, Object) and verifyJsonTreeContains(java.net.http.HttpResponse, CharSequence), where expected map keys must exist and expected list elements are matched by index.
Failures include canonicalized JSON representations to make diffs easier to read.

Since:
7.0.10

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`JsonUtils.SlurperConfig`	Optional configuration for JSON parsing backed by JsonSlurper.

Constructor Summary

Constructors
Constructor and description
`JsonUtils()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static java.lang.Object`	`parseText(java.lang.CharSequence json, JsonUtils.SlurperConfig jsonSlurperConfig)`
	`static void`	`verifyJsonTree(java.net.http.HttpResponse<?> response, java.lang.Object expected)` Verifies that the response JSON is structurally equal to the expected object tree.
	`static void`	`verifyJsonTree(java.net.http.HttpResponse<?> response, java.lang.Object expected, JsonUtils.SlurperConfig jsonSlurperConfig)`
	`static void`	`verifyJsonTree(java.net.http.HttpResponse<?> response, java.lang.CharSequence expectedJson)` Verifies that the response JSON is structurally equal to the expected JSON string.
	`static void`	`verifyJsonTree(java.net.http.HttpResponse<?> response, java.lang.CharSequence expectedJson, JsonUtils.SlurperConfig jsonSlurperConfig)`
	`static void`	`verifyJsonTreeContains(java.net.http.HttpResponse<?> response, java.lang.Object expected)` Verifies that the response JSON contains the expected subset.
	`static void`	`verifyJsonTreeContains(java.net.http.HttpResponse<?> response, java.lang.Object expected, JsonUtils.SlurperConfig jsonSlurperConfig)`
	`static void`	`verifyJsonTreeContains(java.net.http.HttpResponse<?> response, java.lang.CharSequence expectedJson)` Verifies that the response JSON contains the expected subset represented as JSON text.
	`static void`	`verifyJsonTreeContains(java.net.http.HttpResponse<?> response, java.lang.CharSequence expectedJson, JsonUtils.SlurperConfig jsonSlurperConfig)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Constructor Detail
  - JsonUtils()
- Method Detail
  - static java.lang.Object parseText(java.lang.CharSequence json, JsonUtils.SlurperConfig jsonSlurperConfig)
  - static void verifyJsonTree(java.net.http.HttpResponse<?> response, java.lang.Object expected)
    
    Verifies that the response JSON is structurally equal to the expected object tree.
    Map keys are compared independent of declaration order.
    throws:
    AssertionFailedError if the JSON trees differ
    
    Parameters:
    response - HTTP response with a JSON body
    expected - expected JSON-compatible object (for example Map, List, scalar)
  - static void verifyJsonTree(java.net.http.HttpResponse<?> response, java.lang.Object expected, JsonUtils.SlurperConfig jsonSlurperConfig)
  - static void verifyJsonTree(java.net.http.HttpResponse<?> response, java.lang.CharSequence expectedJson)
    
    Verifies that the response JSON is structurally equal to the expected JSON string.
    Both sides are parsed and canonicalized before comparison, so key ordering does not affect equality.
    throws:
    AssertionFailedError if the JSON trees differ
    
    Parameters:
    response - HTTP response with a JSON body
    expectedJson - expected JSON document text
  - static void verifyJsonTree(java.net.http.HttpResponse<?> response, java.lang.CharSequence expectedJson, JsonUtils.SlurperConfig jsonSlurperConfig)
  - static void verifyJsonTreeContains(java.net.http.HttpResponse<?> response, java.lang.Object expected)
    
    Verifies that the response JSON contains the expected subset.
    Subset rules:
    - For maps, every expected key must exist and recursively match.
    - For lists, expected elements are compared by index and the actual list must be at least as large.
    - Scalar values use strict equality.
    throws:
    AssertionError if the response does not contain the expected subset
    
    Parameters:
    response - HTTP response with a JSON body
    expected - expected subset expressed as JSON-compatible objects
  - static void verifyJsonTreeContains(java.net.http.HttpResponse<?> response, java.lang.Object expected, JsonUtils.SlurperConfig jsonSlurperConfig)
  - static void verifyJsonTreeContains(java.net.http.HttpResponse<?> response, java.lang.CharSequence expectedJson)
    
    Verifies that the response JSON contains the expected subset represented as JSON text.
    throws:
    AssertionError if the response does not contain the expected subset
    
    Parameters:
    response - HTTP response with a JSON body
    expectedJson - expected subset as JSON text
  - static void verifyJsonTreeContains(java.net.http.HttpResponse<?> response, java.lang.CharSequence expectedJson, JsonUtils.SlurperConfig jsonSlurperConfig)

Summary:
Nested
Constructor
Method

| Detail:
Constructor
Method

[Groovy] Class JsonUtils

Nested Class Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

JsonUtils()

Method Detail

static java.lang.Object parseText(java.lang.CharSequence json, JsonUtils.SlurperConfig jsonSlurperConfig)

static void verifyJsonTree(java.net.http.HttpResponse<?> response, java.lang.Object expected)

static void verifyJsonTree(java.net.http.HttpResponse<?> response, java.lang.Object expected, JsonUtils.SlurperConfig jsonSlurperConfig)

static void verifyJsonTree(java.net.http.HttpResponse<?> response, java.lang.CharSequence expectedJson)

static void verifyJsonTree(java.net.http.HttpResponse<?> response, java.lang.CharSequence expectedJson, JsonUtils.SlurperConfig jsonSlurperConfig)

static void verifyJsonTreeContains(java.net.http.HttpResponse<?> response, java.lang.Object expected)

static void verifyJsonTreeContains(java.net.http.HttpResponse<?> response, java.lang.Object expected, JsonUtils.SlurperConfig jsonSlurperConfig)

static void verifyJsonTreeContains(java.net.http.HttpResponse<?> response, java.lang.CharSequence expectedJson)

static void verifyJsonTreeContains(java.net.http.HttpResponse<?> response, java.lang.CharSequence expectedJson, JsonUtils.SlurperConfig jsonSlurperConfig)