Configurar o MSTest

MSTest, Microsoft Testing Framework, é uma estrutura de teste para aplicativos .NET. Ele permite que você escreva e execute testes e forneça pacotes de teste com integração com Visual Studio e Visual Studio Code Test Explorers, a CLI do .NET e muitos pipelines de CI.

O MSTest é uma estrutura de teste totalmente suportada, de código aberto e multiplataforma que funciona com todos os destinos .NET suportados (.NET Framework, .NET Core, .NET, UWP, WinUI e assim por diante) hospedados no GitHub.

Configurações de execução

Um arquivo .runsettings pode ser usado para configurar como os testes de unidade estão sendo executados. Para saber mais sobre as definições de execução e as configurações relacionadas com a plataforma, pode consultar a documentação sobre definições de execução do VSTest ou a documentação sobre definições de execução do MSTest runner.

Elemento MSTest

As seguintes entradas runsettings permitem configurar como o MSTest se comporta.

Os valores de timeout devem ser inteiros positivos em milissegundos. Para correr sem timeout, omita a entrada em vez de a definir como 0. Os tempos finais globais dos jogos de teste herdam o valor correspondenteTestInitializeTimeout.TestCleanupTimeout

TestRunParameter elemento

<TestRunParameters>
    <Parameter name="webAppUrl" value="http://localhost" />
</TestRunParameters>

Os parâmetros de execução de teste fornecem uma forma de definir variáveis e valores disponíveis para os testes em tempo de execução. Acesse os parâmetros usando a propriedade MSTest TestContext.Properties :

private string _appUrl;
public TestContext TestContext { get; set; }

[TestMethod]
public void HomePageTest()
{
    string _appUrl = TestContext.Properties["webAppUrl"];
}

Para usar parâmetros de execução de teste, adicione uma propriedade pública TestContext à sua classe de teste.

Exemplo de arquivo .runsettings

O XML a seguir mostra o conteúdo de um arquivo .runsettings típico. Copie este código e edite-o de acordo com as suas necessidades.

Cada elemento do arquivo é opcional porque tem um valor padrão.

<?xml version="1.0" encoding="utf-8"?>
<RunSettings>

  <!-- Parameters used by tests at runtime -->
  <TestRunParameters>
    <Parameter name="webAppUrl" value="http://localhost" />
    <Parameter name="webAppUserName" value="Admin" />
    <Parameter name="webAppPassword" value="Password" />
  </TestRunParameters>

  <!-- MSTest -->
  <MSTest>
    <MapInconclusiveToFailed>True</MapInconclusiveToFailed>
    <CaptureTraceOutput>false</CaptureTraceOutput>
    <DeleteDeploymentDirectoryAfterTestRunIsComplete>False</DeleteDeploymentDirectoryAfterTestRunIsComplete>
    <DeploymentEnabled>False</DeploymentEnabled>
    <ConsiderFixturesAsSpecialTests>False</ConsiderFixturesAsSpecialTests>
    <AssemblyResolution>
      <Directory path="D:\myfolder\bin\" includeSubDirectories="false"/>
    </AssemblyResolution>
  </MSTest>

</RunSettings>

testconfig.json

Ao executar seus testes com o MSTest, você pode usar um arquivo de testconfig.json para configurar o comportamento do executor de teste. O arquivo testconfig.json é um arquivo JSON que contém as definições de configuração para o executor de teste. O arquivo é usado para configurar o executor de teste e o ambiente de execução de teste. Para mais informações, consulte a documentação do MTP testconfig.json.

A partir do MSTest 3.7, você também pode configurar as execuções do MSTest no mesmo arquivo de configuração. As seções a seguir descrevem as configurações que você pode usar no arquivo testconfig.json.

A partir do MSTest 4.3.3, o .NET Framework também aceita comentários e vírgulas em testconfig.json.

Elemento MSTest

As configurações do MSTest são agrupadas por funcionalidade descrita nas seções a seguir.

assemblyResolution configurações

Todas as configurações nesta seção pertencem ao elemento assemblyResolution.

Exemplo:

{
  "mstest": {
    "assemblyResolution": {
        { "path": "...", "includeSubDirectories": "true/false" }
    }
  }
}

deployment configurações

Todas as configurações nesta seção pertencem ao elemento deployment.

Exemplo:

{
  "mstest": {
    "deployment": {
        "deleteDeploymentDirectoryAfterTestRunIsComplete": true,
        "deployTestSourceDependencies": true,
        "enabled": true
    }
  }
}

output configurações

Todas as configurações nesta seção pertencem ao elemento output.

Exemplo:

{
  "mstest": {
    "output": {
        "captureTrace": false
    }
  }
}

parallelism configurações

Todas as configurações nesta seção pertencem ao elemento parallelism.

Exemplo:

{
  "mstest": {
    "parallelism": {
        "enabled": true,
        "scope": "method",
        "workers": 32
    }
  }
}

execution configurações

Todas as configurações nesta seção pertencem ao elemento execution.

Exemplo:

{
  "mstest": {
    "execution": {
        "considerEmptyDataSourceAsInconclusive": false,
        "considerFixturesAsSpecialTests": false,
        "mapInconclusiveToFailed": true,
        "mapNotRunnableToFailed": true,
        "treatClassAndAssemblyCleanupWarningsAsErrors": false,
        "treatDiscoveryWarningsAsErrors": false
    }
  }
}

timeout configurações

Todas as configurações nesta seção pertencem ao elemento timeout.

Exemplo:

{
  "mstest": {
    "timeout": { "globalTestInitialize": 30000, "globalTestCleanup": 30000 }
  }
}

Exemplo testconfig.json arquivo

O JSON a seguir mostra o conteúdo de um arquivo .testconfig.json típico. Copie este código e edite-o de acordo com as suas necessidades.

Cada elemento do arquivo é opcional porque tem um valor padrão.

{
  "platformOptions": {
    "resultDirectory": "./TestResults"
  },
  "mstest": {
    "execution": {
        "mapInconclusiveToFailed": true,
        "disableAppDomain": true,
        "considerFixturesAsSpecialTests": false
    },
    "parallelism": {
        "enabled": true,
        "scope": "method"
    },
    "output": {
        "captureTrace": false
    }
  }
}

Propriedades do MSBuild

A partir do MSTest 4.3, ative a paralelização ao nível da assemblagem no ficheiro do projeto ou em Directory.Build.props, sem definir um atributo [assembly: Parallelize]. Estas propriedades emitem o correspondente atributo assembly durante a compilação, pelo que precisam GenerateAssemblyInfo de ser true (o padrão para projetos ao estilo SDK).

O MSTest valida ambas as propriedades durante a compilação. Valores de âmbito inválidos, contagens de trabalhadores não inteiros e uma contagem de trabalhadores combinados com um None âmbito falham na compilação. Também não declares [assembly: Parallelize] nem [assembly: DoNotParallelize] no código-fonte, porque o atributo gerado duplicaria o atributo. Quando GenerateAssemblyInfo é false, declare o atributo na fonte em vez disso.

O exemplo seguinte permite a paralelização ao nível do método com quatro trabalhadores para cada projeto de teste que importa o Directory.Build.props ficheiro:

<Project>
  <PropertyGroup>
    <MSTestParallelizeScope>MethodLevel</MSTestParallelizeScope>
    <MSTestParallelizeWorkers>4</MSTestParallelizeWorkers>
  </PropertyGroup>
</Project>