Add MiSyntaxTestCase.test_lldbmi_output_grammar test (MI)

[ki.stfu]

Summary

This patch adds a new test and fixes extra new-line before exit

[ki.stfu]

Friendly ping.

[ki.stfu]

Friendly ping.

[ki.stfu]

Rebase against ToT

[ki.stfu]

I plan to commit it this week. Does anyone has any objections?

[abidh]

This test is failing on Linux. I am trying to understand how this test is supposed to work. Please add some more comments and then I can debug why it is failing on Linux.

test/tools/lldb-mi/syntax/TestMiSyntax.py

108 ↗

(On Diff #30784)

This is not being used.

114 ↗

(On Diff #30784)

Add some comments to describe what these functions are meant to do.

116 ↗

(On Diff #30784)

What it means to be in command state?

tools/lldb-mi/MIDriver.cpp

595 ↗

(On Diff #30784)

You can commit this line separately. It does not seem to related to this patch.

[ki.stfu]

test/tools/lldb-mi/syntax/TestMiSyntax.py

108 ↗

(On Diff #30784)

It refers to line #156. I may add an assert(matched_pattern == error) there.

116 ↗

(On Diff #30784)

That lldb-mi has nothing to do until we type a next command. For example, after lldb-mi startup.

tools/lldb-mi/MIDriver.cpp

595 ↗

(On Diff #30784)

It causes a failure of the added test.

[ki.stfu]

Rebase against ToT

[ki.stfu]

Rebase against ToT; Apply autopep8

lldb/trunk/packages/Python/lldbsuite/test/tools/lldb-mi/syntax/TestMiSyntax.py

 """
 Test that the lldb-mi driver understands MI command syntax.
 """
 
 from __future__ import print_function
 
 
 import lldbmi_testcase
 from lldbsuite.test.decorators import *
 from lldbsuite.test.lldbtest import *
 from lldbsuite.test import lldbutil
+from functools import reduce
 
 
 class MiSyntaxTestCase(lldbmi_testcase.MiTestCaseBase):
 
     mydir = TestBase.compute_mydir(__file__)
 
     @skipIfWindows  # llvm.org/pr24452: Get lldb-mi tests working on Windows
     @skipIfFreeBSD  # llvm.org/pr22411: Failure presumably due to known thread races
def test_lldbmi_process_output(self):
 
         # Run
         self.runCmd("-exec-run")
         self.expect("\^running")
 
         # Test that a process output is wrapped correctly
         self.expect("\@\"'\\\\r\\\\n\"")
         self.expect("\@\"` - it's \\\\\\\\n\\\\x12\\\\\"\\\\\\\\\\\\\"")
+
+    @skipIfWindows  # llvm.org/pr24452: Get lldb-mi tests working on Windows
+    @skipIfFreeBSD  # llvm.org/pr22411: Failure presumably due to known thread races
+    def test_lldbmi_output_grammar(self):
+        """Test that 'lldb-mi --interpreter' uses standard output syntax."""
+
+        self.spawnLldbMi(args=None)
+        self.child.setecho(False)
+
+        # Run all commands simultaneously
+        self.runCmd("-unknown-command")
+        self.runCmd("-file-exec-and-symbols %s" % self.myexe)
+        self.runCmd("-break-insert -f main")
+        self.runCmd("-gdb-set target-async off")
+        self.runCmd("-exec-run")
+        self.runCmd("-gdb-set target-async on")
+        self.runCmd("-exec-continue")
+        self.runCmd("-gdb-exit")
+
+        # Test that the program's output matches to the following pattern:
+        # ( async-record | stream-record )* [ result-record ] "(gdb)" nl
+        async_record = "^[0-9]*(\*|\+|=).+?\n"  # 1
+        stream_record = "^(~|@|&).+?\n"         # 2
+        result_record = "^[0-9]*\^.+?\n"        # 3
+        prompt = "^\(gdb\)\r\n"                 # 4
+        command = "^\r\n"                       # 5 (it looks like empty line for pexpect)
+        error = "^.+?\n"                        # 6
+        import pexpect                          # 7 (EOF)
+        all_patterns = [
+            async_record,
+            stream_record,
+            result_record,
+            prompt,
+            command,
+            error,
+            pexpect.EOF]
+
+        # Routines to get a bit-mask for the specified list of patterns
+        def get_bit(pattern): return all_patterns.index(pattern)
+        def get_mask(pattern): return 1 << get_bit(pattern)
+        def or_op(x, y): return x | y
+        def get_state(*args): return reduce(or_op, map(get_mask, args))
+
+        next_state = get_state(command)
+        while True:
+            it = self.expect(all_patterns)
+            matched_pattern = all_patterns[it]
+
+            # Check that state is acceptable
+            if not (next_state & get_mask(matched_pattern)):
+                self.fail(
+                    "error: inconsistent pattern '%s' for state %#x (matched string: %s)" %
+                    (repr(matched_pattern), next_state, self.child.after))
+            elif matched_pattern == async_record or matched_pattern == stream_record:
+                next_state = get_state(
+                    async_record,
+                    stream_record,
+                    result_record,
+                    prompt)
+            elif matched_pattern == result_record:
+                # FIXME lldb-mi prints async-records out of turn
+                # ```
+                #   ^done
+                #   (gdb)
+                #   ^running
+                #   =thread-group-started,id="i1",pid="13875"
+                #   (gdb)
+                # ```
+                # Therefore to pass that test I changed the grammar's rule:
+                #   next_state = get_state(prompt)
+                # to:
+                next_state = get_state(async_record, prompt)
+            elif matched_pattern == prompt:
+                # FIXME lldb-mi prints the prompt out of turn
+                # ```
+                #   ^done
+                #   (gdb)
+                #   ^running
+                #   (gdb)
+                #   (gdb)
+                # ```
+                # Therefore to pass that test I changed the grammar's rule:
+                #   next_state = get_state(async_record, stream_record, result_record, command, pexpect.EOF)
+                # to:
+                next_state = get_state(
+                    async_record,
+                    stream_record,
+                    result_record,
+                    prompt,
+                    command,
+                    pexpect.EOF)
+            elif matched_pattern == command:
+                next_state = get_state(
+                    async_record,
+                    stream_record,
+                    result_record)
+            elif matched_pattern == pexpect.EOF:
+                break
+            else:
+                self.fail("error: pexpect returned an unknown state")

lldb/trunk/tools/lldb-mi/MIDriver.cpp

bool CMIDriver::DoMainLoop() {
   }
 
   // Signal that the application is shutting down
   DoAppQuit();
 
   // Close and wait for the workers to stop
   StopWorkerThreads();
 
-  // Ensure that a new line is sent as the last act of the dying driver
-  m_rStdOut.WriteMIResponse("\n", false);
-
   return MIstatus::success;
 }
 
 //++
 //------------------------------------------------------------------------------------
 // Details: Set things in motion, set state etc that brings *this driver (and
 // the
 //          application) to a tidy shutdown.