How to use CarinaRequestBodyLoggingFilter class of com.qaprosoft.carina.core.foundation.api.log package

...44import com.qaprosoft.carina.core.foundation.api.http.ContentTypeEnum;45import com.qaprosoft.carina.core.foundation.api.http.HttpClient;46import com.qaprosoft.carina.core.foundation.api.http.HttpMethodType;47import com.qaprosoft.carina.core.foundation.api.http.HttpResponseStatusType;48import com.qaprosoft.carina.core.foundation.api.log.CarinaRequestBodyLoggingFilter;49import com.qaprosoft.carina.core.foundation.api.log.CarinaResponseBodyLoggingFilter;50import com.qaprosoft.carina.core.foundation.api.log.LoggingOutputStream;51import com.qaprosoft.carina.core.foundation.api.ssl.NullHostnameVerifier;52import com.qaprosoft.carina.core.foundation.api.ssl.NullX509TrustManager;53import com.qaprosoft.carina.core.foundation.api.ssl.SSLContextBuilder;54import com.qaprosoft.carina.core.foundation.utils.Configuration;55import com.qaprosoft.carina.core.foundation.utils.Configuration.Parameter;56import com.qaprosoft.carina.core.foundation.utils.R;57import io.restassured.RestAssured;58import io.restassured.config.RestAssuredConfig;59import io.restassured.config.SSLConfig;60import io.restassured.filter.log.LogDetail;61import io.restassured.filter.log.RequestLoggingFilter;62import io.restassured.filter.log.ResponseLoggingFilter;63import io.restassured.response.Response;64import io.restassured.specification.RequestSpecification;65public abstract class AbstractApiMethod extends HttpClient {66    private static final Logger LOGGER = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());67    private StringBuilder bodyContent = null;68    protected String methodPath = null;69    protected HttpMethodType methodType = null;70    protected Object response;71    public RequestSpecification request;72    protected ContentTypeEnum contentTypeEnum;73    private boolean logRequest = Configuration.getBoolean(Parameter.LOG_ALL_JSON);74    private boolean logResponse = Configuration.getBoolean(Parameter.LOG_ALL_JSON);75    private boolean ignoreSSL = Configuration.getBoolean(Parameter.IGNORE_SSL);76    public AbstractApiMethod() {77        init(getClass());78        bodyContent = new StringBuilder();79        request = given();80        initContentTypeFromAnnotation();81        replaceUrlPlaceholders();82    }83    @SuppressWarnings({ "rawtypes" })84    private void init(Class clazz) {85        Endpoint e = this.getClass().getAnnotation(Endpoint.class);86        if (e != null) {87            methodType = e.methodType();88            methodPath = e.url();89            return;90        }91        String typePath = R.API.get(clazz.getSimpleName());92        if (typePath == null) {93            throw new RuntimeException("Method type and path are not specified for: " + clazz.getSimpleName());94        }95        if (typePath.contains(":")) {96            methodType = HttpMethodType.valueOf(typePath.split(":")[0]);97            methodPath = StringUtils.substringAfter(typePath, methodType + ":");98        } else {99            methodType = HttpMethodType.valueOf(typePath);100        }101    }102    private void initContentTypeFromAnnotation() {103        ContentType contentTypeA = this.getClass().getAnnotation(ContentType.class);104        if (contentTypeA == null) {105            contentTypeEnum = ContentTypeEnum.JSON;106            this.request.contentType(ContentTypeEnum.JSON.getStringValues()[0]);107            return;108        }109        if (ArrayUtils.contains(ContentTypeEnum.JSON.getStringValues(), contentTypeA.type())) {110            contentTypeEnum = ContentTypeEnum.JSON;111        } else if (ArrayUtils.contains(ContentTypeEnum.XML.getStringValues(), contentTypeA.type())) {112            contentTypeEnum = ContentTypeEnum.XML;113        } else {114            contentTypeEnum = ContentTypeEnum.NA;115        }116        this.request.contentType(contentTypeA.type());117    }118    private void replaceUrlPlaceholders() {119        final String envParam = "config.env.";120        final String configParam = "config.";121        List<String> params = getParamsFromUrl();122        for (String param : params) {123            if (param.startsWith(envParam)) {124                String newParam = StringUtils.substringAfter(param, envParam);125                replaceUrlPlaceholder(param, Configuration.getEnvArg(newParam));126            } else if (param.startsWith(configParam)) {127                String newParam = StringUtils.substringAfter(param, configParam);128                replaceUrlPlaceholder(param, R.CONFIG.get(newParam));129            }130        }131    }132    private List<String> getParamsFromUrl() {133        List<String> params = new ArrayList<>();134        String path = methodPath;135        while (path.contains("{")) {136            String param = StringUtils.substringBetween(path, "${", "}");137            params.add(param);138            path = StringUtils.substringAfter(path, "}");139        }140        return params;141    }142    public void setHeaders(String... headerKeyValues) {143        for (String headerKeyValue : headerKeyValues) {144            String key = headerKeyValue.split("=", 2)[0];145            String value = headerKeyValue.split("=", 2)[1];146            request.header(key, value);147        }148    }149    public void addUrlParameter(String key, String value) {150        if (value != null) {151            request.queryParam(key, value);152        }153    }154    public void addParameter(String key, String value) {155        request.param(key, value.replace(" ", "%20"));156    }157    public void addParameterIfNotNull(String key, String value) {158        if (value != null) {159            this.addParameter(key, value);160        }161    }162    public void addBodyParameter(String key, Object value) {163        if (bodyContent.length() != 0) {164            bodyContent.append("&");165        }166        bodyContent.append(key + "=" + value);167    }168    protected void addBodyParameterIfNotNull(String key, Object value) {169        if (value != null) {170            addBodyParameter(key, value);171        }172    }173    public void addCookie(String key, String value) {174        request.given().cookie(key, value);175    }176    public void addCookies(Map<String, String> cookies) {177        request.given().cookies(cookies);178    }179    public void replaceUrlPlaceholder(String placeholder, String value) {180        if (value != null) {181            methodPath = methodPath.replace("${" + placeholder + "}", value);182        } else {183            methodPath = methodPath.replace("${" + placeholder + "}", "");184            methodPath = StringUtils.removeEnd(methodPath, "/");185        }186    }187    public void expectResponseStatus(HttpResponseStatusType status) {188        request.expect().statusCode(status.getCode());189        request.expect().statusLine(Matchers.containsString(status.getMessage()));190    }191    public <T> void expectResponseContains(Matcher<T> key, Matcher<T> value) {192        request.expect().body(key, value);193    }194    public void expectValueByXpath(String xPath, String value) {195        request.expect().body(Matchers.hasXPath(xPath), Matchers.containsString(value));196    }197    public void expectValueByXpath(String xPath, String value1, String value2) {198        request.expect().body(Matchers.hasXPath(xPath), Matchers.anyOf(Matchers.containsString(value1), Matchers.containsString(value2)));199    }200    public <T> void expectResponseContains(Matcher<T> value) {201        request.expect().body(value);202    }203    public <T> void expectResponseContains(String key, Matcher<T> value) {204        request.expect().body(key, value);205    }206    public <T> void expectResponseContainsXpath(String xPath) {207        request.expect().body(HasXPath.hasXPath(xPath));208    }209    private void initLogging(PrintStream ps) {210        if (logRequest) {211            HideRequestHeadersInLogs hideHeaders = this.getClass().getAnnotation(HideRequestHeadersInLogs.class);212            RequestLoggingFilter fHeaders = new RequestLoggingFilter(LogDetail.HEADERS, true, ps, true,213                    hideHeaders == null ? Collections.emptySet() : new HashSet<String>(Arrays.asList(hideHeaders.headers())));214            RequestLoggingFilter fCookies = new RequestLoggingFilter(LogDetail.COOKIES, ps);215            RequestLoggingFilter fParams = new RequestLoggingFilter(LogDetail.PARAMS, ps);216            RequestLoggingFilter fMethod = new RequestLoggingFilter(LogDetail.METHOD, ps);217            RequestLoggingFilter fUri = new RequestLoggingFilter(LogDetail.URI, ps);218            RequestLoggingFilter fBody;219            HideRequestBodyPartsInLogs hideRqBody = this.getClass().getAnnotation(HideRequestBodyPartsInLogs.class);220            if (hideRqBody != null) {221                fBody = new CarinaRequestBodyLoggingFilter(true, ps, new HashSet<String>(Arrays.asList(hideRqBody.paths())), contentTypeEnum);222            } else {223                fBody = new RequestLoggingFilter(LogDetail.BODY, ps);224            }225            request.filters(fMethod, fUri, fParams, fCookies, fHeaders, fBody);226        }227        if (logResponse) {228            ResponseLoggingFilter fStatus = new ResponseLoggingFilter(LogDetail.STATUS, ps);229            ResponseLoggingFilter fHeaders = new ResponseLoggingFilter(LogDetail.HEADERS, ps);230            ResponseLoggingFilter fCookies = new ResponseLoggingFilter(LogDetail.COOKIES, ps);231            ResponseLoggingFilter fBody;232            HideResponseBodyPartsInLogs a = this.getClass().getAnnotation(HideResponseBodyPartsInLogs.class);233            if (a != null) {234                fBody = new CarinaResponseBodyLoggingFilter(true, ps, Matchers.any(Integer.class), new HashSet<String>(Arrays.asList(a.paths())),235                        contentTypeEnum);...

...23import io.restassured.filter.log.RequestLoggingFilter;24import io.restassured.response.Response;25import io.restassured.specification.FilterableRequestSpecification;26import io.restassured.specification.FilterableResponseSpecification;27public class CarinaRequestBodyLoggingFilter extends RequestLoggingFilter {28    private final PrintStream stream;29    private final boolean shouldPrettyPrint;30    private final Set<String> hiddenPaths;31    private final ContentTypeEnum contentType;32    public CarinaRequestBodyLoggingFilter(boolean shouldPrettyPrint, PrintStream stream, Set<String> hiddenPaths, ContentTypeEnum contentType) {33        Validate.notNull(stream, "Print stream cannot be null");34        this.stream = stream;35        this.shouldPrettyPrint = shouldPrettyPrint;36        this.hiddenPaths = new HashSet<>(hiddenPaths);37        this.contentType = contentType;38    }39    @Override40    public Response filter(FilterableRequestSpecification requestSpec, FilterableResponseSpecification responseSpec, FilterContext ctx) {41        CarinaBodyPrinter.printRequestBody(requestSpec, stream, shouldPrettyPrint, hiddenPaths, contentType);42        return ctx.next(requestSpec, responseSpec);43    }44}...

1import com.qaprosoft.carina.core.foundation.api.AbstractApiMethodV2;2import com.qaprosoft.carina.core.foundation.api.log.CarinaRequestBodyLoggingFilter;3import com.qaprosoft.carina.core.foundation.api.log.CarinaResponseBodyLoggingFilter;4import com.qaprosoft.carina.core.foundation.api.log.CarinaRequestLoggingFilter;5import com.qaprosoft.carina.core.foundation.api.log.CarinaResponseLoggingFilter;6import com.qaprosoft.carina.core.foundation.utils.Configuration;7import com.qaprosoft.carina.core.foundation.utils.Configuration.Parameter;8import com.qaprosoft.carina.core.foundation.utils.R;9import com.qaprosoft.carina.core.foundation.utils.ownership.MethodOwner;10import com.qaprosoft.carina.core.foundation.utils.resources.L10N;11import com.qaprosoft.carina.core.foundation.utils.resources.L10N.L10NData;12import com.qaprosoft.carina.core.foundation.utils.resources.L10N

1String logFileName = "api-requests.log";2CarinaRequestBodyLoggingFilter filter = new CarinaRequestBodyLoggingFilter(logFileName);3RestAssured.filters(filter);4RestAssured.filters(new CarinaResponseBodyLoggingFilter(logFileName));5String logFileName = "api-requests.log";6CarinaRequestBodyLoggingFilter filter = new CarinaRequestBodyLoggingFilter(logFileName);7RestAssured.filters(filter);8RestAssured.filters(new CarinaResponseBodyLoggingFilter(logFileName));9String logFileName = "api-requests.log";10CarinaRequestBodyLoggingFilter filter = new CarinaRequestBodyLoggingFilter(logFileName);11RestAssured.filters(filter);12RestAssured.filters(new CarinaResponseBodyLoggingFilter(logFileName));13String logFileName = "api-requests.log";14CarinaRequestBodyLoggingFilter filter = new CarinaRequestBodyLoggingFilter(logFileName);15RestAssured.filters(filter);16RestAssured.filters(new CarinaResponseBodyLoggingFilter(logFileName));17String logFileName = "api-requests.log";18CarinaRequestBodyLoggingFilter filter = new CarinaRequestBodyLoggingFilter(logFileName);19RestAssured.filters(filter);20RestAssured.filters(new CarinaResponseBodyLoggingFilter(logFileName));

1package com.qaprosoft.carina.core.foundation.api.log;2import org.slf4j.Logger;3import org.slf4j.LoggerFactory;4import javax.ws.rs.client.ClientRequestContext;5import javax.ws.rs.client.ClientRequestFilter;6import javax.ws.rs.core.MediaType;7import java.io.IOException;8import java.io.InputStream;9import java.util.Scanner;10public class CarinaRequestBodyLoggingFilter implements ClientRequestFilter {11    private static final Logger LOGGER = LoggerFactory.getLogger(CarinaRequestBodyLoggingFilter.class);12    public void filter(ClientRequestContext requestContext) throws IOException {13        if (requestContext.hasEntity() && requestContext.getMediaType().equals(MediaType.APPLICATION_JSON_TYPE)) {14            InputStream stream = (InputStream) requestContext.getEntityStream();15            String body = new Scanner(stream, "UTF-8").useDelimiter("\\A").next();16            LOGGER.debug("Request body: " + body);17            requestContext.setEntityStream(stream);18        }19    }20}21package com.qaprosoft.carina.core.foundation.api.log;22import org.slf4j.Logger;23import org.slf4j.LoggerFactory;24import javax.ws.rs.client.ClientRequestContext;25import javax.ws.rs.client.ClientRequestFilter;26import javax.ws.rs.client.ClientResponseContext;27import javax.ws.rs.client.ClientResponseFilter;28import javax.ws.rs.core.MediaType;29import java.io.IOException;30import java.io.InputStream;31import java.util.Scanner;32public class CarinaResponseBodyLoggingFilter implements ClientResponseFilter {33    private static final Logger LOGGER = LoggerFactory.getLogger(CarinaResponseBodyLoggingFilter.class);34    public void filter(ClientRequestContext requestContext, ClientResponseContext responseContext) throws IOException {35        if (responseContext.hasEntity() && responseContext.getMediaType().equals(MediaType.APPLICATION_JSON_TYPE)) {36            InputStream stream = (InputStream) responseContext.getEntityStream();37            String body = new Scanner(stream, "UTF-8").useDelimiter("\\A").next();38            LOGGER.debug("Response body: " + body