[lldb] Modify the `skipIfRemote` decorator so we can skip all PExpect tests.

[JDevlieghere]

Summary

This patch modifies the skipIfRemote decorator so it can apply to a whole class, which allows us to skip all PExpect tests as a whole.

[davide]

I assume we're still allowing to put the decorator on a test-by-test basis, and that seems the case from what I see.
If so, LG.

[JDevlieghere]

In D85365#2197948, @davide wrote:

I assume we're still allowing to put the decorator on a test-by-test basis, and that seems the case from what I see.
If so, LG.

Yup. Thanks!

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

 def skipIfOutOfTreeDebugserver(func):
     """Decorate the item to skip tests if using an out-of-tree debugserver."""
     def is_out_of_tree_debugserver():
         return "out-of-tree debugserver" if lldbtest_config.out_of_tree_debugserver else None
     return skipTestIfFn(is_out_of_tree_debugserver)(func)
 
 def skipIfRemote(func):
     """Decorate the item to skip tests if testing remotely."""
-    def is_remote():
-        return "skip on remote platform" if lldb.remote_platform else None
-    return skipTestIfFn(is_remote)(func)
+    return unittest2.skipIf(lldb.remote_platform, "skip on remote platform")(func)
 
 
 def skipIfNoSBHeaders(func):
     """Decorate the item to mark tests that should be skipped when LLDB is built with no SB API headers."""
     def are_sb_headers_missing():
         if lldb.remote_platform:
             return "skip because SBHeaders tests make no sense remotely"
 

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

 from __future__ import absolute_import
 
 # System modules
 import os
 import sys
 
 # Third-party modules
 import six
 
 # LLDB Modules
 import lldb
 from .lldbtest import *
 from . import lldbutil
+from lldbsuite.test.decorators import *
 
 if sys.platform.startswith('win32'):
     # llvm.org/pr22274: need a pexpect replacement for windows
     class PExpectTest(object):
         pass
 else:
     import pexpect
 
+    @skipIfRemote
     class PExpectTest(TestBase):
 
         NO_DEBUG_INFO_TESTCASE = True
         PROMPT = "(lldb) "
 
         def expect_prompt(self):
             self.child.expect_exact(self.PROMPT)
 

lldb/test/API/commands/expression/multiline-completion/TestMultilineCompletion.py

 """
 Test completion for multiline expressions.
 """
 
 import lldb
 from lldbsuite.test.decorators import *
 from lldbsuite.test.lldbtest import *
 from lldbsuite.test.lldbpexpect import PExpectTest
 
 class MultilineCompletionTest(PExpectTest):
 
     mydir = TestBase.compute_mydir(__file__)
 
     # PExpect uses many timeouts internally and doesn't play well
     # under ASAN on a loaded machine..
     @skipIfAsan
-    @skipIfRemote  # test is written to explicitly "run" the binary
     @skipIfEditlineSupportMissing
     def test_basic_completion(self):
         """Test that we can complete a simple multiline expression"""
         self.build()
 
         self.launch(executable=self.getBuildArtifact("a.out"), dimensions=(100,500))
         self.expect("b main", substrs=["Breakpoint 1", "address ="])
         self.expect("run", substrs=["stop reason ="])

lldb/test/API/commands/gui/basic/TestGuiBasic.py

 class BasicGuiCommandTest(PExpectTest):
 
     mydir = TestBase.compute_mydir(__file__)
 
     # PExpect uses many timeouts internally and doesn't play well
     # under ASAN on a loaded machine..
     @skipIfAsan
     @skipIfCursesSupportMissing
-    @skipIfRemote # "run" command will not work correctly for remote debug
     def test_gui(self):
         self.build()
 
         self.launch(executable=self.getBuildArtifact("a.out"), dimensions=(100,500))
         self.expect('br set -f main.c -p "// Break here"', substrs=["Breakpoint 1", "address ="])
         self.expect("run", substrs=["stop reason ="])
 
 

