[lldb/test] Reduce boilerplate in lldb-server tests

Nearly all of our lldb-server tests have two flavours (lldb-server and
debugserver). Each of them is tagged with an appropriate decorator, and
each of them starts with a call to a matching "init" method. The init
calls are mandatory, and it's not possible to meaningfully combine them
with a different decorator.

This patch leverages the existing decorators to also tag the tests with
the appropriate debug server tag, similar to how we do with debug info
flavours. This allows us to make the "init" calls from inside the common
setUp method.

Author: labath

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

@@ -373,11 +373,13 @@ def should_skip_simulator_test():
 
 def debugserver_test(func):
     """Decorate the item as a debugserver test."""
+    func.debug_server = "debugserver"
     return add_test_categories(["debugserver"])(func)
 
 
 def llgs_test(func):
     """Decorate the item as a lldb-server test."""
+    func.debug_server = "llgs"
     return add_test_categories(["llgs"])(func)
 
 

lldb/packages/Python/lldbsuite/test/tools/lldb-server/gdbremote_testcase.py

@@ -80,6 +80,10 @@ def isVerboseLoggingRequested(self):
         return any(("gdb-remote" in channel)
                    for channel in lldbtest_config.channels)
 
+    def getDebugServer(self):
+        method = getattr(self, self.testMethodName)
+        return getattr(method, "debug_server", None)
+
     def setUp(self):
         super(GdbRemoteTestCaseBase, self).setUp()
 
@@ -114,6 +118,12 @@ def setUp(self):
         else:
             self.stub_hostname = "localhost"
 
+        debug_server = self.getDebugServer()
+        if debug_server == "debugserver":
+            self._init_debugserver_test()
+        else:
+            self._init_llgs_test()
+
     def tearDown(self):
         self.logger.removeHandler(self._verbose_log_handler)
         self._verbose_log_handler = None
@@ -150,7 +160,7 @@ def reset_test_sequence(self):
         self.test_sequence = GdbRemoteTestSequence(self.logger)
 
 
-    def init_llgs_test(self):
+    def _init_llgs_test(self):
         reverse_connect = True
         if lldb.remote_platform:
             # Reverse connections may be tricky due to firewalls/NATs.
@@ -198,7 +208,7 @@ def init_llgs_test(self):
 
         self.reverse_connect = reverse_connect
 
-    def init_debugserver_test(self):
+    def _init_debugserver_test(self):
         self.debug_monitor_exe = get_debugserver_exe()
         if not self.debug_monitor_exe:
             self.skipTest("debugserver exe not found")

lldb/test/API/commands/target/auto-install-main-executable/TestAutoInstallMainExecutable.py

@@ -19,7 +19,6 @@ class TestAutoInstallMainExecutable(gdbremote_testcase.GdbRemoteTestCaseBase):
     @expectedFailureAll(hostoslist=["windows"], triple='.*-android')
     def test_target_auto_install_main_executable(self):
         self.build()
-        self.init_llgs_test()
 
         # Manually install the modified binary.
         working_dir = lldb.remote_platform.GetWorkingDirectory()

lldb/test/API/tools/lldb-server/TestAppleSimulatorOSType.py

@@ -75,7 +75,6 @@ def check_simulator_ostype(self, sdk, platform, arch='x86_64'):
         self.assertIsNotNone(pid)
 
         # Launch debug monitor attaching to the simulated process
-        self.init_debugserver_test()
         server = self.connect_to_debug_monitor(attach_pid=pid)
 
         # Setup packet sequences

lldb/test/API/tools/lldb-server/TestGdbRemoteAttach.py

@@ -53,14 +53,12 @@ def attach_with_vAttach(self):
 
     @debugserver_test
     def test_attach_with_vAttach_debugserver(self):
-        self.init_debugserver_test()
         self.build()
         self.set_inferior_startup_attach_manually()
         self.attach_with_vAttach()
 
     @llgs_test
     def test_attach_with_vAttach_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.set_inferior_startup_attach_manually()
         self.attach_with_vAttach()

lldb/test/API/tools/lldb-server/TestGdbRemoteAuxvSupport.py

