Introduce @SqlConfig for common SQL script configuration [SPR-11896]

[spring-projects-issues]

Sam Brannen opened SPR-11896 and commented

Status Quo

#12311 introduced support for declarative SQL script execution via the @Sql annotation in the Spring TestContext Framework (TCF). @Sql provides attributes for configuring the syntax of the referenced SQL scripts as well as exception handling and transaction behavior.

Early feedback from developers has shown that although this level of configuration (i.e., at the @Sql annotation level) is useful, it is often times a burden on the developer to declare the exact same configuration for each test method within a test class or test class hierarchy. It would therefore be very beneficial to be able to declare common, shared SQL configuration across a test class hierarchy.

Deliverables

1. Introduce a class-level annotation for declaring common SQL script configuration -- for example, @SqlConfig
2. Common configuration must be able to be overridden via method-level @Sql configuration.
3. Avoid unnecessary duplication of code and documentation by replacing existing configuration attributes in @Sql with a single config attribute of type @SqlConfig.
4. Furthermore, all attributes of @SqlConfig must be either of type String or custom enums in order to support overriding. Empty values would therefore imply use of a default or inherited value.

---

Affects: 4.1 RC1

Issue Links:

• Support declarative SQL script execution in the TestContext framework [SPR-7655] #12311 Support declarative SQL script execution in the TestContext framework ("depends on")
• Document @Sql script support in the reference manual [SPR-11849] #16468 Document @Sql script support in the reference manual ("is depended on by")
• Improve transaction management for @Sql [SPR-11911] #16530 Improve transaction management for @Sql

[spring-projects-issues]

Sam Brannen commented

Completed as described in the comments for GitHub commit bbfc31b:

Introduce @SqlConfig for common SQL script config

Prior to this commit, @Sql provided attributes for configuring the
syntax of the referenced SQL scripts as well as exception handling and
transaction behavior; however, such configuration could not be reused
across @Sql declarations thus requiring developers to copy-and-paste
common configuration and resulting in unnecessary code duplication.

This commit addresses this issue by introducing a new @SqlConfig
annotation that can be used to declare common, global configuration for
SQL scripts that can be reused within a test class hierarchy.

• Introduced top-level @SqlConfig annotation and extracted
  common configuration attributes from @Sql.

• @SqlConfig can be used at the class level for common, global config
  or via the new 'config' attribute of @Sql for local config.

• Introduced MergedSqlConfig as a holder for the merged values from
  local and global @SqlConfig instances. MergedSqlConfig also contains
  the logic for overriding global configuration with local
  configuration.

• Refactored all attributes of @SqlConfig to be either of type String
  or custom enums in order to support overriding. Empty Strings or
  DEFAULT enum values imply the use of a default or inherited value.