Pruebas y Configuración de Controladores en Laravel

Clase 32 de 37 • Curso de Introducción a Laravel 6

Resumen

¿Cómo configurar métodos de prueba para endpoints en Laravel?

El proceso de creación y prueba de endpoints en Laravel es clave para asegurarse de que la aplicación responde correctamente a las peticiones. En este caso, trabajamos con la prueba de un endpoint que permite mostrar un post y la verificación de un error 404 para un post inexistente.

¿Cómo se prueba el método `show` de un controlador en Laravel?

Para verificar que podemos acceder a un post a través de su ID, primero debemos asegurarnos de que estamos correctamente configurados para crear entidades, como un post, y luego confirmamos que los datos se obtienen tal como se espera.

Crear un Factory de prueba: Primero necesitamos un Factory para generar un post ficticio.
```
$post = Post::factory()->create();
```
Este método permite crear automáticamente un post de muestra usando el Factory configurado previamente. No necesitamos pasar parámetros porque este dato de prueba solo necesita valores por defecto.
Probar la estructura y contenido: Vamos a comprobar que el título del post se obtiene correctamente y que el estatus HTTP devuelto es 200, lo que indica un acceso exitoso.
```
$response = $this->getJson(route('posts.show', $post->id));
$response->assertStatus(200)
         ->assertJson([
             'title' => $post->title,
         ]);
```
Aquí, route('posts.show', $post->id) genera la URL necesaria para acceder al post por su ID, y se confirma que la respuesta es correcta.

¿Qué pasa si el post no existe y se intenta acceder?

En situaciones donde se intenta acceder a un recurso que no existe, es fundamental asegurarse de que nuestra aplicación maneja este error y devuelve el estatus correcto.

Probar para un post inexistente:

Podemos probar con un ID de post que no existe, por ejemplo, 1000, para confirmar que se devuelve un error 404.
```
$response = $this->getJson('/posts/1000');
$response->assertStatus(404);
```
Esto asegura que el framework Laravel automáticamente maneja y devuelve el error 404, ya que si el post no se encuentra, no es necesario añadir lógica adicional para este comportamiento.

¿Por qué es importante estas pruebas en futuras implementaciones?

Implementar correctamente las pruebas para cada funcionalidad no solo ayuda a evitar errores durante el desarrollo, sino que también respalda el código con una capa adicional de confianza. Saber cómo manejar la creación de datos de prueba y verificar errores de acceso es vital para mantener la calidad y robustez de la aplicación.

Te animo a practicar con estos ejemplos en tu propio entorno y a probar tus códigos. Comparte tus resultados y experiencias para seguir aprendiendo y mejorando. ¡Nos vemos en la próxima clase con más conocimientos para reforzar tu habilidad en programación!

Walter Alexander Barrios Silva

student•