@@ -104,7 +104,6 @@ def supports_auxv(self):
     @skipIfWindows # no auxv support.
     @llgs_test
     def test_supports_auxv_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.set_inferior_startup_launch()
         self.supports_auxv()
@@ -120,7 +119,6 @@ def auxv_data_is_correct_size(self):
 
     @debugserver_test
     def test_auxv_data_is_correct_size_debugserver(self):
-        self.init_debugserver_test()
         self.build()
         self.set_inferior_startup_launch()
         self.auxv_data_is_correct_size()
@@ -129,7 +127,6 @@ def test_auxv_data_is_correct_size_debugserver(self):
     @expectedFailureNetBSD
     @llgs_test
     def test_auxv_data_is_correct_size_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.set_inferior_startup_launch()
         self.auxv_data_is_correct_size()
@@ -160,7 +157,6 @@ def auxv_keys_look_valid(self):
 
     @debugserver_test
     def test_auxv_keys_look_valid_debugserver(self):
-        self.init_debugserver_test()
         self.build()
         self.set_inferior_startup_launch()
         self.auxv_keys_look_valid()
@@ -169,7 +165,6 @@ def test_auxv_keys_look_valid_debugserver(self):
     @expectedFailureNetBSD
     @llgs_test
     def test_auxv_keys_look_valid_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.set_inferior_startup_launch()
         self.auxv_keys_look_valid()
@@ -209,7 +204,6 @@ def auxv_chunked_reads_work(self):
 
     @debugserver_test
     def test_auxv_chunked_reads_work_debugserver(self):
-        self.init_debugserver_test()
         self.build()
         self.set_inferior_startup_launch()
         self.auxv_chunked_reads_work()
@@ -218,7 +212,6 @@ def test_auxv_chunked_reads_work_debugserver(self):
     @expectedFailureNetBSD
     @llgs_test
     def test_auxv_chunked_reads_work_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.set_inferior_startup_launch()
         self.auxv_chunked_reads_work()

lldb/test/API/tools/lldb-server/TestGdbRemoteExitCode.py

@@ -24,13 +24,11 @@ def inferior_exit_0(self):
     @debugserver_test
     @skipIfDarwinEmbedded # <rdar://problem/34539270> lldb-server tests not updated to work on ios etc yet
     def test_inferior_exit_0_debugserver(self):
-        self.init_debugserver_test()
         self.build()
         self.inferior_exit_0()
 
     @llgs_test
     def test_inferior_exit_0_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.inferior_exit_0()
 
@@ -50,12 +48,10 @@ def inferior_exit_42(self):
     @debugserver_test
     @skipIfDarwinEmbedded # <rdar://problem/34539270> lldb-server tests not updated to work on ios etc yet
     def test_inferior_exit_42_debugserver(self):
-        self.init_debugserver_test()
         self.build()
         self.inferior_exit_42()
 
     @llgs_test
     def test_inferior_exit_42_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.inferior_exit_42()

lldb/test/API/tools/lldb-server/TestGdbRemoteExpeditedRegisters.py

@@ -86,14 +86,12 @@ def stop_notification_contains_any_registers(self):
 
     @debugserver_test
     def test_stop_notification_contains_any_registers_debugserver(self):
-        self.init_debugserver_test()
         self.build()
         self.set_inferior_startup_launch()
         self.stop_notification_contains_any_registers()
 
     @llgs_test
     def test_stop_notification_contains_any_registers_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.set_inferior_startup_launch()
         self.stop_notification_contains_any_registers()
@@ -112,14 +110,12 @@ def stop_notification_contains_no_duplicate_registers(self):
     @debugserver_test
     def test_stop_notification_contains_no_duplicate_registers_debugserver(
             self):
-        self.init_debugserver_test()
         self.build()
         self.set_inferior_startup_launch()
         self.stop_notification_contains_no_duplicate_registers()
 
     @llgs_test
     def test_stop_notification_contains_no_duplicate_registers_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.set_inferior_startup_launch()
         self.stop_notification_contains_no_duplicate_registers()
@@ -129,14 +125,12 @@ def stop_notification_contains_pc_register(self):
 
     @debugserver_test
     def test_stop_notification_contains_pc_register_debugserver(self):
