Multi-line statements now execute on 'GO' (#396)

Multi-line query functionality has changed to execute whenever 'GO' is typed, followed by a new-line. Semi-colons are no longer supported.

Author: Elliot Boschwitz

build.py

@@ -173,6 +173,7 @@ def get_active_test_filepaths():
         'tests/test_config.py '
         'tests/test_naive_completion.py '
         'tests/test_main.py '
+        'tests/test_multiline.py '
         'tests/test_fuzzy_completion.py '
         'tests/test_rowlimit.py '
         'tests/test_sqlcompletion.py '

mssqlcli/mssqlbuffer.py

@@ -1,5 +1,6 @@
 from __future__ import unicode_literals
-
+import re
+import sqlparse
 from prompt_toolkit.enums import DEFAULT_BUFFER
 from prompt_toolkit.filters import Condition
 from prompt_toolkit.application import get_app
@@ -21,10 +22,31 @@ def cond():
 
 
 def _is_complete(sql):
-    # A complete command is an sql statement that ends with a semicolon, unless
+    # A complete command is an sql statement that ends with a 'GO', unless
     # there's an open quote surrounding it, as is common when writing a
     # CREATE FUNCTION command
-    return sql.endswith(';') and not is_open_quote(sql)
+    if sql is not None and sql != "":
+        # remove comments
+        sql = sqlparse.format(sql, strip_comments=True)
+
+        # check for open comments
+        # remove all closed quotes to isolate instances of open comments
+        sql_no_quotes = re.sub(r'".*?"|\'.*?\'', '', sql)
+        is_open_comment = len(re.findall(r'\/\*', sql_no_quotes)) > 0
+
+        # check that 'go' is only token on newline
+        lines = sql.split('\n')
+        lastline = lines[len(lines) - 1].lower().strip()
+        is_valid_go_on_lastline = lastline == 'go'
+
+        # check that 'go' is on last line, not in open quotes, and there's no open
+        # comment with closed comments and quotes removed.
+        # NOTE: this method fails when GO follows a closing '*/' block comment on the same line,
+        # we've taken a dependency with sqlparse
+        # (https://github.com/andialbrecht/sqlparse/issues/484)
+        return not is_open_quote(sql) and not is_open_comment and is_valid_go_on_lastline
+
+    return False
 
 
 def _multiline_exception(text):

mssqlcli/mssqlcliclient.py

@@ -230,7 +230,8 @@ def _execute_query_execute_request_for(self, query):
         query_has_exception = query_response.exception_message
         query_has_error_messages = query_messages[0].is_error if query_messages else False
         query_has_batch_error = query_response.batch_summaries[0].has_error \
-            if hasattr(query_response, 'batch_summaries') else False
+            if hasattr(query_response, 'batch_summaries') \
+                and len(query_response.batch_summaries) > 0 else False
 
         query_failed = query_has_exception or query_has_batch_error or query_has_error_messages
 
@@ -277,7 +278,8 @@ def _exception_found_in(query_response):
 
     @staticmethod
     def _no_results_found_in(query_response):
-        return not query_response.batch_summaries[0].result_set_summaries
+        return not query_response.batch_summaries \
+               or not query_response.batch_summaries[0].result_set_summaries
 
     @staticmethod
     def _no_rows_found_in(query_response):

mssqlcli/mssqlclirc

@@ -10,13 +10,13 @@ smart_completion = True
 wider_completion_menu = False
 
 # Multi-line mode allows breaking up the sql statements into multiple lines. If
-# this is set to True, then the end of the statements must have a semi-colon.
+# this is set to True, then the end of the statements must have 'GO'.
 # If this is set to False then sql statements can't be split into multiple
 # lines. End of line (return) is considered as the end of the statement.
 multi_line = False
 
 # If multi_line_mode is set to "tsql", in multi-line mode, [Enter] will execute
-# the current input if the input ends in a semicolon.
+# the current input if the input ends in 'GO'.
 # If multi_line_mode is set to "safe", in multi-line mode, [Enter] will always
 # insert a newline, and [Esc] [Enter] or [Alt]-[Enter] must be used to execute
 # a command.

mssqlcli/mssqltoolbar.py

@@ -39,7 +39,7 @@ def get_toolbar_tokens():
             if mssql_cli.multiline_mode == 'safe':
                 result.append((token, ' ([Esc] [Enter] to execute]) '))
             else:
-                result.append((token, ' (Semi-colon [;] will end the line) '))
+                result.append((token, ' ([GO] statement will end the line) '))
 
         if mssql_cli.vi_mode:
             result.append(

mssqlcli/packages/parseutils/utils.py

@@ -113,7 +113,7 @@ def is_open_quote(sql):
 
 def _parsed_is_open_quote(parsed):
     # Look for unmatched single quotes, or unmatched dollar sign quotes
-    return any(tok.match(Token.Error, ("'", "$")) for tok in parsed.flatten())
+    return any(tok.match(Token.Error, ("'", '"', "$")) for tok in parsed.flatten())
 
 
 def parse_partial_identifier(word):

tests/test_multiline.py

@@ -0,0 +1,37 @@
+import pytest
+from mssqlcli.mssqlbuffer import _is_complete
+
+
+class TestMssqlCliMultiline:
+    testdata = [
+        (None, False),
+        ('', False),
+        ('select 1 /* open comment!\ngo', False),
+        ('select 1\ngo -- another comment', True),
+        ('select 1; select 2, "open quote: go', False),
+        ('select 1\n"go"', False),
+        ('select 1; GO', False),
+        ('SELECT 4;\nGO', True),
+        ('select 1\n select 2;\ngo', True),
+        ('select 1;', False),
+        ('select 1 go', False),
+        ('select 1\ngo go go', False),
+        ('GO select 1', False),
+        ('GO', True)
+        # tests below to be enabled when sqlparse supports retaining newlines
+        # when stripping comments (tracking here:
+        # https://github.com/andialbrecht/sqlparse/issues/484):
+        # ('select 3 /* another open comment\n*/   GO', True),
+        # ('select 1\n*/go', False),
+        # ('select 1 /*\nmultiple lines!\n*/go', True)
+    ]
+
+    @staticmethod
+    @pytest.mark.parametrize("query_str, is_complete", testdata)
+    def test_multiline_completeness(query_str, is_complete):
+        """
+        Tests the _is_complete helper method, which parses a T-SQL multiline
+        statement on each newline and determines whether the script should
+        execute.
+        """
+        assert _is_complete(query_str) == is_complete