MSTEST0064: Prefira métodos de asserção assíncrona

Motivo

Um método de teste usa Assert.Throws ou Assert.ThrowsExactly para verificar que é lançada uma exceção por um código assíncrono, bloqueando a operação assíncrona com GetAwaiter().GetResult().

Descrição da regra

Ao afirmar que uma exceção é lançada por código assíncrono, prefira os métodos de asserção assíncrona Assert.ThrowsAsync e Assert.ThrowsExactlyAsync em vez de bloquear a operação assíncrona com GetAwaiter().GetResult(). Bloquear código assíncrono pode causar impasses em alguns contextos de sincronização e é mais difícil de ler do que a asserção equivalente baseada em await.

[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();
    }
}

Como corrigir violações

Utilize o método de asserção assíncrona e await:

[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();
    }
}

O mesmo se aplica a Assert.ThrowsExactly, que tem um Assert.ThrowsExactlyAsync equivalente.

Quando suprimir avisos

Pode suprimir este aviso quando o método de teste envolvente não puder ser tornado async (por exemplo, uma sobrecarga de teste síncrona exigida por uma classe base ou pela assinatura da interface) e for necessário manter a chamada de bloqueio.

Suprimir um aviso

Se você quiser apenas suprimir uma única violação, adicione diretivas de pré-processador ao seu arquivo de origem para desativar e, em seguida, reativar a regra.

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

Para desabilitar a regra de um arquivo, pasta ou projeto, defina sua gravidade como none no arquivo de configuração.

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

Para obter mais informações, consulte Como suprimir avisos de análise de código.