Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish doc code samples

Browse Source 
See gh-6313
This commit is contained in:
Phillip Webb
2021-05-03 21:16:45 -07:00
parent 9aad29da0c
commit b5583a4620
165 changed files with 517 additions and 482 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/features/developingautoconfiguration/testing/UserServiceAutoConfigurationTestsTests.java → spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/features/developingautoconfiguration/testing/MyServiceAutoConfigurationTestsTests.java
View File

@@ -17,10 +17,10 @@
package org.springframework.boot.docs.features.developingautoconfiguration.testing;
/**
* Tests for {@link UserServiceAutoConfigurationTests}.
* Tests for {@link MyServiceAutoConfigurationTests}.
*
* @author Stephane Nicoll
*/
class UserServiceAutoConfigurationTestsTests extends UserServiceAutoConfigurationTests {
class MyServiceAutoConfigurationTestsTests extends MyServiceAutoConfigurationTests {
}

18
spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/conversion/durations/constructorbinding/AppSystemPropertiesTests.java → spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/conversion/durations/constructorbinding/MyPropertiesTests.java
View File

@@ -29,18 +29,18 @@ import org.springframework.context.annotation.Configuration;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link AppSystemProperties}.
* Tests for {@link MyProperties}.
*
* @author Stephane Nicoll
*/
class AppSystemPropertiesTests {
class MyPropertiesTests {
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
.withUserConfiguration(Config.class);
@Test
void bindWithDefaultUnit() {
this.contextRunner.withPropertyValues("app.system.session-timeout=40", "app.system.read-timeout=5000")
this.contextRunner.withPropertyValues("my.session-timeout=40", "my.read-timeout=5000")
.run(assertBinding((properties) -> {
assertThat(properties.getSessionTimeout()).hasSeconds(40);
assertThat(properties.getReadTimeout()).hasMillis(5000);
@@ -49,7 +49,7 @@ class AppSystemPropertiesTests {
@Test
void bindWithExplicitUnit() {
this.contextRunner.withPropertyValues("app.system.session-timeout=1h", "app.system.read-timeout=5s")
this.contextRunner.withPropertyValues("my.session-timeout=1h", "my.read-timeout=5s")
.run(assertBinding((properties) -> {
assertThat(properties.getSessionTimeout()).hasMinutes(60);
assertThat(properties.getReadTimeout()).hasMillis(5000);
@@ -58,22 +58,22 @@ class AppSystemPropertiesTests {
@Test
void bindWithIso8601Format() {
this.contextRunner.withPropertyValues("app.system.session-timeout=PT15S", "app.system.read-timeout=PT0.5S")
this.contextRunner.withPropertyValues("my.session-timeout=PT15S", "my.read-timeout=PT0.5S")
.run(assertBinding((properties) -> {
assertThat(properties.getSessionTimeout()).hasSeconds(15);
assertThat(properties.getReadTimeout()).hasMillis(500);
}));
}
private ContextConsumer<AssertableApplicationContext> assertBinding(Consumer<AppSystemProperties> properties) {
private ContextConsumer<AssertableApplicationContext> assertBinding(Consumer<MyProperties> properties) {
return (context) -> {
assertThat(context).hasSingleBean(AppSystemProperties.class);
properties.accept(context.getBean(AppSystemProperties.class));
assertThat(context).hasSingleBean(MyProperties.class);
properties.accept(context.getBean(MyProperties.class));
};
}
@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(AppSystemProperties.class)
@EnableConfigurationProperties(MyProperties.class)
static class Config {
}

18
spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/conversion/durations/javabeanbinding/AppSystemPropertiesTests.java → spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/conversion/durations/javabeanbinding/MyPropertiesTests.java
View File

@@ -29,18 +29,18 @@ import org.springframework.context.annotation.Configuration;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link AppSystemProperties}.
* Tests for {@link MyProperties}.
*
* @author Stephane Nicoll
*/
class AppSystemPropertiesTests {
class MyPropertiesTests {
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
.withUserConfiguration(Config.class);
@Test
void bindWithDefaultUnit() {
this.contextRunner.withPropertyValues("app.system.session-timeout=40", "app.system.read-timeout=5000")
this.contextRunner.withPropertyValues("my.session-timeout=40", "my.read-timeout=5000")
.run(assertBinding((properties) -> {
assertThat(properties.getSessionTimeout()).hasSeconds(40);
assertThat(properties.getReadTimeout()).hasMillis(5000);
@@ -49,7 +49,7 @@ class AppSystemPropertiesTests {
@Test
void bindWithExplicitUnit() {
this.contextRunner.withPropertyValues("app.system.session-timeout=1h", "app.system.read-timeout=5s")
this.contextRunner.withPropertyValues("my.session-timeout=1h", "my.read-timeout=5s")
.run(assertBinding((properties) -> {
assertThat(properties.getSessionTimeout()).hasMinutes(60);
assertThat(properties.getReadTimeout()).hasMillis(5000);
@@ -58,22 +58,22 @@ class AppSystemPropertiesTests {
@Test
void bindWithIso8601Format() {
this.contextRunner.withPropertyValues("app.system.session-timeout=PT15S", "app.system.read-timeout=PT0.5S")
this.contextRunner.withPropertyValues("my.session-timeout=PT15S", "my.read-timeout=PT0.5S")
.run(assertBinding((properties) -> {
assertThat(properties.getSessionTimeout()).hasSeconds(15);
assertThat(properties.getReadTimeout()).hasMillis(500);
}));
}
private ContextConsumer<AssertableApplicationContext> assertBinding(Consumer<AppSystemProperties> properties) {
private ContextConsumer<AssertableApplicationContext> assertBinding(Consumer<MyProperties> properties) {
return (context) -> {
assertThat(context).hasSingleBean(AppSystemProperties.class);
properties.accept(context.getBean(AppSystemProperties.class));
assertThat(context).hasSingleBean(MyProperties.class);
properties.accept(context.getBean(MyProperties.class));
};
}
@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(AppSystemProperties.class)
@EnableConfigurationProperties(MyProperties.class)
static class Config {
}

6
spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/features/springapplication/fluentbuilderapi/SpringApplicationBuilderExampleTests.java → spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/features/springapplication/fluentbuilderapi/MyApplicationTests.java
View File

@@ -25,18 +25,18 @@ import org.springframework.boot.test.system.OutputCaptureExtension;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link SpringApplicationBuilderExample}.
* Tests for {@link MyApplication}.
*
* @author Andy Wilkinson
*/
@ExtendWith(OutputCaptureExtension.class)
class SpringApplicationBuilderExampleTests {
class MyApplicationTests {
@Test
void contextHierarchyWithDisabledBanner(CapturedOutput output) {
System.setProperty("spring.main.web-application-type", "none");
try {
new SpringApplicationBuilderExample().hierarchyWithDisabledBanner(new String[0]);
new MyApplication().hierarchyWithDisabledBanner(new String[0]);
assertThat(output).doesNotContain(":: Spring Boot ::");
}
finally {

2
spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/features/testing/springbootapplications/jmx/SampleJmxTestsTests.java → spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/features/testing/springbootapplications/jmx/MyJmxTestsTests.java
View File

@@ -21,6 +21,6 @@ package org.springframework.boot.docs.features.testing.springbootapplications.jm
*
* @author Stephane Nicoll
*/
class SampleJmxTestsTests extends SampleJmxTests {
class MyJmxTestsTests extends MyJmxTests {
}

4
spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/features/testing/utilities/outputcapture/OutputCaptureTestsTests.java → spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/features/testing/utilities/outputcapture/MyOutputCaptureTestsTests.java
View File

@@ -17,10 +17,10 @@
package org.springframework.boot.docs.features.testing.utilities.outputcapture;
/**
* Tests for {@link OutputCaptureTests}.
* Tests for {@link MyOutputCaptureTests}.
*
* @author Stephane Nicoll
*/
class OutputCaptureTestsTests extends OutputCaptureTests {
class MyOutputCaptureTestsTests extends MyOutputCaptureTests {
}

2
spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/actuator/maphealthindicatorstometrics/MetricsHealthMicrometerExportTests.java
View File

@@ -53,7 +53,7 @@ class MetricsHealthMicrometerExportTests {
}
@Configuration(proxyBeanMethods = false)
@Import(MetricsHealthMicrometerExport.HealthMetricsConfiguration.class)
@Import(MyHealthMetricsExportConfiguration.class)
@ImportAutoConfiguration(classes = { HealthContributorAutoConfiguration.class, MetricsAutoConfiguration.class,
HealthEndpointAutoConfiguration.class })
static class Config {

7
spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/dataaccess/configurecustomdatasource/BasicDataSourceConfigurationTests.java → spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/dataaccess/configurecustomdatasource/MyDataSourceConfigurationTests.java
View File

@@ -24,6 +24,7 @@ import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.docs.howto.dataaccess.configurecustomdatasource.builder.MyDataSourceConfiguration;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Import;
@@ -32,14 +33,14 @@ import org.springframework.test.context.junit.jupiter.SpringExtension;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Test for {@link BasicDataSourceConfiguration}.
* Test for {@link MyDataSourceConfiguration}.
*
* @author Stephane Nicoll
*/
@ExtendWith(SpringExtension.class)
@SpringBootTest(properties = "app.datasource.jdbcUrl=jdbc:h2:mem:basic;DB_CLOSE_DELAY=-1")
@Import(BasicDataSourceConfiguration.class)
class BasicDataSourceConfigurationTests {
@Import(MyDataSourceConfiguration.class)
class MyDataSourceConfigurationTests {
@Autowired
private ApplicationContext context;

8
spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/dataaccess/configurecustomdatasource/ConfigurableDataSourceConfigurationTests.java → spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/dataaccess/configurecustomdatasource/configurable/MyDataSourceConfigurationTests.java
View File

@@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.docs.howto.dataaccess.configurecustomdatasource;
package org.springframework.boot.docs.howto.dataaccess.configurecustomdatasource.configurable;
import java.sql.SQLException;
@@ -33,15 +33,15 @@ import org.springframework.test.context.junit.jupiter.SpringExtension;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Test for {@link ConfigurableDataSourceConfiguration}.
* Test for {@link MyDataSourceConfiguration}.
*
* @author Stephane Nicoll
*/
@ExtendWith(SpringExtension.class)
@SpringBootTest(properties = { "app.datasource.url=jdbc:h2:mem:configurable;DB_CLOSE_DELAY=-1",
"app.datasource.configuration.maximum-pool-size=42" })
@Import(ConfigurableDataSourceConfiguration.class)
class ConfigurableDataSourceConfigurationTests {
@Import(MyDataSourceConfiguration.class)
class MyDataSourceConfigurationTests {
@Autowired
private ApplicationContext context;

8
spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/dataaccess/configurecustomdatasource/SimpleDataSourceConfigurationTests.java → spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/dataaccess/configurecustomdatasource/simple/MyDataSourceConfigurationTests.java
View File

@@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.docs.howto.dataaccess.configurecustomdatasource;
package org.springframework.boot.docs.howto.dataaccess.configurecustomdatasource.simple;
import java.sql.SQLException;
@@ -33,15 +33,15 @@ import org.springframework.test.context.junit.jupiter.SpringExtension;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Test for {@link SimpleDataSourceConfiguration}.
* Test for {@link MyDataSourceConfiguration}.
*
* @author Stephane Nicoll
*/
@ExtendWith(SpringExtension.class)
@SpringBootTest(properties = { "app.datasource.jdbc-url=jdbc:h2:mem:simple;DB_CLOSE_DELAY=-1",
"app.datasource.maximum-pool-size=42" })
@Import(SimpleDataSourceConfiguration.class)
class SimpleDataSourceConfigurationTests {
@Import(MyDataSourceConfiguration.class)
class MyDataSourceConfigurationTests {
@Autowired
private ApplicationContext context;

6
spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/CompleteDataSourcesConfigurationTests.java → spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyCompleteDataSourcesConfigurationTests.java
View File

@@ -32,14 +32,14 @@ import org.springframework.test.context.junit.jupiter.SpringExtension;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link CompleteDataSourcesConfiguration}.
* Tests for {@link MyCompleteDataSourcesConfiguration}.
*
* @author Stephane Nicoll
*/
@ExtendWith(SpringExtension.class)
@SpringBootTest
@Import(CompleteDataSourcesConfiguration.class)
class CompleteDataSourcesConfigurationTests {
@Import(MyCompleteDataSourcesConfiguration.class)
class MyCompleteDataSourcesConfigurationTests {
@Autowired
private ApplicationContext context;

6
spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/SimpleDataSourcesConfigurationTests.java → spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyDataSourcesConfigurationTests.java
View File

@@ -33,15 +33,15 @@ import org.springframework.test.context.junit.jupiter.SpringExtension;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link SimpleDataSourcesConfiguration}.
* Tests for {@link MyDataSourcesConfiguration}.
*
* @author Stephane Nicoll
*/
@ExtendWith(SpringExtension.class)
@SpringBootTest(properties = { "app.datasource.second.url=jdbc:h2:mem:bar;DB_CLOSE_DELAY=-1",
"app.datasource.second.max-total=42" })
@Import(SimpleDataSourcesConfiguration.class)
class SimpleDataSourcesConfigurationTests {
@Import(MyDataSourcesConfiguration.class)
class MyDataSourcesConfigurationTests {
@Autowired
private ApplicationContext context;

6
spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/webserver/usetomcatlegacycookieprocessor/LegacyCookieProcessorConfigurationTests.java → spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/webserver/usetomcatlegacycookieprocessor/MyLegacyCookieProcessorConfigurationTests.java
View File

@@ -31,16 +31,16 @@ import org.springframework.context.annotation.Configuration;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link LegacyCookieProcessorConfiguration}.
* Tests for {@link MyLegacyCookieProcessorConfiguration}.
*
* @author Andy Wilkinson
*/
class LegacyCookieProcessorConfigurationTests {
class MyLegacyCookieProcessorConfigurationTests {
@Test
void cookieProcessorIsCustomized() {
ServletWebServerApplicationContext applicationContext = (ServletWebServerApplicationContext) new SpringApplication(
TestConfiguration.class, LegacyCookieProcessorConfiguration.class).run();
TestConfiguration.class, MyLegacyCookieProcessorConfiguration.class).run();
Context context = (Context) ((TomcatWebServer) applicationContext.getWebServer()).getTomcat().getHost()
.findChildren()[0];
assertThat(context.getCookieProcessor()).isInstanceOf(LegacyCookieProcessor.class);