Class BasicJsonTester
java.lang.Object
org.springframework.boot.test.json.BasicJsonTester
AssertJ based JSON tester that works with basic JSON strings. Allows testing of JSON
payloads created from any source, for example:
public class ExampleObjectJsonTests { private BasicJsonTester json = new BasicJsonTester(getClass()); @Test public void testWriteJson() throws IOException { assertThat(json.from("example.json")).extractingJsonPathStringValue("@.name") .isEqualTo("Spring"); } }See
AbstractJsonMarshalTester
for more details.- Since:
- 1.4.0
- Author:
- Phillip Webb, Andy Wilkinson
-
Constructor Summary
ModifierConstructorDescriptionprotected
Create a new uninitializedBasicJsonTester
instance.BasicJsonTester
(Class<?> resourceLoadClass) Create a newBasicJsonTester
instance that will load resources as UTF-8.BasicJsonTester
(Class<?> resourceLoadClass, Charset charset) Create a newBasicJsonTester
instance. -
Method Summary
Modifier and TypeMethodDescriptionfrom
(byte[] source) Create JSON content from the specified JSON bytes.Create JSON content from the specified JSON file.from
(InputStream source) Create JSON content from the specified JSON input stream.from
(CharSequence source) Create JSON content from the specified String source.Create JSON content from the specified resource path.Create JSON content from the specified JSON resource.protected final void
initialize
(Class<?> resourceLoadClass) Initialize the marshal tester for use, configuring it to load JSON resources as UTF-8.protected final void
initialize
(Class<?> resourceLoadClass, Charset charset) Initialize the marshal tester for use.
-
Constructor Details
-
BasicJsonTester
protected BasicJsonTester()Create a new uninitializedBasicJsonTester
instance. -
BasicJsonTester
Create a newBasicJsonTester
instance that will load resources as UTF-8.- Parameters:
resourceLoadClass
- the source class used to load resources
-
BasicJsonTester
Create a newBasicJsonTester
instance.- Parameters:
resourceLoadClass
- the source class used to load resourcescharset
- the charset used to load resources- Since:
- 1.4.1
-
-
Method Details
-
initialize
Initialize the marshal tester for use, configuring it to load JSON resources as UTF-8.- Parameters:
resourceLoadClass
- the source class used when loading relative classpath resources
-
initialize
Initialize the marshal tester for use.- Parameters:
resourceLoadClass
- the source class used when loading relative classpath resourcescharset
- the charset used when loading relative classpath resources- Since:
- 1.4.1
-
from
Create JSON content from the specified String source. The source can contain the JSON itself or, if it ends with.json
, the name of a resource to be loaded usingresourceLoadClass
.- Parameters:
source
- the JSON content or a.json
resource name- Returns:
- the JSON content
-
from
Create JSON content from the specified resource path.- Parameters:
path
- the path of the resource to loadresourceLoadClass
- the source class used to load the resource- Returns:
- the JSON content
-
from
Create JSON content from the specified JSON bytes.- Parameters:
source
- the bytes of JSON- Returns:
- the JSON content
-
from
Create JSON content from the specified JSON file.- Parameters:
source
- the file containing JSON- Returns:
- the JSON content
-
from
Create JSON content from the specified JSON input stream.- Parameters:
source
- the input stream containing JSON- Returns:
- the JSON content
-
from
Create JSON content from the specified JSON resource.- Parameters:
source
- the resource containing JSON- Returns:
- the JSON content
-