io.apimatic.core.utilities

Class TestHelper

java.lang.Object

io.apimatic.core.utilities.TestHelper

public final class TestHelper
extends Object

Contains utility methods for comparing objects, arrays and files.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NULL_STRING GUID to represent NUll string.

Method Summary

Modifier and Type	Method and Description
static boolean	areHeadersProperSubsetOf(Map<String,String> leftTree, Map<String,String> rightTree, boolean checkValues) Recursively check whether the left headers map is a proper subset of the right headers map.
static boolean	containsBigDecimalList(List<BigDecimal> actual, List<BigDecimal> expected) Checks actual list against expected list, without considering order of elements and actual.
static String	convertStreamToString(InputStream is) Convert an InputStream to a String (utility function).
static boolean	equalsBigDecimalList(List<BigDecimal> actual, List<BigDecimal> expected) Checks actual list against expected list to have same order and count and all corresponding values must be equal.
static File	getFile(String urlString) Downloads a given url and return a path to its local version.
static boolean	isArrayOfArrayOfJsonObjectsProperSubsetOf(String leftObject, String rightObject, boolean checkValues, boolean allowExtra, boolean isOrdered) Check if left array of array of objects is a subset of right array of array of objects.
static boolean	isArrayOfJsonObjectsProperSubsetOf(String leftObject, String rightObject, boolean checkValues, boolean allowExtra, boolean isOrdered) Check if left array of objects is a subset of right array.
static boolean	isJsonObjectProperSubsetOf(String leftObject, String rightObject, boolean checkValues, boolean allowExtra, boolean isOrdered) Recursively check whether the left JSON object is a proper subset of the right JSON object.
static boolean	isProperSubsetOf(String leftObject, String rightObject, boolean checkValues, boolean allowExtra, boolean isOrdered) Utility to delegate call to suitable method.
static boolean	isSameAsFile(String file, InputStream input) Compare the input stream to file byte-by-byte.
static <T> String	prepareForComparison(String json, com.fasterxml.jackson.core.type.TypeReference<T> typeReference) Modify a json String according to a given TypeReference, ensuring that inner fields are dealt with properly.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NULL_STRING

public static final String NULL_STRING

GUID to represent NUll string.

See Also:

Constant Field Values

Method Detail

prepareForComparison

public static <T> String prepareForComparison(String json,
                                              com.fasterxml.jackson.core.type.TypeReference<T> typeReference)
                                       throws com.fasterxml.jackson.core.JsonProcessingException,
                                              IOException

Modify a json String according to a given TypeReference, ensuring that inner fields are dealt with properly.

Type Parameters:

T - The extended type.

Parameters:

json - The json String to modify.

typeReference - The TypeReference to use.

Returns:

The modified json String.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - when problems encountered when processing (parsing, generating) JSON content.

IOException - if comparison got failed.

convertStreamToString

public static String convertStreamToString(InputStream is)

Convert an InputStream to a String (utility function).

Parameters:

is - Input stream to read from.

Returns:

All data.

isProperSubsetOf

public static boolean isProperSubsetOf(String leftObject,
                                       String rightObject,
                                       boolean checkValues,
                                       boolean allowExtra,
                                       boolean isOrdered)
                                throws IOException

Utility to delegate call to suitable method.

Parameters:

leftObject - Left array as a JSON string.

rightObject - Right array as a JSON string.

checkValues - Check primitive values for equality?.

allowExtra - Are extra elements allowed in right array?.

isOrdered - Should elements in right be compared in order to left?.

Returns:

True if it is a subset.

Throws:

IOException - if deserialization got failed.

isJsonObjectProperSubsetOf

public static boolean isJsonObjectProperSubsetOf(String leftObject,
                                                 String rightObject,
                                                 boolean checkValues,
                                                 boolean allowExtra,
                                                 boolean isOrdered)
                                          throws IOException

Recursively check whether the left JSON object is a proper subset of the right JSON object.

Parameters:

leftObject - Left JSON object as string.

rightObject - Right JSON object as string.

checkValues - Check primitive values for equality?.

allowExtra - extra value is allowed?.

isOrdered - object value is in order?.

Returns:

true if left left JSON object is a proper subset of right JSON object.

Throws:

IOException - Signal that I/O errors occur.

isArrayOfArrayOfJsonObjectsProperSubsetOf

public static boolean isArrayOfArrayOfJsonObjectsProperSubsetOf(String leftObject,
                                                                String rightObject,
                                                                boolean checkValues,
                                                                boolean allowExtra,
                                                                boolean isOrdered)
                                                         throws IOException

Check if left array of array of objects is a subset of right array of array of objects.

Parameters:

leftObject - Left array as a JSON string.

rightObject - Right array as a JSON string.

checkValues - Check primitive values for equality?.

allowExtra - Are extra elements allowed in right array?.

isOrdered - Should elements in right be compared in order to left?.

Returns:

True if it is a subset.

Throws:

IOException - if deserialization got failed.

isArrayOfJsonObjectsProperSubsetOf

public static boolean isArrayOfJsonObjectsProperSubsetOf(String leftObject,
                                                         String rightObject,
                                                         boolean checkValues,
                                                         boolean allowExtra,
                                                         boolean isOrdered)
                                                  throws IOException

Check if left array of objects is a subset of right array.

Parameters:

leftObject - Left array as a JSON string.

rightObject - Right array as a JSON string.

checkValues - Check primitive values for equality?.

allowExtra - Are extra elements allowed in right array?.

isOrdered - Should elements in right be compared in order to left?.

Returns:

True if it is a subset.

Throws:

IOException - if deserialization got failed.

areHeadersProperSubsetOf

public static boolean areHeadersProperSubsetOf(Map<String,String> leftTree,
                                               Map<String,String> rightTree,
                                               boolean checkValues)

Recursively check whether the left headers map is a proper subset of the right headers map.

Parameters:

leftTree - Left headers map.

rightTree - Right headers map.

checkValues - Check header values for equality?.

Returns:

true if left headers map is a proper subset of right headers map.

isSameAsFile

public static boolean isSameAsFile(String file,
                                   InputStream input)
                            throws FileNotFoundException,
                                   IOException

Compare the input stream to file byte-by-byte.

Parameters:

file - First input.

input - Second input.

Returns:

true True if stream contains the same content as the file.

Throws:

IOException - If error reading either stream.

FileNotFoundException - If file could not be opened.

getFile

public static File getFile(String urlString)
                    throws IOException

Downloads a given url and return a path to its local version. Files are cached. Second call for the same URL will return cached version. Files are deleted when VM exits.

Parameters:

urlString - URL to download.

Returns:

Absolute path to the local downloaded version of file.

Throws:

IOException - Signals that I/O error occur.

equalsBigDecimalList

public static boolean equalsBigDecimalList(List<BigDecimal> actual,
                                           List<BigDecimal> expected)

Checks actual list against expected list to have same order and count and all corresponding values must be equal.

Parameters:

actual - List of BigDecimal.

expected - List of BigDecimal.

Returns:

true if both lists are exactly same.

containsBigDecimalList

public static boolean containsBigDecimalList(List<BigDecimal> actual,
                                             List<BigDecimal> expected)

Checks actual list against expected list, without considering order of elements and actual. list must have all the expected elements.

Parameters:

actual - List of BigDecimal.

expected - List of BigDecimal.

Returns:

true if actual list is a super set of expected list.