Skip to content

Commit d5c0009

Browse files
committed
Rename samples to smoke tests
Closes spring-projectsgh-17197
1 parent 0b720b9 commit d5c0009

File tree

743 files changed

+1440
-2134
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

743 files changed

+1440
-2134
lines changed

CONTRIBUTING.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ find the process a little slower than the standard build.
125125

126126
[TIP]
127127
====
128-
If you want to run a build without the samples and integration tests, building the
128+
If you want to run a build without the smoke tests and integration tests, building the
129129
`spring-boot-project` module is enough. You can cd there and run the same command, or you
130130
can run this from the top-level directory:
131131
@@ -196,7 +196,7 @@ changes just won't be automatically formatted.
196196

197197
With the requisite eclipse plugins installed you can select
198198
`import existing maven projects` from the `file` menu to import the code. You will
199-
need to import the root `spring-boot` pom and the `spring-boot-samples` pom separately.
199+
need to import the root `spring-boot` pom and the `spring-boot-smoke-tests` pom separately.
200200

201201

202202

@@ -241,11 +241,11 @@ Maven is well supported by most Java IDEs. Refer to your vendor documentation.
241241

242242

243243
== Integration Tests
244-
The sample applications are used as integration tests during the build (when you
245-
`./mvnw install`). Due to the fact that they make use of the `spring-boot-maven-plugin`
244+
The smoke tests run as part of the build when you `./mvnw install`.
245+
Due to the fact that they make use of the `spring-boot-maven-plugin`
246246
they cannot be called directly, and so instead are launched via the
247247
`maven-invoker-plugin`. If you encounter build failures running the integration tests,
248-
check the `build.log` file in the appropriate sample directory.
248+
check the `build.log` file in the appropriate smoke test directory.
249249

250250

251251
== Cloning the git repository on Windows

README.adoc

-3
Original file line numberDiff line numberDiff line change
@@ -251,9 +251,6 @@ Groovy samples for use with the command line application are available in
251251
link:spring-boot-project/spring-boot-cli/samples[spring-boot-cli/samples]. To run the CLI samples type
252252
`spring run <sample>.groovy` from samples directory.
253253

254-
Java samples are available in link:spring-boot-samples[spring-boot-samples] and should
255-
be built with maven and run by invoking `java -jar target/<sample>.jar`.
256-
257254

258255

259256
== Guides

ci/scripts/build-samples.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ source $(dirname $0)/common.sh
55
repository=$(pwd)/distribution-repository
66

77
pushd git-repo > /dev/null
8-
run_maven -f spring-boot-samples/pom.xml clean install -U -Dfull -Drepository=file://${repository}
8+
run_maven -f spring-boot-smoke-tests/pom.xml clean install -U -Dfull -Drepository=file://${repository}
99
popd > /dev/null

ci/scripts/stage.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ git commit -m"Release v$stageVersion" > /dev/null
3636
git tag -a "v$stageVersion" -m"Release v$stageVersion" > /dev/null
3737

3838
run_maven -f spring-boot-project/pom.xml clean deploy -U -Dfull -DaltDeploymentRepository=distribution::default::file://${repository}
39-
run_maven -f spring-boot-samples/pom.xml clean install -U -Dfull -Drepository=file://${repository}
39+
run_maven -f spring-boot-smoke-tests/pom.xml clean install -U -Dfull -Drepository=file://${repository}
4040
run_maven -f spring-boot-tests/spring-boot-integration-tests/pom.xml clean install -U -Dfull -Drepository=file://${repository}
4141
run_maven -f spring-boot-tests/spring-boot-deployment-tests/pom.xml clean install -U -Dfull -Drepository=file://${repository}
4242

eclipse/spring-boot-project.setup

+2-2
Original file line numberDiff line numberDiff line change
@@ -127,10 +127,10 @@
127127
pattern="spring-boot-starter(s|-.*)"/>
128128
</workingSet>
129129
<workingSet
130-
name="spring-boot-samples">
130+
name="spring-boot-smoke-tests">
131131
<predicate
132132
xsi:type="predicates:NamePredicate"
133-
pattern="spring-boot-sample(s|-.*)"/>
133+
pattern="spring-boot-smoke-test(s|-.*)"/>
134134
</workingSet>
135135
<workingSet
136136
name="spring-boot-tests">

