Files
laravel-api-kit/tests/Feature/Api/V1/PasswordResetTest.php
ELMEHDI ACHAHED 13da9b84c1 Feature (#16)
* feat: add email verification endpoints and tests

Add comprehensive CI/CD pipeline using GitHub Actions

- Run Pest tests on PHP 8.3 and 8.4 with MySQL 8.0
- Automated code style checks with Pint
- Static analysis with Larastan/PHPStan
- Parallel job execution for faster builds
- Composer dependency caching
- MySQL service container with health checks

* feat: implement password reset flow with secure tokens , add forgot password and reset password functionality

- Created password_reset_tokens table migration
- Added POST /api/v1/forgot-password endpoint
- Added POST /api/v1/reset-password endpoint
- Both endpoints rate-limited to 6 requests per minute
- Integrated with Laravel's Password facade for secure token management
- Revokes all user tokens upon successful password reset
- Created ForgotPasswordRequest and ResetPasswordRequest with validation
- Added comprehensive test suite (6 test cases)
Password reset uses signed, time-limited tokens stored in the database.
All user sessions are invalidated after successful reset for security.

* feat: add reusable API middleware examples , Implement three production-ready middleware patterns for APIs

ForceJsonResponse:
- Ensures all API responses are JSON formatted
- Sets Accept: application/json header automatically
- Handles non-JSON responses gracefully
LogApiRequests:
- Logs API requests with timestamp, method, URL, IP, user ID, status
- Tracks and logs response time in milliseconds
- Adds X-Response-Time header to all responses
- Configurable via APP_LOG_API_REQUESTS env variable
EnsureEmailVerified:
- Protects routes requiring verified emails
- Returns 403 with descriptive message for unverified users
- Works with MustVerifyEmail contract
All middleware registered as aliases in bootstrap/app.php:
'force.json', 'log.api', 'verified'
These provide common API patterns that developers can apply to routes as needed.

* docs: update README with new API endpoints , Update API endpoints table with email verification and password reset routes

- Added 4 new endpoint rows to API documentation
- Updated rate limits for protected routes (60/min -> 120/min)
- Documented email verification endpoints
- Documented password reset endpoints
- All new endpoints properly documented with auth requirements"

* Update 0001_01_01_000000_create_users_table.php

* Fix test suite configuration and update route names to standard Laravel conventions

* style: fix code formatting per Laravel Pint standards

* refactor: revert password_reset_tokens back to users create_users migration

* Update 0001_01_01_000000_create_users_table.php

* fix: resolve all code style and type safety issues

Pint fixes:
- Fixed concat_space issues
- Removed unused imports (MustVerifyEmail from EnsureEmailVerified)
- Fixed not_operator_with_successor_space formatting

Rector fixes:
- Applied EncapsedStringsToSprintfRector for better type safety
- All code quality improvements applied

PHPStan fixes:
- Changed all middleware return types from Response to mixed (Laravel standard)
- Added Response type guard in LogApiRequests before accessing methods
- Removed redundant instanceof MustVerifyEmail check (User always implements it)
2026-01-29 04:16:33 +01:00

122 lines
3.6 KiB
PHP

<?php
declare(strict_types=1);
use App\Models\User;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Support\Facades\Hash;
use Illuminate\Support\Facades\Password;
uses(RefreshDatabase::class);
describe('Forgot Password', function (): void {
it('sends reset link successfully', function (): void {
$user = User::factory()->create();
$response = $this->postJson('/api/v1/forgot-password', [
'email' => $user->email,
]);
$response->assertStatus(200)
->assertJson([
'success' => true,
'message' => 'Password reset link sent to your email',
]);
});
it('fails with non-existent email', function (): void {
$response = $this->postJson('/api/v1/forgot-password', [
'email' => 'nonexistent@example.com',
]);
$response->assertStatus(422);
});
it('respects rate limiting', function (): void {
$user = User::factory()->create();
// Make 7 requests (limit is 6 per minute)
for ($i = 0; $i < 7; $i++) {
$response = $this->postJson('/api/v1/forgot-password', [
'email' => $user->email,
]);
}
// Last request should be rate limited
$response->assertStatus(429);
});
});
describe('Reset Password', function (): void {
it('resets password successfully with valid token', function (): void {
$user = User::factory()->create();
$token = Password::createToken($user);
$response = $this->postJson('/api/v1/reset-password', [
'email' => $user->email,
'token' => $token,
'password' => 'newpassword123',
'password_confirmation' => 'newpassword123',
]);
$response->assertStatus(200)
->assertJson([
'success' => true,
'message' => 'Password reset successfully',
]);
// Verify password was changed
$this->assertTrue(Hash::check('newpassword123', $user->fresh()->password));
// Verify all tokens were deleted
$this->assertDatabaseCount('personal_access_tokens', 0);
});
it('fails with invalid token', function (): void {
$user = User::factory()->create();
$response = $this->postJson('/api/v1/reset-password', [
'email' => $user->email,
'token' => 'invalid-token',
'password' => 'newpassword123',
'password_confirmation' => 'newpassword123',
]);
$response->assertStatus(400)
->assertJson([
'success' => false,
'message' => 'Invalid or expired reset token',
]);
});
it('fails with mismatched passwords', function (): void {
$user = User::factory()->create();
$token = Password::createToken($user);
$response = $this->postJson('/api/v1/reset-password', [
'email' => $user->email,
'token' => $token,
'password' => 'newpassword123',
'password_confirmation' => 'differentpassword',
]);
$response->assertStatus(422);
});
it('fails with non-existent email', function (): void {
$response = $this->postJson('/api/v1/reset-password', [
'email' => 'nonexistent@example.com',
'token' => 'some-token',
'password' => 'newpassword123',
'password_confirmation' => 'newpassword123',
]);
$response->assertStatus(400)
->assertJson([
'success' => false,
'message' => 'User not found',
]);
});
});