Add lldb-mi/lldb-server test folders to PATH before in dotest.py

[ki.stfu]

Summary

This patch allows not specify search path in each lldb-mi test. It makes tests easier.

This fix was requested by vharron.

All test pass on OS X.

[vharron]

Can you make the requested changes?

test/dotest.py

933 ↗

(On Diff #21595)

Maybe scriptPath should be renamed to lldbTestRoot, this would improve understanding

945 ↗

(On Diff #21595)

Comment: Adding test/tools/lldb-mi to the path makes it easy to "import lldbmi_testcase" from the Mi tests

946 ↗

(On Diff #21595)

Comment: Adding test/tools/lldb-server to the path makes it easy to "import lldbgdbserverutils" from the lldb-server tests

[ki.stfu]

test/dotest.py

933 ↗

(On Diff #21595)

I think we should leave it as is, because scriptPath can be taken from env variable DOTEST_SCRIPT_DIR (see line 910).

If we do it, it will be strange why

lldbTestRoot = os.environ["DOTEST_SCRIPT_DIR"]

[ki.stfu]

Add comments

[ki.stfu]

Rebase against ToT

[clayborg]

A few rename changes and this looks good.

test/dotest.py

935 ↗

(On Diff #21695)

Can we rename this to toolsLLDBMIPath?

936 ↗

(On Diff #21695)

Can we rename this to toolsLLDBServerPath?

[ki.stfu]

test/dotest.py

935 ↗

(On Diff #21695)

Why? Look at lines 965-967. I think I follow for the naming convention.

[clayborg]

Anything that is an anocronym that is in the middle of a name should be all caps. So feel free to update the other variables that might not be following this convention.

LLDB and MI should always be caps.

[ki.stfu]

Rename toolsLldbMiPath/toolsLldbServerPath to toolsLLDBMIPath/toolsLLDBServerPath

[clayborg]

Looks good.

[clayborg]

Phabricator isn't allowing me to select "Accept Revision" for some reason...

lldb/trunk/test/dotest.py

else:
         os.environ["LLDB_TEST"] = scriptPath
 
     # Set up the LLDB_SRC environment variable, so that the tests can locate
     # the LLDB source code.
     os.environ["LLDB_SRC"] = os.path.join(sys.path[0], os.pardir)
 
     pluginPath = os.path.join(scriptPath, 'plugins')
     pexpectPath = os.path.join(scriptPath, 'pexpect-2.4')
+    toolsLLDBMIPath = os.path.join(scriptPath, 'tools', 'lldb-mi')
+    toolsLLDBServerPath = os.path.join(scriptPath, 'tools', 'lldb-server')
 
     # Put embedded pexpect at front of the load path so we ensure we
     # use that version.
     sys.path.insert(0, pexpectPath)
 
-    # Append script dir and plugin dir to the sys.path.
+    # Append script dir, plugin dir, lldb-mi dir and lldb-server dir to the sys.path.
     sys.path.append(scriptPath)
     sys.path.append(pluginPath)
+    sys.path.append(toolsLLDBMIPath)     # Adding test/tools/lldb-mi to the path makes it easy
+                                         # to "import lldbmi_testcase" from the MI tests
+    sys.path.append(toolsLLDBServerPath) # Adding test/tools/lldb-server to the path makes it easy
+                                         # to "import lldbgdbserverutils" from the lldb-server tests
 
     # This is our base name component.
     base = os.path.abspath(os.path.join(scriptPath, os.pardir))
 
     # These are for xcode build directories.
     xcode3_build_dir = ['build']
     xcode4_build_dir = ['build', 'lldb', 'Build', 'Products']
     dbg = ['Debug']

lldb/trunk/test/tools/lldb-mi/breakpoint/TestMiBreak.py

 """
 Test lldb-mi -break-xxx commands.
 """
 
-# adjust path for lldbmi_testcase.py
-import sys, os.path
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
-
 import lldbmi_testcase
 from lldbtest import *
 import unittest2
 
 class MiBreakTestCase(lldbmi_testcase.MiTestCaseBase):
 
     mydir = TestBase.compute_mydir(__file__)
 

lldb/trunk/test/tools/lldb-mi/control/TestMiExec.py

 """
 Test lldb-mi -exec-xxx commands.
 """
 
-# adjust path for lldbmi_testcase.py
-import sys, os.path
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
-
 import lldbmi_testcase
 from lldbtest import *
 import unittest2
 
 class MiExecTestCase(lldbmi_testcase.MiTestCaseBase):
 
     mydir = TestBase.compute_mydir(__file__)
 

lldb/trunk/test/tools/lldb-mi/data/TestMiData.py

 """
 Test lldb-mi -data-xxx commands.
 """
 
-# adjust path for lldbmi_testcase.py
-import sys, os.path
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
-
 import lldbmi_testcase
 from lldbtest import *
 import unittest2
 
 class MiDataTestCase(lldbmi_testcase.MiTestCaseBase):
 
     mydir = TestBase.compute_mydir(__file__)
 

lldb/trunk/test/tools/lldb-mi/interpreter/TestMiInterpreterExec.py

 """
 Test lldb-mi -interpreter-exec command.
 """
 
-# adjust path for lldbmi_testcase.py
-import sys, os.path
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
-
 import lldbmi_testcase
 from lldbtest import *
 import unittest2
 
 class MiInterpreterExecTestCase(lldbmi_testcase.MiTestCaseBase):
 
     mydir = TestBase.compute_mydir(__file__)
 

lldb/trunk/test/tools/lldb-mi/signal/TestMiSignal.py

 """
 Test that the lldb-mi handles signals properly.
 """
 
-# adjust path for lldbmi_testcase.py
-import sys, os.path
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
-
 import lldbmi_testcase
 from lldbtest import *
 import unittest2
 
 class MiSignalTestCase(lldbmi_testcase.MiTestCaseBase):
 
     mydir = TestBase.compute_mydir(__file__)
 
class MiSignalTestCase(lldbmi_testcase.MiTestCaseBase):
 
     @lldbmi_test
     @expectedFailureWindows("llvm.org/pr22274: need a pexpect replacement for windows")
     @unittest2.skipUnless(sys.platform.startswith("darwin"), "requires Darwin")
     def test_lldbmi_stopped_when_stopatentry_remote(self):
         """Test that 'lldb-mi --interpreter' notifies after it was stopped on entry (remote)."""
 
         # Prepare debugserver
-        sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..", "lldb-server")))
         import lldbgdbserverutils
         debugserver_exe = lldbgdbserverutils.get_debugserver_exe()
         if not debugserver_exe:
             raise Exception("debugserver not found")
         hostname = "localhost"
         import random
         port = 12000 + random.randint(0,3999) # the same as GdbRemoteTestCaseBase.get_next_port
         import pexpect
class MiSignalTestCase(lldbmi_testcase.MiTestCaseBase):
 
     @lldbmi_test
     @expectedFailureWindows("llvm.org/pr22274: need a pexpect replacement for windows")
     @unittest2.skipUnless(sys.platform.startswith("darwin"), "requires Darwin")
     def test_lldbmi_stopped_when_segfault_remote(self):
         """Test that 'lldb-mi --interpreter' notifies after it was stopped when segfault occurred (remote)."""
 
         # Prepare debugserver
-        sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..", "lldb-server")))
         import lldbgdbserverutils
         debugserver_exe = lldbgdbserverutils.get_debugserver_exe()
         if not debugserver_exe:
             raise Exception("debugserver not found")
         hostname = "localhost"
         import random
         port = 12000 + random.randint(0,3999) # the same as GdbRemoteTestCaseBase.get_next_port
         import pexpect

lldb/trunk/test/tools/lldb-mi/stack/TestMiStack.py

 """
 Test lldb-mi -stack-xxx commands.
 """
 
-# adjust path for lldbmi_testcase.py
-import sys, os.path
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
-
 import lldbmi_testcase
 from lldbtest import *
 import unittest2
 
 class MiStackTestCase(lldbmi_testcase.MiTestCaseBase):
 
     mydir = TestBase.compute_mydir(__file__)
 

lldb/trunk/test/tools/lldb-mi/startup_options/TestMiStartupOptions.py

 """
 Test lldb-mi startup options.
 """
 
-# adjust path for lldbmi_testcase.py
-import sys, os.path
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
-
 import lldbmi_testcase
 from lldbtest import *
 import unittest2
 
 class MiStartupOptionsTestCase(lldbmi_testcase.MiTestCaseBase):
 
     mydir = TestBase.compute_mydir(__file__)
 

lldb/trunk/test/tools/lldb-mi/symbol/TestMiSymbol.py

 """
 Test lldb-mi -symbol-xxx commands.
 """
 
-# adjust path for lldbmi_testcase.py
-import sys, os.path
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
-
 import lldbmi_testcase
 from lldbtest import *
 import unittest2
 
 class MiSymbolTestCase(lldbmi_testcase.MiTestCaseBase):
 
     mydir = TestBase.compute_mydir(__file__)
 

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

 """
 Test that the lldb-mi driver understands MI command syntax.
 """
 
-# adjust path for lldbmi_testcase.py
-import sys, os.path
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
-
 import lldbmi_testcase
 from lldbtest import *
 import unittest2
 
 class MiSyntaxTestCase(lldbmi_testcase.MiTestCaseBase):
 
     mydir = TestBase.compute_mydir(__file__)
 

lldb/trunk/test/tools/lldb-mi/variable/TestMiVar.py

 """
 Test lldb-mi -var-xxx commands.
 """
 
-# adjust path for lldbmi_testcase.py
-import sys, os.path
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
-
 import lldbmi_testcase
 from lldbtest import *
 import unittest2
 
 class MiVarTestCase(lldbmi_testcase.MiTestCaseBase):
 
     mydir = TestBase.compute_mydir(__file__)
 

lldb/trunk/test/tools/lldb-server/commandline/TestStubReverseConnect.py

-# Add the directory above ours to the python library path since we
-# will import from there.
-import os.path
-import sys
-sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
-
 import gdbremote_testcase
 import lldbgdbserverutils
 import re
 import select
 import socket
 import time
 from lldbtest import *
 

lldb/trunk/test/tools/lldb-server/commandline/TestStubSetSID.py

 import unittest2
 
-# Add the directory above ours to the python library path since we
-# will import from there.
-import os.path
-import sys
-sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
-
 import gdbremote_testcase
 import lldbgdbserverutils
 import os
 import select
 import tempfile
 import time
 from lldbtest import *
 

lldb/trunk/test/tools/lldb-server/inferior-crash/TestGdbRemoteAbort.py

 import unittest2
 
-# Add the directory above ours to the python library path since we
-# will import from there.
-import os.path
-import sys
-sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
-
 import gdbremote_testcase
 import signal
 from lldbtest import *
 
 class TestGdbRemoteAbort(gdbremote_testcase.GdbRemoteTestCaseBase):
     mydir = TestBase.compute_mydir(__file__)
 
     def inferior_abort_received(self):

lldb/trunk/test/tools/lldb-server/inferior-crash/TestGdbRemoteSegFault.py

 import unittest2
 
-# Add the directory above ours to the python library path since we
-# will import from there.
-import os.path
-import sys
-sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
-
 import gdbremote_testcase
 import signal
 from lldbtest import *
 
 class TestGdbRemoteSegFault(gdbremote_testcase.GdbRemoteTestCaseBase):
     mydir = TestBase.compute_mydir(__file__)
 
     GDB_REMOTE_STOP_CODE_BAD_ACCESS = 0x91

lldb/trunk/test/tools/lldb-server/test/test_lldbgdbserverutils.py

 import os.path
 import re
 import sys
 
-# adjust path for embedded unittest2
-sys.path.append(os.path.join(os.path.dirname(os.path.realpath(__file__)), '..', '..', '..'))
 import unittest2
 
-# adjust path for lldbgdbserverutils.py
-sys.path.append(os.path.join(os.path.dirname(os.path.realpath(__file__)), '..'))
 from lldbgdbserverutils import *
 
 
 class TestLldbGdbServerUtils(unittest2.TestCase):
     def test_entry_exact_payload_match(self):
         entry = GdbRemoteEntry(is_send_to_remote=False, exact_payload="$OK#9a")
         entry.assert_match(self, "$OK#9a")