Unlimited Plugins, WordPress themes, videos & courses! Unlimited asset downloads! From $16.50/m
Advertisement
  1. Code
  2. PHP
Code

Prueba de los controladores Laravel

by
Difficulty:AdvancedLength:LongLanguages:

Spanish (Español) translation by Elías Nicolás (you can also view the original English article)

Prueba de controladores no es la cosa más fácil en el mundo. Bueno, déjame reformular eso: probarlos es muy facil; Lo que es difícil, al menos al principio, es determinar qué probar.

Should a controller test verify text on the page? ¿Debo tocar la base de datos? ¿Debe asegurarse de que existen variables en la vista? Si este es su primer paseo de heno, estas cosas pueden ser confusas! Déjame ayudar.

Las pruebas del controlador deben verificar las respuestas, asegurarse de que se activan los métodos correctos de acceso a la base de datos y afirmar que las variables de instancia apropiadas se envían a la vista.

El proceso de prueba de un controlador se puede dividir en tres partes.

  • Aislar: Mock todas las dependencias (tal vez excluyendo  View).
  • Llamar: Disparar el método del controlador deseado.
  • Asegúrarse: Realizar afirmaciones, verificando que la etapa se ha ajustado correctamente.

El Hello World de la prueba del Controlador

La mejor manera de aprender estas cosas es a través de ejemplos. Aquí está el "hello world" de las pruebas de controladores en Laravel.

Laravel aprovecha un puñado de componentes Symfony para facilitar el proceso de prueba de rutas y vistas, incluyendo HttpKernel, DomCrawler y BrowserKit. Esta es la razón por la cual es primordial que sus pruebas PHPUnit heredan, no PHPUnit\_Framework\_TestCase, pero TestCase. No te preocupes, Laravel todavía extiende la primera, pero ayuda a configurar la aplicación de Laravel para la prueba, así como proporciona una variedad de métodos de aserción de ayuda que te animan a usar. Más sobre eso en breve.

En el fragmento de código anterior, hacemos una solicitud GET a /post o localhost:8000/posts. Suponiendo que esta línea se agregue a una nueva instalación de Laravel, Symfony lanzará una NotFoundHttpException. Si está trabajando, intente ejecutar phpunit desde la línea de comandos.

En la palabra humana, esto se traduce básicamente a, "Hey, traté de llamar a esa ruta, pero usted no tiene nada registrado, ¡tonto!"

Como se puede imaginar, este tipo de solicitud es bastante común al punto de que tiene sentido proporcionar un método auxiliar, como $this->call(). De hecho, ¡Laravel hace eso mismo! Esto significa que el ejemplo anterior puede ser refactorizado, así:

La sobrecarga es su amigo

Aunque seguiremos con la funcionalidad básica en este capítulo, en mis proyectos personales, voy más allá al permitir métodos como $this->get(), $this->post(), etc. Gracias a PHP sobrecarga, esto sólo requiere la adición de un único método, que se podría añadir a app/tests/TestCase.php.

Ahora, eres libre de escribir $this->get('posts') y lograr el mismo resultado que los dos ejemplos anteriores. Como se señaló anteriormente, sin embargo, vamos a seguir con la funcionalidad base del marco para la simplicidad.

Para hacer pasar la prueba, sólo tenemos que preparar la ruta adecuada.

Ejecutar phpunit de nuevo nos devolverá verde.


Assertions de Laravel Helper

Una prueba que te encontrarás escribiendo repetidamente es aquel que asegura que un controlador pasa una variable particular a una vista. Por ejemplo, el método de index de PostsController debe pasar una variable $posts a su vista asociada, ¿verdad? De esta forma, la vista puede filtrar todos los mensajes y mostrarlos en la página. Esta es una prueba importante para escribir!

Si es que una tarea común, entonces, una vez más, ¿no tendría sentido para Laravel para proporcionar una afirmación de ayuda para lograr esto mismo? Por supuesto. ¡Y, por supuesto, a Laravel tambien!

Illuminate\Foundation\Testing\TestCase incluye una serie de métodos que reducirán drásticamente la cantidad de código necesaria para realizar aserciones básicas. Esta lista incluye:

  • assertViewHas
  • assertResponseOk
  • assertRedirectedTo
  • assertRedirectedToRoute
  • assertRedirectedToAction
  • assertSessionHas
  • assertSessionHasErrors

