Partilhar via

Tutorial: Testar uma biblioteca de classes .NET usando o Visual Studio Code

  • Artigo

Este tutorial mostra como automatizar o teste de unidade adicionando um projeto de teste a uma solução.

Pré-requisitos

Criar um projeto de teste de unidade

Testes unitários fornecem teste automatizado de software durante o desenvolvimento e o lançamento. A estrutura de teste que você usa neste tutorial é MSTest. MSTest é uma das três estruturas de teste que você pode escolher. Os outros são xUnit e nUnit.

  1. Inicie o Visual Studio Code.

  2. Abra a solução ClassLibraryProjects que você criou em Criar uma biblioteca de classes .NET usando o Visual Studio Code.

  3. No Gerenciador de Soluções , selecione Novo Projetoou na Paleta de Comandos, selecione .NET: Novo Projeto.

  4. Selecione MSTest Test Project, nomeie-o "StringLibraryTest", selecione o diretório padrão e selecione Create Project.

    O modelo de projeto cria um arquivo de UnitTest1.cs com o seguinte código:

    namespace StringLibraryTest;

[TestClass]
public class UnitTest1
{
    [TestMethod]
    public void TestMethod1()
    {
    }
}

    O código-fonte criado pelo modelo de teste de unidade faz o seguinte:

    Cada método marcado com [TestMethod] em uma classe de teste marcada com [TestClass] é executado automaticamente quando o teste de unidade é invocado.

Adicionar uma referência de projeto

Para que o projeto de teste funcione com a classe StringLibrary, adicione uma referência no projeto StringLibraryTest ao projeto StringLibrary.

  1. No Gerenciador de Soluções clique com o botão direito do mouse no projeto 'StringLibraryTest' e selecione Adicionar referência de projeto.

  2. Selecione "StringLibrary".

Adicionar e executar métodos de teste de unidade

Quando o Visual Studio invoca um teste de unidade, ele executa cada método marcado com o atributo TestMethodAttribute em uma classe marcada com o atributo TestClassAttribute. Um método de teste termina quando a primeira falha é encontrada ou quando todos os testes contidos no método foram bem-sucedidos.

Os testes mais comuns chamam membros da classe Assert. Muitos métodos de afirmação incluem pelo menos dois parâmetros, um dos quais é o resultado esperado do teste e o outro é o resultado real do teste. Alguns dos métodos mais frequentemente chamados da classe Assert são mostrados na tabela a seguir:

Métodos de asserção Função
Assert.AreEqual Verifica se dois valores ou objetos são iguais. A declaração falhará se os valores ou objetos não forem iguais.
Assert.AreSame Verifica se duas variáveis de objeto se referem ao mesmo objeto. A asserção falhará se as variáveis se referirem a objetos diferentes.
Assert.IsFalse Verifica se uma condição é false. A asserção falhará se a condição for true.
Assert.IsNotNull Verifica se um objeto não é null. A afirmação falha se o objeto for null.

Você também pode usar o método Assert.ThrowsException (ou Assert.Throws e Assert.ThrowsExactly se estiver usando o MSTest 3.8 e posterior) em um método de teste para indicar o tipo de exceção que se espera que ele gere. O teste falhará se a exceção especificada não for lançada.

Ao testar o método StringLibrary.StartsWithUpper, você deseja fornecer várias cadeias de caracteres que começam com um caractere maiúsculo. Você espera que o método retorne true nesses casos, para que você possa chamar o método Assert.IsTrue. Da mesma forma, você deseja fornecer várias cadeias de caracteres que começam com algo diferente de um caractere maiúsculo. Você espera que o método retorne false nesses casos, para que você possa chamar o método Assert.IsFalse.

Como seu método de biblioteca manipula cadeias de caracteres, você também deseja certificar-se de que ele manipula com êxito uma cadeia de caracteres vazia (String.Empty) e uma cadeia de caracteres null. Uma cadeia de caracteres vazia é aquela que não tem caracteres e cuja Length é 0. Uma cadeia de caracteres null é aquela que não foi inicializada. Pode chamar o StartsWithUpper diretamente como um método estático e passar um argumento único, String. Ou você pode chamar StartsWithUpper como um método de extensão em uma variável string atribuída a null.

Você definirá três métodos, cada um dos quais chama um método Assert para cada elemento em uma matriz de cadeia de caracteres. Você chamará uma sobrecarga de método que permite especificar uma mensagem de erro a ser exibida em caso de falha no teste. A mensagem identifica a cadeia de caracteres que causou a falha.

Para criar os métodos de teste:

  1. Abra StringLibraryTest/UnitTest1.cs e substitua todo o código pelo código a seguir.

    using Microsoft.VisualStudio.TestTools.UnitTesting;
using UtilityLibraries;

namespace StringLibraryTest
{
    [TestClass]
    public class UnitTest1
    {
        [TestMethod]
        public void TestStartsWithUpper()
        {
            // Tests that we expect to return true.
            string[] words = { "Alphabet", "Zebra", "ABC", "Αθήνα", "Москва" };
            foreach (var word in words)
            {
                bool result = word.StartsWithUpper();
                Assert.IsTrue(result,
                       string.Format("Expected for '{0}': true; Actual: {1}",
                                     word, result));
            }
        }