pom.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@
106106
</build>
107107
<modules>
108108
<module>spring-boot-project</module>
109-
<!-- Samples are built via the invoker plugin -->
110-
<module>spring-boot-samples-invoker</module>
109+
<!-- Smoke tests are built via the invoker plugin -->
110+
<module>spring-boot-smoke-tests-invoker</module>
111111
<module>spring-boot-tests</module>
112112
</modules>
113113
</profile>
@@ -121,7 +121,7 @@
121121
</activation>
122122
<modules>
123123
<module>spring-boot-project</module>
124-
<module>spring-boot-samples</module>
124+
<module>spring-boot-smoke-tests</module>
125125
<module>spring-boot-tests</module>
126126
</modules>
127127
</profile>

spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc

+1-6
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,7 @@ editor for this example.
557557
[[getting-started-first-application-dependencies]]
558558
=== Adding Classpath Dependencies
559559
Spring Boot provides a number of "`Starters`" that let you add jars to your classpath.
560-
Our sample application has already used `spring-boot-starter-parent` in the `parent`
560+
Our applications for smoke tests use the `spring-boot-starter-parent` in the `parent`
561561
section of the POM. The `spring-boot-starter-parent` is a special starter that provides
562562
useful Maven defaults. It also provides a
563563
<<using-spring-boot.adoc#using-boot-dependency-management,`dependency-management`>>
@@ -819,11 +819,6 @@ https://spring.io/guides/[getting started] guides that solve specific "`How do I
819819
with Spring?`" problems. We also have Spring Boot-specific
820820
"`<<howto.adoc#howto, How-to>>`" reference documentation.
821821

822-
The https://github.com/{github-repo}[Spring Boot repository] also has a
823-
{github-code}/spring-boot-samples[bunch of samples] you can run. The samples are
824-
independent of the rest of the code (that is, you do not need to build the rest to run or
825-
use the samples).
826-
827822
Otherwise, the next logical step is to read _<<using-spring-boot.adoc#using-boot>>_. If
828823
you are really impatient, you could also jump ahead and read about
829824
_<<spring-boot-features.adoc#boot-features, Spring Boot features>>_.

spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc

+3-35
Original file line numberDiff line numberDiff line change
@@ -699,9 +699,7 @@ a plain HTTP connector at port 8080. Spring Boot does not support the configurat
699699
both an HTTP connector and an HTTPS connector through `application.properties`. If you
700700
want to have both, you need to configure one of them programmatically. We recommend using
701701
`application.properties` to configure HTTPS, as the HTTP connector is the easier of the
702-
two to configure programmatically. See the
703-
{github-code}/spring-boot-samples/spring-boot-sample-tomcat-multi-connectors[`spring-boot-sample-tomcat-multi-connectors`]
704-
sample project for an example.
702+
two to configure programmatically.
705703

706704

707705

@@ -1668,9 +1666,7 @@ And the following example shows one way to set up the starters in Gradle:
16681666

16691667
NOTE: The Log4j starters gather together the dependencies for common logging
16701668
requirements (such as having Tomcat use `java.util.logging` but configuring the
1671-
output using Log4j 2). See the
1672-
{github-code}/spring-boot-samples/spring-boot-sample-actuator-log4j2[Actuator Log4j 2]
1673-
samples for more detail and to see it in action.
1669+
output using Log4j 2).
16741670

16751671
NOTE: To ensure that debug logging performed using `java.util.logging` is routed into
16761672
Log4j 2, configure its https://logging.apache.org/log4j/2.0/log4j-jul/index.html[JDK
@@ -1895,9 +1891,7 @@ the same package (or a sub-package) of your `@EnableAutoConfiguration` class.
18951891
For many applications, all you need is to put the right Spring Data dependencies on
18961892
your classpath (there is a `spring-boot-starter-data-jpa` for JPA and a
18971893
`spring-boot-starter-data-mongodb` for Mongodb) and create some repository interfaces to
1898-
handle your `@Entity` objects. Examples are in the
1899-
{github-code}/spring-boot-samples/spring-boot-sample-data-jpa[JPA sample] and the
1900-
{github-code}/spring-boot-samples/spring-boot-sample-data-mongodb[Mongodb sample].
1894+
handle your `@Entity` objects.
19011895

19021896
Spring Boot tries to guess the location of your `@Repository` definitions, based on the
19031897
`@EnableAutoConfiguration` it finds. To get more control, use the `@EnableJpaRepositories`
@@ -2356,8 +2350,6 @@ is sufficient to cause Flyway to use its own `DataSource`. If any of the three
23562350
properties has not be set, the value of its equivalent `spring.datasource` property will
23572351
be used.
23582352

