Move TestCommandScriptImmediateOutput from PExpectTest to TestBase

[fjricci]

Summary

This should make TestCommandScriptImmediateOutput more consistent
with the rest of the test suite.

[zturner]

You can probably remove the expected failure windows if this is no longer
going to be a pexpect test.

[fjricci]

Remove windows expected failure

[granata.enrico]

Why are we trying to do this in the first place?

The entire purpose of this test is to verify the immediate output to the console.

If you want to test the output to a file instead, make a separate test case, that would be fine. But I'd rather much leave this test alone.

[fjricci]

As of r264351, this test already writes to both the console and to files (since the file writing is testing the same python file io bugs tested by the console writing). I can make another patch to split it out if that's preferable.

However, this patch is intended to move the test off of PExpect, because I noticed that sendline() has some issues when running with older versions of lldb (like 3.8, for example), regardless of whether we're testing files or the console.

[granata.enrico]

My personal preference would be to split up the test cases. I'd really like to keep testing the immediate output to console scenario since it is interesting for - e.g. - kernel debugging at Apple.

[fjricci]

Ok, I'll put up a new revision to split out the test cases.

[fjricci]

Would it be acceptable to split it into two test methods inside the same test case? Both are testing writing immediate output from a command script, just one is immediate output to the console and the other is immediate output to a file.

[granata.enrico]

Sure, that works. My only concern is that I'd like to keep the current PExpect-let's test writing to the console and see what happens behavior

Whatever you need to do to split the test is fine by me

[fjricci]

Oh I see. I don't think the file-writing is going to work in the PExpect mode (for some reason, it looks like the sendline calls aren't always being received/processed correctly by lldb, while runCmd works fine), so it's probably better to split out into a different test case then.

[granata.enrico]

I don't think we are seeing this behavior on OS X (the failure to process sendline() calls) - but Todd Fiala might know more about that since he keeps a careful eye over our bots.

Longer term, it would be interesting to find out *why* those issues are happening. For now, a test case split sounds reasonable.

[fjricci]

I do observe the sendline() behavior on OSX, but only when I cherry-pick these bug-fixes onto the 3.8 branch. It seems to work fine on master.

packages/Python/lldbsuite/test/functionalities/command_script_immediate_output/TestCommandScriptImmediateOutput.py

 """
 Test that LLDB correctly allows scripted commands to set an immediate output file
 """
 
 from __future__ import print_function
 
 
 
 import os, time
 import lldb
 from lldbsuite.test.decorators import *
 from lldbsuite.test.lldbtest import *
 from lldbsuite.test.lldbpexpect import *
 from lldbsuite.test import lldbutil
 
-class CommandScriptImmediateOutputTestCase (PExpectTest):
+class CommandScriptImmediateOutputTestCase (TestBase):
 
     mydir = TestBase.compute_mydir(__file__)
 
     def setUp(self):
         # Call super's setUp().
-        PExpectTest.setUp(self)
+        TestBase.setUp(self)
 
     @skipIfRemote # test not remote-ready llvm.org/pr24813
     @expectedFailureAll(oslist=["windows"], bugnumber="llvm.org/pr22274: need a pexpect replacement for windows")
     @expectedFailureAll(oslist=["freebsd","linux"], bugnumber="llvm.org/pr26139")
     def test_command_script_immediate_output (self):
         """Test that LLDB correctly allows scripted commands to set an immediate output file."""
-        self.launch(timeout=60)
-
         script = os.path.join(os.getcwd(), 'custom_command.py')
-        prompt = "\(lldb\) "
                                                                       
-        self.sendline('command script import %s' % script, patterns=[prompt])
-        self.sendline('command script add -f custom_command.command_function mycommand', patterns=[prompt])
-        self.sendline('mycommand', patterns='this is a test string, just a test string')
-        self.sendline('command script delete mycommand', patterns=[prompt])
+        self.runCmd('command script import %s' % script)
+        self.runCmd('command script add -f custom_command.command_function mycommand')
+        self.expect('mycommand', substrs = ['this is a test string, just a test string'])
+        self.runCmd('command script delete mycommand')
 
         test_files = {os.path.join(os.getcwd(), 'read.txt')        :'r',
                       os.path.join(os.getcwd(), 'write.txt')       :'w',
                       os.path.join(os.getcwd(), 'append.txt')      :'a',
                       os.path.join(os.getcwd(), 'write_plus.txt')  :'w+',
                       os.path.join(os.getcwd(), 'read_plus.txt')   :'r+',
                       os.path.join(os.getcwd(), 'append_plus.txt') :'a+'}
 
         starter_string = 'Starter Garbage\n'
         write_string   = 'writing to file with mode: '
 
         for path, mode in test_files.iteritems():
             with open(path, 'w+') as init:
                 init.write(starter_string)
 
-        self.sendline('command script add -f custom_command.write_file mywrite', patterns=[prompt])
+        self.runCmd('command script add -f custom_command.write_file mywrite')
+        self.runCmd('command script list')
         for path, mode in test_files.iteritems():
-            command = 'mywrite "' + path + '" ' + mode
-
-            self.sendline(command, patterns=[prompt])
-
-        self.sendline('command script delete mywrite', patterns=[prompt])
+            self.runCmd('mywrite ' + path + ' ' + mode)
 
-        self.quit(gracefully=False)
+        self.runCmd('command script delete mywrite')
 
         for path, mode in test_files.iteritems():
             with open(path, 'r') as result:
                 if mode in ['r', 'a', 'a+']:
                     self.assertEquals(result.readline(), starter_string)
                 if mode in ['w', 'w+', 'r+', 'a', 'a+']:
                     self.assertEquals(result.readline(), write_string + mode + '\n')
 
             self.assertTrue(os.path.isfile(path))
             os.remove(path)