        [TestMethod]
        public void TestDoesNotStartWithUpper()
        {
            // Tests that we expect to return false.
            string[] words = { "alphabet", "zebra", "abc", "αυτοκινητοβιομηχανία", "государство",
                               "1234", ".", ";", " " };
            foreach (var word in words)
            {
                bool result = word.StartsWithUpper();
                Assert.IsFalse(result,
                       string.Format("Expected for '{0}': false; Actual: {1}",
                                     word, result));
            }
        }

        [TestMethod]
        public void DirectCallWithNullOrEmpty()
        {
            // Tests that we expect to return false.
            string?[] words = { string.Empty, null };
            foreach (var word in words)
            {
                bool result = StringLibrary.StartsWithUpper(word);
                Assert.IsFalse(result,
                       string.Format("Expected for '{0}': false; Actual: {1}",
                                     word == null ? "<null>" : word, result));
            }
        }
    }
}

    O teste de caracteres maiúsculos no método TestStartsWithUpper inclui a letra maiúscula grega alfa (U+0391) e a letra maiúscula cirílica EM (U+041C). O teste de caracteres minúsculos no método TestDoesNotStartWithUpper inclui a letra pequena grega alfa (U+03B1) e a letra pequena cirílica Ghe (U+0433).

  2. Salve suas alterações.

Crie e execute seus testes

  1. No Gerenciador de Soluções, clique com o botão direito do mouse na solução e selecione Build ou na Paleta de comandos, selecione .NET: Build.

  2. Selecione a janela Teste, selecione Executar testes ou na Paleta de comandos, selecione Test: Executar todos os testes.

    Gerenciador de Teste de Código do Visual Studio

Lidar com falhas de teste

Se você estiver fazendo desenvolvimento orientado a testes (TDD), você escreve testes primeiro e eles falham na primeira vez que você os executa. Em seguida, você adiciona código ao aplicativo que faz o teste ser bem-sucedido. Para este tutorial, você criou o teste depois de escrever o código do aplicativo que ele valida, para que você não tenha visto o teste falhar. Para validar que um teste falha quando você espera que ele falhe, adicione um valor inválido à entrada de teste.

  1. Modifique a matriz words no método TestDoesNotStartWithUpper para incluir a cadeia de caracteres "Error".

    string[] words = { "alphabet", "Error", "zebra", "abc", "αυτοκινητοβιομηχανία", "государство",
                   "1234", ".", ";", " " };

  2. Execute os testes clicando no erro verde ao lado do teste no editor.

    A saída mostra que o teste falha e fornece uma mensagem de erro para o teste com falha: "Assert.IsFalse falhou. Esperado para 'Erro': falso; atual: verdadeiro". Devido à falha, nenhuma cadeia de caracteres na matriz após "Error" foi testada.

    Teste falhado do Visual Studio Code

  3. Remova a string "Error" que você adicionou na etapa.

  4. Execute novamente o teste e os testes são aprovados.

Testar a versão Release da biblioteca

Agora que todos os testes passaram ao executar a compilação Debug da biblioteca, execute os testes um tempo adicional em relação à compilação Release da biblioteca. Vários fatores, incluindo otimizações do compilador, às vezes podem produzir um comportamento diferente entre as compilações Debug e Release.

  1. Execute os testes com a configuração de compilação Release.

    dotnet test StringLibraryTest/StringLibraryTest.csproj --configuration Release

    Os testes são bem-sucedidos.

Testes de depuração

Se estiveres a usar o Visual Studio Code como o teu IDE, podes usar o mesmo processo mostrado em Depurar uma aplicação de consola .NET usando o Visual Studio Code para depurar o código usando o teu projeto de testes de unidade. Em vez de iniciar o projeto de aplicativo ShowCase, abra StringLibraryTest/UnitTest1.cse selecione Debug Tests no de arquivo atual entre as linhas 7 e 8. Se não conseguir encontrá-lo, pressione Ctrl+Shift+P para abrir a paleta de comandos e digite Recarregar janela.

O Visual Studio Code inicia o projeto de teste com o depurador anexado. A execução será interrompida em qualquer ponto de interrupção que você adicionou ao projeto de teste ou ao código da biblioteca subjacente.

Recursos adicionais

Próximos passos

Neste tutorial, testaste uma biblioteca de classes. Você pode disponibilizar a biblioteca para outras pessoas publicando-a no NuGet como um pacote. Para saber como, siga um tutorial do NuGet:

Criar e publicar um pacote usando a CLI dotnet

Se você publicar uma biblioteca como um pacote NuGet, outras pessoas poderão instalá-la e usá-la. Para saber como, siga um tutorial do NuGet:

Instalar e usar um pacote usando a CLI dotnet

Uma biblioteca não precisa ser distribuída como um pacote. Ele pode ser empacotado com um aplicativo de console que o usa. Para saber como publicar um aplicativo de console, consulte o tutorial anterior desta série:

publicar um aplicativo de console .NET usando o Visual Studio Code

A extensão de código do Visual Studio C# Dev Kit fornece mais ferramentas para desenvolver aplicativos e bibliotecas em C#:

Kit de Desenvolvimento C#