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
|
# Copyright 2011 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
"""Test vocabulary adapters."""
__metaclass__ = type
from datetime import datetime
from urllib import urlencode
import pytz
import simplejson
from zope.app.form.interfaces import MissingInputError
from zope.component import (
getSiteManager,
getUtility,
)
from zope.interface import implements
from zope.schema.interfaces import IVocabularyFactory
from zope.schema.vocabulary import SimpleTerm
from zope.security.proxy import removeSecurityProxy
from canonical.launchpad.interfaces.launchpad import ILaunchpadRoot
from canonical.launchpad.webapp.vocabulary import (
CountableIterator,
IHugeVocabulary,
)
from canonical.testing.layers import DatabaseFunctionalLayer
from lp.app.browser.vocabulary import (
IPickerEntry,
MAX_DESCRIPTION_LENGTH,
)
from lp.app.errors import UnexpectedFormData
from lp.registry.interfaces.irc import IIrcIDSet
from lp.services.features.testing import FeatureFixture
from lp.testing import (
login_person,
TestCaseWithFactory,
)
from lp.testing.views import create_view
class PersonPickerEntryAdapterTestCase(TestCaseWithFactory):
layer = DatabaseFunctionalLayer
def test_person_to_pickerentry(self):
# IPerson can be adpated to IPickerEntry.
person = self.factory.makePerson()
adapter = IPickerEntry(person)
self.assertTrue(IPickerEntry.providedBy(adapter))
def test_PersonPickerEntryAdapter_email_anonymous(self):
# Anonymous users cannot see entry email addresses.
person = self.factory.makePerson(email='snarf@eg.dom')
entry = IPickerEntry(person).getPickerEntry(None)
self.assertEqual('<email address hidden>', entry.description)
def test_PersonPickerEntryAdapter_visible_email_logged_in(self):
# Logged in users can see visible email addresses.
observer = self.factory.makePerson()
login_person(observer)
person = self.factory.makePerson(email='snarf@eg.dom')
entry = IPickerEntry(person).getPickerEntry(None)
self.assertEqual('snarf@eg.dom', entry.description)
def test_PersonPickerEntryAdapter_hidden_email_logged_in(self):
# Logged in users cannot see hidden email addresses.
person = self.factory.makePerson(email='snarf@eg.dom')
login_person(person)
person.hide_email_addresses = True
observer = self.factory.makePerson()
login_person(observer)
entry = IPickerEntry(person).getPickerEntry(None)
self.assertEqual('<email address hidden>', entry.description)
def test_PersonPickerEntryAdapter_no_email_logged_in(self):
# Teams without email address have no desriptions.
team = self.factory.makeTeam()
observer = self.factory.makePerson()
login_person(observer)
entry = IPickerEntry(team).getPickerEntry(None)
self.assertEqual(None, entry.description)
def test_PersonPickerEntryAdapter_logged_in(self):
# Logged in users can see visible email addresses.
observer = self.factory.makePerson()
login_person(observer)
person = self.factory.makePerson(
email='snarf@eg.dom', name='snarf')
entry = IPickerEntry(person).getPickerEntry(None)
self.assertEqual('sprite person', entry.css)
self.assertEqual('sprite new-window', entry.link_css)
def test_PersonPickerEntryAdapter_enhanced_picker_enabled_user(self):
# The enhanced person picker provides more information for users.
person = self.factory.makePerson(email='snarf@eg.dom', name='snarf')
creation_date = datetime(
2005, 01, 30, 0, 0, 0, 0, pytz.timezone('UTC'))
removeSecurityProxy(person).datecreated = creation_date
getUtility(IIrcIDSet).new(person, 'eg.dom', 'snarf')
getUtility(IIrcIDSet).new(person, 'ex.dom', 'pting')
entry = IPickerEntry(person).getPickerEntry(
None, enhanced_picker_enabled=True)
self.assertEqual('http://launchpad.dev/~snarf', entry.alt_title_link)
self.assertEqual(
['snarf on eg.dom, pting on ex.dom', 'Member since 2005-01-30'],
entry.details)
def test_PersonPickerEntryAdapter_enhanced_picker_enabled_team(self):
# The enhanced person picker provides more information for teams.
team = self.factory.makeTeam(email='fnord@eg.dom', name='fnord')
entry = IPickerEntry(team).getPickerEntry(
None, enhanced_picker_enabled=True)
self.assertEqual('http://launchpad.dev/~fnord', entry.alt_title_link)
self.assertEqual(['Team members: 1'], entry.details)
def test_PersonPickerEntryAdapter_enhanced_picker_enabled_badges(self):
# The enhanced person picker provides affilliation information.
person = self.factory.makePerson(email='snarf@eg.dom', name='snarf')
project = self.factory.makeProduct(name='fnord', owner=person)
bugtask = self.factory.makeBugTask(target=project)
entry = IPickerEntry(person).getPickerEntry(
bugtask, enhanced_picker_enabled=True)
self.assertEqual(1, len(entry.badges))
self.assertEqual('/@@/product-badge', entry.badges[0]['url'])
self.assertEqual('Affiliated with Fnord', entry.badges[0]['alt'])
class TestPersonVocabulary:
implements(IHugeVocabulary)
test_persons = []
@classmethod
def setTestData(cls, person_list):
cls.test_persons = person_list
def __init__(self, context):
self.context = context
def toTerm(self, person):
return SimpleTerm(person, person.name, person.displayname)
def searchForTerms(self, query=None):
found = [
person for person in self.test_persons if query in person.name]
return CountableIterator(len(found), found, self.toTerm)
class HugeVocabularyJSONViewTestCase(TestCaseWithFactory):
layer = DatabaseFunctionalLayer
def setUp(self):
super(HugeVocabularyJSONViewTestCase, self).setUp()
test_persons = []
for name in range(1, 7):
test_persons.append(
self.factory.makePerson(name='pting-%s' % name))
TestPersonVocabulary.setTestData(test_persons)
getSiteManager().registerUtility(
TestPersonVocabulary, IVocabularyFactory, 'TestPerson')
self.addCleanup(
getSiteManager().unregisterUtility,
TestPersonVocabulary, IVocabularyFactory, 'TestPerson')
self.addCleanup(TestPersonVocabulary.setTestData, [])
@staticmethod
def create_vocabulary_view(form):
context = getUtility(ILaunchpadRoot)
query_string = urlencode(form)
return create_view(
context, '+huge-vocabulary', form=form, query_string=query_string)
def test_name_field_missing_error(self):
view = self.create_vocabulary_view({})
self.assertRaisesWithContent(
MissingInputError, "('name', '', None)", view.__call__)
def test_search_text_field_missing_error(self):
view = self.create_vocabulary_view({'name': 'TestPerson'})
self.assertRaisesWithContent(
MissingInputError, "('search_text', '', None)", view.__call__)
def test_vocabulary_name_unknown_error(self):
form = dict(name='snarf', search_text='pting')
view = self.create_vocabulary_view(form)
self.assertRaisesWithContent(
UnexpectedFormData, "Unknown vocabulary 'snarf'", view.__call__)
def test_json_entries(self):
# The results are JSON encoded.
feature_flag = {'disclosure.picker_enhancements.enabled': 'on'}
flags = FeatureFixture(feature_flag)
flags.setUp()
self.addCleanup(flags.cleanUp)
team = self.factory.makeTeam(name='pting-team')
TestPersonVocabulary.test_persons.append(team)
form = dict(name='TestPerson', search_text='pting-team')
view = self.create_vocabulary_view(form)
result = simplejson.loads(view())
expected = {
"alt_title": team.name,
"alt_title_link": "http://launchpad.dev/~%s" % team.name,
"api_uri": "/~%s" % team.name,
"css": "sprite team",
"details": ['Team members: 1'],
"link_css": "sprite new-window",
"metadata": "team",
"title": team.displayname,
"value": team.name
}
self.assertTrue('entries' in result)
self.assertContentEqual(
expected.items(), result['entries'][0].items())
def test_max_description_size(self):
# Descriptions over 120 characters are truncated and ellipsised.
email = 'pting-' * 19 + '@example.dom'
person = self.factory.makePerson(name='pting-n', email=email)
TestPersonVocabulary.test_persons.append(person)
# Login to gain permission to know the email address that used
# for the description
login_person(person)
form = dict(name='TestPerson', search_text='pting-n')
view = self.create_vocabulary_view(form)
result = simplejson.loads(view())
expected = (email[:MAX_DESCRIPTION_LENGTH - 3] + '...')
self.assertEqual(
'pting-n', result['entries'][0]['value'])
self.assertEqual(
expected, result['entries'][0]['description'])
def test_default_batch_size(self):
# The results are batched.
form = dict(name='TestPerson', search_text='pting')
view = self.create_vocabulary_view(form)
result = simplejson.loads(view())
total_size = result['total_size']
entries = len(result['entries'])
self.assertTrue(
total_size > entries,
'total_size: %d is less than entries: %d' % (total_size, entries))
def test_batch_size(self):
# A The batch size can be specified with the batch param.
form = dict(
name='TestPerson', search_text='pting',
start='0', batch='1')
view = self.create_vocabulary_view(form)
result = simplejson.loads(view())
self.assertEqual(6, result['total_size'])
self.assertEqual(1, len(result['entries']))
def test_start_offset(self):
# The offset of the batch is specified with the start param.
form = dict(
name='TestPerson', search_text='pting',
start='1', batch='1')
view = self.create_vocabulary_view(form)
result = simplejson.loads(view())
self.assertEqual(6, result['total_size'])
self.assertEqual(1, len(result['entries']))
self.assertEqual('pting-2', result['entries'][0]['value'])
|