[test] Allow skipTestIfFn to apply to entire classes for skipIfNoSBHeaders

[rupprecht]

Summary

Some test cases are already marked @skipIfNoSBHeaders, but they make use of SBAPI headers in test setup. The setup will fail if the headers are missing, so it is too late to wait until the test case to apply the skip annotation.

In addition to allowing this to apply to entire classes, I also changed all the existing annotations from test cases to test classes where necessary/appropriate.

[DavidSpickett]

LGTM. Do what makes sense to you with the comment.

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

146

This would make more immediate sense if you added the function prototype as well:

# skipIf(condition, reason)

Or if you can figure a way to do the C++ style skipIf(/*condition=*/reason, reason).

[rupprecht]

• Use named args to indicate reason is used as condition

[rupprecht]

Thanks!

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

146

We can use named args. Both the standardized skipIf [1] and LLDB's fork [2] use the same param names so we should be fine if we ever want to drop our fork and use standard python (I wonder if we should do that?)

I still left the comment because I feel like "condition=reason" is still atypical, but using named args makes it less load-bearing of a comment.

[1] https://docs.python.org/3/library/unittest.html?highlight=skipif#unittest.skipIf
[2] https://github.com/llvm/llvm-project/blob/0dff945bbca9e1c00ac76eafd1af61235272b7dd/lldb/third_party/Python/module/unittest2/unittest2/case.py#L86

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

if callable(bugnumber):
         return expectedFailure_impl(bugnumber)
     else:
         return expectedFailure_impl
 
 
 def skipTestIfFn(expected_fn, bugnumber=None):
     def skipTestIfFn_impl(func):
         if isinstance(func, type) and issubclass(func, unittest2.TestCase):
-            raise Exception(
-                "@skipTestIfFn can only be used to decorate a test method")
+            reason = expected_fn()
+            # The return value is the reason (or None if we don't skip), so
+            # reason is used for both args.
+            return unittest2.skipIf(condition=reason, reason=reason)(func)
 
         @wraps(func)
         def wrapper(*args, **kwargs):
             self = args[0]
             if funcutils.requires_self(expected_fn):
                 reason = expected_fn(self)
             else:
                 reason = expected_fn()

lldb/test/API/api/check_public_api_headers/TestPublicAPIHeaders.py

 """Test the integrity of the lldb public api directory containing SB*.h headers.
 
 There should be nothing unwanted there and a simpe main.cpp which includes SB*.h
 should compile and link with the LLDB framework."""
 
 from lldbsuite.test.decorators import *
 from lldbsuite.test.lldbtest import *
 from lldbsuite.test import lldbutil
 
 
+@skipIfNoSBHeaders
 class SBDirCheckerCase(TestBase):
     NO_DEBUG_INFO_TESTCASE = True
 
     def setUp(self):
         TestBase.setUp(self)
         self.source = 'main.cpp'
         self.generateSource(self.source)
 
