Skip to content

Commit bd452a3

Browse files
antonfilichkinantonfilichkin
committed
Removed configuration option - always follow RestAssured log config.
1 parent 194219b commit bd452a3

File tree

2 files changed

+20
-33
lines changed

2 files changed

+20
-33
lines changed

‎allure-rest-assured/src/main/java/io/qameta/allure/restassured/AllureRestAssured.java‎

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,13 @@
4343
*/
4444
public class AllureRestAssured implements OrderedFilter {
4545

46-
private static final String BLACKLISTED = "[ BLACKLISTED ]";
46+
private static final String HIDDEN_PLACEHOLDER = "[ BLACKLISTED ]";
4747

4848
private String requestTemplatePath = "http-request.ftl";
4949
private String responseTemplatePath = "http-response.ftl";
5050
private String requestAttachmentName = "Request";
5151
private String responseAttachmentName;
5252

53-
private boolean followHeadersBlacklist = true;
54-
5553
public AllureRestAssured setRequestTemplate(final String templatePath) {
5654
this.requestTemplatePath = templatePath;
5755
return this;
@@ -72,16 +70,6 @@ public AllureRestAssured setResponseAttachmentName(final String responseAttachme
7270
return this;
7371
}
7472

75-
/**
76-
* Configure filter to consider headers that are blacklisted by RestAssured LogConfig. Enabled by default.
77-
* @see io.restassured.config.LogConfig#blacklistHeader
78-
* @see io.restassured.config.LogConfig#blacklistHeaders
79-
*/
80-
public AllureRestAssured followHeadersBlacklist(final boolean isEnabled) {
81-
this.followHeadersBlacklist = isEnabled;
82-
return this;
83-
}
84-
8573
/**
8674
* @deprecated use {@link #setRequestTemplate(String)} instead.
8775
* Scheduled for removal in 3.0 release.
@@ -107,14 +95,12 @@ public Response filter(final FilterableRequestSpecification requestSpec,
10795
final Prettifier prettifier = new Prettifier();
10896
final String url = requestSpec.getURI();
10997

110-
final Set<String> blacklistedHeaders = new TreeSet<>(String.CASE_INSENSITIVE_ORDER);
111-
if (followHeadersBlacklist) {
112-
blacklistedHeaders.addAll(Objects.requireNonNull(requestSpec.getConfig().getLogConfig().blacklistedHeaders()));
113-
}
98+
final Set<String> hiddenHeaders = new TreeSet<>(String.CASE_INSENSITIVE_ORDER);
99+
hiddenHeaders.addAll(Objects.requireNonNull(requestSpec.getConfig().getLogConfig().blacklistedHeaders()));
114100

115101
final HttpRequestAttachment.Builder requestAttachmentBuilder = create(requestAttachmentName, url)
116102
.setMethod(requestSpec.getMethod())
117-
.setHeaders(toMapConverter(requestSpec.getHeaders(), blacklistedHeaders))
103+
.setHeaders(toMapConverter(requestSpec.getHeaders(), hiddenHeaders))
118104
.setCookies(toMapConverter(requestSpec.getCookies(), new HashSet<>()));
119105

120106
if (Objects.nonNull(requestSpec.getBody())) {
@@ -139,7 +125,7 @@ public Response filter(final FilterableRequestSpecification requestSpec,
139125

140126
final HttpResponseAttachment responseAttachment = create(attachmentName)
141127
.setResponseCode(response.getStatusCode())
142-
.setHeaders(toMapConverter(response.getHeaders(), blacklistedHeaders))
128+
.setHeaders(toMapConverter(response.getHeaders(), hiddenHeaders))
143129
.setBody(prettifier.getPrettifiedBodyIfPossible(response, response.getBody()))
144130
.build();
145131

@@ -151,9 +137,9 @@ public Response filter(final FilterableRequestSpecification requestSpec,
151137
return response;
152138
}
153139

154-
private static Map<String, String> toMapConverter(final Iterable<? extends NameAndValue> items, final Set<String> toBlacklist) {
140+
private static Map<String, String> toMapConverter(final Iterable<? extends NameAndValue> items, final Set<String> toHide) {
155141
final Map<String, String> result = new HashMap<>();
156-
items.forEach(h -> result.put(h.getName(), toBlacklist.contains(h.getName()) ? BLACKLISTED : h.getValue()));
142+
items.forEach(h -> result.put(h.getName(), toHide.contains(h.getName()) ? HIDDEN_PLACEHOLDER : h.getValue()));
157143
return result;
158144
}
159145

‎allure-rest-assured/src/test/java/io/qameta/allure/restassured/AllureRestAssuredTest.java‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,11 @@
2424
import io.qameta.allure.model.TestResult;
2525
import io.qameta.allure.test.AllureResults;
2626
import io.restassured.RestAssured;
27-
import io.restassured.http.ContentType;
2827
import io.restassured.config.LogConfig;
2928
import io.restassured.config.RestAssuredConfig;
30-
import io.restassured.specification.RequestSender;
29+
import io.restassured.http.ContentType;
3130
import io.restassured.specification.RequestSpecification;
3231
import java.nio.charset.StandardCharsets;
33-
import java.util.Map;
3432
import org.junit.jupiter.api.Test;
3533
import org.junit.jupiter.api.extension.ExtensionContext;
3634
import org.junit.jupiter.params.ParameterizedTest;
@@ -40,6 +38,7 @@
4038

4139
import java.util.Collection;
4240
import java.util.List;
41+
import java.util.Map;
4342
import java.util.stream.Collectors;
4443
import java.util.stream.Stream;
4544

@@ -60,20 +59,20 @@ public Stream<? extends Arguments> provideArguments(ExtensionContext context) {
6059
}
6160
}
6261

63-
class BlacklistHeadersArgumentProvider implements ArgumentsProvider {
62+
class HiddenHeadersArgumentProvider implements ArgumentsProvider {
6463
@Override
6564
public Stream<? extends Arguments> provideArguments(ExtensionContext context) {
6665

67-
final String blacklistedHeader = "Authorization";
66+
final String hiddenHeader = "Authorization";
6867
final String header = "Accept";
6968
final String headerValue = "value";
7069

71-
final Map<String, String> headers = Map.of(blacklistedHeader, headerValue, header, headerValue);
70+
final Map<String, String> headers = Map.of(hiddenHeader, headerValue, header, headerValue);
71+
final List<String> expectedHeaders = List.of(hiddenHeader + ": [ BLACKLISTED ]", header + ": " + headerValue);
7272

7373
return Stream.of(
74-
arguments(headers, blacklistedHeader, List.of(blacklistedHeader + ": " + headerValue, header + ": " + headerValue), new AllureRestAssured().followHeadersBlacklist(false)),
75-
arguments(headers, blacklistedHeader, List.of(blacklistedHeader + ": [ BLACKLISTED ]", header + ": " + headerValue), new AllureRestAssured()),
76-
arguments(headers, blacklistedHeader.toUpperCase(), List.of(blacklistedHeader + ": [ BLACKLISTED ]", header + ": " + headerValue), new AllureRestAssured())
74+
arguments(headers, hiddenHeader, expectedHeaders, new AllureRestAssured()),
75+
arguments(headers, hiddenHeader.toUpperCase(), expectedHeaders, new AllureRestAssured())
7776
);
7877
}
7978
}
@@ -155,12 +154,14 @@ void shouldCatchAttachmentBody(final List<String> attachmentNames, final AllureR
155154
}
156155

157156
@ParameterizedTest
158-
@ArgumentsSource(BlacklistHeadersArgumentProvider.class)
159-
void shouldBlacklistHeadersInAttachments(final Map<String, String> headers, final String blacklistedHeader, final List<String> expectedValues, AllureRestAssured filter) {
157+
@ArgumentsSource(HiddenHeadersArgumentProvider.class)
158+
void shouldHideHeadersInAttachments(
159+
final Map<String, String> headers, final String hiddenHeader, final List<String> expectedValues, AllureRestAssured filter) {
160+
160161
final ResponseDefinitionBuilder responseBuilder = WireMock.aResponse().withStatus(200);
161162
headers.forEach(responseBuilder::withHeader);
162163

163-
RestAssured.config = new RestAssuredConfig().logConfig(LogConfig.logConfig().blacklistHeaders(List.of(blacklistedHeader)));
164+
RestAssured.config = new RestAssuredConfig().logConfig(LogConfig.logConfig().blacklistHeaders(List.of(hiddenHeader)));
164165
RestAssured.replaceFiltersWith(filter);
165166

166167
final AllureResults results = executeWithStub(responseBuilder, RestAssured.with().headers(headers));

0 commit comments

Comments
 (0)