[dotest] Add @skipIfCursesSupportMissing and annotate the new gui test

[labath]

Summary

The gui command requires curses support, which can be disabled at
compile time. This patch adds the ability to detect this situation in
the test suite and skip the test accordingly.

[teemperor]

LGTM, thanks!

[jankratochvil]

packages/Python/lldbsuite/test/decorators.py

786 ↗

(On Diff #218336)

I find a bit confusing the function returns opposite of key existence but its name does not indicate that. The skipIf could stay in its name.

[labath]

packages/Python/lldbsuite/test/decorators.py

786 ↗

(On Diff #218336)

good point, lemme rename that

[labath]

Rename the function to _get_bool_config_skip_if_decorator

lldb/trunk/packages/Python/lldbsuite/test/commands/gui/basic/TestGuiBasic.py

 """
 Test that the 'gui' displays the help window and basic UI.
 """
 
 import lldb
 from lldbsuite.test.decorators import *
 from lldbsuite.test.lldbtest import *
 from lldbsuite.test.lldbpexpect import PExpectTest
 
 class BasicGuiCommandTest(PExpectTest):
 
     mydir = TestBase.compute_mydir(__file__)
 
+    @skipIfCursesSupportMissing
     def test_gui(self):
         self.build()
 
         self.launch(executable=self.getBuildArtifact("a.out"))
         self.expect('br set -f main.c -p "// Break here"', substrs=["Breakpoint 1", "address ="])
         self.expect("run", substrs=["stop reason ="])
 
 

lldb/trunk/packages/Python/lldbsuite/test/commands/gui/invalid-args/TestInvalidArgsGui.py

 import lldb
 from lldbsuite.test.lldbtest import *
 from lldbsuite.test.decorators import *
 
 class GuiTestCase(TestBase):
 
     mydir = TestBase.compute_mydir(__file__)
 
-    def setUp(self):
-        TestBase.setUp(self)
-
     @no_debug_info_test
+    @skipIfCursesSupportMissing
     def test_reproducer_generate_invalid_invocation(self):
         self.expect("gui blub", error=True,
                     substrs=["the gui command takes no arguments."])

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

def is_compiler_with_address_sanitizer(self):
         if os.popen(cmd).close() is not None:
             return None  # The compiler cannot compile at all, let's *not* skip the test
         cmd = "echo 'int main() {}' | %s -fsanitize=address -x c -o %s -" % (compiler_path, f.name)
         if os.popen(cmd).close() is not None:
             return "Compiler cannot compile with -fsanitize=address"
         return None
     return skipTestIfFn(is_compiler_with_address_sanitizer)(func)
 
-def skipIfXmlSupportMissing(func):
+def _get_bool_config_skip_if_decorator(key):
     config = lldb.SBDebugger.GetBuildConfiguration()
-    xml = config.GetValueForKey("xml")
-
+    value_node = config.GetValueForKey(key)
     fail_value = True # More likely to notice if something goes wrong
-    have_xml = xml.GetValueForKey("value").GetBooleanValue(fail_value)
-    return unittest2.skipIf(not have_xml, "requires xml support")(func)
+    have = value_node.GetValueForKey("value").GetBooleanValue(fail_value)
+    return unittest2.skipIf(not have, "requires " + key)
+
+def skipIfCursesSupportMissing(func):
+    return _get_bool_config_skip_if_decorator("curses")(func)
+
+def skipIfXmlSupportMissing(func):
+    return _get_bool_config_skip_if_decorator("xml")(func)
 
 def skipIfLLVMTargetMissing(target):
     config = lldb.SBDebugger.GetBuildConfiguration()
     targets = config.GetValueForKey("targets").GetValueForKey("value")
     found = False
     for i in range(targets.GetSize()):
         if targets.GetItemAtIndex(i).GetStringValue(99) == target:
             found = True

lldb/trunk/source/API/SBDebugger.cpp

 SBStructuredData SBDebugger::GetBuildConfiguration() {
   LLDB_RECORD_STATIC_METHOD_NO_ARGS(lldb::SBStructuredData, SBDebugger,
                                     GetBuildConfiguration);
 
   auto config_up = std::make_unique<StructuredData::Dictionary>();
   AddBoolConfigEntry(
       *config_up, "xml", XMLDocument::XMLEnabled(),
       "A boolean value that indicates if XML support is enabled in LLDB");
+  bool have_curses = true;
+#ifdef LLDB_DISABLE_CURSES
+  have_curses = false;
+#endif
+  AddBoolConfigEntry(
+      *config_up, "curses", have_curses,
+      "A boolean value that indicates if curses support is enabled in LLDB");
   AddLLVMTargets(*config_up);
 
   SBStructuredData data;
   data.m_impl_up->SetObjectSP(std::move(config_up));
   return LLDB_RECORD_RESULT(data);
 }
 
 bool SBDebugger::StateIsRunningState(StateType state) {