diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index 9b7429a9fb..1e97919dd8 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -6096,7 +6096,13 @@ context by default only if you use `SpringApplication` to create it. Spring Boot provides a `@SpringBootTest` annotation, which can be used as an alternative to the standard `spring-test` `@ContextConfiguration` annotation when you need Spring Boot features. The annotation works by creating the `ApplicationContext` used in your -tests through `SpringApplication`. +tests through `SpringApplication`. In addition to `@SpringBootTest` a number of other +annotations are also provided for +<> of an application. + +TIP: Don't forget to also add `@RunWith(SpringRunner.class)` to your test, otherwise +the annotations will be ignored. You can use the `webEnvironment` attribute of `@SpringBootTest` to further refine how your tests run: @@ -6121,13 +6127,6 @@ test method by default. However, as using this arrangement with either `RANDOM_P run in separate threads and, thus, in separate transactions. Any transaction initiated on the server does not roll back in this case. -NOTE: In addition to `@SpringBootTest`, a number of other annotations are also provided -for testing more specific slices of an application. You can find more detail throughout -this chapter. - -TIP: Do not forget to add `@RunWith(SpringRunner.class)` to your test. Otherwise, the -annotations are ignored. - [[boot-features-testing-spring-boot-applications-detecting-web-app-type]] @@ -6245,6 +6244,19 @@ include::{code-examples}/test/web/RandomPortTestRestTemplateExampleTests.java[ta +[[boot-features-testing-spring-boot-applications-jmx]] +==== Using JMX +As the test context framework caches context, JMX is disabled by default to prevent +identical components to register on the same domain. If such test needs access to an +`MBeanServer`, consider marking it dirty as well: + +[source,java,indent=0] +---- +include::{test-examples}/jmx/SampleJmxTests.java[tag=test] +---- + + + [[boot-features-testing-spring-boot-applications-mocking-beans]] ==== Mocking and Spying Beans When running tests, it is sometimes necessary to mock certain components within your diff --git a/spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/jmx/SampleApp.java b/spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/jmx/SampleApp.java new file mode 100644 index 0000000000..3e7939c39c --- /dev/null +++ b/spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/jmx/SampleApp.java @@ -0,0 +1,32 @@ +/* + * Copyright 2012-2018 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 org.springframework.boot.docs.jmx; + +import org.springframework.boot.SpringBootConfiguration; +import org.springframework.boot.autoconfigure.ImportAutoConfiguration; +import org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration; + +/** + * A sample {@link SpringBootConfiguration} that only enables JMX auto-configuration. + * + * @author Stephane Nicoll + */ +@SpringBootConfiguration +@ImportAutoConfiguration(JmxAutoConfiguration.class) +public class SampleApp { + +} diff --git a/spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/jmx/SampleJmxTests.java b/spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/jmx/SampleJmxTests.java new file mode 100644 index 0000000000..c0d85b76c3 --- /dev/null +++ b/spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/jmx/SampleJmxTests.java @@ -0,0 +1,50 @@ +/* + * Copyright 2012-2018 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 org.springframework.boot.docs.jmx; + +import javax.management.MBeanServer; + +import org.junit.Test; +import org.junit.runner.RunWith; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.annotation.DirtiesContext; +import org.springframework.test.context.junit4.SpringRunner; + +/** + * Example integration test that uses JMX. + * + * @author Stephane Nicoll + */ +// tag::test[] +@RunWith(SpringRunner.class) +@SpringBootTest(properties = "spring.jmx.enabled=true") +@DirtiesContext +public class SampleJmxTests { + + @Autowired + private MBeanServer mBeanServer; + + @Test + public void exampleTest() { + // ... + + } + +} +// end::test[]