Tests unitaires dans Laravel avec Sanctum-tutoriel php-php.cn

Pruebas Unitarias en Laravel con Sanctum

Quoi de neuf mes enfants, j'espère que vous passez un bon moment et que vous passez une bonne semaine, et même un meilleur mois. J'ai écrit cet article sur thedevgang.com et je le partage ici afin qu'il suscite plus d'engagement avec vous tous. J'espère que ça vous plaira :3

C'est déjà la dernière étape de 2024 et d'autres choses, dont il ne vaut pas la peine de parler en ce moment. Eh bien, dans un article de blog précédent, nous avons migré la bibliothèque d'authentification Passport vers Sanctum, cependant, j'aimerais maintenant me plonger dans les tests unitaires de certains points de terminaison et ainsi pouvoir les exécuter dans un pipeline d'intégration continue tel que Github Actions <.>

Auparavant, j'avais écrit sur la façon de faire des tests unitaires avec Passport dans dev.to, cet article peut être trouvé ici, où j'explique également ce que sont les tests unitaires et les aspects de base de leur implémentation dans Laravel. Dans cet article, nous aborderons les éléments suivants :

Tests unitaires avec Sanctum implémentés

Dans le cas de cet article, j'ai quelques points finaux que j'ai mis en place pour un projet alternatif que je développe depuis quelques mois. Ce projet présente les caractéristiques suivantes au niveau du cadre et autres :

Dans ce cas, nous testerons trois points de terminaison que nous avons configurés pour le processus d'authentification de cette application, nous ferons d'abord la chose appropriée avec la méthode suivante :

public function login(Request $request) { $validator = Validator::make($request->all(), [ 'email' => 'required|email', 'password' => 'required', 'device_id' => 'required', ]); if ($validator->fails()) { return response()->json(['success' => false, 'error' => $validator->errors()], $this->badRequestStatus); } $result = $this->getToken(request('email'), request('password'), request('device_id')); if ($result['success'] == true) { return response()->json($result, $this->successStatus); } else { return response()->json(['success' => false, 'error' => 'Unauthorized'], $this->unauthorizedStatus); } }

Copier après la connexion

Cette méthode est celle qui gère entièrement le processus de connexion de notre application, cependant l'inscription n'est pas incluse dans cet extrait, ce sera le prochain à tester. Dans ce cas, nous l'avons confirmé et cela semble fonctionner correctement, mais afin de nous en assurer, nous mettrons en place leurs tests respectifs.

D'abord avec le terminal, entrez cette commande :

php artisan make:test UserTest --unit

Cela créera un fichier UserTest dans le dossier tests/Unit, qui sera complètement « vide », comme ceci :

assertTrue(true); } }

Copier après la connexion

Supprimez la méthode test_basic_test(), nous n'en aurons pas besoin. Dans ce cas je dis qu'il est vide car ce n'est que la maquette de nos tests unitaires et pour cette occasion ce sera celui que nous utiliserons pour les méthodes susmentionnées. Maintenant, avant de commencer à planifier les tests, nous devons nous assurer des cas d'utilisation que nous allons exécuter et tester, nous avons donc les cas d'utilisation suivants à tester :

Une fois les cas d'utilisation répertoriés, nous tenons compte du fait que ceux que couvre la méthode susmentionnée dans ce cas sont les cas 1 et 2, nous allons donc procéder avec eux.

Préparation aux tests

Maintenant, avant de commencer à coder les tests, nous devons les configurer pour qu'ils puissent être exécutés correctement, pour ce faire, nous allons créer la méthode setUp dans le fichier UserTest, qui exécute les instructions avant d'exécuter les tests unitaires. . C'est ici que l'on peut indiquer au système qu'il doit effectuer les migrations et pouvoir les démarrer si des données sont nécessaires, ainsi que l'affectation de valeurs dans les variables. La méthode setUp que nous allons créer est structurée comme ceci :

public function setUp(): void { parent::setUp(); $this->faker = \Faker\Factory::create(); $this->name = $this->faker->name(); $this->password = 'password'; $this->email = 'valid@test.com'; $this->deviceId = $this->faker->uuid(); Artisan::call('migrate:fresh', ['-vvv' => true]); }

Copier après la connexion

La configuration fera ce qui suit :

Au dessus de cette méthode, déclarez les variables globales que nous utiliserons pour tous nos tests :

public $faker; public $name; public $email; public $password; public $deviceId;

Copier après la connexion

Développement de tests unitaires

Pour le test 1, nous devons nous assurer que la connexion est correcte en appelant le point de terminaison que nous appellerons dans notre application. Nous allons créer la méthode test_login_success et elle ressemblerait à ceci :

public function test_login_success() { Artisan::call('db:seed', ['-vvv' => true]); $body = [ 'email' => $this->email, 'password' => $this->password, 'device_id' => $this->deviceId ]; $this->json('POST', '/api/login', $body, ['Accept' => 'application/json']) ->assertStatus(200)->assertJson([ "success" => true ]); }

