[all-commits] [llvm/llvm-project] 356749: [lldb/Test] Introduce "assertSuccess"

[Pavel Labath via All-commits]

  Branch: refs/heads/master
  Home:   https://github.com/llvm/llvm-project
  Commit: 35674976f09ec99e74d0d28b4a64b6bce360c128
      https://github.com/llvm/llvm-project/commit/35674976f09ec99e74d0d28b4a64b6bce360c128
  Author: Pavel Labath <pavel at labath.sk>
  Date:   2020-06-30 (Tue, 30 Jun 2020)

  Changed paths:
    M lldb/packages/Python/lldbsuite/test/lldbtest.py
    M lldb/test/API/commands/expression/call-restarts/TestCallThatRestarts.py
    M lldb/test/API/commands/expression/call-throws/TestCallThatThrows.py
    M lldb/test/API/commands/expression/context-object-objc/TestContextObjectObjc.py
    M lldb/test/API/commands/expression/context-object/TestContextObject.py
    M lldb/test/API/commands/expression/dont_allow_jit/TestAllowJIT.py
    M lldb/test/API/commands/expression/fixits/TestFixIts.py
    M lldb/test/API/commands/expression/options/TestExprOptions.py
    M lldb/test/API/commands/expression/pr35310/TestExprsBug35310.py
    M lldb/test/API/commands/expression/result_numbering/TestResultNumbering.py
    M lldb/test/API/commands/expression/scoped_enums/TestScopedEnumType.py
    M lldb/test/API/commands/expression/timeout/TestCallWithTimeout.py
    M lldb/test/API/commands/expression/unwind_expression/TestUnwindExpression.py
    M lldb/test/API/commands/expression/weak_symbols/TestWeakSymbols.py
    M lldb/test/API/commands/register/register/register_command/TestRegisters.py
    M lldb/test/API/commands/target/auto-install-main-executable/TestAutoInstallMainExecutable.py
    M lldb/test/API/python_api/hello_world/TestHelloWorld.py

  Log Message:
  -----------
  [lldb/Test] Introduce "assertSuccess"

Summary:
A lot of our tests do 'self.assertTrue(error.Success()'. The problem
with that is that when this fails, it produces a completely useless
error message (False is not True) and the most important piece of
information -- the actual error message -- is completely hidden.

Sometimes we mitigate that by including the error message in the "msg"
argument, but this has two additional problems:
- as the msg argument is evaluated unconditionally, one needs to be
  careful to not trigger an exception when the operation was actually
  successful.
- it requires more typing, which means we often don't do it

assertSuccess solves these problems by taking the entire SBError object
as an argument. If the operation was unsuccessful, it can format a
reasonable error message itself. The function still accepts a "msg"
argument, which can include any additional context, but this context now
does not need to include the error message.

To demonstrate usage, I replace a number of existing assertTrue
assertions with the new function. As this process is not easily
automatable, I have just manually updated a representative sample. In
some cases, I did not update the code to use assertSuccess, but I went
for even higher-level assertion apis (runCmd, expect_expr), as these are
even shorter, and can produce even better failure messages.

Reviewers: teemperor, JDevlieghere

Subscribers: arphaman, lldb-commits

Tags: #lldb

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