Los siguientes ejemplos llaman a GET /posts y verifica que sus vistas reciben la variable, $posts.

Sugerencia: Cuando se trata de formatear, prefiero proporcionar un salto de línea entre la afirmación de una prueba y el código que prepara la etapa.

AssertViewHas es simplemente un poco de azúcar que inspecciona el objeto de respuesta - que se devuelve desde  $this->call() - y verifica que los datos asociados con la vista contienen una variable posts.

Al inspeccionar el objeto de respuesta, tiene dos opciones principales.

  • $response->getOriginalContent(): busca el contenido original o la devuelta View. Opcionalmente, puede acceder a la propiedad original directamente, en lugar de llamar al método getOriginalContent.
  • $Response->getContent(): Obtiene la salida renderizada. Si se devuelve una instancia View de la ruta, entonces getContent() será igual a la salida HTML. Esto puede ser útil para verificaciones de DOM, como "la vista debe contener esta cadena".

Supongamos que la ruta de posts consta de:

Deberíamos ejecutar phpunit, se fallara con un útil paso siguiente mensaje:

Para hacerlo verde, simplemente buscamos los posts y lo pasamos a la vista.

Una cosa a tener en cuenta es que, como el código actual, sólo asegura que la variable, $posts, se pasa a la vista. No inspecciona su valor. El assertViewHas opcionalmente acepta un segundo argumento para verificar el valor de la variable, así como su existencia.

Con este código modificado, a menos que la vista tenga una variable, $posts, que sea igual a foo, la prueba fallará. En esta situación, sin embargo, es probable que prefieramos no especificar un valor, sino que declaramos que el valor es una instancia de la clase Illuminate\Database\Eloquent\Collection de Laravel. ¿Cómo podríamos lograr eso? PHPUnit proporciona una afirmación assertInstanceOf útil para llenar esta misma necesidad!

Con esta modificación, hemos declarado que el controlador debe pasar $posts - una instancia de Illuminate\Database\ Eloquent\Collection - a la vista. Excelente.


Mocking la base de datos

Hay un problema flagrante con nuestras pruebas hasta ahora. ¿Lo atrapaste?

Para cada prueba, se está ejecutando una consulta SQL en la base de datos. Aunque esto es útil para ciertos tipos de pruebas (aceptación, integración), para las pruebas básicas del controlador, sólo servirá para disminuir el rendimiento.

He perforado esto en su cráneo varias veces en este momento. No estamos interesados en probar la capacidad de Eloquent de buscar registros de una base de datos. Tiene sus propias pruebas. ¡Taylor sabe que funciona! No perdamos tiempo y poder de procesamiento repitiendo las mismas pruebas.

En su lugar, lo mejor es burlarse de la base de datos, y simplemente verificar que los métodos apropiados se llaman con los argumentos correctos. O, en otras palabras, queremos asegurarnos de que Post::all() nunca se dispara y llega a la base de datos. Sabemos que funciona, por lo que no requiere pruebas.

Esta sección dependerá en gran medida de la biblioteca Mockery. Por favor revise ese capítulo de mi libro, si aún no está familiarizado con él.

Refactorización Requerida

Lamentablemente, hasta ahora, hemos estructurado el código de una manera que hace prácticamente imposible probar.

Esta es precisamente la razón por la que se considera mala práctica anidar llamadas de Eloquent en sus controladores. No confundas las fachadas de Laravel, que son comprobables y pueden intercambiarse con mocks (Queue::shouldReceive()), con tus modelos Eloquent. La solución es inyectar la capa de base de datos en el controlador a través del constructor. Esto requiere una cierta refactorización.

Advertencia: almacenar la lógica dentro de las devoluciones de llamada de ruta es útil para proyectos pequeños y API, pero hacen que las pruebas sean increíblemente difíciles. Para aplicaciones de cualquier tamaño considerable, utilice controladores.

Registremos un nuevo recurso reemplazando la ruta de posts con:

... y crear el controlador de recursos necesarios con Artisan.

