Deprecate SimpleJdbcTestUtils in favor of JdbcTestUtils [SPR-9235]

[spring-projects-issues]

Michel Zanini opened SPR-9235 and commented

Overview

Since SimpleJdbcTemplate is now deprecated, SimpleJdbcTestUtils should also be deprecated, and its methods could be moved to JdbcTestUtils, changing them to use JdbcTemplate instead.

Proposed Solution

The file attached is a patch where I did this. Also, I added two methods that are very useful for database testing:

• dropTables(): this method is similar to deleteFromTables() but instead of removing all rows, it will drop the tables.
• countRowsInTable(): countRowsInTable() already exists, but I added this overloaded method that takes a whereClause to augment the query.

---

Affects: 3.1.1

Attachments:

• JdbcTestUtils.java (9.91 kB)

Sub-tasks:

• Backport "Deprecate SimpleJdbcTestUtils in favor of JdbcTestUtils" [SPR-9664] #14298 Backport "Deprecate SimpleJdbcTestUtils in favor of JdbcTestUtils"

Issue Links:

• Introduce countRowsInTableWhere() and dropTables() in abstract transactional base classes in the TestContext framework [SPR-9665] #14299 Introduce countRowsInTableWhere() and dropTables() in abstract transactional base classes in the TestContext framework ("is depended on by")
• Provide JdbcTemplate in abstract transactional base classes in the TestContext framework [SPR-8990] #13630 Provide JdbcTemplate in abstract transactional base classes in the TestContext framework ("is depended on by")
• JdbcTestUtils should not interpret comments as a separate statement [SPR-9593] #14227 JdbcTestUtils should not interpret comments as a separate statement
• Reference Guide still recommends SimpleJdbcTemplate, which is now deprecated [SPR-9345] #13983 Reference Guide still recommends SimpleJdbcTemplate, which is now deprecated
• Deprecate SimpleJdbcTemplate in favor of JdbcTemplate [SPR-6922] #11587 Deprecate SimpleJdbcTemplate in favor of JdbcTemplate

Referenced from: commits d7fd70f, a7d4377, bd0c4b4

3 votes, 5 watchers

[spring-projects-issues]

Chris Beams commented

Added @thomas.risberg as a watcher. Thomas, this looks reasonable. If you see fit, please assign to yourself and schedule for an upcoming release.

[spring-projects-issues]

Ian Brandt commented

I'm looking forward to the release of this. I've used SimpleJdbcTestUtils extensively. As it stands upgrading from 3.0 to 3.1 implies a flood of deprecation warnings without an equivalent API to migrate to.

[spring-projects-issues]

Chris Beams commented

Ian, Michel, all,

This is an ideal candidate for a pull request - if anyone here is interested in contributing, you can start with Michel's original attachment here, and then follow the contributor guidelines to get it committed.

[spring-projects-issues]

Ian Brandt commented

Done: #90. Hopefully this is in time for a 3.1.2 backport.

[spring-projects-issues]

Michel Zanini commented

I added a comment on the Git pull request on Github. One SQL has an extra escape char (`) that should be removed.

[spring-projects-issues]

Ian Brandt commented

I just noticed 3.1.2 was released, and was sorry to see that this was not included. Is there going to be a 3.1.3? Is there anything I need to do to the above pull request to get it considered?

[spring-projects-issues]

Sam Brannen commented

This issue has been addressed in GitHub commit a7d43773e8 as described in the commit message:

Deprecate SimpleJdbcTestUtils in favor of JdbcTestUtils

Several static utility methods in SimpleJdbcTestUtils accept an instance of SimpleJdbcTemplate as an argument; however, SimpleJdbcTemplate has been deprecated since Spring 3.1 in favor of simply using JdbcTemplate which now also supports Java 5 language constructs such as var-args. Consequently, use of such methods from SimpleJdbcTestUtils results in deprecation warnings without an equivalent API to migrate to.

This commit addresses this issue by migrating all existing methods in SimpleJdbcTestUtils to JdbcTestUtils. The migrated methods now accept an instance of JdbcTemplate as an argument, thereby avoiding the deprecation warnings but maintaining semantic compatibility with the functionality previous available in SimpleJdbcTestUtils.

In addition, this commit also introduces two new methods:

• countRowsInTableWhere(): counts the rows in a given table, using a provided WHERE clause
• dropTables(): drops the tables with the specified names

[spring-projects-issues]

Sam Brannen commented

FYI: I have raised #14298 to have this feature considered for backporting to Spring 3.1.x.

So feel free to watch #14298 if you're interested.

[spring-projects-issues]

Ian Brandt commented

Thank you Sam!

[spring-projects-issues]

Sam Brannen commented

If you're following this issue, you may also be interested in #14299.