From deed4863fb027ae06dd782e59dffc6384e807f44 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Thu, 4 Jul 2019 09:31:24 +0100 Subject: [PATCH] Adopt Spring Java Format's JUnit 5 check Closes gh-941 --- .../MainControllerStatsIntegrationTests.java | 2 +- .../ProjectGenerationStatPublisherTests.java | 2 +- initializr-docs/pom.xml | 5 +++++ .../src/main/asciidoc/using-the-stubs.adoc | 17 ++++++++--------- .../initializr/stub/ClientApplicationTests.java | 11 ++++------- .../web/AbstractInitializrIntegrationTests.java | 2 +- .../project/MainControllerIntegrationTests.java | 8 ++++---- .../support/CommandLineHelpGeneratorTests.java | 2 +- ...ltInitializrMetadataUpdateStrategyTests.java | 2 +- src/checkstyle/checkstyle.xml | 4 ++-- 10 files changed, 28 insertions(+), 27 deletions(-) diff --git a/initializr-actuator/src/test/java/io/spring/initializr/actuate/stat/MainControllerStatsIntegrationTests.java b/initializr-actuator/src/test/java/io/spring/initializr/actuate/stat/MainControllerStatsIntegrationTests.java index 705cb6a5..ced79c14 100755 --- a/initializr-actuator/src/test/java/io/spring/initializr/actuate/stat/MainControllerStatsIntegrationTests.java +++ b/initializr-actuator/src/test/java/io/spring/initializr/actuate/stat/MainControllerStatsIntegrationTests.java @@ -56,7 +56,7 @@ class MainControllerStatsIntegrationTests extends AbstractFullStackInitializrInt private ProjectGenerationStatPublisher projectGenerationStatPublisher; @BeforeEach - public void setup() { + void setup() { this.statsMockController.stats.clear(); // Make sure our mock is going to be invoked with the stats this.projectGenerationStatPublisher diff --git a/initializr-actuator/src/test/java/io/spring/initializr/actuate/stat/ProjectGenerationStatPublisherTests.java b/initializr-actuator/src/test/java/io/spring/initializr/actuate/stat/ProjectGenerationStatPublisherTests.java index bdf21ad5..57d2ffc7 100755 --- a/initializr-actuator/src/test/java/io/spring/initializr/actuate/stat/ProjectGenerationStatPublisherTests.java +++ b/initializr-actuator/src/test/java/io/spring/initializr/actuate/stat/ProjectGenerationStatPublisherTests.java @@ -76,7 +76,7 @@ class ProjectGenerationStatPublisherTests { private MockRestServiceServer mockServer; @BeforeEach - public void setUp() { + void setUp() { configureService(createProperties()); } diff --git a/initializr-docs/pom.xml b/initializr-docs/pom.xml index 638939ef..03d09c74 100644 --- a/initializr-docs/pom.xml +++ b/initializr-docs/pom.xml @@ -48,6 +48,11 @@ true + + org.junit.jupiter + junit-jupiter + test + org.springframework.boot spring-boot-starter-web diff --git a/initializr-docs/src/main/asciidoc/using-the-stubs.adoc b/initializr-docs/src/main/asciidoc/using-the-stubs.adoc index 1efd2b71..89dab550 100644 --- a/initializr-docs/src/main/asciidoc/using-the-stubs.adoc +++ b/initializr-docs/src/main/asciidoc/using-the-stubs.adoc @@ -31,15 +31,14 @@ A convenient way to consume the stubs in your project is to add a test dependenc and then pull the stubs from the classpath. In a Spring Boot application, using Spring Cloud Contract, you can start a WireMock server and register all the stubs -with it like this: +with it, as shown in the following JUnit 5-based example: [source,java,indent=0,subs="attributes"] ---- - @RunWith(SpringRunner.class) @SpringBootTest @AutoConfigureWireMock(port = 0, stubs="classpath:META-INF/io.spring.initializr/initializr-web/{spring-initializr-version}") - public class ClientApplicationTests { + class ClientApplicationTests { @Value("${wiremock.server.port}") private int port; @@ -80,16 +79,16 @@ stubs declared as a dependency): ---- -The test should use `@AutoConfigureStubRunner` instead: +The test should use `@AutoConfigureStubRunner` instead, as shown in the following JUnit +5-based example: [source,java,indent=0,,subs="attributes,specialchars"] ---- - @RunWith(SpringRunner.class) @SpringBootTest(webEnvironment = WebEnvironment.NONE) @AutoConfigureStubRunner( ids = "io.spring.initializr:initializr-web:{spring-initializr-version}", repositoryRoot = "https://repo.spring.io/{initializr-repo}") - public class ClientApplicationTests { + class ClientApplicationTests { @Autowired private StubFinder stubFinder; @@ -100,9 +99,9 @@ The test should use `@AutoConfigureStubRunner` instead: } ---- -Here is an example of a test that retrieves the metadata of the service. The assertions -do not matter much here but it illustrates how you could integrate that in the test suite -of a custom client: +Here is JUnit 5-based example of a test that retrieves the metadata of the service. The +assertions do not matter much here but it illustrates how you could integrate that in the +test suite of a custom client: [source,java,indent=0,subs="verbatim,quotes,attributes"] ---- diff --git a/initializr-docs/src/test/java/io/spring/initializr/stub/ClientApplicationTests.java b/initializr-docs/src/test/java/io/spring/initializr/stub/ClientApplicationTests.java index 83694f86..578077e1 100755 --- a/initializr-docs/src/test/java/io/spring/initializr/stub/ClientApplicationTests.java +++ b/initializr-docs/src/test/java/io/spring/initializr/stub/ClientApplicationTests.java @@ -18,8 +18,7 @@ package io.spring.initializr.stub; import java.net.URI; -import org.junit.Test; -import org.junit.runner.RunWith; +import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; @@ -34,16 +33,14 @@ import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; import org.springframework.http.RequestEntity; import org.springframework.http.ResponseEntity; -import org.springframework.test.context.junit4.SpringRunner; import org.springframework.web.client.RestTemplate; import static org.assertj.core.api.Assertions.assertThat; -@RunWith(SpringRunner.class) +// tag::test[] @SpringBootTest(webEnvironment = WebEnvironment.NONE) @AutoConfigureStubRunner(ids = "io.spring.initializr:initializr-web:${project.version}", stubsMode = StubsMode.LOCAL) -// tag::test[] -public class ClientApplicationTests { +class ClientApplicationTests { @Autowired private StubFinder stubFinder; @@ -52,7 +49,7 @@ public class ClientApplicationTests { private RestTemplate restTemplate; @Test - public void testCurrentMetadata() { + void testCurrentMetadata() { RequestEntity request = RequestEntity.get(createUri("/")) .accept(MediaType.valueOf("application/vnd.initializr.v2.1+json")).build(); diff --git a/initializr-web/src/test/java/io/spring/initializr/web/AbstractInitializrIntegrationTests.java b/initializr-web/src/test/java/io/spring/initializr/web/AbstractInitializrIntegrationTests.java index 855e2d84..04ab46d7 100755 --- a/initializr-web/src/test/java/io/spring/initializr/web/AbstractInitializrIntegrationTests.java +++ b/initializr-web/src/test/java/io/spring/initializr/web/AbstractInitializrIntegrationTests.java @@ -77,7 +77,7 @@ public abstract class AbstractInitializrIntegrationTests { private RestTemplate restTemplate; @BeforeEach - public void before(@TempDir Path folder) { + void before(@TempDir Path folder) { this.restTemplate = this.restTemplateBuilder.build(); this.folder = folder; } diff --git a/initializr-web/src/test/java/io/spring/initializr/web/project/MainControllerIntegrationTests.java b/initializr-web/src/test/java/io/spring/initializr/web/project/MainControllerIntegrationTests.java index 2f119cc7..a730f7f0 100755 --- a/initializr-web/src/test/java/io/spring/initializr/web/project/MainControllerIntegrationTests.java +++ b/initializr-web/src/test/java/io/spring/initializr/web/project/MainControllerIntegrationTests.java @@ -169,7 +169,7 @@ class MainControllerIntegrationTests extends AbstractInitializrControllerIntegra @Test @Disabled("Need a comparator that does not care about the number of elements in an array") - public void currentMetadataCompatibleWithV2() { + void currentMetadataCompatibleWithV2() { ResponseEntity response = invokeHome(null, "*/*"); validateMetadata(response, AbstractInitializrIntegrationTests.CURRENT_METADATA_MEDIA_TYPE, "2.0.0", JSONCompareMode.LENIENT); @@ -237,7 +237,7 @@ class MainControllerIntegrationTests extends AbstractInitializrControllerIntegra @Test // make sure curl can still receive metadata with json - public void curlWithAcceptHeaderJson() { + void curlWithAcceptHeaderJson() { ResponseEntity response = invokeHome("curl/1.2.4", "application/json"); validateContentType(response, AbstractInitializrIntegrationTests.CURRENT_METADATA_MEDIA_TYPE); validateCurrentMetadata(response.getBody()); @@ -263,7 +263,7 @@ class MainControllerIntegrationTests extends AbstractInitializrControllerIntegra @Test // make sure curl can still receive metadata with json - public void httpieWithAcceptHeaderJson() { + void httpieWithAcceptHeaderJson() { ResponseEntity response = invokeHome("HTTPie/0.8.0", "application/json"); validateContentType(response, AbstractInitializrIntegrationTests.CURRENT_METADATA_MEDIA_TYPE); validateCurrentMetadata(response.getBody()); @@ -296,7 +296,7 @@ class MainControllerIntegrationTests extends AbstractInitializrControllerIntegra @Test // Test that the current output is exactly what we expect - public void validateCurrentProjectMetadata() { + void validateCurrentProjectMetadata() { validateCurrentMetadata(getMetadataJson()); } diff --git a/initializr-web/src/test/java/io/spring/initializr/web/support/CommandLineHelpGeneratorTests.java b/initializr-web/src/test/java/io/spring/initializr/web/support/CommandLineHelpGeneratorTests.java index f4e8bc61..6fc094fa 100755 --- a/initializr-web/src/test/java/io/spring/initializr/web/support/CommandLineHelpGeneratorTests.java +++ b/initializr-web/src/test/java/io/spring/initializr/web/support/CommandLineHelpGeneratorTests.java @@ -39,7 +39,7 @@ class CommandLineHelpGeneratorTests { private CommandLineHelpGenerator generator; @BeforeEach - public void init() { + void init() { this.generator = new CommandLineHelpGenerator(new MustacheTemplateRenderer("classpath:/templates")); } diff --git a/initializr-web/src/test/java/io/spring/initializr/web/support/DefaultInitializrMetadataUpdateStrategyTests.java b/initializr-web/src/test/java/io/spring/initializr/web/support/DefaultInitializrMetadataUpdateStrategyTests.java index 36f2c1cf..bd8c4e15 100755 --- a/initializr-web/src/test/java/io/spring/initializr/web/support/DefaultInitializrMetadataUpdateStrategyTests.java +++ b/initializr-web/src/test/java/io/spring/initializr/web/support/DefaultInitializrMetadataUpdateStrategyTests.java @@ -52,7 +52,7 @@ class DefaultInitializrMetadataUpdateStrategyTests { private MockRestServiceServer mockServer; @BeforeEach - public void setUp() { + void setUp() { this.restTemplate = new RestTemplate(); this.mockServer = MockRestServiceServer.createServer(this.restTemplate); } diff --git a/src/checkstyle/checkstyle.xml b/src/checkstyle/checkstyle.xml index c94b436f..4d06c135 100644 --- a/src/checkstyle/checkstyle.xml +++ b/src/checkstyle/checkstyle.xml @@ -5,8 +5,7 @@ - + @@ -19,5 +18,6 @@ value="Please use BDDMockito imports."/> +