Ahora, en lugar de referenciar directamente el modelo Post, lo inyectaremos en el constructor del controlador. He aquí un ejemplo condensado que omite todos los métodos de restful, excepto el que estamos actualmente interesados en las pruebas.

Tenga en cuenta que es una mejor idea escribir la sugerencia de una interfaz, en lugar de hacer referencia al modelo Eloquent, en sí. Pero, ¡una cosa a la vez! Vamos a trabajar hasta eso.

Esta es una manera significativamente mejor de estructurar el código. Debido a que el modelo ahora se inyecta, tenemos la capacidad de intercambiarlo con una versión simulada para la prueba. He aquí un ejemplo de hacer eso:

El principal beneficio de esta reestructuración es que, ahora, la base de datos nunca será usada innecesariamente. En su lugar, usando Mockery, simplemente verificamos que el método all se dispara en el modelo.

Por desgracia, si elige renunciar a la codificación a una interfaz, y en su lugar inyectar el modelo Post en el controlador, un poco de trucos tiene que ser utilizados con el fin de evitar el uso de Eloquent de la estática, que puede chocar con Mockery. Esta es la razón por la que hijack tanto el Post y Eloquent clases dentro del constructor de la prueba, antes de las versiones oficiales se han cargado. De esta manera, tenemos una lista limpia para declarar cualquier expectativa. La desventaja, por supuesto, es que no podemos usar ningún método existente, a través del uso de métodos de Mockery, como makePartial().

El contenedor de IoC

El contenedor IoC de Laravel facilita drásticamente el proceso de inyección de dependencias en sus clases. Cada vez que se solicita un controlador, se resuelve fuera del contenedor de IoC. Como tal, cuando necesitamos declarar que una versión simulada de Post se debe utilizar para la prueba, sólo tenemos que proporcionar a Laravel la instancia de Post que debe utilizarse.

Piense en este código como diciendo: "Hey Laravel, cuando necesitas una instancia de Post, quiero que uses mi versión mock." Debido a que la aplicación extiende el Container, tenemos acceso a todos los métodos de IoC directamente fuera de él.

Tras la instanciación del controlador, Laravel aprovecha la potencia de la reflexión de PHP para leer el tipo e inyectar la dependencia para usted. Está bien; Usted no tiene que escribir un solo enlace para permitir esto; ¡Es automatizado!


Redirecciones

Otra expectativa común de que te encontrarás escribiendo es aquella que asegura que el usuario sea redirigido a la ubicación correcta, tal vez al agregar una nueva entrada a la base de datos. ¿Cómo podemos lograr esto?

Suponiendo que estamos siguiendo un sabor restful, para agregar un nuevo post, hacemos POST a la colección, o posts (no confunda el método de solicitud POST con el nombre del recurso, que sólo tiene el mismo nombre).

Entonces, sólo necesitamos aprovechar otra de las aserciones de ayuda de Laravel, assertRedirectedToRoute.

Sugerencia: Cuando un recurso está registrado con Laravel (Route::resource()), el framework registrará automáticamente las rutas nombradas necesarias. Ejecute php artisan routes si alguna vez se olvida de cuáles son estos nombres.

Es posible que prefiera también asegurarse de que el $_POST superglobal se pasa al método create. A pesar de que no estamos enviando físicamente un formulario, todavía podemos permitir esto, a través del método Input::replace(), que nos permite "stub" esta array. Aquí está la prueba modificada, que utiliza el método with() de Mockery para verificar los argumentos pasados al método al que hace referencia shouldReceive.


Rutas

Una cosa que no hemos considerado en esta prueba es la validación. Debe haber dos caminos separados a través del método store, dependiendo de si la validación pasa:

  1. Redirigir de nuevo al formulario "Crear publicación" y mostrar los errores de validación de formulario.
  2. Redirigir a la colección, o la ruta nombrada, posts.index.

Como una práctica recomendada, cada prueba debe representar un solo camino a través de su código.

Esta primera ruta será para validación fallida.

El fragmento de código anterior declara explícitamente qué errores deben existir. Alternativamente, puede omitir el argumento a assertSessionHasErrors, en cuyo caso se limitará a verificar que una bolsa de mensajes ha sido destellada (en la traducción, su redirección incluye withErrors($errors)).

