MSTEST0067: Evitar bloquear chamadas sincronizadas no código de teste

Motivo

O código de teste utiliza uma chamada de bloqueio síncrono, como Thread.Sleep, Task.Wait, Task.WaitAll, Task.WaitAny, ou Task<TResult>.Result.

A regra é ativada em métodos marcados com TestMethodAttribute (incluindo atributos personalizados que herdam dele) e em métodos de fixture marcados com TestInitializeAttribute, TestCleanupAttribute, ClassInitializeAttribute, ClassCleanupAttributeAssemblyInitializeAttribute, AssemblyCleanupAttribute, , GlobalTestInitializeAttribute, e GlobalTestCleanupAttribute.

Descrição da regra

Bloquear sincronizadamente o thread atual dentro de métodos de teste ou fixtures de teste é uma fonte comum de instabilidade e pode também bloquear quando o framework de testes executa testes num contexto de sincronização que requer agendamento cooperativo. Prefira await Task.Delay para esperas temporizadas e await para observar o resultado da tarefa.

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

Como corrigir violações

Use o equivalente assíncrono:

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

Quando suprimir avisos

Esta regra está desativada por defeito. Quando ativada esta opção, suprima ocorrências específicas quando a espera síncrona é intencional e inevitável — por exemplo, ao interagir com uma API síncrona que não pode ser convertida em assíncrona.

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

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

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

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