Allow disabling the statement splitting when running an SQL script file

Author: amochin

src/DatabaseLibrary/query.py

@@ -209,11 +209,17 @@ def delete_all_rows_from_table(self, tableName: str, sansTran: bool = False, ali
             if cur and not sansTran:
                 db_connection.client.rollback()
 
-    def execute_sql_script(self, sqlScriptFileName: str, sansTran: bool = False, alias: Optional[str] = None):
+    def execute_sql_script(
+        self, sqlScriptFileName: str, sansTran: bool = False, split: bool = True, alias: Optional[str] = None
+    ):
         """
         Executes the content of the `sqlScriptFileName` as SQL commands. Useful for setting the database to a known
         state before running your tests, or clearing out your test data after running each a test.
 
+        SQL commands are expected to be delimited by a semicolon (';') - they will be split and executed separately.
+        You can disable this behaviour setting the parameter `split` to _False_ -
+        in this case the entire script content will be passed to the database module for execution.
+
         Sample usage :
         | Execute Sql Script | ${EXECDIR}${/}resources${/}DDL-setup.sql |
         | Execute Sql Script | ${EXECDIR}${/}resources${/}DML-setup.sql |
@@ -222,7 +228,6 @@ def execute_sql_script(self, sqlScriptFileName: str, sansTran: bool = False, ali
         | Execute Sql Script | ${EXECDIR}${/}resources${/}DML-teardown.sql |
         | Execute Sql Script | ${EXECDIR}${/}resources${/}DDL-teardown.sql |
 
-        SQL commands are expected to be delimited by a semicolon (';') - they will be executed separately.
 
         For example:
         DELETE FROM person_employee_table;
@@ -273,72 +278,77 @@ def execute_sql_script(self, sqlScriptFileName: str, sansTran: bool = False, ali
         with open(sqlScriptFileName, encoding="UTF-8") as sql_file:
             cur = None
             try:
-                statements_to_execute = []
                 cur = db_connection.client.cursor()
                 logger.info(f"Executing : Execute SQL Script  |  {sqlScriptFileName}")
-                current_statement = ""
-                inside_statements_group = False
-                proc_start_pattern = re.compile("create( or replace)? (procedure|function){1}( )?")
-                proc_end_pattern = re.compile("end(?!( if;| loop;| case;| while;| repeat;)).*;()?")
-                for line in sql_file:
-                    line = line.strip()
-                    if line.startswith("#") or line.startswith("--") or line == "/":
-                        continue
-
-                    # check if the line matches the creating procedure regexp pattern
-                    elif proc_start_pattern.match(line.lower()):
-                        inside_statements_group = True
-                    elif line.lower().startswith("begin"):
-                        inside_statements_group = True
-
-                    # semicolons inside the line? use them to separate statements
-                    # ... but not if they are inside a begin/end block (aka. statements group)
-                    sqlFragments = line.split(";")
-                    # no semicolons
-                    if len(sqlFragments) == 1:
-                        current_statement += line + " "
-                        continue
-                    quotes = 0
-                    # "select * from person;" -> ["select..", ""]
-                    for sqlFragment in sqlFragments:
-                        if len(sqlFragment.strip()) == 0:
+                if not split:
+                    logger.info("Statements splitting disabled - pass entire script content to the database module")
+                    self.__execute_sql(cur, sql_file.read())
+                else:
+                    logger.info("Splitting script file into statements...")
+                    statements_to_execute = []
+                    current_statement = ""
+                    inside_statements_group = False
+                    proc_start_pattern = re.compile("create( or replace)? (procedure|function){1}( )?")
+                    proc_end_pattern = re.compile("end(?!( if;| loop;| case;| while;| repeat;)).*;()?")
+                    for line in sql_file:
+                        line = line.strip()
+                        if line.startswith("#") or line.startswith("--") or line == "/":
                             continue
 
-                        if inside_statements_group:
-                            # if statements inside a begin/end block have semicolns,
-                            # they must persist - even with oracle
-                            sqlFragment += "; "
-
-                        if proc_end_pattern.match(sqlFragment.lower()):
-                            inside_statements_group = False
-                        elif proc_start_pattern.match(sqlFragment.lower()):
+                        # check if the line matches the creating procedure regexp pattern
+                        if proc_start_pattern.match(line.lower()):
                             inside_statements_group = True
-                        elif sqlFragment.lower().startswith("begin"):
+                        elif line.lower().startswith("begin"):
                             inside_statements_group = True
 
-                        # check if the semicolon is a part of the value (quoted string)
-                        quotes += sqlFragment.count("'")
-                        quotes -= sqlFragment.count("\\'")
-                        quotes -= sqlFragment.count("''")
-                        inside_quoted_string = quotes % 2 != 0
-                        if inside_quoted_string:
-                            sqlFragment += ";"  # restore the semicolon
-
-                        current_statement += sqlFragment
-                        if not inside_statements_group and not inside_quoted_string:
-                            statements_to_execute.append(current_statement.strip())
-                            current_statement = ""
-                            quotes = 0
-
-                current_statement = current_statement.strip()
-                if len(current_statement) != 0:
-                    statements_to_execute.append(current_statement)
-
-                for statement in statements_to_execute:
-                    logger.info(f"Executing statement from script file: {statement}")
-                    line_ends_with_proc_end = re.compile(r"(\s|;)" + proc_end_pattern.pattern + "$")
-                    omit_semicolon = not line_ends_with_proc_end.search(statement.lower())
-                    self.__execute_sql(cur, statement, omit_semicolon)
+                        # semicolons inside the line? use them to separate statements
+                        # ... but not if they are inside a begin/end block (aka. statements group)
+                        sqlFragments = line.split(";")
+                        # no semicolons
+                        if len(sqlFragments) == 1:
+                            current_statement += line + " "
+                            continue
+                        quotes = 0
+                        # "select * from person;" -> ["select..", ""]
+                        for sqlFragment in sqlFragments:
+                            if len(sqlFragment.strip()) == 0:
+                                continue
+
+                            if inside_statements_group:
+                                # if statements inside a begin/end block have semicolns,
+                                # they must persist - even with oracle
+                                sqlFragment += "; "
+
+                            if proc_end_pattern.match(sqlFragment.lower()):
+                                inside_statements_group = False
+                            elif proc_start_pattern.match(sqlFragment.lower()):
+                                inside_statements_group = True
+                            elif sqlFragment.lower().startswith("begin"):
+                                inside_statements_group = True
+
+                            # check if the semicolon is a part of the value (quoted string)
+                            quotes += sqlFragment.count("'")
+                            quotes -= sqlFragment.count("\\'")
+                            quotes -= sqlFragment.count("''")
+                            inside_quoted_string = quotes % 2 != 0
+                            if inside_quoted_string:
+                                sqlFragment += ";"  # restore the semicolon
+
+                            current_statement += sqlFragment
+                            if not inside_statements_group and not inside_quoted_string:
+                                statements_to_execute.append(current_statement.strip())
+                                current_statement = ""
+                                quotes = 0
+
+                    current_statement = current_statement.strip()
+                    if len(current_statement) != 0:
+                        statements_to_execute.append(current_statement)
+
+                    for statement in statements_to_execute:
+                        logger.info(f"Executing statement from script file: {statement}")
+                        line_ends_with_proc_end = re.compile(r"(\s|;)" + proc_end_pattern.pattern + "$")
+                        omit_semicolon = not line_ends_with_proc_end.search(statement.lower())
+                        self.__execute_sql(cur, statement, omit_semicolon)
                 if not sansTran:
                     db_connection.client.commit()
             finally:

test/tests/custom_db_tests/sql_script_split_commands.robot

@@ -0,0 +1,22 @@
+*** Settings ***
+Documentation    Tests for the parameter _split_ in the keyword
+...    _Execute SQL Script_ - special for the issue #184:
+...    https://github.com/MarketSquare/Robotframework-Database-Library/issues/184
+
+Resource            ../../resources/common.resource
+Suite Setup         Connect To DB
+Suite Teardown      Disconnect From Database
+Test Setup          Create Person Table
+Test Teardown       Drop Tables Person And Foobar
+
+
+*** Test Cases ***
+Split Commands
+    [Documentation]    Such a simple script works always,
+    ...    just check if the logs if the parameter value was processed properly
+    Execute Sql Script    ${CURDIR}/../../resources/insert_data_in_person_table.sql    split=True
+
+Don't Split Commands
+    [Documentation]    Running such a script as a single statement works for PostgreSQL,
+    ...    but fails in Oracle. Check in the logs if the splitting was disabled.
+    Execute Sql Script    ${CURDIR}/../../resources/insert_data_in_person_table.sql    split=False