Testing de Carga de Archivos en Laravel

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

Resumen

¿Cómo configurar un test para subir archivos en Laravel?

Comprender cómo probar y verificar la carga de archivos en una aplicación web es crucial. Este tutorial te guiará a través del proceso de configuración de un test unitario en Laravel para simular la carga de un archivo, específicamente una imagen. Con este conocimiento, podrás garantizar que tu aplicación maneje correctamente las cargas de archivos antes de implementarla en producción.

¿Cómo crear el test inicial?

El punto de partida es la creación de un archivo de test que validará si la carga de archivos se realiza correctamente. Aquí se utilizan las herramientas ofrecidas por Laravel, lo que permite enfocarse en la lógica de negocio en vez de en configuraciones complejas.

php artisan make:test ProfileTest

Al ejecutar este comando, se generará un archivo de test llamado ProfileTest.php. El objetivo es verificar si se puede cargar una imagen satisfactoriamente.

¿Cómo simular la carga de una imagen?

Para emular la subida de una imagen, utilizaremos las funcionalidades proporcionadas por Laravel. A continuación, se configuran las clases necesarias:

use Illuminate\Support\Facades\Storage;

Storage::fake('local');

Esta línea indica que vamos a utilizar una configuración falsa de almacenamiento para las pruebas. Así, tus pruebas no afectarán la configuración real de almacenamiento.

¿Cómo enviar una solicitud POST simulada?

Cuando cargamos un archivo al servidor, normalmente utilizamos una solicitud POST. Podremos simular este comportamiento en nuestros tests.

$response = $this->post('/profile', [
    'foto' => UploadedFile::fake()->image('foto.jpg')
]);

Aquí, estamos simulando el envío de una imagen denominada foto.jpg vía una solicitud POST a la ruta /profile.

¿Cómo verificar la existencia del archivo?

Un aspecto clave es confirmar que el archivo fue realmente almacenado. Para ello, puedes hacer lo siguiente:

Storage::disk('local')->assertExists('profiles/' . $foto);

Este bloque de código revisa si el archivo de imagen existe dentro del directorio profiles.

¿Cómo manejar las redirecciones en los tests?

Al considerar la experiencia del usuario, querrás que, después de cargar un archivo, el sistema redirija al usuario a una vista específica. También deberás verificar esto en tus pruebas.

$response->assertRedirect('/profile');

Este comando confirma que la aplicación redirige correctamente a /profile tras completar la carga.

¿Cómo configurar las rutas necesarias?

Para que todo funcione, deberás configurar las rutas en el archivo web.php de Laravel:

Route::get('/profile', function () {
    return view('profile');
});

Route::post('/profile', function (Illuminate\Http\Request $request) {
    $request->file('foto')->store('profiles');
    return redirect('/profile');
});

Esta configuración incluye una ruta POST para manejar la carga de imágenes y una redirección a la ruta GET.

¿Qué sucede al ejecutar el test?

Luego de haber configurado todo lo anterior, es momento de ejecutar el test para asegurarnos de que funciona como se espera.

php artisan test

Este comando ejecutará todas las pruebas y debería confirmar que la carga de archivos se realiza adecuadamente.

Siéntete motivado a seguir experimentando y aprendiendo más sobre las funcionalidades de Laravel. Cada paso que des te acercará más a convertirte en un experto desarrollador. Continúa creando, probando e implementando con confianza.

Luis Alberto Ruiz Sarmiento

student•

Al momento de hacer la validación con assertExist(), me genero error, la forma como lo solucione fue:

$this->assertTrue(Storage::disk('local')->exists($imageRoute));

Nestor David Velasquez Lopez

student•

He notado que en varias clases el profe a veces declara las funciones de los tests con camel case y en otras con snake case. Opino a mi criterio que lo mejor es siempre estandarizar la codificación. Es decir, si por ejemplo declaro mis funciones de testing en un archivo con camel case, entonces debo seguir ese mismo estandar para que así el código luzca siempre prolijo y ordenado :D

Hector Rubio

student•

Si tienes razon con estandarizar la declaracion de funciones paratesting, yo creo que el profesor lo hace con la finalidad de que nos demos cuenta y tomemos nuestra forma de declararlas.

