From 06157837e577af7e3abb469c0e415e5479af5080 Mon Sep 17 00:00:00 2001 From: Johnny Lim Date: Wed, 14 Jun 2023 00:57:27 +0900 Subject: [PATCH] Polish See gh-35872 --- .../boot/autoconfigure/kafka/KafkaProperties.java | 4 ++-- ...utoConfigurationEarlyInitializationIntegrationTests.java | 2 +- .../docs/asciidoc/getting-started/first-application.adoc | 5 +++-- .../src/docs/asciidoc/web/spring-security.adoc | 2 +- .../TestcontainersLifecycleBeanFactoryPostProcessor.java | 2 +- .../lifecycle/TestcontainersLifecycleBeanPostProcessor.java | 2 +- ...ntainersLifecycleApplicationContextInitializerTests.java | 4 ++-- .../TestcontainersLifecycleOrderIntegrationTests.java | 6 +++--- .../connection/ServiceConnectionContextCustomizerTests.java | 6 +++--- 9 files changed, 17 insertions(+), 16 deletions(-) diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java index cd0e3684682..50a2890821b 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java @@ -649,12 +649,12 @@ public class KafkaProperties { private final Map properties = new HashMap<>(); /** - * The close timeout. + * Close timeout. */ private Duration closeTimeout; /** - * The operation timeout. + * Operation timeout. */ private Duration operationTimeout; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/SessionAutoConfigurationEarlyInitializationIntegrationTests.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/SessionAutoConfigurationEarlyInitializationIntegrationTests.java index 6d449f83a4d..da11c9381ca 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/SessionAutoConfigurationEarlyInitializationIntegrationTests.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/SessionAutoConfigurationEarlyInitializationIntegrationTests.java @@ -39,7 +39,7 @@ import static org.assertj.core.api.Assertions.assertThat; * * @author Phillip Webb */ -public class SessionAutoConfigurationEarlyInitializationIntegrationTests { +class SessionAutoConfigurationEarlyInitializationIntegrationTests { @Test void configurationIsFrozenWhenSessionRepositoryAccessed() { diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started/first-application.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started/first-application.adoc index f6e1268b630..6abd497b49b 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started/first-application.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started/first-application.adoc @@ -141,9 +141,10 @@ Open your favorite text editor and add the following: plugins { id 'java' id 'org.springframework.boot' version '{spring-boot-version}' - id 'io.spring.dependency-management' version '1.1.0' } + apply plugin: 'io.spring.dependency-management' + group = 'com.example' version = '0.0.1-SNAPSHOT' sourceCompatibility = '17' @@ -247,7 +248,7 @@ If you run `gradle dependencies` again, you see that there are now a number of a [[getting-started.first-application.code]] === Writing the Code To finish our application, we need to create a single Java file. -By default, Maven and Gradle compiles sources from `src/main/java`, so you need to create that directory structure and then add a file named `src/main/java/MyApplication.java` to contain the following code: +By default, Maven and Gradle compile sources from `src/main/java`, so you need to create that directory structure and then add a file named `src/main/java/MyApplication.java` to contain the following code: include::code:MyApplication[] diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/spring-security.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/spring-security.adoc index 6921a17d3e3..2fc187ddba3 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/spring-security.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/spring-security.adoc @@ -211,7 +211,7 @@ For JWT configuration, a JWK Set URI or OIDC Issuer URI needs to be specified, a NOTE: If the authorization server does not support a JWK Set URI, you can configure the resource server with the Public Key used for verifying the signature of the JWT. This can be done using the configprop:spring.security.oauth2.resourceserver.jwt.public-key-location[] property, where the value needs to point to a file containing the public key in the PEM-encoded x509 format. -The configprop:spring.security.oauth2.resourceserver.jwt.audiences[] property can be used to specifify the expected values of the aud claim in JWTs. +The configprop:spring.security.oauth2.resourceserver.jwt.audiences[] property can be used to specify the expected values of the aud claim in JWTs. For example, to require JWTs to contain an aud claim with the value `my-audience`: [source,yaml,indent=0,subs="verbatim",configprops,configblocks] diff --git a/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/lifecycle/TestcontainersLifecycleBeanFactoryPostProcessor.java b/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/lifecycle/TestcontainersLifecycleBeanFactoryPostProcessor.java index 3590095053b..516eb45026f 100644 --- a/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/lifecycle/TestcontainersLifecycleBeanFactoryPostProcessor.java +++ b/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/lifecycle/TestcontainersLifecycleBeanFactoryPostProcessor.java @@ -29,7 +29,7 @@ import org.springframework.core.annotation.Order; /** * {@link BeanFactoryPostProcessor} to prevent {@link AutoCloseable} destruction calls so - * that {@link TestcontainersLifecycleBeanFactoryPostProcessor} can be smarter about which + * that {@link TestcontainersLifecycleBeanPostProcessor} can be smarter about which * containers to close. * * @author Phillip Webb diff --git a/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/lifecycle/TestcontainersLifecycleBeanPostProcessor.java b/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/lifecycle/TestcontainersLifecycleBeanPostProcessor.java index 5c70032d096..9a5ec1d10af 100644 --- a/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/lifecycle/TestcontainersLifecycleBeanPostProcessor.java +++ b/spring-boot-project/spring-boot-testcontainers/src/main/java/org/springframework/boot/testcontainers/lifecycle/TestcontainersLifecycleBeanPostProcessor.java @@ -56,7 +56,7 @@ class TestcontainersLifecycleBeanPostProcessor implements DestructionAwareBeanPo private static final Log logger = LogFactory.getLog(TestcontainersLifecycleBeanPostProcessor.class); - private ConfigurableListableBeanFactory beanFactory; + private final ConfigurableListableBeanFactory beanFactory; private volatile boolean containersInitialized = false; diff --git a/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/lifecycle/TestcontainersLifecycleApplicationContextInitializerTests.java b/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/lifecycle/TestcontainersLifecycleApplicationContextInitializerTests.java index caf27a1508b..ee27dae34f7 100644 --- a/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/lifecycle/TestcontainersLifecycleApplicationContextInitializerTests.java +++ b/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/lifecycle/TestcontainersLifecycleApplicationContextInitializerTests.java @@ -32,8 +32,8 @@ import static org.mockito.Mockito.never; import static org.mockito.Mockito.times; /** - * Tests for {@link TestcontainersLifecycleApplicationContextInitializer} and - * {@link TestcontainersLifecycleBeanPostProcessor} and + * Tests for {@link TestcontainersLifecycleApplicationContextInitializer}, + * {@link TestcontainersLifecycleBeanPostProcessor}, and * {@link TestcontainersLifecycleBeanFactoryPostProcessor}. * * @author Stephane Nicoll diff --git a/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/lifecycle/TestcontainersLifecycleOrderIntegrationTests.java b/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/lifecycle/TestcontainersLifecycleOrderIntegrationTests.java index d3fb40edf51..1fda208130f 100644 --- a/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/lifecycle/TestcontainersLifecycleOrderIntegrationTests.java +++ b/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/lifecycle/TestcontainersLifecycleOrderIntegrationTests.java @@ -39,8 +39,8 @@ import org.springframework.test.context.junit.jupiter.SpringExtension; import static org.assertj.core.api.Assertions.assertThat; /** - * Integration tests for {@link TestcontainersLifecycleApplicationContextInitializer} to - * ensure create and destroy events happen in the correct order. + * Integration tests for {@link TestcontainersLifecycleBeanPostProcessor} to ensure create + * and destroy events happen in the correct order. * * @author Phillip Webb */ @@ -48,7 +48,7 @@ import static org.assertj.core.api.Assertions.assertThat; @ContextConfiguration(classes = { TestConfig.class, ContainerConfig.class }) @DirtiesContext @DisabledIfDockerUnavailable -public class TestcontainersLifecycleOrderIntegrationTests { +class TestcontainersLifecycleOrderIntegrationTests { static List events = Collections.synchronizedList(new ArrayList<>()); diff --git a/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/service/connection/ServiceConnectionContextCustomizerTests.java b/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/service/connection/ServiceConnectionContextCustomizerTests.java index 47c62115a01..9ce9c30f9b0 100644 --- a/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/service/connection/ServiceConnectionContextCustomizerTests.java +++ b/spring-boot-project/spring-boot-testcontainers/src/test/java/org/springframework/boot/testcontainers/service/connection/ServiceConnectionContextCustomizerTests.java @@ -110,7 +110,7 @@ class ServiceConnectionContextCustomizerTests { ServiceConnectionContextCustomizer n3 = new ServiceConnectionContextCustomizer( List.of(new ContainerConnectionSource<>("test", this.origin, PostgreSQLContainer.class, "namex", annotation1, () -> container1))); - assertThat(n1.hashCode()).isEqualTo(n2.hashCode()); + assertThat(n1.hashCode()).isEqualTo(n2.hashCode()).isNotEqualTo(n3.hashCode()); assertThat(n1).isEqualTo(n2).isNotEqualTo(n3); // Connection Details Types ServiceConnectionContextCustomizer t1 = new ServiceConnectionContextCustomizer( @@ -122,7 +122,7 @@ class ServiceConnectionContextCustomizerTests { ServiceConnectionContextCustomizer t3 = new ServiceConnectionContextCustomizer( List.of(new ContainerConnectionSource<>("test", this.origin, PostgreSQLContainer.class, "name", annotation3, () -> container1))); - assertThat(t1.hashCode()).isEqualTo(t2.hashCode()); + assertThat(t1.hashCode()).isEqualTo(t2.hashCode()).isNotEqualTo(t3.hashCode()); assertThat(t1).isEqualTo(t2).isNotEqualTo(t3); // Container ServiceConnectionContextCustomizer c1 = new ServiceConnectionContextCustomizer( @@ -134,7 +134,7 @@ class ServiceConnectionContextCustomizerTests { ServiceConnectionContextCustomizer c3 = new ServiceConnectionContextCustomizer( List.of(new ContainerConnectionSource<>("test", this.origin, PostgreSQLContainer.class, "name", annotation1, () -> container2))); - assertThat(c1.hashCode()).isEqualTo(c2.hashCode()); + assertThat(c1.hashCode()).isEqualTo(c2.hashCode()).isNotEqualTo(c3.hashCode()); assertThat(c1).isEqualTo(c2).isNotEqualTo(c3); }