MSTEST0064: Asynchrone Assertionsmethoden bevorzugen

Ursache

Eine Testmethode verwendet Assert.Throws oder Assert.ThrowsExactly, um zu überprüfen, dass durch asynchronen Code, der den asynchronen Vorgang mithilfe von GetAwaiter().GetResult() blockiert, eine Ausnahme ausgelöst wird.

Regelbeschreibung

Wenn Sie überprüfen, ob durch asynchronen Code eine Ausnahme ausgelöst wird, verwenden Sie vorzugsweise die asynchronen Assertionsmethoden Assert.ThrowsAsync und Assert.ThrowsExactlyAsync, anstatt den asynchronen Vorgang mit GetAwaiter().GetResult() zu blockieren. Das Blockieren von asynchronem Code kann zu Deadlocks in einigen Synchronisierungskontexten führen und ist schwieriger zu lesen als die entsprechende await-basierte Assertion.

[TestClass]
public class TestClass
{
    [TestMethod]
    public async Task Test_ThrowsOnAsyncCall()
    {
        // Violation: blocks the async call inside Assert.Throws.
        Assert.Throws<InvalidOperationException>(() => DoAsync().GetAwaiter().GetResult());
    }

    private static async Task DoAsync()
    {
        await Task.Yield();
        throw new InvalidOperationException();
    }
}

Wie man Verstöße behebt

Verwenden Sie die asynchrone Assert-Methode und rufen Sie await auf:

[TestClass]
public class TestClass
{
    [TestMethod]
    public async Task Test_ThrowsOnAsyncCall()
    {
        await Assert.ThrowsAsync<InvalidOperationException>(() => DoAsync());
    }

    private static async Task DoAsync()
    {
        await Task.Yield();
        throw new InvalidOperationException();
    }
}

Das gleiche gilt für Assert.ThrowsExactly, die ein Assert.ThrowsExactlyAsync Gegenstück hat.

Wann sollten Warnungen unterdrückt werden?

Sie können diese Warnung unterdrücken, wenn die umschließende Testmethode nicht zu async gemacht werden kann (z. B. wenn eine synchrone Überladung der Testmethode durch die Signatur einer Basisklasse oder Schnittstelle erforderlich ist) und Sie den blockierenden Aufruf beibehalten müssen.

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 MSTEST0064
// The code that's violating the rule is on this line.
#pragma warning restore MSTEST0064

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.MSTEST0064.severity = none

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