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
|
# Copyright 2009 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
"""Tests for the scanner's email generation."""
__metaclass__ = type
import email
import unittest
from zope.component import getUtility
from zope.event import notify
from canonical.testing.layers import LaunchpadZopelessLayer
from lp.code.enums import (
BranchSubscriptionDiffSize,
BranchSubscriptionNotificationLevel,
CodeReviewNotificationLevel,
)
from lp.code.interfaces.branchjob import (
IRevisionMailJobSource,
IRevisionsAddedJobSource,
)
from lp.code.model.branchjob import RevisionMailJob
from lp.codehosting.scanner import events
from lp.codehosting.scanner.tests.test_bzrsync import BzrSyncTestCase
from lp.registry.interfaces.person import IPersonSet
from lp.services.job.runner import JobRunner
from lp.services.mail import stub
from lp.testing import TestCaseWithFactory
class TestBzrSyncEmail(BzrSyncTestCase):
"""Tests BzrSync support for generating branch email notifications."""
def setUp(self):
BzrSyncTestCase.setUp(self)
stub.test_emails = []
def makeDatabaseBranch(self):
branch = BzrSyncTestCase.makeDatabaseBranch(self)
LaunchpadZopelessLayer.txn.begin()
test_user = getUtility(IPersonSet).getByEmail('test@canonical.com')
branch.subscribe(
test_user,
BranchSubscriptionNotificationLevel.FULL,
BranchSubscriptionDiffSize.FIVEKLINES,
CodeReviewNotificationLevel.NOEMAIL,
test_user)
LaunchpadZopelessLayer.txn.commit()
return branch
def assertTextIn(self, expected, text):
"""Assert that expected is in text.
Report expected and text in case of failure.
"""
self.failUnless(expected in text, '%r not in %r' % (expected, text))
def test_empty_branch(self):
self.makeBzrSync(self.db_branch).syncBranchAndClose()
JobRunner.fromReady(getUtility(IRevisionMailJobSource)).runAll()
self.assertEqual(len(stub.test_emails), 1)
[initial_email] = stub.test_emails
expected = 'First scan of the branch detected 0 revisions'
message = email.message_from_string(initial_email[2])
email_body = message.get_payload()
self.assertTextIn(expected, email_body)
self.assertEmailHeadersEqual(
'[Branch %s] 0 revisions' % self.db_branch.unique_name,
message['Subject'])
def test_import_revision(self):
self.commitRevision()
self.makeBzrSync(self.db_branch).syncBranchAndClose()
JobRunner.fromReady(getUtility(IRevisionMailJobSource)).runAll()
self.assertEqual(len(stub.test_emails), 1)
[initial_email] = stub.test_emails
expected = ('First scan of the branch detected 1 revision'
' in the revision history of the=\n branch.')
message = email.message_from_string(initial_email[2])
email_body = message.get_payload()
self.assertTextIn(expected, email_body)
self.assertEmailHeadersEqual(
'[Branch %s] 1 revision' % self.db_branch.unique_name,
message['Subject'])
def test_import_uncommit(self):
self.commitRevision()
self.makeBzrSync(self.db_branch).syncBranchAndClose()
JobRunner.fromReady(getUtility(IRevisionMailJobSource)).runAll()
stub.test_emails = []
self.uncommitRevision()
self.makeBzrSync(self.db_branch).syncBranchAndClose()
JobRunner.fromReady(getUtility(IRevisionMailJobSource)).runAll()
self.assertEqual(len(stub.test_emails), 1)
[uncommit_email] = stub.test_emails
expected = '1 revision was removed from the branch.'
message = email.message_from_string(uncommit_email[2])
email_body = message.get_payload()
self.assertTextIn(expected, email_body)
self.assertEmailHeadersEqual(
'[Branch %s] 1 revision removed' % self.db_branch.unique_name,
message['Subject'])
def test_import_recommit(self):
# When scanning the uncommit and new commit there should be an email
# generated saying that 1 (in this case) revision has been removed,
# and another email with the diff and log message.
self.commitRevision('first')
self.makeBzrSync(self.db_branch).syncBranchAndClose()
JobRunner.fromReady(getUtility(IRevisionMailJobSource)).runAll()
stub.test_emails = []
self.uncommitRevision()
self.writeToFile(filename="hello.txt",
contents="Hello World\n")
author = self.factory.getUniqueString()
self.commitRevision('second', committer=author)
self.makeBzrSync(self.db_branch).syncBranchAndClose()
JobRunner.fromReady(getUtility(IRevisionsAddedJobSource)).runAll()
JobRunner.fromReady(getUtility(IRevisionMailJobSource)).runAll()
self.assertEqual(len(stub.test_emails), 2)
[recommit_email, uncommit_email] = stub.test_emails
uncommit_email_body = uncommit_email[2]
expected = '1 revision was removed from the branch.'
self.assertTextIn(expected, uncommit_email_body)
subject = (
'Subject: [Branch %s] Test branch' % self.db_branch.unique_name)
self.assertTextIn(expected, uncommit_email_body)
recommit_email_msg = email.message_from_string(recommit_email[2])
recommit_email_body = recommit_email_msg.get_payload()[0].get_payload(
decode=True)
subject = '[Branch %s] Rev 1: second' % self.db_branch.unique_name
self.assertEmailHeadersEqual(subject, recommit_email_msg['Subject'])
body_bits = [
'revno: 1',
'committer: %s' % author,
'branch nick: %s' % self.bzr_branch.nick,
'message:\n second',
'added:\n hello.txt',
]
for bit in body_bits:
self.assertTextIn(bit, recommit_email_body)
class TestScanBranches(TestCaseWithFactory):
layer = LaunchpadZopelessLayer
def test_queue_tip_changed_email_jobs_subscribed(self):
"""A queue_tip_changed_email_jobs is run when TipChanged emitted."""
self.useBzrBranches(direct_database=True)
db_branch, tree = self.create_branch_and_tree()
db_branch.subscribe(
db_branch.registrant,
BranchSubscriptionNotificationLevel.FULL,
BranchSubscriptionDiffSize.WHOLEDIFF,
CodeReviewNotificationLevel.FULL,
db_branch.registrant)
self.assertEqual(0, len(list(RevisionMailJob.iterReady())))
notify(events.TipChanged(db_branch, tree.branch, True))
self.assertEqual(1, len(list(RevisionMailJob.iterReady())))
def test_send_removed_revision_emails_subscribed(self):
"""send_removed_revision_emails run when RevisionsRemoved emitted."""
self.useBzrBranches(direct_database=True)
db_branch, tree = self.create_branch_and_tree()
db_branch.subscribe(
db_branch.registrant,
BranchSubscriptionNotificationLevel.FULL,
BranchSubscriptionDiffSize.WHOLEDIFF,
CodeReviewNotificationLevel.FULL,
db_branch.registrant)
self.assertEqual(0, len(list(RevisionMailJob.iterReady())))
notify(events.RevisionsRemoved(db_branch, tree.branch, ['x']))
self.assertEqual(1, len(list(RevisionMailJob.iterReady())))
class TestBzrSyncNoEmail(BzrSyncTestCase):
"""Tests BzrSync support for not generating branch email notifications
when no one is interested.
"""
def setUp(self):
BzrSyncTestCase.setUp(self)
stub.test_emails = []
def assertNoPendingEmails(self):
jobs = list(getUtility(IRevisionMailJobSource).iterReady())
jobs.extend(getUtility(IRevisionsAddedJobSource).iterReady())
self.assertEqual([], jobs, "There should be no pending emails.")
def test_no_subscribers(self):
self.assertEqual(self.db_branch.subscribers.count(), 0,
"There should be no subscribers to the branch.")
def test_empty_branch(self):
bzrsync = self.makeBzrSync(self.db_branch)
bzrsync.syncBranchAndClose()
self.assertNoPendingEmails()
def test_import_revision(self):
self.commitRevision()
bzrsync = self.makeBzrSync(self.db_branch)
bzrsync.syncBranchAndClose()
self.assertNoPendingEmails()
def test_import_uncommit(self):
self.commitRevision()
bzrsync = self.makeBzrSync(self.db_branch)
bzrsync.syncBranchAndClose()
stub.test_emails = []
self.uncommitRevision()
bzrsync = self.makeBzrSync(self.db_branch)
bzrsync.syncBranchAndClose()
self.assertNoPendingEmails()
def test_import_recommit(self):
# No emails should have been generated.
self.commitRevision('first')
bzrsync = self.makeBzrSync(self.db_branch)
bzrsync.syncBranchAndClose()
stub.test_emails = []
self.uncommitRevision()
self.writeToFile(filename="hello.txt",
contents="Hello World\n")
self.commitRevision('second')
bzrsync = self.makeBzrSync(self.db_branch)
bzrsync.syncBranchAndClose()
self.assertNoPendingEmails()
def test_suite():
return unittest.TestLoader().loadTestsFromName(__name__)
|