JdbcTestUtils should not interpret comments as a separate statement [SPR-9593]

[spring-projects-issues]

Johannes Odland opened SPR-9593 and commented

Overview

The splitSqlScripts() method in JdbcTestUtils splits scripts at a given delimiter, often ';'. If the script has a trailing comment this will be returned as a separate statement. When executing the statements an exception will be thrown.

Steps to Reproduce

If you call SimpleJdbcTestUtils.executeSqlScript() on the following script, the trailing comment will be detected as a separate statement and executed, resulting in a BadSqlGrammarException.

CREATE SQEUENCE HIBERNATE_SEQUENCE;
-- End of script

---

Affects: 3.1.2

Sub-tasks:

• Backport "JdbcTestUtils should not interpret comments as a separate statement" [SPR-9903] #14536 Backport "JdbcTestUtils should not interpret comments as a separate statement"

Issue Links:

• Deprecate SimpleJdbcTestUtils in favor of JdbcTestUtils [SPR-9235] #13873 Deprecate SimpleJdbcTestUtils in favor of JdbcTestUtils
• Support comments within SQL statements in JdbcTestUtils [SPR-9982] #14616 Support comments within SQL statements in JdbcTestUtils
• Improve comment handling in ResourceDatabasePopulator [SPR-9261] #13899 Improve comment handling in ResourceDatabasePopulator ("supersedes")

Referenced from: commits 397d20b, 4aaf014, d8dc4a2

[spring-projects-issues]

Sam Brannen commented

Fixed as described in the comments for GitHub commit 4aaf014cc6:

Support comments in SQL scripts in JdbcTestUtils

Prior to this commit, utility methods in JdbcTestUtils interpreted SQL comments as separate statements, resulting in an exception when such a script is executed.

This commit addresses this issue by introducing a readScript(lineNumberReader, String) method that accepts a comment prefix. Comment lines are therefore no longer returned in the parsed script. Furthermore, the existing readScript(lineNumberReader) method now delegates to this new readScript() method, supplying "--" as the default comment prefix.

[spring-projects-issues]

Chris Beams commented

Now backported to 3.1.x:

commit d8dc4a257afa2aad9575e4d17a283935735f949e
Author: Sam Brannen <sam@sambrannen.com>
Commit: Chris Beams <cbeams@vmware.com>

    Support comments in SQL scripts in JdbcTestUtils
    
    Prior to this commit, utility methods in JdbcTestUtils interpreted SQL
    comments as separate statements, resulting in an exception when such a
    script is executed.
    
    This commit addresses this issue by introducing a
    readScript(lineNumberReader, String) method that accepts a comment
    prefix. Comment lines are therefore no longer returned in the parsed
    script. Furthermore, the existing readScript(lineNumberReader) method
    now delegates to this new readScript() method, supplying "--" as the
    default comment prefix.
    
    Issue: SPR-9593
    Backport-Commit: 4aaf014cc6bed8bdeea375556b1022066359e79d