Writing coverage for marketing model, increasing coverage to 33% #524

leonprou · 2018-03-04T19:11:08Z

Description

Adding tests to increase code coverage from 28% to 33%. Testing marketing module.

Checklist

linter status: 100% pass.
changes don't break existing behavior
commit message follows commit guidelines

Affected core subsystem(s)

marketing

Testing

This PR is increasing test coverage. Only one little refactor was made.

Refers/Fixes

#408

leonprou · 2018-03-05T06:51:36Z

@owocki hey, I'd like to merge it but it seems like the tests are failing again with same error as before

_pytest.vendored_packages.pluggy.PluginValidationError: Plugin 'ethereum' could not be loaded: (eth-utils 1.0.0b2 (/home/travis/virtualenv/python3.6.3/lib/python3.6/site-packages), Requirement.parse('eth-utils<2.0.0,>=1.0.1'), {'hexbytes', 'eth-abi'})!

leonprou · 2018-03-05T21:24:52Z

I think expitation_start_work got broken, it's uses created_at here. While Interest class has been changed to have created property. Found it running the tests after merge.

owocki · 2018-03-05T21:35:18Z

I think expitation_start_work got broken, it's uses created_at here. While Interest class has been changed to have created property. Found it running the tests after merge.

shoot.. you are right.. 9c82c4f should fix that

owocki · 2018-03-05T21:35:31Z

@owocki hey, I'd like to merge it but it seems like the tests are failing again with same error as before

IIRC, you and @mbeacom chatted about this on slack already, right?

owocki · 2018-03-05T21:37:44Z

just poked through the new tests.. 💯 thanks so much!

leonprou · 2018-03-06T06:49:31Z

IIRC, you and @mbeacom chatted about this on slack already, right?

Yeah, we talked. it's good now 👍

just poked through the new tests.. 💯 thanks so much!

You're welcome 😄, learned a thing or two writing the tests. I think more bounties like this are needed, I communicate some more thoughts later.

For now expiration_start_work implementation changed so the tests not pass, I'll look at that at the evening I guess.

owocki · 2018-03-06T10:24:37Z

For now expiration_start_work implementation changed so the tests not pass, I'll look at that at the evening I guess.

did you mean that my commit (9c82c4f) broke the tests? or something else?

leonprou · 2018-03-06T12:10:02Z

Oh no, some logic was changed before.. I assumed it was intentionally

…

On Tue, Mar 6, 2018, 12:24 Kevin Owocki ***@***.***> wrote: For now expiration_start_work implementation changed so the tests not pass, I'll look at that at the evening I guess. did you mean that my commit (hash pasted above in my previous comment) broke the tests? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#524 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AG5NrFHzvVBt4g5u03XfKSTGpyxP1HkFks5tbmPmgaJpZM4SbdJL> .

codecov · 2018-03-06T22:46:57Z

Codecov Report

Merging #524 into master will increase coverage by 4.86%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #524      +/-   ##
==========================================
+ Coverage   29.11%   33.98%   +4.86%     
==========================================
  Files          88       88              
  Lines        4880     4882       +2     
  Branches      571      571              
==========================================
+ Hits         1421     1659     +238     
+ Misses       3412     3157     -255     
- Partials       47       66      +19

Impacted Files	Coverage Δ
...ing/management/commands/send_subscription_mails.py	`100% <ø> (+100%)`	⬆️
...eting/management/commands/expiration_start_work.py	`84.31% <ø> (+84.31%)`	⬆️
...eting/management/commands/assemble_leaderboards.py	`51.78% <100%> (+51.78%)`	⬆️
app/dashboard/notifications.py	`14.7% <0%> (+0.32%)`	⬆️
app/marketing/models.py	`86.58% <0%> (+1.21%)`	⬆️
app/dashboard/models.py	`71.55% <0%> (+3.23%)`	⬆️
app/dashboard/signals.py	`55% <0%> (+25%)`	⬆️
app/marketing/utils.py	`66.66% <0%> (+37.03%)`	⬆️
...pp/marketing/management/commands/remarket_tweet.py	`66.66% <0%> (+66.66%)`	⬆️
... and 6 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d6c5a33...63b2cbd. Read the comment docs.

