From 72d50ed2f8916820862c2540e8573296135cfbea Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Tue, 18 May 2021 11:14:26 -0700 Subject: [PATCH] Move "Testing With Spring Security" How-to See gh-26262 --- .../src/docs/asciidoc/anchor-rewrite.properties | 2 +- .../src/docs/asciidoc/features/testing.adoc | 2 +- .../spring-boot-docs/src/docs/asciidoc/howto.adoc | 4 ++-- ...sting-with-spring-security.adoc => testing.adoc} | 13 ++++++++++--- .../withspringsecurity}/MySecurityTests.java | 2 +- .../withspringsecurity}/UserController.java | 2 +- 6 files changed, 16 insertions(+), 9 deletions(-) rename spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/{testing-with-spring-security.adoc => testing.adoc} (58%) rename spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/{testingwithspringsecurity => testing/withspringsecurity}/MySecurityTests.java (94%) rename spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/{testingwithspringsecurity => testing/withspringsecurity}/UserController.java (90%) diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/anchor-rewrite.properties b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/anchor-rewrite.properties index ecede55509..b11e583e31 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/anchor-rewrite.properties +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/anchor-rewrite.properties @@ -2527,7 +2527,7 @@ howto.spring-mvc.customize-view-resolvers # 2 == Testing With Spring Security howto-use-test-with-spring-security=\ -howto.testing-with-spring-security +howto.spring-mvc.testing.with-spring-security # 2 == Jersey howto-jersey=\ diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/testing.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/testing.adoc index 5b5f928d25..2679586f50 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/testing.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/testing.adoc @@ -404,7 +404,7 @@ If you define your own `webDriver` scope you may find it stops working when you If you have Spring Security on the classpath, `@WebMvcTest` will also scan `WebSecurityConfigurer` beans. Instead of disabling security completely for such tests, you can use Spring Security's test support. -More details on how to use Spring Security's `MockMvc` support can be found in this _<>_ how-to section. +More details on how to use Spring Security's `MockMvc` support can be found in this _<>_ how-to section. TIP: Sometimes writing Spring MVC tests is not enough; Spring Boot can help you run <>. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto.adoc index 24deb2d22a..b746211c01 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto.adoc @@ -23,8 +23,6 @@ include::howto/webserver.adoc[] include::howto/spring-mvc.adoc[] -include::howto/testing-with-spring-security.adoc[] - include::howto/jersey.adoc[] include::howto/http-clients.adoc[] @@ -45,6 +43,8 @@ include::howto/security.adoc[] include::howto/hotswapping.adoc[] +include::howto/testing.adoc[] + include::howto/build.adoc[] include::howto/traditional-deployment.adoc[] diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testing-with-spring-security.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testing.adoc similarity index 58% rename from spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testing-with-spring-security.adoc rename to spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testing.adoc index 74687f51b8..f43303dfb2 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testing-with-spring-security.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testing.adoc @@ -1,11 +1,18 @@ -[[howto.testing-with-spring-security]] -== Testing With Spring Security +[[howto.testing]] +== Testing +Spring Boot includes a number of testing utilities and support classes as well as a dedicated starter that provides common test dependencies. +This section answers common questions about testing. + + + +[[howto.testing.with-spring-security]] +=== Testing With Spring Security Spring Security provides support for running tests as a specific user. For example, the test in the snippet below will run with an authenticated user that has the `ADMIN` role. [source,java,indent=0,subs="verbatim"] ---- -include::{docs-java}/howto/testingwithspringsecurity/MySecurityTests.java[] +include::{docs-java}/howto/testing/withspringsecurity/MySecurityTests.java[] ---- Spring Security provides comprehensive integration with Spring MVC Test and this can also be used when testing controllers using the `@WebMvcTest` slice and `MockMvc`. diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testingwithspringsecurity/MySecurityTests.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testing/withspringsecurity/MySecurityTests.java similarity index 94% rename from spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testingwithspringsecurity/MySecurityTests.java rename to spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testing/withspringsecurity/MySecurityTests.java index d322bb7369..b932490b8a 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testingwithspringsecurity/MySecurityTests.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testing/withspringsecurity/MySecurityTests.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package org.springframework.boot.docs.howto.testingwithspringsecurity; +package org.springframework.boot.docs.howto.testing.withspringsecurity; import org.junit.jupiter.api.Test; diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testingwithspringsecurity/UserController.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testing/withspringsecurity/UserController.java similarity index 90% rename from spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testingwithspringsecurity/UserController.java rename to spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testing/withspringsecurity/UserController.java index 19e24c032b..96fa823791 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testingwithspringsecurity/UserController.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testing/withspringsecurity/UserController.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package org.springframework.boot.docs.howto.testingwithspringsecurity; +package org.springframework.boot.docs.howto.testing.withspringsecurity; class UserController {