Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6660,6 +6660,17 @@ NOTE: If you directly use `@ComponentScan` (that is, not through
`@SpringBootApplication`) you need to register the `TypeExcludeFilter` with it. See
{dc-spring-boot}/context/TypeExcludeFilter.{dc-ext}[the Javadoc] for details.

[[boot-features-testing-spring-boot-applications-arguments]]
==== Testing with Application Arguments

If your application expects <<boot-features-application-arguments,arguments>>, you can
have `@SpringBootTest` inject them using the `args` field.

[source,java,indent=0]
----
include::{test-examples}/context/ApplicationArgumentsExampleTests.java[tag=args]
}
----

[[boot-features-testing-spring-boot-applications-testing-with-mock-environment]]
==== Testing with a mock environment
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/*
* Copyright 2012-2018 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.docs.context;

// tag::args[]
import org.junit.Test;
import org.junit.runner.RunWith;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.annotation.Configuration;
import org.springframework.test.context.junit4.SpringRunner;

import static org.assertj.core.api.Assertions.assertThat;

@RunWith(SpringRunner.class)
@SpringBootTest(args = { "--foo=bar" })
public class ApplicationArgumentsExampleTests {

@Autowired
private ApplicationArguments args;

@Test
public void applicationArgumentsPopulated() {
assertThat(this.args.getOptionNames()).contains("foo");
assertThat(this.args.getOptionValues("foo")).contains("bar");
}

// end::args[]
@Configuration
protected static class Config {

}

}
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ else if (config instanceof ReactiveWebMergedContextConfiguration) {
application.setWebApplicationType(WebApplicationType.NONE);
}
application.setInitializers(initializers);
return application.run();
return application.run(getArgs(config));
}

/**
Expand All @@ -145,6 +145,19 @@ protected ConfigurableEnvironment getEnvironment() {
return new StandardEnvironment();
}

/**
* Get the {@link SpringBootTest#args()} (if present) specified in the annotated test
* class. If no args given, returns empty array.
* @param config the source context configuration
* @return the {@link SpringBootTest#args()} (if present) specified in the annotated
* test class, or empty array
*/
protected String[] getArgs(MergedContextConfiguration config) {
SpringBootTest annotation = AnnotatedElementUtils
.findMergedAnnotation(config.getTestClass(), SpringBootTest.class);
return (annotation != null) ? annotation.args() : new String[0];
}

private void setActiveProfiles(ConfigurableEnvironment environment,
String[] profiles) {
TestPropertyValues
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,12 @@
*/
Class<?>[] classes() default {};

/**
* Arguments that should be passed to the application under test.
* @return the arguments to pass to the application under test.
*/
String[] args() default {};

/**
* The type of web environment to create when applicable. Defaults to
* {@link WebEnvironment#MOCK}.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/*
* Copyright 2012-2017 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.test.context;

import org.junit.Test;
import org.junit.runner.RunWith;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.ApplicationArguments;
import org.springframework.context.annotation.Configuration;
import org.springframework.test.context.junit4.SpringRunner;

import static org.assertj.core.api.Assertions.assertThat;

/**
* Assert that tests annotated with {@link SpringBootTest} can specify
* {@link SpringBootTest#args()} to be passed to their application under test.
*
* @author Justin Griffin
*/
@RunWith(SpringRunner.class)
@SpringBootTest(args = { "--option.foo=option-foo-value", "other.bar=other-bar-value" })
public class SpringBootTestArgsTests {

@Autowired
private ApplicationArguments args;

@Test
public void applicationArgumentsPopulated() {
assertThat(this.args.getOptionNames()).contains("option.foo");
assertThat(this.args.getNonOptionArgs()).contains("other.bar=other-bar-value");
}

@Configuration
protected static class Config {

}

}