Update SpringApplicationBuilder example in the docs and test it

Closes gh-6488
This commit is contained in:
Andy Wilkinson 2016-08-16 13:14:56 +01:00
parent 05fc967335
commit 49202570e9
4 changed files with 109 additions and 5 deletions

View File

@ -730,6 +730,13 @@
<artifactId>jedis</artifactId>
<optional>true</optional>
</dependency>
<!-- Test dependencies -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot</artifactId>
<type>test-jar</type>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>

View File

@ -149,11 +149,7 @@ For example:
[source,java,indent=0]
----
new SpringApplicationBuilder()
.bannerMode(Banner.Mode.OFF)
.sources(Parent.class)
.child(Application.class)
.run(args);
include::{code-examples}/builder/SpringApplicationBuilderExample.java[tag=hierarchy]
----
NOTE: There are some restrictions when creating an `ApplicationContext` hierarchy, e.g.

View File

@ -0,0 +1,54 @@
/*
* 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.builder;
import org.springframework.boot.Banner;
/**
* Examples of using {@link SpringApplicationBuilder}.
*
* @author Andy Wilkinson
*/
public class SpringApplicationBuilderExample {
public void hierarchyWithDisabledBanner(String[] args) {
// @formatter:off
// tag::hierarchy[]
new SpringApplicationBuilder()
.sources(Parent.class)
.child(Application.class)
.bannerMode(Banner.Mode.OFF)
.run(args);
// end::hierarchy[]
// @formatter:on
}
/**
* Parent application configuration.
*/
static class Parent {
}
/**
* Application configuration.
*/
static class Application {
}
}

View File

@ -0,0 +1,47 @@
/*
* 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.builder;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.rule.OutputCapture;
import org.springframework.boot.testutil.ClassPathExclusions;
import org.springframework.boot.testutil.FilteredClassPathRunner;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link SpringApplicationBuilderExample}.
*
* @author Andy Wilkinson
*/
@RunWith(FilteredClassPathRunner.class)
@ClassPathExclusions("spring-web-*.jar")
public class SpringApplicationBuilderExampleTests {
@Rule
public OutputCapture outputCapture = new OutputCapture();
@Test
public void contextHierarchyWithDisabledBanner() {
new SpringApplicationBuilderExample().hierarchyWithDisabledBanner(new String[0]);
assertThat(this.outputCapture.toString()).doesNotContain(":: Spring Boot ::");
}
}