io.restassured.config.LogConfig Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of rest-assured Show documentation
Show all versions of rest-assured Show documentation
Java DSL for easy testing of REST services
/*
* Copyright 2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.restassured.config;
import io.restassured.filter.log.LogDetail;
import io.restassured.filter.log.RequestLoggingFilter;
import io.restassured.filter.log.ResponseLoggingFilter;
import io.restassured.specification.LogSpecification;
import org.apache.commons.lang3.Validate;
import java.io.PrintStream;
import java.util.*;
import java.util.stream.Collectors;
import static io.restassured.internal.common.assertion.AssertParameter.notNull;
/**
* Configure the logging for REST Assured. Note that only things known to REST Assured (i.e. the request- and response specifications) will be logged. If you need to log what's actually sent on the wire
* refer to the HTTP Client logging docs or use an external tool such as
* Wireshark.
*/
public class LogConfig implements Config {
private final PrintStream defaultPrintStream;
private final boolean prettyPrintingEnabled;
private final LogDetail logDetailIfValidationFails;
private final boolean urlEncodeRequestUri;
private final boolean isUserDefined;
private final Set headerBlacklist;
/**
* Configure the default stream to use the System.out stream (default).
*/
public LogConfig() {
this(System.out, true, null, true, new TreeSet<>(String.CASE_INSENSITIVE_ORDER), false);
}
/**
* Configure pretty printing and the default stream where logs should be written if not specified explicitly by a filter. I.e. this stream will be used in cases
* where the log specification DSL is used, e.g.
*
* given().log().all()...
*
* or
*
* expect().log.ifError(). ..
*
*
* It will not override explicit streams defined by using the {@link RequestLoggingFilter} or the {@link ResponseLoggingFilter}.
*
* @param defaultPrintStream The default print stream to use for the {@link LogSpecification}'s.
* @param prettyPrintingEnabled Enable or disable pretty printing when logging. Pretty printing is only possible when content-type is XML, JSON or HTML.
*/
public LogConfig(PrintStream defaultPrintStream, boolean prettyPrintingEnabled) {
this(defaultPrintStream, prettyPrintingEnabled, null, true, new HashSet<>(), true);
}
/**
* Configure pretty printing and the default stream where logs should be written if not specified explicitly by a filter. I.e. this stream will be used in cases
* where the log specification DSL is used, e.g.
*
* given().log().all()...
*
* or
*
* expect().log.ifError(). ..
*
*
* It will not override explicit streams defined by using the {@link RequestLoggingFilter} or the {@link ResponseLoggingFilter}.
*
* @param defaultPrintStream The default print stream to use for the {@link LogSpecification}'s.
* @param prettyPrintingEnabled Enable or disable pretty printing when logging. Pretty printing is only possible when content-type is XML, JSON or HTML.
*/
private LogConfig(PrintStream defaultPrintStream, boolean prettyPrintingEnabled, LogDetail logDetailIfValidationFails,
boolean urlEncodeRequestUri, Set headerBlacklist, boolean isUserDefined) {
Validate.notNull(defaultPrintStream, "Stream to write logs to cannot be null");
Validate.notNull(defaultPrintStream, "Stream to write logs to cannot be null");
this.defaultPrintStream = defaultPrintStream;
this.prettyPrintingEnabled = prettyPrintingEnabled;
this.logDetailIfValidationFails = logDetailIfValidationFails;
this.isUserDefined = isUserDefined;
this.urlEncodeRequestUri = urlEncodeRequestUri;
this.headerBlacklist = new TreeSet<>(String.CASE_INSENSITIVE_ORDER);
this.headerBlacklist.addAll(headerBlacklist);
}
/**
* @return The default stream to use
*/
public PrintStream defaultStream() {
return defaultPrintStream;
}
/**
* @return The blacklisted headers
* @see #blacklistHeader(String, String...)
*/
public Set blacklistedHeaders() {
return Collections.unmodifiableSet(headerBlacklist);
}
/**
* Specify a new default stream to the print to.
*
* @param printStream The stream
* @return A new LogConfig instance
*/
public LogConfig defaultStream(PrintStream printStream) {
return new LogConfig(printStream, true, logDetailIfValidationFails, urlEncodeRequestUri, headerBlacklist, true);
}
/**
* @return true if pretty printing is enabled, false otherwise.
*/
public boolean isPrettyPrintingEnabled() {
return prettyPrintingEnabled;
}
/**
* @return true if request and response logging is enabled if test validation fails, false otherwise.
*/
public boolean isLoggingOfRequestAndResponseIfValidationFailsEnabled() {
return logDetailIfValidationFails != null;
}
/**
* @return The log detail to use if request and response logging is enabled if test validation fails.
*/
public LogDetail logDetailOfRequestAndResponseIfValidationFails() {
return logDetailIfValidationFails;
}
/**
* Specify a whether or not to enable pretty printing by default.
*
* @param shouldEnable true if pretty-printing should be enabled, false otherwise.
* @return A new LogConfig instance
*/
public LogConfig enablePrettyPrinting(boolean shouldEnable) {
return new LogConfig(defaultPrintStream, shouldEnable, logDetailIfValidationFails, urlEncodeRequestUri, headerBlacklist, true);
}
/**
* Enable logging of both the request and the response if REST Assureds test validation fails.
*
* @return A new LogConfig instance
*/
public LogConfig enableLoggingOfRequestAndResponseIfValidationFails() {
return enableLoggingOfRequestAndResponseIfValidationFails(LogDetail.ALL);
}
/**
* Enable logging of both the request and the response if REST Assureds test validation fails with the specified log detail
*
* @param logDetail The log detail to show in the log
* @return A new LogConfig instance
*/
public LogConfig enableLoggingOfRequestAndResponseIfValidationFails(LogDetail logDetail) {
return new LogConfig(defaultPrintStream, prettyPrintingEnabled, logDetail, urlEncodeRequestUri, headerBlacklist, true);
}
/**
* Instruct REST Assured whether or not to URL encode the request URI when it's presented in the request specification log.
* By default url encoding of the request uri is enabled to show what the URL targeted by REST Assured actually looks like for real.
* But there may be cases where you want to make the URI more readable and this is when you might want to consider setting
* urlEncodeRequestUri to false. Note that this only affects logging.
*
* @param urlEncodeRequestUri Whether or not to url encode the request uri when it's presented in the request log
* @return A new LogConfig instance
*/
public LogConfig urlEncodeRequestUri(boolean urlEncodeRequestUri) {
return new LogConfig(defaultPrintStream, prettyPrintingEnabled, logDetailIfValidationFails, urlEncodeRequestUri, headerBlacklist, true);
}
/**
* Blacklist one or more headers. If these headers show up during logging they will be replaced with 'HIDDEN'. The purpose of a blacklist is to prevent sensitive information
* to be included in the log.
*
* @param header The header to include in the blacklist
* @param otherHeaders Additional headers to include in the blacklist (optional)
* @return A new LogConfig instance
*/
public LogConfig blacklistHeader(String header, String... otherHeaders) {
notNull(header, "header");
Set newHeaderBlackList = new TreeSet<>(String.CASE_INSENSITIVE_ORDER);
newHeaderBlackList.addAll(headerBlacklist);
newHeaderBlackList.add(header);
if (otherHeaders != null && otherHeaders.length > 0) {
Collections.addAll(newHeaderBlackList, otherHeaders);
}
return new LogConfig(defaultPrintStream, prettyPrintingEnabled, logDetailIfValidationFails, urlEncodeRequestUri, newHeaderBlackList, true);
}
/**
* Blacklist one or more headers. If these headers show up during logging they will be hidden. The purpose of a blacklist is to prevent sensitive information
* to be included in the log. Note that this method replaces the previously defined blacklist.
*
* @param headers The headers to include in the blacklist
* @return A new LogConfig instance
*/
public LogConfig blacklistHeaders(Collection headers) {
notNull(headers, "headers");
Set newHeaderBlackList = headers.stream().filter(Objects::nonNull).collect(Collectors.toSet());
return new LogConfig(defaultPrintStream, prettyPrintingEnabled, logDetailIfValidationFails, urlEncodeRequestUri, newHeaderBlackList, true);
}
/**
* Add the following sensitive headers to be excluded from the request log:
*
* Authorization Cookie Proxy-Authorization
*
* @return A new LogConfig instance
*/
public LogConfig blacklistDefaultSensitiveHeaders() {
headerBlacklist.add("Authorization");
headerBlacklist.add("Proxy-Authorization");
headerBlacklist.add("Cookie");
return new LogConfig(defaultPrintStream, prettyPrintingEnabled, logDetailIfValidationFails, urlEncodeRequestUri, headerBlacklist, true);
}
/**
* @return true is the request URI should be URL encoded in the request log
*/
public boolean shouldUrlEncodeRequestUri() {
return urlEncodeRequestUri;
}
/**
* @return A static way to create a new LogConfig instance without calling "new" explicitly. Mainly for syntactic sugar.
*/
public static LogConfig logConfig() {
return new LogConfig();
}
/**
* Syntactic sugar.
*
* @return The same log config instance.
*/
public LogConfig and() {
return this;
}
public boolean isUserConfigured() {
return isUserDefined;
}
}