Hector Rubio

student•

De igual manera te paso un blog que trata sobre las convenciones de laravel, espero y te sirva! https://kennyhorna.com/blog/laravel-convenciones-de-nombrado-nombres-4ef5faa1-66eb-4122-a7fd-d4ec367c33d0

David Granados

student•

Mi linter se estaba quejando del código del profesor porque $request->file('photo'); puede regresar null y por lo tanto generaría el famoso 'null pointer exception'... lo solucioné así aprovechando el nuevo feature de php 8 'null safe operator'

Route::post(
    'profile',
    function (\Illuminate\Http\Request $request) {
        $file = $request->file('photo');
        $file?->store('profiles');
        return redirect('profile');
    }
);

Rainer Vargas

student•

Estuve dándole muchas vueltas y no me funcionaba la validación del ProfileTest. siempre me retornaba un error relacionado a no encontraba la ruta o el directorio, porque nunca ingresaba al ruta de Profilepara guardar la imagen, indagando mas me saltaba otro error y me retornaba el código "419"

El error de código "419" esta relacionado con la expiración del token de seguridad cuando no se usa CSRF, la solución que encontré fue añadir este código al inicio de la validación.

$this->withoutMiddleware();

PD: otra forma que puedes usar para hacer el "Assert" y comprobar si existe la imagen es :

$exists = Storage::disk('local')->exists("profiles/{$photo->hashName()}");
$this->assertTrue($exists);

espero que le ayude a alguien.

Mauricio Poveda Macias

student•

Me están gustando estas clase y hasta cierto punto entiendo los pasos que ejecuta el profe, pero aún no alcanzo a contextualizarlo en un proyecto real.

Nelson Junior Moncada Pirela

student•

Asegurense de tener la extension GD en php activada para que el codigo funcione correctamente

Uriel Zoe Sanjuán Morales

student•

Muchas gracias, justo me paso el error al correr el test, excelente aporte

Carlos Eduardo Gomez García

teacher•

Uhhhmm, me pregunto cómo se haría este test en un sistema distribuido, por ejemplo, subir algo a S3, imagino que sería algo del tipo, hacerle fake al disco "s3", podría ser eso, o realmente subir el archivo y testear que sí s sube y luego eliminarlo para que los tests no consuman almacenamiento dentro de S3 🤔

Kenny Emmanuel Lajara Aquino

student•

TL;DR: No necesitas complicarte la vida, Laravel resuelve eso por ti.

Explicacion: Segun mis pruebas, cada vez que ejecutas el test terminas con una sola imagen falsa aunque tengas varios test de carga de archivos. Al parecer, cuando se intenta guardar una nueva image, Laravel limpia el directorio de imagenes falsas antes de guardar la nueva imagen. Como la imagen que se guara es una cuadro negro de 10px por 10px, lo que pueda consumir en disco es en la practica totalmente irrelevante.

Jonathan Dario Perez Narvaez

student•

Para versiones recientes de Laravel la ruta es:

use App\Http\Controllers\ProfileController;

Route::post('/profile', [ProfileController::class, 'upload']);

Cesar More Sanchez

student•

Estoy usando Laravel 8.78.1 con PHP 7.4.27 y me indica que el método assertExists() no existe. Alguien más tiene este problema?

Wilber Pulido

student•

Lo que pasa es que esta clase en particular es un Facades, es un concepto de Laravel que procura siempre tener una unica instancia, digamos que es una implementacion de Singlenton rarito. Y este tipo de patrones, el pluging que debes tener de sintaxis no lo pilla y para el no existe, pero si lo puedas, tendria que pasar el test, porque si esta en alguna parte jaja

Sebastian Sulbaran

student•

Verifica que hayas seteado bien el namespace de la clase storage: use Illuminate\Support\Facades\Storage;

y aplicar el assertExist de la forma como muestra el video:

Storage::disk('local')->assertExists

Abraham Gonzalez

student•

Para los que esten usando Laravel 11 esta es la forma de hacer el assert

