Detect usages of Received like methods in Received.InOrder block

[tpodolak]

As discussed nsubstitute/NSubstitute#604 (comment)

[dtchepak]

From review comments, suggestion for error doc:

---

NS5001

CheckId	NS5001
Category	Usage

Cause

Usage of received-like method in Received.InOrder callback.

Rule description

A violation of this rule occurs when any of the following are used inside a Received.InOrder callback:

• Received()
• ReceivedWithAnyArgs()
• DidNotReceive()
• DidNotReceiveWithAnyArgs()

Calls within Received.InOrder are already checked to ensure they were received in the expected order. Individual received-like assertions should be moved outside the Received.InOrder callback.

How to fix violations

To fix a violation of this rule, remove received-like method calls from Received.InOrder callback.

For example:

// Incorrect:
Received.InOrder(() =>
{
    sub.Received().Baz();
    sub.Received().Bar();
})

// Correct:
Received.InOrder(() =>
{
    sub.Baz();
    sub.Bar();
})

Alternatively, move any received-like methods outside of Received.InOrder block if ordering is not important:

// Incorrect:
Received.InOrder(() =>
{
    sub.Baz();
    sub.Zap();
    sub.DidNotReceive().Bar();
})

// Correct:
Received.InOrder(() =>
{
    sub.Baz();
    sub.Zap();
})
sub.DidNotReceive().Bar();

How to suppress violations

This warning can be suppressed by disabling the warning in the ruleset file for the project.
The warning can also be suppressed programmatically for an assembly:

[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "NS5001:Received-like method used in Received.InOrder block.", Justification = "Reviewed")]

Or for a specific code block:

#pragma warning disable NS5001 // Received-like method used in Received.InOrder block.
// the code which produces warning
#pragma warning restore NS5001 // Received-like method used in Received.InOrder block.

[dtchepak]

Sorry it took me so long to get to this ☝️ . 😞