Introducción a NUnit (I)

En el proceso de desarrollo de software, una parte muy importante del mismo son las pruebas unitarias. Las pruebas unitarias comprueban la corrección del código. Una prueba unitaria es código que comprueba la corrección de otro código y sirve para contestar a la pregunta ¿Hace mi código “correctamente” lo que se comprometió a hacer?

Con independencia de si te ha gustado o no la definición de prueba unitaria (a muchos nos les gusta hablar de corrección sino del grado de confianza en tu código que te reportan las pruebas), en esta serie de posts me centraré exclusivamente en la utilización de NUnit. El cómo, cuándo y dónde escribir una prueba unitaria… es harina de otro costal.

En este primer post mi intención es poner cara y ojos a NUnit. Ver qué es, cómo se ejecuta y cómo se integra con Visual Studio.

NUnit es un framework de unit testing de testing (ya sea pruebas unitarias, de integración o de cualquier otro tipo… gracias @lantoli por la corrección), muy utilizado en el mundo .NET y ampliamente soportado por herramientas de terceros. Válido para cualquier lenguaje .NET, está escrito en C# y es Open Source. Aunque a día de hoy ha sido complemente reescrito haciendo hincapié en características propias y novedosas de C#, inicialmente fue un port de JUnit (el primer framework de unit testing).

A propósito de esta amalgama de nombres (NUnit, JUnit, Xunit, etc.) puedes leerte este artículo de Martin Fowler que explica qué significa Xunit y el nacimiento de JUnit y NUnit. En mi caso, la confusión vino por confundir Xunit (nombre derivado de JUnit para hacer mención a la familia de frameworks de unit testing) con xUnit.Net, un nuevo framework del creador original de NUnit.

Como queda claro según lo expuesto, NUnit no es el único framework disponible de unit testing. De hecho son muchos y seguro todos ellos con un buen número de seguidores y detractores. Al final está claro que lo que cuenta es escribir buenas pruebas. El utilizar uno u otro framework debería ser algo secundario.

Para disponer de NUnit, bastará con descargar la última versión desde su página oficial e instalarlo a través de un asistente muy sencillo. Una vez instalado, tenemos a nuestra disposición tanto el ensamblado necesario para agregarlo como referencia a un proyecto de Visual Studio (nunit.framework.dll), así como un par de ejecutables (nunit.exe y nunit-console.exe) que actúan como “test runners”. Un test-runner es una herramienta que entiende el framework de testing y es capaz de ejecutar los tests.

Para escribir nuestra primeras pruebas unitarias con NUnit tiraré del manido ejemplo de una calculadora.

    class Calculadora

    {

        public int Sumar(int num1, int num2)

        {

            return num1 + num2;

        }

    }

Una vez tenemos el código que queremos testear, nuestro siguiente paso será agregar NUnit al proyecto. Para ello  bien podemos agregar manualmente una referencia al ensamblado nunit.framework.dll desde el directorio de instalación de NUnit, o bien agregar el paquete NUnit a través de Nuget. Sea cual sea la forma el resultado es siempre el mismo: una referencia a nunit.framework.dll. Yo personalmente prefiero agregar NUnit vía paquete Nuget porque si hay una actualización del paquete (es decir, una actualización de NUnit) tarde o temprano seré consciente de ello a través de Visual Studio. Además, y como veremos más tarde, no siempre es necesario instalar NUnit (en último instancia lo único que necesitamos para escribir nuestras pruebas es el ensamblado nunit.framework.dll).

NUnit se basa en atributos. Para decorar un método como un test simplemente tenemos que añadirle el atributo Test.

    class CalculadoraTest

    {

        [Test]

        public void Sumar()

        {

            var calculadora = new Calculadora();

            var resultado = calculadora.Sumar(1, 2);

            Assert.AreEqual(3, resultado);

        }

    }

Para ejecutar las pruebas unitarias tenemos varias posibilidades:

• Ejecutar uno de los test runner que instaló NUnit (esto claro está, si optamos por instalar NUnit).
• Instalar el plugin NUnit Test Adapter para integrar NUnit dentro de Visual Studio y poder así ejecutar las pruebas desde el mismo IDE.
• Utilizar ReSharper para, de nuevo, ejecutar las pruebas también desde la comodidad del IDE.

Otra opción muy interesante es la que comenta Fernando Pérez (@ferpega_) en los comentarios, que es descargar el paquete de Nuget “NUnit Test Adapter” sin tener que instalarlo como un complemento. Además de hacer la misma función que el complemento, ya no será necesario tener que instalarlo en todos los equipos de desarrollo e incluso en un escenario de CI se descargará automáticamente y lanzará los tests. Gran aporte, Fernando!

Yo personalmente no he probado esa solución para integrar NUnit en un servidor de CI y por el contrario he optado por agregar el paquete NUnit.Runners, que creará un fichero package.config en la carpeta /nuget, es decir, el paquete no está asociado a ningún proyecto en particular. De este modo y hasta nuevo aviso, es necesario agregarlo también a algún proyecto de la solución para que se descargue automáticamente al restaurar paquetes en el servidor de CI (y para ello hay que editar manualmente algún package.config de un proyecto de la solución y agregar a mano la dependencia)… un poco raro, lo sé!

Si hemos instalado NUnit podemos utilizar la herramienta gráfica nunit.exe. La gran ventaja de esta herramienta es que podemos manualmente seleccionar que tests queremos ejecutar. Además, al compilar de nuevo nuestro proyecto desde Visual Studio, nunit-exe detectará el cambio y recargará qué pruebas hay disponibles.

También podemos utilizar nunit-console.exe que, por línea de comandos, recibirá los parámetros necesarios para ejecutar los test que le indiquemos. Por defecto, nunit-console.exe creará un fichero TestResult.xml en el directorio de trabajo con los resultados de las pruebas.

Si no hemos instalado NUnit (esto es que hemos agregado NUnit al proyecto vía Nuget) o no queremos ejecutar las pruebas desde una herramienta externa a Visual Studio porque, por ejemplo, queremos depurar nuestras pruebas, podemos instalar el anteriormente citado plugin NUnit Test Adapter que se integra dentro de Visual Studio y nos da una experiencia de uso igual a la que tendríamos si hubiéramos elegido el framework MSTest (el propio de Microsoft). En realidad esto es posible porque a partir de VS 2012, se ha añadido soporte para frameworks de unit testing de terceros.

Después de instalar NUnit Test Adapter, NUnit estará totalmente integrado en Visual Studio y podremos ejecutar/depurar los tests desde la ventana Test Explorer (disponible en todas las versiones de Visual Studio, incluida la Community Edition). Por otro lado, también podremos ahora utilizar la cobertura de código incluida en Visual Studio sin tener que depender de herramientas de terceros como NCover (aunque la cobertura de código sólo está disponible en las versiones Premium y Ultimate de Visual Studio).

Por último, si tenemos Resharper instalado, no tendremos que instalar ninguna otra herramienta puesto que Resharper reconoce a NUnit y nos brindará la posibilidad de ejecutar/depurar los tests de forma muy amigable y desde el propio IDE. Además, Resharper incorpora 2 ventanas relativas a pruebas unitarias que nos darán información de los test descubiertos y del resultado de la ejecución de los tests.

Ahora que ya has visto qué es NUnit, como agregarlo a un proyecto y cómo ejecutarlo, en siguientes posts indagaremos más en que atributos es importante conocer, que modelos de ejecución propone NUnit y como extenderlo para sacarle el mayor jugo posible.

Mas posts de esta serie:

• Introducción a NUnit(II): Atributos básicos
• Introducción a NUnit(III): Ciclo de vida de un test
• Introducción a NUnit (IV): Tests parametrizados

Un saludo!