Port TestBatchMode to PExpectTest class

[labath]

Summary

I'm doing this mainly for consistency, but there are also other cleanups
that will be enabled by this (e.g., the automatic setting of
clang-modules-cache-path setting).

packages/Python/lldbsuite/test/driver/batch_mode/TestBatchMode.py

 """
 Test that the lldb driver's batch mode works correctly.
 """
 
 from __future__ import print_function
 
 
 import lldb
 from lldbsuite.test.decorators import *
 from lldbsuite.test.lldbtest import *
 from lldbsuite.test import lldbutil
+from lldbsuite.test.lldbpexpect import PExpectTest
 
 
-class DriverBatchModeTest (TestBase):
+class DriverBatchModeTest(PExpectTest):
 
     mydir = TestBase.compute_mydir(__file__)
-
-    def setUp(self):
-        # Call super's setUp().
-        TestBase.setUp(self)
-        # Our simple source filename.
-        self.source = 'main.c'
-        self.victim = None
-
-    def expect_string(self, string):
-        import pexpect
-        """This expects for "string", with timeout & EOF being test fails."""
-        try:
-            self.child.expect_exact(string)
-        except pexpect.EOF:
-            self.fail("Got EOF waiting for '%s'" % (string))
-        except pexpect.TIMEOUT:
-            self.fail("Timed out waiting for '%s'" % (string))
+    source = 'main.c'
 
     @skipIfRemote  # test not remote-ready llvm.org/pr24813
     @expectedFlakeyFreeBSD("llvm.org/pr25172 fails rarely on the buildbot")
-    @expectedFlakeyLinux("llvm.org/pr25172")
-    @expectedFailureAll(
-        oslist=["windows"],
-        bugnumber="llvm.org/pr22274: need a pexpect replacement for windows")
     def test_batch_mode_run_crash(self):
         """Test that the lldb driver's batch mode works correctly."""
         self.build()
-        self.setTearDownCleanup()
 
-        import pexpect
         exe = self.getBuildArtifact("a.out")
         module_cache = self.getBuildArtifact("module.cache")
-        prompt = "(lldb) "
 
         # Pass CRASH so the process will crash and stop in batch mode.
-        run_commands = ' -b -o "settings set symbols.clang-modules-cache-path %s" -o "break set -n main" -o "run" -o "continue" -k "frame var touch_me_not"' % module_cache
-        self.child = pexpect.spawn(
-            '%s %s %s %s -- CRASH' %
-            (lldbtest_config.lldbExec, self.lldbOption, run_commands, exe))
+        extra_args = ['-b',
+            '-o', "settings set symbols.clang-modules-cache-path '%s'"%module_cache,
+            '-o', 'break set -n main',
+            '-o', 'run',
+            '-o', 'continue',
+            '-k', 'frame var touch_me_not',
+            '--', 'CRASH',
+        ]
+        self.launch(executable=exe, extra_args=extra_args)
         child = self.child
 
         # We should see the "run":
-        self.expect_string("run")
+        child.expect_exact("run")
         # We should have hit the breakpoint & continued:
-        self.expect_string("continue")
+        child.expect_exact("continue")
         # The App should have crashed:
-        self.expect_string("About to crash")
+        child.expect_exact("About to crash")
         # The -k option should have printed the frame variable once:
-        self.expect_string('(char *) touch_me_not')
+        child.expect_exact('(char *) touch_me_not')
         # Then we should have a live prompt:
-        self.expect_string(prompt)
-        self.child.sendline("frame variable touch_me_not")
-        self.expect_string('(char *) touch_me_not')
-
-        self.deletePexpectChild()
+        self.expect_prompt()
+        self.expect("frame variable touch_me_not", substrs='(char *) touch_me_not')
 
     @skipIfRemote  # test not remote-ready llvm.org/pr24813
     @expectedFlakeyFreeBSD("llvm.org/pr25172 fails rarely on the buildbot")
-    @expectedFlakeyLinux("llvm.org/pr25172")
-    @expectedFailureAll(
-        oslist=["windows"],
-        bugnumber="llvm.org/pr22274: need a pexpect replacement for windows")
     def test_batch_mode_run_exit(self):
         """Test that the lldb driver's batch mode works correctly."""
         self.build()
-        self.setTearDownCleanup()
 
-        import pexpect
         exe = self.getBuildArtifact("a.out")
         module_cache = self.getBuildArtifact("module.cache")
-        prompt = "(lldb) "
 
         # Now do it again, and make sure if we don't crash, we quit:
-        run_commands = ' -b -o "settings set symbols.clang-modules-cache-path %s" -o "break set -n main" -o "run" -o "continue" '%module_cache
-        self.child = pexpect.spawn(
-            '%s %s %s %s -- NOCRASH' %
-            (lldbtest_config.lldbExec, self.lldbOption, run_commands, exe))
+        extra_args = ['-b',
+            '-o', "settings set symbols.clang-modules-cache-path '%s'"%module_cache,
+            '-o', 'break set -n main',
+            '-o', 'run',
+            '-o', 'continue',
+            '--', 'NOCRASH',
+        ]
+        self.launch(executable=exe, extra_args=extra_args)
         child = self.child
 
         # We should see the "run":
