Pruebas de Métodos Personalizados en PHP con Laravel

Clase 8 de 24 • Curso Básico de Testing con PHP y Laravel

Resumen

¿Cómo probar un método personalizado en PHP?

En el mundo del desarrollo de software, probar nuestros métodos personalizados es crucial para garantizar que nuestro código funcione correctamente y de manera consistente. Imagina que hemos desarrollado un sitio web o una aplicación, y queremos asegurar que todas las funcionalidades, incluyendo nuestros métodos personalizados, operen al 100%. En este artículo, exploraremos cómo puedes configurar y probar un método personalizado en PHP, utilizando el framework Laravel para un enfoque más estructurado.

¿Cuál es el proceso para configurar un test en Laravel?

Para comenzar, debemos entender cómo estructurar y organizar nuestros tests dentro del framework Laravel. Aquí te presento los pasos clave que debes seguir:

Crear un archivo de test: Empezamos asegurándonos de tener un archivo de test, por ejemplo, PostTest.php. Dentro de este archivo incluimos nuestras pruebas organizadas.
Definir el método de test: A cada test dentro de la clase le damos un nombre que empiece con la palabra 'test'. Esto es crucial, ya que Laravel y PHPUnit reconocen automáticamente estos métodos como pruebas.
Inicializar y configurar el objeto: Cada prueba generalmente involucra la creación de un objeto de la clase que estamos probando. En este caso, podrías estar manipulando un objeto del post donde quieres generar un enlace.

public function testHref()
{
    $post = new Post();
    $post->name = 'Proyecto en PHP';
}

¿Cómo se espera el resultado del método test?

Una vez configurado el entorno y definido el test, es el momento de especificar qué resultado estamos esperando del método en cuestión:

Utilizar assertions: Un aspecto crítico es usar funciones de assertion. En el caso del método href, esperamos que devuelva una URL formateada en minúsculas, separando las palabras con guiones.

$this->assertEquals('blog-proyecto-en-php', $post->href());

Aquí, assertEquals ayuda a verificar si el resultado que retorna el método es el esperado.

¿Cómo definir un método personalizado en Laravel?

Ahora que tenemos una prueba que falla porque el método href aún no existe, procedemos a crear ese método en la clase que estamos evaluando:

Crear el método en el modelo: Agregamos el método href en el modelo Post.

public function href()
{
    return '/'. $this->getSlug();
}

Implementar lógica personalizada: Dentro de este método podrías tener funcionalidades personalizadas, como generar un “slug” para la URL. El slug usualmente es generado utilizando el nombre del post en minúsculas y reemplazando espacios con guiones.

¿Por qué es importante duplicar código en los tests?

Puede parecer contraproducente al inicio, pero duplicar código en tus pruebas es esencial. Este enfoque permite:

Facilitar el mantenimiento: Mantener fragmentos de código idénticos en tus tests aseguran consistencia. Si otro desarrollador desea entender tu lógica o realizar cambios, los tests servirán como una documentación clara y precisa.
Verificar integridad: Al correr estos tests garantizamos que modificaciones futuras no rompan la funcionalidad existente.

Probar tus métodos personalizados es un paso para garantizar que tu código PHP sea robusto y esté libre de errores. Estas prácticas no solo te ahorran tiempo y estrés a largo plazo, sino que también fortalecen la calidad de tu software. Alienta a seguir investigando y aprendiendo sobre estos conceptos para perfeccionar tus habilidades de programación y testing.

Brian Sánchez Izquierdo

student•

La diferencia entre un mutator/accessor y un método personalizado es que los primeros solo se ejecutan sobre ++propiedades++ de la clase. 😉

Carlos Eduardo Gomez García

teacher•

Algo que me encanta de este curso es cómo el profesor va reutilizando los métodos antiguos para generar nuevos, y es completamente válido jaja, los tests son como esa cosa que te sirven de colchón cuando te caes, básicamente te están diciendo: "Oiga, todo ok por acá, siga programando sin preocupaciones" . Y de hecho, repetir los tests, para este caso, es "buena práctica", ya que te estás asegurando de que el mismo test pase por cada cambio que hay 👀

Sebastian Sulbaran

student•

No solamente que pase por cada cambio que hay, sino tambien al "duplicar", cada test se te va contando su historia y diciendo todo lo que necesita eso que estas testeando para "funcionar" (las comillas es porque puedes estar haciendo funcionar una falla)

Eddy Herrera Vargas

student•

Getter: Su función es permitir el obtener el valor de una propiedad de la clase y así poder utilizar dicho valor en diferentes métodos.

Setter: Su función permite brindar acceso a propiedades especificas para poder asignar un valor fuera de la clase.

Un método en programación es una función que tiene un conjunto de instrucciones definidas dentro de él. El método tiene un nombre para identificarlo. Podemos hacer que requiera diferentes tipos de datos de entrada para ejecutarse. Y podemos hacer que el método devuelva datos como resultado.

Omar Villafuerte

student•

muy buen aporte!

Hector Rubio

student•

La diferencia entre los setters y getters con los métodos personalizados es que en los métodos personalizados trabajamos con eso, con un método que trata los atributos y podemos usarlo para agregar cosas, en setters y getters trtabajamos directamente con los atributos del modelo, ya sea seteandolos o obteniéndolos para hacer en este caso una prueba.

Pedro Xavier Escalante

student•

Es una excelente manera de iniciar el desarrollo usando TDD (Test Driven Design). Se realizan primero las pruebas, y luego la función que debe ser probada exitosamente.

David Granados

student•

Hola les comparto como hacer los ejercicios usando la nueva clase de laravel para interactuar con strings de una manera más amigable

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;

class Post extends Model
{
    use HasFactory;

    public function href()
    {
        return Str::of($this->slug)->prepend('blog/');
    }
}

<?php

namespace Tests\Unit\Models;

use App\Models\Post;
use Illuminate\Support\Str;
use PHPUnit\Framework\TestCase;

class PostTest extends TestCase
{
    public function test_get_href()
    {
        $post = new Post();
        $post->name = "Proyecto en PHP";
        $href = Str::of($post->name)->slug()->prepend('blog/');
        self::assertEquals($href, $post->href());
    }
}

Abel da Cunha

student•

Existe un plugin en VSC llamado Codium AI que te da una opción de generar los tests automáticamente cada vez que creas una función.

Jimmy Buriticá Londoño

student•

Me ha gustado la forma en que se ha dictado el curso. Se explican los conceptos de forma sencilla, paso a paso, para entender el porque de las cosas. 👍

Lázaro José Pérez Rodríguez

student•

es convención escribir las funciones en snake case ?

Juan Guillermo Perez Cardozo

student•

Osea que en test, es normal que se repita codigo ? como varias veces poner $post->name"tal texto"

Eloy Chávez Dev

student•

Holiiii 👋🏻

Sip, esto pasa porque estás creado las pruebas unitarias y para ello debes simular el ingreso de varios valores, a menos que uses una API en cuyo caso solo tendrías que llamar la cantidad de datos a requerir en tu prueba.

LEONARD CUENCA

student•

Me ha gustado la forma en que se ha dictado el curso. Se explican los conceptos de forma sencilla, paso a paso, para entender el porque de las cosas.

Jorge Daniel Rincón Luciano

student•

Me parecen sumamente interesante estos conceptos, tome el curso Básico de Manejo de Datos en Laravel con Eloquent ORM y me ayuda a refrescar algunos temas y entenderlos de mejor manera!