-        self.init_debugserver_test()
         self.build()
         self.set_inferior_startup_launch()
         self.stop_notification_contains_pc_register()
 
     @llgs_test
     def test_stop_notification_contains_pc_register_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.set_inferior_startup_launch()
         self.stop_notification_contains_pc_register()
@@ -148,14 +142,12 @@ def stop_notification_contains_fp_register(self):
 
     @debugserver_test
     def test_stop_notification_contains_fp_register_debugserver(self):
-        self.init_debugserver_test()
         self.build()
         self.set_inferior_startup_launch()
         self.stop_notification_contains_fp_register()
 
     @llgs_test
     def test_stop_notification_contains_fp_register_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.set_inferior_startup_launch()
         self.stop_notification_contains_fp_register()
@@ -165,14 +157,12 @@ def stop_notification_contains_sp_register(self):
 
     @debugserver_test
     def test_stop_notification_contains_sp_register_debugserver(self):
-        self.init_debugserver_test()
         self.build()
         self.set_inferior_startup_launch()
         self.stop_notification_contains_sp_register()
 
     @llgs_test
     def test_stop_notification_contains_sp_register_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.set_inferior_startup_launch()
         self.stop_notification_contains_sp_register()
@@ -183,7 +173,6 @@ def test_stop_notification_contains_sp_register_llgs(self):
     def test_stop_notification_contains_vg_register_llgs(self):
         if not self.isAArch64SVE():
             self.skipTest('SVE registers must be supported.')
-        self.init_llgs_test()
         self.build()
         self.set_inferior_startup_launch()
         self.stop_notification_contains_aarch64_vg_register()

lldb/test/API/tools/lldb-server/TestGdbRemoteHostInfo.py

@@ -102,22 +102,19 @@ def validate_darwin_minimum_host_info_keys(self, host_info_dict):
     @skipIfDarwinEmbedded # <rdar://problem/34539270> lldb-server tests not updated to work on ios etc yet
     @debugserver_test
     def test_qHostInfo_returns_at_least_one_key_val_pair_debugserver(self):
-        self.init_debugserver_test()
         self.build()
         self.get_qHostInfo_response()
 
     @skipIfDarwinEmbedded # <rdar://problem/34539270> lldb-server tests not updated to work on ios etc yet
     @llgs_test
     def test_qHostInfo_returns_at_least_one_key_val_pair_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.get_qHostInfo_response()
 
     @skipUnlessDarwin
     @skipIfDarwinEmbedded # <rdar://problem/34539270> lldb-server tests not updated to work on ios etc yet
     @debugserver_test
     def test_qHostInfo_contains_darwin_required_keys_debugserver(self):
-        self.init_debugserver_test()
         self.build()
         host_info_dict = self.get_qHostInfo_response()
         self.validate_darwin_minimum_host_info_keys(host_info_dict)
@@ -126,7 +123,6 @@ def test_qHostInfo_contains_darwin_required_keys_debugserver(self):
     @skipIfDarwinEmbedded # <rdar://problem/34539270> lldb-server tests not updated to work on ios etc yet
     @llgs_test
     def test_qHostInfo_contains_darwin_required_keys_llgs(self):
-        self.init_llgs_test()
         self.build()
         host_info_dict = self.get_qHostInfo_response()
         self.validate_darwin_minimum_host_info_keys(host_info_dict)

lldb/test/API/tools/lldb-server/TestGdbRemoteKill.py

@@ -46,14 +46,12 @@ def attach_commandline_kill_after_initial_stop(self):
 
     @debugserver_test
     def test_attach_commandline_kill_after_initial_stop_debugserver(self):
-        self.init_debugserver_test()
         self.build()
         self.set_inferior_startup_attach()
         self.attach_commandline_kill_after_initial_stop()
 
     @llgs_test
     def test_attach_commandline_kill_after_initial_stop_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.set_inferior_startup_attach()
         self.attach_commandline_kill_after_initial_stop()

lldb/test/API/tools/lldb-server/TestGdbRemoteModuleInfo.py

@@ -37,7 +37,6 @@ def module_info(self):
 
     @llgs_test
     def test_module_info(self):
-        self.init_llgs_test()
         self.build()
         self.set_inferior_startup_launch()
         self.module_info()

