[lldb][test] Create a separate LLDB_TEST_SRC var to allow moving tests.

[rupprecht]

Summary

This creates a separate LLDB_TEST_SRC var to match the existing LLDB_TEST var. LLDB_TEST points to the test framework, LLDB_TEST_SRC points to the tests themselves.

The var points to the same place, but a future patch will move the tree + update var.

[merge_guards_bot]

Build result: pass - 60563 tests passed, 0 failed and 726 were skipped.

Log files: console-log.txt, CMakeCache.txt

[labath]

Hmm... given the lua thread on lldb-dev, maybe we should slow down here, and consider the potential relationship of these tests and the hypothetical lua tests that come to be. One of the reasons the current tests are so deeply nested was that Zach was trying to future-proof ourselves for addition of new scripting languages (at that time, Java was being floated around, but the idea never took off the ground). I'd hate to move these tests now, only to have to move them around again in a couple of weeks to make room for lua...

[rupprecht]

In D71150#1774575, @labath wrote:

Hmm... given the lua thread on lldb-dev, maybe we should slow down here, and consider the potential relationship of these tests and the hypothetical lua tests that come to be. One of the reasons the current tests are so deeply nested was that Zach was trying to future-proof ourselves for addition of new scripting languages (at that time, Java was being floated around, but the idea never took off the ground). I'd hate to move these tests now, only to have to move them around again in a couple of weeks to make room for lua...

I don't *think* this patch is affected by that discussion, except for the speculative comment to update lldb_test_root = os.path.join(lldb_root, "test", "API", "test") with the next patch. I'll followup with the next patch discussion.

[labath]

In D71150#1778351, @rupprecht wrote:

In D71150#1774575, @labath wrote:

Hmm... given the lua thread on lldb-dev, maybe we should slow down here, and consider the potential relationship of these tests and the hypothetical lua tests that come to be. One of the reasons the current tests are so deeply nested was that Zach was trying to future-proof ourselves for addition of new scripting languages (at that time, Java was being floated around, but the idea never took off the ground). I'd hate to move these tests now, only to have to move them around again in a couple of weeks to make room for lua...

I don't *think* this patch is affected by that discussion, except for the speculative comment to update lldb_test_root = os.path.join(lldb_root, "test", "API", "test") with the next patch. I'll followup with the next patch discussion.

Yes, that seems reasonable.

[rupprecht]

lldb/packages/Python/lldbsuite/__init__.py

32

... I'm finally planning to submit this (checking now that the patch still passes), with an updated path based on D71151.

This patch is intended to be NFC, I'll retitle it when submitting.

lldb/packages/Python/lldbsuite/__init__.py

while True:
         test_path = os.path.join(lldb_root, "use_lldb_suite_root.py")
         if os.path.isfile(test_path):
             return lldb_root
     return None
 
 # lldbsuite.lldb_root refers to the root of the git/svn source checkout
 lldb_root = find_lldb_root()
 
-# lldbsuite.lldb_test_root refers to the root of the python test tree
+# lldbsuite.lldb_test_src_root refers to the root of the python test case tree
+# (i.e. the actual unit tests).
 lldb_test_root = os.path.join(
     lldb_root,
     "packages",
     "Python",
     "lldbsuite",
     "test")
+# TODO(rupprecht): update the above definition after moving test cases:
+# lldb_test_root = os.path.join(lldb_root, "test", "API")

lldb/packages/Python/lldbsuite/test/dotest.py

if "DOTEST_PROFILE" in os.environ and "DOTEST_SCRIPT_DIR" in os.environ:
         scriptPath = os.environ["DOTEST_SCRIPT_DIR"]
     else:
         scriptPath = os.path.dirname(os.path.realpath(__file__))
     if not scriptPath.endswith('test'):
         print("This script expects to reside in lldb's test directory.")
         sys.exit(-1)
 
     os.environ["LLDB_TEST"] = scriptPath
+    os.environ["LLDB_TEST_SRC"] = lldbsuite.lldb_test_root
 
     # Set up the root build directory.
     builddir = configuration.test_build_dir
     if not configuration.test_build_dir:
         raise Exception("test_build_dir is not set")
     os.environ["LLDB_BUILD"] = os.path.abspath(configuration.test_build_dir)
 
     # Set up the LLDB_SRC environment variable, so that the tests can locate

lldb/packages/Python/lldbsuite/test/lldbtest.py

class Base(unittest2.TestCase):
     @staticmethod
     def compute_mydir(test_file):
         '''Subclasses should call this function to correctly calculate the
            required "mydir" attribute as follows:
 
             mydir = TestBase.compute_mydir(__file__)
         '''
         # /abs/path/to/packages/group/subdir/mytest.py -> group/subdir
