fix SQLFileChange.generateCheckSum() to calculate checksum without pr…

…operty substitution (liquibase#5389)
jglass524 · Dec 20, 2023 · c4748fe · c4748fe
1 parent 672b35c
commit c4748fe
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 2 deletions.
diff --git a/liquibase-standard/src/main/java/liquibase/change/core/SQLFileChange.java b/liquibase-standard/src/main/java/liquibase/change/core/SQLFileChange.java
@@ -147,14 +147,18 @@ public String getConfirmationMessage() {
     @Override
     @DatabaseChangeProperty(isChangeProperty = false)
     public String getSql() {
+        return getSql(true);
+    }
+
+    public String getSql(boolean doExpandExpressions) {
         String sql = super.getSql();
         if (sql == null) {
             try (InputStream sqlStream = openSqlStream()) {
                 if (sqlStream == null) {
                     return null;
                 }
                 String content = StreamUtil.readStreamAsString(sqlStream, getEncoding());
-                if (getChangeSet() != null) {
+                if (doExpandExpressions && getChangeSet() != null) {
                     ChangeLogParameters parameters = getChangeSet().getChangeLogParameters();
                     if (parameters != null) {
                         content = parameters.expandExpressions(content, getChangeSet().getChangeLog());
@@ -198,7 +202,7 @@ public CheckSum generateCheckSum() {
         }
         InputStream stream = null;
         try {
-            String sqlContent = getSql();
+            String sqlContent = getSql(false);
             Charset encoding = GlobalConfiguration.FILE_ENCODING.getCurrentValue();
             stream = new ByteArrayInputStream(sqlContent.getBytes(encoding));
             return CheckSum.compute(new AbstractSQLChange.NormalizingStream(stream), false);

diff --git a/liquibase-standard/src/test/groovy/liquibase/change/core/SQLFileChangeTest.groovy b/liquibase-standard/src/test/groovy/liquibase/change/core/SQLFileChangeTest.groovy
@@ -85,6 +85,39 @@ class SQLFileChangeTest extends StandardChangeTest {
         assertEquals("create prfx_customer (nofx INTEGER NOT NULL, PRIMARY KEY (nofx));", change.getSql());
     }
 
+    def noReplacementOfPropertiesInChecksum() throws Exception {
+        when:
+        def changelog = new DatabaseChangeLog("com/example/changelog.xml")
+        def change1 = new SQLFileChange()
+        change1.path = "com/example-2/fileWithSchemaNameProperty.sql"
+        change1.relativeToChangelogFile = false
+        def changeLogParameters1 = new ChangeLogParameters()
+        changeLogParameters1.set("database.liquibaseSchemaName", "schema1")
+        def changeSet1 = new ChangeSet("x", "y", false, false, null, null, null, changelog)
+        changeSet1.setChangeLogParameters(changeLogParameters1)
+        change1.setChangeSet(changeSet1)
+
+        def sqlForSchema1 = change1.getSql().trim()
+        def checksum1 = change1.generateCheckSum()
+
+        def change2 = new SQLFileChange()
+        change2.path = "com/example-2/fileWithSchemaNameProperty.sql"
+        change2.relativeToChangelogFile = false
+        def changeLogParameters2 = new ChangeLogParameters()
+        changeLogParameters2.set("database.liquibaseSchemaName", "schema2")
+        def changeSet2 = new ChangeSet("x", "y", false, false, null, null, null, changelog)
+        changeSet2.setChangeLogParameters(changeLogParameters2)
+        change2.setChangeSet(changeSet2)
+
+        def sqlForSchema2 = change2.getSql().trim()
+        def checksum2 = change2.generateCheckSum()
+
+        then:
+        assertEquals("select * from schema1.customer;", sqlForSchema1)
+        assertEquals("select * from schema2.customer;", sqlForSchema2)
+        assertEquals(checksum1, checksum2)
+    }
+
     def "checkStatus"() {
         when:
         def database = new MockDatabase()

diff --git a/liquibase-standard/src/test/resources/com/example-2/fileWithSchemaNameProperty.sql b/liquibase-standard/src/test/resources/com/example-2/fileWithSchemaNameProperty.sql
@@ -0,0 +1 @@
+select * from ${database.liquibaseSchemaName}.customer;