En laravel 8.x cambia el factory public function test_show() { $this->withoutExceptionHandling(); $post = Post::factory()->create(); $response = $this->json('GET',"/api/posts/$post->id"); $response->assertJsonStructure(['id','title','created_at']) ->assertJson(['title'=> $post->title]) ->assertStatus(200);

Jhon Fabio Cardona Martinez

student•

Gracias por el aporte me sirvio

Lucas Durán

student•

En laravel 8, el archivo PostFactory se escribiría asi:

public function definition()
  {
    return [
      'title' => $this->faker->sentence
    ];
  }

Miguel Angel Muñoz Pozos

student•

** vendor/bin/phpunit --testdox**


    public function test_show()
    {
        $this->withoutExceptionHandling();

        $post = factory(Post::class)->create();

        $response = $this->json('GET', "/api/posts/$post->id"); //id = 1

        $response->assertJsonStructure(['id', 'title', 'created_at', 'updated_at'])
            ->assertJson(['title' => $post->title])
            ->assertStatus(200); // ok
    }


    public function test_404_show()
    {
        $response = $this->json('GET', '/api/posts/1000'); //id = 1000

        $response->assertStatus(404); // no existe
    }```

Javier Amaya Patricio

student•

Muchas gracias por el aporte del comando **vendor/bin/phpunit --testdox ** :D con ello me ha surgido más interes sobre como mejorar la respuesta de mis tests.

Carlos Alberto Angel Angel

student•

Gracias por el aporte, es de mucha ayudar ver que test son los que estoy ejecutando.

Luciano Nicolas Pereira

student•

En laravel 8.x hay que escribir: use App\Models\Post;

Javier Amaya Patricio

student•

Aporte de la clase echo con mucho entusiasmo y mucha hambre de aprendizaje :D

https://www.evernote.com/l/Ap4jk8UWAGJCjL4rskky7ViulhH9ExRb79E/

Luis Diego Aguilar Ruiz

student•

Que tal amigos, queria compartir mis anotaciones de este test, por si a alguien le sirve

public function test_show()
{
// Create a post
    $post = Post::factory()->create();

// Request that post based on ID
    $response = $this->json('GET', "/api/posts/$post->id"); // id = 1

// Checks if post has id, title, created_at and updated_at
    $response->assertJsonStructure(['id', 'title', 'created_at', 'updated_at'])
        ->assertJson(['title' => $post->title]) // Checks title matches
        ->assertStatus(200); // Okay and creates a resource
}

public function test_404_show()
{
// No need to create a post since we need to prove a 404 error
    $response = $this->json('GET', '/api/posts/1000'); // id = 1000
    $response->assertStatus(404); // Returns a 404
}

Oly Graterol

student•

Ejercicio de la clase

Eduardo Bueno Lopez

student•

Laravel 8

    public function test_show()
    {
        $post = Post::factory()->create();

        $response = $this->json("GET", "/api/posts/$post->id");

        $response->assertJsonStructure(['id', 'title', 'created_at', 'updated_at'])
                 ->assertJson(['title'=> $post->title])
                 ->assertStatus(200); // OK
    }

    public function test_404_show()
    {

        $response = $this->json("GET", '/api/posts/1000');

        $response->assertStatus(404);
    }

Fabrizio Fasanando Sotelo

student•

Buenas! Dejo por aquí el estado de mi fichero PostControllerTest.php

(Laravel 8) Hay un par de cambios respecto al código de las clases

Uso de constantes para mejorar legibilidad al usar los HTTP status.
Utilizar postJson() y getJson() en lugar de json() más que nada por gusto personal jeje

namespace Tests\Feature\Http\Controllers\Api;

use App\Models\Post;
use Tests\TestCase;
use Illuminate\Foundation\Testing\RefreshDatabase;

class PostControllerTest extends TestCase
{
    use RefreshDatabase;
    const HTTP_OK = 200;
    const HTTP_CREATED = 201;
    const HTTP_NOT_FOUND = 404;
    const HTTP_UNPROCESSABLE_ENTITY = 422;

    public function test_store()
    {
        $response = $this->postJson('api/posts', ['title' => 'El post de prueba']);

        $response->assertJsonStructure(['id', 'title', 'created_at', 'updated_at'])
            ->assertJson(['title' => 'El post de prueba'])
            ->assertStatus(self::HTTP_CREATED);

        $this->assertDatabaseHas('posts', ['title' => 'El post de prueba']);
    }

    public function test_validate_title()
    {
        $response = $this->postJson('api/posts', ['title' => '']);

        $response->assertStatus(self::HTTP_UNPROCESSABLE_ENTITY)
        ->assertJsonValidationErrors('title');
    }

    public function test_show()
    {
        $post = Post::factory()->create();

        $response = $this->getJson("api/posts/{$post->id}");
        $response->assertJsonStructure(['id', 'title', 'created_at', 'updated_at'])
            ->assertJson(['title' => $post->title])
            ->assertStatus(self::HTTP_OK);
    }

    public function test_invalid_post()
    {
        $response = $this->getJson('api/posts/1000');
        $response->assertStatus(self::HTTP_NOT_FOUND);
    }
}

Alejandro Cataño Herrera

student•

Carlos Eduardo Gomez García

teacher•

Genial! Me esta empezando a gustar desarrollar con pruebas xD Aquí dejo mis métodos del test de show:

public function test_show() {
        
        $post = Post::factory()->create();

        $response = $this->json("GET", "/api/posts/$post->id");

        $response->assertJsonStructure(["id", "title", "created_at", "updated_at"])
            ->assertJson(["title" => $post->title])
            ->assertStatus(200); // Ok

    }

    public function test_404_show() {

        $response = $this->json("GET", "/api/posts/1000");

        $response->assertStatus(404); // Ok
        
    }

Brajhan Javier Rivera González

student•

Compañero, ¿no tuviste problema al usar el factory? Lo tengo de la misma manera y me arroja el error de Call to undefined method App\Models\Post::factory() usando App\Models\Post

Carlos Eduardo Gomez García

teacher•

@Jarriv No, sería bueno que pongas tu código para ver qué tienes mal, pero pueden ser varias cosas:

1.- Revisa que en verdad tienes Laravel 8 2.- En la clase App\Models\Post revisa que tienes la linea:

use Illuminate\Database\Eloquent\Factories\HasFactory;

Revisa que dentro de esa misma clase tengas la linea:

use HasFactory, Notifiable;

Adrian Bautista Orozco

student•

Deben tener en cuenta que Laravel en su version 8.x ha tenido varios cambios, como por ejemplo el helper factory, la manera de crear factories y ahora los modelos se crean dentro de la carpeta models en la carpeta app, lo que hace que al usar los modelos deban seguir la nomenclatura App\Models[Modelo].

Cristhian Edwin Ortiz Mercado

student•

Aqui usando el comando php artisan test ![](

)

Juan Carlos García Esquivel

student•

Muy interesante Cristhian ahora es un poco mas sencillo y se ve mejor el output con este comando.

KEVIN BRAYAN LUNA FIGUEROA

student•

1) Tests\Feature\Http\Controllers\Api\PostControllerTest::test_show
TypeError: Argument 1 passed to Illuminate\Database\Grammar::parameterize() must be of the type array, string given, called in C:\xampp\htdocs\ApiPlatziLaravel\vendor\laravel\framework\src\Illuminate\Database\Query\Grammars\Grammar.php on line 869

Martin Mendez

student•

tal vez lo escribiste mal revisa el repo de github

Miguel Angel Muñoz Pozos

student•

Bro usa este método para que puedas tener más detalles sobre tu erreror

$this->withoutExceptionHandling();

Manuel Angel Lemus Recinos

student•

en la clase anterior, probe la url post pasando sin nada el titulo y en postman no me devolvio igual la respuesta 422

Bulmaro Arellano Navarrete

student•

Hola

¿Qué resultado obtuviste entonces? ¿Podrías compartir una captura de pantalla donde veamos tu procedimiento y el resultado? Por favor.

Saludos

Sergio Antonio Ordoñez González

student•

$this->json('GET', "/api/posts/$post->id");``` --> Funciona

$this->json('GET', '/api/posts/$post->id');``` ---> No Funciona

porque si funciona con " " y con ' ' No?

Malco Marco Minaya Pumaricra

student•

con las comillas dobles se pueden escapar las variables, con comillas simples no

David Antonio Garcia Saaib

student•

El metodo show no se utiliza normalmente para mostrar listas de datos?

Manuel Ojeda

student•

El método Show va específicamente cuando necesitas mostrar los detalles de un solo elemento, es la principal diferencia a comparación de Index que obtienes una lista sin tanto detalle.

Martin Mendez

student•

como se podria crear una variable ?

public $my_route = '/api/codes';

y pasarla en lugar de siempre escribir la misma ruta en cada funcion ** '/api/codes'**

$this-&gt;json('POST', '/api/codes' , [
    'title' =&gt; 'Test Title'
]);

ya que esto me da error

$this-&gt;json('POST', $this-&gt;$my_route, [
    'title' =&gt; 'Test Title'
]);

Mario Alberto Mendoza Cárdenas

student•

Si el código es tal cual lo mandas, te manda error por que colocas el $ en la variable my_route

$this-&gt;$my_route #Esta mal no lleva $ el atributo
$this-&gt;my_route #Esta es la manera correcta de hacerlo.

Podrías hacer algo similar a esto si el valor es una constante y no va cambiar nunca.

Class test {
 const MY_ROUTE = &quot;api/codes/&quot;;
}

Posteriormente en donde ocupes la variable.

$this-&gt;json('POST', self::MY_ROUTE, [
	'title' =&gt; 'Test Title'
]);

Josué Merino

student•

Código de test_show

public function test_show()
    {
        $post = factory(Post::class)-&gt;create();

        $response = $this-&gt;json('GET', &quot;/api/posts/$post-&gt;id&quot;);//id = 1

        $response-&gt;assertJsonStructure(['id', 'title', 'created_at', 'updated_at'])
            -&gt;assertJson(['title' =&gt; $post-&gt;title])
            -&gt;assertStatus(200); //OK
    }

Código de test_404

public function test_404_show()
    {

        $response = $this-&gt;json('GET', '/api/posts/1000');//id = 1

        $response-&gt;assertStatus(404); //OK
    }

DEY WILLIAMS GORDILLO SALAZAR

student•

Yo no cree un nuevo proyecto y usé la base con user_id.

Así quedó mi prueba:

public function test_show()
    {
        $user = factory(User::class)->create();
        $post = factory(Post::class)->create();

        $response = $this->json('GET', "/api/posts/{$post->id}");

        $response->assertJsonStructure(['id', 'title', 'created_at', 'updated_at'])
            ->assertJson(['title' => $post->title])
            ->assertStatus(200); // http OK
    }

Pruebas y Configuración de Controladores en Laravel

¿Cómo configurar métodos de prueba para endpoints en Laravel?

¿Cómo se prueba el método show de un controlador en Laravel?

¿Qué pasa si el post no existe y se intenta acceder?

¿Por qué es importante estas pruebas en futuras implementaciones?

¿Cómo se prueba el método `show` de un controlador en Laravel?