Creación y Prueba de Métodos Index en PHP

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

Resumen

¿Cómo trabajar con el método Index en tu aplicación?

El método Index en las aplicaciones web es crucial para la visualización de listas de registros. Este método es sumamente eficiente para asegurarse de que los datos se presenten de forma organizada y como se espera. A través del enfoque que vamos a discutir, podrás crear y verificar registros fácilmente.

¿Cómo crear múltiples registros para pruebas?

Para empezar a trabajar con el método Index, debemos centrarnos en la creación de varios registros que nos permitan validar nuestros métodos. Sigamos el proceso para crear cinco "posts":

posts :: Class, 5

Este fragmento de código nos ayuda a generar los datos de prueba. Recuerda que tener datos de prueba es esencial para asegurarse de que todo funcione como debería.

¿Cómo verificar los datos generados?

Verificar que los datos generados sean correctos es el siguiente paso. En nuestro caso, queremos confirmar que la estructura de los datos en formato JSON sea la esperada:

# Verificación de la estructura JSON
[
    {id: ..., titulo: ..., fecha_creacion: ..., fecha_actualizacion: ...},
    # más registros 
]

El objetivo aquí es chequear que cada registro tenga un "id", "título", "fecha de creación" y "fecha de actualización". Estos son los elementos básicos de una estructura JSON correcta para nuestros propósitos.

¿Cuál es la importancia del estatus HTTP?

El estatus HTTP es importante para verificar que la conexión y respuesta de los métodos se ejecute correctamente. El estándar de un código HTTP exitoso para una petición GET es 200:

status: 200

Debe asegurarse de que la respuesta de la ruta principal contenga este estatus. De esta manera, se confirma que la comunicación entre el cliente y el servidor fue exitosa.

¿Cómo establecer el proceso de prueba?

El proceso de prueba en desarrollo de software se conoce comúnmente como "Test-Driven Development" (TDD) en inglés. El siguiente es el orden ideal para asegurar que tus pruebas validen correctamente tu método:

Crear datos de prueba: Inicialmente fabricamos varios posts para poner a prueba nuestras hipótesis.
Prueba y validación: Accede al método Index y confirma que los datos recibidos son correctos.
Ajustar el código: Si la prueba inicial falla (lo cual es esperado), el código debe ajustarse hasta que pase.
Mejorar y optimizar: Una vez que la prueba pase, optimiza el código (Refactoring) sin cambiar la funcionalidad.

Este ciclo debe seguirse regularmente para asegurar un desarrollo sólido y confiable.

Propuesta de práctica y mejora continua

A medida que trabajes con el método Index y las pruebas necesarias, no olvides practicar dado que la constancia mejora la comprensión y habilidades de programación. Usa las herramientas de prueba automatizadas disponibles y comparte tus resultados en la comunidad para recibir retroalimentación. ¡Continúa perfeccionando y mejorando tus proyectos!

Walter Alexander Barrios Silva

student•

Por si tienen laravel 8.x y les sale el error con el factory

public function test_index()
    {
        Post::factory()->count(5)->create();
        $response = $this->json('GET','api/posts');
        $response->assertJsonStructure([
            'data' => [
                '*' => ['id','title','created_at','updated_at']
            ]
        ])->assertStatus(200);
    }

Oscar Stevens Cuartas Bejarano

student•

conclusion, no usare TDD nunca para no tardar 4000000000 años en terminar un proyecto y que mi cliente no se enoje y me trate mal cuando le diga que me tardo mucho

Eduardo Bueno Lopez

student•

Eday Alix González Manjarrés

student•

Jajaja

Carlos Eduardo Gomez García

teacher•

Interesante, aunque igual sería interesante ver cómo se escribiría el test para una estructura de varios niveles con objetos distintos en cada posición del JSON

KEVIN BRAYAN LUNA FIGUEROA

student•

Tuve que utilizar este código para que no me enviara error.

public function index()
 {
    return Post::paginate();
 }

Cesar Augusto Garzón Puentes

student•

Verifica que tienes el constructor en la clase:

class PostController extends Controller
{
    //Creamos nuestro metodo constructor para reasignar a nuestra entidad Post
    protected $posts;
    public function __construct( Post $post )
    {
        $this-&gt;post = $post;
    }
...

Eduardo Rahn

student•

Para muchos como yo no es facil cambiar la forma en la que programas. Sacarte las costumbres, seguir aprendiendo entender que si hay cosas nuevas probablemente traen mejoras (nada lo garantiza) es parte del crecimiento como programador.

Hasta ahora todo ha estado genial y quizás lo mas difícil es aprenderse los métodos que se utilizan para probar cada cosa

Hector Rubio

student•

Siempre se puede consultar la documentación amigo una ves que se aprende a leer la documentación se vuelve fácil el proceso.

Julian David Alzate Cuervo

student•

En laravel 9.5

Erasmo Andrés Martínez Rodríguez

student•

Se ve excelente, voy luego a pasar a ese curso.

EDGAR MERCADO GARCIA

student•

Como quedo el código para la versión 18

 public function test_index()
    {
        Post::factory(5)->create();

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

        $response->assertJsonStructure([
            'data' =>[
                '*' => ['id', 'title','created_at', 'updated_at']
            ]
        ])->assertStatus(200);
    }

Edgar Alejandro España Amaya

student•

Código de prueba método index =>

public function test_index()
    {
        Post::factory()->count(10)->create();
        $response = $this->json('GET','api/posts');
        $response->assertJsonStructure([
            'data' => [
                '*' => ['id','title','created_at','updated_at']
            ]
        ])->assertStatus(200); // OK
    }

Blas Rodriguez934

student•

public function index()
    {
        return response()-&gt;json(
            $this-&gt;post-&gt;paginate());
    }```

Kenneth Angulo L

student•

Remember to write descriptive names and to name our test classes after the class being tested. . That way, in our tests, we should be reading someting like this: .

PHPUnit 9.5.26 by Sebastian Bergmann and contributors.

Post Controller (Tests\Feature\Http\Controllers\Api\PostController)
 ✔ Post store
 ✔ Post validate title on store
 ✔ Post show
 ✔ Post returns 404 when try to show non existing post
 ✔ Post update
 ✔ Post delete
 ✔ Post index

Time: 00:04.747, Memory: 32.00 MB

OK (7 tests, 49 assertions)

Oly Graterol

student•

Ejercicio

Oriana Morillo

student•

Luz Verde, Luz Roja👧

Juan José del Aguila López

student•

    public function test_index()
    {
        factory(Post::class,5)->create();

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

        $response->assertJsonStructure([
            'data'=>[
                '*' => ['id','title','created_at','updated_at']
            ]])->assertStatus(200);
    }

Miguel Bonifaz

student•

Recomienda revisar la sección de "API Resources", es una forma de organizar mejor nuestra data al momento de retornala 😁

👇 https://laravel.com/docs/7.x/eloquent-resources

Jahiker Rojas

student•

Test Controller:

/**
     * Feature for list all resources test
     *
     */
    public function test_index()
    {
        factory(Post::class, 5)->create();

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

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

Route Controller

/**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function index()
    {
        return response()->json(
            $this->post->paginate(), 200
        );
    }

Lautaro Cabral

student•

Qué es lo que hacía el método paginate?

Diana Velásquez

student•

Pagina los resultados. Ej: En vez de enviarte 100 posts de golpe, los envía de 15 en 15

Jesebell Maderleyn Escobar Hurtado

student•

Paul Cortes

student•

Documentacion de la paginación en Laravel docs

Paul Cortes

student•

Genial la paginación que se hace de forma automática por parte de Laravel, simplemente espectacular!!!

Usuario anónimo

user•

Genial :)

public function test_index() {
    //$this->withoutExceptionHandling();
    $post = factory(Post::class, 5)->create();
    $response = $this->json('GET', "/api/posts/");
    $response->assertJsonStructure([
        'data' => [ '*' => ['id', 'title', 'created_at', 'updated_at']]])
        ->assertStatus(200);//OK
}  


public function index() {
    return response()->json($this->post->paginate());
}