$this->assertTrue(Storage::disk('local')->exists("profiles/{$photo->hashName()}"));

Víctor Arnau Gómez

student•

No consigo hacer que pase el test. Me devuelve un error de dependencias:

Call to undefined function Illuminate\Http\Testing\imagecreatetruecolor()

ProfileTest.php

use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Storage;

public function test_upload()
    {
       Storage::fake('local');

       $response = $this->post('profile', [
           'photo' => $photo = UploadedFile::fake()->image('photo.png')
       ]);

       Storage::disk('local')->assertExists("profiles/{$photo->hashName()}");

       $response->assertRedirect('profile');

    }

routes/web.php

Route::view('profile', 'profile');
Route::post('profile', function(Request $request) {
    $request->file('photo')->store('profiles');

    return redirect('profile');
});

composer.json

"require": {
        "php": "^7.3|^8.0",
        "fideloper/proxy": "^4.4",
        "fruitcake/laravel-cors": "^2.0",
        "guzzlehttp/guzzle": "^7.0.1",
        "laravel/framework": "^8.12",
        "laravel/tinker": "^2.5"
    },
    "require-dev": {
        "facade/ignition": "^2.5",
        "fakerphp/faker": "^1.9.1",
        "laravel/sail": "^1.0.1",
        "mockery/mockery": "^1.4.2",
        "nunomaduro/collision": "^5.0",
        "phpunit/phpunit": "^9.3.3"
    },

Es posible que sea problema de la versión de Laravel?

Darío Rugerio

student•

Prueba ejecutando php artisan config:clear

Wilder Cahuaya Quispe

student•

Es por tu extensión GD ve a php.ini y busca ;extension=gd quitale el ; guarda y reinicia apache

Jorge Cortes Lopez

student•

en laravel 10 hay que agregar lo siguiente en la ruta ya que de no hacerlo manda un error extraño

Route::post('avatar',function(Illuminate\Http\Request $request){
    $file = $request->file('photo');
    if($file){
        $path = $file->store('profiles');
    }
    // $request->file('photo')->storage('profiles');
    return redirect('profile');
});
```*Route*::post('avatar',*function*(Illuminate\Http\\*Request* $request){    $file = $request->file('photo');    if($file){        $path = $file->store('profiles');    }    // $request->file('photo')->storage('profiles');    return redirect('profile');});

David Quelal

student•

Alguien pudo solucionar este error ? Call to undefined function Illuminate\Http\Testing\imagecreatetruecolor()

William Condori

student•

Dentro del archivo php.ini tienes que habilitar lo siguiente:

Martin Ronquillo Vargas

student•

En el test me da el error: Method Illuminate\Http\Testing\File::hasName does not exist. Esto en la linea: Storage::disk('local')->exists("profiles/{$photo->hasName()}");Si utilizo ->getClientOriginalName() me da un 419, alguna solucion?

Vanessa katherine Quero Delgado

student•

Tuve el mismo problema, no se si ya resolviste pero me di cuenta que no es hasName(), el método correcto es hashName().

Juan Pablo Campuzano Monsalve

student•

Excelente clase!

Jorge Cortes Lopez

student•

el test me regresa este error Method Illuminate\Http\Testing\File::storage does not exist.

Daniel Antonio

student•

Algo que podemos igual testear es si la ruta profile existe, ya que si bloqueamos la vista y corremos el test no marca error, ya que nuestro metodo esta redireccioando correctamente a la ruta que especificamos.

/**
     * @Description: Test para la ruta de perfil
     * @return void
     */
    public function test_route_profile(): void
    {
        $response = $this->get('profile');
        $response->assertStatus(200);
    }

Con este test confirmamos que la ruta profile existe.

Arnold Lainez

student•

El sistema de archivos del proyecto es increible!.

Juan Guillermo Perez Cardozo

student•

sencillamente expectacular

Rafa Anaya

student•

Pense que me había vuelto loco, juraría que ya había terminado este curso, pero resulta que hay dos cursos de test con italo. jajaja

Aún así italo es tan buen profesor que con solo tomar el otro curso pase el examen de este y solo tuve mal una pregunta referente a esta clase jeje..