Skip to content

Api assured method improvement #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Api assured method improvement #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
22ad9eb
error response type update
egecansen Mar 12, 2025
531b61a
Update pom.xml
egecansen Mar 12, 2025
eaddf73
Merge branch 'main' into api_assured_method_improvement
egecansen Apr 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 26 additions & 13 deletions src/main/java/api_assured/Caller.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,22 @@

import api_assured.exceptions.FailedCallException;
import com.fasterxml.jackson.core.JsonProcessingException;
import okhttp3.ResponseBody;
import okio.Buffer;
import properties.PropertyUtilities;
import retrofit2.Call;
import retrofit2.Response;
import utils.*;
import utils.mapping.MappingUtilities;
import utils.reflection.ReflectionUtilities;

import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.Objects;

import static utils.mapping.MappingUtilities.Json.*;
import static utils.MappingUtilities.Json.*;
import static utils.reflection.ReflectionUtilities.getPreviousMethodName;
import static utils.StringUtilities.Color.*;
import static utils.reflection.ReflectionUtilities.isOfType;

/**
* This abstract class represents a caller that performs API calls, logs the results and returns objects in response bodies.
Expand All @@ -32,7 +34,7 @@ public abstract class Caller {
/**
* A static boolean variable that determines whether logs should be kept for API calls.
*/
public static boolean keepLogs;
protected static boolean keepLogs;

/**
* A Printer object for logging.
Expand Down Expand Up @@ -143,16 +145,18 @@ private static <T> Response<T> getResponse(Call<T> call, boolean printBody) thro
if (keepLogs) log.success("The response code is: " + response.code());
if (keepLogs && !response.message().isEmpty()) log.info(response.message());
if (printBody && printableResponse) log.info("The response body is: \n" + getJsonString(body));
assert body != null;
return Response.success(body, response.raw());
}
else {
log.warning("The response code is: " + response.code());
if (!response.message().isEmpty()) log.warning(response.message());
assert response.errorBody() != null;
if (printBody) {
Object errorBody = getJsonString(getErrorObject(response, Object.class));
String errorLog = errorBody.equals("null") ? "The error body is empty." : "The error body is: \n" + errorBody;
if (response.message().length()>0) log.warning(response.message());
if (response.errorBody() != null && printBody) {
Object errorBody = isOfType(response, Object.class) ?
getJsonString(getErrorObject(response, Object.class)) :
response.raw();
String errorLog = errorBody.equals("null") ?
"The error body is empty." :
"The error body is: \n" + errorBody;
log.warning(errorLog);
}
return Response.error(response.errorBody(), response.raw());
Expand All @@ -173,12 +177,18 @@ private static <T> Response<T> getResponse(Call<T> call, boolean printBody) thro
*
* @see MappingUtilities.Json#fromJsonString(String, Class)
*/
@SuppressWarnings("unchecked")
private static <ErrorModel> ErrorModel getErrorObject(Response<?> response, Class<ErrorModel> errorModel) throws JsonProcessingException {
assert response.errorBody() != null;
if (errorModel.isAssignableFrom(ResponseBody.class))
return (ErrorModel) response.errorBody();
try (Buffer errorBuffer = response.errorBody().source().getBuffer().clone()) {
String bodyString = errorBuffer.readString(StandardCharsets.UTF_8);
if (!StringUtilities.isBlank(bodyString))
return fromJsonString(bodyString, errorModel);
if (!StringUtilities.isBlank(bodyString)) {
if (errorModel.isAssignableFrom(String.class))
return (ErrorModel) bodyString;
else return fromJsonString(bodyString, errorModel);
}
else
return null;
}
Expand Down Expand Up @@ -249,9 +259,12 @@ private static <ResponseModel> Response<ResponseModel> call(
*/
@SuppressWarnings("unchecked")
private static <ErrorModel> ErrorModel getErrorBody(Response<?> response, Class<?>... errorModels){
for (Class<?> errorModel:errorModels){
for (Class<?> errorClass:errorModels){
try {
return (ErrorModel) fromJsonString(getJsonStringFor(getErrorObject(response, errorModel)), errorModel);
ErrorModel errorModel = (ErrorModel) getErrorObject(response, errorClass);
assert errorModel != null;
if (errorClass.isAssignableFrom(errorModel.getClass()))
return errorModel;
}
catch (JsonProcessingException ignored) {}
}
Expand Down
38 changes: 35 additions & 3 deletions src/main/java/utils/reflection/ReflectionUtilities.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,7 @@ public static <T> JsonObject getJsonObject(Class<T> clazz, JsonObject json, Stri
field.setAccessible(true);
if (Arrays.stream(exceptions).noneMatch(exception -> exception.equals(field.getName()))) {
boolean isMember = field.getType().isMemberClass();
boolean isList = isOfType(field, "List");
boolean isList = fieldIsOfType(field, "List");
if (isMember)
json.add(field.getName(), getJsonObject(field.getType(), new JsonObject(), exceptions));
else if (isList)
Expand Down Expand Up @@ -547,7 +547,7 @@ public static <T> JsonObject getJsonFromObject(T object, JsonObject json, String
field.setAccessible(true);
if (Arrays.stream(exceptions).noneMatch(exception -> exception.equals(field.getName()))) {
boolean isMember = field.getType().isMemberClass();
boolean isList = isOfType(field, "List");
boolean isList = fieldIsOfType(field, "List");

if (isMember)
json.add(field.getName(), getJsonFromObject(field, new JsonObject(), exceptions));
Expand All @@ -567,10 +567,42 @@ else if (isList)
* @param expectedType expected field type
* @return true or false
*/
public static boolean isOfType(Field field, String expectedType) {
public static boolean fieldIsOfType(Field field, String expectedType) {
return field.getType().getTypeName().contains(expectedType);
}

/**
* Verifies type of given object
*
* @param object target object
* @param type expected object type
* @return true or false
*/
public static <Type> boolean isOfType(Type object, Class<Type> type) {
try {
String jsonString = MappingUtilities.Json.getJsonStringFor(object);
return isOfType(jsonString, type);
} catch (IllegalArgumentException e) {
return false;
}
}

/**
* Verifies type of given object
*
* @param objectString expected object string
* @param type expected object type
* @return true or false
*/
public static <Type> boolean isOfType(String objectString, Class<Type> type) {
try {
MappingUtilities.Json.fromJsonString(objectString, type);
return true;
} catch (JsonProcessingException | IllegalArgumentException e) {
return false;
}
}

/**
* Acquires the type of given field
*
Expand Down