dotest: improvements to the pexpect tests

Summary:
While working on r370054, i've found it frustrating that the test output
was compeletely unhelpful in case of failures. Therefore I've decided to
improve that. In this I reuse the PExpectTest class, which was one of
our mechanisms for running pexpect tests, but which has gotten orhpaned
in the mean time.

I've replaced the existing send methods with a "expect" method, which
I've tried to design so that it has a similar interface to the expect
method in regular non-pexpect dotest tests (as it essentially does
something very similar). I've kept the ability to dump the transcript of
the pexpect communication to stdout in the "trace" mode, as that is a
very handy way to figure out what the test is doing. I've also removed
the "expect_string" method used in the existing tests -- I've found this
to be unhelpful because it hides the message that would be normally
displayed by the EOF exception. Although vebose, this message includes
some important information, like what strings we were searching for,
what were the last bits of lldb output, etc. I've also beefed up the
class to automatically disable the debug info test duplication, and
auto-skip tests when the host platform does not support pexpect.

This patch ports TestMultilineCompletion and TestIOHandlerCompletion to
the new class. It also deletes TestFormats as it is not testing anything
(definitely not formats) -- it was committed with the test code
commented out (r228207), and then the testing code was deleted in
r356000.

Reviewers: teemperor, JDevlieghere, davide

Subscribers: aprantl, lldb-commits

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

llvm-svn: 370449

1 files changed, 31 insertions, 66 deletions

diff --git a/lldb/packages/Python/lldbsuite/test/lldbpexpect.py b/lldb/packages/Python/lldbsuite/test/lldbpexpect.py
index ce73654bdbe..bb50f47e02e 100644
--- a/lldb/packages/Python/lldbsuite/test/lldbpexpect.py
+++ b/lldb/packages/Python/lldbsuite/test/lldbpexpect.py
@@ -13,82 +13,47 @@ from .lldbtest import *
 from . import lldbutil
 
 if sys.platform.startswith('win32'):
-    class PExpectTest(TestBase):
+    # llvm.org/pr22274: need a pexpect replacement for windows
+    class PExpectTest(object):
         pass
 else:
     import pexpect
 
     class PExpectTest(TestBase):
 
-        mydir = TestBase.compute_mydir(__file__)
-
-        def setUp(self):
-            TestBase.setUp(self)
+        NO_DEBUG_INFO_TESTCASE = True
+        PROMPT = "(lldb) "
 
-        def launchArgs(self):
-            return ""
+        def expect_prompt(self):
+            self.child.expect_exact(self.PROMPT)
 
-        def launch(self, timeout=None):
-            if timeout is None:
-                timeout = 30
+        def launch(self, executable=None, timeout=30, dimensions=None):
             logfile = sys.stdout if self.TraceOn() else None
+            args = ['--no-lldbinit', '--no-use-colors']
+            for cmd in self.setUpCommands():
+                args += ['-O', cmd]
+            if executable is not None:
+                args += ['--file', executable]
             self.child = pexpect.spawn(
-                '%s --no-use-colors %s' %
-                (lldbtest_config.lldbExec, self.launchArgs()), logfile=logfile)
-            self.child.timeout = timeout
-            self.timeout = timeout
-
-        def expect(self, patterns=None, timeout=None, exact=None):
-            if patterns is None:
-                return None
-            if timeout is None:
-                timeout = self.timeout
-            if exact is None:
-                exact = False
-            if exact:
-                return self.child.expect_exact(patterns, timeout=timeout)
-            else:
-                return self.child.expect(patterns, timeout=timeout)
-
-        def expectall(self, patterns=None, timeout=None, exact=None):
-            if patterns is None:
-                return None
-            if timeout is None:
-                timeout = self.timeout
-            if exact is None:
-                exact = False
-            for pattern in patterns:
-                self.expect(pattern, timeout=timeout, exact=exact)
-
-        def sendimpl(
-                self,
-                sender,
-                command,
-                patterns=None,
-                timeout=None,
-                exact=None):
-            sender(command)
-            return self.expect(patterns=patterns, timeout=timeout, exact=exact)
-
-        def send(self, command, patterns=None, timeout=None, exact=None):
-            return self.sendimpl(
-                self.child.send,
-                command,
-                patterns,
-                timeout,
-                exact)
-
-        def sendline(self, command, patterns=None, timeout=None, exact=None):
-            return self.sendimpl(
-                self.child.sendline,
-                command,
-                patterns,
-                timeout,
-                exact)
-
-        def quit(self, gracefully=None):
-            if gracefully is None:
-                gracefully = True
+                    lldbtest_config.lldbExec, args=args, logfile=logfile,
+                    timeout=timeout, dimensions=dimensions)
+            self.expect_prompt()
+            for cmd in self.setUpCommands():
+                self.child.expect_exact(cmd)
+                self.expect_prompt()
+            if executable is not None:
+                self.child.expect_exact("target create")
+                self.child.expect_exact("Current executable set to")
+                self.expect_prompt()
+
+        def expect(self, cmd, substrs=None):
+            self.child.sendline(cmd)
+            if substrs is not None:
+                for s in substrs:
+                    self.child.expect_exact(s)
+            self.expect_prompt()
+
+        def quit(self, gracefully=True):
             self.child.sendeof()
             self.child.close(force=not gracefully)
             self.child = None