Ahora, para la prueba que maneja la validación exitosa.

El código de producción para estas dos pruebas podría ser:

Observe cómo el Validator está anidado directamente en el controlador? En general, te recomiendo que abstraigas esto a un servicio. De esta forma, puede probar su validación de forma aislada de cualquier controlador o ruta. Sin embargo, dejemos las cosas como están por la simplicidad. Una cosa a tener en cuenta es que no estamos mock al Validator, aunque ciertamente podría hacerlo. Debido a que esta clase es una fachada, se puede intercambiar fácilmente con una versión burlada, a través del método shouldReceive de la Facade, sin que tengamos que preocuparnos por inyectar una instancia a través del constructor. ¡Victoria!

De vez en cuando, usted encontrará que un método que necesita ser mock debe devolver un objeto, por sí mismo. Por suerte, con Mockery, esto es un muy facil: sólo necesitamos crear un simulacro anónimo, y pasar una array , que señala el nombre del método y el valor de respuesta, respectivamente. Como tal:

Preparará un objeto, que contiene un método fails() que devuelve true.


Repositorios

Para permitir una flexibilidad óptima, en lugar de crear un enlace directo entre su controlador y un ORM, como Eloquent, es mejor codificar en una interfaz. La ventaja considerable de este enfoque es que, si tal vez necesitas intercambiar Eloquente por, digamos, Mongo o Redis, hacerlo literalmente requiere la modificación de una sola línea. Incluso mejor, el controlador no necesita ser tocado nunca.

Los repositorios representan la capa de acceso a datos de su aplicación.

¿Qué aspecto podría tener una interfaz para administrar la capa de base de datos de un Post? Esto debería hacerlo empezar.

Esto ciertamente puede ser ampliado, pero hemos añadido los métodos mínimos para la demostración: all, find y create. Observe que las interfaces del repositorio se almacenan en app/repositories. Debido a que esta carpeta no se carga automáticamente de forma predeterminada, necesitamos actualizar el archivo composer.json para que la aplicación le haga referencia.

Cuando se añade una nueva clase a este directorio, no olvides al composer dump-autoload -o El indicador -o, (optimize) es opcional, pero siempre debe usarse, como una mejor práctica.

Si intenta inyectar esta interfaz en su controlador, Laravel fallara Adelante; Pruebalo y vea. Aquí está el PostController modificado, que se ha actualizado para inyectar una interfaz, en lugar del modelo Post Eloquent.

Si ejecuta el servidor y ve la salida, se encontrará con la temida (pero hermosa) página de error Whoops , declarando que "PostRepositoryInterface no es instanciable."

Not Instantiable

Si usted piensa en ello, por supuesto, ¡el marco esta fallando! Laravel es inteligente, pero no es un lector mental. Se necesita saber qué implementación de la interfaz debe utilizarse dentro del controlador.

Por ahora, vamos a agregar este enlace a app/routes.php. Posteriormente, en su lugar utilizaremos proveedores de servicios para almacenar este tipo de lógica.

Verbalize esta llamada de función como, "Laravel, bebé, cuando necesitas una instancia de PostRepositoryInterface, quiero que uses EloquentPostRepository."

App/repositories/EloquentPostRepository simplemente será una envoltura alrededor de Eloquent que implementa PostRepositoryInterface. De esta manera, no estamos restringiendo la API (y cualquier otra implementación) a la interpretación de Eloquent; Podemos nombrar los métodos como quisiéramos.

Algunos podrían argumentar que el modelo Post debería ser inyectado en esta implementación con fines de testabilidad. Si usted está de acuerdo, simplemente inyectarlo a través del constructor, como habitualmente.

Eso es todo lo que debe tomar hacerlo! Actualiza el navegador y las cosas deberían volver a la normalidad. Sólo ahora su aplicación está mucho mejor estructurada y el controlador ya no está vinculado a Eloquent.

Imaginemos que, dentro de unos meses, su jefe le informará que necesita intercambiar Eloquent con Redis. Pues bien, ya que ha estructurado su aplicación de esta manera a prueba de futuro, sólo necesita crear la nueva app/repositories/RedisPostRepository:

Y actualizar el enlace:

Al instante, ahora está aprovechando Redis en su controlador. ¿Noto cómo app/controllers/PostsController.php nunca se tocó? Esa es la belleza de la misma!


Estructura

Hasta ahora en esta lección, nuestra organización ha sido un poco carente. IoC enlaces en el archivo routes.php? Todos los repositorios agrupados en un directorio? Claro, eso puede funcionar al principio, pero, muy rápidamente, se hará evidente que esto no escala.

En la sección final de este artículo, PSR-er nuestro código, y aprovechar los proveedores de servicios para registrar cualquier consolidación aplicable.

PSR-0 define los requisitos obligatorios que deben cumplirse para la interoperabilidad del cargador automático.

Un cargador PSR-0 puede estar registrado con Composer, a través del objeto psr-0.

La sintaxis puede ser confusa al principio. Ciertamente fue para mí. Una manera fácil de descifrar "Way": "app/lib/" es pensar en ti mismo, "La carpeta base para el espacio de nombres Way se encuentra en app/lib." Por supuesto, reemplazar mi apellido con el nombre de su proyecto. La estructura de directorios para que coincida con esto sería:

  • app/
    • lib/
    • Way/

A continuación, en lugar de agrupar todos los repositorios en un directorio de repositories, un enfoque más elegante podría ser clasificarlos en varios directorios, de la siguiente manera:

  • app/
    • lib/
    • Way/
      • Storage/
      • Post/
        • PostRepositoryInterface.php
        • EloquentPostRepository.php

Es vital que nos adherimos a esta convención de nomenclatura y carpeta, si queremos que el autoloading funcione como se espera. Lo único que queda por hacer es actualizar los espacios de nombres para PostRepositoryInterface y EloquentPostRepository.

Y para la implementación:

Aquí vamos; Eso es mucho más limpio. Pero, ¿qué pasa con esas molestas fijaciones? El archivo de rutas puede ser un lugar conveniente para experimentar, pero tiene poco sentido almacenar allí permanentemente. En su lugar, utilizaremos los proveedores de servicios.

Los proveedores de servicios no son nada más que las clases de arranque que se pueden utilizar para hacer lo que quieras: registrar un enlace, conectar un evento, importar un archivo de rutas, etc.

El registro de un proveedor de servicios () será activado automáticamente por Laravel.

Para que este archivo sea conocido por Laravel, sólo es necesario incluirlo en app/config/app.php, dentro de la array de providers .

Bueno; Ahora tenemos un archivo dedicado para registrar nuevos enlaces.

Actualización de las pruebas

Con nuestra nueva estructura en su lugar, en lugar de mock del modelo Eloquent, en sí, en lugar de eso podemos simular PostRepositoryInterface. He aquí un ejemplo de una prueba de este tipo:

Sin embargo, podemos mejorar esto. Es lógico que cada método dentro de PostsControllerTest necesitará una versión mock del repositorio. Como tal, es mejor extraer parte de este trabajo de preparación en su propio método, así:

No está mal, ¿hey?

Ahora, si quieres ser super-liviano, y estás dispuesto a agregar un toque de lógica de prueba a tu código de producción, ¡incluso podrías realizar tu mock dentro del modelo Eloquent! Esto permitiría:

Detrás de las escenas, esto mock PostRepositoryInterface, y actualizara la vinculación IoC. No se puede obtener mucho más legible que eso!

Permitir esta sintaxis sólo requiere actualizar el modelo Post o, mejor, un BaseModel que todos los modelos Eloquent se extienden. He aquí un ejemplo de lo anterior:

Si puede gestionar la batalla interna "Debería incrustar lógica de prueba en código de producción", verá que esto permite pruebas significativamente más legibles.

Se siente bien, ¿no? Esperemos que este artículo no ha sido demasiado abrumador. La clave es aprender a organizar sus repositorios de tal manera que sean lo más fáciles de simular e inyectar en sus controladores. ¡Como resultado de ese esfuerzo, sus pruebas serán rápidas!

Este artículo es un extracto de mi próximo libro, Laravel Testing Decoded. ¡Manténgase atento para su lanzamiento en mayo de 2013!

Advertisement
Advertisement
Advertisement
Advertisement
Looking for something to help kick start your next project?
Envato Market has a range of items for sale to help get you started.