Use factory.Sequence with faker.unique to remove the chance of duplicate values (#17740)

* use a unique faker class to remove the chance of duplicate values

Replace faker providers known to occasionally fail with the unique faker (safe_email, user_name, ipv4_private

Based on: FactoryBoy/factory_boy#305
See also: FactoryBoy/factory_boy#820

closes #17734
relates to #15398

* use existing approach for getting unique faker sequences in tests

---------

Co-authored-by: Dustin Ingram <[email protected]>

Author: cofiem

tests/common/db/accounts.py

@@ -112,7 +112,11 @@ class Meta:
         model = Email
 
     user = factory.SubFactory(UserFactory)
-    email = factory.Faker("safe_email")
+
+    # TODO: Replace when factory_boy supports `unique`.
+    #  See https://github.com/FactoryBoy/factory_boy/pull/997
+    email = factory.Sequence(lambda _: fake.unique.safe_email())
+
     verified = True
     primary = True
     public = False
@@ -133,4 +137,6 @@ class ProhibitedUsernameFactory(WarehouseFactory):
     class Meta:
         model = ProhibitedUserName
 
-    name = factory.Faker("user_name")
+    # TODO: Replace when factory_boy supports `unique`.
+    #  See https://github.com/FactoryBoy/factory_boy/pull/997
+    name = factory.Sequence(lambda _: fake.unique.user_name())

tests/common/db/ip_addresses.py

@@ -13,17 +13,23 @@
 import hashlib
 
 import factory
+import faker
 
 from warehouse.ip_addresses.models import IpAddress
 
 from .base import WarehouseFactory
 
+fake = faker.Faker()
+
 
 class IpAddressFactory(WarehouseFactory):
     class Meta:
         model = IpAddress
 
-    ip_address = factory.Faker("ipv4_private")
+    # TODO: Replace when factory_boy supports `unique`.
+    #  See https://github.com/FactoryBoy/factory_boy/pull/997
+    ip_address = factory.Sequence(lambda _: fake.unique.ipv4_private())
+
     hashed_ip_address = factory.LazyAttribute(
         lambda o: hashlib.sha256(o.ip_address.encode("utf8")).hexdigest()
     )

tests/common/db/oidc.py

@@ -11,6 +11,7 @@
 # limitations under the License.
 
 import factory
+import faker
 
 from warehouse.oidc.models import (
     ActiveStatePublisher,
@@ -26,6 +27,8 @@
 from .accounts import UserFactory
 from .base import WarehouseFactory
 
+fake = faker.Faker()
+
 
 class GitHubPublisherFactory(WarehouseFactory):
     class Meta:
@@ -82,7 +85,11 @@ class Meta:
         model = GooglePublisher
 
     id = factory.Faker("uuid4", cast_to=None)
-    email = factory.Faker("safe_email")
+
+    # TODO: Replace when factory_boy supports `unique`.
+    #  See https://github.com/FactoryBoy/factory_boy/pull/997
+    email = factory.Sequence(lambda _: fake.unique.safe_email())
+
     sub = factory.Faker("pystr", max_chars=12)
 
 
@@ -92,7 +99,11 @@ class Meta:
 
     id = factory.Faker("uuid4", cast_to=None)
     project_name = "fake-nonexistent-project"
-    email = factory.Faker("safe_email")
+
+    # TODO: Replace when factory_boy supports `unique`.
+    #  See https://github.com/FactoryBoy/factory_boy/pull/997
+    email = factory.Sequence(lambda _: fake.unique.safe_email())
+
     sub = factory.Faker("pystr", max_chars=12)
     added_by = factory.SubFactory(UserFactory)
 

tests/common/db/packaging.py

@@ -107,8 +107,11 @@ class Meta:
 
     release = factory.SubFactory(ReleaseFactory)
     python_version = "source"
-    # TODO: Replace when factory_boy supports `unique`. See https://git.io/JM6kx
+
+    # TODO: Replace when factory_boy supports `unique`.
+    #  See https://github.com/FactoryBoy/factory_boy/pull/997
     filename = factory.Sequence(lambda _: fake.unique.file_name())
+
     md5_digest = factory.LazyAttribute(
         lambda o: hashlib.md5(o.filename.encode("utf8")).hexdigest()
     )

tests/common/db/ses.py

@@ -13,11 +13,14 @@
 import datetime
 
 import factory
+import faker
 
 from warehouse.email.ses.models import EmailMessage, Event, EventTypes
 
 from .base import WarehouseFactory
 
+fake = faker.Faker()
+
 
 class EmailMessageFactory(WarehouseFactory):
     class Meta:
@@ -29,8 +32,12 @@ class Meta:
         - datetime.timedelta(days=14),
     )
     message_id = factory.Faker("pystr", max_chars=12)
-    from_ = factory.Faker("safe_email")
-    to = factory.Faker("safe_email")
+
+    # TODO: Replace when factory_boy supports `unique`.
+    #  See https://github.com/FactoryBoy/factory_boy/pull/997
+    from_ = factory.Sequence(lambda _: fake.unique.safe_email())
+    to = factory.Sequence(lambda _: fake.unique.safe_email())
+
     subject = factory.Faker("sentence")
 
 

tests/common/db/subscriptions.py

@@ -11,6 +11,7 @@
 # limitations under the License.
 
 import factory
+import faker
 
 from warehouse.subscriptions.models import (
     StripeCustomer,
@@ -23,14 +24,19 @@
 
 from .base import WarehouseFactory
 
+fake = faker.Faker()
+
 
 class StripeCustomerFactory(WarehouseFactory):
     class Meta:
         model = StripeCustomer
 
     id = factory.Faker("uuid4", cast_to=None)
     customer_id = factory.Faker("uuid4")
-    billing_email = factory.Faker("safe_email")
+
+    # TODO: Replace when factory_boy supports `unique`.
+    #  See https://github.com/FactoryBoy/factory_boy/pull/997
+    billing_email = factory.Sequence(lambda _: fake.unique.safe_email())
 
 
 class StripeSubscriptionProductFactory(WarehouseFactory):