-        rel_prefix = test_file[len(os.environ["LLDB_TEST"]) + 1:]
+        rel_prefix = test_file[len(os.environ["LLDB_TEST_SRC"]) + 1:]
         return os.path.dirname(rel_prefix)
 
     def TraceOn(self):
         """Returns True if we are in trace mode (tracing detailed test execution)."""
         return traceAlways
 
     @classmethod
     def setUpClass(cls):
         """
         Python unittest framework class setup fixture.
         Do current directory manipulation.
         """
         # Fail fast if 'mydir' attribute is not overridden.
         if not cls.mydir or len(cls.mydir) == 0:
             raise Exception("Subclasses must override the 'mydir' attribute.")
 
         # Save old working directory.
         cls.oldcwd = os.getcwd()
 
-        # Change current working directory if ${LLDB_TEST} is defined.
-        # See also dotest.py which sets up ${LLDB_TEST}.
-        if ("LLDB_TEST" in os.environ):
-            full_dir = os.path.join(os.environ["LLDB_TEST"],
+        # Change current working directory if ${LLDB_TEST_SRC} is defined.
+        # See also dotest.py which sets up ${LLDB_TEST_SRC}.
+        if ("LLDB_TEST_SRC" in os.environ):
+            full_dir = os.path.join(os.environ["LLDB_TEST_SRC"],
                                     cls.mydir)
             if traceAlways:
                 print("Change dir to:", full_dir, file=sys.stderr)
             os.chdir(full_dir)
 
         # Set platform context.
         cls.platformContext = lldbplatformutil.createPlatformContext()
 
def setPlatformWorkingDir(self):
             # list of files we have to remove during test runs.
             shell_cmd = lldb.SBPlatformShellCommand(
                 "rm %s/*" % remote_test_dir)
             lldb.remote_platform.Run(shell_cmd)
         self.addTearDownHook(clean_working_directory)
 
     def getSourceDir(self):
         """Return the full path to the current test."""
-        return os.path.join(os.environ["LLDB_TEST"], self.mydir)
+        return os.path.join(os.environ["LLDB_TEST_SRC"], self.mydir)
 
     def getBuildDirBasename(self):
         return self.__class__.__module__ + "." + self.testMethodName
 
     def getBuildDir(self):
         """Return the full path to the current test."""
         return os.path.join(os.environ["LLDB_BUILD"], self.mydir,
                             self.getBuildDirBasename())
class Base(unittest2.TestCase):
 
     def getLogBasenameForCurrentTest(self, prefix=None):
         """
         returns a partial path that can be used as the beginning of the name of multiple
         log files pertaining to this test
 
         <session-dir>/<arch>-<compiler>-<test-file>.<test-class>.<test-method>
         """
-        dname = os.path.join(os.environ["LLDB_TEST"],
+        dname = os.path.join(os.environ["LLDB_TEST_SRC"],
                              os.environ["LLDB_SESSION_DIRNAME"])
         if not os.path.isdir(dname):
             os.mkdir(dname)
 
         components = []
         if prefix is not None:
             components.append(prefix)
         for c in configuration.session_file_format:

lldb/packages/Python/lldbsuite/test/plugins/builder_base.py

"""Returns the invocation for GNU make.
        and its filename stem."""
     if platform.system() == "FreeBSD" or platform.system() == "NetBSD":
         make = "gmake"
     else:
         make = "make"
 
     # Construct the base make invocation.
     lldb_test = os.environ["LLDB_TEST"]
+    lldb_test_src = os.environ["LLDB_TEST_SRC"]
     lldb_build = os.environ["LLDB_BUILD"]
-    if not (lldb_test and lldb_build and test_subdir and test_name and
-            (not os.path.isabs(test_subdir))):
+    if not (lldb_test and lldb_test_src and lldb_build and test_subdir and
+            test_name and (not os.path.isabs(test_subdir))):
         raise Exception("Could not derive test directories")
     build_dir = os.path.join(lldb_build, test_subdir, test_name)
-    src_dir = os.path.join(lldb_test, test_subdir)
+    src_dir = os.path.join(lldb_test_src, test_subdir)
     # This is a bit of a hack to make inline testcases work.
     makefile = os.path.join(src_dir, "Makefile")
     if not os.path.isfile(makefile):
         makefile = os.path.join(build_dir, "Makefile")
     return [make,
             "VPATH="+src_dir,
             "-C", build_dir,
             "-I", src_dir,