~launchpad-pqm/launchpad/devel

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
# Copyright 2009 Canonical Ltd.  This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).

"""Tests for Branch-related mailings"""

from unittest import TestLoader

from zope.security.proxy import removeSecurityProxy

from canonical.testing.layers import DatabaseFunctionalLayer
from lp.code.enums import (
    BranchSubscriptionDiffSize,
    BranchSubscriptionNotificationLevel,
    CodeReviewNotificationLevel,
    )
from lp.code.mail.branch import (
    BranchMailer,
    RecipientReason,
    )
from lp.code.model.branch import Branch
from lp.testing import (
    login_person,
    TestCaseWithFactory,
    )


class TestRecipientReason(TestCaseWithFactory):
    """Test the RecipientReason class."""

    layer = DatabaseFunctionalLayer

    def setUp(self):
        # Need to set target_branch.date_last_modified.
        TestCaseWithFactory.setUp(self, user='test@canonical.com')

    def makeProposalWithSubscription(self, subscriber=None):
        """Test fixture."""
        if subscriber is None:
            subscriber = self.factory.makePerson()
        source_branch = self.factory.makeProductBranch(title='foo')
        target_branch = self.factory.makeProductBranch(
            product=source_branch.product, title='bar')
        merge_proposal = source_branch.addLandingTarget(
            source_branch.owner, target_branch)
        subscription = merge_proposal.source_branch.subscribe(
            subscriber, BranchSubscriptionNotificationLevel.NOEMAIL, None,
            CodeReviewNotificationLevel.FULL, subscriber)
        return merge_proposal, subscription

    def test_forBranchSubscriber(self):
        """Test values when created from a branch subscription."""
        merge_proposal, subscription = self.makeProposalWithSubscription()
        subscriber = subscription.person
        reason = RecipientReason.forBranchSubscriber(
            subscription, subscriber, '', merge_proposal)
        self.assertEqual(subscriber, reason.subscriber)
        self.assertEqual(subscriber, reason.recipient)
        self.assertEqual(merge_proposal.source_branch, reason.branch)

    def makeReviewerAndSubscriber(self):
        """Return a tuple of vote_reference, subscriber."""
        merge_proposal, subscription = self.makeProposalWithSubscription()
        subscriber = subscription.person
        login_person(merge_proposal.registrant)
        vote_reference = merge_proposal.nominateReviewer(
            subscriber, subscriber)
        return merge_proposal, vote_reference, subscriber

    def test_forReviewer(self):
        """Test values when created from a branch subscription."""
        merge_proposal, vote_reference, subscriber = (
            self.makeReviewerAndSubscriber())
        pending_review = vote_reference.comment is None
        reason = RecipientReason.forReviewer(
            merge_proposal, pending_review, subscriber)
        self.assertEqual(subscriber, reason.subscriber)
        self.assertEqual(subscriber, reason.recipient)
        self.assertEqual(
            vote_reference.branch_merge_proposal.source_branch, reason.branch)

    def test_forReview_individual_pending(self):
        bmp = self.factory.makeBranchMergeProposal()
        reviewer = self.factory.makePerson(name='eric')
        reason = RecipientReason.forReviewer(bmp, True, reviewer)
        self.assertEqual('Reviewer', reason.mail_header)
        self.assertEqual(
            'You are requested to review the proposed merge of %s into %s.'
            % (bmp.source_branch.bzr_identity,
               bmp.target_branch.bzr_identity),
            reason.getReason())

    def test_forReview_individual_in_progress(self):
        bmp = self.factory.makeBranchMergeProposal()
        reviewer = self.factory.makePerson(name='eric')
        reason = RecipientReason.forReviewer(bmp, False, reviewer)
        self.assertEqual('Reviewer', reason.mail_header)
        self.assertEqual(
            'You are reviewing the proposed merge of %s into %s.'
            % (bmp.source_branch.bzr_identity,
               bmp.target_branch.bzr_identity),
            reason.getReason())

    def test_forReview_team_pending(self):
        bmp = self.factory.makeBranchMergeProposal()
        reviewer = self.factory.makeTeam(name='vikings')
        reason = RecipientReason.forReviewer(bmp, True, reviewer)
        self.assertEqual('Reviewer @vikings', reason.mail_header)
        self.assertEqual(
            'Your team Vikings is requested to review the proposed merge'
            ' of %s into %s.'
            % (bmp.source_branch.bzr_identity,
               bmp.target_branch.bzr_identity),
            reason.getReason())

    def test_getReasonPerson(self):
        """Ensure the correct reason is generated for individuals."""
        merge_proposal, subscription = self.makeProposalWithSubscription()
        reason = RecipientReason.forBranchSubscriber(
            subscription, subscription.person, '', merge_proposal)
        self.assertEqual(
            'You are subscribed to branch %s.'
            % merge_proposal.source_branch.bzr_identity, reason.getReason())

    def test_getReasonTeam(self):
        """Ensure the correct reason is generated for teams."""
        team_member = self.factory.makePerson(
            displayname='Foo Bar', email='foo@bar.com')
        team = self.factory.makeTeam(team_member, displayname='Qux')
        bmp, subscription = self.makeProposalWithSubscription(team)
        reason = RecipientReason.forBranchSubscriber(
            subscription, team_member, '', bmp)
        self.assertEqual(
            'Your team Qux is subscribed to branch %s.'
            % bmp.source_branch.bzr_identity, reason.getReason())

    def test_usesBranchIdentityCache(self):
        """Ensure that the cache is used for branches if provided."""
        branch = self.factory.makeAnyBranch()
        subscription = branch.getSubscription(branch.owner)
        branch_cache = {branch: 'lp://fake'}

        def blowup(self):
            raise AssertionError('boom')
        patched = Branch.bzr_identity
        Branch.bzr_identity = property(blowup)

        def cleanup():
            Branch.bzr_identity = patched
        self.addCleanup(cleanup)
        self.assertRaises(AssertionError, getattr, branch, 'bzr_identity')
        reason = RecipientReason.forBranchSubscriber(
            subscription, subscription.person, '',
            branch_identity_cache=branch_cache)
        self.assertEqual(
            'You are subscribed to branch lp://fake.',
            reason.getReason())


