Compile the LLDB tests out-of-tree.

This patch is the result of a discussion on lldb-dev, see
http://lists.llvm.org/pipermail/lldb-dev/2018-January/013111.html for
background.

For each test (should be eventually: each test configuration) a
separate build directory is created and we execute

  make VPATH=$srcdir/path/to/test -C $builddir/path/to/test -f $srcdir/path/to/test/Makefile -I $srcdir/path/to/test

In order to make this work all LLDB tests need to be updated to find
the executable in the test build directory, since CWD still points at
the test's source directory, which is a requirement for unittest2.

Although we have done extensive testing, I'm expecting that this first
attempt will break a few bots. Please DO NOT HESITATE TO REVERT this
patch in order to get the bots green again. We will likely have to
iterate on this some more.

Differential Revision: https://reviews.llvm.org/D42281

llvm-svn: 323803

1 files changed, 44 insertions, 27 deletions

diff --git a/lldb/packages/Python/lldbsuite/test/plugins/builder_base.py b/lldb/packages/Python/lldbsuite/test/plugins/builder_base.py
index bd6656bd5e8..ab9c39acbc3 100644
--- a/lldb/packages/Python/lldbsuite/test/plugins/builder_base.py
+++ b/lldb/packages/Python/lldbsuite/test/plugins/builder_base.py
@@ -50,13 +50,31 @@ def getArchFlag():
 
     return ("ARCHFLAG=" + archflag) if archflag else ""
 
-
-def getMake():
-    """Returns the name for GNU make"""
+def getMake(test_subdir):
+    """Returns the invocation for GNU make.
+       The argument test_subdir is the relative path to the testcase."""
     if platform.system() == "FreeBSD" or platform.system() == "NetBSD":
-        return "gmake"
+        make = "gmake"
     else:
-        return "make"
+        make = "make"
+
+    # Construct the base make invocation.
+    lldb_test = os.environ["LLDB_TEST"]
+    lldb_build = os.environ["LLDB_BUILD"]
+    if not (lldb_test and lldb_build and test_subdir and
+            (not os.path.isabs(test_subdir))):
+        raise Exception("Could not derive test directories")
+    build_dir = os.path.join(lldb_build, test_subdir)
+    test_dir = os.path.join(lldb_test, test_subdir)
+    # This is a bit of a hack to make inline testcases work.
+    makefile = os.path.join(test_dir, "Makefile")
+    if not os.path.isfile(makefile):
+        makefile = os.path.join(build_dir, "Makefile")
+    return [make,
+            "VPATH="+test_dir,
+            "-C", build_dir,
+            "-I", test_dir,
+            "-f", makefile]
 
 
 def getArchSpec(architecture):
@@ -121,12 +139,13 @@ def buildDefault(
         architecture=None,
         compiler=None,
         dictionary=None,
-        clean=True):
+        clean=True,
+        testdir=None):
     """Build the binaries the default way."""
     commands = []
     if clean:
-        commands.append([getMake(), "clean", getCmdLine(dictionary)])
-    commands.append([getMake(), getArchSpec(architecture),
+        commands.append(getMake(testdir) + ["clean", getCmdLine(dictionary)])
+    commands.append(getMake(testdir) + [getArchSpec(architecture),
                      getCCSpec(compiler), getCmdLine(dictionary)])
 
     runBuildCommands(commands, sender=sender)
@@ -140,12 +159,13 @@ def buildDwarf(
         architecture=None,
         compiler=None,
         dictionary=None,
-        clean=True):
+        clean=True,
+        testdir=None):
     """Build the binaries with dwarf debug info."""
     commands = []
     if clean:
-        commands.append([getMake(), "clean", getCmdLine(dictionary)])
-    commands.append([getMake(), "MAKE_DSYM=NO", getArchSpec(
+        commands.append(getMake(testdir) + ["clean", getCmdLine(dictionary)])
+    commands.append(getMake(testdir) + ["MAKE_DSYM=NO", getArchSpec(
         architecture), getCCSpec(compiler), getCmdLine(dictionary)])
 
     runBuildCommands(commands, sender=sender)
@@ -158,13 +178,17 @@ def buildDwo(
         architecture=None,
         compiler=None,
         dictionary=None,
-        clean=True):
+        clean=True,
+        testdir=None):
     """Build the binaries with dwarf debug info."""
     commands = []
     if clean:
-        commands.append([getMake(), "clean", getCmdLine(dictionary)])
-    commands.append([getMake(), "MAKE_DSYM=NO", "MAKE_DWO=YES", getArchSpec(
-        architecture), getCCSpec(compiler), getCmdLine(dictionary)])
+        commands.append(getMake(testdir) + ["clean", getCmdLine(dictionary)])
+    commands.append(getMake(testdir) +
+                    ["MAKE_DSYM=NO", "MAKE_DWO=YES",
+                     getArchSpec(architecture),
+                     getCCSpec(compiler),
+                     getCmdLine(dictionary)])
 
     runBuildCommands(commands, sender=sender)
     # True signifies that we can handle building dwo.
@@ -176,13 +200,14 @@ def buildGModules(
         architecture=None,
         compiler=None,
         dictionary=None,
-        clean=True):
+        clean=True,
+        testdir=None):
     """Build the binaries with dwarf debug info."""
     commands = []
     if clean:
-        commands.append([getMake(), "clean", getCmdLine(dictionary)])
-    commands.append([getMake(),
-                     "MAKE_DSYM=NO",
+        commands.append(getMake(testdir) + ["clean", getCmdLine(dictionary)])
+    commands.append(getMake(testdir) +
+                    ["MAKE_DSYM=NO",
                      "MAKE_GMODULES=YES",
                      getArchSpec(architecture),
                      getCCSpec(compiler),
@@ -195,12 +220,4 @@ def buildGModules(
 
 def cleanup(sender=None, dictionary=None):
     """Perform a platform-specific cleanup after the test."""
-    #import traceback
-    # traceback.print_stack()
-    commands = []
-    if os.path.isfile("Makefile"):
-        commands.append([getMake(), "clean", getCmdLine(dictionary)])
-
-    runBuildCommands(commands, sender=sender)
-    # True signifies that we can handle cleanup.
     return True