-    @skipIfNoSBHeaders
     def test_sb_api_directory(self):
         """Test the SB API directory and make sure there's no unwanted stuff."""
 
         # Only proceed if this is an Apple OS, "x86_64", and local platform.
         if not (self.platformIsDarwin() and self.getArchitecture() == "x86_64"):
             self.skipTest("This test is only for LLDB.framework built 64-bit")
         if self.getArchitecture() == "i386":
             self.skipTest(

lldb/test/API/api/multithreaded/TestMultithreaded.py

 """Test the lldb public C++ api breakpoint callbacks."""
 
 # __package__ = "lldbsuite.test"
 
 
 import os
 from lldbsuite.test.decorators import *
 from lldbsuite.test.lldbtest import *
 from lldbsuite.test import lldbutil
 
 
+@skipIfNoSBHeaders
 class SBBreakpointCallbackCase(TestBase):
 
     NO_DEBUG_INFO_TESTCASE = True
 
     def setUp(self):
         TestBase.setUp(self)
         self.generateSource('driver.cpp')
         self.generateSource('listener_test.cpp')
         self.generateSource('test_breakpoint_callback.cpp')
         self.generateSource('test_breakpoint_location_callback.cpp')
         self.generateSource('test_listener_event_description.cpp')
         self.generateSource('test_listener_event_process_state.cpp')
         self.generateSource('test_listener_resume.cpp')
         self.generateSource('test_stop-hook.cpp')
 
     @skipIfRemote
-    @skipIfNoSBHeaders
     # clang-cl does not support throw or catch (llvm.org/pr24538)
     @skipIfWindows
     def test_python_stop_hook(self):
         """Test that you can run a python command in a stop-hook when stdin is File based. """
         self.build_and_test('driver.cpp test_stop-hook.cpp',
                             'test_python_stop_hook')
 
     @skipIfRemote
-    @skipIfNoSBHeaders
     # clang-cl does not support throw or catch (llvm.org/pr24538)
     @skipIfWindows
     def test_breakpoint_callback(self):
         """Test the that SBBreakpoint callback is invoked when a breakpoint is hit. """
         self.build_and_test('driver.cpp test_breakpoint_callback.cpp',
                             'test_breakpoint_callback')
 
     @skipIfRemote
-    @skipIfNoSBHeaders
     # clang-cl does not support throw or catch (llvm.org/pr24538)
     @skipIfWindows
     def test_breakpoint_location_callback(self):
         """Test the that SBBreakpointLocation callback is invoked when a breakpoint is hit. """
         self.build_and_test('driver.cpp test_breakpoint_location_callback.cpp',
                             'test_breakpoint_location_callback')
 
     @skipIfRemote
-    @skipIfNoSBHeaders
     # clang-cl does not support throw or catch (llvm.org/pr24538)
     @skipIfWindows
     @expectedFlakeyFreeBSD
     def test_sb_api_listener_event_description(self):
         """ Test the description of an SBListener breakpoint event is valid."""
         self.build_and_test(
             'driver.cpp listener_test.cpp test_listener_event_description.cpp',
             'test_listener_event_description')
 
     @skipIfRemote
-    @skipIfNoSBHeaders
     # clang-cl does not support throw or catch (llvm.org/pr24538)
     @skipIfWindows
     @expectedFlakeyFreeBSD
     def test_sb_api_listener_event_process_state(self):
         """ Test that a registered SBListener receives events when a process
             changes state.
         """
         self.build_and_test(
             'driver.cpp listener_test.cpp test_listener_event_process_state.cpp',
             'test_listener_event_process_state')
 
     @skipIfRemote
-    @skipIfNoSBHeaders
     # clang-cl does not support throw or catch (llvm.org/pr24538)
     @skipIfWindows
     @expectedFlakeyFreeBSD
     @skipIf(oslist=["linux"]) # flakey
     def test_sb_api_listener_resume(self):
         """ Test that a process can be resumed from a non-main thread. """
         self.build_and_test(
             'driver.cpp listener_test.cpp test_listener_resume.cpp',

lldb/test/API/functionalities/plugins/command_plugin/TestPluginCommands.py

 """
 Test that plugins that load commands work correctly.
 """
 
 import lldb
 from lldbsuite.test.decorators import *
 from lldbsuite.test.lldbtest import *
 from lldbsuite.test import lldbutil
 
 
 class PluginCommandTestCase(TestBase):
 
     def setUp(self):
         TestBase.setUp(self)
-        self.generateSource('plugin.cpp')
 
     @skipIfNoSBHeaders
     # Requires a compatible arch and platform to link against the host's built
     # lldb lib.
     @skipIfHostIncompatibleWithRemote
     @expectedFailureAll(oslist=["windows"], bugnumber="llvm.org/pr24778")
     @no_debug_info_test
     def test_load_plugin(self):
         """Test that plugins that load commands work correctly."""
+        self.generateSource('plugin.cpp')
 
         plugin_name = "plugin"
         if sys.platform.startswith("darwin"):
             plugin_lib_name = "lib%s.dylib" % plugin_name
         else:
             plugin_lib_name = "lib%s.so" % plugin_name
 
         # Invoke the library build rule.