-        self.expect_string("run")
+        child.expect_exact("run")
         # We should have hit the breakpoint & continued:
-        self.expect_string("continue")
+        child.expect_exact("continue")
         # The App should have not have crashed:
-        self.expect_string("Got there on time and it did not crash.")
-        # Then we should have a live prompt:
-        self.expect_string("exited")
-        index = self.child.expect([pexpect.EOF, pexpect.TIMEOUT])
-        self.assertTrue(
-            index == 0,
-            "lldb didn't close on successful batch completion.")
+        child.expect_exact("Got there on time and it did not crash.")
+
+        # Then lldb should exit.
+        child.expect_exact("exited")
+        import pexpect
+        child.expect(pexpect.EOF)
 
     def closeVictim(self):
         if self.victim is not None:
             self.victim.close()
             self.victim = None
 
     @skipIfRemote  # test not remote-ready llvm.org/pr24813
     @expectedFlakeyFreeBSD("llvm.org/pr25172 fails rarely on the buildbot")
-    @expectedFlakeyLinux("llvm.org/pr25172")
     @expectedFailureNetBSD
-    @expectedFailureAll(
-        oslist=["windows"],
-        bugnumber="llvm.org/pr22274: need a pexpect replacement for windows")
     def test_batch_mode_attach_exit(self):
         """Test that the lldb driver's batch mode works correctly."""
         self.build()
         self.setTearDownCleanup()
 
-        import pexpect
         exe = self.getBuildArtifact("a.out")
         module_cache = self.getBuildArtifact("module.cache")
-        prompt = "(lldb) "
 
-        # Finally, start up the process by hand, attach to it, and wait for its completion.
+        # Start up the process by hand, attach to it, and wait for its completion.
         # Attach is funny, since it looks like it stops with a signal on most Unixen so
         # care must be taken not to treat that as a reason to exit batch mode.
 
         # Start up the process by hand and wait for it to get to the wait loop.
-
+        import pexpect
         self.victim = pexpect.spawn('%s WAIT' % (exe))
         if self.victim is None:
             self.fail("Could not spawn ", exe, ".")
 
         self.addTearDownHook(self.closeVictim)
 
         self.victim.expect("PID: ([0-9]+) END")
-        if self.victim.match is None:
-            self.fail("Couldn't get the target PID.")
-
         victim_pid = int(self.victim.match.group(1))
 
         self.victim.expect("Waiting")
 
-        run_commands = ' -b  -o "settings set symbols.clang-modules-cache-path %s" -o "process attach -p %d" -o "breakpoint set --file %s -p \'Stop here to unset keep_waiting\' -N keep_waiting" -o "continue" -o "break delete keep_waiting" -o "expr keep_waiting = 0" -o "continue" ' % (
-            module_cache, victim_pid, self.source)
-        self.child = pexpect.spawn(
-            '%s %s %s %s' %
-            (lldbtest_config.lldbExec,
-             self.lldbOption,
-             run_commands,
-             exe))
-
+        extra_args = [
+            '-b',
+            '-o', "settings set symbols.clang-modules-cache-path '%s'"%module_cache,
+            '-o', 'process attach -p %d'%victim_pid,
+            '-o', "breakpoint set --file '%s' -p 'Stop here to unset keep_waiting' -N keep_waiting"%self.source,
+            '-o', 'continue',
+            '-o', 'break delete keep_waiting',
+            '-o', 'expr keep_waiting = 0',
+            '-o', 'continue',
+        ]
+        self.launch(executable=exe, extra_args=extra_args)
         child = self.child
 
-        # We should see the "run":
-        self.expect_string("attach")
+        child.expect_exact("attach")
 
-        self.expect_string(prompt + "continue")
+        child.expect_exact(self.PROMPT + "continue")
 
-        self.expect_string(prompt + "continue")
+        child.expect_exact(self.PROMPT + "continue")
 
         # Then we should see the process exit:
-        self.expect_string("Process %d exited with status" % (victim_pid))
-
-        victim_index = self.victim.expect([pexpect.EOF, pexpect.TIMEOUT])
-        self.assertTrue(victim_index == 0, "Victim didn't really exit.")
+        child.expect_exact("Process %d exited with status" % (victim_pid))
 
-        index = self.child.expect([pexpect.EOF, pexpect.TIMEOUT])
-        self.assertTrue(
-            index == 0,
-            "lldb didn't close on successful batch completion.")
+        self.victim.expect(pexpect.EOF)
+        child.expect(pexpect.EOF)

packages/Python/lldbsuite/test/lldbpexpect.py

else:
     class PExpectTest(TestBase):
 
         NO_DEBUG_INFO_TESTCASE = True
         PROMPT = "(lldb) "
 
         def expect_prompt(self):
             self.child.expect_exact(self.PROMPT)
 
-        def launch(self, executable=None, timeout=30, dimensions=None):
+        def launch(self, executable=None, extra_args=None, timeout=30, dimensions=None):
             logfile = getattr(sys.stdout, 'buffer',
                               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]
+            if extra_args is not None:
+                args.extend(extra_args)
             self.child = pexpect.spawn(
                     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: