MSTEST0067: Vermeiden sie synchrones Blockieren von Aufrufen im Testcode

Ursache

Testcode verwendet einen synchron blockierenden Aufruf wie Thread.Sleep, Task.Wait, Task.WaitAll, Task.WaitAny oder Task<TResult>.Result.

Die Regel greift bei Methoden, die mit TestMethodAttribute gekennzeichnet sind (einschließlich benutzerdefinierter Attribute, die davon erben), sowie bei Fixturemethoden, die mit TestInitializeAttribute, TestCleanupAttribute, ClassInitializeAttribute, ClassCleanupAttribute, AssemblyInitializeAttribute, AssemblyCleanupAttribute, GlobalTestInitializeAttribute und GlobalTestCleanupAttribute gekennzeichnet sind.

Regelbeschreibung

Das synchrone Blockieren des aktuellen Threads innerhalb von Testmethoden oder Testfixtures ist eine häufige Ursache für instabile Tests und kann auch zu einem Deadlock führen, wenn das Testframework Tests in einem Synchronisierungskontext ausführt, der eine kooperative Ablaufplanung erfordert. Verwenden Sie für zeitbasierte Wartevorgänge bevorzugt await Task.Delay und await den Task, um dessen Ergebnis zu beobachten.

[TestClass]
public class TestClass
{
    [TestMethod]
    public async Task Test()
    {
        Thread.Sleep(1000); // Violation
        var result = ComputeAsync().Result; // Violation
        ComputeAsync().Wait(); // Violation
    }

    private static Task<int> ComputeAsync() => Task.FromResult(42);
}

Wie man Verstöße behebt

Verwenden Sie das asynchrone Äquivalent:

[TestClass]
public class TestClass
{
    [TestMethod]
    public async Task Test()
    {
        await Task.Delay(1000);
        var result = await ComputeAsync();
    }

    private static Task<int> ComputeAsync() => Task.FromResult(42);
}

Wann sollten Warnungen unterdrückt werden?

Diese Regel ist standardmäßig deaktiviert. Wenn diese Option aktiviert ist, werden einzelne Vorkommen unterdrückt, wenn das synchrone Warten beabsichtigt und unvermeidbar ist – zum Beispiel bei der Interaktion mit einer synchronen API, die nicht asynchron gestaltet werden kann.

Unterdrücken einer Warnung

Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.

#pragma warning disable MSTEST0067
// The code that's violating the rule is on this line.
#pragma warning restore MSTEST0067

Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad auf none in der Konfigurationsdatei fest.

[*.{cs,vb}]
dotnet_diagnostic.MSTEST0067.severity = none

Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.