lldb/test/API/tools/lldb-server/TestGdbRemoteProcessInfo.py

@@ -36,13 +36,11 @@ def qProcessInfo_returns_running_process(self):
     @debugserver_test
     @skipIfDarwinEmbedded # <rdar://problem/34539270> lldb-server tests not updated to work on ios etc yet
     def test_qProcessInfo_returns_running_process_debugserver(self):
-        self.init_debugserver_test()
         self.build()
         self.qProcessInfo_returns_running_process()
 
     @llgs_test
     def test_qProcessInfo_returns_running_process_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.qProcessInfo_returns_running_process()
 
@@ -69,14 +67,12 @@ def attach_commandline_qProcessInfo_reports_correct_pid(self):
     @skipIfDarwinEmbedded # <rdar://problem/34539270> lldb-server tests not updated to work on ios etc yet
     def test_attach_commandline_qProcessInfo_reports_correct_pid_debugserver(
             self):
-        self.init_debugserver_test()
         self.build()
         self.set_inferior_startup_attach()
         self.attach_commandline_qProcessInfo_reports_correct_pid()
 
     @llgs_test
     def test_attach_commandline_qProcessInfo_reports_correct_pid_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.set_inferior_startup_attach()
         self.attach_commandline_qProcessInfo_reports_correct_pid()
@@ -101,13 +97,11 @@ def qProcessInfo_reports_valid_endian(self):
     @debugserver_test
     @skipIfDarwinEmbedded # <rdar://problem/34539270> lldb-server tests not updated to work on ios etc yet
     def test_qProcessInfo_reports_valid_endian_debugserver(self):
-        self.init_debugserver_test()
         self.build()
         self.qProcessInfo_reports_valid_endian()
 
     @llgs_test
     def test_qProcessInfo_reports_valid_endian_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.qProcessInfo_reports_valid_endian()
 
@@ -162,28 +156,24 @@ def qProcessInfo_does_not_contain_keys(self, absent_key_set):
     @debugserver_test
     @skipIfDarwinEmbedded # <rdar://problem/34539270> lldb-server tests not updated to work on ios etc yet
     def test_qProcessInfo_contains_cputype_cpusubtype_debugserver_darwin(self):
-        self.init_debugserver_test()
         self.build()
         self.qProcessInfo_contains_keys(set(['cputype', 'cpusubtype']))
 
     @skipUnlessDarwin
     @llgs_test
     def test_qProcessInfo_contains_cputype_cpusubtype_llgs_darwin(self):
-        self.init_llgs_test()
         self.build()
         self.qProcessInfo_contains_keys(set(['cputype', 'cpusubtype']))
 
     @llgs_test
     def test_qProcessInfo_contains_triple_ppid_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.qProcessInfo_contains_keys(set(['triple', 'parent-pid']))
 
     @skipUnlessDarwin
     @debugserver_test
     @skipIfDarwinEmbedded # <rdar://problem/34539270> lldb-server tests not updated to work on ios etc yet
     def test_qProcessInfo_does_not_contain_triple_debugserver_darwin(self):
-        self.init_debugserver_test()
         self.build()
         # We don't expect to see triple on darwin.  If we do, we'll prefer triple
         # to cputype/cpusubtype and skip some darwin-based ProcessGDBRemote ArchSpec setup
@@ -193,7 +183,6 @@ def test_qProcessInfo_does_not_contain_triple_debugserver_darwin(self):
     @skipUnlessDarwin
     @llgs_test
     def test_qProcessInfo_does_not_contain_triple_llgs_darwin(self):
-        self.init_llgs_test()
         self.build()
         # We don't expect to see triple on darwin.  If we do, we'll prefer triple
         # to cputype/cpusubtype and skip some darwin-based ProcessGDBRemote ArchSpec setup
@@ -203,6 +192,5 @@ def test_qProcessInfo_does_not_contain_triple_llgs_darwin(self):
     @skipIfDarwin
     @llgs_test
     def test_qProcessInfo_does_not_contain_cputype_cpusubtype_llgs(self):
-        self.init_llgs_test()
         self.build()
         self.qProcessInfo_does_not_contain_keys(set(['cputype', 'cpusubtype']))