[lldb][NFC] Specify guidelines for API tests
authorRaphael Isemann <teemperor@gmail.com>
Mon, 17 May 2021 08:32:45 +0000 (10:32 +0200)
committerRaphael Isemann <teemperor@gmail.com>
Mon, 17 May 2021 09:01:47 +0000 (11:01 +0200)
commit4112f5ef69a166ae1d18da0cde60b8d6c402a5e4
tree9720cc86cc2b9b99f8e7acc51667e5c7d83226fc
parentd3676d4b666ead794fc58bbc7e07aa406dcf487a
[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
lldb/docs/resources/test.rst