Document programmatic test transaction management support [SPR-11941]

[spring-projects-issues]

Sam Brannen opened SPR-11941 and commented

Status Quo

#9753 introduced support for programmatically interacting with test-managed transactions in the Spring TestContext Framework (TCF); however, this new feature has not yet been sufficiently documented.

Deliverables

1. Document programmatic support for stopping and starting test-managed transactions in the reference manual, including examples of how to use the new TestTransaction API.
2. Introduce examples in the class-level Javadoc for TestTransaction.
3. Document TestTransaction support in the class-level Javadoc for TransactionalTestExecutionListener.

---

Affects: 4.1 RC1

Issue Links:

• Support programmatic starting and stopping of transactions in the TestContext framework [SPR-5079] #9753 Support programmatic starting and stopping of transactions in the TestContext framework ("depends on")
• Improve documentation of transactional support in the TestContext framework [SPR-11399] #16026 Improve documentation of transactional support in the TestContext framework ("is depended on by")

[spring-projects-issues]

Sam Brannen commented

Completed in GitHub commit cdc5222:

Document programmatic tx mgt support in the TCF

This commit introduces a new "Programmatic transaction management"
section in the Testing chapter of the reference manual with an example
highlighting the new support provided via TestTransaction.

In addition, this commit begins the work to be addressed more
thoroughly in #16026 by overhauling the entire "Transaction
management" section with in-depth discussions on the following topics.

• Test-managed transactions
• Enabling and disabling transactions
• Transaction rollback and commit behavior
• Executing code outside of a transaction
• Configuring a transaction manager