Merge pull request #433 from cattr-app/test/faker-unique-emails

test: share one Faker generator across the test factories

Author: vermorag

tests/Factories/IntervalFactory.php

@@ -6,7 +6,6 @@
 use App\Models\TimeInterval;
 use App\Models\User;
 use Carbon\Carbon;
-use Faker\Factory as FakerFactory;
 use Tests\Facades\TaskFactory;
 use Tests\Facades\UserFactory;
 
@@ -26,7 +25,7 @@ public function createRandomModelDataWithRelation(): array
 
     public function createRandomModelData(): array
     {
-        $randomDateTime = FakerFactory::create()->unique()->dateTimeThisYear();
+        $randomDateTime = fake()->unique()->dateTimeThisYear();
         $randomDateTime = Carbon::instance($randomDateTime);
 
         return [

tests/Factories/InvitationFactory.php

@@ -3,7 +3,6 @@
 namespace Tests\Factories;
 
 use App\Models\Invitation;
-use Faker\Factory as FakerFactory;
 use Illuminate\Database\Eloquent\Model;
 
 class InvitationFactory extends Factory
@@ -17,7 +16,7 @@ protected function getModelInstance(): Model
 
     public function createRequestData(): array
     {
-        $faker = FakerFactory::create();
+        $faker = fake();
 
         return [
             'users' => [
@@ -31,7 +30,7 @@ public function createRequestData(): array
 
     public function createRandomModelData(): array
     {
-        $faker = FakerFactory::create();
+        $faker = fake();
 
         return [
             'email' => $faker->unique()->email,

tests/Factories/ProjectFactory.php

@@ -4,7 +4,6 @@
 
 use App\Models\Project;
 use App\Enums\ScreenshotsState;
-use Faker\Factory as FakerFactory;
 use Tests\Facades\TaskFactory;
 
 class ProjectFactory extends Factory
@@ -62,7 +61,7 @@ public function forUsers(array $users): self
 
     public function createRandomModelData(): array
     {
-        $faker = FakerFactory::create();
+        $faker = fake();
 
         return [
             'company_id' => self::COMPANY_ID,

tests/Factories/TaskFactory.php

@@ -7,7 +7,6 @@
 use App\Models\Status;
 use App\Models\Task;
 use App\Models\User;
-use Faker\Factory as FakerFactory;
 use Illuminate\Database\Eloquent\Model;
 use Tests\Facades\IntervalFactory;
 use Tests\Facades\ProjectFactory;
@@ -77,7 +76,7 @@ public function create(array $attributes = []): Task
 
     public function createRandomModelData(): array
     {
-        $faker = FakerFactory::create();
+        $faker = fake();
 
         return [
             'task_name' => $faker->jobTitle,

tests/Factories/UserFactory.php

@@ -5,7 +5,6 @@
 use App\Enums\ScreenshotsState;
 use App\Models\User;
 use Carbon\Carbon;
-use Faker\Factory as FakerFactory;
 use Illuminate\Database\Eloquent\Model;
 
 class UserFactory extends Factory
@@ -52,7 +51,7 @@ public function create(): User
 
     public function createRandomModelData(): array
     {
-        $faker = FakerFactory::create();
+        $faker = fake();
 
         $fullName = $faker->name;
 
@@ -80,7 +79,7 @@ public function createRandomModelData(): array
 
     public function createRandomRegistrationModelData(): array
     {
-        $faker = FakerFactory::create();
+        $faker = fake();
 
         return [
             'full_name' => $faker->name,

tests/Feature/Factories/TestFactoryUniquenessTest.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Tests\Feature\Factories;
+
+use Tests\Facades\InvitationFactory;
+use Tests\Facades\UserFactory;
+use Tests\TestCase;
+
+/**
+ * The test factories in tests/Factories used to create a new Faker generator on every call, so
+ * `unique()` only applied within one call and users created in the same test could get the same
+ * e-mail (an intermittent unique-key violation, e.g. in ProjectMembers\ShowTest). They now share
+ * the application's generator, which is reset together with the application for every test.
+ */
+class TestFactoryUniquenessTest extends TestCase
+{
+    // Large enough that independent generators almost surely repeat a safeEmail, small enough to stay fast.
+    private const SAMPLES = 1000;
+
+    public function test_user_emails_are_unique_across_factory_calls(): void
+    {
+        $emails = [];
+        for ($i = 0; $i < self::SAMPLES; $i++) {
+            $emails[] = UserFactory::createRandomModelData()['email'];
+            $emails[] = UserFactory::createRandomRegistrationModelData()['email'];
+        }
+
+        $this->assertSameSize($emails, array_unique($emails));
+    }
+
+    public function test_invitation_emails_are_unique_across_factory_calls(): void
+    {
+        $emails = [];
+        for ($i = 0; $i < self::SAMPLES; $i++) {
+            $emails[] = InvitationFactory::createRandomModelData()['email'];
+        }
+
+        $this->assertSameSize($emails, array_unique($emails));
+    }
+}

tests/Feature/Users/EditTest.php

@@ -6,7 +6,6 @@
 use Illuminate\Foundation\Testing\WithFaker;
 use Tests\Facades\UserFactory;
 use Tests\TestCase;
-use Faker\Factory as FakerFactory;
 
 class EditTest extends TestCase
 {
@@ -80,7 +79,7 @@ public function test_edit_as_user(): void
 
     public function test_edit_as_your_own_user(): void
     {
-        $faker = FakerFactory::create();
+        $faker = fake();
         $user = clone $this->user;
 
         $user->full_name = $faker->unique()->firstName;