class TestBranchMailerHeaders(TestCaseWithFactory):
    """Check the headers are correct for Branch email."""

    layer = DatabaseFunctionalLayer

    def test_branch_modified(self):
        # Test the email headers for a branch modified email.
        bob = self.factory.makePerson(email='bob@example.com')
        branch = self.factory.makeProductBranch(owner=bob)
        branch.getSubscription(bob).notification_level = (
            BranchSubscriptionNotificationLevel.FULL)
        mailer = BranchMailer.forBranchModified(branch, branch.owner, None)
        mailer.message_id = '<foobar-example-com>'
        ctrl = mailer.generateEmail('bob@example.com', branch.owner)
        self.assertEqual(
            {'X-Launchpad-Branch': branch.unique_name,
             'X-Launchpad-Message-Rationale': 'Subscriber',
             'X-Launchpad-Notification-Type': 'branch-updated',
             'X-Launchpad-Project': branch.product.name,
             'Message-Id': '<foobar-example-com>'},
            ctrl.headers)

    def test_branch_revision(self):
        # Test the email headers for new revision email.
        bob = self.factory.makePerson(email='bob@example.com')
        branch = self.factory.makeProductBranch(owner=bob)
        branch.getSubscription(bob).notification_level = (
            BranchSubscriptionNotificationLevel.FULL)
        mailer = BranchMailer.forRevision(
            branch, 1, 'from@example.com', contents='', diff=None, subject='')
        mailer.message_id = '<foobar-example-com>'
        ctrl = mailer.generateEmail('bob@example.com', branch.owner)
        self.assertEqual(
            {'X-Launchpad-Branch': branch.unique_name,
             'X-Launchpad-Message-Rationale': 'Subscriber',
             'X-Launchpad-Notification-Type': 'branch-revision',
             'X-Launchpad-Branch-Revision-Number': '1',
             'X-Launchpad-Project': branch.product.name,
             'Message-Id': '<foobar-example-com>'},
            ctrl.headers)


class TestBranchMailerDiff(TestCaseWithFactory):
    """Check the diff is an attachment for Branch email."""

    layer = DatabaseFunctionalLayer

    def makeBobMailController(self, diff=None,
                              max_lines=BranchSubscriptionDiffSize.WHOLEDIFF):
        bob = self.factory.makePerson(email='bob@example.com')
        branch = self.factory.makeProductBranch(owner=bob)
        subscription = branch.getSubscription(bob)
        subscription.max_diff_lines = max_lines
        subscription.notification_level = (
            BranchSubscriptionNotificationLevel.FULL)
        mailer = BranchMailer.forRevision(
            branch, 1, 'from@example.com', contents='', diff=diff, subject='')
        return mailer.generateEmail('bob@example.com', branch.owner)

    def test_generateEmail_with_no_diff(self):
        """When there is no diff, no attachment should be included."""
        ctrl = self.makeBobMailController()
        self.assertEqual([], ctrl.attachments)
        self.assertNotIn('larger than your specified limit', ctrl.body)

    def test_generateEmail_with_diff(self):
        """When there is a diff, it should be an attachment, not inline."""
        ctrl = self.makeBobMailController(diff='hello')
        self.assertEqual(1, len(ctrl.attachments))
        diff = ctrl.attachments[0]
        self.assertEqual('hello', diff.get_payload(decode=True))
        self.assertEqual('text/x-diff', diff['Content-type'])
        self.assertEqual('inline; filename="revision-diff.txt"',
                         diff['Content-disposition'])
        self.assertNotIn('hello', ctrl.body)
        self.assertNotIn('larger than your specified limit', ctrl.body)

    def test_generateEmail_with_oversize_diff(self):
        """When the diff is oversize, don't attach, add reason."""
        ctrl = self.makeBobMailController(diff='hello\n' * 5000,
            max_lines=BranchSubscriptionDiffSize.FIVEKLINES)
        self.assertEqual([], ctrl.attachments)
        self.assertIn('The size of the diff (5001 lines) is larger than your'
            ' specified limit of 5000 lines', ctrl.body)

    def test_generateEmail_with_subscription_no_diff(self):
        """When subscription forbids diffs, don't add reason."""
        ctrl = self.makeBobMailController(diff='hello\n',
            max_lines=BranchSubscriptionDiffSize.NODIFF)
        self.assertEqual([], ctrl.attachments)
        self.assertNotIn('larger than your specified limit', ctrl.body)


class TestBranchMailerSubject(TestCaseWithFactory):
    """The subject for a BranchMailer is returned verbatim."""

    layer = DatabaseFunctionalLayer

    def test_subject(self):
        # No string interpolation should occur on the subject.
        branch = self.factory.makeAnyBranch()
        # Subscribe the owner to get revision email.
        branch.getSubscription(branch.owner).notification_level = (
            BranchSubscriptionNotificationLevel.FULL)
        mailer = BranchMailer.forRevision(
            branch, 1, 'test@example.com', 'content', 'diff',
            'Testing %j foo')
        branch_owner_email = removeSecurityProxy(
            branch.owner).preferredemail.email
        self.assertEqual('Testing %j foo', mailer._getSubject(
                branch_owner_email, branch.owner))


def test_suite():
    return TestLoader().loadTestsFromName(__name__)