Acheve.TestHost una pequeña ayuda en nuestros tests…

¿Usas Microsoft.AspNetCore.TestHost? Si la respuesta es si, seguramente (espero) lo que te contaré en este post te resulte útil. Por el contrario, si aún no conoces como y para que usar esta librería este post igual te ayuda a descubrir una nueva forma de testar tus HTPP API.

Para los que conozcáis TestServer, incluida dentro de Microsoft.AspNetCore.TestHost, sabréis que nos ofrece una manera de testar nuestros proyectos de HTTP API de una forma simple y muy poderosa. La idea subyacente es ofrecernos un cliente HttpClient que podremos utilizar para llamar a nuestro API sin necesidad de que este sea alojado en ningún servidor web.

Introducción

Para ilustrar este trabajo supongamos que partimos de la plantilla por defecto de ASP.NET Core para API HTTP.

Probar este controlador tal cual seria llamado por un cliente usando HTTP se vuelve insultantemente simple, tan solo tendremos que configurar nuestro TestServer y realizar las llamadas.

Del fragmento anterior hay un elemento importante que mencionar. Para crear nuestro TestServer hemos utilizado un IWebHost construido con una clase de Startup, la cual podría ser tranquilamente la misma que usamos en el proyecto para definir nuestro HTTP API aunque esto, para ilustrar nuestro post sirve, en realidad, suele ser mejor idea que el propio proyecto de test pueda definir su clase de startup.

Separar el alojamiento de tus proyectos de API HTTP siempre es una buena idea, y no solamente porque nos permitirá en nuestros proyecto de test quitarnos ruido que solo afecta al alojamiento.

Ahora que ya tenemos nuestro HttpClient ya podremos utilizarlo para hacer las llamadas a nuestro controlador.

En este post solamente nos estamos centrando en presentar de forma ligera TestServer. En futuras entradas veremos como es recomendable reutilizar para nuestros diferentes tests esta instancia y como podremos hacerlo con ClassFixtures / CollectionFixtures, en el caso de xunit, así como otros elementos habituales en este tipo de Tests, pero que se escapan aquí al propósito de esta entrada.

¿Porqué usar Acheve.TestHost?

¿Para que crear una librería si TestServer es ya tan potente? Pues bien, porque hay ciertos escenarios habituales que nos puede resultar  muy útil y nos librará de mucho código extra que hacer. A continuación presentaremos dos puntos  donde nos ofrecerá mejoras apreciables.

Seguridad

Por regla general, nuestras HTTP API están securizadas y la ejecución de las acciones requerirá que el usuario esté autorizado. De hecho, en nuestro ejemplo hemos puesto el atributo Authorization por el cual solamente los usuarios autenticados podrán ejecutar las acciones del controlador ValuesController. 

Nuestro host es quien elige como autenticamos estas llamadas, así por ejemplo en nuestro caso podríamos tener lo siguiente:

Si no hemos separado las clases de Startup de nuestro alojamiento de la clase Startup usada al construir TestServer, tendremos que lidiar en como conseguir estos tokens JWT para hacer nuestras llamadas con las clase HttpClient conseguida anteriormente. Sin embargo, si separamos ambos mundos, en nuestro alojamiento podríamos tener el código anterior y en nuestros tests podríamos cambiarlo para hacernos la vida mas sencilla. Achve.TestHost nos permite que podamos configurar nuestra clase Startup de test con un mecanismo propio de autenticación que nos simplificará mucho las pruebas en nuestros tests.

El método AddTestServerAuthentication nos habilita que las llamadas que hagamos con nuestro HttpClient estén autenticadas y además que en los tests podamos establecer fácilmente las claims que necesitemos para cada prueba.

Como podemos ver en el siguiente fragmento.

En pocas palabras diríamos que AddTestServerAuthentication nos habilita un nuevo middleware sobre el que después podremos establecer un conjunto de claims que serán establecidas en el contexto del usuario para cada una de las pruebas que hagamos. En concreto, el método WithIdentity es el que  nos permitirá establecer estas claims a utilizar para cada uno de nuestros tests.

Uris

Otro de los elementos con los que solemos lidiar en los tests con TestServer es el manejo de estas magic strings que representan las uris de las rutas a las que llamamos, como en el caso anterior api/values. Las alternativas habituales son varias, como crear una pequeña clase estática en la que definamos estas rutas y que sea fácilmente modificable y/o parametrizable como por ejemplo la siguiente.

