Split SQL script - remove comments when using external parser to avoid DB errors executing empty statements

Author: amochin

src/DatabaseLibrary/query.py

@@ -352,7 +352,11 @@ def split_sql_script(
             logger.info("Splitting script file into statements...")
             statements_to_execute = []
             if external_parser:
-                statements_to_execute = sqlparse.split(sql_file.read())
+                split_statements = sqlparse.split(sql_file.read())
+                for statement in split_statements:
+                    statement_without_comments = sqlparse.format(statement, strip_comments=True)
+                    if statement_without_comments:
+                        statements_to_execute.append(statement_without_comments)
             else:
                 current_statement = ""
                 inside_statements_group = False

test/resources/script_file_tests/split_commands_comments.sql

@@ -0,0 +1,6 @@
+-- here is a comment
+SELECT * FROM person;
+-- here is some another comment
+-- on more lines
+SELECT * FROM person WHERE id=1;
+--

test/tests/common_tests/script_files.robot

@@ -57,6 +57,17 @@ Split Script Into Statements - External Parser
         ${results}=    Query    ${command}
     END
 
+Split Script Into Statements - External Parser - Comments Are Removed
+    Insert Data In Person Table Using SQL Script
+    @{Expected commands}=    Create List
+    ...    SELECT * FROM person;
+    ...    SELECT * FROM person WHERE id=1;
+    ${extracted commands}=    Split Sql Script    ${Script files dir}/split_commands_comments.sql    external_parser=True
+    Lists Should Be Equal    ${Expected commands}    ${extracted commands}
+    FOR    ${command}    IN    @{extracted commands}
+        ${results}=    Query    ${command}
+    END
+
 
 *** Keywords ***
 Run SQL Script File