[lldb] Replace asserts on .Success() with assertSuccess()

Replace forms of `assertTrue(err.Success())` with `assertSuccess(err)` (added in D82759).

* `assertSuccess` prints out the error's message
* `assertSuccess` expresses explicit higher level semantics, both to the reader and for test failure output
* `assertSuccess` seems not to be well known, using it where possible will help spread knowledge
* `assertSuccess` statements are more succinct

Differential Revision: https://reviews.llvm.org/D119616

(cherry picked from commit 779bbbf)

Author: kastiglione

lldb/test/API/commands/expression/context-object-objc/TestContextObjectObjc.py

@@ -36,7 +36,7 @@ def test_context_object_objc(self):
         # Test retrieving of a field (not a local with the same name)
         value = obj_val.EvaluateExpression("field")
         self.assertTrue(value.IsValid())
-        self.assertTrue(value.GetError().Success())
+        self.assertSuccess(value.GetError())
         self.assertEqual(value.GetValueAsSigned(), 1111)
 
         # Test if the self pointer is properly evaluated

lldb/test/API/commands/platform/basic/TestPlatformPython.py

@@ -94,5 +94,5 @@ def test_shell_interpreter(self):
         self.build()
         sh_cmd.SetShell(self.getBuildArtifact('a.out'))
         err = platform.Run(sh_cmd)
-        self.assertTrue(err.Success())
+        self.assertSuccess(err)
         self.assertIn("SUCCESS", sh_cmd.GetOutput())

lldb/test/API/commands/watchpoints/multiple_hits/TestMultipleHits.py

@@ -43,7 +43,7 @@ def test(self):
 
             error = lldb.SBError()
             watch = member.Watch(True, True, True, error)
-            self.assertTrue(error.Success())
+            self.assertSuccess(error)
 
         process.Continue();
         self.assertEqual(process.GetState(), lldb.eStateStopped)

lldb/test/API/commands/watchpoints/step_over_watchpoint/TestStepOverWatchpoint.py

@@ -55,9 +55,7 @@ def test(self):
 
         # resolve_location=True, read=True, write=False
         read_watchpoint = read_value.Watch(True, True, False, error)
-        self.assertTrue(error.Success(),
-                        "Error while setting watchpoint: %s" %
-                        error.GetCString())
+        self.assertSuccess(error, "Error while setting watchpoint")
         self.assertTrue(read_watchpoint, "Failed to set read watchpoint.")
 
         thread.StepOver()
@@ -85,9 +83,7 @@ def test(self):
         # resolve_location=True, read=False, write=True
         write_watchpoint = write_value.Watch(True, False, True, error)
         self.assertTrue(write_watchpoint, "Failed to set write watchpoint.")
