From a1e3dcebd46f997d20da7507ef0df8d9ab577f83 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Tue, 16 Aug 2016 16:06:27 +0100 Subject: [PATCH] =?UTF-8?q?Polish=20=E2=80=9CImprove=20documentation=20for?= =?UTF-8?q?=20testing=20with=20Spock=E2=80=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Closes gh-6539 --- .../main/asciidoc/spring-boot-features.adoc | 44 ++++++-------- .../spock/SpockTestRestTemplateExample.java | 57 +++++++++++++++++++ .../SpockTestRestTemplateExampleTests.java | 48 ++++++++++++++++ 3 files changed, 121 insertions(+), 28 deletions(-) create mode 100644 spring-boot-docs/src/main/java/org/springframework/boot/test/spock/SpockTestRestTemplateExample.java create mode 100644 spring-boot-docs/src/test/java/org/springframework/boot/test/spock/SpockTestRestTemplateExampleTests.java diff --git a/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index 25ef9f502e..c909397bf5 100644 --- a/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -5369,42 +5369,30 @@ automatically generate the default snippets: ==== Using Spock to test Spring Boot applications If you wish to use Spock to test a Spring Boot application you should add a dependency on Spock's `spock-spring` module to your application's build. `spock-spring` integrates -Spring's test framework into Spock. +Spring's test framework into Spock. Exactly how you can use Spock to test a Spring Boot +application depends on the version of Spock that you are using. -NOTE: The annotations <> -can be used with Spock 1.1, i.e. you can annotate your `Specification` with +NOTE: Spring Boot provides dependency management for Spock 1.0. If you wish to use Spock +1.1 you should <> in your `build.gradle` or `pom.xml` file. + +When using Spock 1.1, the annotations <> can only be used and you can annotate your `Specification` with `@SpringBootTest` to suit the needs of your tests. -When using Spock 1.0 @SpringbootTest will not work for a web project. You need to use -'@SpringApplicationConfiguration()' and '@WebIntegrationTest(randomPort = true)' -If you want to autowire a TestRestTemplate you will have to create a bean like: + +When using Spock 1.0, `@SpringBootTest` will not work for a web project. You need to use +`@SpringApplicationConfiguration` and `@WebIntegrationTest(randomPort = true)`. Being +unable to use `@SpringBootTest` means that you also lose the auto-configured +`TestRestTemplate` bean. You can create an equivalent bean yourself using the following +configuration: + [source,java,indent=0] ---- - public class TestConfiguration { - @Autowired - ApplicationContext applicationContext; - - @Bean - TestRestTemplate restTemplate(){ - RestTemplateBuilder builder = getRestTemplateBuilder(applicationContext); - TestRestTemplate template = new TestRestTemplate(builder.build()); - template.setUriTemplateHandler( - new LocalHostUriTemplateHandler(applicationContext.getEnvironment())); - return template; - } - - private RestTemplateBuilder getRestTemplateBuilder( - ApplicationContext applicationContext) { - try { - return applicationContext.getBean(RestTemplateBuilder.class); - } - catch (NoSuchBeanDefinitionException ex) { - return new RestTemplateBuilder(); - } +include::{code-examples}/test/spock/SpockTestRestTemplateExample.java[tag=test-rest-template-configuration] ---- - [[boot-features-test-utilities]] === Test utilities A few test utility classes are packaged as part of `spring-boot` that are generally diff --git a/spring-boot-docs/src/main/java/org/springframework/boot/test/spock/SpockTestRestTemplateExample.java b/spring-boot-docs/src/main/java/org/springframework/boot/test/spock/SpockTestRestTemplateExample.java new file mode 100644 index 0000000000..cc87370ee4 --- /dev/null +++ b/spring-boot-docs/src/main/java/org/springframework/boot/test/spock/SpockTestRestTemplateExample.java @@ -0,0 +1,57 @@ +/* + * Copyright 2012-2016 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.test.spock; + +import org.springframework.beans.factory.ObjectProvider; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.web.client.LocalHostUriTemplateHandler; +import org.springframework.boot.test.web.client.TestRestTemplate; +import org.springframework.boot.web.client.RestTemplateBuilder; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.core.env.Environment; + +/** + * Example configuration for using TestRestTemplate with Spock 1.0 when + * {@link SpringBootTest} cannot be used. + * + * @author Andy Wilkinson + */ +public class SpockTestRestTemplateExample { + + /** + * Test configuration for a {@link TestRestTemplate}. + */ + // tag::test-rest-template-configuration[] + @Configuration + static class TestRestTemplateConfiguration { + + @Bean + public TestRestTemplate testRestTemplate( + ObjectProvider builderProvider, + Environment environment) { + RestTemplateBuilder builder = builderProvider.getIfAvailable(); + TestRestTemplate template = builder == null ? new TestRestTemplate() + : new TestRestTemplate(builder.build()); + template.setUriTemplateHandler(new LocalHostUriTemplateHandler(environment)); + return template; + } + + } + // end::test-rest-template-configuration[] + +} diff --git a/spring-boot-docs/src/test/java/org/springframework/boot/test/spock/SpockTestRestTemplateExampleTests.java b/spring-boot-docs/src/test/java/org/springframework/boot/test/spock/SpockTestRestTemplateExampleTests.java new file mode 100644 index 0000000000..c15b676eea --- /dev/null +++ b/spring-boot-docs/src/test/java/org/springframework/boot/test/spock/SpockTestRestTemplateExampleTests.java @@ -0,0 +1,48 @@ +/* + * Copyright 2012-2016 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.test.spock; + +import org.junit.Test; +import org.junit.runner.RunWith; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.web.client.TestRestTemplate; +import org.springframework.context.ApplicationContext; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringRunner; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for {@link SpockTestRestTemplateExample}. + * + * @author Andy Wilkinson + */ +@RunWith(SpringRunner.class) +@ContextConfiguration(classes = SpockTestRestTemplateExample.TestRestTemplateConfiguration.class) +public class SpockTestRestTemplateExampleTests { + + @Autowired + private ApplicationContext applicationContext; + + @Test + public void testRestTemplateBeanIsAvailable() { + assertThat(this.applicationContext.getBeansOfType(TestRestTemplate.class)) + .hasSize(1); + } + +}