[all-commits] [llvm/llvm-project] 4112f5: [lldb][NFC] Specify guidelines for API tests

[Raphael Isemann via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 4112f5ef69a166ae1d18da0cde60b8d6c402a5e4
      https://github.com/llvm/llvm-project/commit/4112f5ef69a166ae1d18da0cde60b8d6c402a5e4
  Author: Raphael Isemann <teemperor at gmail.com>
  Date:   2021-05-17 (Mon, 17 May 2021)

  Changed paths:
    M lldb/docs/resources/test.rst

  Log Message:
  -----------
  [lldb][NFC] Specify guidelines for API tests

This patch specifies a few guidelines that our API tests should follow.

The motivations for this are twofold:

1. API tests have unexpected pitfalls that especially new contributors run into
when writing tests. To prevent the frustration of letting people figure those
pitfalls out by trial-and-error, let's just document them briefly in one place.

2. It prevents some arguing about what is the right way to write tests. I really
like to have fast and reliable API test suite, but I also don't want to be the
bogeyman that has to insist in every review that the test should be rewritten to
not launch a process for no good reason. It's much easier to just point to a
policy document.

I omitted some guidelines that I think could be controversial (e.g., the whole
"should assert message describe failure or success").

Reviewed By: shafik

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