Files
crewli/api/tests/Feature/Email/EmailSettingsAndTemplateControllerTest.php
bert.hausmans 65978104d8 feat: complete email infrastructure with queue, templates, logging, and API
Adds the full transactional email system:
- Redis queue (QUEUE_CONNECTION=redis), SES config in .env.example
- 3 migrations: organisation_email_settings, organisation_email_templates, email_logs
- EmailTemplateType and EmailLogStatus enums with Dutch defaults
- EmailService as central entry point for all email sending
- SendTransactionalEmail queued job with retries and idempotency
- TransactionalMail mailable with responsive HTML + plain text templates
- Organisation-level branding (colors, logo, footer, reply-to)
- Per-type template overrides with {variable} substitution
- Email log with filtering by status, type, date range, recipient
- Preview and send-test endpoints for template management
- API endpoints: email-settings, email-templates (CRUD), email-logs (read-only)
- Integrated into existing flows: invitations, password reset, email
  verification, registration approval/rejection
- 37 new tests across 4 test files, all existing tests updated

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-15 20:12:21 +02:00

236 lines
7.5 KiB
PHP

<?php
declare(strict_types=1);
namespace Tests\Feature\Email;
use App\Enums\EmailTemplateType;
use App\Models\Organisation;
use App\Models\OrganisationEmailSettings;
use App\Models\OrganisationEmailTemplate;
use App\Models\User;
use Database\Seeders\RoleSeeder;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Support\Facades\Queue;
use Laravel\Sanctum\Sanctum;
use Tests\TestCase;
class EmailSettingsAndTemplateControllerTest extends TestCase
{
use RefreshDatabase;
private User $orgAdmin;
private User $outsider;
private Organisation $organisation;
private Organisation $otherOrganisation;
protected function setUp(): void
{
parent::setUp();
$this->seed(RoleSeeder::class);
$this->organisation = Organisation::factory()->create(['name' => 'Test Org']);
$this->otherOrganisation = Organisation::factory()->create();
$this->orgAdmin = User::factory()->create();
$this->organisation->users()->attach($this->orgAdmin, ['role' => 'org_admin']);
$this->outsider = User::factory()->create();
$this->otherOrganisation->users()->attach($this->outsider, ['role' => 'org_admin']);
}
// ── Email Settings ──
public function test_show_returns_defaults_when_no_settings(): void
{
Sanctum::actingAs($this->orgAdmin);
$response = $this->getJson("/api/v1/organisations/{$this->organisation->id}/email-settings");
$response->assertOk();
$response->assertJsonPath('data.primary_color', '#6366F1');
}
public function test_show_returns_custom_settings(): void
{
OrganisationEmailSettings::factory()->create([
'organisation_id' => $this->organisation->id,
'primary_color' => '#FF0000',
]);
Sanctum::actingAs($this->orgAdmin);
$response = $this->getJson("/api/v1/organisations/{$this->organisation->id}/email-settings");
$response->assertOk();
$response->assertJsonPath('data.primary_color', '#FF0000');
}
public function test_update_creates_settings_if_not_exists(): void
{
Sanctum::actingAs($this->orgAdmin);
$response = $this->putJson("/api/v1/organisations/{$this->organisation->id}/email-settings", [
'primary_color' => '#00FF00',
'footer_text' => 'Custom Footer',
]);
$response->assertOk();
$this->assertDatabaseHas('organisation_email_settings', [
'organisation_id' => $this->organisation->id,
'primary_color' => '#00FF00',
'footer_text' => 'Custom Footer',
]);
}
public function test_update_modifies_existing_settings(): void
{
OrganisationEmailSettings::factory()->create([
'organisation_id' => $this->organisation->id,
'primary_color' => '#FF0000',
]);
Sanctum::actingAs($this->orgAdmin);
$response = $this->putJson("/api/v1/organisations/{$this->organisation->id}/email-settings", [
'primary_color' => '#00FF00',
]);
$response->assertOk();
$response->assertJsonPath('data.primary_color', '#00FF00');
}
public function test_update_validates_hex_color(): void
{
Sanctum::actingAs($this->orgAdmin);
$response = $this->putJson("/api/v1/organisations/{$this->organisation->id}/email-settings", [
'primary_color' => 'invalid',
]);
$response->assertUnprocessable();
$response->assertJsonValidationErrors(['primary_color']);
}
public function test_settings_denied_for_non_org_admin(): void
{
Sanctum::actingAs($this->outsider);
$response = $this->getJson("/api/v1/organisations/{$this->organisation->id}/email-settings");
$response->assertForbidden();
}
// ── Email Templates ──
public function test_index_returns_all_template_types_with_content(): void
{
Sanctum::actingAs($this->orgAdmin);
$response = $this->getJson("/api/v1/organisations/{$this->organisation->id}/email-templates");
$response->assertOk();
$this->assertCount(count(EmailTemplateType::cases()), $response->json('data'));
}
public function test_show_returns_template_with_defaults(): void
{
Sanctum::actingAs($this->orgAdmin);
$response = $this->getJson("/api/v1/organisations/{$this->organisation->id}/email-templates/invitation");
$response->assertOk();
$response->assertJsonPath('data.type', 'invitation');
$response->assertJsonPath('data.is_custom', false);
$this->assertArrayHasKey('defaults', $response->json('data'));
}
public function test_update_creates_custom_override(): void
{
Sanctum::actingAs($this->orgAdmin);
$response = $this->putJson("/api/v1/organisations/{$this->organisation->id}/email-templates/invitation", [
'subject' => 'Aangepaste uitnodiging',
'body_text' => 'Aangepaste tekst voor de uitnodiging.',
]);
$response->assertOk();
$response->assertJsonPath('data.is_custom', true);
$response->assertJsonPath('data.subject', 'Aangepaste uitnodiging');
$this->assertDatabaseHas('organisation_email_templates', [
'organisation_id' => $this->organisation->id,
'type' => 'invitation',
'subject' => 'Aangepaste uitnodiging',
]);
}
public function test_destroy_resets_to_default(): void
{
OrganisationEmailTemplate::factory()->create([
'organisation_id' => $this->organisation->id,
'type' => EmailTemplateType::INVITATION->value,
]);
Sanctum::actingAs($this->orgAdmin);
$response = $this->deleteJson("/api/v1/organisations/{$this->organisation->id}/email-templates/invitation");
$response->assertOk();
$this->assertDatabaseMissing('organisation_email_templates', [
'organisation_id' => $this->organisation->id,
'type' => 'invitation',
]);
}
public function test_preview_returns_rendered_html(): void
{
Sanctum::actingAs($this->orgAdmin);
$response = $this->postJson("/api/v1/organisations/{$this->organisation->id}/email-templates/invitation/preview");
$response->assertOk();
$this->assertArrayHasKey('html', $response->json('data'));
$this->assertStringContainsString('<!DOCTYPE html>', $response->json('data.html'));
}
public function test_send_test_queues_email(): void
{
Queue::fake();
Sanctum::actingAs($this->orgAdmin);
$response = $this->postJson("/api/v1/organisations/{$this->organisation->id}/email-templates/invitation/send-test", [
'email' => 'test@example.com',
]);
$response->assertOk();
$this->assertDatabaseHas('email_logs', [
'organisation_id' => $this->organisation->id,
'recipient_email' => 'test@example.com',
'template_type' => 'invitation',
]);
}
public function test_templates_denied_for_non_org_admin(): void
{
Sanctum::actingAs($this->outsider);
$response = $this->getJson("/api/v1/organisations/{$this->organisation->id}/email-templates");
$response->assertForbidden();
}
public function test_show_returns_404_for_invalid_type(): void
{
Sanctum::actingAs($this->orgAdmin);
$response = $this->getJson("/api/v1/organisations/{$this->organisation->id}/email-templates/nonexistent");
$response->assertNotFound();
}
}