Testing workshop (#9668)

* updated to ignore tool versions for local python version management

* remove whitespace

* update factory locations for testing workshop

* update module path for cy_create_grants

* update factories and tests

* prep for testing workshop

* tests from workshop

* updated location of factory in import

* update test and factory for grant_clr

* Update .gitignore

Co-authored-by: Graham Dixon <[email protected]>

Co-authored-by: Kevin Solorio <[email protected]>
Co-authored-by: Graham Dixon <[email protected]>

Author: 3 people

.gitignore

@@ -61,3 +61,6 @@ _build/
 # cypress artifacts
 cypress/videos
 cypress/screenshots
+
+# asdf-vm (https://asdf-vm.com/)
+.tool-versions

app/dashboard/tests/factories/__init__.py

@@ -0,0 +1,3 @@
+from .bounty_factory import BountyFactory
+from .fulfillment_factory import FulfillmentFactory
+from .profile_factory import ProfileFactory

app/dashboard/tests/factories/bounty_factory.py

@@ -8,8 +8,8 @@ class BountyFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = Bounty
 
-    web3_created = datetime.now()
-    is_open = True
-    expires_date = datetime.now() + timedelta(days=365)
-    raw_data = {}
-    bounty_owner_github_username = 'gitcoin'
+    web3_created = factory.LazyFunction(datetime.now)
+    is_open = factory.Faker('pybool')
+    expires_date = factory.LazyFunction(lambda: datetime.now() + timedelta(days=365))
+    raw_data = factory.LazyFunction(dict)
+    bounty_owner_github_username = factory.LazyFunction(lambda: 'gitcoin')

app/dashboard/tests/factories/profile_factory.py

@@ -9,4 +9,4 @@ class Meta:
         model = Profile
 
     handle = factory.Sequence(lambda n: "Contributor_%03d" % n)
-    data = {}
+    data = factory.LazyFunction(dict)

app/grants/tests/models/factories/__init__.py renamed to app/dashboard/tests/models/__init__.py

@@ -0,0 +1,21 @@
+from attr import has
+import pytest
+
+from dashboard.models import BountyFulfillment
+from dashboard.tests.factories.fulfillment_factory import FulfillmentFactory
+from dashboard.tests.factories.bounty_factory import BountyFactory
+
+@pytest.mark.django_db
+class TestBountyFulfillmentProperties:
+    def test_fulfillment_has_bounty(self):
+        fulfillment = FulfillmentFactory()
+        assert hasattr(fulfillment, 'bounty')
+
+    def test_deleting_bounty_deletes_fulfillment(self):
+        bounty = BountyFactory()
+        fulfillment = FulfillmentFactory(bounty=bounty)
+
+        bounty.delete()
+
+        with pytest.raises(BountyFulfillment.DoesNotExist):
+            fulfillment.refresh_from_db()

app/dashboard/tests/models/test_bounty_fulfillment.py

@@ -1,5 +1,5 @@
 import pytest
-from dashboard.tests.factories.bounty_factory import BountyFactory
+from dashboard.tests.factories import BountyFactory
 from rest_framework.test import APIClient
 
 
@@ -13,4 +13,4 @@ def test_retrieves_activities(self, django_user_model):
         client.force_login(user)
         response = client.get('/actions/api/v0.1/bounty/', github_url, format='json')
 
-        assert response.status_code == 200
+        assert response.status_code == 200

app/dashboard/tests/views/test_bounty_api.py

@@ -1,7 +1,5 @@
 import pytest
-from dashboard.tests.factories.profile_factory import ProfileFactory
-from dashboard.tests.factories.bounty_factory import BountyFactory
-from dashboard.tests.factories.fulfillment_factory import FulfillmentFactory
+from dashboard.tests.factories import ProfileFactory, BountyFactory, FulfillmentFactory
 from rest_framework.test import APIClient
 
 
@@ -31,4 +29,4 @@ def test_pays_out_bounty(self, django_user_model):
 
         response = client.post(f'/api/v1/bounty/payout/{fulfillment.id}', payload)
 
-        assert response.status_code == 200
+        assert response.status_code == 200

app/dashboard/tests/views/test_bounty_payout.py

@@ -2,7 +2,7 @@
 
 import pytest
 from dashboard.models import PortfolioItem
-from dashboard.tests.factories.profile_factory import ProfileFactory
+from dashboard.tests.factories import ProfileFactory
 
 
 class TestProfileTabProjectCreation:

app/dashboard/tests/views/test_profile_projects.py

@@ -2,7 +2,7 @@
 
 from django.core.management.base import BaseCommand
 
-from grants.tests.models.factories.grant_factory import GrantFactory
+from grants.tests.factories import GrantFactory
 
 
 class Command(BaseCommand):

app/grants/management/commands/cy_create_grants.py

@@ -0,0 +1,16 @@
+from .cart_activity_factory import CartActivityFactory
+from .clr_match_factory import CLRMatchFactory
+from .contribution_factory import ContributionFactory
+from .donation_factory import DonationFactory
+from .flag_factory import FlagFactory
+from .grant_api_key_factory import GrantAPIKeyFactory
+from .grant_branding_routing_policy_factory import GrantBrandingRoutingPolicyFactory
+from .grant_category_factory import GrantCategoryFactory
+from .grant_clr_calculation_factory import GrantCLRCalculationFactory
+from .grant_clr_factory import GrantCLRFactory
+from .grant_collection_factory import GrantCollectionFactory
+from .grant_factory import GrantFactory
+from .grant_stat_factory import GrantStatFactory
+from .grant_type_factory import GrantTypeFactory
+from .match_pledge_factory import MatchPledgeFactory
+from .subscription_factory import SubscriptionFactory

app/grants/tests/factories/__init__.py

@@ -1,18 +1,18 @@
+import random
+
 import factory
 import pytest
-from dashboard.tests.factories.profile_factory import ProfileFactory
+from dashboard.tests.factories import ProfileFactory
 from grants.models.cart_activity import CartActivity
 
 from .grant_factory import GrantFactory
 
 
 @pytest.mark.django_db
 class CartActivityFactory(factory.django.DjangoModelFactory):
-    """Create mock CartActivity for testing."""
-
     class Meta:
         model = CartActivity
 
     grant = factory.SubFactory(GrantFactory)
     profile = factory.SubFactory(ProfileFactory)
-    action = ''
+    action = factory.LazyFunction(lambda: random.choice(CartActivity.ACTIONS)[0])

app/grants/tests/models/factories/cart_activity_factory.py renamed to app/grants/tests/factories/cart_activity_factory.py

@@ -1,5 +1,6 @@
 import factory
 import pytest
+
 from grants.models.clr_match import CLRMatch
 
 from .contribution_factory import ContributionFactory
@@ -8,12 +9,10 @@
 
 @pytest.mark.django_db
 class CLRMatchFactory(factory.django.DjangoModelFactory):
-    """Create a mock CLRMatch for testing."""
-
     class Meta:
-        model = CLRMatch 
+        model = CLRMatch
 
-    amount = 0.0
+    amount = factory.Faker('pyfloat')
     grant = factory.SubFactory(GrantFactory)
     test_payout_contribution = factory.SubFactory(ContributionFactory)
     payout_contribution = factory.SubFactory(ContributionFactory)

app/grants/tests/models/factories/clr_match_factory.py renamed to app/grants/tests/factories/clr_match_factory.py

@@ -5,8 +5,6 @@
 
 
 class ContributionFactory(factory.django.DjangoModelFactory):
-    """Create mock Contribution for testing."""
-
     class Meta:
         model = Contribution
 

app/grants/tests/models/factories/contribution_factory.py renamed to app/grants/tests/factories/contribution_factory.py

@@ -3,14 +3,12 @@
 from grants.models.donation import Donation
 
 from .contribution_factory import ContributionFactory
-from .profile_factory import ProfileFactory
+from dashboard.tests.factories import ProfileFactory
 from .subscription_factory import SubscriptionFactory
 
 
 @pytest.mark.django_db
 class DonationFactory(factory.django.DjangoModelFactory):
-    """Create a mock Donation for testing."""
-
     class Meta:
         model = Donation
 

app/grants/tests/models/factories/donation_factory.py renamed to app/grants/tests/factories/donation_factory.py

@@ -3,16 +3,13 @@
 from grants.models.flag import Flag
 
 from .grant_factory import GrantFactory
-from .profile_factory import ProfileFactory
+from dashboard.tests.factories import ProfileFactory
 
 
 @pytest.mark.django_db
 class FlagFactory(factory.django.DjangoModelFactory):
-    """Create a mock Flag for testing."""
-
     class Meta:
         model = Flag
 
     grant = factory.SubFactory(GrantFactory)
     profile = factory.SubFactory(ProfileFactory)
-    comments = ''

app/grants/tests/models/factories/flag_factory.py renamed to app/grants/tests/factories/flag_factory.py

@@ -1,12 +1,10 @@
 import factory
 from grants.models.grant_api_key import GrantAPIKey
 
-from .profile_factory import ProfileFactory
+from dashboard.tests.factories import ProfileFactory
 
 
 class GrantAPIKeyFactory(factory.django.DjangoModelFactory):
-    """Create mock GrantAPIKey for testing."""
-
     class Meta:
         model = GrantAPIKey
 

app/grants/tests/models/factories/grant_api_key_factory.py renamed to app/grants/tests/factories/grant_api_key_factory.py

@@ -1,11 +1,11 @@
+from random import randint
+
 import factory
 from grants.models.grant_branding_routing_policy import GrantBrandingRoutingPolicy
 
 
 class GrantBrandingRoutingPolicyFactory(factory.django.DjangoModelFactory):
-    """Create mock GrantBrandingRoutingPolicy for testing."""
-
     class Meta:
         model = GrantBrandingRoutingPolicy
 
-    priority = 1
+    priority = factory.LazyFunction(lambda: randint(1, 255))

app/grants/tests/models/factories/grant_branding_routing_policy_factory.py renamed to app/grants/tests/factories/grant_branding_routing_policy_factory.py

@@ -3,9 +3,5 @@
 
 
 class GrantCategoryFactory(factory.django.DjangoModelFactory):
-    """Create mock GrantCategory for testing."""
-
     class Meta:
         model = GrantCategory
-
-    category = factory.Sequence(lambda n: "Category #%s" % n)

app/grants/tests/factories/grant_category_factory.py

@@ -8,8 +8,6 @@
 
 @pytest.mark.django_db
 class GrantCLRCalculationFactory(factory.django.DjangoModelFactory):
-    """Create mock GrantCLRCalculation for testing."""
-
     class Meta:
         model = GrantCLRCalculation
 

app/grants/tests/models/factories/grant_clr_calculation_factory.py renamed to app/grants/tests/factories/grant_clr_calculation_factory.py

@@ -1,20 +1,21 @@
 from datetime import datetime, timedelta
+from random import choice
 
 import factory
 import pytest
 from grants.models.grant import GrantCLR
 
+from dashboard.tests.factories import ProfileFactory
+
 
 @pytest.mark.django_db
 class GrantCLRFactory(factory.django.DjangoModelFactory):
-    """Create mock GrantCLR for testing."""
-
     class Meta:
         model = GrantCLR
 
-    round_num = 2
-    start_date = datetime.now()
-    end_date = start_date + timedelta(weeks=2)
-    is_active = True
-    type='main'
-    banner_text='text which appears below banner'
+    round_num = factory.Faker('pyint')
+    start_date = factory.LazyFunction(datetime.now)
+    end_date = factory.LazyAttribute(lambda o: o.start_date + timedelta(weeks=2))
+    type = factory.LazyFunction(lambda: choice(GrantCLR.CLR_TYPES)[0])
+    banner_text = factory.Faker('catch_phrase')
+    owner = factory.SubFactory(ProfileFactory)

app/grants/tests/factories/grant_clr_factory.py

@@ -1,12 +1,10 @@
 import factory
 from grants.models.grant_collection import GrantCollection
 
-from .profile_factory import ProfileFactory
+from dashboard.tests.factories import ProfileFactory
 
 
 class GrantCollectionFactory(factory.django.DjangoModelFactory):
-    """Create mock GrantCollection for testing."""
-
     class Meta:
         model = GrantCollection
 

app/grants/tests/models/factories/grant_collection_factory.py renamed to app/grants/tests/factories/grant_collection_factory.py

@@ -3,7 +3,5 @@
 
 
 class GrantFactory(factory.django.DjangoModelFactory):
-    """Create mock Grant for testing."""
-
     class Meta:
         model = Grant

app/grants/tests/models/factories/grant_factory.py renamed to app/grants/tests/factories/grant_factory.py

@@ -5,8 +5,6 @@
 
 
 class GrantStatFactory(factory.django.DjangoModelFactory):
-    """Create mock GrantStat for testing."""
-
     class Meta:
         model = GrantStat
 

app/grants/tests/models/factories/grant_stat_factory.py renamed to app/grants/tests/factories/grant_stat_factory.py

@@ -3,7 +3,5 @@
 
 
 class GrantTypeFactory(factory.django.DjangoModelFactory):
-    """Create mock GrantType for testing."""
-
     class Meta:
         model = GrantType

app/grants/tests/factories/grant_type_factory.py

@@ -4,15 +4,13 @@
 from grants.models.match_pledge import MatchPledge
 
 from .grant_clr_factory import GrantCLRFactory
-from .profile_factory import ProfileFactory
+from dashboard.tests.factories import ProfileFactory
 
 
 class MatchPledgeFactory(factory.django.DjangoModelFactory):
-    """Create mock MatchPledge for testing."""
-
     class Meta:
         model = MatchPledge
 
     profile = factory.SubFactory(ProfileFactory)
-    data = json.dumps('test string')
+    data = factory.LazyFunction(lambda: json.dumps(dict()))
     clr_round_num = factory.SubFactory(GrantCLRFactory)

app/grants/tests/models/factories/match_pledge_factory.py renamed to app/grants/tests/factories/match_pledge_factory.py

@@ -2,14 +2,12 @@
 from grants.models.subscription import Subscription
 
 from .grant_factory import GrantFactory
-from .profile_factory import ProfileFactory
+from dashboard.tests.factories import ProfileFactory
 
 
 class SubscriptionFactory(factory.django.DjangoModelFactory):
-    """Create mock Subscription for testing."""
-
     class Meta:
         model = Subscription
 
     grant = factory.SubFactory(GrantFactory)
-    contributor_profile = factory.SubFactory(ProfileFactory) 
+    contributor_profile = factory.SubFactory(ProfileFactory)

app/grants/tests/models/factories/subscription_factory.py renamed to app/grants/tests/factories/subscription_factory.py

@@ -6,31 +6,25 @@
 import pytest
 from grants.management.commands.grant_collections_shuffle import grant_collection_age_score, grant_meta_data_score
 
-from ...models.factories.grant_collection_factory import GrantCollectionFactory
-from ...models.factories.grant_factory import GrantFactory
+from grants.tests.factories import GrantFactory
 
 
 @pytest.mark.django_db
 def test_grant_collections_shuffle_grant_meta_data_score():
-    grant_1 = GrantFactory()
-    grant_2 = GrantFactory()
-    
-    grant_1.twitter_verified = True
-    grant_2.twitter_verified = True
-    
-    grant_1.github_project_url = 'https://github.com/gitcoinco/web'
-    grant_2.github_project_url = 'https://github.com/gitcoinco/web'
-    
+    grant_1 = GrantFactory(twitter_verified=True, github_project_url='https://github.com/gitcoinco/web')
+    grant_2 = GrantFactory(twitter_verified=True, github_project_url='https://github.com/gitcoinco/web')
     grants = (grant_1, grant_2)
 
     score = grant_meta_data_score(grants)
-    
+
     assert score == 12000
-    
+
 @pytest.mark.django_db
 def test_grant_collections_shuffle_calc_age_score():
     today = datetime.now()
     last_month = today - (today - timedelta(days=28))
     last_week = today - timedelta(days=7)
+
     score = grant_collection_age_score(last_month, last_week)
+
     assert score == 3750