owocki · 2018-03-07T01:17:49Z

Oh no, some logic was changed before.. I assumed it was intentionally

The logic that was changed in 9c82c4f is just that if a comment happens before the 'start work' button is clicked it is disregarded..

Let me know if you have other questions to get the tests working agin

leonprou · 2018-03-07T06:00:58Z

The logic that was changed in 9c82c4f is just that if a comment happens before the 'start work' button is clicked it is disregarded..

Yes I solved that. Ok I think that this can be merged 😄, the last thing is about the linter? Which one you are using?

mbeacom · 2018-03-07T16:09:41Z

@leonprou I regularly use flake8, pylint, and pydocstyle along with a combination of plugins.

owocki · 2018-03-07T16:40:51Z

i use

isort --recursive --atomic

but i'm not as good of a citizen as @mbeacom

@mbeacom maybe we should update the readme with some agreed-upon linting commands so that maintainers can be expected to lint their own PRs?

mbeacom · 2018-03-07T16:45:13Z

@owocki I'm all for updating the docs to reflect a standard linting practice. I've been meaning to ask you about your thoughts on: https://stickler-ci.com/ - It's free for OSS. We could simply use their linter without using the fixer functionality to identify spots throughout a PR that don't adhere to the linting configuration for both python (flake8) and js (eslint).

owocki · 2018-03-07T17:20:42Z

certainly open to trying it.. hopefully between travis + codecov + stickler its not too overwhelming for new contributors

mbeacom · 2018-03-09T19:41:43Z

@leonprou Is this ready to review and test?

leonprou · 2018-03-09T20:44:13Z

Yes it's ready There's a problem in master I think, a linting (isort) is failing.

…

On Fri, Mar 9, 2018, 21:41 Mark Beacom ***@***.***> wrote: @leonprou <https://github.com/leonprou> Is this ready to review and test? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#524 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AG5NrCvXAjWkss4qVtpjefnZ43Y4wTD2ks5tctr5gaJpZM4SbdJL> .

mbeacom · 2018-03-09T20:49:55Z

@leonprou Yeah, that's fine... It's an isort failure on an import in sync_slack.py - All good.

Reviewing this now.

mbeacom · 2018-03-09T20:58:17Z

app/marketing/tests/management/commands/test_send_subscription_mails.py

+    """Define tests for roundup send subscription mails."""
+
+    def test_handle(self):
+        """Test command send subscription mails."""


Does this need to call Command().handle()?

thanks, forgot to test that one 👍

mbeacom · 2018-03-09T20:59:27Z

app/marketing/tests/test_marketing_utils.py

