Polish “Improve documentation for testing with Spock”

Closes gh-6539
pull/6666/head
Andy Wilkinson 8 years ago
parent 894d86de12
commit a1e3dcebd4

@ -5369,42 +5369,30 @@ automatically generate the default snippets:
==== Using Spock to test Spring Boot applications ==== Using Spock to test Spring Boot applications
If you wish to use Spock to test a Spring Boot application you should add a dependency 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 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 <<boot-features-testing-spring-boot-applications,described above>> NOTE: Spring Boot provides dependency management for Spock 1.0. If you wish to use Spock
can be used with Spock 1.1, i.e. you can annotate your `Specification` with 1.1 you should <<howto.adoc#howto-customize-dependency-versions,override the
`spock.version` property>> in your `build.gradle` or `pom.xml` file.
When using Spock 1.1, the annotations <<boot-features-testing-spring-boot-applications,
described above>> can only be used and you can annotate your `Specification` with
`@SpringBootTest` to suit the needs of your tests. `@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)' When using Spock 1.0, `@SpringBootTest` will not work for a web project. You need to use
If you want to autowire a TestRestTemplate you will have to create a bean like: `@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] [source,java,indent=0]
---- ----
public class TestConfiguration { include::{code-examples}/test/spock/SpockTestRestTemplateExample.java[tag=test-rest-template-configuration]
@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();
}
---- ----
[[boot-features-test-utilities]] [[boot-features-test-utilities]]
=== Test utilities === Test utilities
A few test utility classes are packaged as part of `spring-boot` that are generally A few test utility classes are packaged as part of `spring-boot` that are generally

@ -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<RestTemplateBuilder> 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[]
}

@ -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);
}
}
Loading…
Cancel
Save