Prueba unitaria de C# con MSTest y .NET

  • Artículo

Este tutorial le guía por una experiencia interactiva de creación de una solución de ejemplo paso a paso para aprender los conceptos de pruebas unitarias. Si prefiere seguir el tutorial con una solución precompilada, vea o descargue el código de ejemplo antes de comenzar. Para obtener instrucciones de descarga, vea Ejemplos y tutoriales.

Este artículo trata sobre la prueba de un proyecto de .NET Core. Si está realizando pruebas con un proyecto de ASP.NET Core, consulte Pruebas de integración en ASP.NET Core.

Requisitos previos

Creación del proyecto de origen

Abra una ventana del Shell. Cree un directorio llamado unit-testing-using-mstest que contenga la solución. En este directorio nuevo, ejecute dotnet new sln para crear un archivo de solución nuevo para la biblioteca de clases y el proyecto de prueba. Cree un directorio PrimeService. En el esquema siguiente se muestra la estructura de directorios y archivos hasta el momento:

/unit-testing-using-mstest
    unit-testing-using-mstest.sln
    /PrimeService

Convierta PrimeService en el directorio actual y ejecute dotnet new classlib para crear el proyecto de origen. Cambie el nombre de Class1.cs a PrimeService.cs. Reemplace el código del archivo por el código siguiente para crear una implementación con errores de la clase PrimeService:

using System;

namespace Prime.Services
{
    public class PrimeService
    {
        public bool IsPrime(int candidate)
        {
            throw new NotImplementedException("Please create a test first.");
        }
    }
}

Cambie nuevamente el directorio al directorio unit-testing-using-mstest. Ejecute dotnet sln add para agregar el proyecto de biblioteca de clases a la solución:

dotnet sln add PrimeService/PrimeService.csproj

Crear el proyecto de prueba

Cree el directorio PrimeService.Tests. En el esquema siguiente se muestra la estructura de directorios:

/unit-testing-using-mstest
    unit-testing-using-mstest.sln
    /PrimeService
        Source Files
        PrimeService.csproj
    /PrimeService.Tests

Convierta el directorio PrimeService.Tests en el directorio actual y cree un proyecto nuevo con dotnet new mstest. Este comando de dotnet nuevo crea un proyecto de prueba que usa MSTest como la biblioteca de pruebas. La plantilla configura el ejecutor de pruebas en el archivo PrimeServiceTests.csproj:

<ItemGroup>
  <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.7.1" />
  <PackageReference Include="MSTest.TestAdapter" Version="2.1.1" />
  <PackageReference Include="MSTest.TestFramework" Version="2.1.1" />
  <PackageReference Include="coverlet.collector" Version="1.3.0" />
</ItemGroup>

El proyecto de prueba requiere otros paquetes para crear y ejecutar pruebas unitarias. En el paso anterior, dotnet new agregó el SDK de MSTest, el marco de pruebas de MSTest, el ejecutor de MSTest y Coverlet para los informes de cobertura de código.

Agregue la biblioteca de clases PrimeService como otra dependencia al proyecto. Use el comando dotnet add reference:

dotnet add reference ../PrimeService/PrimeService.csproj

Puede ver todo el archivo en el repositorio de muestras en GitHub.

En el esquema siguiente se muestra el diseño de solución final:

/unit-testing-using-mstest
    unit-testing-using-mstest.sln
    /PrimeService
        Source Files
        PrimeService.csproj
    /PrimeService.Tests
        Test Source Files
        PrimeServiceTests.csproj

Cambie al directorio unit-testing-using-mstest y ejecute dotnet sln add:

dotnet sln add ./PrimeService.Tests/PrimeService.Tests.csproj

Creación de la primera prueba

Escriba una prueba con errores, apruébela y repita el proceso. Quite UnitTest1.cs del directorio PrimeService.Tests y cree un nuevo archivo de C# denominado PrimeService_IsPrimeShould.cs con el siguiente contenido:

using Microsoft.VisualStudio.TestTools.UnitTesting;
using Prime.Services;

namespace Prime.UnitTests.Services
{
    [TestClass]
    public class PrimeService_IsPrimeShould
    {
        private readonly PrimeService _primeService;

        public PrimeService_IsPrimeShould()
        {
            _primeService = new PrimeService();
        }

        [TestMethod]
        public void IsPrime_InputIs1_ReturnFalse()
        {
            bool result = _primeService.IsPrime(1);

            Assert.IsFalse(result, "1 should not be prime");
        }
    }
}

El atributo TestClass indica una clase que contiene pruebas unitarias. El atributo TestMethod indica que un método es un método de prueba.

Guarde este archivo y ejecute dotnet test para compilar las pruebas y la biblioteca de clases y luego ejecutar las pruebas. El ejecutor de pruebas de MSTest tiene el punto de entrada del programa para ejecutar las pruebas desde la consola. dotnet test inicia el ejecutor de pruebas con el proyecto de prueba unitaria que creó.

La prueba produce un error. Todavía no ha creado la implementación. Cree esta prueba que se supera escribiendo el código más simple en la clase PrimeService que funciona:

public bool IsPrime(int candidate)
{
    if (candidate == 1)
    {
        return false;
    }
    throw new NotImplementedException("Please create a test first.");
}

En el directorio unit-testing-using-mstest, vuelva a ejecutar dotnet test. El comando dotnet test ejecuta una compilación del proyecto PrimeService y luego del proyecto PrimeService.Tests. Después de compilar ambos proyectos, se ejecuta esta única prueba. Pasa.

Adición de más características

Ahora que la prueba se ha superado, es el momento de escribir más. Hay algunos otros casos simples para números primos: 0, -1. Puede agregar pruebas nuevas con el atributo TestMethod, pero este proceso enseguida se hace tedioso. Hay otros atributos de MSTest que le permiten escribir un conjunto de pruebas similares. Un método de prueba puede ejecutar el mismo código pero tener argumentos de entrada diferentes. Puede usar el atributo DataRow para especificar valores para esas entradas.

En lugar de crear pruebas nuevas, aplique estos dos atributos para crear una sola prueba controlada por datos. La prueba controlada por datos es un método que prueba varios valores menores que dos, que es el número primo menor. Agregue un nuevo método de prueba en PrimeService_IsPrimeShould.cs:

[TestMethod]
[DataRow(-1)]
[DataRow(0)]
[DataRow(1)]
public void IsPrime_ValuesLessThan2_ReturnFalse(int value)
{
    var result = _primeService.IsPrime(value);

    Assert.IsFalse(result, $"{value} should not be prime");
}

Ejecute dotnet test, y dos de estas pruebas no se superarán. Para superar todas las pruebas, cambie la cláusula if al principio del método IsPrime en el archivo PrimeService.cs:

if (candidate < 2)

Puede continuar recorriendo en iteración agregando más pruebas, más teorías y más código en la biblioteca principal. Ya tiene la versión terminada de las pruebas y la implementación completa de la biblioteca.

Ha creado una biblioteca pequeña y un conjunto de pruebas unitarias para esa biblioteca. Ha estructurado la solución, por lo que agregar pruebas y paquetes nuevos es parte del flujo de trabajo normal. Ha centrado la mayor parte del tiempo y del esfuerzo en resolver los objetivos de la aplicación.

Consulte también