2359-
There is a {github-code}/spring-boot-samples/spring-boot-sample-flyway[Flyway sample] so
2360-
that you can see how to set things up.
23612353

23622354
You can also use Flyway to provide data for specific scenarios. For example, you can
23632355
place test-specific migrations in `src/test/resources` and they are run only when your
@@ -2399,9 +2391,6 @@ See
23992391
{sc-spring-boot-autoconfigure}/liquibase/LiquibaseProperties.{sc-ext}[`LiquibaseProperties`]
24002392
for details about available settings such as contexts, the default schema, and others.
24012393

2402-
There is a {github-code}/spring-boot-samples/spring-boot-sample-liquibase[Liquibase
2403-
sample] so that you can see how to set things up.
2404-
24052394

24062395

24072396
[[howto-messaging]]
@@ -3049,22 +3038,6 @@ The following example shows how to build an executable archive with Ant:
30493038
</target>
30503039
----
30513040

3052-
The {github-code}/spring-boot-samples/spring-boot-sample-ant[Ant Sample] has a
3053-
`build.xml` file with a `manual` task that should work if you run it with the following
3054-
command:
3055-
3056-
[indent=0,subs="verbatim,quotes,attributes"]
3057-
----
3058-
$ ant -lib <folder containing ivy-2.2.jar> clean manual
3059-
----
3060-
3061-
Then you can run the application with the following command:
3062-
3063-
[indent=0,subs="verbatim,quotes,attributes"]
3064-
----
3065-
$ java -jar target/*.jar
3066-
----
3067-
30683041

30693042

30703043
[[howto-traditional-deployment]]
@@ -3166,11 +3139,6 @@ file with the provided dependencies packaged in a `lib-provided` directory. This
31663139
that, in addition to being deployable to a servlet container, you can also run your
31673140
application by using `java -jar` on the command line.
31683141

3169-
TIP: Take a look at Spring Boot's sample applications for a
3170-
{github-code}/spring-boot-samples/spring-boot-sample-traditional/pom.xml[Maven-based
3171-
example] of the previously described configuration.
3172-
3173-
31743142

31753143

31763144
[[howto-convert-an-existing-application-to-spring-boot]]

spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

+1-11
Original file line numberDiff line numberDiff line change
@@ -1586,9 +1586,7 @@ You can also add a custom Spring `Validator` by creating a bean definition calle
15861586
configuration properties validator is created very early in the application's lifecycle,
15871587
and declaring the `@Bean` method as static lets the bean be created without having to
15881588
instantiate the `@Configuration` class. Doing so avoids any problems that may be caused
1589-
by early instantiation. There is a
1590-
{github-code}/spring-boot-samples/spring-boot-sample-property-validation[property
1591-
validation sample] that shows how to set things up.
1589+
by early instantiation.
15921590

15931591
TIP: The `spring-boot-actuator` module includes an endpoint that exposes all
15941592
`@ConfigurationProperties` beans. Point your web browser to
@@ -3212,9 +3210,6 @@ an `@Order`, which you can set with `spring.jersey.filter.order`. Both the servl
32123210
the filter registrations can be given init parameters by using `spring.jersey.init.*` to
32133211
specify a map of properties.
32143212

3215-
There is a {github-code}/spring-boot-samples/spring-boot-sample-jersey[Jersey sample] so
3216-
that you can see how to set things up.
3217-
32183213

32193214

32203215
[[boot-features-embedded-container]]
@@ -3422,9 +3417,6 @@ packaged as an executable archive), there are some limitations in the JSP suppor
34223417
<<boot-features-error-handling-custom-error-pages,Custom error pages>> should be used
34233418
instead.
34243419

3425-
There is a {github-code}/spring-boot-samples/spring-boot-sample-web-jsp[JSP sample] so
3426-
that you can see how to set things up.
3427-
34283420

34293421

34303422
[[boot-features-reactive-server]]
@@ -3646,8 +3638,6 @@ so does not disable the `UserDetailsService` configuration or Actuator's securit
36463638

36473639
To also switch off the `UserDetailsService` configuration, you can add a bean of type
36483640
`UserDetailsService`, `AuthenticationProvider`, or `AuthenticationManager`.
3649-
There are several secure applications in the {github-code}/spring-boot-samples/[Spring
3650-
Boot samples] to get you started with common use cases.
36513641

36523642
Access rules can be overridden by adding a custom `WebSecurityConfigurerAdapter`. Spring
36533643
Boot provides convenience methods that can be used to override access rules for actuator

0 commit comments

Comments
 (0)