Fix #2133 and preserve CORE-2971 (Liquibase endDelimiter does not work after upgrading from 3.10.x to 4.x)

[Saucistophe]

Environment

Liquibase Version: Latest (4.5.1?)

Liquibase Integration & Version: core

Pull Request Type

• Bug fix (non-breaking change which fixes an issue.)
• Enhancement/New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Description

Fixes #2133 while preserving (and testing) CORE-2971.
It's a tad less aggressive regarding end delimiters.

Steps To Reproduce

All steps are clearly listed in the Github issue.

Fast Track PR Acceptance Checklist:

• Build is successful and all new and existing tests pass
• Added Unit Test(s)
• Added Integration Test(s)
• Added Test Harness Test(s)
• Documentation Updated

---

Dev Handoff Notes (Internal Use)

Links

• Fixed Issue: Liquibase endDelimiter does not work after upgrading from 3.10.x to 4.x #2133
• Test Results: https://github.com/liquibase/liquibase/pull/2135/checks

Testing

• Steps to Reproduce: Liquibase endDelimiter does not work after upgrading from 3.10.x to 4.x #2133 while not impacting https://liquibase.jira.com/browse/CORE-2971
• Guidance:
  • Impact: changes the handling of delimiters in parsed sql, whether it is in formatted sql or a sql/sqlFile tag

Dev Verification

Reviewed code and verified that automated tests now check the described problem

┆Issue is synchronized with this Jira Bug by Unito

[mkobylarz]

Hello, I would like to upvote for this merge request, because it solves breaking change for me. @Saucistophe do you think we could ask someone for review?

[Saucistophe]

Hello, I would like to upvote for this merge request, because it solves breaking change for me. @Saucistophe do you think we could ask someone for review?

Sure, I'm just not sure who/how to call out?

[mkobylarz]

Hello, I would like to upvote for this merge request, because it solves breaking change for me. @Saucistophe do you think we could ask someone for review?

Sure, I'm just not sure who/how to call out?

Don't exactly know either, but maybe there is an option to assign a reviewer? For example look at the history of #2140. There is a log entry: wwillard7800 requested review from nvoxland and suryaaki2 2 days ago therefore I suppose there must be such button somewhere. Can you see anything like that? Users: @nvoxland and @suryaaki2 were recently active in approving merge request.

Nevertheless, I am very grateful for your help. This gives hope to solve this issue, thanks a lot.

[Saucistophe]

Looks like it's for registered collaborators only !

@nvoxland or @suryaaki2, I'm not sure about how to raise attention on a PR, do you think you could check this one?
Thanks!

[nvoxland]

Changes look good, thanks.

I pushed a merge from master to your fork to clean up the merge conflicts

[kataggart]

hey @nvoxland can you take a look at this one? I think it was all set to go but never actually got merged; I put it in Ready to Merge and assigned to you, if that isn't right could you adjust? Thanks!

[XDelphiGrl]

This PR addresses two issues. The first issue is that endDelimiter was not being respected during liquibase update. The second issue is to ensure the fix for endDelimiter does not break handling of trailing comments in SQL statements; i.e. /*comment*/.

---

• Verify changesets with endDelimiter deploy without error.

  • formatted SQL changelog PASS
  • JSON changelog PASS
  • YAML changelog PASS
  • XML changelog Mostly PASS
    • The createProcedure changetype does not support the endDelimiter property. However, Liquibase still tries to split statements based on an end delimiter and does not do it correctly (truncates the last statement in the SQL). If you use an XML changelog, I suggest using either the sql or sqlFile changetypes to explicitly set an end delimeter and split statement properties.

• Verify with a trailing comment deploy without error.

  • formatted SQL changelog PASS
  • JSON changelog PASS
  • YAML changelog PASS
  • XML changelog PASS

---

Test Files

Formatted SQL

--liquibase formatted sql

-- changeset pr2135:endDelim runOnChange:true endDelimiter:/
CREATE OR REPLACE PROCEDURE proschema.pr2135_proc is
BEGIN
    SELECT * FROM DATABASECHANGELOGLOCK;
END pr2135_proc;
/

grant execute on pr2135_proc to CUKE_ADMIN/
grant execute on pr2135_proc to CUKE_ADMIN/
grant execute on pr2135_proc to CUKE_ADMIN/
-- rollback drop PROCEDURE pr2135_proc/

--changeset pr2135:trailingcomment stripComments:false

CREATE VIEW proschema.v_test AS

SELECT 1 x FROM dual /*test view*/

JSON

{ "databaseChangeLog": [
  {
    "changeSet": {
      "id": "1646318526286-1",
      "author": "erz (generated)",
      "changes": [
        {
          "createView": {
            "fullDefinition": true,
            "selectQuery": "CREATE OR REPLACE FORCE VIEW \"V_TEST\" (\"X\") AS SELECT 1 x FROM dual /*test view*/",
            "viewName": "V_TEST"
          }
        }]
      
    }
  },
  
  {
    "changeSet": {
      "id": "1646318526286-2",
      "author": "erz (generated)",
      "changes": [
        {
          "createProcedure": {
            "path": "objects/storedprocedure/PR2135_PROC.sql",
            "procedureName": "PR2135_PROC",
            "relativeToChangelogFile": true,
            "endDelimiter": "/"
          }
        }]
      
    }
  }
  
]}

YML

databaseChangeLog:
- changeSet:
    id: 1646318590509-1
    author: erz (generated)
    changes:
    - createView:
        fullDefinition: true
        selectQuery: CREATE OR REPLACE FORCE VIEW "V_TEST" ("X") AS SELECT 1 x FROM
          dual /*test view*/
        viewName: V_TEST
- changeSet:
    id: 1646318590509-2
    author: erz (generated)
    changes:
    - createProcedure:
        path: objects/storedprocedure/PR2135_PROC.sql
        procedureName: PR2135_PROC
        relativeToChangelogFile: true
        endDelimiter: /

XML

<?xml version="1.1" encoding="UTF-8" standalone="no"?>
<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog" xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext" xmlns:pro="http://www.liquibase.org/xml/ns/pro" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd http://www.liquibase.org/xml/ns/pro http://www.liquibase.org/xml/ns/pro/liquibase-pro-4.1.xsd http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.1.xsd">
    <changeSet author="erz (generated)" id="1646318372076-1">
        <createView fullDefinition="true" viewName="V_TEST">CREATE OR REPLACE FORCE VIEW "V_TEST" ("X") AS SELECT 1 x FROM dual /*test view*/</createView>
    </changeSet>
    <changeSet author="erz (generated)" id="1646318372076-2">
        <createProcedure path="objects/storedprocedure/PR2135_PROC.sql" procedureName="PR2135_PROC" relativeToChangelogFile="true"/>
    </changeSet>
</databaseChangeLog>

SQL File PR2135_PROC.sql

CREATE OR REPLACE PROCEDURE proschema.pr2135_proc is
BEGIN
    SELECT * FROM DATABASECHANGELOGLOCK;
END pr2135_proc;/

grant execute on pr2135_proc to CUKE_ADMIN/
grant execute on pr2135_proc to CUKE_ADMIN/
grant execute on pr2135_proc to CUKE_ADMIN/

---

Test Environment
Liquibase Core: handle_slash_delimiter_and_comments/957/b949f0, Pro: master/216/2fa6e0
Oracle 12.2.1
Passing Functional Tests

• Note: The Oracle proxy tests did not run due to an environmental issue; I deem this acceptable due to the limited scope of those tests and their lack of relation to the current fix.