Merge branch 'saleyn/eunit'

* saleyn/eunit:
  Add ?assertReceive(Guard, Timeout) macro to eunit

OTP-12753

1 files changed, 15 insertions, 0 deletions

diff --git a/lib/eunit/doc/overview.edoc b/lib/eunit/doc/overview.edoc
index df716cdeea..eb60f673ef 100644
--- a/lib/eunit/doc/overview.edoc
+++ b/lib/eunit/doc/overview.edoc
@@ -572,6 +572,21 @@ Examples:
 <dt>`assertNotMatch(GuardedPattern, Expr)'</dt>
 <dd>The inverse case of assertMatch, for convenience.
 </dd>
+<dt>`assertReceive(GuardedPattern, Timeout)'</dt>
+<dd>Waits for up to the `Timeout' milliseconds for a message to arrive
+in the mailbox of the current process that matches against the
+`GuardedPattern' if testing is enabled.
+If no message matching the `GuardedPattern' is received in the specified
+`Timeout' interval, the assertion fails and an informative exception will
+be generated; see the `assert' macro for further details. `GuardedPattern'
+can be anything that you can write on the left hand side of the `->'
+symbol in a case-clause, except that it cannot contain comma-separated
+guard tests.
+
+Examples:
+```?assertReceive(done, 1000)'''
+```?assertReceive(Bin when byte_size(Bin) > 10, 1000)'''
+</dd>
 <dt>`assertEqual(Expect, Expr)'</dt>
 <dd>Evaluates the expressions `Expect' and `Expr' and compares the
 results for equality, if testing is enabled. If the values are not