-        self.assertTrue(error.Success(),
-                        "Error while setting watchpoint: %s" %
-                        error.GetCString())
+        self.assertSuccess(error, "Error while setting watchpoint")
 
         thread.StepOver()
         self.assertEquals(thread.GetStopReason(), lldb.eStopReasonWatchpoint,

lldb/test/API/functionalities/breakpoint/auto_continue/TestBreakpointAutoContinue.py

@@ -48,7 +48,7 @@ def launch_it (self, expected_state):
         launch_info.SetWorkingDirectory(self.get_process_working_directory())
 
         process = self.target.Launch(launch_info, error)
-        self.assertTrue(error.Success(), "Launch failed.")
+        self.assertSuccess(error, "Launch failed.")
 
         state = process.GetState()
         self.assertEqual(state, expected_state, "Didn't get expected state")

lldb/test/API/functionalities/breakpoint/breakpoint_command/TestBreakpointCommandsFromPython.py

@@ -110,7 +110,7 @@ def do_set_python_command_from_python(self):
         stream.Print('{"side_effect" : "I am fancy"}')
         extra_args.SetFromJSON(stream)
         error = fancy_bkpt.SetScriptCallbackFunction("bktptcmd.another_function", extra_args)
-        self.assertTrue(error.Success(), "Failed to add callback %s"%(error.GetCString()))
+        self.assertSuccess(error, "Failed to add callback")
 
         stream.Clear()
         stream.Print('{"side_effect" : "I am so much fancier"}')
@@ -123,14 +123,14 @@ def do_set_python_command_from_python(self):
         # Not so fancy gets an empty extra_args:
         empty_args = lldb.SBStructuredData()
         error = not_so_fancy_bkpt.SetScriptCallbackFunction("bktptcmd.empty_extra_args", empty_args)
-        self.assertTrue(error.Success(), "Failed to add callback %s"%(error.GetCString()))
+        self.assertSuccess(error, "Failed to add callback")
 
         # Do list breakpoint like fancy:
         stream.Clear()
         stream.Print('{"side_effect" : "I come from list input"}')
         extra_args.SetFromJSON(stream)
         error = list_bkpt.SetScriptCallbackFunction("bktptcmd.a_list_function", extra_args)
-        self.assertTrue(error.Success(), "Failed to add callback %s"%(error.GetCString()))
+        self.assertSuccess(error, "Failed to add callback")
 
         # Clear out canary variables
         side_effect.bktptcmd = None

lldb/test/API/functionalities/breakpoint/scripted_bkpt/TestScriptedResolver.py

@@ -71,7 +71,7 @@ def make_extra_args(self):
         json_stream.Print(json_string)
         extra_args = lldb.SBStructuredData()
         error = extra_args.SetFromJSON(json_stream)
-        self.assertTrue(error.Success(), "Error making SBStructuredData: %s"%(error.GetCString()))
+        self.assertSuccess(error, "Error making SBStructuredData")
         return extra_args
 
     def do_test(self):

lldb/test/API/functionalities/breakpoint/serialize/TestBreakpointSerialization.py

@@ -119,11 +119,11 @@ def check_equivalence(self, source_bps, do_write = True):
 
         if (do_write):
             error = self.orig_target.BreakpointsWriteToFile(self.bkpts_file_spec, source_bps)
-            self.assertTrue(error.Success(), "Failed writing breakpoints to file: %s."%(error.GetCString()))
+            self.assertSuccess(error, "Failed writing breakpoints to file")
 
         copy_bps = lldb.SBBreakpointList(self.copy_target)
         error = self.copy_target.BreakpointsCreateFromFile(self.bkpts_file_spec, copy_bps)
-        self.assertTrue(error.Success(), "Failed reading breakpoints from file: %s"%(error.GetCString()))
+        self.assertSuccess(error, "Failed reading breakpoints from file")
 
         num_source_bps = source_bps.GetSize()
         num_copy_bps = copy_bps.GetSize()
@@ -279,7 +279,7 @@ def do_check_appending(self):
 
         error = lldb.SBError()
         error = self.orig_target.BreakpointsWriteToFile(self.bkpts_file_spec, source_bps)
-        self.assertTrue(error.Success(), "Failed writing breakpoints to file: %s."%(error.GetCString()))
+        self.assertSuccess(error, "Failed writing breakpoints to file")
 
         source_bps.Clear()
 
@@ -299,7 +299,7 @@ def do_check_appending(self):
         all_bps.Append(bkpt)
 
         error = self.orig_target.BreakpointsWriteToFile(self.bkpts_file_spec, source_bps, True)
-        self.assertTrue(error.Success(), "Failed appending breakpoints to file: %s."%(error.GetCString()))
+        self.assertSuccess(error, "Failed appending breakpoints to file")
 
         self.check_equivalence(all_bps)
 
@@ -313,19 +313,19 @@ def do_check_names(self):
 
         error = lldb.SBError()
         error = self.orig_target.BreakpointsWriteToFile(self.bkpts_file_spec, write_bps)
-        self.assertTrue(error.Success(), "Failed writing breakpoints to file: %s."%(error.GetCString()))
+        self.assertSuccess(error, "Failed writing breakpoints to file")
 
         copy_bps = lldb.SBBreakpointList(self.copy_target)
         names_list = lldb.SBStringList()
         names_list.AppendString("NoSuchName")
 
         error = self.copy_target.BreakpointsCreateFromFile(self.bkpts_file_spec, names_list, copy_bps)
-        self.assertTrue(error.Success(), "Failed reading breakpoints from file: %s"%(error.GetCString()))
+        self.assertSuccess(error, "Failed reading breakpoints from file")
         self.assertEqual(copy_bps.GetSize(), 0, "Found breakpoints with a nonexistent name.")
 
         names_list.AppendString(good_bkpt_name)
         error = self.copy_target.BreakpointsCreateFromFile(self.bkpts_file_spec, names_list, copy_bps)
-        self.assertTrue(error.Success(), "Failed reading breakpoints from file: %s"%(error.GetCString()))
+        self.assertSuccess(error, "Failed reading breakpoints from file")
         self.assertEqual(copy_bps.GetSize(), 1, "Found the matching breakpoint.")
 
     def do_check_extra_args(self):
@@ -348,12 +348,12 @@ def do_check_extra_args(self):
         write_bps = lldb.SBBreakpointList(self.orig_target)
 
         error = self.orig_target.BreakpointsWriteToFile(self.bkpts_file_spec, write_bps)
-        self.assertTrue(error.Success(), "Failed writing breakpoints: %s"%(error.GetCString()))
+        self.assertSuccess(error, "Failed writing breakpoints")
 
         side_effect.g_extra_args = None
         copy_bps = lldb.SBBreakpointList(self.copy_target)
         error = self.copy_target.BreakpointsCreateFromFile(self.bkpts_file_spec, copy_bps)
-        self.assertTrue(error.Success(), "Failed reading breakpoints: %s"%(error.GetCString()))
+        self.assertSuccess(error, "Failed reading breakpoints")
 
         self.assertEqual(copy_bps.GetSize(), 1, "Got one breakpoint from file.")
         no_keys = lldb.SBStringList()
@@ -377,7 +377,7 @@ def do_check_extra_args(self):
         write_bps = lldb.SBBreakpointList(self.orig_target)
 
         error = self.orig_target.BreakpointsWriteToFile(self.bkpts_file_spec, write_bps)
-        self.assertTrue(error.Success(), "Failed writing breakpoints: %s"%(error.GetCString()))
+        self.assertSuccess(error, "Failed writing breakpoints")
 
         orig_extra_args = side_effect.g_extra_args
         self.assertTrue(orig_extra_args.IsValid(), "Extra args originally valid")
@@ -390,7 +390,7 @@ def do_check_extra_args(self):
 
         copy_bps = lldb.SBBreakpointList(self.copy_target)
         error = self.copy_target.BreakpointsCreateFromFile(self.bkpts_file_spec, copy_bps)
-        self.assertTrue(error.Success(), "Failed reading breakpoints: %s"%(error.GetCString()))
+        self.assertSuccess(error, "Failed reading breakpoints")
 
         self.assertEqual(copy_bps.GetSize(), 1, "Got one breakpoint from file.")
 

lldb/test/API/functionalities/dlopen_other_executable/TestDlopenOtherExecutable.py

@@ -39,7 +39,7 @@ def test(self):
 
         # Kill the process and run the program again.
         err = self.process().Kill()
-        self.assertTrue(err.Success(), str(err))
+        self.assertSuccess(err)
 
         # Test that we hit the breakpoint after dlopen.
         lldbutil.run_to_breakpoint_do_run(self, self.target(), breakpoint)

lldb/test/API/functionalities/dyld-launch-linux/TestDyldLaunchLinux.py

@@ -40,7 +40,7 @@ def test(self):
         launch_info.SetWorkingDirectory(self.get_process_working_directory())
         error = lldb.SBError()
         process = target.Launch(launch_info, error)
-        self.assertTrue(error.Success())
+        self.assertSuccess(error)
 
         # Stopped on main here.
         self.assertEqual(process.GetState(), lldb.eStateStopped)

lldb/test/API/functionalities/gdb_remote_client/TestJLink6Armv7RegisterDefinition.py

@@ -189,7 +189,7 @@ def QListThreadsInStopReply(self):
         data = lldb.SBData()
         data.SetData(error, val, lldb.eByteOrderBig, 4)
         self.assertEqual(r1_valobj.SetData(data, error), True)
-        self.assertTrue(error.Success())
+        self.assertSuccess(error)
 
         r1_valobj = process.GetThreadAtIndex(0).GetFrameAtIndex(0).FindRegister("r1")
         self.assertEqual(r1_valobj.GetValueAsUnsigned(), 0x11223344)

lldb/test/API/functionalities/gdb_remote_client/TestMemoryRegionDirtyPages.py

@@ -34,30 +34,30 @@ def qMemoryRegionInfo(self, addr):
         # A memory region where we don't know anything about dirty pages
         region = lldb.SBMemoryRegionInfo()
         err = process.GetMemoryRegionInfo(0, region)
-        self.assertTrue(err.Success())
+        self.assertSuccess(err)
         self.assertFalse(region.HasDirtyMemoryPageList())
         self.assertEqual(region.GetNumDirtyPages(), 0)
         region.Clear()
 
         # A memory region with dirty page information -- and zero dirty pages
         err = process.GetMemoryRegionInfo(0x100000000, region)
-        self.assertTrue(err.Success())
+        self.assertSuccess(err)
         self.assertTrue(region.HasDirtyMemoryPageList())
         self.assertEqual(region.GetNumDirtyPages(), 0)
         self.assertEqual(region.GetPageSize(), 4096)
         region.Clear()
 
         # A memory region with one dirty page
         err = process.GetMemoryRegionInfo(0x100004000, region)
-        self.assertTrue(err.Success())
+        self.assertSuccess(err)
         self.assertTrue(region.HasDirtyMemoryPageList())
         self.assertEqual(region.GetNumDirtyPages(), 1)
         self.assertEqual(region.GetDirtyPageAddressAtIndex(0), 0x100004000)
         region.Clear()
 
         # A memory region with multple dirty pages
         err = process.GetMemoryRegionInfo(0x1000a2000, region)
-        self.assertTrue(err.Success())
+        self.assertSuccess(err)
         self.assertTrue(region.HasDirtyMemoryPageList())
         self.assertEqual(region.GetNumDirtyPages(), 5)
         self.assertEqual(region.GetDirtyPageAddressAtIndex(4), 0x1000a6000)

lldb/test/API/functionalities/launch_stop_at_entry/TestStopAtEntry.py

@@ -86,7 +86,7 @@ def cleanup ():
         error = lldb.SBError()
 
         process = target.Launch(launch_info, error)
-        self.assertTrue(error.Success(), "Launch failed: {0}".format(error.description))
+        self.assertSuccess(error, "Launch failed")
         # If we are asynchronous, we have to wait for the events:
         if not synchronous:
             listener = launch_info.GetListener()
@@ -106,7 +106,7 @@ def cleanup ():
 
         # Now make sure that we can resume the process and have it exit.
         error = process.Continue()
-        self.assertTrue(error.Success(), "Error continuing: {0}".format(error.description))
+        self.assertSuccess(error, "Error continuing")
         # Fetch events till we get eStateExited:
         if not synchronous:
             # Get events till exited.

lldb/test/API/functionalities/load_using_paths/TestLoadUsingPaths.py

@@ -85,7 +85,7 @@ def test_load_using_paths(self):
 
         # Now see that we can call a function in the loaded module.
         value = thread.frames[0].EvaluateExpression("d_function()", lldb.SBExpressionOptions())
-        self.assertTrue(value.GetError().Success(), "Got a value from the expression")
+        self.assertSuccess(value.GetError(), "Got a value from the expression")
         ret_val = value.GetValueAsSigned()
         self.assertEqual(ret_val, 12345, "Got the right value")
 

lldb/test/API/functionalities/paths/TestPaths.py

@@ -49,7 +49,7 @@ def test_interpreter_info(self):
         info_sd = self.dbg.GetScriptInterpreterInfo(self.dbg.GetScriptingLanguage("python"))
         self.assertTrue(info_sd.IsValid())
         stream = lldb.SBStream()
-        self.assertTrue(info_sd.GetAsJSON(stream).Success())
+        self.assertSuccess(info_sd.GetAsJSON(stream))
         info = json.loads(stream.GetData())
         prefix = info['prefix']
         self.assertEqual(os.path.realpath(sys.prefix), os.path.realpath(prefix))

lldb/test/API/functionalities/postmortem/elf-core/TestLinuxCore.py

@@ -109,7 +109,7 @@ def test_two_cores_same_pid(self):
         error = lldb.SBError()
         F = altprocess.ReadCStringFromMemory(
             altframe.FindVariable("F").GetValueAsUnsigned(), 256, error)
-        self.assertTrue(error.Success())
+        self.assertSuccess(error)
         self.assertEqual(F, "_start")
 
         # without destroying this process, run the test which opens another core file with the

lldb/test/API/functionalities/postmortem/minidump-new/TestMiniDumpNew.py

@@ -65,7 +65,7 @@ def test_loadcore_error_status(self):
         error = lldb.SBError()
         self.process = self.target.LoadCore(minidump_path, error)
         self.assertTrue(self.process, PROCESS_IS_VALID)
-        self.assertTrue(error.Success())
+        self.assertSuccess(error)
 
     def test_loadcore_error_status_failure(self):
         """Test the SBTarget.LoadCore(core, error) overload."""

lldb/test/API/functionalities/postmortem/minidump/TestMiniDump.py

@@ -123,7 +123,7 @@ def test_deeper_stack_in_mini_dump(self):
             self.assertEqual(process.GetState(), lldb.eStateStopped)
             self.assertTrue(process.SaveCore(core))
             self.assertTrue(os.path.isfile(core))
-            self.assertTrue(process.Kill().Success())
+            self.assertSuccess(process.Kill())
 
             # Launch with the mini dump, and inspect the stack.
             target = self.dbg.CreateTarget(None)
@@ -159,7 +159,7 @@ def test_local_variables_in_mini_dump(self):
             self.assertEqual(process.GetState(), lldb.eStateStopped)
             self.assertTrue(process.SaveCore(core))
             self.assertTrue(os.path.isfile(core))
-            self.assertTrue(process.Kill().Success())
+            self.assertSuccess(process.Kill())
 
             # Launch with the mini dump, and inspect a local variable.
             target = self.dbg.CreateTarget(None)

lldb/test/API/functionalities/process_crash_info/TestProcessCrashInfo.py

@@ -63,7 +63,7 @@ def test_api(self):
 
         error = crash_info.GetAsJSON(stream)
 
-        self.assertTrue(error.Success())
+        self.assertSuccess(error)
 
         self.assertTrue(crash_info.IsValid())
 

lldb/test/API/functionalities/process_save_core/TestProcessSaveCore.py

@@ -43,7 +43,7 @@ def test_save_windows_mini_dump(self):
             self.assertEqual(process.GetState(), lldb.eStateStopped)
             self.assertTrue(process.SaveCore(core))
             self.assertTrue(os.path.isfile(core))
-            self.assertTrue(process.Kill().Success())
+            self.assertSuccess(process.Kill())
 
             # To verify, we'll launch with the mini dump, and ensure that we see
             # the executable in the module list.
@@ -77,7 +77,7 @@ def test_save_core_via_process_plugin(self):
             self.assertEqual(process.GetState(), lldb.eStateStopped)
             self.assertTrue(process.SaveCore(core))
             self.assertTrue(os.path.isfile(core))
-            self.assertTrue(process.Kill().Success())
+            self.assertSuccess(process.Kill())
             pid = process.GetProcessID()
 
             target = self.dbg.CreateTarget(None)

lldb/test/API/functionalities/process_save_core_minidump/TestProcessSaveCoreMinidump.py

@@ -43,7 +43,7 @@ def test_save_linux_mini_dump(self):
             # save core and, kill process and verify corefile existence
             self.runCmd("process save-core --plugin-name=minidump --style=stack " + core)
             self.assertTrue(os.path.isfile(core))
-            self.assertTrue(process.Kill().Success())
+            self.assertSuccess(process.Kill())
 
             # To verify, we'll launch with the mini dump
             target = self.dbg.CreateTarget(None)

lldb/test/API/functionalities/return-value/TestReturnValue.py

@@ -50,7 +50,7 @@ def test_with_python(self):
         # inner_sint returns the variable value, so capture that here:
         in_int = thread.GetFrameAtIndex(0).FindVariable(
             "value").GetValueAsSigned(error)
-        self.assertTrue(error.Success())
+        self.assertSuccess(error)
 
         thread.StepOut()
 
@@ -65,7 +65,7 @@ def test_with_python(self):
         self.assertTrue(return_value.IsValid())
 
         ret_int = return_value.GetValueAsSigned(error)
-        self.assertTrue(error.Success())
+        self.assertSuccess(error)
         self.assertEquals(in_int, ret_int)
 
         # Run again and we will stop in inner_sint the second time outer_sint is called.
@@ -82,7 +82,7 @@ def test_with_python(self):
         fun_name = frame.GetFunctionName()
         self.assertEquals(fun_name, "outer_sint(int)")
         in_int = frame.FindVariable("value").GetValueAsSigned(error)
-        self.assertTrue(error.Success())
+        self.assertSuccess(error)
 
         thread.StepOutOfFrame(frame)
 
@@ -95,7 +95,7 @@ def test_with_python(self):
         ret_value = thread.GetStopReturnValue()
         self.assertTrue(return_value.IsValid())
         ret_int = ret_value.GetValueAsSigned(error)
-        self.assertTrue(error.Success())
+        self.assertSuccess(error)
         self.assertEquals(2 * in_int, ret_int)
 
         # Now try some simple returns that have different types:

lldb/test/API/functionalities/scripted_process/TestScriptedProcess.py

@@ -70,7 +70,7 @@ def cleanup():
 
         process = target.Launch(launch_info, error)
 
-        self.assertTrue(error.Success(), error.GetCString())
+        self.assertSuccess(error)
         self.assertTrue(process, PROCESS_IS_VALID)
         self.assertEqual(process.GetProcessID(), 666)
         self.assertEqual(process.GetNumThreads(), 0)