¿Cómo llevar una prueba de rojo a verde en el desarrollo guiado por pruebas?
El desarrollo de software a menudo enfrenta el desafío de garantizar que las funcionalidades cumplan con las expectativas del usuario. Adoptar el desarrollo guiado por pruebas o Test-Driven Development (TDD) es una práctica que asegura que cada línea de código esté justificada por pruebas previas. Al comenzar con una prueba que falla (roja) y realizar los cambios necesarios para que pase (verde), podemos mejorar nuestro proceso de desarrollo.
¿Cómo iniciamos la creación de clases?
Inicialmente, hemos identificado que uno de los errores principales al ejecutar el comando es que la clase app\post no existe. Para rectificar este problema:
Creamos un directorio llamado src, definido en nuestro archivo composer.json.
Dentro de este directorio, creamos el archivo Post.php para comenzar a desarrollar la clase post.
Con esto en mente, es esencial asegurarnos de que la clase esté declarada correctamente y que incluya un espacio de nombres (namespace) adecuado para evitar errores de ejecución.
¿Cuál es el rol de los comentarios y métodos en nuestro código?
Una vez que hemos resuelto el problema de la existencia de la clase post, encontramos otro obstáculo: la ausencia del método addComment. Para abordar este problema:
Creamos un archivo Comment.php que contiene la definición de la clase Comment.
En la clase Post, implementamos el método addComment. Este método se asegura de recibir un parámetro que es una instancia de la clase Comment. Esto garantiza que los comentarios añadidos sean válidos y pertenezcan al mismo espacio de nombres.
Este enfoque también implica la creación de una propiedad denominada comments dentro de la clase Post, que inicialmente es un arreglo vacío. De esta manera, podemos agregar comentarios y acumularlos adecuadamente.
¿Cómo implementamos el conteo y la obtención de comentarios?
Para expandir la funcionalidad de la clase Post, incorporamos métodos adicionales que permiten contar y obtener comentarios:
Este método devuelve todos los comentarios almacenados en la propiedad para que puedan ser manipulados externamente.
¿Qué sucede si enviamos un string en lugar de un objeto comment?
En los momentos finales, integramos validaciones adicionales para enfatizar la importancia de trabajar con instancias de objetos y no con tipos de datos básicos como strings. Al ejecutar un test con un string en lugar de la instancia esperada, observamos que el código amablemente avisa de que no es la instancia esperada.
La validación de tipos en la implementación bloquea estos errores, priorizando instancias específicas de nuestras clases. Así, conseguimos proporcionar múltiples niveles de seguridad, tanto a nivel de prueba como a nivel de código.
En el ámbito del desarrollo software, este ciclo de crear pruebas, escribir código a partir de ellas y refactorizar contribuye decididamente a elevar nuestras habilidades de programación a nivel profesional. Las pruebas aseguran que cualquier modificación futura no altere el comportamiento deseado, brindando una base sólida para el crecimiento y mantenimiento del código.
Desarrollo Guiado por Pruebas en PHP: Creación de Clases y Métodos
¿Cómo llevar una prueba de rojo a verde en el desarrollo guiado por pruebas?
El desarrollo de software a menudo enfrenta el desafío de garantizar que las funcionalidades cumplan con las expectativas del usuario. Adoptar el desarrollo guiado por pruebas o Test-Driven Development (TDD) es una práctica que asegura que cada línea de código esté justificada por pruebas previas. Al comenzar con una prueba que falla (roja) y realizar los cambios necesarios para que pase (verde), podemos mejorar nuestro proceso de desarrollo.
¿Cómo iniciamos la creación de clases?
Inicialmente, hemos identificado que uno de los errores principales al ejecutar el comando es que la clase app\post no existe. Para rectificar este problema:
Creamos un directorio llamado src, definido en nuestro archivo composer.json.
Dentro de este directorio, creamos el archivo Post.php para comenzar a desarrollar la clase post.
Con esto en mente, es esencial asegurarnos de que la clase esté declarada correctamente y que incluya un espacio de nombres (namespace) adecuado para evitar errores de ejecución.
¿Cuál es el rol de los comentarios y métodos en nuestro código?
Una vez que hemos resuelto el problema de la existencia de la clase post, encontramos otro obstáculo: la ausencia del método addComment. Para abordar este problema:
Creamos un archivo Comment.php que contiene la definición de la clase Comment.
En la clase Post, implementamos el método addComment. Este método se asegura de recibir un parámetro que es una instancia de la clase Comment. Esto garantiza que los comentarios añadidos sean válidos y pertenezcan al mismo espacio de nombres.
Este enfoque también implica la creación de una propiedad denominada comments dentro de la clase Post, que inicialmente es un arreglo vacío. De esta manera, podemos agregar comentarios y acumularlos adecuadamente.
¿Cómo implementamos el conteo y la obtención de comentarios?
Para expandir la funcionalidad de la clase Post, incorporamos métodos adicionales que permiten contar y obtener comentarios:
Método para contar comentarios:
public function countComments() {
return count($this->comments);
}
Este método evalúa la cantidad de elementos presentes en la propiedad comments.
Método para obtener comentarios:
public function getComments() {
return $this->comments;
}
Este método devuelve todos los comentarios almacenados en la propiedad para que puedan ser manipulados externamente.
¿Qué sucede si enviamos un string en lugar de un objeto comment?
En los momentos finales, integramos validaciones adicionales para enfatizar la importancia de trabajar con instancias de objetos y no con tipos de datos básicos como strings. Al ejecutar un test con un string en lugar de la instancia esperada, observamos que el código amablemente avisa de que no es la instancia esperada.
La validación de tipos en la implementación bloquea estos errores, priorizando instancias específicas de nuestras clases. Así, conseguimos proporcionar múltiples niveles de seguridad, tanto a nivel de prueba como a nivel de código.
En el ámbito del desarrollo software, este ciclo de crear pruebas, escribir código a partir de ellas y refactorizar contribuye decididamente a elevar nuestras habilidades de programación a nivel profesional. Las pruebas aseguran que cualquier modificación futura no altere el comportamiento deseado, brindando una base sólida para el crecimiento y mantenimiento del código.
En esta clase se mencionó algo muy importante, y es el tipo de dato que se espera, cuando trabajamos con parámetros en las funciones es posible especificar qué tipo de dato estamos esperando, esto hace que sea un código mejor estructurado y te acerca más a las buenas prácticas, de igual manera, los métodos de las clases pueden especificar qué tipo de dato se va a retornar, así le confirmamos 100% a quien use nuestra clase que vamos a retornarle si o si tal tipo de dato, por ejemplo, en esta clase:
<?php
namespace App;
class Comment {
public $like_count = 0;
public function like(User $usuario) : int {
return $this->like_count;
}
}
?>
Vemos que hay un método que espera como parámetro "User $usuario", esto quiere decir que, el parámetro $usuario tiene que ser si o si una instancia de la clase Usuario, si yo reemplazara "User" por "string" le estarían diciendo que espero que el parámetro $usuario sea una cadena de texto.
De igual manera, es función tiene al final " : int" esto está diciendo que el método va a devolver si o si un entero, de esta manera podemos hacer un código más robusto y a prueba de errores.
Si te te sale un error: Error: Class 'App\Post' not found a pesar de haber creado la clase y el namespace, ejecuta composer dump-autoload, esto hara que la clase que sea reconocida por el autoload y no mostrara el previo error.
Cuando ya se tiene mas practica y mas conocimiento en el desarrollo de software, siempre te vas a ir por escribir codigo primero y luego los tests, con esto quiero decir que, aunque en la teoria sea lo contrario, esta es la realidad
<?php
namespace App;
class Post{
public $comments = [];
public function add_comment(Comment $comment){
$this->$comments[] = $comment;
}
public function count_comments() : int{
return count($this->$comments);
}
public function getComments(){
return $this->comments;
}
}
?>
Al hacer la prueba con phpunit me sale el siguiente error:
There was 1 error:
1) PostTest::test_add_comment_to_post
Undefined variable: comments
Y al revisar la variable me sale la siguiente advertencia:
Yo entiendo que no detecta que la $this->comments ya ha sido inicializada mas arriba.
He estado intentando varias cosas sin resultado y no se si a alguien mas tiene el mismo problema.
Haciendo el curso en marzo del 2024, al ejecutar el comando php vendor/phpunit/phpunit/phpunit no pasa nada, buscando en la documentación y con ayuda de otros comentarios llegue a una solución por lo menos con la version 10.5.15 que es la que estoy usando:
se debe ejecutar el comando php vendor/bin/phpunit tests/PostTest.php