Fix lldb-vscode logging and enable logging for all lldb-vscode tests.

[clayborg]

Summary

This patch fixes logging to log incoming packets which was removed during a refactor.

We also enable logging to a "vscode.txt" file for each lldb-vscode test by creating the log file in the build artifacts directory for each test. This allows users to see the packets for their tests if needed and the log file is in a directory that will be removed after tests have been run.

[clayborg]

Here is an example of where these files end up after running tests:

$ cd lldb-test-build.noindex/
$ find . -name vscode.txt
./tools/lldb-vscode/breakpoint-events/TestVSCode_breakpointEvents.test_breakpoint_events/vscode.txt
./tools/lldb-vscode/launch/TestVSCode_launch.test_shellExpandArguments_enabled/vscode.txt
./tools/lldb-vscode/launch/TestVSCode_launch.test_shellExpandArguments_disabled/vscode.txt
./tools/lldb-vscode/launch/TestVSCode_launch.test_stopOnEntry/vscode.txt
./tools/lldb-vscode/launch/TestVSCode_launch.test_commands/vscode.txt
./tools/lldb-vscode/launch/TestVSCode_launch.test_cwd/vscode.txt
./tools/lldb-vscode/launch/TestVSCode_launch.test_args/vscode.txt
./tools/lldb-vscode/launch/TestVSCode_launch.test_disableSTDIO/vscode.txt
./tools/lldb-vscode/launch/TestVSCode_launch.test_debuggerRoot/vscode.txt
./tools/lldb-vscode/launch/TestVSCode_launch.test_environment/vscode.txt
./tools/lldb-vscode/launch/TestVSCode_launch.test_extra_launch_commands/vscode.txt
./tools/lldb-vscode/launch/TestVSCode_launch.test_sourcePath/vscode.txt
./tools/lldb-vscode/step/TestVSCode_step.test_step/vscode.txt
./tools/lldb-vscode/breakpoint/TestVSCode_setExceptionBreakpoints.test_functionality/vscode.txt
./tools/lldb-vscode/breakpoint/TestVSCode_setFunctionBreakpoints.test_functionality/vscode.txt
./tools/lldb-vscode/breakpoint/TestVSCode_setBreakpoints.test_set_and_clear/vscode.txt
./tools/lldb-vscode/breakpoint/TestVSCode_setBreakpoints.test_functionality/vscode.txt
./tools/lldb-vscode/breakpoint/TestVSCode_setFunctionBreakpoints.test_set_and_clear/vscode.txt
./tools/lldb-vscode/attach/TestVSCode_attach.test_by_pid/vscode.txt
./tools/lldb-vscode/attach/TestVSCode_attach.test_by_name/vscode.txt
./tools/lldb-vscode/variables/TestVSCode_variables.test_scopes_variables_setVariable_evaluate/vscode.txt
./tools/lldb-vscode/stackTrace/TestVSCode_stackTrace.test_stackTrace/vscode.txt

[wallace]

Cool

[jankratochvil]

lldb/tools/lldb-vscode/VSCode.cpp

136

I had this chunk in a local patch, thanks.

lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/lldbvscode_testcase.py

 
 from lldbsuite.test.lldbtest import *
 import os
 import vscode
 
 
 class VSCodeTestCaseBase(TestBase):
 
     NO_DEBUG_INFO_TESTCASE = True
 
     def create_debug_adaptor(self):
         '''Create the Visual Studio Code debug adaptor'''
         self.assertTrue(os.path.exists(self.lldbVSCodeExec),
                         'lldb-vscode must exist')
+        log_file_path = self.getBuildArtifact('vscode.txt')
         self.vscode = vscode.DebugAdaptor(
-            executable=self.lldbVSCodeExec, init_commands=self.setUpCommands())
+            executable=self.lldbVSCodeExec, init_commands=self.setUpCommands(),
+            log_file=log_file_path)
 
     def build_and_create_debug_adaptor(self):
         self.build()
         self.create_debug_adaptor()
 
     def set_source_breakpoints(self, source_path, lines, condition=None,
                                hitCondition=None):
         '''Sets source breakpoints and returns an array of strings containing
def get_dict_value(self, d, key_path):
             if key in value:
                 value = value[key]
             else:
                 self.assertTrue(key in value,
                                 'key "%s" from key_path "%s" not in "%s"' % (
                                     key, key_path, d))
         return value
 
-    def get_stackFrames_and_totalFramesCount(self, threadId=None, startFrame=None, 
+    def get_stackFrames_and_totalFramesCount(self, threadId=None, startFrame=None,
                         levels=None, dump=False):
         response = self.vscode.request_stackTrace(threadId=threadId,
                                                   startFrame=startFrame,
                                                   levels=levels,
                                                   dump=dump)
         if response:
             stackFrames = self.get_dict_value(response, ['body', 'stackFrames'])
             totalFrames = self.get_dict_value(response, ['body', 'totalFrames'])

lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/vscode.py

def request_testGetTargetBreakpoints(self):
         return self.send_recv(command_dict)
 
     def terminate(self):
         self.send.close()
         # self.recv.close()
 
 
 class DebugAdaptor(DebugCommunication):
-    def __init__(self, executable=None, port=None, init_commands=[]):
+    def __init__(self, executable=None, port=None, init_commands=[], log_file=None):
         self.process = None
         if executable is not None:
+            adaptor_env = os.environ.copy()
+            if log_file:
+                adaptor_env['LLDBVSCODE_LOG'] = log_file
             self.process = subprocess.Popen([executable],
                                             stdin=subprocess.PIPE,
                                             stdout=subprocess.PIPE,
-                                            stderr=subprocess.PIPE)
+                                            stderr=subprocess.PIPE,
+                                            env=adaptor_env)
             DebugCommunication.__init__(self, self.process.stdout,
                                         self.process.stdin, init_commands)
         elif port is not None:
             s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
             s.connect(('127.0.0.1', port))
             DebugCommunication.__init__(self, s.makefile('r'), s.makefile('w'),
                 init_commands)
 

lldb/tools/lldb-vscode/VSCode.cpp

if (!llvm::to_integer(length_str, length))
     return json_str;
 
   if (!input.read_expected(log.get(), "\r\n"))
     return json_str;
 
   if (!input.read_full(log.get(), length, json_str))
     return json_str;
 
+  if (log) {
+    *log << "--> " << std::endl
+         << "Content-Length: " << length << "\r\n\r\n"
+         << json_str << std::endl;
+  }
+
   return json_str;
 }
 
 // "OutputEvent": {
 //   "allOf": [ { "$ref": "#/definitions/Event" }, {
 //     "type": "object",
 //     "description": "Event message for 'output' event type. The event
 //                     indicates that the target has produced some output.",