diff --git a/src/docs/asciidoc/testing.adoc b/src/docs/asciidoc/testing.adoc index cf92e6a313..77670fce30 100644 --- a/src/docs/asciidoc/testing.adoc +++ b/src/docs/asciidoc/testing.adoc @@ -9,9 +9,9 @@ :docinfo1: This chapter covers Spring's support for integration testing and best practices for unit -testing. The Spring team advocates test-driven development (TDD). -The Spring team has found that the correct use of inversion of control (IoC) certainly does make both unit and -integration testing easier (in that the presence of setter methods and appropriate +testing. The Spring team advocates test-driven development (TDD). The Spring team has +found that the correct use of inversion of control (IoC) certainly does make both unit +and integration testing easier (in that the presence of setter methods and appropriate constructors on classes makes them easier to wire together in a test without having to set up service locator registries and similar structures). @@ -36,18 +36,17 @@ be with traditional Java EE development. The POJOs that make up your application be testable in JUnit or TestNG tests, with objects instantiated by using the `new` operator, without Spring or any other container. You can use <> (in conjunction with other valuable testing techniques) to test your code in -isolation. If you follow the architecture recommendations for Spring, the resulting -clean layering and componentization of your codebase facilitate easier unit -testing. For example, you can test service layer objects by stubbing or mocking DAO or -repository interfaces, without needing to access persistent data while running unit -tests. +isolation. If you follow the architecture recommendations for Spring, the resulting clean +layering and componentization of your codebase facilitate easier unit testing. For +example, you can test service layer objects by stubbing or mocking DAO or repository +interfaces, without needing to access persistent data while running unit tests. -True unit tests typically run extremely quickly, as there is no runtime infrastructure -to set up. Emphasizing true unit tests as part of your development methodology can -boost your productivity. You may not need this section of the testing chapter to help -you write effective unit tests for your IoC-based applications. For certain unit testing -scenarios, however, the Spring Framework provides mock objects and testing -support classes, which are described in this chapter. +True unit tests typically run extremely quickly, as there is no runtime infrastructure to +set up. Emphasizing true unit tests as part of your development methodology can boost +your productivity. You may not need this section of the testing chapter to help you write +effective unit tests for your IoC-based applications. For certain unit testing scenarios, +however, the Spring Framework provides mock objects and testing support classes, which +are described in this chapter. @@ -80,9 +79,9 @@ out-of-container tests for code that depends on environment-specific properties. The `org.springframework.mock.jndi` package contains an implementation of the JNDI SPI, which you can use to set up a simple JNDI environment for test suites or stand-alone -applications. If, for example, JDBC `DataSource` instances get bound to the same JNDI names in -test code as they do in a Java EE container, you can reuse both application code and -configuration in testing scenarios without modification. +applications. If, for example, JDBC `DataSource` instances get bound to the same JNDI +names in test code as they do in a Java EE container, you can reuse both application code +and configuration in testing scenarios without modification. @@ -92,37 +91,34 @@ configuration in testing scenarios without modification. The `org.springframework.mock.web` package contains a comprehensive set of Servlet API mock objects that are useful for testing web contexts, controllers, and filters. These mock objects are targeted at usage with Spring's Web MVC framework and are generally more -convenient to use than dynamic mock objects (such as http://www.easymock.org[EasyMock]) or -alternative Servlet API mock objects (such as http://www.mockobjects.com[MockObjects]). +convenient to use than dynamic mock objects (such as http://www.easymock.org[EasyMock]) +or alternative Servlet API mock objects (such as http://www.mockobjects.com[MockObjects]). -TIP: Since Spring Framework 5.0, the mock objects in `org.springframework.mock.web` are based -on the Servlet 4.0 API. +TIP: Since Spring Framework 5.0, the mock objects in `org.springframework.mock.web` are +based on the Servlet 4.0 API. The Spring MVC Test framework builds on the mock Servlet API objects to provide an -integration testing framework for Spring MVC. See -<>. +integration testing framework for Spring MVC. See <>. [[mock-objects-web-reactive]] ==== Spring Web Reactive -The `org.springframework.mock.http.server.reactive` package contains mock -implementations of `ServerHttpRequest` and `ServerHttpResponse` for use in WebFlux -applications. The `org.springframework.mock.web.server` package -contains a mock `ServerWebExchange` that depends on those mock request and response -objects. +The `org.springframework.mock.http.server.reactive` package contains mock implementations +of `ServerHttpRequest` and `ServerHttpResponse` for use in WebFlux applications. The +`org.springframework.mock.web.server` package contains a mock `ServerWebExchange` that +depends on those mock request and response objects. -Both `MockServerHttpRequest` and `MockServerHttpResponse` extend from the same -abstract base classes as server-specific implementations and share behavior with them. -For example, a mock request is immutable once created, but you can use the `mutate()` method +Both `MockServerHttpRequest` and `MockServerHttpResponse` extend from the same abstract +base classes as server-specific implementations and share behavior with them. For +example, a mock request is immutable once created, but you can use the `mutate()` method from `ServerHttpRequest` to create a modified instance. In order for the mock response to properly implement the write contract and return a write completion handle (that is, `Mono`), it by default uses a `Flux` with -`cache().then()`, which buffers the data and makes it available for assertions in -tests. Applications can set a custom write function (for example, to test an infinite -stream). +`cache().then()`, which buffers the data and makes it available for assertions in tests. +Applications can set a custom write function (for example, to test an infinite stream). The <> builds on the mock request and response to provide support for testing WebFlux applications without an HTTP server. The client can also be used for @@ -150,36 +146,39 @@ for use in unit and integration testing. `ReflectionTestUtils` is a collection of reflection-based utility methods. You can use these methods in testing scenarios where you need to change the value of a constant, set a non-`public` field, invoke a non-`public` setter method, or invoke a non-`public` -configuration or lifecycle callback method when testing application code for -use cases such as the following: +configuration or lifecycle callback method when testing application code for use cases +such as the following: * ORM frameworks (such as JPA and Hibernate) that condone `private` or `protected` field access as opposed to `public` setter methods for properties in a domain entity. * Spring's support for annotations (such as `@Autowired`, `@Inject`, and `@Resource`), - that provide dependency injection for `private` or `protected` fields, setter - methods, and configuration methods. + that provide dependency injection for `private` or `protected` fields, setter methods, + and configuration methods. * Use of annotations such as `@PostConstruct` and `@PreDestroy` for lifecycle callback methods. -{api-spring-framework}/test/util/AopTestUtils.html[`AopTestUtils`] is a collection of AOP-related utility methods. You can use these methods -to obtain a reference to the underlying target object hidden behind one or more Spring -proxies. For example, if you have configured a bean as a dynamic mock by using a library -such as EasyMock or Mockito, and the mock is wrapped in a Spring proxy, you may need direct -access to the underlying mock to configure expectations on it and perform -verifications. For Spring's core AOP utilities, see {api-spring-framework}/aop/support/AopUtils.html[`AopUtils`] and {api-spring-framework}/aop/framework/AopProxyUtils.html[`AopProxyUtils`]. +{api-spring-framework}/test/util/AopTestUtils.html[`AopTestUtils`] is a collection of +AOP-related utility methods. You can use these methods to obtain a reference to the +underlying target object hidden behind one or more Spring proxies. For example, if you +have configured a bean as a dynamic mock by using a library such as EasyMock or Mockito, +and the mock is wrapped in a Spring proxy, you may need direct access to the underlying +mock to configure expectations on it and perform verifications. For Spring's core AOP +utilities, see {api-spring-framework}/aop/support/AopUtils.html[`AopUtils`] and +{api-spring-framework}/aop/framework/AopProxyUtils.html[`AopProxyUtils`]. [[unit-testing-spring-mvc]] ==== Spring MVC Testing Utilities -The `org.springframework.test.web` package contains {api-spring-framework}/test/web/ModelAndViewAssert.html[`ModelAndViewAssert`], which you can -use in combination with JUnit, TestNG, or any other testing framework for unit tests +The `org.springframework.test.web` package contains +{api-spring-framework}/test/web/ModelAndViewAssert.html[`ModelAndViewAssert`], which you +can use in combination with JUnit, TestNG, or any other testing framework for unit tests that deal with Spring MVC `ModelAndView` objects. .Unit testing Spring MVC Controllers -TIP: To unit test your Spring MVC `Controller` classes as POJOs, use `ModelAndViewAssert` combined -with `MockHttpServletRequest`, `MockHttpSession`, and so on from Spring's +TIP: To unit test your Spring MVC `Controller` classes as POJOs, use `ModelAndViewAssert` +combined with `MockHttpServletRequest`, `MockHttpSession`, and so on from Spring's <>. For thorough integration testing of your Spring MVC and REST `Controller` classes in conjunction with your `WebApplicationContext` configuration for Spring MVC, use the <> instead. [[integration-testing]] == Integration Testing -This section (most of the rest of this chapter) covers integration testing for -Spring applications. It includes the following topics: +This section (most of the rest of this chapter) covers integration testing for Spring +applications. It includes the following topics: * <> * <> @@ -211,18 +210,18 @@ deployment to your application server or connecting to other enterprise infrastr Doing so lets you test things such as: * The correct wiring of your Spring IoC container contexts. -* Data access using JDBC or an ORM tool. This can include such things as the - correctness of SQL statements, Hibernate queries, JPA entity mappings, and so forth. +* Data access using JDBC or an ORM tool. This can include such things as the correctness + of SQL statements, Hibernate queries, JPA entity mappings, and so forth. The Spring Framework provides first-class support for integration testing in the `spring-test` module. The name of the actual JAR file might include the release version -and might also be in the long `org.springframework.test` form, depending on where you -get it from (see the <> for an -explanation). This library includes the `org.springframework.test` package, which +and might also be in the long `org.springframework.test` form, depending on where you get +it from (see the <> for +an explanation). This library includes the `org.springframework.test` package, which contains valuable classes for integration testing with a Spring container. This testing does not rely on an application server or other deployment environment. Such tests are -slower to run than unit tests but much faster than the equivalent Selenium tests or remote -tests that rely on deployment to an application server. +slower to run than unit tests but much faster than the equivalent Selenium tests or +remote tests that rely on deployment to an application server. In Spring 2.5 and later, unit and integration testing support is provided in the form of the annotation-driven <>. The @@ -251,28 +250,28 @@ configuration details. ==== Context Management and Caching The Spring TestContext Framework provides consistent loading of Spring -`ApplicationContext` instances and `WebApplicationContext` instances as well as caching of those -contexts. Support for the caching of loaded contexts is important, because startup time -can become an issue -- not because of the overhead of Spring itself, but because the -objects instantiated by the Spring container take time to instantiate. For example, a -project with 50 to 100 Hibernate mapping files might take 10 to 20 seconds to load the -mapping files, and incurring that cost before running every test in every test fixture -leads to slower overall test runs that reduce developer productivity. +`ApplicationContext` instances and `WebApplicationContext` instances as well as caching +of those contexts. Support for the caching of loaded contexts is important, because +startup time can become an issue -- not because of the overhead of Spring itself, but +because the objects instantiated by the Spring container take time to instantiate. For +example, a project with 50 to 100 Hibernate mapping files might take 10 to 20 seconds to +load the mapping files, and incurring that cost before running every test in every test +fixture leads to slower overall test runs that reduce developer productivity. Test classes typically declare either an array of resource locations for XML or Groovy -configuration metadata -- often in the classpath -- or an array of annotated classes -that is used to configure the application. These locations or classes are the same as or +configuration metadata -- often in the classpath -- or an array of annotated classes that +is used to configure the application. These locations or classes are the same as or similar to those specified in `web.xml` or other configuration files for production deployments. By default, once loaded, the configured `ApplicationContext` is reused for each test. Thus, the setup cost is incurred only once per test suite, and subsequent test execution is much faster. In this context, the term "`test suite`" means all tests run in the same -JVM -- for example, all tests run from an Ant, Maven, or Gradle build for a given -project or module. In the unlikely case that a test corrupts the application context and -requires reloading (for example, by modifying a bean definition or the state of an -application object) the TestContext framework can be configured to reload the -configuration and rebuild the application context before executing the next test. +JVM -- for example, all tests run from an Ant, Maven, or Gradle build for a given project +or module. In the unlikely case that a test corrupts the application context and requires +reloading (for example, by modifying a bean definition or the state of an application +object) the TestContext framework can be configured to reload the configuration and +rebuild the application context before executing the next test. See <> and <> with the TestContext framework. @@ -285,9 +284,9 @@ When the TestContext framework loads your application context, it can optionally configure instances of your test classes by using Dependency Injection. This provides a convenient mechanism for setting up test fixtures by using preconfigured beans from your application context. A strong benefit here is that you can reuse application contexts -across various testing scenarios (for example, for configuring Spring-managed object graphs, -transactional proxies, `DataSource` instances, and others), thus avoiding the need to duplicate -complex test fixture setup for individual test cases. +across various testing scenarios (for example, for configuring Spring-managed object +graphs, transactional proxies, `DataSource` instances, and others), thus avoiding the +need to duplicate complex test fixture setup for individual test cases. As an example, consider a scenario where we have a class (`HibernateTitleRepository`) that implements data access logic for a `Title` domain entity. We want to write @@ -297,8 +296,8 @@ integration tests that test the following areas: `HibernateTitleRepository` bean correct and present? * The Hibernate mapping file configuration: Is everything mapped correctly and are the correct lazy-loading settings in place? -* The logic of the `HibernateTitleRepository`: Does the configured instance of this - class perform as anticipated? +* The logic of the `HibernateTitleRepository`: Does the configured instance of this class + perform as anticipated? See dependency injection of test fixtures with the <>. @@ -308,24 +307,23 @@ framework>>. [[testing-tx]] ==== Transaction Management -One common issue in tests that access a real database is their effect on the state of -the persistence store. Even when you use a development database, changes to the -state may affect future tests. Also, many operations -- such as inserting or modifying -persistent data -- cannot be performed (or verified) outside of a transaction. - -The TestContext framework addresses this issue. By default, the framework creates -and rolls back a transaction for each test. You can write code that can assume the -existence of a transaction. If you call transactionally proxied objects in your tests, -they behave correctly, according to their configured transactional semantics. In -addition, if a test method deletes the contents of selected tables while running within -the transaction managed for the test, the transaction rolls back by default, and the -database returns to its state prior to execution of the test. Transactional support -is provided to a test by using a `PlatformTransactionManager` bean defined in the test's -application context. +One common issue in tests that access a real database is their effect on the state of the +persistence store. Even when you use a development database, changes to the state may +affect future tests. Also, many operations -- such as inserting or modifying persistent +data -- cannot be performed (or verified) outside of a transaction. + +The TestContext framework addresses this issue. By default, the framework creates and +rolls back a transaction for each test. You can write code that can assume the existence +of a transaction. If you call transactionally proxied objects in your tests, they behave +correctly, according to their configured transactional semantics. In addition, if a test +method deletes the contents of selected tables while running within the transaction +managed for the test, the transaction rolls back by default, and the database returns to +its state prior to execution of the test. Transactional support is provided to a test by +using a `PlatformTransactionManager` bean defined in the test's application context. If you want a transaction to commit (unusual, but occasionally useful when you want a -particular test to populate or modify the database), you can tell the TestContext framework -to cause the transaction to commit instead of roll back by using the +particular test to populate or modify the database), you can tell the TestContext +framework to cause the transaction to commit instead of roll back by using the <> annotation. See transaction management with the <>. @@ -342,11 +340,11 @@ which let you access: * The `ApplicationContext`, for performing explicit bean lookups or testing the state of the context as a whole. -* A `JdbcTemplate`, for executing SQL statements to query the database. You can use such queries - to confirm database state both before and after execution of - database-related application code, and Spring ensures that such queries run in the - scope of the same transaction as the application code. When used in conjunction with - an ORM tool, be sure to avoid <>. +* A `JdbcTemplate`, for executing SQL statements to query the database. You can use such + queries to confirm database state both before and after execution of database-related + application code, and Spring ensures that such queries run in the scope of the same + transaction as the application code. When used in conjunction with an ORM tool, be sure + to avoid <>. In addition, you may want to create your own custom, application-wide superclass with instance variables and methods specific to your project. @@ -364,26 +362,25 @@ testing scenarios. Specifically, `JdbcTestUtils` provides the following static u methods. * `countRowsInTable(..)`: Counts the number of rows in the given table. -* `countRowsInTableWhere(..)`: Counts the number of rows in the given table by using -the provided `WHERE` clause. +* `countRowsInTableWhere(..)`: Counts the number of rows in the given table by using the + provided `WHERE` clause. * `deleteFromTables(..)`: Deletes all rows from the specified tables. * `deleteFromTableWhere(..)`: Deletes rows from the given table by using the provided -`WHERE` clause. + `WHERE` clause. * `dropTables(..)`: Drops the specified tables. [TIP] ==== -<> and -<> +<> +and <> provide convenience methods that delegate to the aforementioned methods in `JdbcTestUtils`. The `spring-jdbc` module provides support for configuring and launching an embedded database, which you can use in integration tests that interact with a database. For -details, see <> -and <>. +details, see <> and <>. ==== @@ -405,10 +402,10 @@ includes the following topics: [[integration-testing-annotations-spring]] ==== Spring Testing Annotations -The Spring Framework provides the following set of Spring-specific annotations that -you can use in your unit and integration tests in conjunction with the TestContext -framework. See the corresponding Javadoc for further information, including -default attribute values, attribute aliases, and other details. +The Spring Framework provides the following set of Spring-specific annotations that you +can use in your unit and integration tests in conjunction with the TestContext framework. +See the corresponding Javadoc for further information, including default attribute +values, attribute aliases, and other details. Spring's testing annotations include the following: @@ -434,9 +431,10 @@ Spring's testing annotations include the following: ===== `@BootstrapWith` `@BootstrapWith` is a class-level annotation that you can use to configure how the Spring -TestContext Framework is bootstrapped. Specifically, you can use `@BootstrapWith` to specify -a custom `TestContextBootstrapper`. See the <> section for further details. +TestContext Framework is bootstrapped. Specifically, you can use `@BootstrapWith` to +specify a custom `TestContextBootstrapper`. See the +<> section for further +details. @@ -448,8 +446,8 @@ load and configure an `ApplicationContext` for integration tests. Specifically, `@ContextConfiguration` declares the application context resource `locations` or the annotated `classes` used to load the context. -Resource locations are typically XML configuration files or Groovy scripts located in -the classpath, while annotated classes are typically `@Configuration` classes. However, +Resource locations are typically XML configuration files or Groovy scripts located in the +classpath, while annotated classes are typically `@Configuration` classes. However, resource locations can also refer to files and scripts in the file system, and annotated classes can be component classes, and so on. @@ -520,8 +518,8 @@ The following example uses both a location and a loader: NOTE: `@ContextConfiguration` provides support for inheriting resource locations or configuration classes as well as context initializers that are declared by superclasses. -See <> and the `@ContextConfiguration` javadocs for -further details. +See <> and the `@ContextConfiguration` javadocs for further +details. @@ -552,10 +550,10 @@ The following example shows how to use the `@WebAppConfiguration` annotation: <1> The `@WebAppConfiguration` annotation. ==== -To override the default, you can specify a different base resource path by using the implicit -`value` attribute. Both `classpath:` and `file:` resource prefixes are supported. If no -resource prefix is supplied, the path is assumed to be a file system resource. -The following example shows how to specify a classpath resource: +To override the default, you can specify a different base resource path by using the +implicit `value` attribute. Both `classpath:` and `file:` resource prefixes are +supported. If no resource prefix is supplied, the path is assumed to be a file system +resource. The following example shows how to specify a classpath resource: ==== [source,java,indent=0] @@ -572,7 +570,9 @@ The following example shows how to specify a classpath resource: Note that `@WebAppConfiguration` must be used in conjunction with `@ContextConfiguration`, either within a single test class or within a test class -hierarchy. See the {api-spring-framework}/test/context/web/WebAppConfiguration.html[`@WebAppConfiguration` Javadoc] for further details. +hierarchy. See the +{api-spring-framework}/test/context/web/WebAppConfiguration.html[`@WebAppConfiguration` +Javadoc] for further details. @@ -580,11 +580,11 @@ hierarchy. See the {api-spring-framework}/test/context/web/WebAppConfiguration.h ===== `@ContextHierarchy` `@ContextHierarchy` is a class-level annotation that is used to define a hierarchy of -`ApplicationContext` instances for integration tests. `@ContextHierarchy` should be declared -with a list of one or more `@ContextConfiguration` instances, each of which defines a -level in the context hierarchy. The following examples demonstrate the use of -`@ContextHierarchy` within a single test class (`@ContextHierarchy` can also be -used within a test class hierarchy): +`ApplicationContext` instances for integration tests. `@ContextHierarchy` should be +declared with a list of one or more `@ContextConfiguration` instances, each of which +defines a level in the context hierarchy. The following examples demonstrate the use of +`@ContextHierarchy` within a single test class (`@ContextHierarchy` can also be used +within a test class hierarchy): ==== [source,java,indent=0] @@ -614,10 +614,10 @@ used within a test class hierarchy): ==== If you need to merge or override the configuration for a given level of the context -hierarchy within a test class hierarchy, you must explicitly name that level by -supplying the same value to the `name` attribute in `@ContextConfiguration` at each -corresponding level in the class hierarchy. See -<> and the {api-spring-framework}/test/context/ContextHierarchy.html[`@ContextHierarchy` Javadoc] +hierarchy within a test class hierarchy, you must explicitly name that level by supplying +the same value to the `name` attribute in `@ContextConfiguration` at each corresponding +level in the class hierarchy. See <> and the +{api-spring-framework}/test/context/ContextHierarchy.html[`@ContextHierarchy` Javadoc] for further examples. @@ -661,27 +661,29 @@ be active: ==== NOTE: `@ActiveProfiles` provides support for inheriting active bean definition profiles -declared by superclasses by default. You can also resolve active bean -definition profiles programmatically by implementing a custom +declared by superclasses by default. You can also resolve active bean definition profiles +programmatically by implementing a custom <> and registering it by using the `resolver` attribute of `@ActiveProfiles`. -See <> and the {api-spring-framework}/test/context/ActiveProfiles.html[`@ActiveProfiles` Javadoc] -for examples and further details. +See <> and the +{api-spring-framework}/test/context/ActiveProfiles.html[`@ActiveProfiles` Javadoc] for +examples and further details. [[spring-testing-annotation-testpropertysource]] ===== `@TestPropertySource` -`@TestPropertySource` is a class-level annotation that you can use to configure the locations -of properties files and inlined properties to be added to the set of `PropertySources` in -the `Environment` for an `ApplicationContext` loaded for an integration test. +`@TestPropertySource` is a class-level annotation that you can use to configure the +locations of properties files and inlined properties to be added to the set of +`PropertySources` in the `Environment` for an `ApplicationContext` loaded for an +integration test. Test property sources have higher precedence than those loaded from the operating system's environment or Java system properties as well as property sources added by the -application declaratively through `@PropertySource` or programmatically. Thus, test property -sources can be used to selectively override properties defined in system and application -property sources. Furthermore, inlined properties have higher precedence than properties -loaded from resource locations. +application declaratively through `@PropertySource` or programmatically. Thus, test +property sources can be used to selectively override properties defined in system and +application property sources. Furthermore, inlined properties have higher precedence than +properties loaded from resource locations. The following example demonstrates how to declare a properties file from the classpath: @@ -719,16 +721,17 @@ The following example demonstrates how to declare inlined properties: ===== `@DirtiesContext` `@DirtiesContext` indicates that the underlying Spring `ApplicationContext` has been -dirtied during the execution of a test (that is, the test modified or corrupted it in some manner -- -for example, by changing the state of a singleton bean) and should be closed. When an -application context is marked as dirty, it is removed from the testing framework's cache -and closed. As a consequence, the underlying Spring container is rebuilt for any -subsequent test that requires a context with the same configuration metadata. +dirtied during the execution of a test (that is, the test modified or corrupted it in +some manner -- for example, by changing the state of a singleton bean) and should be +closed. When an application context is marked as dirty, it is removed from the testing +framework's cache and closed. As a consequence, the underlying Spring container is +rebuilt for any subsequent test that requires a context with the same configuration +metadata. You can use `@DirtiesContext` as both a class-level and a method-level annotation within the same class or class hierarchy. In such scenarios, the `ApplicationContext` is marked -as dirty before or after any such annotated method as well as before or after the -current test class, depending on the configured `methodMode` and `classMode`. +as dirty before or after any such annotated method as well as before or after the current +test class, depending on the configured `methodMode` and `classMode`. The following examples explain when the context would be dirtied for various configuration scenarios: @@ -827,11 +830,11 @@ mode set to `AFTER_EACH_TEST_METHOD.` If you use `@DirtiesContext` in a test whose context is configured as part of a context hierarchy with `@ContextHierarchy`, you can use the `hierarchyMode` flag to control how -the context cache is cleared. By default, an exhaustive algorithm is used to -clear the context cache, including not only the current level but also all other context +the context cache is cleared. By default, an exhaustive algorithm is used to clear the +context cache, including not only the current level but also all other context hierarchies that share an ancestor context common to the current test. All -`ApplicationContext` instances that reside in a sub-hierarchy of the common ancestor context -are removed from the context cache and closed. If the exhaustive algorithm is +`ApplicationContext` instances that reside in a sub-hierarchy of the common ancestor +context are removed from the context cache and closed. If the exhaustive algorithm is overkill for a particular use case, you can specify the simpler current level algorithm, as the following example shows. @@ -887,8 +890,9 @@ The following example shows how to register two `TestExecutionListener` implemen <1> Register two `TestExecutionListener` implementations. ==== -By default, `@TestExecutionListeners` supports inherited listeners. See the {api-spring-framework}/test/context/TestExecutionListeners.html[Javadoc] -for an example and further details. +By default, `@TestExecutionListeners` supports inherited listeners. See the +{api-spring-framework}/test/context/TestExecutionListeners.html[Javadoc] for an example +and further details. @@ -897,9 +901,9 @@ for an example and further details. `@Commit` indicates that the transaction for a transactional test method should be committed after the test method has completed. You can use `@Commit` as a direct -replacement for `@Rollback(false)` to more explicitly convey the intent of the -code. Analogous to `@Rollback`, `@Commit` can also be declared as a class-level or -method-level annotation. +replacement for `@Rollback(false)` to more explicitly convey the intent of the code. +Analogous to `@Rollback`, `@Commit` can also be declared as a class-level or method-level +annotation. The following example shows how to use the `@Commit` annotation: @@ -923,9 +927,9 @@ The following example shows how to use the `@Commit` annotation: `@Rollback` indicates whether the transaction for a transactional test method should be rolled back after the test method has completed. If `true`, the transaction is rolled -back. Otherwise, the transaction is committed (see also <>). Rollback -for integration tests in the Spring TestContext Framework defaults to `true` even if -`@Rollback` is not explicitly declared. +back. Otherwise, the transaction is committed (see also +<>). Rollback for integration tests in the Spring +TestContext Framework defaults to `true` even if `@Rollback` is not explicitly declared. When declared as a class-level annotation, `@Rollback` defines the default rollback semantics for all test methods within the test class hierarchy. When declared as a @@ -953,8 +957,8 @@ result is committed to the database): [[spring-testing-annotation-beforetransaction]] ===== `@BeforeTransaction` -`@BeforeTransaction` indicates that the annotated `void` method should be run -before a transaction is started, for test methods that have been configured to run within a +`@BeforeTransaction` indicates that the annotated `void` method should be run before a +transaction is started, for test methods that have been configured to run within a transaction by using Spring's `@Transactional` annotation. As of Spring Framework 4.3, `@BeforeTransaction` methods are not required to be `public` and may be declared on Java 8-based interface default methods. @@ -976,11 +980,11 @@ The following example shows how to use the `@BeforeTransaction` annotation: [[spring-testing-annotation-aftertransaction]] ===== `@AfterTransaction` -`@AfterTransaction` indicates that the annotated `void` method should be run -after a transaction is ended, for test methods that have been configured to run within a transaction -by using Spring's `@Transactional` annotation. As of Spring Framework 4.3, `@AfterTransaction` -methods are not required to be `public` and may be declared on Java 8-based interface -default methods. +`@AfterTransaction` indicates that the annotated `void` method should be run after a +transaction is ended, for test methods that have been configured to run within a +transaction by using Spring's `@Transactional` annotation. As of Spring Framework 4.3, +`@AfterTransaction` methods are not required to be `public` and may be declared on Java +8-based interface default methods. ==== [source,java,indent=0] @@ -999,9 +1003,9 @@ default methods. [[spring-testing-annotation-sql]] ===== `@Sql` -`@Sql` is used to annotate a test class or test method to configure SQL scripts to be -run against a given database during integration tests. The following example shows -how to use it: +`@Sql` is used to annotate a test class or test method to configure SQL scripts to be run +against a given database during integration tests. The following example shows how to use +it: ==== [source,java,indent=0] @@ -1023,8 +1027,8 @@ See <> for further details. [[spring-testing-annotation-sqlconfig]] ===== `@SqlConfig` -`@SqlConfig` defines metadata that is used to determine how to parse and run SQL -scripts configured with the `@Sql` annotation. The following example shows how to use it: +`@SqlConfig` defines metadata that is used to determine how to parse and run SQL scripts +configured with the `@Sql` annotation. The following example shows how to use it: ==== [source,java,indent=0] @@ -1047,11 +1051,11 @@ scripts configured with the `@Sql` annotation. The following example shows how t [[spring-testing-annotation-sqlgroup]] ===== `@SqlGroup` -`@SqlGroup` is a container annotation that aggregates several `@Sql` annotations. -You can use `@SqlGroup` natively to declare several nested `@Sql` annotations, or you can -use it in conjunction with Java 8's support for repeatable annotations, where `@Sql` can -be declared several times on the same class or method, implicitly generating this -container annotation. The following example shows how to declare an SQL group: +`@SqlGroup` is a container annotation that aggregates several `@Sql` annotations. You can +use `@SqlGroup` natively to declare several nested `@Sql` annotations, or you can use it +in conjunction with Java 8's support for repeatable annotations, where `@Sql` can be +declared several times on the same class or method, implicitly generating this container +annotation. The following example shows how to declare an SQL group: ==== [source,java,indent=0] @@ -1074,9 +1078,9 @@ container annotation. The following example shows how to declare an SQL group: [[integration-testing-annotations-standard]] ==== Standard Annotation Support -The following annotations are supported with standard semantics for all configurations -of the Spring TestContext Framework. Note that these annotations are not specific to -tests and can be used anywhere in the Spring Framework. +The following annotations are supported with standard semantics for all configurations of +the Spring TestContext Framework. Note that these annotations are not specific to tests +and can be used anywhere in the Spring Framework. * `@Autowired` * `@Qualifier` @@ -1096,13 +1100,13 @@ In the Spring TestContext Framework, you can use `@PostConstruct` and `@PreDestr standard semantics on any application components configured in the `ApplicationContext`. However, these lifecycle annotations have limited usage within an actual test class. -If a method within a test class is annotated with `@PostConstruct`, that method -runs before any before methods of the underlying test framework (for example, methods -annotated with JUnit Jupiter's `@BeforeEach`), and that applies for every test method -in the test class. On the other hand, if a method within a test class is annotated with -`@PreDestroy`, that method never runs. Therefore, within a test class, we -recommend that you use test lifecycle callbacks from the underlying test framework -instead of `@PostConstruct` and `@PreDestroy`. +If a method within a test class is annotated with `@PostConstruct`, that method runs +before any before methods of the underlying test framework (for example, methods +annotated with JUnit Jupiter's `@BeforeEach`), and that applies for every test method in +the test class. On the other hand, if a method within a test class is annotated with +`@PreDestroy`, that method never runs. Therefore, within a test class, we recommend that +you use test lifecycle callbacks from the underlying test framework instead of +`@PostConstruct` and `@PreDestroy`. ==== @@ -1111,8 +1115,8 @@ instead of `@PostConstruct` and `@PreDestroy`. ==== Spring JUnit 4 Testing Annotations The following annotations are supported only when used in conjunction with the -<>, <>, or <>: +<>, <>, or <>: * <> * <> @@ -1126,16 +1130,15 @@ The following annotations are supported only when used in conjunction with the `@IfProfileValue` indicates that the annotated test is enabled for a specific testing environment. If the configured `ProfileValueSource` returns a matching `value` for the -provided `name`, the test is enabled. Otherwise, the test is disabled and, -effectively, ignored. +provided `name`, the test is enabled. Otherwise, the test is disabled and, effectively, +ignored. You can apply `@IfProfileValue` at the class level, the method level, or both. Class-level usage of `@IfProfileValue` takes precedence over method-level usage for any methods within that class or its subclasses. Specifically, a test is enabled if it is -enabled both at the class level and at the method level. The absence of -`@IfProfileValue` means the test is implicitly enabled. This is analogous to the -semantics of JUnit 4's `@Ignore` annotation, except that the presence of `@Ignore` always -disables a test. +enabled both at the class level and at the method level. The absence of `@IfProfileValue` +means the test is implicitly enabled. This is analogous to the semantics of JUnit 4's +`@Ignore` annotation, except that the presence of `@Ignore` always disables a test. The following example shows a test that has an `@IfProfileValue` annotation: @@ -1201,9 +1204,9 @@ use `@ProfileValueSourceConfiguration`: time period (in milliseconds). If the text execution time exceeds the specified time period, the test fails. -The time period includes running the test method itself, any repetitions of the -test (see `@Repeat`), as well as any setting up or tearing down of the test fixture. -The following example shows how to use it: +The time period includes running the test method itself, any repetitions of the test (see +`@Repeat`), as well as any setting up or tearing down of the test fixture. The following +example shows how to use it: ==== [source,java,indent=0] @@ -1229,12 +1232,12 @@ before failing. [[integration-testing-annotations-junit4-repeat]] ===== `@Repeat` -`@Repeat` indicates that the annotated test method must be run repeatedly. The -number of times that the test method is to be executed is specified in the annotation. +`@Repeat` indicates that the annotated test method must be run repeatedly. The number of +times that the test method is to be executed is specified in the annotation. The scope of execution to be repeated includes execution of the test method itself as -well as any setting up or tearing down of the test fixture. -The following example shows how to use the `@Repeat` annotation: +well as any setting up or tearing down of the test fixture. The following example shows +how to use the `@Repeat` annotation: ==== [source,java,indent=0] @@ -1290,8 +1293,8 @@ configuration class: <1> Specify the configuration class. ==== -The following example shows how to use the `@SpringJUnitConfig` annotation to specify -the location of a configuration file: +The following example shows how to use the `@SpringJUnitConfig` annotation to specify the +location of a configuration file: ==== [source,java,indent=0] @@ -1305,8 +1308,9 @@ the location of a configuration file: <1> Specify the location of a configuration file. ==== -See <> as well as the {api-spring-framework}/test/context/junit/jupiter/SpringJUnitConfig.html[Javadoc for `@SpringJUnitConfig`] and -`@ContextConfiguration` for further details. +See <> as well as the +{api-spring-framework}/test/context/junit/jupiter/SpringJUnitConfig.html[Javadoc for +`@SpringJUnitConfig`] and `@ContextConfiguration` for further details. @@ -1318,13 +1322,13 @@ See <> as well as the {api-spring-framework}/test/co `@WebAppConfiguration` from the Spring TestContext Framework. You can use it at the class level as a drop-in replacement for `@ContextConfiguration` and `@WebAppConfiguration`. With regard to configuration options, the only difference between `@ContextConfiguration` -and `@SpringJUnitWebConfig` is that you can declare annotated classes bu using the `value` -attribute in `@SpringJUnitWebConfig`. In addition, you can override the `value` attribute from -`@WebAppConfiguration` only by using the `resourcePath` attribute in +and `@SpringJUnitWebConfig` is that you can declare annotated classes bu using the +`value` attribute in `@SpringJUnitWebConfig`. In addition, you can override the `value` +attribute from `@WebAppConfiguration` only by using the `resourcePath` attribute in `@SpringJUnitWebConfig`. -The following example shows how to use the `@SpringJUnitWebConfig` annotation to specify a -configuration class: +The following example shows how to use the `@SpringJUnitWebConfig` annotation to specify +a configuration class: ==== [source,java,indent=0] @@ -1353,8 +1357,11 @@ the location of a configuration file: <1>Specify the location of a configuration file. ==== -See <> as well as the Javadoc for {api-spring-framework}/test/context/junit/jupiter/web/SpringJUnitWebConfig.html[`@SpringJUnitWebConfig`], -{api-spring-framework}/test/context/ContextConfiguration.html[`@ContextConfiguration`], and {api-spring-framework}/test/context/web/WebAppConfiguration.html[`@WebAppConfiguration`] for further details. +See <> as well as the Javadoc for +{api-spring-framework}/test/context/junit/jupiter/web/SpringJUnitWebConfig.html[`@SpringJUnitWebConfig`], +{api-spring-framework}/test/context/ContextConfiguration.html[`@ContextConfiguration`], and +{api-spring-framework}/test/context/web/WebAppConfiguration.html[`@WebAppConfiguration`] +for further details. @@ -1363,9 +1370,9 @@ See <> as well as the Javadoc for {api-spring-framew `@EnabledIf` is used to signal that the annotated JUnit Jupiter test class or test method is enabled and should be run if the supplied `expression` evaluates to `true`. -Specifically, if the expression evaluates to `Boolean.TRUE` or a `String` equal to -`true` (ignoring case), the test is enabled. When applied at the class level, -all test methods within that class are automatically enabled by default as well. +Specifically, if the expression evaluates to `Boolean.TRUE` or a `String` equal to `true` +(ignoring case), the test is enabled. When applied at the class level, all test methods +within that class are automatically enabled by default as well. Expressions can be any of the following: @@ -1374,12 +1381,11 @@ Expressions can be any of the following: * Placeholder for a property available in the Spring <>. For example: `@EnabledIf("${smoke.tests.enabled}")` -* Text literal. For example: - `@EnabledIf("true")` +* Text literal. For example: `@EnabledIf("true")` Note, however, that a text literal that is not the result of dynamic resolution of a -property placeholder is of zero practical value, since `@EnabledIf("false")` is equivalent -to `@Disabled` and `@EnabledIf("true")` is logically meaningless. +property placeholder is of zero practical value, since `@EnabledIf("false")` is +equivalent to `@Disabled` and `@EnabledIf("true")` is logically meaningless. You can use `@EnabledIf` as a meta-annotation to create custom composed annotations. For example, you can create a custom `@EnabledOnMac` annotation as follows: @@ -1406,8 +1412,8 @@ example, you can create a custom `@EnabledOnMac` annotation as follows: `@DisabledIf` is used to signal that the annotated JUnit Jupiter test class or test method is disabled and should not be executed if the supplied `expression` evaluates to `true`. Specifically, if the expression evaluates to `Boolean.TRUE` or a `String` equal -to `true` (ignoring case), the test is disabled. When applied at the class -level, all test methods within that class are automatically disabled as well. +to `true` (ignoring case), the test is disabled. When applied at the class level, all +test methods within that class are automatically disabled as well. Expressions can be any of the following: @@ -1416,8 +1422,7 @@ Expressions can be any of the following: * Placeholder for a property available in the Spring <>. For example: `@DisabledIf("${smoke.tests.disabled}")` -* Text literal. For example: - `@DisabledIf("true")` +* Text literal. For example: `@DisabledIf("true")` Note, however, that a text literal that is not the result of dynamic resolution of a property placeholder is of zero practical value, since `@DisabledIf("true")` is @@ -1497,9 +1502,9 @@ Consider the following example: ---- ==== -If we discover that we are repeating the preceding configuration across our -JUnit 4-based test suite, we can reduce the duplication by introducing a custom composed annotation that -centralizes the common test configuration for Spring, as follows: +If we discover that we are repeating the preceding configuration across our JUnit 4-based +test suite, we can reduce the duplication by introducing a custom composed annotation +that centralizes the common test configuration for Spring, as follows: ==== [source,java,indent=0] @@ -1532,8 +1537,8 @@ configuration of individual JUnit 4 based test classes, as follows: ==== If we write tests that use JUnit Jupiter, we can reduce code duplication even further, -since annotations in JUnit 5 can also be used as meta-annotations. -Consider the following example: +since annotations in JUnit 5 can also be used as meta-annotations. Consider the following +example: ==== [source,java,indent=0] @@ -1553,10 +1558,10 @@ Consider the following example: ---- ==== -If we -discover that we are repeating the preceding configuration across our JUnit Jupiter-based -test suite, we can reduce the duplication by introducing a custom composed annotation -that centralizes the common test configuration for Spring and JUnit Jupiter, as follows: +If we discover that we are repeating the preceding configuration across our JUnit +Jupiter-based test suite, we can reduce the duplication by introducing a custom composed +annotation that centralizes the common test configuration for Spring and JUnit Jupiter, +as follows: ==== [source,java,indent=0] @@ -1588,9 +1593,9 @@ configuration of individual JUnit Jupiter based test classes, as follows: ==== Since JUnit Jupiter supports the use of `@Test`, `@RepeatedTest`, `ParameterizedTest`, -and others as meta-annotations, you can also create custom composed annotations at -the test method level. For example, if we wish to create a composed annotation that -combines the `@Test` and `@Tag` annotations from JUnit Jupiter with the `@Transactional` +and others as meta-annotations, you can also create custom composed annotations at the +test method level. For example, if we wish to create a composed annotation that combines +the `@Test` and `@Tag` annotations from JUnit Jupiter with the `@Transactional` annotation from Spring, we could create an `@TransactionalIntegrationTest` annotation, as follows: @@ -1630,25 +1635,23 @@ Annotation Programming Model>>. [[testcontext-framework]] === Spring TestContext Framework -The Spring TestContext Framework (located in the -`org.springframework.test.context` package) provides generic, annotation-driven unit and -integration testing support that is agnostic of the testing framework in use. The -TestContext framework also places a great deal of importance on convention over -configuration, with reasonable defaults that you can override through annotation-based -configuration. +The Spring TestContext Framework (located in the `org.springframework.test.context` +package) provides generic, annotation-driven unit and integration testing support that is +agnostic of the testing framework in use. The TestContext framework also places a great +deal of importance on convention over configuration, with reasonable defaults that you +can override through annotation-based configuration. In addition to generic testing infrastructure, the TestContext framework provides -explicit support for JUnit 4, JUnit Jupiter (AKA JUnit 5), and TestNG. For JUnit 4 -and TestNG, Spring provides `abstract` support classes. Furthermore, Spring provides a -custom JUnit `Runner` and custom JUnit `Rules` for JUnit 4 and a custom -`Extension` for JUnit Jupiter that let you write so-called POJO test classes. -POJO test classes are not required to extend a particular class hierarchy, such as the -`abstract` support classes. +explicit support for JUnit 4, JUnit Jupiter (AKA JUnit 5), and TestNG. For JUnit 4 and +TestNG, Spring provides `abstract` support classes. Furthermore, Spring provides a custom +JUnit `Runner` and custom JUnit `Rules` for JUnit 4 and a custom `Extension` for JUnit +Jupiter that let you write so-called POJO test classes. POJO test classes are not +required to extend a particular class hierarchy, such as the `abstract` support classes. The following section provides an overview of the internals of the TestContext framework. -If you are interested only in using the framework and are not interested in -extending it with your own custom listeners or custom loaders, feel free to go directly -to the configuration (<>, +If you are interested only in using the framework and are not interested in extending it +with your own custom listeners or custom loaders, feel free to go directly to the +configuration (<>, <>, <>), <>, and <> sections. @@ -1660,15 +1663,15 @@ management>>), <>, and The core of the framework consists of the `TestContextManager` class and the `TestContext`, `TestExecutionListener`, and `SmartContextLoader` interfaces. A -`TestContextManager` is created for each test class (for example, for the execution of all test -methods within a single test class in JUnit Jupiter). The `TestContextManager`, in turn, -manages a `TestContext` that holds the context of the current test. The +`TestContextManager` is created for each test class (for example, for the execution of +all test methods within a single test class in JUnit Jupiter). The `TestContextManager`, +in turn, manages a `TestContext` that holds the context of the current test. The `TestContextManager` also updates the state of the `TestContext` as the test progresses and delegates to `TestExecutionListener` implementations, which instrument the actual test execution by providing dependency injection, managing transactions, and so on. A `SmartContextLoader` is responsible for loading an `ApplicationContext` for a given test -class. See the {api-spring-framework}[Javadoc] and the Spring test suite for further information and -examples of various implementations. +class. See the {api-spring-framework}[Javadoc] and the Spring test suite for further +information and examples of various implementations. @@ -1683,9 +1686,9 @@ the test instance for which it is responsible. The `TestContext` also delegates ===== `TestContextManager` -`TestContextManager` is the main entry point into the Spring TestContext Framework -and is responsible for managing a single `TestContext` and signaling events to each -registered `TestExecutionListener` at well-defined test execution points: +`TestContextManager` is the main entry point into the Spring TestContext Framework and is +responsible for managing a single `TestContext` and signaling events to each registered +`TestExecutionListener` at well-defined test execution points: * Prior to any "`before class`" or "`before all`" methods of a particular testing framework. * Test instance post-processing. @@ -1705,8 +1708,8 @@ by the `TestContextManager` with which the listener is registered. See `ContextLoader` is a strategy interface that was introduced in Spring 2.5 for loading an `ApplicationContext` for an integration test managed by the Spring TestContext Framework. -You should implement `SmartContextLoader` instead of this interface to provide support for -annotated classes, active bean definition profiles, test property sources, context +You should implement `SmartContextLoader` instead of this interface to provide support +for annotated classes, active bean definition profiles, test property sources, context hierarchies, and `WebApplicationContext` support. `SmartContextLoader` is an extension of the `ContextLoader` interface introduced in @@ -1718,31 +1721,31 @@ the context that it loads. Spring provides the following implementations: -* `DelegatingSmartContextLoader`: One of two default loaders, it delegates internally -to an `AnnotationConfigContextLoader`, a `GenericXmlContextLoader`, or a -`GenericGroovyXmlContextLoader`, depending either on the configuration declared for the -test class or on the presence of default locations or default configuration classes. -Groovy support is enabled only if Groovy is on the classpath. -* `WebDelegatingSmartContextLoader`: One of two default loaders, it delegates -internally to an `AnnotationConfigWebContextLoader`, a `GenericXmlWebContextLoader`, or a -`GenericGroovyXmlWebContextLoader`, depending either on the configuration declared for the -test class or on the presence of default locations or default configuration classes. A -web `ContextLoader` is used only if `@WebAppConfiguration` is present on the test -class. Groovy support is enabled only if Groovy is on the classpath. -* `AnnotationConfigContextLoader`: Loads a standard `ApplicationContext` from -annotated classes. +* `DelegatingSmartContextLoader`: One of two default loaders, it delegates internally to + an `AnnotationConfigContextLoader`, a `GenericXmlContextLoader`, or a + `GenericGroovyXmlContextLoader`, depending either on the configuration declared for the + test class or on the presence of default locations or default configuration classes. + Groovy support is enabled only if Groovy is on the classpath. +* `WebDelegatingSmartContextLoader`: One of two default loaders, it delegates internally + to an `AnnotationConfigWebContextLoader`, a `GenericXmlWebContextLoader`, or a + `GenericGroovyXmlWebContextLoader`, depending either on the configuration declared for + the test class or on the presence of default locations or default configuration + classes. A web `ContextLoader` is used only if `@WebAppConfiguration` is present on the + test class. Groovy support is enabled only if Groovy is on the classpath. +* `AnnotationConfigContextLoader`: Loads a standard `ApplicationContext` from annotated + classes. * `AnnotationConfigWebContextLoader`: Loads a `WebApplicationContext` from annotated -classes. + classes. * `GenericGroovyXmlContextLoader`: Loads a standard `ApplicationContext` from resource -locations that are either Groovy scripts or XML configuration files. + locations that are either Groovy scripts or XML configuration files. * `GenericGroovyXmlWebContextLoader`: Loads a `WebApplicationContext` from resource -locations that are either Groovy scripts or XML configuration files. + locations that are either Groovy scripts or XML configuration files. * `GenericXmlContextLoader`: Loads a standard `ApplicationContext` from XML resource -locations. + locations. * `GenericXmlWebContextLoader`: Loads a `WebApplicationContext` from XML resource -locations. + locations. * `GenericPropertiesContextLoader`: Loads a standard `ApplicationContext` from Java -properties files. + properties files. [[testcontext-bootstrapping]] @@ -1752,23 +1755,23 @@ The default configuration for the internals of the Spring TestContext Framework sufficient for all common use cases. However, there are times when a development team or third party framework would like to change the default `ContextLoader`, implement a custom `TestContext` or `ContextCache`, augment the default sets of -`ContextCustomizerFactory` and `TestExecutionListener` implementations, and so on. For such -low-level control over how the TestContext framework operates, Spring provides a +`ContextCustomizerFactory` and `TestExecutionListener` implementations, and so on. For +such low-level control over how the TestContext framework operates, Spring provides a bootstrapping strategy. -`TestContextBootstrapper` defines the SPI for bootstrapping the TestContext framework. -A `TestContextBootstrapper` is used by the `TestContextManager` to load the +`TestContextBootstrapper` defines the SPI for bootstrapping the TestContext framework. A +`TestContextBootstrapper` is used by the `TestContextManager` to load the `TestExecutionListener` implementations for the current test and to build the `TestContext` that it manages. You can configure a custom bootstrapping strategy for a test class (or test class hierarchy) by using `@BootstrapWith`, either directly or as a -meta-annotation. If a bootstrapper is not explicitly configured by using `@BootstrapWith`, -either the `DefaultTestContextBootstrapper` or the `WebTestContextBootstrapper` is -used, depending on the presence of `@WebAppConfiguration`. +meta-annotation. If a bootstrapper is not explicitly configured by using +`@BootstrapWith`, either the `DefaultTestContextBootstrapper` or the +`WebTestContextBootstrapper` is used, depending on the presence of `@WebAppConfiguration`. -Since the `TestContextBootstrapper` SPI is likely to change in the future (to -accommodate new requirements), we strongly encourage implementers not to implement this -interface directly but rather to extend `AbstractTestContextBootstrapper` or one of its -concrete subclasses instead. +Since the `TestContextBootstrapper` SPI is likely to change in the future (to accommodate +new requirements), we strongly encourage implementers not to implement this interface +directly but rather to extend `AbstractTestContextBootstrapper` or one of its concrete +subclasses instead. @@ -1778,25 +1781,27 @@ concrete subclasses instead. Spring provides the following `TestExecutionListener` implementations that are registered by default, exactly in the following order: -. `ServletTestExecutionListener`: Configures Servlet API mocks for a +* `ServletTestExecutionListener`: Configures Servlet API mocks for a `WebApplicationContext`. -. `DirtiesContextBeforeModesTestExecutionListener`: Handles the `@DirtiesContext` annotation for - "`before`" modes. -. `DependencyInjectionTestExecutionListener`: Provides dependency injection for the test +* `DirtiesContextBeforeModesTestExecutionListener`: Handles the `@DirtiesContext` + annotation for "`before`" modes. +* `DependencyInjectionTestExecutionListener`: Provides dependency injection for the test instance. -. `DirtiesContextTestExecutionListener`: Handles the `@DirtiesContext` annotation for +* `DirtiesContextTestExecutionListener`: Handles the `@DirtiesContext` annotation for "`after`" modes. -. `TransactionalTestExecutionListener`: Provides transactional test execution with +* `TransactionalTestExecutionListener`: Provides transactional test execution with default rollback semantics. -. `SqlScriptsTestExecutionListener`: Runs SQL scripts configured by using the `@Sql` +* `SqlScriptsTestExecutionListener`: Runs SQL scripts configured by using the `@Sql` annotation. + [[testcontext-tel-config-registering-tels]] ===== Registering Custom `TestExecutionListener` Implementations -You can register custom `TestExecutionListener` implementations for a test class and its subclasses -by using the `@TestExecutionListeners` annotation. See -<> and the {}api-spring-framework/test/context/TestExecutionListeners.html[Javadoc for +You can register custom `TestExecutionListener` implementations for a test class and its +subclasses by using the `@TestExecutionListeners` annotation. See +<> and the +{api-spring-framework}/test/context/TestExecutionListeners.html[Javadoc for `@TestExecutionListeners`] for details and examples. @@ -1804,42 +1809,44 @@ by using the `@TestExecutionListeners` annotation. See [[testcontext-tel-config-automatic-discovery]] ===== Automatic Discovery of Default `TestExecutionListener` Implementations -Registering custom `TestExecutionListener` implementations by using `@TestExecutionListeners` is suitable -for custom listeners that are used in limited testing scenarios. However, it can become -cumbersome if a custom listener needs to be used across a test suite. Since Spring -Framework 4.1, this issue is addressed through support for automatic discovery of default -`TestExecutionListener` implementations through the `SpringFactoriesLoader` mechanism. +Registering custom `TestExecutionListener` implementations by using +`@TestExecutionListeners` is suitable for custom listeners that are used in limited +testing scenarios. However, it can become cumbersome if a custom listener needs to be +used across a test suite. Since Spring Framework 4.1, this issue is addressed through +support for automatic discovery of default `TestExecutionListener` implementations +through the `SpringFactoriesLoader` mechanism. -Specifically, the `spring-test` module declares all core default -TestExecutionListener` implementations under the -`org.springframework.test.context.TestExecutionListener` key in its -`META-INF/spring.factories` properties file. Third-party frameworks and developers can -contribute their own `TestExecutionListener` implementations to the list of default listeners in the -same manner through their own `META-INF/spring.factories` properties file. +Specifically, the `spring-test` module declares all core default TestExecutionListener` +implementations under the `org.springframework.test.context.TestExecutionListener` key in +its `META-INF/spring.factories` properties file. Third-party frameworks and developers +can contribute their own `TestExecutionListener` implementations to the list of default +listeners in the same manner through their own `META-INF/spring.factories` properties +file. [[testcontext-tel-config-ordering]] ===== Ordering `TestExecutionListener` Implementations -When the TestContext framework discovers default `TestExecutionListener` implementations through the -<> `SpringFactoriesLoader` mechanism, the instantiated listeners are sorted -by using Spring's `AnnotationAwareOrderComparator`, which honors Spring's `Ordered` interface -and `@Order` annotation for ordering. `AbstractTestExecutionListener` and all default -`TestExecutionListener` implementations provided by Spring implement `Ordered` with appropriate -values. Third-party frameworks and developers should therefore make sure that their -default `TestExecutionListener` implementations are registered in the proper order by implementing -`Ordered` or declaring `@Order`. See the Javadoc for the `getOrder()` methods of the -core default `TestExecutionListener` implementations for details on what values are assigned to each -core listener. +When the TestContext framework discovers default `TestExecutionListener` implementations +through the <> +`SpringFactoriesLoader` mechanism, the instantiated listeners are sorted by using +Spring's `AnnotationAwareOrderComparator`, which honors Spring's `Ordered` interface and +`@Order` annotation for ordering. `AbstractTestExecutionListener` and all default +`TestExecutionListener` implementations provided by Spring implement `Ordered` with +appropriate values. Third-party frameworks and developers should therefore make sure that +their default `TestExecutionListener` implementations are registered in the proper order +by implementing `Ordered` or declaring `@Order`. See the Javadoc for the `getOrder()` +methods of the core default `TestExecutionListener` implementations for details on what +values are assigned to each core listener. [[testcontext-tel-config-merging]] ===== Merging `TestExecutionListener` Implementations If a custom `TestExecutionListener` is registered via `@TestExecutionListeners`, the -default listeners are not registered. In most common testing scenarios, this -effectively forces the developer to manually declare all default listeners in addition to -any custom listeners. The following listing demonstrates this style of configuration: +default listeners are not registered. In most common testing scenarios, this effectively +forces the developer to manually declare all default listeners in addition to any custom +listeners. The following listing demonstrates this style of configuration: ==== [source,java,indent=0] @@ -1866,19 +1873,19 @@ which listeners are registered by default. Moreover, the set of default listener change from release to release -- for example, `SqlScriptsTestExecutionListener` was introduced in Spring Framework 4.1, and `DirtiesContextBeforeModesTestExecutionListener` was introduced in Spring Framework 4.2. Furthermore, third-party frameworks like Spring -Security register their own default `TestExecutionListener` implementations by using the aforementioned -<>. +Security register their own default `TestExecutionListener` implementations by using the +aforementioned <>. To avoid having to be aware of and re-declare all default listeners, you can set the -`mergeMode` attribute of `@TestExecutionListeners` to -`MergeMode.MERGE_WITH_DEFAULTS`. `MERGE_WITH_DEFAULTS` indicates that locally declared -listeners should be merged with the default listeners. The merging algorithm ensures that -duplicates are removed from the list and that the resulting set of merged listeners is -sorted according to the semantics of `AnnotationAwareOrderComparator`, as described in -<>. If a listener implements `Ordered` or is annotated -with `@Order`, it can influence the position in which it is merged with the defaults. -Otherwise, locally declared listeners are appended to the list of default -listeners when merged. +`mergeMode` attribute of `@TestExecutionListeners` to `MergeMode.MERGE_WITH_DEFAULTS`. +`MERGE_WITH_DEFAULTS` indicates that locally declared listeners should be merged with the +default listeners. The merging algorithm ensures that duplicates are removed from the +list and that the resulting set of merged listeners is sorted according to the semantics +of `AnnotationAwareOrderComparator`, as described in <>. +If a listener implements `Ordered` or is annotated with `@Order`, it can influence the +position in which it is merged with the defaults. Otherwise, locally declared listeners +are appended to the list of default listeners when merged. For example, if the `MyCustomTestExecutionListener` class in the previous example configures its `order` value (for example, `500`) to be less than the order of the @@ -1918,9 +1925,9 @@ provide access to the `ApplicationContext` automatically. .@Autowired ApplicationContext [TIP] ===== -As an alternative to implementing the `ApplicationContextAware` interface, you can -inject the application context for your test class through the `@Autowired` annotation -on either a field or setter method, as the following example shows: +As an alternative to implementing the `ApplicationContextAware` interface, you can inject +the application context for your test class through the `@Autowired` annotation on either +a field or setter method, as the following example shows: ==== [source,java,indent=0] @@ -1968,12 +1975,12 @@ Dependency injection by using `@Autowired` is provided by the Test classes that use the TestContext framework do not need to extend any particular class or implement a specific interface to configure their application context. Instead, -configuration is achieved by declaring the `@ContextConfiguration` annotation at -the class level. If your test class does not explicitly declare application context -resource locations or annotated classes, the configured `ContextLoader` determines -how to load a context from a default location or default configuration classes. In -addition to context resource locations and annotated classes, an application context -can also be configured through application context initializers. +configuration is achieved by declaring the `@ContextConfiguration` annotation at the +class level. If your test class does not explicitly declare application context resource +locations or annotated classes, the configured `ContextLoader` determines how to load a +context from a default location or default configuration classes. In addition to context +resource locations and annotated classes, an application context can also be configured +through application context initializers. The following sections explain how to use Spring's `@ContextConfiguration` annotation to configure a test `ApplicationContext` by using XML configuration files, Groovy scripts, @@ -2001,11 +2008,11 @@ advanced use cases. To load an `ApplicationContext` for your tests by using XML configuration files, annotate your test class with `@ContextConfiguration` and configure the `locations` attribute with an array that contains the resource locations of XML configuration metadata. A plain or -relative path (for example, `context.xml`) is treated as a classpath resource -that is relative to the package in which the test class is defined. A path starting with -a slash is treated as an absolute classpath location (for example, -`/org/example/config.xml`). A path that represents a resource URL (i.e., a path -prefixed with `classpath:`, `file:`, `http:`, etc.) is used _as is_. +relative path (for example, `context.xml`) is treated as a classpath resource that is +relative to the package in which the test class is defined. A path starting with a slash +is treated as an absolute classpath location (for example, `/org/example/config.xml`). A +path that represents a resource URL (i.e., a path prefixed with `classpath:`, `file:`, +`http:`, etc.) is used _as is_. ==== [source,java,indent=0] @@ -2041,12 +2048,13 @@ demonstrated in the following example: <1> Specifying XML files without using the `location` attribute. ==== -If you omit both the `locations` and the `value` attributes from the `@ContextConfiguration` -annotation, the TestContext framework tries to detect a default XML resource -location. Specifically, `GenericXmlContextLoader` and `GenericXmlWebContextLoader` detect -a default location based on the name of the test class. If your class is named -`com.example.MyTest`, `GenericXmlContextLoader` loads your application context from -`"classpath:com/example/MyTest-context.xml"`. The following example shows how to do so: +If you omit both the `locations` and the `value` attributes from the +`@ContextConfiguration` annotation, the TestContext framework tries to detect a default +XML resource location. Specifically, `GenericXmlContextLoader` and +`GenericXmlWebContextLoader` detect a default location based on the name of the test +class. If your class is named `com.example.MyTest`, `GenericXmlContextLoader` loads your +application context from `"classpath:com/example/MyTest-context.xml"`. The following +example shows how to do so: ==== [source,java,indent=0] @@ -2071,11 +2079,11 @@ a default location based on the name of the test class. If your class is named ===== Context Configuration with Groovy Scripts To load an `ApplicationContext` for your tests by using Groovy scripts that use the -<>, you can annotate your test class with -`@ContextConfiguration` and configure the `locations` or `value` attribute with an array -that contains the resource locations of Groovy scripts. Resource lookup semantics for -Groovy scripts are the same as those described for <>. +<>, you can annotate +your test class with `@ContextConfiguration` and configure the `locations` or `value` +attribute with an array that contains the resource locations of Groovy scripts. Resource +lookup semantics for Groovy scripts are the same as those described for +<>. .Enabling Groovy script support TIP: Support for using Groovy scripts to load an `ApplicationContext` in the Spring @@ -2126,10 +2134,11 @@ the default: .Declaring XML configuration and Groovy scripts simultaneously [TIP] ===== -You can declare both XML configuration files and Groovy scripts simultaneously by using the -`locations` or `value` attribute of `@ContextConfiguration`. If the path to a configured -resource location ends with `.xml`, it is loaded by using an `XmlBeanDefinitionReader`. -Otherwise, it is loaded by using a `GroovyBeanDefinitionReader`. +You can declare both XML configuration files and Groovy scripts simultaneously by using +the `locations` or `value` attribute of `@ContextConfiguration`. If the path to a +configured resource location ends with `.xml`, it is loaded by using an +`XmlBeanDefinitionReader`. Otherwise, it is loaded by using a +`GroovyBeanDefinitionReader`. The following listing shows how to combine both in an integration test: @@ -2154,10 +2163,9 @@ The following listing shows how to combine both in an integration test: ===== Context Configuration with Annotated Classes To load an `ApplicationContext` for your tests by using annotated classes (see -<>), -you can annotate your test class with `@ContextConfiguration` and configure the -`classes` attribute with an array that contains references to annotated classes. -The following example shows how to do so: +<>), you can annotate your test +class with `@ContextConfiguration` and configure the `classes` attribute with an array +that contains references to annotated classes. The following example shows how to do so: ==== [source,java,indent=0] @@ -2183,21 +2191,24 @@ The term "`annotated class`" can refer to any of the following: * A JSR-330 compliant class that is annotated with `javax.inject` annotations. * Any other class that contains `@Bean` methods. -See the Javadoc of {api-spring-framework}/context/annotation/Configuration.html[`@Configuration`] and {api-spring-framework}/context/annotation/Bean.html[`@Bean`] for further information regarding -the configuration and semantics of annotated classes, paying special attention to -the discussion of `@Bean` Lite Mode. +See the Javadoc of +{api-spring-framework}/context/annotation/Configuration.html[`@Configuration`] and +{api-spring-framework}/context/annotation/Bean.html[`@Bean`] for further information +regarding the configuration and semantics of annotated classes, paying special attention +to the discussion of `@Bean` Lite Mode. ==== If you omit the `classes` attribute from the `@ContextConfiguration` annotation, the -TestContext framework tries to detect the presence of default configuration -classes. Specifically, `AnnotationConfigContextLoader` and -`AnnotationConfigWebContextLoader` detect all `static` nested classes of the test class -that meet the requirements for configuration class implementations, as specified in the -{api-spring-framework}/context/annotation/Configuration.html[`@Configuration`] Javadoc. Note that the name of the -configuration class is arbitrary. In addition, a test class can contain more than one -`static` nested configuration class if desired. In the following example, the `OrderServiceTest` class -declares a `static` nested configuration class named `Config` that is automatically -used to load the `ApplicationContext` for the test class: +TestContext framework tries to detect the presence of default configuration classes. +Specifically, `AnnotationConfigContextLoader` and `AnnotationConfigWebContextLoader` +detect all `static` nested classes of the test class that meet the requirements for +configuration class implementations, as specified in the +{api-spring-framework}/context/annotation/Configuration.html[`@Configuration`] Javadoc. +Note that the name of the configuration class is arbitrary. In addition, a test class can +contain more than one `static` nested configuration class if desired. In the following +example, the `OrderServiceTest` class declares a `static` nested configuration class +named `Config` that is automatically used to load the `ApplicationContext` for the test +class: ==== [source,java,indent=0] @@ -2245,44 +2256,45 @@ annotated classes (typically `@Configuration` classes) to configure an production, you may decide that you want to use `@Configuration` classes to configure specific Spring-managed components for your tests, or vice versa. -Furthermore, some third-party frameworks (such as Spring Boot) provide first-class support -for loading an `ApplicationContext` from different types of resources simultaneously -(for example, XML configuration files, Groovy scripts, and `@Configuration` classes). The Spring -Framework, historically, has not supported this for standard deployments. Consequently, -most of the `SmartContextLoader` implementations that the Spring Framework delivers in -the `spring-test` module support only one resource type for each test context. However, this -does not mean that you cannot use both. One exception to the general rule is that the -`GenericGroovyXmlContextLoader` and `GenericGroovyXmlWebContextLoader` support both XML -configuration files and Groovy scripts simultaneously. Furthermore, third-party -frameworks may choose to support the declaration of both `locations` and `classes` through -`@ContextConfiguration`, and, with the standard testing support in the TestContext -framework, you have the following options. +Furthermore, some third-party frameworks (such as Spring Boot) provide first-class +support for loading an `ApplicationContext` from different types of resources +simultaneously (for example, XML configuration files, Groovy scripts, and +`@Configuration` classes). The Spring Framework, historically, has not supported this for +standard deployments. Consequently, most of the `SmartContextLoader` implementations that +the Spring Framework delivers in the `spring-test` module support only one resource type +for each test context. However, this does not mean that you cannot use both. One +exception to the general rule is that the `GenericGroovyXmlContextLoader` and +`GenericGroovyXmlWebContextLoader` support both XML configuration files and Groovy +scripts simultaneously. Furthermore, third-party frameworks may choose to support the +declaration of both `locations` and `classes` through `@ContextConfiguration`, and, with +the standard testing support in the TestContext framework, you have the following options. If you want to use resource locations (for example, XML or Groovy) and `@Configuration` -classes to configure your tests, you must pick one as the entry point, and -that one must include or import the other. For example, in XML or Groovy scripts, -you can include `@Configuration` classes by using component scanning or defining them as normal -Spring beans, whereas, in a `@Configuration` class, you can use `@ImportResource` to -import XML configuration files or Groovy scripts. Note that this behavior is semantically -equivalent to how you configure your application in production: In production -configuration, you define either a set of XML or Groovy resource locations or a set -of `@Configuration` classes from which your production `ApplicationContext` is loaded, -but you still have the freedom to include or import the other type of configuration. +classes to configure your tests, you must pick one as the entry point, and that one must +include or import the other. For example, in XML or Groovy scripts, you can include +`@Configuration` classes by using component scanning or defining them as normal Spring +beans, whereas, in a `@Configuration` class, you can use `@ImportResource` to import XML +configuration files or Groovy scripts. Note that this behavior is semantically equivalent +to how you configure your application in production: In production configuration, you +define either a set of XML or Groovy resource locations or a set of `@Configuration` +classes from which your production `ApplicationContext` is loaded, but you still have the +freedom to include or import the other type of configuration. + [[testcontext-ctx-management-initializers]] ===== Context Configuration with Context Initializers -To configure an `ApplicationContext` for your tests by using context initializers, annotate -your test class with `@ContextConfiguration` and configure the `initializers` attribute -with an array that contains references to classes that implement +To configure an `ApplicationContext` for your tests by using context initializers, +annotate your test class with `@ContextConfiguration` and configure the `initializers` +attribute with an array that contains references to classes that implement `ApplicationContextInitializer`. The declared context initializers are then used to initialize the `ConfigurableApplicationContext` that is loaded for your tests. Note that -the concrete `ConfigurableApplicationContext` type supported by each declared -initializer must be compatible with the type of `ApplicationContext` created by the -`SmartContextLoader` in use (typically a `GenericApplicationContext`). -Furthermore, the order in which the initializers are invoked depends on whether they -implement Spring's `Ordered` interface or are annotated with Spring's `@Order` annotation -or the standard `@Priority` annotation. The following example shows how to use initializers: +the concrete `ConfigurableApplicationContext` type supported by each declared initializer +must be compatible with the type of `ApplicationContext` created by the +`SmartContextLoader` in use (typically a `GenericApplicationContext`). Furthermore, the +order in which the initializers are invoked depends on whether they implement Spring's +`Ordered` interface or are annotated with Spring's `@Order` annotation or the standard +`@Priority` annotation. The following example shows how to use initializers: ==== [source,java,indent=0] @@ -2301,8 +2313,8 @@ or the standard `@Priority` annotation. The following example shows how to use i <1> Specifying configuration by using a configuration class and an initializer. ==== -You can also omit the declaration of XML configuration files, Groovy scripts, -or annotated classes in `@ContextConfiguration` entirely and instead declare only +You can also omit the declaration of XML configuration files, Groovy scripts, or +annotated classes in `@ContextConfiguration` entirely and instead declare only `ApplicationContextInitializer` classes, which are then responsible for registering beans in the context -- for example, by programmatically loading bean definitions from XML files or configuration classes. The following example shows how to do so: @@ -2329,14 +2341,14 @@ files or configuration classes. The following example shows how to do so: `@ContextConfiguration` supports boolean `inheritLocations` and `inheritInitializers` attributes that denote whether resource locations or annotated classes and context -initializers declared by superclasses should be inherited. The default value for -both flags is `true`. This means that a test class inherits the resource locations or +initializers declared by superclasses should be inherited. The default value for both +flags is `true`. This means that a test class inherits the resource locations or annotated classes as well as the context initializers declared by any superclasses. Specifically, the resource locations or annotated classes for a test class are appended to the list of resource locations or annotated classes declared by superclasses. -Similarly, the initializers for a given test class are added to the set of -initializers defined by test superclasses. Thus, subclasses have the option -of extending the resource locations, annotated classes, or context initializers. +Similarly, the initializers for a given test class are added to the set of initializers +defined by test superclasses. Thus, subclasses have the option of extending the resource +locations, annotated classes, or context initializers. If the `inheritLocations` or `inheritInitializers` attribute in `@ContextConfiguration` is set to `false`, the resource locations or annotated classes and the context @@ -2344,11 +2356,10 @@ initializers, respectively, for the test class shadow and effectively replace th configuration defined by superclasses. In the next example, which uses XML resource locations, the `ApplicationContext` for -`ExtendedTest` is loaded from `base-config.xml` and -`extended-config.xml`, in that order. Beans defined in `extended-config.xml` can, -therefore, override (that is, replace) those defined in `base-config.xml`. -The following example shows how one class can extend another and use both its own -configuration file and the superclass's configuration file: +`ExtendedTest` is loaded from `base-config.xml` and `extended-config.xml`, in that order. +Beans defined in `extended-config.xml` can, therefore, override (that is, replace) those +defined in `base-config.xml`. The following example shows how one class can extend +another and use both its own configuration file and the superclass's configuration file: ==== [source,java,indent=0] @@ -2373,12 +2384,11 @@ configuration file and the superclass's configuration file: <2> Configuration file defined in the subclass. ==== -Similarly, in the next example, which uses annotated classes, the -`ApplicationContext` for `ExtendedTest` is loaded from the `BaseConfig` and -`ExtendedConfig` classes, in that order. Beans defined in `ExtendedConfig` can, therefore, -override (that is, replace) those defined in `BaseConfig`. -The following example shows how one class can extend another and use both its own -configuration class and the superclass's configuration class: +Similarly, in the next example, which uses annotated classes, the `ApplicationContext` +for `ExtendedTest` is loaded from the `BaseConfig` and `ExtendedConfig` classes, in that +order. Beans defined in `ExtendedConfig` can, therefore, override (that is, replace) +those defined in `BaseConfig`. The following example shows how one class can extend +another and use both its own configuration class and the superclass's configuration class: ==== [source,java,indent=0] @@ -2402,12 +2412,11 @@ configuration class and the superclass's configuration class: ==== In the next example, which uses context initializers, the `ApplicationContext` for -`ExtendedTest` is initialized by using `BaseInitializer` and -`ExtendedInitializer`. Note, however, that the order in which the initializers are -invoked depends on whether they implement Spring's `Ordered` interface or are annotated -with Spring's `@Order` annotation or the standard `@Priority` annotation. -The following example shows how one class can extend another and use both its own -initializer and the superclass's initializer: +`ExtendedTest` is initialized by using `BaseInitializer` and `ExtendedInitializer`. Note, +however, that the order in which the initializers are invoked depends on whether they +implement Spring's `Ordered` interface or are annotated with Spring's `@Order` annotation +or the standard `@Priority` annotation. The following example shows how one class can +extend another and use both its own initializer and the superclass's initializer: ==== [source,java,indent=0] @@ -2436,16 +2445,16 @@ initializer and the superclass's initializer: [[testcontext-ctx-management-env-profiles]] ===== Context Configuration with Environment Profiles -Spring 3.1 introduced first-class support in the framework for the notion of -environments and profiles (AKA "`bean definition profiles`"), and integration tests -can be configured to activate particular bean definition profiles for various testing -scenarios. This is achieved by annotating a test class with the `@ActiveProfiles` -annotation and supplying a list of profiles that should be activated when loading the -`ApplicationContext` for the test. +Spring 3.1 introduced first-class support in the framework for the notion of environments +and profiles (AKA "`bean definition profiles`"), and integration tests can be configured +to activate particular bean definition profiles for various testing scenarios. This is +achieved by annotating a test class with the `@ActiveProfiles` annotation and supplying a +list of profiles that should be activated when loading the `ApplicationContext` for the +test. -NOTE: You can use `@ActiveProfiles` with any implementation of the new `SmartContextLoader` -SPI, but `@ActiveProfiles` is not supported with implementations of the older -`ContextLoader` SPI. +NOTE: You can use `@ActiveProfiles` with any implementation of the new +`SmartContextLoader` SPI, but `@ActiveProfiles` is not supported with implementations of +the older `ContextLoader` SPI. Consider two examples with XML configuration and `@Configuration` classes: @@ -2523,20 +2532,20 @@ When `TransferServiceTest` is run, its `ApplicationContext` is loaded from the `app-config.xml` configuration file in the root of the classpath. If you inspect `app-config.xml`, you can see that the `accountRepository` bean has a dependency on a `dataSource` bean. However, `dataSource` is not defined as a top-level bean. Instead, -`dataSource` is defined three times: in the `production` profile, in the -`dev` profile, and in the `default` profile. +`dataSource` is defined three times: in the `production` profile, in the `dev` profile, +and in the `default` profile. By annotating `TransferServiceTest` with `@ActiveProfiles("dev")`, we instruct the Spring TestContext Framework to load the `ApplicationContext` with the active profiles set to -`{"dev"}`. As a result, an embedded database is created and populated with test data, -and the `accountRepository` bean is wired with a reference to the development -`DataSource`. That is likely what we want in an integration test. +`{"dev"}`. As a result, an embedded database is created and populated with test data, and +the `accountRepository` bean is wired with a reference to the development `DataSource`. +That is likely what we want in an integration test. -It is sometimes useful to assign beans to a `default` profile. Beans within the default profile -are included only when no other profile is specifically activated. You can use this to define -"`fallback`" beans to be used in the application's default state. For example, you may -explicitly provide a data source for `dev` and `production` profiles, but define an in-memory -data source as a default when neither of these is active. +It is sometimes useful to assign beans to a `default` profile. Beans within the default +profile are included only when no other profile is specifically activated. You can use +this to define "`fallback`" beans to be used in the application's default state. For +example, you may explicitly provide a data source for `dev` and `production` profiles, +but define an in-memory data source as a default when neither of these is active. The following code listings demonstrate how to implement the same configuration and integration test with `@Configuration` classes instead of XML: @@ -2652,20 +2661,20 @@ In this variation, we have split the XML configuration into four independent developer tests. * `JndiDataConfig`: Defines a `dataSource` that is retrieved from JNDI in a production environment. -* `DefaultDataConfig`: Defines a `dataSource` for a default embedded database, in case - no profile is active. +* `DefaultDataConfig`: Defines a `dataSource` for a default embedded database, in case no + profile is active. -As with the XML-based configuration example, we still annotate `TransferServiceTest` -with `@ActiveProfiles("dev")`, but this time we specify all four configuration classes -by using the `@ContextConfiguration` annotation. The body of the test class itself remains +As with the XML-based configuration example, we still annotate `TransferServiceTest` with +`@ActiveProfiles("dev")`, but this time we specify all four configuration classes by +using the `@ContextConfiguration` annotation. The body of the test class itself remains completely unchanged. It is often the case that a single set of profiles is used across multiple test classes within a given project. Thus, to avoid duplicate declarations of the `@ActiveProfiles` -annotation, you can declare `@ActiveProfiles` once on a base class, and -subclasses automatically inherit the `@ActiveProfiles` configuration from the base -class. In the following example, the declaration of `@ActiveProfiles` (as well as other -annotations) has been moved to an abstract superclass, `AbstractIntegrationTest`: +annotation, you can declare `@ActiveProfiles` once on a base class, and subclasses +automatically inherit the `@ActiveProfiles` configuration from the base class. In the +following example, the declaration of `@ActiveProfiles` (as well as other annotations) +has been moved to an abstract superclass, `AbstractIntegrationTest`: ==== [source,java,indent=0] @@ -2732,9 +2741,10 @@ programmatically instead of declaratively -- for example, based on: To resolve active bean definition profiles programmatically, you can implement a custom `ActiveProfilesResolver` and register it by using the `resolver` attribute of -`@ActiveProfiles`. For further information, see the -corresponding {api-spring-framework}/test/context/ActiveProfilesResolver.html[Javadoc]. The following example demonstrates how to implement and register a -custom `OperatingSystemActiveProfilesResolver`: +`@ActiveProfiles`. For further information, see the corresponding +{api-spring-framework}/test/context/ActiveProfilesResolver.html[Javadoc]. The following +example demonstrates how to implement and register a custom +`OperatingSystemActiveProfilesResolver`: ==== [source,java,indent=0] @@ -2774,13 +2784,13 @@ custom `OperatingSystemActiveProfilesResolver`: ===== Context Configuration with Test Property Sources Spring 3.1 introduced first-class support in the framework for the notion of an -environment with a hierarchy of property sources. Since Spring 4.1, you can configure integration -tests with test-specific property sources. In contrast to the -`@PropertySource` annotation used on `@Configuration` classes, you can declare the `@TestPropertySource` -annotation on a test class to declare resource locations for test -properties files or inlined properties. These test property sources are added to -the set of `PropertySources` in the `Environment` for the `ApplicationContext` loaded -for the annotated integration test. +environment with a hierarchy of property sources. Since Spring 4.1, you can configure +integration tests with test-specific property sources. In contrast to the +`@PropertySource` annotation used on `@Configuration` classes, you can declare the +`@TestPropertySource` annotation on a test class to declare resource locations for test +properties files or inlined properties. These test property sources are added to the set +of `PropertySources` in the `Environment` for the `ApplicationContext` loaded for the +annotated integration test. [NOTE] ==== @@ -2802,11 +2812,11 @@ Both traditional and XML-based properties file formats are supported -- for exam `"classpath:/com/example/test.properties"` or `"file:///path/to/file.xml"`. Each path is interpreted as a Spring `Resource`. A plain path (for example, -`"test.properties"`) is treated as a classpath resource that is relative to the -package in which the test class is defined. A path starting with a slash is treated -as an absolute classpath resource (for example: `"/org/example/test.xml"`). A path that -references a URL (for example, a path prefixed with `classpath:`, `file:`, or `http:`) -is loaded by using the specified resource protocol. Resource location wildcards (such as +`"test.properties"`) is treated as a classpath resource that is relative to the package +in which the test class is defined. A path starting with a slash is treated as an +absolute classpath resource (for example: `"/org/example/test.xml"`). A path that +references a URL (for example, a path prefixed with `classpath:`, `file:`, or `http:`) is +loaded by using the specified resource protocol. Resource location wildcards (such as `**/*.properties`) are not permitted: Each location must evaluate to exactly one `.properties` or `.xml` resource. @@ -2857,27 +2867,27 @@ The following example sets two inlined properties: ====== Default Properties File Detection If `@TestPropertySource` is declared as an empty annotation (that is, without explicit -values for the `locations` or `properties` attributes), an attempt is made to detect -a default properties file relative to the class that declared the annotation. For -example, if the annotated test class is `com.example.MyTest`, the corresponding default -properties file is `classpath:com/example/MyTest.properties`. If the default cannot be -detected, an `IllegalStateException` is thrown. +values for the `locations` or `properties` attributes), an attempt is made to detect a +default properties file relative to the class that declared the annotation. For example, +if the annotated test class is `com.example.MyTest`, the corresponding default properties +file is `classpath:com/example/MyTest.properties`. If the default cannot be detected, an +`IllegalStateException` is thrown. ====== Precedence Test property sources have higher precedence than those loaded from the operating system's environment, Java system properties, or property sources added by the -application declaratively by using `@PropertySource` or programmatically. Thus, test property -sources can be used to selectively override properties defined in system and application -property sources. Furthermore, inlined properties have higher precedence than properties -loaded from resource locations. +application declaratively by using `@PropertySource` or programmatically. Thus, test +property sources can be used to selectively override properties defined in system and +application property sources. Furthermore, inlined properties have higher precedence than +properties loaded from resource locations. -In the next example, the `timezone` and `port` properties and any properties -defined in `"/test.properties"` override any properties of the same name that are -defined in system and application property sources. Furthermore, if the -`"/test.properties"` file defines entries for the `timezone` and `port` properties those -are overridden by the inlined properties declared by using the `properties` attribute. -The following example shows how to specify properties both in a file and inline: +In the next example, the `timezone` and `port` properties and any properties defined in +`"/test.properties"` override any properties of the same name that are defined in system +and application property sources. Furthermore, if the `"/test.properties"` file defines +entries for the `timezone` and `port` properties those are overridden by the inlined +properties declared by using the `properties` attribute. The following example shows how +to specify properties both in a file and inline: ==== [source,java,indent=0] @@ -2898,25 +2908,24 @@ The following example shows how to specify properties both in a file and inline: `@TestPropertySource` supports boolean `inheritLocations` and `inheritProperties` attributes that denote whether resource locations for properties files and inlined -properties declared by superclasses should be inherited. The default value for both -flags is `true`. This means that a test class inherits the locations and inlined -properties declared by any superclasses. Specifically, the locations and inlined -properties for a test class are appended to the locations and inlined properties declared -by superclasses. Thus, subclasses have the option of extending the locations and -inlined properties. Note that properties that appear later shadow (that is, -override) properties of the same name that appear earlier. In addition, the -aforementioned precedence rules apply for inherited test property sources as well. +properties declared by superclasses should be inherited. The default value for both flags +is `true`. This means that a test class inherits the locations and inlined properties +declared by any superclasses. Specifically, the locations and inlined properties for a +test class are appended to the locations and inlined properties declared by superclasses. +Thus, subclasses have the option of extending the locations and inlined properties. Note +that properties that appear later shadow (that is, override) properties of the same name +that appear earlier. In addition, the aforementioned precedence rules apply for inherited +test property sources as well. -If the `inheritLocations` or `inheritProperties` attribute in `@TestPropertySource` is set -to `false`, the locations or inlined properties, respectively, for the test class shadow -and effectively replace the configuration defined by superclasses. +If the `inheritLocations` or `inheritProperties` attribute in `@TestPropertySource` is +set to `false`, the locations or inlined properties, respectively, for the test class +shadow and effectively replace the configuration defined by superclasses. -In the next example, the `ApplicationContext` for `BaseTest` is loaded by using -only the `base.properties` file as a test property source. In contrast, the -`ApplicationContext` for `ExtendedTest` is loaded by using the `base.properties` -and `extended.properties` files as test property source locations. -The following example shows how to define properties in both a subclass and its superclass -by using `properties` files: +In the next example, the `ApplicationContext` for `BaseTest` is loaded by using only the +`base.properties` file as a test property source. In contrast, the `ApplicationContext` +for `ExtendedTest` is loaded by using the `base.properties` and `extended.properties` +files as test property source locations. The following example shows how to define +properties in both a subclass and its superclass by using `properties` files: ==== [source,java,indent=0] @@ -2936,8 +2945,8 @@ by using `properties` files: ---- ==== -In the next example, the `ApplicationContext` for `BaseTest` is loaded by using only -the inlined `key1` property. In contrast, the `ApplicationContext` for `ExtendedTest` is +In the next example, the `ApplicationContext` for `BaseTest` is loaded by using only the +inlined `key1` property. In contrast, the `ApplicationContext` for `ExtendedTest` is loaded by using the inlined `key1` and `key2` properties. The following example shows how to define properties in both a subclass and its superclass by using inline properties: @@ -2964,34 +2973,34 @@ to define properties in both a subclass and its superclass by using inline prope [[testcontext-ctx-management-web]] ===== Loading a `WebApplicationContext` -Spring 3.2 introduced support for loading a `WebApplicationContext` in integration -tests. To instruct the TestContext framework to load a `WebApplicationContext` instead -of a standard `ApplicationContext`, you can annotate the respective test class with +Spring 3.2 introduced support for loading a `WebApplicationContext` in integration tests. +To instruct the TestContext framework to load a `WebApplicationContext` instead of a +standard `ApplicationContext`, you can annotate the respective test class with `@WebAppConfiguration`. The presence of `@WebAppConfiguration` on your test class instructs the TestContext framework (TCF) that a `WebApplicationContext` (WAC) should be loaded for your integration tests. In the background, the TCF makes sure that a `MockServletContext` is created and supplied to your test's WAC. By default, the base resource path for your -`MockServletContext` is set to `src/main/webapp`. This is interpreted as a path -relative to the root of your JVM (normally the path to your project). If you are -familiar with the directory structure of a web application in a Maven project, you -know that `src/main/webapp` is the default location for the root of your WAR. If you -need to override this default, you can provide an alternate path to the -`@WebAppConfiguration` annotation (for example, `@WebAppConfiguration("src/test/webapp")`). If -you wish to reference a base resource path from the classpath instead of the file -system, you can use Spring's `classpath:` prefix. - -Note that Spring's testing support for `WebApplicationContext` implementations is on par with its -support for standard `ApplicationContext` implementations. When testing with a `WebApplicationContext`, -you are free to declare XML configuration files, Groovy scripts, or `@Configuration` -classes by using `@ContextConfiguration`. You are also free to use any other test -annotations, such as `@ActiveProfiles`, `@TestExecutionListeners`, `@Sql`, `@Rollback`, -and others. - -The remaining examples in this section show some of the various configuration options for loading -a `WebApplicationContext`. The following example shows the TestContext framework's support -for convention over configuration: +`MockServletContext` is set to `src/main/webapp`. This is interpreted as a path relative +to the root of your JVM (normally the path to your project). If you are familiar with the +directory structure of a web application in a Maven project, you know that +`src/main/webapp` is the default location for the root of your WAR. If you need to +override this default, you can provide an alternate path to the `@WebAppConfiguration` +annotation (for example, `@WebAppConfiguration("src/test/webapp")`). If you wish to +reference a base resource path from the classpath instead of the file system, you can use +Spring's `classpath:` prefix. + +Note that Spring's testing support for `WebApplicationContext` implementations is on par +with its support for standard `ApplicationContext` implementations. When testing with a +`WebApplicationContext`, you are free to declare XML configuration files, Groovy scripts, +or `@Configuration` classes by using `@ContextConfiguration`. You are also free to use +any other test annotations, such as `@ActiveProfiles`, `@TestExecutionListeners`, `@Sql`, +`@Rollback`, and others. + +The remaining examples in this section show some of the various configuration options for +loading a `WebApplicationContext`. The following example shows the TestContext +framework's support for convention over configuration: .Conventions ==== @@ -3013,14 +3022,12 @@ for convention over configuration: ---- ==== -If you annotate a test class with `@WebAppConfiguration` without -specifying a resource base path, the resource path effectively defaults -to `file:src/main/webapp`. Similarly, if you declare `@ContextConfiguration` without -specifying resource `locations`, annotated `classes`, or context `initializers`, Spring -tries to detect the presence of your configuration by using conventions -(that is, `WacTests-context.xml` in the same package as the `WacTests` class or static -nested `@Configuration` classes). - +If you annotate a test class with `@WebAppConfiguration` without specifying a resource +base path, the resource path effectively defaults to `file:src/main/webapp`. Similarly, +if you declare `@ContextConfiguration` without specifying resource `locations`, annotated +`classes`, or context `initializers`, Spring tries to detect the presence of your +configuration by using conventions (that is, `WacTests-context.xml` in the same package +as the `WacTests` class or static nested `@Configuration` classes). The following example shows how to explicitly declare a resource base path with `@WebAppConfiguration` and an XML resource location with `@ContextConfiguration`: @@ -3070,28 +3077,26 @@ annotations by specifying a Spring resource prefix: ---- ==== -Contrast the comments in this -example with the previous example. +Contrast the comments in this example with the previous example. .[[testcontext-ctx-management-web-mocks]]Working with Web Mocks -- To provide comprehensive web testing support, Spring 3.2 introduced a `ServletTestExecutionListener` that is enabled by default. When testing against a -`WebApplicationContext`, this <> sets -up default thread-local state by using Spring Web's `RequestContextHolder` before each test -method and creates a `MockHttpServletRequest`, a `MockHttpServletResponse`, and a -`ServletWebRequest` based on the base resource path configured with +`WebApplicationContext`, this <> +sets up default thread-local state by using Spring Web's `RequestContextHolder` before +each test method and creates a `MockHttpServletRequest`, a `MockHttpServletResponse`, and +a `ServletWebRequest` based on the base resource path configured with `@WebAppConfiguration`. `ServletTestExecutionListener` also ensures that the -`MockHttpServletResponse` and `ServletWebRequest` can be injected into the test -instance, and, once the test is complete, it cleans up thread-local state. +`MockHttpServletResponse` and `ServletWebRequest` can be injected into the test instance, +and, once the test is complete, it cleans up thread-local state. Once you have a `WebApplicationContext` loaded for your test, you might find that you need to interact with the web mocks -- for example, to set up your test fixture or to -perform assertions after invoking your web component. The following example shows -which mocks can be autowired into your test instance. Note that the -`WebApplicationContext` and `MockServletContext` are both cached across the test suite, -whereas the other mocks are managed per test method by the -`ServletTestExecutionListener`. +perform assertions after invoking your web component. The following example shows which +mocks can be autowired into your test instance. Note that the `WebApplicationContext` and +`MockServletContext` are both cached across the test suite, whereas the other mocks are +managed per test method by the `ServletTestExecutionListener`. .Injecting mocks ==== @@ -3132,16 +3137,14 @@ whereas the other mocks are managed per test method by the ===== Context Caching Once the TestContext framework loads an `ApplicationContext` (or `WebApplicationContext`) -for a test, that context is cached and reused for all subsequent tests that -declare the same unique context configuration within the same test suite. To understand -how caching works, it is important to understand what is meant by "`unique`" and "`test -suite.`" +for a test, that context is cached and reused for all subsequent tests that declare the +same unique context configuration within the same test suite. To understand how caching +works, it is important to understand what is meant by "`unique`" and "`test suite.`" -An `ApplicationContext` can be uniquely identified by the combination of -configuration parameters that is used to load it. Consequently, the unique combination -of configuration parameters is used to generate a key under which the context is -cached. The TestContext framework uses the following configuration parameters to build -the context cache key: +An `ApplicationContext` can be uniquely identified by the combination of configuration +parameters that is used to load it. Consequently, the unique combination of configuration +parameters is used to generate a key under which the context is cached. The TestContext +framework uses the following configuration parameters to build the context cache key: * `locations` (from `@ContextConfiguration`) * `classes` (from `@ContextConfiguration`) @@ -3162,9 +3165,9 @@ under a key that is based solely on those locations. So, if `TestClassB` also de implicitly through inheritance) but does not define `@WebAppConfiguration`, a different `ContextLoader`, different active profiles, different context initializers, different test property sources, or a different parent context, then the same `ApplicationContext` -is shared by both test classes. This means that the setup cost for loading an -application context is incurred only once (per test suite), and subsequent test execution -is much faster. +is shared by both test classes. This means that the setup cost for loading an application +context is incurred only once (per test suite), and subsequent test execution is much +faster. .Test suites and forked processes [NOTE] @@ -3174,21 +3177,21 @@ means that the context is literally stored in a `static` variable. In other word tests execute in separate processes, the static cache is cleared between each test execution, which effectively disables the caching mechanism. -To benefit from the caching mechanism, all tests must run within the same process or -test suite. This can be achieved by executing all tests as a group within an IDE. -Similarly, when executing tests with a build framework such as Ant, Maven, or Gradle, it -is important to make sure that the build framework does not fork between tests. For -example, if the +To benefit from the caching mechanism, all tests must run within the same process or test +suite. This can be achieved by executing all tests as a group within an IDE. Similarly, +when executing tests with a build framework such as Ant, Maven, or Gradle, it is +important to make sure that the build framework does not fork between tests. For example, +if the http://maven.apache.org/plugins/maven-surefire-plugin/test-mojo.html#forkMode[`forkMode`] -for the Maven Surefire plug-in is set to `always` or `pertest`, the TestContext -framework cannot cache application contexts between test classes, and the -build process runs significantly more slowly as a result. +for the Maven Surefire plug-in is set to `always` or `pertest`, the TestContext framework +cannot cache application contexts between test classes, and the build process runs +significantly more slowly as a result. ==== Since Spring Framework 4.3, the size of the context cache is bounded with a default maximum size of 32. Whenever the maximum size is reached, a least recently used (LRU) -eviction policy is used to evict and close stale contexts. You can configure the maximum size -from the command line or a build script by setting a JVM system property named +eviction policy is used to evict and close stale contexts. You can configure the maximum +size from the command line or a build script by setting a JVM system property named `spring.test.context.cache.maxSize`. As an alternative, you can set the same property programmatically by using the `SpringProperties` API. @@ -3199,12 +3202,12 @@ the underlying context cache, you can set the log level for the `org.springframework.test.context.cache` logging category to `DEBUG`. In the unlikely case that a test corrupts the application context and requires reloading -(for example, by modifying a bean definition or the state of an application object), -you can annotate your test class or test method with `@DirtiesContext` (see the -discussion of `@DirtiesContext` in <>). This -instructs Spring to remove the context from the cache and rebuild the application -context before running the next test. Note that support for the `@DirtiesContext` -annotation is provided by the `DirtiesContextBeforeModesTestExecutionListener` and the +(for example, by modifying a bean definition or the state of an application object), you +can annotate your test class or test method with `@DirtiesContext` (see the discussion of +`@DirtiesContext` in <>). This instructs Spring +to remove the context from the cache and rebuild the application context before running +the next test. Note that support for the `@DirtiesContext` annotation is provided by the +`DirtiesContextBeforeModesTestExecutionListener` and the `DirtiesContextTestExecutionListener`, which are enabled by default. @@ -3213,10 +3216,10 @@ annotation is provided by the `DirtiesContextBeforeModesTestExecutionListener` a When writing integration tests that rely on a loaded Spring `ApplicationContext`, it is often sufficient to test against a single context. However, there are times when it is -beneficial or even necessary to test against a hierarchy of `ApplicationContext` instances. For -example, if you are developing a Spring MVC web application, you typically have a -root `WebApplicationContext` loaded by Spring's `ContextLoaderListener` and a child -`WebApplicationContext` loaded by Spring's `DispatcherServlet`. This results in a +beneficial or even necessary to test against a hierarchy of `ApplicationContext` +instances. For example, if you are developing a Spring MVC web application, you typically +have a root `WebApplicationContext` loaded by Spring's `ContextLoaderListener` and a +child `WebApplicationContext` loaded by Spring's `DispatcherServlet`. This results in a parent-child context hierarchy where shared components and infrastructure configuration are declared in the root context and consumed in the child context by web-specific components. Another use case can be found in Spring Batch applications, where you often @@ -3227,14 +3230,14 @@ Since Spring Framework 3.2.2, you can write integration tests that use context hierarchies by declaring context configuration with the `@ContextHierarchy` annotation, either on an individual test class or within a test class hierarchy. If a context hierarchy is declared on multiple classes within a test class hierarchy, you can also -merge or override the context configuration for a specific, named level in -the context hierarchy. When merging configuration for a given level in the hierarchy, the -configuration resource type (that is, XML configuration files or annotated classes) must be -consistent. Otherwise, it is perfectly acceptable to have different levels in a context -hierarchy configured using different resource types. +merge or override the context configuration for a specific, named level in the context +hierarchy. When merging configuration for a given level in the hierarchy, the +configuration resource type (that is, XML configuration files or annotated classes) must +be consistent. Otherwise, it is perfectly acceptable to have different levels in a +context hierarchy configured using different resource types. -The remaining JUnit 4-based examples in this section show common configuration scenarios for -integration tests that require the use of context hierarchies. +The remaining JUnit 4-based examples in this section show common configuration scenarios +for integration tests that require the use of context hierarchies. .Single test class with context hierarchy -- @@ -3242,8 +3245,8 @@ integration tests that require the use of context hierarchies. Spring MVC web application by declaring a context hierarchy that consists of two levels, one for the root `WebApplicationContext` (loaded by using the `TestAppConfig` `@Configuration` class) and one for the dispatcher servlet `WebApplicationContext` -(loaded by using the `WebConfig` `@Configuration` class). The `WebApplicationContext` that -is autowired into the test instance is the one for the child context (that is, the +(loaded by using the `WebConfig` `@Configuration` class). The `WebApplicationContext` +that is autowired into the test instance is the one for the child context (that is, the lowest context in the hierarchy). The following listing shows this configuration scenario: ==== @@ -3270,17 +3273,18 @@ lowest context in the hierarchy). The following listing shows this configuration .Class hierarchy with implicit parent context -- -The test classes in this example define a context hierarchy within a test class hierarchy. -`AbstractWebTests` declares the configuration for a root `WebApplicationContext` in a -Spring-powered web application. Note, however, that `AbstractWebTests` does not declare -`@ContextHierarchy`. Consequently, subclasses of `AbstractWebTests` can optionally -participate in a context hierarchy or follow the standard semantics for -`@ContextConfiguration`. `SoapWebServiceTests` and `RestWebServiceTests` both extend -`AbstractWebTests` and define a context hierarchy by using `@ContextHierarchy`. The result is -that three application contexts are loaded (one for each declaration of -`@ContextConfiguration`), and the application context loaded based on the configuration -in `AbstractWebTests` is set as the parent context for each of the contexts loaded -for the concrete subclasses. The following listing shows this configuration scenario: +The test classes in this example define a context hierarchy within a test class +hierarchy. `AbstractWebTests` declares the configuration for a root +`WebApplicationContext` in a Spring-powered web application. Note, however, that +`AbstractWebTests` does not declare `@ContextHierarchy`. Consequently, subclasses of +`AbstractWebTests` can optionally participate in a context hierarchy or follow the +standard semantics for `@ContextConfiguration`. `SoapWebServiceTests` and +`RestWebServiceTests` both extend `AbstractWebTests` and define a context hierarchy by +using `@ContextHierarchy`. The result is that three application contexts are loaded (one +for each declaration of `@ContextConfiguration`), and the application context loaded +based on the configuration in `AbstractWebTests` is set as the parent context for each of +the contexts loaded for the concrete subclasses. The following listing shows this +configuration scenario: ==== [source,java,indent=0] @@ -3303,18 +3307,17 @@ for the concrete subclasses. The following listing shows this configuration scen .Class hierarchy with merged context hierarchy configuration -- -The classes in this exxample show the use of named hierarchy levels in order to -merge the configuration for specific levels in a context hierarchy. `BaseTests` -defines two levels in the hierarchy, `parent` and `child`. `ExtendedTests` extends -`BaseTests` and instructs the Spring TestContext Framework to merge the context -configuration for the `child` hierarchy level, by ensuring that the names -declared in the `name` attribute in `@ContextConfiguration` are both `child`. The -result is that three application contexts are loaded: one for `/app-config.xml`, -one for `/user-config.xml`, and one for `{"/user-config.xml", "/order-config.xml"}`. -As with the previous example, the application context loaded from `/app-config.xml` -is set as the parent context for the contexts loaded from `/user-config.xml` -and `{"/user-config.xml", "/order-config.xml"}`. The following listing shows this -configuration scenario: +The classes in this example show the use of named hierarchy levels in order to merge the +configuration for specific levels in a context hierarchy. `BaseTests` defines two levels +in the hierarchy, `parent` and `child`. `ExtendedTests` extends `BaseTests` and instructs +the Spring TestContext Framework to merge the context configuration for the `child` +hierarchy level, by ensuring that the names declared in the `name` attribute in +`@ContextConfiguration` are both `child`. The result is that three application contexts +are loaded: one for `/app-config.xml`, one for `/user-config.xml`, and one for +`{"/user-config.xml", "/order-config.xml"}`. As with the previous example, the +application context loaded from `/app-config.xml` is set as the parent context for the +contexts loaded from `/user-config.xml` and `{"/user-config.xml", "/order-config.xml"}`. +The following listing shows this configuration scenario: ==== [source,java,indent=0] @@ -3340,9 +3343,9 @@ configuration scenario: In contrast to the previous example, this example demonstrates how to override the configuration for a given named level in a context hierarchy by setting the `inheritLocations` flag in `@ContextConfiguration` to `false`. Consequently, the -application context for `ExtendedTests` is loaded only from -`/test-user-config.xml` and has its parent set to the context loaded from -`/app-config.xml`. The following listing shows this configuration scenario: +application context for `ExtendedTests` is loaded only from `/test-user-config.xml` and +has its parent set to the context loaded from `/app-config.xml`. The following listing +shows this configuration scenario: ==== [source,java,indent=0] @@ -3366,9 +3369,9 @@ application context for `ExtendedTests` is loaded only from ==== .Dirtying a context within a context hierarchy -NOTE: If you use `@DirtiesContext` in a test whose context is configured as part of a context -hierarchy, you can use the `hierarchyMode` flag to control how the context cache is -cleared. For further details, see the discussion of `@DirtiesContext` in +NOTE: If you use `@DirtiesContext` in a test whose context is configured as part of a +context hierarchy, you can use the `hierarchyMode` flag to control how the context cache +is cleared. For further details, see the discussion of `@DirtiesContext` in <> and the {api-spring-framework}/test/annotation/DirtiesContext.html[`@DirtiesContext` Javadoc]. -- @@ -3383,8 +3386,8 @@ default), the dependencies of your test instances are injected from beans in the application context that you configured with `@ContextConfiguration`. You may use setter injection, field injection, or both, depending on which annotations you choose and whether you place them on setter methods or fields. For consistency with the annotation -support introduced in Spring 2.5 and 3.0, you can use Spring's `@Autowired` annotation -or the `@Inject` annotation from JSR 330. +support introduced in Spring 2.5 and 3.0, you can use Spring's `@Autowired` annotation or +the `@Inject` annotation from JSR 330. TIP: The TestContext framework does not instrument the manner in which a test instance is instantiated. Thus, the use of `@Autowired` or `@Inject` for constructors has no effect @@ -3395,12 +3398,12 @@ type>>, if you have multiple bean definitions of the same type, you cannot rely approach for those particular beans. In that case, you can use `@Autowired` in conjunction with `@Qualifier`. As of Spring 3.0, you can also choose to use `@Inject` in conjunction with `@Named`. Alternatively, if your test class has access to its -`ApplicationContext`, you can perform an explicit lookup by using (for example) a call -to `applicationContext.getBean("titleRepository")`. +`ApplicationContext`, you can perform an explicit lookup by using (for example) a call to +`applicationContext.getBean("titleRepository")`. -If you do not want dependency injection applied to your test instances, do not -annotate fields or setter methods with `@Autowired` or `@Inject`. Alternatively, you can -disable dependency injection altogether by explicitly configuring your class with +If you do not want dependency injection applied to your test instances, do not annotate +fields or setter methods with `@Autowired` or `@Inject`. Alternatively, you can disable +dependency injection altogether by explicitly configuring your class with `@TestExecutionListeners` and omitting `DependencyInjectionTestExecutionListener.class` from the list of listeners. @@ -3411,13 +3414,12 @@ is presented after all sample code listings. [NOTE] ==== -The dependency injection behavior in the following code listings is not specific to -JUnit 4. The same DI techniques can be used in conjunction with any testing framework. +The dependency injection behavior in the following code listings is not specific to JUnit +4. The same DI techniques can be used in conjunction with any testing framework. The following examples make calls to static assertion methods, such as `assertNotNull()`, but without prepending the call with `Assert`. In such cases, assume that the method was -properly imported through an `import static` declaration that is not shown in the -example. +properly imported through an `import static` declaration that is not shown in the example. ==== The first code listing shows a JUnit 4 based implementation of the test class that uses @@ -3530,7 +3532,7 @@ The specified qualifier value indicates the specific `DataSource` bean to inject narrowing the set of type matches to a specific bean. Its value is matched against `` declarations within the corresponding `` definitions. The bean name is used as a fallback qualifier value, so you can effectively also point to a specific -bean by name there (as shown earler, assuming that `myDataSource` is the bean `id`). +bean by name there (as shown earlier, assuming that `myDataSource` is the bean `id`). ===== @@ -3538,24 +3540,24 @@ bean by name there (as shown earler, assuming that `myDataSource` is the bean `i [[testcontext-web-scoped-beans]] ==== Testing Request- and Session-scoped Beans -Spring has supported <> -since the early years. Since Spring 3.2, you can test your -request-scoped and session-scoped beans by following these steps: +Spring has supported <> since the early years. Since Spring 3.2, you can test your request-scoped and +session-scoped beans by following these steps: -. Ensure that a `WebApplicationContext` is loaded for your test by annotating your test +* Ensure that a `WebApplicationContext` is loaded for your test by annotating your test class with `@WebAppConfiguration`. -. Inject the mock request or session into your test instance and prepare your test +* Inject the mock request or session into your test instance and prepare your test fixture as appropriate. -. Invoke your web component that you retrieved from the configured +* Invoke your web component that you retrieved from the configured `WebApplicationContext` (with dependency injection). -. Perform assertions against the mocks. +* Perform assertions against the mocks. -The next code snippet shows the XML configuration for a login use case. Note -that the `userService` bean has a dependency on a request-scoped `loginAction` bean. -Also, the `LoginAction` is instantiated by using <> that -retrieve the username and password from the current HTTP request. In our test, we -want to configure these request parameters through the mock managed by the TestContext -framework. The following listing shows the configuration for this use case: +The next code snippet shows the XML configuration for a login use case. Note that the +`userService` bean has a dependency on a request-scoped `loginAction` bean. Also, the +`LoginAction` is instantiated by using <> that +retrieve the username and password from the current HTTP request. In our test, we want to +configure these request parameters through the mock managed by the TestContext framework. +The following listing shows the configuration for this use case: .Request-scoped bean configuration ==== @@ -3582,8 +3584,8 @@ test) and the `MockHttpServletRequest` into our test instance. Within our `requestScope()` test method, we set up our test fixture by setting request parameters in the provided `MockHttpServletRequest`. When the `loginUser()` method is invoked on our `userService`, we are assured that the user service has access to the request-scoped -`loginAction` for the current `MockHttpServletRequest` (that is, the one in which we just set -parameters). We can then perform assertions against the results based on the known +`loginAction` for the current `MockHttpServletRequest` (that is, the one in which we just +set parameters). We can then perform assertions against the results based on the known inputs for the username and password. The following listing shows how to do so: .Request-scoped bean test @@ -3611,12 +3613,12 @@ inputs for the username and password. The following listing shows how to do so: ---- ==== -The following code snippet is similar to the one we saw earlier for a request-scoped bean. -However, this time, the `userService` bean has a dependency on a session-scoped +The following code snippet is similar to the one we saw earlier for a request-scoped +bean. However, this time, the `userService` bean has a dependency on a session-scoped `userPreferences` bean. Note that the `UserPreferences` bean is instantiated by using a -SpEL expression that retrieves the theme from the current HTTP session. In our test, -we need to configure a theme in the mock session managed by the TestContext -framework. The following example shows how to do so: +SpEL expression that retrieves the theme from the current HTTP session. In our test, we +need to configure a theme in the mock session managed by the TestContext framework. The +following example shows how to do so: .Session-scoped bean configuration ==== @@ -3683,32 +3685,32 @@ transactions, however, you must configure a `PlatformTransactionManager` bean in details are provided later). In addition, you must declare Spring's `@Transactional` annotation either at the class or the method level for your tests. + [[testcontext-tx-test-managed-transactions]] ===== Test-managed Transactions Test-managed transactions are transactions that are managed declaratively by using the -`TransactionalTestExecutionListener` or programmatically by using `TestTransaction` (described -later). You should not confuse such transactions with Spring-managed transactions -(those managed directly by Spring within the `ApplicationContext` loaded for tests) -or application-managed transactions (those managed programmatically within +`TransactionalTestExecutionListener` or programmatically by using `TestTransaction` +(described later). You should not confuse such transactions with Spring-managed +transactions (those managed directly by Spring within the `ApplicationContext` loaded for +tests) or application-managed transactions (those managed programmatically within application code that is invoked by tests). Spring-managed and application-managed -transactions typically participate in test-managed transactions. However, you should use caution -if Spring-managed or application-managed transactions are configured with -any propagation type other than `REQUIRED` or `SUPPORTS` (see the discussion on +transactions typically participate in test-managed transactions. However, you should use +caution if Spring-managed or application-managed transactions are configured with any +propagation type other than `REQUIRED` or `SUPPORTS` (see the discussion on <> for details). - [[testcontext-tx-enabling-transactions]] ===== Enabling and Disabling Transactions Annotating a test method with `@Transactional` causes the test to be run within a -transaction that is, by default, automatically rolled back after completion of the -test. If a test class is annotated with `@Transactional`, each test method within that -class hierarchy runs within a transaction. Test methods that are not annotated -with `@Transactional` (at the class or method level) are not run within a -transaction. Furthermore, tests that are annotated with `@Transactional` but have the -`propagation` type set to `NOT_SUPPORTED` are not run within a transaction. +transaction that is, by default, automatically rolled back after completion of the test. +If a test class is annotated with `@Transactional`, each test method within that class +hierarchy runs within a transaction. Test methods that are not annotated with +`@Transactional` (at the class or method level) are not run within a transaction. +Furthermore, tests that are annotated with `@Transactional` but have the `propagation` +type set to `NOT_SUPPORTED` are not run within a transaction. Note that <> and @@ -3764,16 +3766,15 @@ a Hibernate-based `UserRepository`: ---- ==== -As explained in -<>, there is no need to clean up the -database after the `createUser()` method runs, since any changes made to the -database are automatically rolled back by the `TransactionalTestExecutionListener`. -See <> for an additional example. +As explained in <>, there is no need to +clean up the database after the `createUser()` method runs, since any changes made to the +database are automatically rolled back by the `TransactionalTestExecutionListener`. See +<> for an additional example. [[testcontext-tx-rollback-and-commit-behavior]] -===== Transaction rollback and commit behavior +===== Transaction Rollback and Commit Behavior By default, test transactions will be automatically rolled back after completion of the test; however, transactional commit and rollback behavior can be configured declaratively @@ -3784,14 +3785,15 @@ via the `@Commit` and `@Rollback` annotations. See the corresponding entries in ===== Programmatic Transaction Management Since Spring Framework 4.1, you can interact with test-managed transactions -programmatically by using the static methods in `TestTransaction`. For example, you can use -`TestTransaction` within test methods, before methods, and after -methods to start or end the current test-managed transaction or to configure the current -test-managed transaction for rollback or commit. Support for `TestTransaction` is -automatically available whenever the `TransactionalTestExecutionListener` is enabled. +programmatically by using the static methods in `TestTransaction`. For example, you can +use `TestTransaction` within test methods, before methods, and after methods to start or +end the current test-managed transaction or to configure the current test-managed +transaction for rollback or commit. Support for `TestTransaction` is automatically +available whenever the `TransactionalTestExecutionListener` is enabled. The following example demonstrates some of the features of `TestTransaction` (see the -{api-spring-framework}/test/context/transaction/TestTransaction.html[Javadoc for `TestTransaction`] for further details): +{api-spring-framework}/test/context/transaction/TestTransaction.html[Javadoc for +`TestTransaction`] for further details): ==== [source,java,indent=0] @@ -3831,21 +3833,21 @@ The following example demonstrates some of the features of `TestTransaction` (se [[testcontext-tx-before-and-after-tx]] ===== Running Code Outside of a Transaction -Occasionally, you may need to execute certain code before or after a transactional test method -but outside the transactional context -- for example, to verify the initial database state -prior to running your test or to verify expected transactional commit behavior after your -test runs (if the test was configured to commit the transaction). +Occasionally, you may need to execute certain code before or after a transactional test +method but outside the transactional context -- for example, to verify the initial +database state prior to running your test or to verify expected transactional commit +behavior after your test runs (if the test was configured to commit the transaction). `TransactionalTestExecutionListener` supports the `@BeforeTransaction` and `@AfterTransaction` annotations for exactly such scenarios. You can annotate any `void` method in a test class or any `void` default method in a test interface with one of these annotations, and the `TransactionalTestExecutionListener` ensures that your before transaction method or after transaction method runs at the appropriate time. -TIP: Any before methods (such as methods annotated with JUnit Jupiter's `@BeforeEach`) and -any after methods (such as methods annotated with JUnit Jupiter's `@AfterEach`) are -run within a transaction. In addition, methods annotated with -`@BeforeTransaction` or `@AfterTransaction` are not run for test methods -that are not configured to run within a transaction. +TIP: Any before methods (such as methods annotated with JUnit Jupiter's `@BeforeEach`) +and any after methods (such as methods annotated with JUnit Jupiter's `@AfterEach`) are +run within a transaction. In addition, methods annotated with `@BeforeTransaction` or +`@AfterTransaction` are not run for test methods that are not configured to run within a +transaction. @@ -3853,13 +3855,14 @@ that are not configured to run within a transaction. ===== Configuring a Transaction Manager `TransactionalTestExecutionListener` expects a `PlatformTransactionManager` bean to be -defined in the Spring `ApplicationContext` for the test. If there are multiple -instances of `PlatformTransactionManager` within the test's `ApplicationContext`, you can declare -a qualifier by using `@Transactional("myTxMgr")` or -`@Transactional(transactionManager = "myTxMgr")`, or `TransactionManagementConfigurer` -can be implemented by an `@Configuration` class. Consult the {api-spring-framework}/test/context/transaction/TestContextTransactionUtils.html#retrieveTransactionManager[Javadoc for -`TestContextTransactionUtils.retrieveTransactionManager()`] for details on the algorithm -used to look up a transaction manager in the test's `ApplicationContext`. +defined in the Spring `ApplicationContext` for the test. If there are multiple instances +of `PlatformTransactionManager` within the test's `ApplicationContext`, you can declare a +qualifier by using `@Transactional("myTxMgr")` or `@Transactional(transactionManager = +"myTxMgr")`, or `TransactionManagementConfigurer` can be implemented by an +`@Configuration` class. Consult the +{api-spring-framework}/test/context/transaction/TestContextTransactionUtils.html#retrieveTransactionManager[Javadoc +for `TestContextTransactionUtils.retrieveTransactionManager()`] for details on the +algorithm used to look up a transaction manager in the test's `ApplicationContext`. @@ -3921,13 +3924,13 @@ following example shows the relevant annotations in bold: [NOTE] ===== When you test application code that manipulates the state of a Hibernate session or JPA -persistence context, make sure to flush the underlying unit of work within test -methods that run that code. Failing to flush the underlying unit of work can produce -false positives: Your test passes, but the same code throws an exception in a live, -production environment. Note that this applies to any ORM framework that maintains an -in-memory unit of work. In the following Hibernate-based example test case, one method -demonstrates a false positive, and the other method correctly exposes the results of -flushing the session: +persistence context, make sure to flush the underlying unit of work within test methods +that run that code. Failing to flush the underlying unit of work can produce false +positives: Your test passes, but the same code throws an exception in a live, production +environment. Note that this applies to any ORM framework that maintains an in-memory unit +of work. In the following Hibernate-based example test case, one method demonstrates a +false positive, and the other method correctly exposes the results of flushing the +session: ==== [source,java,indent=0] @@ -3995,13 +3998,13 @@ The following example shows matching methods for JPA: [[testcontext-executing-sql]] ==== Executing SQL Scripts -When writing integration tests against a relational database, it is often beneficial -to execute SQL scripts to modify the database schema or insert test data into tables. -The `spring-jdbc` module provides support for _initializing_ an embedded or existing -database by executing SQL scripts when the Spring `ApplicationContext` is loaded. See -<> and -<> for details. +When writing integration tests against a relational database, it is often beneficial to +execute SQL scripts to modify the database schema or insert test data into tables. The +`spring-jdbc` module provides support for _initializing_ an embedded or existing database +by executing SQL scripts when the Spring `ApplicationContext` is loaded. See +<> and +<> for details. Although it is very useful to initialize a database for testing _once_ when the `ApplicationContext` is loaded, sometimes it is essential to be able to modify the @@ -4019,24 +4022,26 @@ integration test methods. * `org.springframework.test.context.junit4.AbstractTransactionalJUnit4SpringContextTests` * `org.springframework.test.context.testng.AbstractTransactionalTestNGSpringContextTests` -`ScriptUtils` provides a collection of static utility methods for working with SQL scripts -and is mainly intended for internal use within the framework. However, if you require -full control over how SQL scripts are parsed and executed, `ScriptUtils` may suit your -needs better than some of the other alternatives described later. See the {api-spring-framework}/jdbc/datasource/init/ScriptUtils.html[Javadoc] for -individual methods in `ScriptUtils` for further details. +`ScriptUtils` provides a collection of static utility methods for working with SQL +scripts and is mainly intended for internal use within the framework. However, if you +require full control over how SQL scripts are parsed and executed, `ScriptUtils` may suit +your needs better than some of the other alternatives described later. See the +{api-spring-framework}/jdbc/datasource/init/ScriptUtils.html[Javadoc] for individual +methods in `ScriptUtils` for further details. -`ResourceDatabasePopulator` provides an object-based API for programmatically -populating, initializing, or cleaning up a database by using SQL scripts defined in -external resources. `ResourceDatabasePopulator` provides options for configuring the -character encoding, statement separator, comment delimiters, and error handling flags -used when parsing and running the scripts. Each of the configuration options has -a reasonable default value. See the {api-spring-framework}/jdbc/datasource/init/ResourceDatabasePopulator.html[Javadoc] for details on default values. To -run the scripts configured in a `ResourceDatabasePopulator`, you can invoke either -the `populate(Connection)` method to execute the populator against a -`java.sql.Connection` or the `execute(DataSource)` method to execute the populator -against a `javax.sql.DataSource`. The following example specifies SQL scripts for a test -schema and test data, sets the statement separator to `@@`, and executes the -scripts against a `DataSource`: +`ResourceDatabasePopulator` provides an object-based API for programmatically populating, +initializing, or cleaning up a database by using SQL scripts defined in external +resources. `ResourceDatabasePopulator` provides options for configuring the character +encoding, statement separator, comment delimiters, and error handling flags used when +parsing and running the scripts. Each of the configuration options has a reasonable +default value. See the +{api-spring-framework}/jdbc/datasource/init/ResourceDatabasePopulator.html[Javadoc] for +details on default values. To run the scripts configured in a +`ResourceDatabasePopulator`, you can invoke either the `populate(Connection)` method to +execute the populator against a `java.sql.Connection` or the `execute(DataSource)` method +to execute the populator against a `javax.sql.DataSource`. The following example +specifies SQL scripts for a test schema and test data, sets the statement separator to +`@@`, and executes the scripts against a `DataSource`: ==== [source,java,indent=0] @@ -4057,37 +4062,37 @@ scripts against a `DataSource`: Note that `ResourceDatabasePopulator` internally delegates to `ScriptUtils` for parsing and running SQL scripts. Similarly, the `executeSqlScript(..)` methods in -<> and -<> -internally use a `ResourceDatabasePopulator` to run SQL scripts. See the Javadoc -for the various `executeSqlScript(..)` methods for further details. +<> +and <> +internally use a `ResourceDatabasePopulator` to run SQL scripts. See the Javadoc for the +various `executeSqlScript(..)` methods for further details. [[testcontext-executing-sql-declaratively]] ===== Executing SQL scripts declaratively with @Sql -In addition to the aforementioned mechanisms for running SQL scripts -programmatically, you can declaratively configure SQL scripts in the Spring -TestContext Framework. Specifically, you can declare the `@Sql` annotation on a test -class or test method to configure the resource paths to SQL scripts that should be -run against a given database before or after an integration test method. Note -that method-level declarations override class-level declarations and that support for -`@Sql` is provided by the `SqlScriptsTestExecutionListener`, which is enabled by default. +In addition to the aforementioned mechanisms for running SQL scripts programmatically, +you can declaratively configure SQL scripts in the Spring TestContext Framework. +Specifically, you can declare the `@Sql` annotation on a test class or test method to +configure the resource paths to SQL scripts that should be run against a given database +before or after an integration test method. Note that method-level declarations override +class-level declarations and that support for `@Sql` is provided by the +`SqlScriptsTestExecutionListener`, which is enabled by default. ====== Path Resource Semantics Each path is interpreted as a Spring `Resource`. A plain path (for example, -`"schema.sql"`) is treated as a classpath resource that is relative to the -package in which the test class is defined. A path starting with a slash is treated -as an absolute classpath resource (for example, `"/org/example/schema.sql"`). A path -that references a URL (for example, a path prefixed with `classpath:`, `file:`, `http:`) -is loaded by using the specified resource protocol. +`"schema.sql"`) is treated as a classpath resource that is relative to the package in +which the test class is defined. A path starting with a slash is treated as an absolute +classpath resource (for example, `"/org/example/schema.sql"`). A path that references a +URL (for example, a path prefixed with `classpath:`, `file:`, `http:`) is loaded by using +the specified resource protocol. -The following example shows how to use `@Sql` at the class level and at the method -level within a JUnit Jupiter based integration test class: +The following example shows how to use `@Sql` at the class level and at the method level +within a JUnit Jupiter based integration test class: ==== [source,java,indent=0] @@ -4120,10 +4125,10 @@ depending on where `@Sql` is declared. If a default cannot be detected, an `IllegalStateException` is thrown. * Class-level declaration: If the annotated test class is `com.example.MyTest`, the - corresponding default script is `classpath:com/example/MyTest.sql`. + corresponding default script is `classpath:com/example/MyTest.sql`. * Method-level declaration: If the annotated test method is named `testMethod()` and is - defined in the class `com.example.MyTest`, the corresponding default script is - `classpath:com/example/MyTest.testMethod.sql`. + defined in the class `com.example.MyTest`, the corresponding default script is + `classpath:com/example/MyTest.testMethod.sql`. @@ -4131,13 +4136,12 @@ depending on where `@Sql` is declared. If a default cannot be detected, an If you need to configure multiple sets of SQL scripts for a given test class or test method but with different syntax configuration, different error handling rules, or -different execution phases per set, you can declare multiple instances of -`@Sql`. With Java 8, you can use `@Sql` as a repeatable annotation. Otherwise, you can use the -`@SqlGroup` annotation as an explicit container for declaring multiple -instances of `@Sql`. +different execution phases per set, you can declare multiple instances of `@Sql`. With +Java 8, you can use `@Sql` as a repeatable annotation. Otherwise, you can use the +`@SqlGroup` annotation as an explicit container for declaring multiple instances of +`@Sql`. -The following example shows how to use `@Sql` as a repeatable annotation with -Java 8: +The following example shows how to use `@Sql` as a repeatable annotation with Java 8: ==== [source,java,indent=0] @@ -4152,11 +4156,12 @@ Java 8: ---- ==== -In the scenario presented in the preceding example, the `test-schema.sql` script uses a different syntax for -single-line comments. +In the scenario presented in the preceding example, the `test-schema.sql` script uses a +different syntax for single-line comments. -The following example is identical to the preceding example, except that the `@Sql` declarations are -grouped together within `@SqlGroup`, for compatibility with Java 6 and Java 7. +The following example is identical to the preceding example, except that the `@Sql` +declarations are grouped together within `@SqlGroup`, for compatibility with Java 6 and +Java 7. ==== [source,java,indent=0] @@ -4175,10 +4180,10 @@ grouped together within `@SqlGroup`, for compatibility with Java 6 and Java 7. ====== Script Execution Phases -By default, SQL scripts are executed before the corresponding test method. However, -if you need to run a particular set of scripts after the test method (for -example, to clean up database state), you can use the `executionPhase` attribute in `@Sql`, -as the following example shows: +By default, SQL scripts are executed before the corresponding test method. However, if +you need to run a particular set of scripts after the test method (for example, to clean +up database state), you can use the `executionPhase` attribute in `@Sql`, as the +following example shows: ==== [source,java,indent=0] @@ -4201,22 +4206,22 @@ as the following example shows: ---- ==== -Note that `ISOLATED` and `AFTER_TEST_METHOD` are -statically imported from `Sql.TransactionMode` and `Sql.ExecutionPhase`, respectively. +Note that `ISOLATED` and `AFTER_TEST_METHOD` are statically imported from +`Sql.TransactionMode` and `Sql.ExecutionPhase`, respectively. ====== Script Configuration with `@SqlConfig` -You can configure script parsing and error handling by using the -`@SqlConfig` annotation. When declared as a class-level annotation on an integration test -class, `@SqlConfig` serves as global configuration for all SQL scripts within the test -class hierarchy. When declared directly by using the `config` attribute of the `@Sql` -annotation, `@SqlConfig` serves as local configuration for the SQL scripts declared -within the enclosing `@Sql` annotation. Every attribute in `@SqlConfig` has an implicit -default value, which is documented in the Javadoc of the corresponding attribute. Due to -the rules defined for annotation attributes in the Java Language Specification, it is, -unfortunately, not possible to assign a value of `null` to an annotation attribute. Thus, -in order to support overrides of inherited global configuration, `@SqlConfig` attributes -have an explicit default value of either `""` (for Strings) or `DEFAULT` (for enumerations). This +You can configure script parsing and error handling by using the `@SqlConfig` annotation. +When declared as a class-level annotation on an integration test class, `@SqlConfig` +serves as global configuration for all SQL scripts within the test class hierarchy. When +declared directly by using the `config` attribute of the `@Sql` annotation, `@SqlConfig` +serves as local configuration for the SQL scripts declared within the enclosing `@Sql` +annotation. Every attribute in `@SqlConfig` has an implicit default value, which is +documented in the Javadoc of the corresponding attribute. Due to the rules defined for +annotation attributes in the Java Language Specification, it is, unfortunately, not +possible to assign a value of `null` to an annotation attribute. Thus, in order to +support overrides of inherited global configuration, `@SqlConfig` attributes have an +explicit default value of either `""` (for Strings) or `DEFAULT` (for enumerations). This approach lets local declarations of `@SqlConfig` selectively override individual attributes from global declarations of `@SqlConfig` by providing a value other than `""` or `DEFAULT`. Global `@SqlConfig` attributes are inherited whenever local `@SqlConfig` @@ -4225,8 +4230,9 @@ configuration, therefore, overrides global configuration. The configuration options provided by `@Sql` and `@SqlConfig` are equivalent to those supported by `ScriptUtils` and `ResourceDatabasePopulator` but are a superset of those -provided by the `` XML namespace element. See the Javadoc -of individual attributes in {api-spring-framework}/test/context/jdbc/Sql.html[`@Sql`] and {api-spring-framework}/test/context/jdbc/SqlConfig.html[`@SqlConfig`] for details. +provided by the `` XML namespace element. See the Javadoc of +individual attributes in {api-spring-framework}/test/context/jdbc/Sql.html[`@Sql`] and +{api-spring-framework}/test/context/jdbc/SqlConfig.html[`@SqlConfig`] for details. @@ -4244,13 +4250,15 @@ however, a `javax.sql.DataSource` must be present in the test's `ApplicationCont If the algorithms used by `SqlScriptsTestExecutionListener` to detect a `DataSource` and `PlatformTransactionManager` and infer the transaction semantics do not suit your needs, -you can specify explicit names by setting the `dataSource` and `transactionManager` attributes -of `@SqlConfig`. Furthermore, you can control the transaction propagation behavior by setting -the `transactionMode` attribute of `@SqlConfig` (for example, whether scripts should be -run in an isolated transaction). Although a thorough discussion of all supported -options for transaction management with `@Sql` is beyond the scope of this reference -manual, the Javadoc for {api-spring-framework}/test/context/jdbc/SqlConfig.html[`@SqlConfig`] and {api-spring-framework}/test/context/jdbc/SqlScriptsTestExecutionListener.html[`SqlScriptsTestExecutionListener`] provide -detailed information, and the following example shows a typical testing scenario +you can specify explicit names by setting the `dataSource` and `transactionManager` +attributes of `@SqlConfig`. Furthermore, you can control the transaction propagation +behavior by setting the `transactionMode` attribute of `@SqlConfig` (for example, whether +scripts should be run in an isolated transaction). Although a thorough discussion of all +supported options for transaction management with `@Sql` is beyond the scope of this +reference manual, the Javadoc for +{api-spring-framework}/test/context/jdbc/SqlConfig.html[`@SqlConfig`] and +{api-spring-framework}/test/context/jdbc/SqlScriptsTestExecutionListener.html[`SqlScriptsTestExecutionListener`] +provide detailed information, and the following example shows a typical testing scenario that uses JUnit Jupiter and transactional tests with `@Sql`: ==== @@ -4288,11 +4296,11 @@ that uses JUnit Jupiter and transactional tests with `@Sql`: ---- ==== -Note that there is no need to -clean up the database after the `usersTest()` method is run, since any changes made -to the database (either within the test method or within the `/test-data.sql` script) -are automatically rolled back by the `TransactionalTestExecutionListener` (see -<> for details). +Note that there is no need to clean up the database after the `usersTest()` method is +run, since any changes made to the database (either within the test method or within the +`/test-data.sql` script) are automatically rolled back by the +`TransactionalTestExecutionListener` (see <> for +details). @@ -4308,8 +4316,8 @@ TIP: For details on how to set up parallel test execution, see the documentation testing framework, build tool, or IDE. Keep in mind that the introduction of concurrency into your test suite can result in -unexpected side effects, strange runtime behavior, and tests that fail intermittently -or seemingly randomly. The Spring Team therefore provides the following general guidelines +unexpected side effects, strange runtime behavior, and tests that fail intermittently or +seemingly randomly. The Spring Team therefore provides the following general guidelines for when not to execute tests in parallel. Do not execute tests in parallel if the tests: @@ -4328,19 +4336,19 @@ for the current test is no longer active, this typically means that the `ApplicationContext` was removed from the `ContextCache` in a different thread. This may be due to the use of `@DirtiesContext` or due to automatic eviction from the -`ContextCache`. If `@DirtiesContext` is the culprit, you either need to find a way -to avoid using `@DirtiesContext` or exclude such tests from parallel execution. If the +`ContextCache`. If `@DirtiesContext` is the culprit, you either need to find a way to +avoid using `@DirtiesContext` or exclude such tests from parallel execution. If the maximum size of the `ContextCache` has been exceeded, you can increase the maximum size of the cache. See the discussion on <> for details. ==== -WARNING: Parallel test execution in the Spring TestContext Framework is only possible if the -underlying `TestContext` implementation provides a copy constructor, as explained in the -{api-spring-framework}/test/context/TestContext.html[Javadoc for `TestContext`]. The `DefaultTestContext` used in Spring provides such a -constructor. However, if you use a third-party library that provides a custom -`TestContext` implementation, you need to verify that it is suitable for parallel test -execution. +WARNING: Parallel test execution in the Spring TestContext Framework is only possible if +the underlying `TestContext` implementation provides a copy constructor, as explained in +the {api-spring-framework}/test/context/TestContext.html[Javadoc for `TestContext`]. The +`DefaultTestContext` used in Spring provides such a constructor. However, if you use a +third-party library that provides a custom `TestContext` implementation, you need to +verify that it is suitable for parallel test execution. @@ -4354,19 +4362,19 @@ This section describes the various classes that support the Spring TestContext F [[testcontext-junit4-runner]] ===== Spring JUnit 4 Runner -The Spring TestContext Framework offers full integration with JUnit 4 through a -custom runner (supported on JUnit 4.12 or higher). By annotating test classes with +The Spring TestContext Framework offers full integration with JUnit 4 through a custom +runner (supported on JUnit 4.12 or higher). By annotating test classes with `@RunWith(SpringJUnit4ClassRunner.class)` or the shorter `@RunWith(SpringRunner.class)` variant, developers can implement standard JUnit 4-based unit and integration tests and -simultaneously reap the benefits of the TestContext framework, such as support for loading -application contexts, dependency injection of test instances, transactional test method -execution, and so on. If you want to use the Spring TestContext Framework with an -alternative runner (such as JUnit 4's `Parameterized` runner) or third-party runners (such as the -`MockitoJUnitRunner`), you can, optionally, use <> instead. +simultaneously reap the benefits of the TestContext framework, such as support for +loading application contexts, dependency injection of test instances, transactional test +method execution, and so on. If you want to use the Spring TestContext Framework with an +alternative runner (such as JUnit 4's `Parameterized` runner) or third-party runners +(such as the `MockitoJUnitRunner`), you can, optionally, use +<> instead. -The following code listing shows the minimal requirements for configuring a test class -to run with the custom Spring `Runner`: +The following code listing shows the minimal requirements for configuring a test class to +run with the custom Spring `Runner`: ==== [source,java,indent=0] @@ -4384,9 +4392,9 @@ to run with the custom Spring `Runner`: ---- ==== -In the preceding example, `@TestExecutionListeners` is configured with an -empty list, to disable the default listeners, which otherwise would require an -`ApplicationContext` to be configured through `@ContextConfiguration`. +In the preceding example, `@TestExecutionListeners` is configured with an empty list, to +disable the default listeners, which otherwise would require an `ApplicationContext` to +be configured through `@ContextConfiguration`. @@ -4399,18 +4407,18 @@ The `org.springframework.test.context.junit4.rules` package provides the followi * `SpringClassRule` * `SpringMethodRule` -`SpringClassRule` is a JUnit `TestRule` that supports class-level features of the -Spring TestContext Framework, whereas `SpringMethodRule` is a JUnit `MethodRule` that -supports instance-level and method-level features of the Spring TestContext Framework. +`SpringClassRule` is a JUnit `TestRule` that supports class-level features of the Spring +TestContext Framework, whereas `SpringMethodRule` is a JUnit `MethodRule` that supports +instance-level and method-level features of the Spring TestContext Framework. -In contrast to the `SpringRunner`, Spring's rule-based JUnit support has the advantage -of being independent of any `org.junit.runner.Runner` implementation and can, therefore, -be combined with existing alternative runners (such as JUnit 4's `Parameterized`) or third-party -runners (such as the `MockitoJUnitRunner`). +In contrast to the `SpringRunner`, Spring's rule-based JUnit support has the advantage of +being independent of any `org.junit.runner.Runner` implementation and can, therefore, be +combined with existing alternative runners (such as JUnit 4's `Parameterized`) or +third-party runners (such as the `MockitoJUnitRunner`). To support the full functionality of the TestContext framework, you must combine a -`SpringClassRule` with a `SpringMethodRule`. The following example -shows the proper way to declare these rules in an integration test: +`SpringClassRule` with a `SpringMethodRule`. The following example shows the proper way +to declare these rules in an integration test: ==== [source,java,indent=0] @@ -4444,30 +4452,30 @@ classes for JUnit 4-based test cases (supported on JUnit 4.12 or higher): * `AbstractTransactionalJUnit4SpringContextTests` `AbstractJUnit4SpringContextTests` is an abstract base test class that integrates the -Spring TestContext Framework with explicit `ApplicationContext` testing support in -a JUnit 4 environment. When you extend `AbstractJUnit4SpringContextTests`, you can -access a `protected` `applicationContext` instance variable that you can use to perform -explicit bean lookups or to test the state of the context as a whole. - -`AbstractTransactionalJUnit4SpringContextTests` is an abstract transactional extension -of `AbstractJUnit4SpringContextTests` that adds some convenience functionality for JDBC -access. This class expects a `javax.sql.DataSource` bean and a `PlatformTransactionManager` -bean to be defined in the `ApplicationContext`. When you extend -`AbstractTransactionalJUnit4SpringContextTests`, you can access a `protected` `jdbcTemplate` -instance variable that you can use to run SQL statements to query the database. You can use such -queries to confirm database state both before and after running -database-related application code, and Spring ensures that such queries run in the scope of -the same transaction as the application code. When used in conjunction with an ORM tool, -be sure to avoid <>. As mentioned in -<>, `AbstractTransactionalJUnit4SpringContextTests` -also provides convenience methods that delegate to methods in `JdbcTestUtils` by using the -aforementioned `jdbcTemplate`. Furthermore, `AbstractTransactionalJUnit4SpringContextTests` -provides an `executeSqlScript(..)` method for running SQL scripts against the configured -`DataSource`. - -TIP: These classes are a convenience for extension. If you do not want your test classes to be -tied to a Spring-specific class hierarchy, you can configure your own custom test classes -by using `@RunWith(SpringRunner.class)` or <>. As +mentioned in <>, +`AbstractTransactionalJUnit4SpringContextTests` also provides convenience methods that +delegate to methods in `JdbcTestUtils` by using the aforementioned `jdbcTemplate`. +Furthermore, `AbstractTransactionalJUnit4SpringContextTests` provides an +`executeSqlScript(..)` method for running SQL scripts against the configured `DataSource`. + +TIP: These classes are a convenience for extension. If you do not want your test classes +to be tied to a Spring-specific class hierarchy, you can configure your own custom test +classes by using `@RunWith(SpringRunner.class)` or <>. @@ -4475,28 +4483,26 @@ JUnit rules>>. [[testcontext-junit-jupiter-extension]] ===== SpringExtension for JUnit Jupiter -The Spring TestContext Framework offers full integration with the JUnit Jupiter -testing framework, introduced in JUnit 5. By annotating test classes with -`@ExtendWith(SpringExtension.class)`, you can implement standard JUnit Jupiter-based -unit and integration tests and simultaneously reap the benefits of the TestContext -framework, such as support for loading application contexts, dependency injection of test -instances, transactional test method execution, and so on. +The Spring TestContext Framework offers full integration with the JUnit Jupiter testing +framework, introduced in JUnit 5. By annotating test classes with +`@ExtendWith(SpringExtension.class)`, you can implement standard JUnit Jupiter-based unit +and integration tests and simultaneously reap the benefits of the TestContext framework, +such as support for loading application contexts, dependency injection of test instances, +transactional test method execution, and so on. -Furthermore, thanks to the rich extension API in JUnit Jupiter, Spring can provide -the following features above and beyond the feature set that Spring supports for JUnit 4 -and TestNG: +Furthermore, thanks to the rich extension API in JUnit Jupiter, Spring can provide the +following features above and beyond the feature set that Spring supports for JUnit 4 and +TestNG: * Dependency injection for test constructors, test methods, and test lifecycle callback - methods. - See <> for further details. -* Powerful support for link:http://junit.org/junit5/docs/current/user-guide/#extensions-conditions[conditional test execution] - based on SpEL expressions, environment variables, system properties, and so on. - See the documentation for `@EnabledIf` and `@DisabledIf` in - <> for further details and examples. -* Custom composed annotations that combine annotations from Spring and JUnit - Jupiter. - See the `@TransactionalDevTestConfig` and `@TransactionalIntegrationTest` examples in - <> for further details. + methods. See <> for further details. +* Powerful support for link:http://junit.org/junit5/docs/current/user-guide/#extensions-conditions[conditional + test execution] based on SpEL expressions, environment variables, system properties, + and so on. See the documentation for `@EnabledIf` and `@DisabledIf` in + <> for further details and examples. +* Custom composed annotations that combine annotations from Spring and JUnit Jupiter. See + the `@TransactionalDevTestConfig` and `@TransactionalIntegrationTest` examples in + <> for further details. The following code listing shows how to configure a test class to use the `SpringExtension` in conjunction with `@ContextConfiguration`: @@ -4519,12 +4525,12 @@ The following code listing shows how to configure a test class to use the ---- ==== -Since you can also use annotations in JUnit 5 as meta-annotations, Spring can -provide the `@SpringJUnitConfig` and `@SpringJUnitWebConfig` composed annotations to -simplify the configuration of the test `ApplicationContext` and JUnit Jupiter. +Since you can also use annotations in JUnit 5 as meta-annotations, Spring can provide the +`@SpringJUnitConfig` and `@SpringJUnitWebConfig` composed annotations to simplify the +configuration of the test `ApplicationContext` and JUnit Jupiter. -The following example uses `@SpringJUnitConfig` to reduce the amount of -configuration used in the previous example: +The following example uses `@SpringJUnitConfig` to reduce the amount of configuration +used in the previous example: ==== [source,java,indent=0] @@ -4573,13 +4579,13 @@ See the documentation for `@SpringJUnitConfig` and `@SpringJUnitWebConfig` in `SpringExtension` implements the link:http://junit.org/junit5/docs/current/user-guide/#extensions-parameter-resolution[`ParameterResolver`] -extension API from JUnit Jupiter, which lets Spring provide dependency injection for -test constructors, test methods, and test lifecycle callback methods. +extension API from JUnit Jupiter, which lets Spring provide dependency injection for test +constructors, test methods, and test lifecycle callback methods. Specifically, `SpringExtension` can inject dependencies from the test's -`ApplicationContext` into test constructors and methods that are annotated with `@BeforeAll`, -`@AfterAll`, `@BeforeEach`, `@AfterEach`, `@Test`, `@RepeatedTest`, `@ParameterizedTest`, -and others. +`ApplicationContext` into test constructors and methods that are annotated with +`@BeforeAll`, `@AfterAll`, `@BeforeEach`, `@AfterEach`, `@Test`, `@RepeatedTest`, +`@ParameterizedTest`, and others. @@ -4589,14 +4595,14 @@ and others. If a parameter in a constructor for a JUnit Jupiter test class is of type `ApplicationContext` (or a sub-type thereof) or is annotated or meta-annotated with `@Autowired`, `@Qualifier`, or `@Value`, Spring injects the value for that specific -parameter with the corresponding bean from the test's `ApplicationContext`. You can also directly annotate a test -constructor with `@Autowired` if all of the parameters -should be supplied by Spring. +parameter with the corresponding bean from the test's `ApplicationContext`. You can also +directly annotate a test constructor with `@Autowired` if all of the parameters should be +supplied by Spring. -WARNING: If the constructor for a test class is itself annotated with `@Autowired`, Spring -assumes the responsibility for resolving _all_ parameters in the constructor. -Consequently, no other `ParameterResolver` registered with JUnit Jupiter can -resolve parameters for such a constructor. +WARNING: If the constructor for a test class is itself annotated with `@Autowired`, +Spring assumes the responsibility for resolving _all_ parameters in the constructor. +Consequently, no other `ParameterResolver` registered with JUnit Jupiter can resolve +parameters for such a constructor. In the following example, Spring injects the `OrderService` bean from the `ApplicationContext` loaded from `TestConfig.class` into the @@ -4621,9 +4627,7 @@ In the following example, Spring injects the `OrderService` bean from the ---- ==== -Note that this feature lets test -dependencies be `final` and therefore immutable. - +Note that this feature lets test dependencies be `final` and therefore immutable. [[testcontext-junit-jupiter-di-method]] @@ -4634,8 +4638,8 @@ type `ApplicationContext` (or a sub-type thereof) or is annotated or meta-annota `@Autowired`, `@Qualifier`, or `@Value`, Spring injects the value for that specific parameter with the corresponding bean from the test's `ApplicationContext`. -In the following example, Spring injects the `OrderService` from the -`ApplicationContext` loaded from `TestConfig.class` into the `deleteOrder()` test method: +In the following example, Spring injects the `OrderService` from the `ApplicationContext` +loaded from `TestConfig.class` into the `deleteOrder()` test method: ==== [source,java,indent=0] @@ -4653,11 +4657,11 @@ In the following example, Spring injects the `OrderService` from the ==== Due to the robustness of the `ParameterResolver` support in JUnit Jupiter, you can also -have multiple dependencies injected into a single method, not only from Spring -but also from JUnit Jupiter itself or other third-party extensions. +have multiple dependencies injected into a single method, not only from Spring but also +from JUnit Jupiter itself or other third-party extensions. -The following example shows how to have both Spring and JUnit Jupiter inject -dependencies into the `placeOrderRepeatedly()` test method simultaneously. +The following example shows how to have both Spring and JUnit Jupiter inject dependencies +into the `placeOrderRepeatedly()` test method simultaneously. ==== [source,java,indent=0] @@ -4677,10 +4681,8 @@ dependencies into the `placeOrderRepeatedly()` test method simultaneously. ---- ==== -Note that the -use of `@RepeatedTest` from JUnit Jupiter lets the test method gain access to the -`RepetitionInfo`. - +Note that the use of `@RepeatedTest` from JUnit Jupiter lets the test method gain access +to the `RepetitionInfo`. [[testcontext-support-classes-testng]] @@ -4693,54 +4695,53 @@ classes for TestNG based test cases: * `AbstractTransactionalTestNGSpringContextTests` `AbstractTestNGSpringContextTests` is an abstract base test class that integrates the -Spring TestContext Framework with explicit `ApplicationContext` testing support in -a TestNG environment. When you extend `AbstractTestNGSpringContextTests`, you can -access a `protected` `applicationContext` instance variable that you can use to perform -explicit bean lookups or to test the state of the context as a whole. - -`AbstractTransactionalTestNGSpringContextTests` is an abstract transactional extension -of `AbstractTestNGSpringContextTests` that adds some convenience functionality for JDBC -access. This class expects a `javax.sql.DataSource` bean and a `PlatformTransactionManager` -bean to be defined in the `ApplicationContext`. When you extend -`AbstractTransactionalTestNGSpringContextTests`, you can access a `protected` `jdbcTemplate` -instance variable that you can use to execute SQL statements to query the database. You can use such -queries to confirm database state both before and after running -database-related application code, and Spring ensures that such queries run in the scope of -the same transaction as the application code. When used in conjunction with an ORM tool, -be sure to avoid <>. As mentioned in -<>, `AbstractTransactionalTestNGSpringContextTests` -also provides convenience methods that delegate to methods in `JdbcTestUtils` by using the -aforementioned `jdbcTemplate`. Furthermore, `AbstractTransactionalTestNGSpringContextTests` -provides an `executeSqlScript(..)` method for running SQL scripts against the configured -`DataSource`. - - -TIP: These classes are a convenience for extension. If you do not want your test classes to be -tied to a Spring-specific class hierarchy, you can configure your own custom test classes -by using `@ContextConfiguration`, `@TestExecutionListeners`, and so on and by manually -instrumenting your test class with a `TestContextManager`. See the source code of -`AbstractTestNGSpringContextTests` for an example of how to instrument your test class. +Spring TestContext Framework with explicit `ApplicationContext` testing support in a +TestNG environment. When you extend `AbstractTestNGSpringContextTests`, you can access a +`protected` `applicationContext` instance variable that you can use to perform explicit +bean lookups or to test the state of the context as a whole. + +`AbstractTransactionalTestNGSpringContextTests` is an abstract transactional extension of +`AbstractTestNGSpringContextTests` that adds some convenience functionality for JDBC +access. This class expects a `javax.sql.DataSource` bean and a +`PlatformTransactionManager` bean to be defined in the `ApplicationContext`. When you +extend `AbstractTransactionalTestNGSpringContextTests`, you can access a `protected` +`jdbcTemplate` instance variable that you can use to execute SQL statements to query the +database. You can use such queries to confirm database state both before and after +running database-related application code, and Spring ensures that such queries run in +the scope of the same transaction as the application code. When used in conjunction with +an ORM tool, be sure to avoid <>. As +mentioned in <>, +`AbstractTransactionalTestNGSpringContextTests` also provides convenience methods that +delegate to methods in `JdbcTestUtils` by using the aforementioned `jdbcTemplate`. +Furthermore, `AbstractTransactionalTestNGSpringContextTests` provides an +`executeSqlScript(..)` method for running SQL scripts against the configured `DataSource`. + +TIP: These classes are a convenience for extension. If you do not want your test classes +to be tied to a Spring-specific class hierarchy, you can configure your own custom test +classes by using `@ContextConfiguration`, `@TestExecutionListeners`, and so on and by +manually instrumenting your test class with a `TestContextManager`. See the source code +of `AbstractTestNGSpringContextTests` for an example of how to instrument your test class. [[spring-mvc-test-framework]] === Spring MVC Test Framework -The Spring MVC Test framework provides first class support for testing Spring MVC -code with a fluent API that you can use with JUnit, TestNG, or any other testing -framework. It is built on the -{api-spring-framework}/mock/web/package-summary.html[Servlet API mock objects] +The Spring MVC Test framework provides first class support for testing Spring MVC code +with a fluent API that you can use with JUnit, TestNG, or any other testing framework. It +is built on the {api-spring-framework}/mock/web/package-summary.html[Servlet API mock objects] from the `spring-test` module and, hence, does not use a running Servlet container. It -uses the `DispatcherServlet` to provide full Spring MVC runtime behavior and provides support -for loading actual Spring configuration with the TestContext framework in addition to a -standalone mode, in which you can manually instantiate controllers and test them one at a time. +uses the `DispatcherServlet` to provide full Spring MVC runtime behavior and provides +support for loading actual Spring configuration with the TestContext framework in +addition to a standalone mode, in which you can manually instantiate controllers and test +them one at a time. -Spring MVC Test also provides client-side support for testing code that uses -the `RestTemplate`. Client-side tests mock the server responses and also do not -use a running server. +Spring MVC Test also provides client-side support for testing code that uses the +`RestTemplate`. Client-side tests mock the server responses and also do not use a running +server. -TIP: Spring Boot provides an option to write full, end-to-end integration tests that include -a running server. If this is your goal, see the +TIP: Spring Boot provides an option to write full, end-to-end integration tests that +include a running server. If this is your goal, see the {doc-spring-boot}/html/boot-features-testing.html#boot-features-testing-spring-boot-applications[Spring Boot reference page]. For more information on the differences between out-of-container and end-to-end integration tests, see <>. @@ -4750,23 +4751,23 @@ integration tests, see <>. [[spring-mvc-test-server]] ==== Server-Side Tests -You can write a plain unit test for a Spring MVC controller by using JUnit or TestNG. -To do so, instantiate the controller, inject it with mocked or stubbed dependencies, and call -its methods (passing `MockHttpServletRequest`, `MockHttpServletResponse`, and others, as necessary). -However, when writing such a unit test, much remains untested: for example, request -mappings, data binding, type conversion, validation, and much more. Furthermore, other -controller methods such as `@InitBinder`, `@ModelAttribute`, and `@ExceptionHandler` may -also be invoked as part of the request processing lifecycle. +You can write a plain unit test for a Spring MVC controller by using JUnit or TestNG. To +do so, instantiate the controller, inject it with mocked or stubbed dependencies, and +call its methods (passing `MockHttpServletRequest`, `MockHttpServletResponse`, and +others, as necessary). However, when writing such a unit test, much remains untested: for +example, request mappings, data binding, type conversion, validation, and much more. +Furthermore, other controller methods such as `@InitBinder`, `@ModelAttribute`, and +`@ExceptionHandler` may also be invoked as part of the request processing lifecycle. -The goal of Spring MVC Test is to provide an effective way to test controllers -by performing requests and generating responses through the actual `DispatcherServlet`. +The goal of Spring MVC Test is to provide an effective way to test controllers by +performing requests and generating responses through the actual `DispatcherServlet`. -Spring MVC Test builds on the familiar <> available in the `spring-test` module. This allows performing -requests and generating responses without the need for running in a Servlet container. -For the most part, everything should work as it does at runtime with a few notable -exceptions, as explained in <>. The following -JUnit Jupiter-based example uses Spring MVC Test: +Spring MVC Test builds on the familiar <> available in the `spring-test` module. This allows performing requests +and generating responses without the need for running in a Servlet container. For the +most part, everything should work as it does at runtime with a few notable exceptions, as +explained in <>. The following JUnit +Jupiter-based example uses Spring MVC Test: ==== [source,java,indent=0] @@ -4796,42 +4797,43 @@ JUnit Jupiter-based example uses Spring MVC Test: ---- ==== -The preceding test relies on the `WebApplicationContext` support of the TestContext framework -to load Spring configuration from an XML configuration file located in the same package -as the test class, but Java-based and Groovy-based configuration are also supported. See these +The preceding test relies on the `WebApplicationContext` support of the TestContext +framework to load Spring configuration from an XML configuration file located in the same +package as the test class, but Java-based and Groovy-based configuration are also +supported. See these https://github.com/spring-projects/spring-framework/tree/master/spring-test/src/test/java/org/springframework/test/web/servlet/samples/context[sample tests]. The `MockMvc` instance is used to perform a `GET` request to `/accounts/1` and verify -that the resulting response has status 200, the content type is `application/json`, and the -response body has a JSON property called `name` with the value `Lee`. The `jsonPath` +that the resulting response has status 200, the content type is `application/json`, and +the response body has a JSON property called `name` with the value `Lee`. The `jsonPath` syntax is supported through the Jayway https://github.com/jayway/JsonPath[JsonPath -project]. Many other options for verifying the result of the performed -request are discussed later in this document. +project]. Many other options for verifying the result of the performed request are +discussed later in this document. [[spring-mvc-test-server-static-imports]] ===== Static Imports -The fluent API in the example from the <> requires a few static imports, such as -`MockMvcRequestBuilders.{asterisk}`, `MockMvcResultMatchers.{asterisk}`, -and `MockMvcBuilders.{asterisk}`. An easy way to find these classes is to search for -types that match `MockMvc*`. If you use Eclipse or the Eclipse-based Spring Tool Suite, be sure to add them as -"`favorite static members`" in the Eclipse preferences under -Java -> Editor -> Content Assist -> Favorites. Doing so lets you use content -assist after typing the first character of the static method name. Other IDEs (such as -IntelliJ) may not require any additional configuration. Check the support for code -completion on static members. +The fluent API in the example from the <> +requires a few static imports, such as `MockMvcRequestBuilders.{asterisk}`, +`MockMvcResultMatchers.{asterisk}`, and `MockMvcBuilders.{asterisk}`. An easy way to find +these classes is to search for types that match `MockMvc*`. If you use Eclipse or the +Eclipse-based Spring Tool Suite, be sure to add them as "`favorite static members`" in +the Eclipse preferences under Java -> Editor -> Content Assist -> Favorites. Doing so +lets you use content assist after typing the first character of the static method name. +Other IDEs (such as IntelliJ) may not require any additional configuration. Check the +support for code completion on static members. [[spring-mvc-test-server-setup-options]] ===== Setup Choices -You have two main options for creating an instance of `MockMvc`. -The first is to load Spring MVC configuration through the TestContext -framework, which loads the Spring configuration and injects a `WebApplicationContext` -into the test to use to build a `MockMvc` instance. The following example shows how to do so: +You have two main options for creating an instance of `MockMvc`. The first is to load +Spring MVC configuration through the TestContext framework, which loads the Spring +configuration and injects a `WebApplicationContext` into the test to use to build a +`MockMvc` instance. The following example shows how to do so: ==== [source,java,indent=0] @@ -4859,9 +4861,9 @@ into the test to use to build a `MockMvc` instance. The following example shows ==== Your second option is to manually create a controller instance without loading Spring -configuration. Instead, basic default configuration, roughly comparable to that of -the MVC JavaConfig or the MVC namespace, is automatically created. You can customize it -to a degree. The following example shows how to do so: +configuration. Instead, basic default configuration, roughly comparable to that of the +MVC JavaConfig or the MVC namespace, is automatically created. You can customize it to a +degree. The following example shows how to do so: ==== [source,java,indent=0] @@ -4884,12 +4886,12 @@ to a degree. The following example shows how to do so: Which setup option should you use? -The `webAppContextSetup` loads your actual Spring MVC configuration, resulting in a -more complete integration test. Since the TestContext framework caches the loaded -Spring configuration, it helps keep tests running fast, even as you introduce more tests -in your test suite. Furthermore, you can inject mock services into controllers through -Spring configuration to remain focused on testing the web layer. The following -example declares a mock service with Mockito: +The `webAppContextSetup` loads your actual Spring MVC configuration, resulting in a more +complete integration test. Since the TestContext framework caches the loaded Spring +configuration, it helps keep tests running fast, even as you introduce more tests in your +test suite. Furthermore, you can inject mock services into controllers through Spring +configuration to remain focused on testing the web layer. The following example declares +a mock service with Mockito: ==== [source,xml,indent=0] @@ -4927,9 +4929,9 @@ expectations, as the following example shows: ---- ==== -The `standaloneSetup`, on the other hand, is a little closer to a unit test. It tests -one controller at a time. You can manually inject the controller with mock dependencies, -and it does not involve loading Spring configuration. Such tests are more focused on style +The `standaloneSetup`, on the other hand, is a little closer to a unit test. It tests one +controller at a time. You can manually inject the controller with mock dependencies, and +it does not involve loading Spring configuration. Such tests are more focused on style and make it easier to see which controller is being tested, whether any specific Spring MVC configuration is required to work, and so on. The `standaloneSetup` is also a very convenient way to write ad-hoc tests to verify specific behavior or to debug an issue. @@ -4937,8 +4939,8 @@ convenient way to write ad-hoc tests to verify specific behavior or to debug an As with most "`integration versus unit testing`" debates, there is no right or wrong answer. However, using the `standaloneSetup` does imply the need for additional `webAppContextSetup` tests in order to verify your Spring MVC configuration. -Alternatively, you can write all your tests with `webAppContextSetup`, in order to -always test against your actual Spring MVC configuration. +Alternatively, you can write all your tests with `webAppContextSetup`, in order to always +test against your actual Spring MVC configuration. @@ -4946,9 +4948,9 @@ always test against your actual Spring MVC configuration. ===== Setup Features No matter which MockMvc builder you use, all `MockMvcBuilder` implementations provide -some common and very useful features. For example, you can declare an `Accept` header -for all requests and expect a status of 200 as well as a `Content-Type` header -in all responses, as follows: +some common and very useful features. For example, you can declare an `Accept` header for +all requests and expect a status of 200 as well as a `Content-Type` header in all +responses, as follows: ==== [source,java,indent=0] @@ -4965,9 +4967,9 @@ MockMvc mockMvc = standaloneSetup(new MusicController()) ==== In addition, third-party frameworks (and applications) can pre-package setup -instructions, such as those in a `MockMvcConfigurer`. The Spring Framework -has one such built-in implementation that helps to save and re-use the HTTP -session across requests. You can use it as follows: +instructions, such as those in a `MockMvcConfigurer`. The Spring Framework has one such +built-in implementation that helps to save and re-use the HTTP session across requests. +You can use it as follows: ==== [source,java,indent=0] @@ -4983,8 +4985,9 @@ session across requests. You can use it as follows: ---- ==== -See the {api-spring-framework}/test/web/servlet/setup/ConfigurableMockMvcBuilder.html[Javadoc for `ConfigurableMockMvcBuilder`] for a list of all MockMvc builder features -or use the IDE to explore the available options. +See the {api-spring-framework}/test/web/servlet/setup/ConfigurableMockMvcBuilder.html[Javadoc +for `ConfigurableMockMvcBuilder`] for a list of all MockMvc builder features or use the +IDE to explore the available options. @@ -5023,8 +5026,8 @@ You can specify query parameters in URI template style, as the following example ---- ==== -You can also add Servlet request parameters that represent either query or form parameters, -as the following example shows: +You can also add Servlet request parameters that represent either query or form +parameters, as the following example shows: ==== [source,java,indent=0] @@ -5036,12 +5039,14 @@ as the following example shows: If application code relies on Servlet request parameters and does not check the query string explicitly (as is most often the case), it does not matter which option you use. -Keep in mind, however, that query paramaters provided with the URI template are decoded while -request parameters provided through the `param(...)` method are expected to already be decoded. +Keep in mind, however, that query parameters provided with the URI template are decoded +while request parameters provided through the `param(...)` method are expected to already +be decoded. -In most cases, it is preferable to leave the context path and the Servlet path out of -the request URI. If you must test with the full request URI, be sure to set the -`contextPath` and `servletPath` accordingly so that request mappings work, as the following example shows: +In most cases, it is preferable to leave the context path and the Servlet path out of the +request URI. If you must test with the full request URI, be sure to set the `contextPath` +and `servletPath` accordingly so that request mappings work, as the following example +shows: ==== [source,java,indent=0] @@ -5074,9 +5079,9 @@ properties, as the following example shows: ==== The preceding properties affect every request performed through the `MockMvc` instance. -If the same property is also specified on a given request, it overrides the default value. -That is why the HTTP method and URI in the default request do not matter, since they must be -specified on every request. +If the same property is also specified on a given request, it overrides the default +value. That is why the HTTP method and URI in the default request do not matter, since +they must be specified on every request. @@ -5098,14 +5103,14 @@ performing a request, as the following example shows: nested with more detailed expectations. Expectations fall in two general categories. The first category of assertions verifies -properties of the response (for example, the response status, headers, and content). These -are the most important results to assert. +properties of the response (for example, the response status, headers, and content). +These are the most important results to assert. -The second category of assertions goes beyond the response. These assertions let -you inspect Spring MVC specific aspects, such as which controller method processed -the request, whether an exception was raised and handled, what the content of the model -is, what view was selected, what flash attributes were added, and so on. They also let -you inspect Servlet specific aspects, such as request and session attributes. +The second category of assertions goes beyond the response. These assertions let you +inspect Spring MVC specific aspects, such as which controller method processed the +request, whether an exception was raised and handled, what the content of the model is, +what view was selected, what flash attributes were added, and so on. They also let you +inspect Servlet specific aspects, such as request and session attributes. The following test asserts that binding or validation failed: @@ -5119,8 +5124,8 @@ The following test asserts that binding or validation failed: ---- ==== -Many times, when writing tests, it is useful to dump the results of the performed request. -You can do so as follows, where `print()` is a static import from +Many times, when writing tests, it is useful to dump the results of the performed +request. You can do so as follows, where `print()` is a static import from `MockMvcResultHandlers`: ==== @@ -5135,14 +5140,13 @@ You can do so as follows, where `print()` is a static import from ==== As long as request processing does not cause an unhandled exception, the `print()` method -prints all the available result data to `System.out`. Spring Framework 4.2 introduced -a `log()` method and two additional variants of the `print()` method, one that accepts -an `OutputStream` and one that accepts a `Writer`. For example, invoking -`print(System.err)` prints the result data to `System.err`, while invoking -`print(myWriter)` prints the result data to a custom writer. If you want to -have the result data logged instead of printed, you can invoke the `log()` method, which -logs the result data as a single `DEBUG` message under the -`org.springframework.test.web.servlet.result` logging category. +prints all the available result data to `System.out`. Spring Framework 4.2 introduced a +`log()` method and two additional variants of the `print()` method, one that accepts an +`OutputStream` and one that accepts a `Writer`. For example, invoking `print(System.err)` +prints the result data to `System.err`, while invoking `print(myWriter)` prints the +result data to a custom writer. If you want to have the result data logged instead of +printed, you can invoke the `log()` method, which logs the result data as a single +`DEBUG` message under the `org.springframework.test.web.servlet.result` logging category. In some cases, you may want to get direct access to the result and verify something that cannot be verified otherwise. This can be achieved by appending `.andReturn()` after all @@ -5157,8 +5161,8 @@ other expectations, as the following example shows: ---- ==== -If all tests repeat the same expectations, you can set up common expectations once -when building the `MockMvc` instance, as the following example shows: +If all tests repeat the same expectations, you can set up common expectations once when +building the `MockMvc` instance, as the following example shows: ==== [source,java,indent=0] @@ -5175,8 +5179,8 @@ Note that common expectations are always applied and cannot be overridden withou creating a separate `MockMvc` instance. When a JSON response content contains hypermedia links created with -https://github.com/spring-projects/spring-hateoas[Spring HATEOAS], you can verify the resulting links -by using JsonPath expressions, as the following example shows: +https://github.com/spring-projects/spring-hateoas[Spring HATEOAS], you can verify the +resulting links by using JsonPath expressions, as the following example shows: ==== [source,java,indent=0] @@ -5188,8 +5192,8 @@ by using JsonPath expressions, as the following example shows: ==== When XML response content contains hypermedia links created with -https://github.com/spring-projects/spring-hateoas[Spring HATEOAS], you can verify the resulting links -by using XPath expressions: +https://github.com/spring-projects/spring-hateoas[Spring HATEOAS], you can verify the +resulting links by using XPath expressions: ==== [source,java,indent=0] @@ -5206,8 +5210,8 @@ by using XPath expressions: [[spring-mvc-test-server-filters]] ===== Filter Registrations -When setting up a `MockMvc` instance, you can register one or more Servlet `Filter` instances, -as the following example shows: +When setting up a `MockMvc` instance, you can register one or more Servlet `Filter` +instances, as the following example shows: ==== [source,java,indent=0] @@ -5225,49 +5229,48 @@ last filter delegates to the `DispatcherServlet`. [[spring-mvc-test-vs-end-to-end-integration-tests]] ===== Differences Between Out-of-Container and End-to-End Integration Tests -As mentioned earlier Spring MVC Test is built on the Servlet API mock objects from -the `spring-test` module and does not use a running Servlet container. Therefore, -there are some important differences compared to full end-to-end integration tests -with an actual client and server running. +As mentioned earlier Spring MVC Test is built on the Servlet API mock objects from the +`spring-test` module and does not use a running Servlet container. Therefore, there are +some important differences compared to full end-to-end integration tests with an actual +client and server running. The easiest way to think about this is by starting with a blank `MockHttpServletRequest`. Whatever you add to it is what the request becomes. Things that may catch you by surprise -are that there is no context path by default; no `jsessionid` cookie; no forwarding, error, -or async dispatches; and, therefore, no actual JSP rendering. Instead, "`forwarded`" and -"`redirected`" URLs are saved in the `MockHttpServletResponse` and can be asserted with -expectations. +are that there is no context path by default; no `jsessionid` cookie; no forwarding, +error, or async dispatches; and, therefore, no actual JSP rendering. Instead, +"`forwarded`" and "`redirected`" URLs are saved in the `MockHttpServletResponse` and can +be asserted with expectations. This means that, if you use JSPs, you can verify the JSP page to which the request was -forwarded, but no HTML is rendered. In other words, the JSP is not -invoked. Note, however, that all other rendering technologies that do not rely on -forwarding, such as Thymeleaf and Freemarker, render HTML to the response body as -expected. The same is true for rendering JSON, XML, and other formats through `@ResponseBody` -methods. +forwarded, but no HTML is rendered. In other words, the JSP is not invoked. Note, +however, that all other rendering technologies that do not rely on forwarding, such as +Thymeleaf and Freemarker, render HTML to the response body as expected. The same is true +for rendering JSON, XML, and other formats through `@ResponseBody` methods. Alternatively, you may consider the full end-to-end integration testing support from Spring Boot with `@WebIntegrationTest`. See the {doc-spring-boot}/html/boot-features-testing.html#boot-features-testing-spring-boot-applications[Spring Boot Reference Guide]. -There are pros and cons for each approach. The options provided in Spring MVC Test -are different stops on the scale from classic unit testing to full integration testing. -To be certain, none of the options in Spring MVC Test fall under the category of classic -unit testing, but they are a little closer to it. For example, you can isolate the web -layer by injecting mocked services into controllers, in which case you are testing the web -layer only through the `DispatcherServlet` but with actual Spring configuration, as -you might test the data access layer in isolation from the layers above it. Also, you -can use the stand-alone setup, focusing on one controller at a time and manually providing -the configuration required to make it work. +There are pros and cons for each approach. The options provided in Spring MVC Test are +different stops on the scale from classic unit testing to full integration testing. To be +certain, none of the options in Spring MVC Test fall under the category of classic unit +testing, but they are a little closer to it. For example, you can isolate the web layer +by injecting mocked services into controllers, in which case you are testing the web +layer only through the `DispatcherServlet` but with actual Spring configuration, as you +might test the data access layer in isolation from the layers above it. Also, you can use +the stand-alone setup, focusing on one controller at a time and manually providing the +configuration required to make it work. Another important distinction when using Spring MVC Test is that, conceptually, such -tests are the server-side, so you can check what handler was used, -if an exception was handled with a HandlerExceptionResolver, what the content of the -model is, what binding errors there were, and other details. That means that it is easier to write -expectations, since the server is not a black box, as it is when testing it through -an actual HTTP client. This is generally an advantage of classic unit testing: It is -easier to write, reason about, and debug but does not replace the need for full -integration tests. At the same time, it is important not to lose sight of the fact that -the response is the most important thing to check. In short, there is room here for -multiple styles and strategies of testing even within the same project. +tests are the server-side, so you can check what handler was used, if an exception was +handled with a HandlerExceptionResolver, what the content of the model is, what binding +errors there were, and other details. That means that it is easier to write expectations, +since the server is not a black box, as it is when testing it through an actual HTTP +client. This is generally an advantage of classic unit testing: It is easier to write, +reason about, and debug but does not replace the need for full integration tests. At the +same time, it is important not to lose sight of the fact that the response is the most +important thing to check. In short, there is room here for multiple styles and strategies +of testing even within the same project. @@ -5278,8 +5281,8 @@ The framework's own tests include https://github.com/spring-projects/spring-framework/tree/master/spring-test/src/test/java/org/springframework/test/web/servlet/samples[many sample tests] intended to show how to use Spring MVC Test. You can browse these examples for further ideas. Also, the -https://github.com/spring-projects/spring-mvc-showcase[`spring-mvc-showcase`] project has full test -coverage based on Spring MVC Test. +https://github.com/spring-projects/spring-mvc-showcase[`spring-mvc-showcase`] project has +full test coverage based on Spring MVC Test. [[spring-mvc-test-server-htmlunit]] @@ -5289,27 +5292,28 @@ Spring provides integration between <> and http://htmlunit.sourceforge.net/[HtmlUnit]. This simplifies performing end-to-end testing when using HTML-based views. This integration lets you: -* Easily test HTML pages by using tools such as http://htmlunit.sourceforge.net/[HtmlUnit], -http://seleniumhq.org/projects/webdriver/[WebDriver], and -http://www.gebish.org/manual/current/testing.html#spock_junit__testng[Geb] without the -need to deploy to a Servlet container. +* Easily test HTML pages by using tools such as + http://htmlunit.sourceforge.net/[HtmlUnit], + http://seleniumhq.org/projects/webdriver/[WebDriver], and + http://www.gebish.org/manual/current/testing.html#spock_junit__testng[Geb] without the + need to deploy to a Servlet container. * Test JavaScript within pages. * Optionally, test using mock services to speed up testing. * Share logic between in-container end-to-end tests and out-of-container integration tests. -NOTE: MockMvc works with templating technologies that do not rely on a Servlet Container (for example, -Thymeleaf, FreeMarker, and others), but it does not work with JSPs, since they rely on the Servlet -container. +NOTE: MockMvc works with templating technologies that do not rely on a Servlet Container +(for example, Thymeleaf, FreeMarker, and others), but it does not work with JSPs, since +they rely on the Servlet container. [[spring-mvc-test-server-htmlunit-why]] ===== Why HtmlUnit Integration? -The most obvious question that comes to mind is "`Why do I need this?`" The answer is best -found by exploring a very basic sample application. Assume you have a Spring MVC web -application that supports CRUD operations on a `Message` object. The application also supports -paging through all messages. How would you go about testing it? +The most obvious question that comes to mind is "`Why do I need this?`" The answer is +best found by exploring a very basic sample application. Assume you have a Spring MVC web +application that supports CRUD operations on a `Message` object. The application also +supports paging through all messages. How would you go about testing it? With Spring MVC Test, we can easily test if we are able to create a `Message`, as follows: @@ -5361,8 +5365,9 @@ naive attempt might resemble the following: ==== This test has some obvious drawbacks. If we update our controller to use the parameter -`message` instead of `text`, our form test continues to pass, even though the HTML -form is out of synch with the controller. To resolve this we can combine our two tests, as follows: +`message` instead of `text`, our form test continues to pass, even though the HTML form +is out of synch with the controller. To resolve this we can combine our two tests, as +follows: ==== [[spring-mvc-test-server-htmlunit-mock-mvc-test]] @@ -5388,13 +5393,13 @@ This would reduce the risk of our test incorrectly passing, but there are still problems: * What if we have multiple forms on our page? Admittedly, we could update our XPath - expressions, but they get more complicated as we take more factors into account: Are the - fields the correct type? Are the fields enabled? And so on. -* Another issue is that we are doing double the work we would expect. - We must first verify the view, and then we submit the view with the same parameters we just - verified. Ideally, this could be done all at once. -* Finally, we still cannot account for some things. For example, what if the - form has JavaScript validation that we wish to test as well? + expressions, but they get more complicated as we take more factors into account: Are + the fields the correct type? Are the fields enabled? And so on. +* Another issue is that we are doing double the work we would expect. We must first + verify the view, and then we submit the view with the same parameters we just verified. + Ideally, this could be done all at once. +* Finally, we still cannot account for some things. For example, what if the form has + JavaScript validation that we wish to test as well? The overall problem is that testing a web page does not involve a single interaction. Instead, it is a combination of how the user interacts with a web page and how that web @@ -5408,31 +5413,32 @@ validation. [[spring-mvc-test-server-htmlunit-why-integration]] ====== Integration Testing to the Rescue? -To resolve the issues mentioned earler, we could perform end-to-end integration testing, but this has -some drawbacks. Consider testing the view that lets us page through the messages. -We might need the following tests: +To resolve the issues mentioned earlier, we could perform end-to-end integration testing, +but this has some drawbacks. Consider testing the view that lets us page through the +messages. We might need the following tests: -* Does our page display a notification to the user to indicate that no results are available -when the messages are empty? +* Does our page display a notification to the user to indicate that no results are + available when the messages are empty? * Does our page properly display a single message? * Does our page properly support paging? -To set up these tests, we need to ensure our database contains the proper messages. -This leads to a number of additional challenges: +To set up these tests, we need to ensure our database contains the proper messages. This +leads to a number of additional challenges: * Ensuring the proper messages are in the database can be tedious. (Consider foreign key constraints.) -* Testing can become slow, since each test would need to ensure that the database is in the - correct state. +* Testing can become slow, since each test would need to ensure that the database is in + the correct state. * Since our database needs to be in a specific state, we cannot run tests in parallel. -* Performing assertions on such items as auto-generated ids, timestamps, and others can be difficult. +* Performing assertions on such items as auto-generated ids, timestamps, and others can + be difficult. These challenges do not mean that we should abandon end-to-end integration testing altogether. Instead, we can reduce the number of end-to-end integration tests by -refactoring our detailed tests to use mock services that run much faster, more -reliably, and without side effects. We can then implement a small number of true -end-to-end integration tests that validate simple workflows to ensure that everything -works together properly. +refactoring our detailed tests to use mock services that run much faster, more reliably, +and without side effects. We can then implement a small number of true end-to-end +integration tests that validate simple workflows to ensure that everything works together +properly. @@ -5451,29 +5457,29 @@ with HtmlUnit.`" You have a number of options when you want to integrate MockMvc with HtmlUnit: * <>: Use this option if you -want to use the raw HtmlUnit libraries. + want to use the raw HtmlUnit libraries. * <>: Use this option to -ease development and reuse code between integration and end-to-end testing. -* <>: Use this option if you want -to use Groovy for testing, ease development, and reuse code between integration and -end-to-end testing. + ease development and reuse code between integration and end-to-end testing. +* <>: Use this option if you want to + use Groovy for testing, ease development, and reuse code between integration and + end-to-end testing. [[spring-mvc-test-server-htmlunit-mah]] ===== MockMvc and HtmlUnit -This section describes how to integrate MockMvc and HtmlUnit. Use this option if you -want to use the raw HtmlUnit libraries. +This section describes how to integrate MockMvc and HtmlUnit. Use this option if you want +to use the raw HtmlUnit libraries. [[spring-mvc-test-server-htmlunit-mah-setup]] ====== MockMvc and HtmlUnit Setup -First, make sure that you have included a test dependency on `net.sourceforge.htmlunit:htmlunit`. -In order to use HtmlUnit with Apache HttpComponents 4.5+, you need to use HtmlUnit -2.18 or higher. +First, make sure that you have included a test dependency on +`net.sourceforge.htmlunit:htmlunit`. In order to use HtmlUnit with Apache HttpComponents +4.5+, you need to use HtmlUnit 2.18 or higher. We can easily create an HtmlUnit `WebClient` that integrates with MockMvc by using the `MockMvcWebClientBuilder`, as follows: @@ -5495,11 +5501,11 @@ We can easily create an HtmlUnit `WebClient` that integrates with MockMvc by usi ---- ==== -NOTE: This is a simple example of using `MockMvcWebClientBuilder`. For advanced usage, see -<>. +NOTE: This is a simple example of using `MockMvcWebClientBuilder`. For advanced usage, +see <>. -This ensures that any URL that references `localhost` as the server is directed to -our `MockMvc` instance without the need for a real HTTP connection. Any other URL is +This ensures that any URL that references `localhost` as the server is directed to our +`MockMvc` instance without the need for a real HTTP connection. Any other URL is requested by using a network connection, as normal. This lets us easily test the use of CDNs. @@ -5509,8 +5515,8 @@ CDNs. ====== MockMvc and HtmlUnit Usage Now we can use HtmlUnit as we normally would but without the need to deploy our -application to a Servlet container. For example, we can request the view to create -a message with the following: +application to a Servlet container. For example, we can request the view to create a +message with the following: ==== [source,java,indent=0] @@ -5519,11 +5525,11 @@ a message with the following: ---- ==== -NOTE: The default context path is `""`. Alternatively, we can specify the context path, as -described in <>. +NOTE: The default context path is `""`. Alternatively, we can specify the context path, +as described in <>. -Once we have a reference to the `HtmlPage`, we can then fill out the form and submit -it to create a message, as the following example shows: +Once we have a reference to the `HtmlPage`, we can then fill out the form and submit it +to create a message, as the following example shows: ==== [source,java,indent=0] @@ -5554,26 +5560,27 @@ assertions use the http://joel-costigliola.github.io/assertj/[AssertJ] library: ---- ==== -The preceding code improves on our <> in a -number of ways. First, we no longer have to explicitly verify our form and then create a -request that looks like the form. Instead, we request the form, fill it out, and submit -it, thereby significantly reducing the overhead. +The preceding code improves on our +<> in a number of ways. +First, we no longer have to explicitly verify our form and then create a request that +looks like the form. Instead, we request the form, fill it out, and submit it, thereby +significantly reducing the overhead. Another important factor is that http://htmlunit.sourceforge.net/javascript.html[HtmlUnit -uses the Mozilla Rhino engine] to evaluate JavaScript. This means that we can also test the -behavior of JavaScript within our pages. +uses the Mozilla Rhino engine] to evaluate JavaScript. This means that we can also test +the behavior of JavaScript within our pages. -See the http://htmlunit.sourceforge.net/gettingStarted.html[HtmlUnit documentation] -for additional information about using HtmlUnit. +See the http://htmlunit.sourceforge.net/gettingStarted.html[HtmlUnit documentation] for +additional information about using HtmlUnit. [[spring-mvc-test-server-htmlunit-mah-advanced-builder]] ====== Advanced `MockMvcWebClientBuilder` -In the examples so far, we have used `MockMvcWebClientBuilder` in the simplest way possible, -by building a `WebClient` based on the `WebApplicationContext` loaded for us by the Spring -TestContext Framework. This approach is repeated in the following example: +In the examples so far, we have used `MockMvcWebClientBuilder` in the simplest way +possible, by building a `WebClient` based on the `WebApplicationContext` loaded for us by +the Spring TestContext Framework. This approach is repeated in the following example: ==== [source,java,indent=0] @@ -5657,19 +5664,19 @@ http://docs.seleniumhq.org/projects/webdriver/[WebDriver] to make things even ea ====== Why WebDriver and MockMvc? We can already use HtmlUnit and MockMvc, so why would we want to use WebDriver? The -Selenium WebDriver provides a very elegant API that lets us easily organize our code. -To better show how it works, we explore an example in this section. +Selenium WebDriver provides a very elegant API that lets us easily organize our code. To +better show how it works, we explore an example in this section. -NOTE: Despite being a part of http://docs.seleniumhq.org/[Selenium], WebDriver does not require -a Selenium Server to run your tests. +NOTE: Despite being a part of http://docs.seleniumhq.org/[Selenium], WebDriver does not +require a Selenium Server to run your tests. Suppose we need to ensure that a message is created properly. The tests involve finding the HTML form input elements, filling them out, and making various assertions. -This approach results in numerous separate tests because we want to test error -conditions as well. For example, we want to ensure that we get an error if we fill out -only part of the form. If we fill out the entire form, the newly created message should -be displayed afterwards. +This approach results in numerous separate tests because we want to test error conditions +as well. For example, we want to ensure that we get an error if we fill out only part of +the form. If we fill out the entire form, the newly created message should be displayed +afterwards. If one of the fields were named "`summary`", we might have something that resembles the following repeated in multiple places within our tests: @@ -5683,8 +5690,8 @@ following repeated in multiple places within our tests: ==== So what happens if we change the `id` to `smmry`? Doing so would force us to update all -of our tests to incorporate this change. This violates the DRY principle, so -we should ideally extract this code into its own method, as follows: +of our tests to incorporate this change. This violates the DRY principle, so we should +ideally extract this code into its own method, as follows: ==== [source,java,indent=0] @@ -5744,8 +5751,8 @@ represents the `HtmlPage` we are currently on, as the following example shows: ==== Formerly, this pattern was known as the -https://github.com/SeleniumHQ/selenium/wiki/PageObjects[Page Object Pattern]. While we can -certainly do this with HtmlUnit, WebDriver provides some tools that we explore in the +https://github.com/SeleniumHQ/selenium/wiki/PageObjects[Page Object Pattern]. While we +can certainly do this with HtmlUnit, WebDriver provides some tools that we explore in the following sections to make this pattern much easier to implement. @@ -5776,13 +5783,13 @@ We can easily create a Selenium WebDriver that integrates with MockMvc by using ---- ==== -NOTE: This is a simple example of using `MockMvcHtmlUnitDriverBuilder`. -For more advanced usage, see <>. +NOTE: This is a simple example of using `MockMvcHtmlUnitDriverBuilder`. For more advanced +usage, see <>. -The preceding example ensures that any URL that references `localhost` as the server is directed to -our `MockMvc` instance without the need for a real HTTP connection. Any other URL is -requested by using a network connection, as normal. This lets us easily test the use of -CDNs. +The preceding example ensures that any URL that references `localhost` as the server is +directed to our `MockMvc` instance without the need for a real HTTP connection. Any other +URL is requested by using a network connection, as normal. This lets us easily test the +use of CDNs. @@ -5790,8 +5797,8 @@ CDNs. ====== MockMvc and WebDriver Usage Now we can use WebDriver as we normally would but without the need to deploy our -application to a Servlet container. For example, we can request the view to create -a message with the following: +application to a Servlet container. For example, we can request the view to create a +message with the following: ==== [source,java,indent=0] @@ -5810,11 +5817,11 @@ We can then fill out the form and submit it to create a message, as follows: ---- ==== -This improves on the design of our -<> by leveraging the Page Object -Pattern. As we mentioned in <>, we can -use the Page Object Pattern with HtmlUnit, but it is much easier with WebDriver. -Consider the following `CreateMessagePage` implementation: +This improves on the design of our <> by leveraging the Page Object Pattern. As we mentioned in +<>, we can use the Page Object Pattern +with HtmlUnit, but it is much easier with WebDriver. Consider the following +`CreateMessagePage` implementation: ==== [source,java,indent=0] @@ -5848,20 +5855,19 @@ Consider the following `CreateMessagePage` implementation: } ---- -<1> `CreateMessagePage` extends the -`AbstractPage`. We do not go over the details of `AbstractPage`, but, in summary, it -contains common functionality for all of our pages. For example, if our application has -a navigational bar, global error messages, and other features, we can place this logic in a shared -location. +<1> `CreateMessagePage` extends the `AbstractPage`. We do not go over the details of +`AbstractPage`, but, in summary, it contains common functionality for all of our pages. +For example, if our application has a navigational bar, global error messages, and other +features, we can place this logic in a shared location. -<2> We have a member variable for each of the -parts of the HTML page in which we are interested. These are of type `WebElement`. -WebDriver's https://github.com/SeleniumHQ/selenium/wiki/PageFactory[`PageFactory`] lets -us remove a lot of code from the HtmlUnit version of `CreateMessagePage` by -automatically resolving each `WebElement`. The +<2> We have a member variable for each of the parts of the HTML page in which we are +interested. These are of type `WebElement`. WebDriver's +https://github.com/SeleniumHQ/selenium/wiki/PageFactory[`PageFactory`] lets us remove a +lot of code from the HtmlUnit version of `CreateMessagePage` by automatically resolving +each `WebElement`. The https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/support/PageFactory.html#initElements-org.openqa.selenium.WebDriver-java.lang.Class-[`PageFactory#initElements(WebDriver,Class)`] -method automatically resolves each `WebElement` by using the field name and looking it -up by the `id` or `name` of the element within the HTML page. +method automatically resolves each `WebElement` by using the field name and looking it up +by the `id` or `name` of the element within the HTML page. <3> We can use the https://github.com/SeleniumHQ/selenium/wiki/PageFactory#making-the-example-work-using-annotations[`@FindBy` annotation] @@ -5870,7 +5876,7 @@ annotation to look up our submit button with a `css` selector (*input[type=submi ==== Finally, we can verify that a new message was created successfully. The following -assertions use the https://code.google.com/p/fest/[FEST assertion library]: +assertions use the http://joel-costigliola.github.io/assertj/[AssertJ] assertion library: ==== [source,java,indent=0] @@ -5880,8 +5886,8 @@ assertions use the https://code.google.com/p/fest/[FEST assertion library]: ---- ==== -We can see that our `ViewMessagePage` lets us interact with our custom domain -model. For example, it exposes a method that returns a `Message` object: +We can see that our `ViewMessagePage` lets us interact with our custom domain model. For +example, it exposes a method that returns a `Message` object: ==== [source,java,indent=0] @@ -5899,7 +5905,8 @@ model. For example, it exposes a method that returns a `Message` object: We can then use the rich domain objects in our assertions. -Lastly, we must not forget to close the `WebDriver` instance when the test is complete, as follows: +Lastly, we must not forget to close the `WebDriver` instance when the test is complete, +as follows: ==== [source,java,indent=0] @@ -5997,8 +6004,8 @@ TIP: For additional information on creating a `MockMvc` instance, see [[spring-mvc-test-server-htmlunit-geb]] ===== MockMvc and Geb -In the previous section, we saw how to use MockMvc with WebDriver. In this section, -we use http://www.gebish.org/[Geb] to make our tests even Groovy-er. +In the previous section, we saw how to use MockMvc with WebDriver. In this section, we +use http://www.gebish.org/[Geb] to make our tests even Groovy-er. @@ -6015,8 +6022,8 @@ boilerplate code for us. [[spring-mvc-test-server-htmlunit-geb-setup]] ====== MockMvc and Geb Setup -We can easily initialize a Geb `Browser` with a Selenium WebDriver that uses MockMvc, -as follows: +We can easily initialize a Geb `Browser` with a Selenium WebDriver that uses MockMvc, as +follows: ==== [source,groovy] @@ -6029,11 +6036,11 @@ def setup() { ---- ==== -NOTE: This is a simple example of using `MockMvcHtmlUnitDriverBuilder`. -For more advanced usage, see <>. +NOTE: This is a simple example of using `MockMvcHtmlUnitDriverBuilder`. For more advanced +usage, see <>. -This ensures that any URL referencing `localhost` as the server is directed to -our `MockMvc` instance without the need for a real HTTP connection. Any other URL is +This ensures that any URL referencing `localhost` as the server is directed to our +`MockMvc` instance without the need for a real HTTP connection. Any other URL is requested by using a network connection as normal. This lets us easily test the use of CDNs. @@ -6042,9 +6049,9 @@ CDNs. [[spring-mvc-test-server-htmlunit-geb-usage]] ====== MockMvc and Geb Usage -Now we can use Geb as we normally would but without the need to deploy our -application to a Servlet container. For example, we can request the view to create -a message with the following: +Now we can use Geb as we normally would but without the need to deploy our application to +a Servlet container. For example, we can request the view to create a message with the +following: ==== [source,groovy] @@ -6066,8 +6073,8 @@ submit.click(ViewMessagePage) ==== Any unrecognized method calls or property accesses or references that are not found are -forwarded to the current page object. This removes a lot of the boilerplate code we needed -when using WebDriver directly. +forwarded to the current page object. This removes a lot of the boilerplate code we +needed when using WebDriver directly. As with direct WebDriver usage, this improves on the design of our <> by using the Page Object @@ -6090,10 +6097,9 @@ class CreateMessagePage extends Page { ---- ==== -Our `CreateMessagePage` extends `Page`. We do not -go over the details of `Page`, but, in summary, it contains common functionality for all of -our pages. We define a URL in which this page can -be found. This lets us navigate to the page, as follows: +Our `CreateMessagePage` extends `Page`. We do not go over the details of `Page`, but, in +summary, it contains common functionality for all of our pages. We define a URL in which +this page can be found. This lets us navigate to the page, as follows: ==== [source,groovy] @@ -6102,9 +6108,9 @@ to CreateMessagePage ---- ==== -We also have an `at` closure that determines if we are at the specified page. It should return -`true` if we are on the correct page. This is why we can assert that we are on the correct -page, as follows: +We also have an `at` closure that determines if we are at the specified page. It should +return `true` if we are on the correct page. This is why we can assert that we are on the +correct page, as follows: ==== [source,groovy] @@ -6115,13 +6121,13 @@ errors.contains('This field is required.') ---- ==== -NOTE: We use an assertion in the closure so that we can determine where things went wrong if -we were at the wrong page. +NOTE: We use an assertion in the closure so that we can determine where things went wrong +if we were at the wrong page. -Next, we create a `content` closure that specifies all the areas of interest within the page. -We can use a -http://www.gebish.org/manual/current/#the-jquery-ish-navigator-api[jQuery-ish Navigator API] -to select the content in which we are interested. +Next, we create a `content` closure that specifies all the areas of interest within the +page. We can use a +http://www.gebish.org/manual/current/#the-jquery-ish-navigator-api[jQuery-ish Navigator +API] to select the content in which we are interested. Finally, we can verify that a new message was created successfully, as follows: @@ -6146,10 +6152,10 @@ http://www.gebish.org/manual/current/[The Book of Geb] user's manual. [[spring-mvc-test-client]] ==== Client-Side REST Tests -You can use client-side tests to test code that internally uses the `RestTemplate`. -The idea is to declare expected requests and to provide "`stub`" responses so that -you can focus on testing the code in isolation (that is, without running a server). -The following example shows how to do so: +You can use client-side tests to test code that internally uses the `RestTemplate`. The +idea is to declare expected requests and to provide "`stub`" responses so that you can +focus on testing the code in isolation (that is, without running a server). The following +example shows how to do so: ==== [source,java,indent=0] @@ -6168,17 +6174,17 @@ The following example shows how to do so: In the preceding example, `MockRestServiceServer` (the central class for client-side REST tests) configures the `RestTemplate` with a custom `ClientHttpRequestFactory` that -asserts actual requests against expectations and returns "`stub`" responses. In this case, -we expect a request to `/greeting` and want to return a 200 response with +asserts actual requests against expectations and returns "`stub`" responses. In this +case, we expect a request to `/greeting` and want to return a 200 response with `text/plain` content. We can define additional expected requests and stub responses as needed. When we define expected requests and stub responses, the `RestTemplate` can be used in client-side code as usual. At the end of testing, `mockServer.verify()` can be used to verify that all expectations have been satisfied. -By default, requests are expected in the order in which expectations were declared. -You can set the `ignoreExpectOrder` option when building the server, in which case -all expectations are checked (in order) to find a match for a given request. That -means requests are allowed to come in any order. The following example uses `ignoreExpectOrder`: +By default, requests are expected in the order in which expectations were declared. You +can set the `ignoreExpectOrder` option when building the server, in which case all +expectations are checked (in order) to find a match for a given request. That means +requests are allowed to come in any order. The following example uses `ignoreExpectOrder`: ==== [source,java,indent=0] @@ -6210,15 +6216,16 @@ argument that specifies a count range (for example, `once`, `manyTimes`, `max`, ==== Note that, when `ignoreExpectOrder` is not set (the default), and, therefore, requests -are expected in order of declaration, then that order applies only to the first of -any expected request. For example if "/something" is expected two times followed by "/somewhere" -three times, then there should be a request to "/something" before there is a request to "/somewhere", -but, aside from that subsequent "/something" and "/somewhere", requests can come at any time. +are expected in order of declaration, then that order applies only to the first of any +expected request. For example if "/something" is expected two times followed by +"/somewhere" three times, then there should be a request to "/something" before there is +a request to "/somewhere", but, aside from that subsequent "/something" and "/somewhere", +requests can come at any time. As an alternative to all of the above, the client-side test support also provides a -`ClientHttpRequestFactory` implementation that you can configure into a `RestTemplate` -to bind it to a `MockMvc` instance. That allows processing requests using actual -server-side logic but without running a server. The following example shows how to do so: +`ClientHttpRequestFactory` implementation that you can configure into a `RestTemplate` to +bind it to a `MockMvc` instance. That allows processing requests using actual server-side +logic but without running a server. The following example shows how to do so: ==== [source,java,indent=0] @@ -6234,13 +6241,12 @@ server-side logic but without running a server. The following example shows how [[spring-mvc-test-client-static-imports]] ===== Static Imports -As with server-side tests, the fluent API for client-side tests requires a few -static imports. Those are easy to find by searching for `MockRest*`. Eclipse users -should add `MockRestRequestMatchers.{asterisk}` and `MockRestResponseCreators.{asterisk}` -as "`favorite static members`" in the Eclipse preferences under -Java -> Editor -> Content Assist -> Favorites. -That allows using content assist after typing the first character of the -static method name. Other IDEs (such IntelliJ) may not require any additional +As with server-side tests, the fluent API for client-side tests requires a few static +imports. Those are easy to find by searching for `MockRest*`. Eclipse users should add +`MockRestRequestMatchers.{asterisk}` and `MockRestResponseCreators.{asterisk}` as +"`favorite static members`" in the Eclipse preferences under Java -> Editor -> Content +Assist -> Favorites. That allows using content assist after typing the first character of +the static method name. Other IDEs (such IntelliJ) may not require any additional configuration. Check for the support for code completion on static members. @@ -6262,9 +6268,9 @@ include::testing-webtestclient.adoc[leveloffset=+2] === PetClinic Example The PetClinic application, available on -https://github.com/spring-projects/spring-petclinic[GitHub], shows several features -of the Spring TestContext Framework in a JUnit 4 environment. Most test functionality -is included in the `AbstractClinicTests`, for which a partial listing follows: +https://github.com/spring-projects/spring-petclinic[GitHub], shows several features of +the Spring TestContext Framework in a JUnit 4 environment. Most test functionality is +included in the `AbstractClinicTests`, for which a partial listing follows: ==== [source,java,indent=0] @@ -6310,17 +6316,16 @@ the database without breaking tests. ==== Like many integration tests that use a database, most of the tests in -`AbstractClinicTests` depend on a minimum amount of data already being in the database before -the test cases run. Alternatively, you can populate the database within the -test fixture set up of your test cases (again, within the same transaction as the -tests). +`AbstractClinicTests` depend on a minimum amount of data already being in the database +before the test cases run. Alternatively, you can populate the database within the test +fixture set up of your test cases (again, within the same transaction as the tests). The PetClinic application supports three data access technologies: JDBC, Hibernate, and JPA. By declaring `@ContextConfiguration` without any specific resource locations, the -`AbstractClinicTests` class has its application context loaded from the default -location, `AbstractClinicTests-context.xml`, which declares a common `DataSource`. -Subclasses specify additional context locations that must declare a -`PlatformTransactionManager` and a concrete implementation of `Clinic`. +`AbstractClinicTests` class has its application context loaded from the default location, +`AbstractClinicTests-context.xml`, which declares a common `DataSource`. Subclasses +specify additional context locations that must declare a `PlatformTransactionManager` and +a concrete implementation of `Clinic`. For example, the Hibernate implementation of the PetClinic tests contains the following implementation. For this example, `HibernateClinicTests` does not contain a single line @@ -6330,8 +6335,8 @@ specific resource locations, the Spring TestContext Framework loads an applicati context from all the beans defined in `AbstractClinicTests-context.xml` (that is, the inherited locations) and `HibernateClinicTests-context.xml`, with `HibernateClinicTests-context.xml` possibly overriding beans defined in -`AbstractClinicTests-context.xml`. -The following listing shows the definition of the `HibernateClinicTests` class: +`AbstractClinicTests-context.xml`. The following listing shows the definition of the +`HibernateClinicTests` class: ==== [source,java,indent=0] @@ -6350,19 +6355,18 @@ useful instance variables (populated by Dependency Injection, naturally), such a `SessionFactory` in the case of an application that uses Hibernate. As far as possible, you should have exactly the same Spring configuration files in your -integration tests as in the deployed environment. One likely point of difference -concerns database connection pooling and transaction infrastructure. If you are -deploying to a full-blown application server, you probably use its connection pool -(available through JNDI) and JTA implementation. Thus, in production, you can use a -`JndiObjectFactoryBean` or `` for the `DataSource` and -`JtaTransactionManager`. JNDI and JTA are not available in out-of-container -integration tests, so you should use a combination such as the Commons DBCP -`BasicDataSource` and `DataSourceTransactionManager` or `HibernateTransactionManager` -for them. You can factor out this variant behavior into a single XML file, having the -choice between application server and a "`local`" configuration separated from all other -configuration, which will not vary between the test and production environments. In -addition, we recommend that you use properties files for connection settings. See the -PetClinic application for an example. +integration tests as in the deployed environment. One likely point of difference concerns +database connection pooling and transaction infrastructure. If you are deploying to a +full-blown application server, you probably use its connection pool (available through +JNDI) and JTA implementation. Thus, in production, you can use a `JndiObjectFactoryBean` +or `` for the `DataSource` and `JtaTransactionManager`. JNDI and JTA are +not available in out-of-container integration tests, so you should use a combination such +as the Commons DBCP `BasicDataSource` and `DataSourceTransactionManager` or +`HibernateTransactionManager` for them. You can factor out this variant behavior into a +single XML file, having the choice between application server and a "`local`" +configuration separated from all other configuration, which will not vary between the +test and production environments. In addition, we recommend that you use properties files +for connection settings. See the PetClinic application for an example.