El problema de esta aproximación, aunque también tiene sus ventajas está en el hecho de que precisamente son magic strings, que representan unas rutas que en el día a día pueden ser alteradas y que romperán muchos tests por el mero hecho de una cambio de nombre, un nuevo segmento de ruta etc. Acheve.TestHost nos ofrece un nuevo método extensor a TestServerCreateHttpApiRequest, que nos permitirá devolvernos un RequestBuilder configurado con una ruta construída con una expresión lambda de la llamada al controlador. En el siguiente fragmento podemos ver un sencillo ejemplo:

En estos momentos CreateHttpApiRequest solamente es capaz de entender rutas construídas con AttributeRouting y no mediante la definición de mapa de rutas y/o otras convenciones. En nuestro caso suponemos que AttributeRouting es la norma por defecto por ser la más flexible de todas.

Resúmen

Acheve.TestHost es un proyecto de Xabaril, en el que he tenido la suerte de participar junto con el impulsor y padre del mismo Hugo Biarge  @hbiarge.

https://github.com/Xabaril/Acheve.TestHost

https://github.com/Xabaril

Aunque hay mucho que profundizar, en esta entrada hemos visto que es TestServer y porqué Acheve.TestHost nos aporta ciertas funcionalidades que nos ayudarán en su uso.

Si quiere ver algún ejemplo de uso de Acheve.TestHost aquí.

Si quiere aprender más las posibilidades de CreateHttpApiRequest aquí.

Si quiere revisar la WiKi del proyecto aquí.

Shadow Properties – Otros ejemplos de uso

La verdad es que ya llevo unas cuantas charlas encima sobre EF Core 1.1 en las que trato de hacer un repaso por encima de las diferentes características nuevas o de como se han implementado las que ya conocíamos de EF 6.X.  Por suerte, cada vez tenemos más características que enseñar o más capacidades dentro de las características ya existentes que hacen que estas charlas no sean tan repetitivas.

Una de estas características nuevas que suele llamar la atención es el concepto de Shadow Properties, o propiedades que existirán en nuestro modelo relacional pero no las tendremos “visibles” en nuestro modelo de entidades. Para explicar estas propiedades, casi siempre suelo recurrir al típico ejemplo de propiedades de “fontanería” como por ejemplo los típicos conceptos de UpdatedBy, UpdatedOn. Por lo general este tipo de elementos los queremos como elementos básicos de funcionamiento pero no son importantes a la hora de modelar un problema, por eso nos referimos a ellos como elementos de “fontanería”. Incluir estos conceptos resulta de lo más trivial como podemos ver a continuación:

Fíjese como en nuestro método de configuración del modelo, OnModelCreating, hemos dispuesto dos propiedades nuevas que no tenemos en nuestra entidad. Si hacemos una simple migración podríamos ver como efectivamente EF generará estos elementos en nuestro modelo relacional.

Por supuesto, y más en este caso que las hemos establecido como requeridas, tenemos que tener la posibilidad de establecer los valores de las mismas. Aunque hay diferentes alternativas y patrones de código para hacer esto relativamente sencillo lo más natural para demostrarlo sería recurrir a nuestro SaveChanges para hacer este trabajo.

Pues bien, aunque las Shadow Properties, se explican muy bien con estos conceptos de fontanería en realidad pueden tener más utilidades. Si hay algo que mucha gente pregunta con respecto a EF 6.X es  que ya no existe el concepto de ComplexTypes, que por lo general eran usados como ValueObjects en estilos orientados al dominio. Una forma simple para realizar ValueObjects dentro de EF Core podría ser precisamente con el uso de Shadow Properties. Para ello, veamos un ejemplo simple, que por supuesto tiene detalles que deberían ser revisados y/o mejorados.

Lo primero, será definir una pequeña clase base que nos permita marcar ciertos elementos como Value Objects y por lo tanto que sepa compararlos por su contenido. Para ello, podemos buscar por internet muchos ejemplos de implementaciones, aunque lo más básico ( no lo mejor ) podría ser algo como esto:

 

Una vez definida esta clase, podemos ya marcar nuestras entidades con la misma, por ejemplo una clase Address, que podríamos escribir como sigue:

¿Donde entre el uso de las Shadow Properties? Pues bien, una de las cosas que restringimos en nuestros Value Objects es el concepto de identidad en contenido. Es decir dos direcciones son iguales si su contenido es el mismo no si una clave de identidad es igual. Sin embargo EF nos obliga a que todas las entidades que mapeemos tengan un clave primaria/identidad. Las Shadow Properties nos permitirán sacar esta “restricción” fuera de nuestra clase Address y sin embargo que EF siga pudiendo funcionar.

En este caso el mapeo podría realizarse como sigue:

Como hemos visto, el concepto de Shadow Properties nos habilitan más escenarios que el simple de mecanismos de fontanería. En este caso hemos visto otro uso con respecto a la definición de Value Objects pero seguro que se le ocurren muchos más.

 

Saludos

Unai

 

 

 

 

 

 

 

 

 

 

Inyeccion de dependencias de .NET Core – #3 TransientAndDispose

Bien, esta será la última entrada por ahora de esta pequeña serie acerca de elementos con los que tenemos que tener cuidado cuando trabajemos con inyección de dependencias en .NET Core. En esta ocasión hablaremos sobre como funciona el ciclo de vida de nuestras dependencias y cuando se liberan los recursos de las mismas. Paria ello, vamos a empezar con la misma clase que hemos utilizado en esta serie, aunque ahora implementando IDisposable.

Bien, el sistema de DI de .NET Core nos asegura que la llamada a nuestro método Dispose se realizará  una vez que el proveedor finalize su ámbito. Por el código que estoy viendo últimamente, mucha gente tiende a registrar ciertos componentes usando directamente el IServiceProvider que tenemos en nuestro método de configuración, que generalmente vivirá todo el tiempo que viva nuestra aplicación web. Por lo tanto, todas estas dependencias transient seguirán vivas en nuestras aplicaciones, haciendo que la memoria crezca ad infinitum. Vamos a ilustrar este caso con un sencillo ejemplo.

Si cuando acaba la ejecución de este bucle revisáramos los miembros de nuestro provider veriamos un campo llamado _transientDisposables que mantienen una referencia a las 1000 dependencias que hemos resuelto del contenedor.

Por supuesto, esto no sucede en un ciclo normal de una aplicación ASP.NET Core puesto que las mismas se hacen en un scope que después es limpiado. Vendría ser algo como lo siguiente:

El corolario de esta entrada es entonces.. ten cuidado de que proveedor haces la resolución de tus dependencias, ten cuidado que el mismo se libere y todos tus objetos disposables puedan a su vez liberar recursos. Revisa _transientDisposables para obtener posible información de fugas de memoria.

 

Saludos

Unai

Inyeccion de dependencias de .NET Core – #2 Scoped2Singleton

Continuando con la serie empezada con los deadlock en la inyeccion de dependencias de .NET Core en esta ocasión vamos a hablar de otra práctica erronea como asignar una dependencia de tipo Scope a un componente registrado como Singleton. Empezaremos como siempre ilustrándolo con un pequeño ejemplo, dónde usaremos las mismas clases que en la entrada anterior:

Estas clases las registraremos como sigue:

Como observas, tenemos un componente SomeClass registrado como Singleton pero que depende de DependencyClass que está a su vez registrada como Scoped. El problema de este tipo de registros es que si no pensamos en realidad lo que estamos diciendo podemos pasar por alto que esta dependencia Scoped en realidad se convertirá en Singleton y, por lo tanto, podremos tener muchos problemas si no lo tenemos en consideración. Vamos a comprobarlo agregando el siguiente código después del registro de nuestras dependencias:

En el código anterior estamos simulando la creación de diferentes scopes, recuerde que en una aplicación ASP.NET Core cada request sería un nuevo Scope. Si observamos el HashCode de cada elemento Dependency nos será fácil ver que siempre tenemos el mismo valor.

Como hemos dicho al principio, esto no es un bug sino una consideración que tenemos que tener y ser consicente de ella, toda dependencia scope de un singleton se convierte en singleton.

En .NET Core 1.1 tenemos un pequeño flag para indicarle a nuestro sistema de DI que nos avise sobre estos posibles errores. Con el uso de este flag en la situación anterior se lanzaría una excepcion al intentar resolver SomeClass. En el siguiente fragmento podemos ver el codigo completo con el uso de este flag.

 

Saludos

Unai Zorrilla

Inyeccion de dependencias de .NET Core – #1 DeadLocks

A lo largo de esta serie de post que hoy empieza no quiero repetir muchos de los elementos que ya tenemos en la propia documentación oficial de .NET Core. El nuevo portal de documentación Microsoft Docs ya tiene mucha información sobre Quick Starts y los elementos más comunes, por lo que escribir sobre eso creo que no aporta demasiado. Incluso en el libro de introducción a .NET Core puedes ver muchos conceptos y prácticas más allá de estos “comienzos”.  En esta serie de entradas me gustaría hablar de ciertos aspectos problemáticos o con los que podemos tener problemas si no los tenemos en consideración. Continúa leyendo Inyeccion de dependencias de .NET Core – #1 DeadLocks