Copier après la connexion

Este método, primeramente alimentará la base de datos con los catálogos pertinentes para poder confirmar que los mismos existen sin problemas. Después asignará el body y enviará los datos por medio de un request POST, al enviarlo, revisará que el status que devuelva su llamada es 200 y que los datos sean conforme al arreglo solicitado para confirmar, en este caso [ “success” => true ]. Si todo sale bien y se cumplen las condiciones, se considera prueba satisfactoria, en caso contrario, se considerará fallida y es donde se tendrá que revisar nuevamente el código.

Ahora bien, haremos el caso de uso 2. Para ello crea un método llamado test_login_error_with_data_ok e ingresa el siguiente código:

public function test_login_error_with_data_ok() { Artisan::call('db:seed', ['-vvv' => true]); $body = [ 'email' => 'invalid@test.com', 'password' => 'password', 'device_id' => $this->deviceId ]; $this->json('POST', '/api/login', $body) ->assertStatus(401)->assertJson([ "success" => false ]); }

Copier après la connexion

A diferencia del anterior, en este caso, se le entregan datos erróneos y se solicita que confirme que el endpoint devuelva un error 401, así como un body [“success” => false ], esto con el fin de que se confirme que el sistema deniega el acceso a alguien que no tenga credenciales correctas.

Con esto, cubrimos el método presentado anteriormente y ya quedaría cubierto el método. Para poder probarlo, podemos ejecutar el siguiente comando bajo Sail:

docker compose exec laravel.test php artisan test

Te mostrará los siguientes resultados:

PASS Tests\Unit\UserTest ✓ login error with data ok 0.08s ✓ login success 0.16s

Copier après la connexion

Si te sale todo bien como te lo he mostrado, tus unit tests han salido satisfactoriamente, pero estamos lejos de terminar. Ahora necesitamos probar el siguiente método:

public function register(Request $request) { $validator = Validator::make($request->all(), [ 'email' => 'required|email|unique:users', 'password' => 'required', 'c_password' => 'required|same:password', 'device_id' => 'required', ]); if ($validator->fails()) { return response()->json(['success' => false, 'error' => $validator->errors()], $this->badRequestStatus); } $password = $request->password; $input = $request->all(); $input['password'] = bcrypt($password); $user = User::create($input); if (null !== $user) { $result = $this->getToken($user->email, $password, $request->device_id); if ($result['success'] == true) { return response()->json($result, $this->successStatus); } else { return response()->json(['success' => false, 'error' => 'Unauthorized'], $this->unauthorizedStatus); } } }

Copier après la connexion

En este caso, realizaremos el caso de uso 3, el cual solicita confirmar que el registro sea correcto, para ello, crea el método test_register_success e ingresa el siguiente código:

public function test_register_success() { $body = [ 'name' => $this->name, 'email' => $this->email, 'password' => $this->password, 'c_password' => $this->password, 'device_id' => $this->deviceId ]; $this->json('POST', '/api/register', $body) ->assertStatus(200)->assertJson([ "success" => true ]); }

Copier après la connexion

Al igual que con el login, solicitamos que nos confirme el sistema que se nos está entregando un código 200 así como el arreglo [“success” => true], si logramos eso, ya hemos terminado, pero si te das cuenta, nos hace falta la prueba en caso de que se equivoque el usuario. Ese método te lo dejo de tarea para que puedas corroborar tus conocimientos.

Ahora bien probaremos los siguientes métodos:

public function profile() { $user = Auth::user(); $profile = Profile::find($user->id); if (null !== $profile) { return response()->json(["success" => true, "data" => $user], $this->successStatus); } else { return response()->json(['success' => false, 'message' => 'Usuario no encontrado.'], $this->notFoundStatus); } }

Copier après la connexion

public function createProfile(Request $request) { try { $validator = Validator::make($request->all(), [ 'first_name' => 'required', 'last_name' => 'required', 'birth_date' => 'required|date', 'bloodtype' => 'required|numeric', 'phone' => 'required', 'gender' => 'required|numeric', 'country' => 'required|numeric', 'state' => 'required|numeric', ]); if ($validator->fails()) { return response()->json(['success' => false, 'error' => $validator->errors()], $this->badRequestStatus); } $user = Auth::user(); $profile = Profile::where(['user_id' => $user->id])->first(); $data = [ 'user_id' => $user->id, ]; $dataInsert = array_merge($data, $request->all()); if (null !== $profile) { $profile = $profile->update($dataInsert); } else { $profile = Profile::create($dataInsert); } return response()->json(["success" => true, "message" => 'Perfil actualizado correctamente.'], $this->successStatus); } catch (QueryException $e) { return response()->json(["success" => false, "message" => 'Error al actualizar el perfil.'], $this->internalServerErrorStatus); } }

Copier après la connexion

Este par de métodos son los referentes a la gestión del perfil del usuario y su retroalimentación, por lo que los casos de uso que debemos probar son del 4 al 7. Para el caso 4, debemos crear un nuevo método llamado test_register_profile_success y agregamos el siguiente código:

public function test_register_profile_success() { $body = [ 'first_name' => $this->faker->firstName, 'last_name' => $this->faker->lastName, 'birth_date' => '1987-10-10', 'bloodtype' => 1, 'phone' => $this->faker->phoneNumber, 'gender' => 1, 'country' => 1, 'state' => 1, ]; $user = User::factory()->create(); $token = $user->createToken('TestToken')->plainTextToken; $response = $this->withHeaders([ 'Authorization' => 'Bearer ' . $token, ])->post('/api/user/profile', $body); $response->assertStatus(200); }

Copier après la connexion

En esta ocasión, necesitamos declarar un arreglo que simule el contenido del cuerpo del request para que pueda ser enviado correctamente por el endpoint y una vez enviado, el confirmar que el request tiene una respuesta satisfactoria (200).

Para el caso del perfil erróneo por no ingresar datos, necesitamos agregar un nuevo método que denominaremos test_register_profile_validation_failed, el cual implementaremos de la siguiente forma:

public function test_register_profile_validation_failed() { $user = User::factory()->create(); $token = $user->createToken('TestToken')->plainTextToken; $response = $this->withHeaders([ 'Authorization' => 'Bearer ' . $token, ])->post('/api/user/profile', []); $response->assertStatus(400); }

Copier après la connexion

En este caso, es prácticamente el mismo contenido de la prueba anterior, con la diferencia que ahora le enviamos un arreglo en blanco, para poder asegurarnos que si no se están enviando los datos correctamente, no permita la creación del perfil del usuario por medio de un Bad Request error (400).

El siguiente método probará que en caso de no encontrar el perfil de algún usuario, así lo indique con un código 404, por lo que creamos otro método denominado test_obtain_profile_not_found e ingresando el siguiente código.

public function test_obtain_profile_not_found() { $user = User::factory()->create(); $token = $user->createToken('TestToken')->plainTextToken; $response = $this->withHeaders([ 'Authorization' => 'Bearer ' . $token, ])->get('/api/user/profile'); $response->assertStatus(404); }

Copier après la connexion

En el modelo de negocio, nosotros al registrarnos, creamos el usuario, mas no el perfil que tiene que ser ingresado posteriormente, por lo que al momento de ejecutar la prueba unitaria, al ejecutar el request para obtener el perfil, nos enviará un código 404, comportamiento que estamos buscando para esta prueba unitaria.

Finalmente para el último caso de uso, crearemos el método test_register_profile_and_obtain para confirmar que un mismo test pueda obtener dos comportamientos en un mismo flujo. Para este caso implementaremos el siguiente código:

public function test_register_profile_and_obtain() { $body = [ 'first_name' => $this->faker->firstName, 'last_name' => $this->faker->lastName, 'birth_date' => '1987-10-10', 'bloodtype' => 1, 'phone' => $this->faker->phoneNumber, 'gender' => 1, 'country' => 1, 'state' => 1, ]; $user = User::factory()->create(); $token = $user->createToken('TestToken')->plainTextToken; $this->withHeaders([ 'Authorization' => 'Bearer ' . $token, ])->post('/api/user/profile', $body); $response = $this->withHeaders([ 'Authorization' => 'Bearer ' . $token, ])->get('/api/user/profile'); $response->assertStatus(200); }

Copier après la connexion

En este test, implementamos dos casos de uso realizados previamente, el primero es la creación del perfil y posteriormente, retroalimentamos el perfil, indicando a PHPUnit que deseamos confirmar que el response del endpoint que retroalimenta el perfil sea satisfactoria (código 200). Igualmente podríamos realizar el assert de la inserción de datos cambiando algunas líneas de código, pero por el momento es más que suficiente.

Ya terminando las pruebas unitarias, procedemos a ejecutar el comando docker compose exec laravel.test php artisan test y confirmamos el estatus de nuestras pruebas unitarias. Si nos salen de esta forma:

PASS Tests\Unit\UserTest ✓ login error with data ok. 0.10s ✓ login success. 0.15s ✓ register success. 0.20s ✓ register profile success. 0.10s ✓ register profile validation failed. 0.09s ✓ obtain profile not found. 0.10s ✓ register profile and obtain. 0.10s

Copier après la connexion

Las pruebas unitarias salieron satisfactorias. En caso contrario, checa lo siguiente:

Kaedah yang mempunyai masalah, periksa sama ada ia bukan situasi kod.
Pastikan konfigurasi PHPUnit sesuai, kami akan menyelidikinya dalam siaran seterusnya.

Begitu juga, saya akan menerangkan cara mengkonfigurasi Tindakan Github untuk menjalankan ujian unit padanya dan juga boleh mendapatkan laporan liputan kod dan kemungkinan penggunaan berterusan. Saya berharap siaran ini, walaupun panjang, dapat memberi anda lebih banyak konteks tentang ujian unit dan tentang proses penyepaduan dan penggunaan yang berterusan.

Selamat pengekodan!

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!