+        """Test the marketing util get_or_save_email_subscriber method."""
+        assert get_or_save_email_subscriber('emailSubscriber1@gitcoin.co', 'mysource') == 'priv1'
+
+        emailSubscriber1SecondSource = EmailSubscriber.objects.create(


Can you camel_case this variable?

actually it's unused variable)

mbeacom · 2018-03-09T21:01:41Z

app/marketing/management/commands/assemble_leaderboards.py

-    'all_earners': {},
-}
+def default_ranks():
+    return {


mbeacom · 2018-03-09T21:02:32Z

app/marketing/tests/management/commands/test_assemble_leaderboards.py

+            idx_status='submitted',
+            current_bounty=True
+        )
+        bounty_fulfillment = BountyFulfillment.objects.create(


Can you remove the unused assignment of bounty_fulfillment here?

mbeacom · 2018-03-09T21:08:30Z

app/marketing/tests/management/commands/test_assemble_leaderboards.py

+        assert assemble_leaderboards.ranks['monthly_all']['fred'] == 3
+        assert assemble_leaderboards.ranks['yearly_all']['fred'] == 3
+
+        assert len(assemble_leaderboards.ranks['weekly_fulfilled']) == 0


Opposed to len(), can you use either assert any(dict) is False or assert not dict

done,
buy why you don't like len()?

mbeacom · 2018-03-09T21:28:20Z

app/marketing/tests/management/commands/test_sync_keywords.py

+            bounty=bounty
+        )
+
+        bounty_fulfillment = BountyFulfillment.objects.create(


Can you remove the unused assignment here?

mbeacom · 2018-03-09T21:29:05Z

app/marketing/tests/management/commands/test_sync_keywords.py

+class TestSyncKeywords(TestCase):
+    """Define tests for sync keywords."""
+
+    def setUp(test):


Can you switch this to def setUp(self): ?

mbeacom · 2018-03-09T21:29:41Z

app/marketing/tests/test_marketing_utils.py

+    def test_get_stat(self):
+        """Test the marketing util get_stat method."""
+        assert get_stat('mykey') == 2
+


Can you add another new line between these?

you want to separate the classes by 2 lines, right?

Yes @leonprou - Two new lines between module level classes and methods.

import thing class Example: """Some docstring.""" def test(self): """Some test.""" return 'test' def test_again(self): """Some test again.""" return 'test again' class ExampleAgain: """Some docstring again.""" def test(self): """Some test.""" return 'test' def some_test(): """Some test.""" return 'some test'

mbeacom · 2018-03-09T21:30:30Z

app/marketing/tests/test_marketing_utils.py

+
+    def test_should_suppress_notification_email(self):
+        """Test the marketing util test_should_suppress_notification_email method."""
+        assert should_suppress_notification_email('emailSubscriber1@gitcoin.co') == False


Can you change these boolean assertions to assert func() is False and assert func() is True or assert func() and assert not func()

sure, thanks 👍

mbeacom · 2018-03-09T21:33:14Z

app/marketing/tests/test_marketing_utils.py

+    def test_save_get_or_save_email_subscriber_get(self):
+        """Test the marketing util get_or_save_email_subscriber method."""
+        self.assertIsNotNone(get_or_save_email_subscriber('newemail@gitcoin.co',
+            'mysource', send_slack_invite=False))


Can you carry this indent over to hang below (get_or_save?

never use how to indent it right, but I fixed and flake is not complaining

mbeacom · 2018-03-09T21:34:04Z

Overall, lgtm - Just a few miscellaneous syntax changes. Thanks for the contribution @leonprou !

leonprou

Thanks, I think I made all the changes, also ran flake myself on all tests files

leonprou · 2018-03-10T11:19:14Z

app/marketing/tests/test_marketing_utils.py

+
+    def test_should_suppress_notification_email(self):
+        """Test the marketing util test_should_suppress_notification_email method."""
+        assert should_suppress_notification_email('emailSubscriber1@gitcoin.co') == False


sure, thanks 👍

leonprou · 2018-03-10T11:20:34Z

app/marketing/tests/test_marketing_utils.py

+        """Test the marketing util get_or_save_email_subscriber method."""
+        assert get_or_save_email_subscriber('emailSubscriber1@gitcoin.co', 'mysource') == 'priv1'
+
+        emailSubscriber1SecondSource = EmailSubscriber.objects.create(


actually it's unused variable)

leonprou · 2018-03-10T11:22:22Z

app/marketing/tests/test_marketing_utils.py

+    def test_save_get_or_save_email_subscriber_get(self):
+        """Test the marketing util get_or_save_email_subscriber method."""
+        self.assertIsNotNone(get_or_save_email_subscriber('newemail@gitcoin.co',
+            'mysource', send_slack_invite=False))


never use how to indent it right, but I fixed and flake is not complaining

leonprou · 2018-03-10T16:24:20Z

app/marketing/tests/management/commands/test_assemble_leaderboards.py

+        assert assemble_leaderboards.ranks['monthly_all']['fred'] == 3
+        assert assemble_leaderboards.ranks['yearly_all']['fred'] == 3
+
+        assert len(assemble_leaderboards.ranks['weekly_fulfilled']) == 0


done,
buy why you don't like len()?

leonprou · 2018-03-10T17:20:43Z

app/marketing/tests/management/commands/test_send_subscription_mails.py

+    """Define tests for roundup send subscription mails."""
+
+    def test_handle(self):
+        """Test command send subscription mails."""


thanks, forgot to test that one 👍

owocki · 2018-03-12T15:05:54Z

lets get this shipped this week!

mbeacom

lgtm

Thanks for the contribution and updates @leonprou !

leonprou force-pushed the increase_code_coverage branch from d0b2f62 to de2cf45 Compare March 5, 2018 20:02

owocki added a commit that referenced this pull request Mar 5, 2018

fix for #524 (comment)

9c82c4f

mbeacom changed the title ~~writing coverage for marketing model, increasing coverage to 33%~~ WIP: writing coverage for marketing model, increasing coverage to 33% Mar 6, 2018

mbeacom added wip backend This needs backend expertise. labels Mar 6, 2018

leonprou force-pushed the increase_code_coverage branch from de2cf45 to 9801ad6 Compare March 6, 2018 22:43

leonprou closed this Mar 7, 2018

leonprou reopened this Mar 7, 2018

leonprou force-pushed the increase_code_coverage branch 2 times, most recently from 9165fc0 to 79623c6 Compare March 9, 2018 14:03

mbeacom added the waiting on contributor label Mar 9, 2018

mbeacom added needs-testing and removed waiting on contributor labels Mar 9, 2018

mbeacom changed the title ~~WIP: writing coverage for marketing model, increasing coverage to 33%~~ Writing coverage for marketing model, increasing coverage to 33% Mar 9, 2018

mbeacom suggested changes Mar 9, 2018

View reviewed changes

mbeacom added waiting on contributor and removed needs review labels Mar 9, 2018

writing coverage for marketing model, increasing coverage to 33%

db889b3

leonprou force-pushed the increase_code_coverage branch from 79623c6 to db889b3 Compare March 10, 2018 17:24

leonprou commented Mar 10, 2018

View reviewed changes

Merge branch 'master' into increase_code_coverage

63b2cbd

mbeacom added needs review and removed waiting on contributor labels Mar 12, 2018

mbeacom approved these changes Mar 12, 2018

View reviewed changes

mbeacom added mergeable and removed needs review labels Mar 12, 2018

mbeacom merged commit 7c467aa into gitcoinco:master Mar 12, 2018

Writing coverage for marketing model, increasing coverage to 33% #524

Writing coverage for marketing model, increasing coverage to 33% #524

Conversation

leonprou commented Mar 4, 2018 • edited Loading

Description

Checklist

Affected core subsystem(s)

Testing

Refers/Fixes

leonprou commented Mar 5, 2018

leonprou commented Mar 5, 2018

owocki commented Mar 5, 2018

owocki commented Mar 5, 2018

owocki commented Mar 5, 2018

leonprou commented Mar 6, 2018

owocki commented Mar 6, 2018 • edited Loading

leonprou commented Mar 6, 2018 via email

codecov bot commented Mar 6, 2018 • edited Loading

Codecov Report

owocki commented Mar 7, 2018

leonprou commented Mar 7, 2018

mbeacom commented Mar 7, 2018

owocki commented Mar 7, 2018

mbeacom commented Mar 7, 2018

owocki commented Mar 7, 2018

mbeacom commented Mar 9, 2018

leonprou commented Mar 9, 2018 via email

mbeacom commented Mar 9, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mbeacom commented Mar 9, 2018 • edited Loading

leonprou left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

owocki commented Mar 12, 2018

mbeacom left a comment

Choose a reason for hiding this comment

leonprou commented Mar 4, 2018 •

edited

Loading

owocki commented Mar 6, 2018 •

edited

Loading

codecov bot commented Mar 6, 2018 •

edited

Loading

mbeacom commented Mar 9, 2018 •

edited

Loading