lldb/test/API/commands/gui/basicdebug/TestGuiBasicDebug.py

 class TestGuiBasicDebugCommandTest(PExpectTest):
 
     mydir = TestBase.compute_mydir(__file__)
 
     # PExpect uses many timeouts internally and doesn't play well
     # under ASAN on a loaded machine..
     @skipIfAsan
     @skipIfCursesSupportMissing
-    @skipIfRemote # "run" command will not work correctly for remote debug
     @expectedFailureAll(archs=["aarch64"], oslist=["linux"])
     def test_gui(self):
         self.build()
 
         self.launch(executable=self.getBuildArtifact("a.out"), dimensions=(100,500))
         self.expect('br set -f main.c -p "// Break here"', substrs=["Breakpoint 1", "address ="])
         self.expect("run", substrs=["stop reason ="])
 

lldb/test/API/commands/gui/breakpoints/TestGuiBreakpoints.py

 class TestGuiBasicDebugCommandTest(PExpectTest):
 
     mydir = TestBase.compute_mydir(__file__)
 
     # PExpect uses many timeouts internally and doesn't play well
     # under ASAN on a loaded machine..
     @skipIfAsan
     @skipIfCursesSupportMissing
-    @skipIfRemote # "run" command will not work correctly for remote debug
     def test_gui(self):
         self.build()
 
         self.launch(executable=self.getBuildArtifact("a.out"), dimensions=(100,500))
         self.expect('br set -o true -f main.c -p "// First break here"', substrs=["Breakpoint 1", "address ="])
         self.expect("run", substrs=["stop reason ="])
 
         self.child.sendline("breakpoint list")

lldb/test/API/driver/batch_mode/TestBatchMode.py

 from lldbsuite.test.lldbpexpect import PExpectTest
 
 
 class DriverBatchModeTest(PExpectTest):
 
     mydir = TestBase.compute_mydir(__file__)
     source = 'main.c'
 
-    @skipIfRemote  # test not remote-ready llvm.org/pr24813
     @expectedFlakeyFreeBSD("llvm.org/pr25172 fails rarely on the buildbot")
     def test_batch_mode_run_crash(self):
         """Test that the lldb driver's batch mode works correctly."""
         self.build()
 
         exe = self.getBuildArtifact("a.out")
 
         # Pass CRASH so the process will crash and stop in batch mode.
def test_batch_mode_run_crash(self):
         # The App should have crashed:
         child.expect_exact("About to crash")
         # The -k option should have printed the frame variable once:
         child.expect_exact('(char *) touch_me_not')
         # Then we should have a live prompt:
         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")
     def test_batch_mode_run_exit(self):
         """Test that the lldb driver's batch mode works correctly."""
         self.build()
 
         exe = self.getBuildArtifact("a.out")
 
         # Now do it again, and make sure if we don't crash, we quit:
def test_batch_mode_run_exit(self):
         # The App should have not have crashed:
         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)
 
-    @skipIfRemote
     @expectedFlakeyFreeBSD("llvm.org/pr25172 fails rarely on the buildbot")
     def test_batch_mode_launch_stop_at_entry(self):
         """Test that the lldb driver's batch mode works correctly for process launch."""
         self.build()
 
         exe = self.getBuildArtifact("a.out")
 
         # Launch with the option '--stop-at-entry' stops with a signal (usually SIGSTOP)
         # that should be suppressed since it doesn't imply a crash and
         # this is not a reason to exit batch mode.
         extra_args = ['-b',
             '-o', 'process launch --stop-at-entry',
             '-o', 'continue',
         ]
         self.launch(executable=exe, extra_args=extra_args)
         child = self.child
 
         # Check that the process has been launched:
         child.expect("Process ([0-9]+) launched:")
         # We should have continued:
         child.expect_exact("continue")
         # The App should have not have crashed:
         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")
     @expectedFailureNetBSD
     def test_batch_mode_attach_exit(self):
         """Test that the lldb driver's batch mode works correctly."""
         self.build()
         self.setTearDownCleanup()
 
         exe = self.getBuildArtifact("a.out")