From 6518f8f7fd2a3be8dbb47560ca91c8b266b6b0fa Mon Sep 17 00:00:00 2001 From: Wanderlei Souza Date: Sun, 22 Nov 2020 18:49:44 -0300 Subject: [PATCH 1/2] Allow to exclude an empty set of ErrorAttributes See gh-24230 --- .../boot/web/error/ErrorAttributeOptions.java | 4 +- .../error/ErrorAttributesOptionsTests.java | 51 +++++++++++++++++++ 2 files changed, 54 insertions(+), 1 deletion(-) create mode 100644 spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/error/ErrorAttributesOptionsTests.java diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/error/ErrorAttributeOptions.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/error/ErrorAttributeOptions.java index b930aa346fdc..53e1e75b39fc 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/error/ErrorAttributeOptions.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/error/ErrorAttributeOptions.java @@ -27,6 +27,7 @@ * * @author Scott Frederick * @author Phillip Webb + * @author Wanderlei Souza * @since 2.3.0 */ public final class ErrorAttributeOptions { @@ -76,7 +77,8 @@ public ErrorAttributeOptions including(Include... includes) { * @return an {@code ErrorAttributeOptions} */ public ErrorAttributeOptions excluding(Include... excludes) { - EnumSet updated = EnumSet.copyOf(this.includes); + EnumSet updated = (this.includes.isEmpty()) ? EnumSet.noneOf(Include.class) + : EnumSet.copyOf(this.includes); updated.removeAll(Arrays.asList(excludes)); return new ErrorAttributeOptions(Collections.unmodifiableSet(updated)); } diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/error/ErrorAttributesOptionsTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/error/ErrorAttributesOptionsTests.java new file mode 100644 index 000000000000..0a7779332940 --- /dev/null +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/error/ErrorAttributesOptionsTests.java @@ -0,0 +1,51 @@ +/* + * Copyright 2012-2020 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 + * + * https://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 org.springframework.boot.web.servlet.error; + +import static org.assertj.core.api.Assertions.assertThat; + +import java.util.EnumSet; +import java.util.Set; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.web.error.ErrorAttributeOptions; +import org.springframework.boot.web.error.ErrorAttributeOptions.Include; + +/** + * Tests for {@link ErrorAttributesOptions}. + * + * @author Wanderlei Souza + */ +class ErrorAttributesOptionsTests { + + @Test + void excludingFromEmptySetWithoutErrors() { + Set includes = EnumSet.noneOf(Include.class); + ErrorAttributeOptions errorAttributeOptions = ErrorAttributeOptions.of(includes); + errorAttributeOptions = errorAttributeOptions.excluding(Include.EXCEPTION); + assertThat(errorAttributeOptions.getIncludes().isEmpty()); + } + + @Test + void includingInEmptySetWithoutErrors() { + Set includes = EnumSet.noneOf(Include.class); + ErrorAttributeOptions errorAttributeOptions = ErrorAttributeOptions.of(includes); + errorAttributeOptions = errorAttributeOptions.including(Include.EXCEPTION); + assertThat(errorAttributeOptions.getIncludes().isEmpty()); + } + +} From 016b69aa787784085b18c30d108fdd853aaac1c0 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Mon, 23 Nov 2020 20:44:18 +0100 Subject: [PATCH 2/2] Polish "Allow to exclude an empty set of ErrorAttributes" See gh-24230 --- .../boot/web/error/ErrorAttributeOptions.java | 11 ++--- .../error/ErrorAttributesOptionsTests.java | 40 ++++++++++++------- 2 files changed, 31 insertions(+), 20 deletions(-) diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/error/ErrorAttributeOptions.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/error/ErrorAttributeOptions.java index 53e1e75b39fc..cd47e8dc070d 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/error/ErrorAttributeOptions.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/error/ErrorAttributeOptions.java @@ -27,7 +27,6 @@ * * @author Scott Frederick * @author Phillip Webb - * @author Wanderlei Souza * @since 2.3.0 */ public final class ErrorAttributeOptions { @@ -64,8 +63,7 @@ public Set getIncludes() { * @return an {@code ErrorAttributeOptions} */ public ErrorAttributeOptions including(Include... includes) { - EnumSet updated = (this.includes.isEmpty()) ? EnumSet.noneOf(Include.class) - : EnumSet.copyOf(this.includes); + EnumSet updated = copyIncludes(); updated.addAll(Arrays.asList(includes)); return new ErrorAttributeOptions(Collections.unmodifiableSet(updated)); } @@ -77,12 +75,15 @@ public ErrorAttributeOptions including(Include... includes) { * @return an {@code ErrorAttributeOptions} */ public ErrorAttributeOptions excluding(Include... excludes) { - EnumSet updated = (this.includes.isEmpty()) ? EnumSet.noneOf(Include.class) - : EnumSet.copyOf(this.includes); + EnumSet updated = copyIncludes(); updated.removeAll(Arrays.asList(excludes)); return new ErrorAttributeOptions(Collections.unmodifiableSet(updated)); } + private EnumSet copyIncludes() { + return (this.includes.isEmpty()) ? EnumSet.noneOf(Include.class) : EnumSet.copyOf(this.includes); + } + /** * Create an {@code ErrorAttributeOptions} with defaults. * @return an {@code ErrorAttributeOptions} diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/error/ErrorAttributesOptionsTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/error/ErrorAttributesOptionsTests.java index 0a7779332940..783969998668 100644 --- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/error/ErrorAttributesOptionsTests.java +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/error/ErrorAttributesOptionsTests.java @@ -16,36 +16,46 @@ package org.springframework.boot.web.servlet.error; -import static org.assertj.core.api.Assertions.assertThat; - import java.util.EnumSet; -import java.util.Set; import org.junit.jupiter.api.Test; + import org.springframework.boot.web.error.ErrorAttributeOptions; import org.springframework.boot.web.error.ErrorAttributeOptions.Include; +import static org.assertj.core.api.Assertions.assertThat; + /** - * Tests for {@link ErrorAttributesOptions}. + * Tests for {@link ErrorAttributeOptions}. * * @author Wanderlei Souza + * @author Stephane Nicoll */ class ErrorAttributesOptionsTests { @Test - void excludingFromEmptySetWithoutErrors() { - Set includes = EnumSet.noneOf(Include.class); - ErrorAttributeOptions errorAttributeOptions = ErrorAttributeOptions.of(includes); - errorAttributeOptions = errorAttributeOptions.excluding(Include.EXCEPTION); - assertThat(errorAttributeOptions.getIncludes().isEmpty()); + void includingFromEmptyAttributesReturnAddedEntry() { + ErrorAttributeOptions options = ErrorAttributeOptions.of(EnumSet.noneOf(Include.class)); + assertThat(options.including(Include.EXCEPTION).getIncludes()).containsOnly(Include.EXCEPTION); + } + + @Test + void includingFromMatchingAttributesDoesNotModifyOptions() { + ErrorAttributeOptions options = ErrorAttributeOptions.of(EnumSet.of(Include.EXCEPTION, Include.STACK_TRACE)); + assertThat(options.including(Include.EXCEPTION).getIncludes()).containsOnly(Include.EXCEPTION, + Include.STACK_TRACE); + } + + @Test + void excludingFromEmptyAttributesReturnEmptyList() { + ErrorAttributeOptions options = ErrorAttributeOptions.of(EnumSet.noneOf(Include.class)); + assertThat(options.excluding(Include.EXCEPTION).getIncludes()).isEmpty(); } - + @Test - void includingInEmptySetWithoutErrors() { - Set includes = EnumSet.noneOf(Include.class); - ErrorAttributeOptions errorAttributeOptions = ErrorAttributeOptions.of(includes); - errorAttributeOptions = errorAttributeOptions.including(Include.EXCEPTION); - assertThat(errorAttributeOptions.getIncludes().isEmpty()); + void excludingFromMatchingAttributesRemoveMatch() { + ErrorAttributeOptions options = ErrorAttributeOptions.of(EnumSet.of(Include.EXCEPTION, Include.STACK_TRACE)); + assertThat(options.excluding(Include.EXCEPTION).getIncludes()).containsOnly(Include.STACK_TRACE); } }