refactor db access
[matthijs/upstream/django-ldapdb.git] / examples / tests.py
1 # -*- coding: utf-8 -*-
2
3 # django-ldapdb
4 # Copyright (c) 2009-2010, Bolloré telecom
5 # All rights reserved.
6
7 # See AUTHORS file for a full list of contributors.
8
9 # Redistribution and use in source and binary forms, with or without modification,
10 # are permitted provided that the following conditions are met:
11
12 #     1. Redistributions of source code must retain the above copyright notice, 
13 #        this list of conditions and the following disclaimer.
14 #     
15 #     2. Redistributions in binary form must reproduce the above copyright 
16 #        notice, this list of conditions and the following disclaimer in the
17 #        documentation and/or other materials provided with the distribution.
18
19 #     3. Neither the name of Bolloré telecom nor the names of its contributors
20 #        may be used to endorse or promote products derived from this software
21 #        without specific prior written permission.
22
23 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
24 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26 # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
27 # ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
30 # ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #
34
35 from django.db import connections, router
36 from django.db.models import Q
37 from django.test import TestCase
38
39 import ldap
40 import ldapdb
41 from ldapdb.backends.ldap.compiler import query_as_ldap
42 from examples.models import LdapUser, LdapGroup
43       
44 class BaseTestCase(TestCase):
45     def setUp(self):
46         for model in [LdapGroup, LdapUser]:
47             using = router.db_for_write(model)
48             connection = connections[using]
49
50             rdn = model.base_dn.split(',')[0]
51             key, val = rdn.split('=')
52             attrs = [('objectClass', ['top', 'organizationalUnit']), (key, [val])]
53             try:
54                 connection.add_s(model.base_dn, attrs)
55             except ldap.ALREADY_EXISTS:
56                 pass
57
58     def tearDown(self):
59         for model in [LdapGroup, LdapUser]:
60             using = router.db_for_write(model)
61             connection = connections[using]
62
63             try:
64                 results = connection.search_s(model.base_dn, ldap.SCOPE_SUBTREE)
65                 for dn, attrs in reversed(results):
66                     connection.delete_s(dn)
67             except ldap.NO_SUCH_OBJECT:
68                 pass
69
70 class GroupTestCase(BaseTestCase):
71     def setUp(self):
72         super(GroupTestCase, self).setUp()
73
74         g = LdapGroup()
75         g.name = "foogroup"
76         g.gid = 1000
77         g.usernames = ['foouser', 'baruser']
78         g.save()
79
80         g = LdapGroup()
81         g.name = "bargroup"
82         g.gid = 1001
83         g.usernames = ['zoouser', 'baruser']
84         g.save()
85
86         g = LdapGroup()
87         g.name = "wizgroup"
88         g.gid = 1002
89         g.usernames = ['wizuser', 'baruser']
90         g.save()
91
92     def test_count(self):
93         # empty query
94         qs = LdapGroup.objects.none()
95         self.assertEquals(qs.count(), 0)
96
97         qs = LdapGroup.objects.none()
98         self.assertEquals(len(qs), 0)
99
100         # all query
101         qs = LdapGroup.objects.all()
102         self.assertEquals(qs.count(), 3)
103
104         qs = LdapGroup.objects.all()
105         self.assertEquals(len(qs), 3)
106
107     def test_ldap_filter(self):
108         # single filter
109         qs = LdapGroup.objects.filter(name='foogroup')
110         self.assertEquals(query_as_ldap(qs.query), '(&(objectClass=posixGroup)(cn=foogroup))')
111
112         qs = LdapGroup.objects.filter(Q(name='foogroup'))
113         self.assertEquals(query_as_ldap(qs.query), '(&(objectClass=posixGroup)(cn=foogroup))')
114
115         # AND filter
116         qs = LdapGroup.objects.filter(gid=1000, name='foogroup')
117         self.assertEquals(query_as_ldap(qs.query), '(&(objectClass=posixGroup)(&(gidNumber=1000)(cn=foogroup)))')
118
119         qs = LdapGroup.objects.filter(Q(gid=1000) & Q(name='foogroup'))
120         self.assertEquals(query_as_ldap(qs.query), '(&(objectClass=posixGroup)(&(gidNumber=1000)(cn=foogroup)))')
121
122         # OR filter
123         qs = LdapGroup.objects.filter(Q(gid=1000) | Q(name='foogroup'))
124         self.assertEquals(query_as_ldap(qs.query), '(&(objectClass=posixGroup)(|(gidNumber=1000)(cn=foogroup)))')
125
126         # single exclusion
127         qs = LdapGroup.objects.exclude(name='foogroup')
128         self.assertEquals(query_as_ldap(qs.query), '(&(objectClass=posixGroup)(!(cn=foogroup)))')
129         
130         qs = LdapGroup.objects.filter(~Q(name='foogroup'))
131         self.assertEquals(query_as_ldap(qs.query), '(&(objectClass=posixGroup)(!(cn=foogroup)))')
132
133         # multiple exclusion
134         qs = LdapGroup.objects.exclude(name='foogroup', gid=1000)
135         self.assertEquals(query_as_ldap(qs.query), '(&(objectClass=posixGroup)(!(&(gidNumber=1000)(cn=foogroup))))')
136
137         qs = LdapGroup.objects.filter(name='foogroup').exclude(gid=1000)
138         self.assertEquals(query_as_ldap(qs.query), '(&(objectClass=posixGroup)(&(cn=foogroup)(!(gidNumber=1000))))')
139
140     def test_filter(self):
141         qs = LdapGroup.objects.filter(name='foogroup')
142         self.assertEquals(qs.count(), 1)
143
144         qs = LdapGroup.objects.filter(name='foogroup')
145         self.assertEquals(len(qs), 1)
146
147         g = qs[0]
148         self.assertEquals(g.dn, 'cn=foogroup,%s' % LdapGroup.base_dn)
149         self.assertEquals(g.name, 'foogroup')
150         self.assertEquals(g.gid, 1000)
151         self.assertEquals(g.usernames, ['foouser', 'baruser'])
152
153         # try to filter non-existent entries
154         qs = LdapGroup.objects.filter(name='does_not_exist')
155         self.assertEquals(qs.count(), 0)
156
157         qs = LdapGroup.objects.filter(name='does_not_exist')
158         self.assertEquals(len(qs), 0)
159
160     def test_get(self):
161         g = LdapGroup.objects.get(name='foogroup')
162         self.assertEquals(g.dn, 'cn=foogroup,%s' % LdapGroup.base_dn)
163         self.assertEquals(g.name, 'foogroup')
164         self.assertEquals(g.gid, 1000)
165         self.assertEquals(g.usernames, ['foouser', 'baruser'])
166
167         # try to get a non-existent entry
168         self.assertRaises(LdapGroup.DoesNotExist, LdapGroup.objects.get, name='does_not_exist')
169
170     def test_order_by(self):
171         # ascending name 
172         qs = LdapGroup.objects.order_by('name')
173         self.assertEquals(len(qs), 3)
174         self.assertEquals(qs[0].name, 'bargroup')
175         self.assertEquals(qs[1].name, 'foogroup')
176         self.assertEquals(qs[2].name, 'wizgroup')
177
178         # descending name 
179         qs = LdapGroup.objects.order_by('-name')
180         self.assertEquals(len(qs), 3)
181         self.assertEquals(qs[0].name, 'wizgroup')
182         self.assertEquals(qs[1].name, 'foogroup')
183         self.assertEquals(qs[2].name, 'bargroup')
184
185         # ascending gid
186         qs = LdapGroup.objects.order_by('gid')
187         self.assertEquals(len(qs), 3)
188         self.assertEquals(qs[0].gid, 1000)
189         self.assertEquals(qs[1].gid, 1001)
190         self.assertEquals(qs[2].gid, 1002)
191
192         # descending gid
193         qs = LdapGroup.objects.order_by('-gid')
194         self.assertEquals(len(qs), 3)
195         self.assertEquals(qs[0].gid, 1002)
196         self.assertEquals(qs[1].gid, 1001)
197         self.assertEquals(qs[2].gid, 1000)
198
199     def test_bulk_delete(self):
200         LdapGroup.objects.all().delete()
201
202         qs = LdapGroup.objects.all()
203         self.assertEquals(len(qs), 0)
204
205     def test_slice(self):
206         qs = LdapGroup.objects.all()
207         objs = list(qs)
208         self.assertEquals(len(objs), 3)
209         self.assertEquals(objs[0].gid, 1000)
210         self.assertEquals(objs[1].gid, 1001)
211         self.assertEquals(objs[2].gid, 1002)
212
213         # limit only
214         qs = LdapGroup.objects.all()
215         objs = qs[:2]
216         self.assertEquals(objs.count(), 2)
217
218         objs = qs[:2]
219         self.assertEquals(len(objs), 2)
220         self.assertEquals(objs[0].gid, 1000)
221         self.assertEquals(objs[1].gid, 1001)
222
223         # offset only
224         qs = LdapGroup.objects.all()
225         objs = qs[1:]
226         self.assertEquals(objs.count(), 2)
227
228         objs = qs[1:]
229         self.assertEquals(len(objs), 2)
230         self.assertEquals(objs[0].gid, 1001)
231         self.assertEquals(objs[1].gid, 1002)
232
233         # offset and limit
234         qs = LdapGroup.objects.all()
235         objs = qs[1:2]
236         self.assertEquals(objs.count(), 1)
237
238         objs = qs[1:2]
239         self.assertEquals(len(objs), 1)
240         self.assertEquals(objs[0].gid, 1001)
241
242     def test_update(self):
243         g = LdapGroup.objects.get(name='foogroup')
244
245         g.gid = 1002
246         g.usernames = ['foouser2', 'baruser2']
247         g.save()
248
249         # make sure DN gets updated if we change the pk
250         g.name = 'foogroup2'
251         g.save()
252         self.assertEquals(g.dn, 'cn=foogroup2,%s' % LdapGroup.base_dn)
253
254     def test_values(self):
255         qs = LdapGroup.objects.values('name')
256         self.assertEquals(len(qs), 3)
257         self.assertEquals(qs[0], {'name': 'foogroup'})
258         self.assertEquals(qs[1], {'name': 'bargroup'})
259         self.assertEquals(qs[2], {'name': 'wizgroup'})
260
261     def test_values_list(self):
262         qs = LdapGroup.objects.values_list('name')
263         self.assertEquals(len(qs), 3)
264         self.assertEquals(qs[0], ('foogroup',))
265         self.assertEquals(qs[1], ('bargroup',))
266         self.assertEquals(qs[2], ('wizgroup',))
267
268     def test_delete(self):
269         g = LdapGroup.objects.get(name='foogroup')
270         g.delete()
271
272         qs = LdapGroup.objects.all()
273         self.assertEquals(len(qs), 2)
274
275 class UserTestCase(BaseTestCase):
276     def setUp(self):
277         super(UserTestCase, self).setUp()
278
279         u = LdapUser()
280         u.first_name = u"Fôo"
281         u.last_name = u"Usér"
282         u.full_name = u"Fôo Usér"
283
284         u.group = 1000
285         u.home_directory = "/home/foouser"
286         u.uid = 2000
287         u.username = "foouser"
288         u.photo = '\xff\xd8\xff\xe0\x00\x10JFIF\x00\x01\x01\x01\x00H\x00H\x00\x00\xff\xfe\x00\x1cCreated with GIMP on a Mac\xff\xdb\x00C\x00\x05\x03\x04\x04\x04\x03\x05\x04\x04\x04\x05\x05\x05\x06\x07\x0c\x08\x07\x07\x07\x07\x0f\x0b\x0b\t\x0c\x11\x0f\x12\x12\x11\x0f\x11\x11\x13\x16\x1c\x17\x13\x14\x1a\x15\x11\x11\x18!\x18\x1a\x1d\x1d\x1f\x1f\x1f\x13\x17"$"\x1e$\x1c\x1e\x1f\x1e\xff\xdb\x00C\x01\x05\x05\x05\x07\x06\x07\x0e\x08\x08\x0e\x1e\x14\x11\x14\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\xff\xc0\x00\x11\x08\x00\x08\x00\x08\x03\x01"\x00\x02\x11\x01\x03\x11\x01\xff\xc4\x00\x15\x00\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\xff\xc4\x00\x19\x10\x00\x03\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x02\x06\x11A\xff\xc4\x00\x14\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xff\xc4\x00\x14\x11\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xff\xda\x00\x0c\x03\x01\x00\x02\x11\x03\x11\x00?\x00\x9d\xf29wU5Q\xd6\xfd\x00\x01\xff\xd9'
289         u.save()
290
291     def test_get(self):
292         u = LdapUser.objects.get(username='foouser')
293         self.assertEquals(u.first_name, u'Fôo')
294         self.assertEquals(u.last_name, u'Usér')
295         self.assertEquals(u.full_name, u'Fôo Usér')
296
297         self.assertEquals(u.group, 1000)
298         self.assertEquals(u.home_directory, '/home/foouser')
299         self.assertEquals(u.uid, 2000)
300         self.assertEquals(u.username, 'foouser')
301         self.assertEquals(u.photo, '\xff\xd8\xff\xe0\x00\x10JFIF\x00\x01\x01\x01\x00H\x00H\x00\x00\xff\xfe\x00\x1cCreated with GIMP on a Mac\xff\xdb\x00C\x00\x05\x03\x04\x04\x04\x03\x05\x04\x04\x04\x05\x05\x05\x06\x07\x0c\x08\x07\x07\x07\x07\x0f\x0b\x0b\t\x0c\x11\x0f\x12\x12\x11\x0f\x11\x11\x13\x16\x1c\x17\x13\x14\x1a\x15\x11\x11\x18!\x18\x1a\x1d\x1d\x1f\x1f\x1f\x13\x17"$"\x1e$\x1c\x1e\x1f\x1e\xff\xdb\x00C\x01\x05\x05\x05\x07\x06\x07\x0e\x08\x08\x0e\x1e\x14\x11\x14\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\x1e\xff\xc0\x00\x11\x08\x00\x08\x00\x08\x03\x01"\x00\x02\x11\x01\x03\x11\x01\xff\xc4\x00\x15\x00\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\xff\xc4\x00\x19\x10\x00\x03\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x02\x06\x11A\xff\xc4\x00\x14\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xff\xc4\x00\x14\x11\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xff\xda\x00\x0c\x03\x01\x00\x02\x11\x03\x11\x00?\x00\x9d\xf29wU5Q\xd6\xfd\x00\x01\xff\xd9')
302
303         self.assertRaises(LdapUser.DoesNotExist, LdapUser.objects.get, username='does_not_exist')
304
305     def test_update(self):
306         u = LdapUser.objects.get(username='foouser')
307         u.first_name = u'Fôo2'
308         u.save()
309         
310         # make sure DN gets updated if we change the pk
311         u.username = 'foouser2'
312         u.save()
313         self.assertEquals(u.dn, 'uid=foouser2,%s' % LdapUser.base_dn)
314
315 class ScopedTestCase(BaseTestCase):
316     def setUp(self):
317         super(ScopedTestCase, self).setUp()
318
319         self.scoped_dn = "ou=contacts,%s" % LdapGroup.base_dn
320         attrs = [('objectClass', ['top', 'organizationalUnit']), ("ou", ["contacts"])]
321         ldapdb.connection.add_s(self.scoped_dn, attrs)
322
323     def test_scope(self):
324         ScopedGroup = LdapGroup.scoped(self.scoped_dn)
325
326         # create group
327         g = LdapGroup()
328         g.name = "foogroup"
329         g.gid = 1000
330         g.save()
331
332         qs = LdapGroup.objects.all()
333         self.assertEquals(qs.count(), 1)
334
335         qs = ScopedGroup.objects.all()
336         self.assertEquals(qs.count(), 0)
337
338         # create scoped group
339         g2 = ScopedGroup()
340         g2.name = "scopedgroup"
341         g2.gid = 5000
342         g2.save()
343
344         qs = LdapGroup.objects.all()
345         self.assertEquals(qs.count(), 2)
346
347         qs = ScopedGroup.objects.all()
348         self.assertEquals(qs.count(), 1)
349
350 class AdminTestCase(BaseTestCase):
351     fixtures = ['test_users.json']
352
353     def setUp(self):
354         super(AdminTestCase, self).setUp()
355
356         g = LdapGroup()
357         g.name = "foogroup"
358         g.gid = 1000
359         g.usernames = ['foouser', 'baruser']
360         g.save()
361
362         g = LdapGroup()
363         g.name = "bargroup"
364         g.gid = 1001
365         g.usernames = ['zoouser', 'baruser']
366         g.save()
367
368         u = LdapUser()
369         u.first_name = "Foo"
370         u.last_name = "User"
371         u.full_name = "Foo User"
372         u.group = 1000
373         u.home_directory = "/home/foouser"
374         u.uid = 2000
375         u.username = "foouser"
376         u.save()
377
378         u = LdapUser()
379         u.first_name = "Bar"
380         u.last_name = "User"
381         u.full_name = "Bar User"
382         u.group = 1001
383         u.home_directory = "/home/baruser"
384         u.uid = 2001
385         u.username = "baruser"
386         u.save()
387
388         self.client.login(username="test_user", password="password")
389
390     def test_index(self):
391         response = self.client.get('/admin/examples/')
392         self.assertContains(response, "Ldap groups")
393         self.assertContains(response, "Ldap users")
394
395     def test_group_list(self):
396         response = self.client.get('/admin/examples/ldapgroup/')
397         self.assertContains(response, "Ldap groups")
398         self.assertContains(response, "foogroup")
399         self.assertContains(response, "1000")
400
401         # order by name
402         response = self.client.get('/admin/examples/ldapgroup/?o=1')
403         self.assertContains(response, "Ldap groups")
404         self.assertContains(response, "foogroup")
405         self.assertContains(response, "1000")
406
407         # order by gid
408         response = self.client.get('/admin/examples/ldapgroup/?o=2')
409         self.assertContains(response, "Ldap groups")
410         self.assertContains(response, "foogroup")
411         self.assertContains(response, "1000")
412
413     def test_group_detail(self):
414         response = self.client.get('/admin/examples/ldapgroup/foogroup/')
415         self.assertContains(response, "foogroup")
416         self.assertContains(response, "1000")
417
418     def test_group_add(self):
419         response = self.client.post('/admin/examples/ldapgroup/add/', {'gid': '1002', 'name': 'wizgroup'})
420         self.assertRedirects(response, '/admin/examples/ldapgroup/')
421         qs = LdapGroup.objects.all()
422         self.assertEquals(qs.count(), 3)
423
424     def test_group_delete(self):
425         response = self.client.post('/admin/examples/ldapgroup/foogroup/delete/', {'yes': 'post'})
426         self.assertRedirects(response, '/admin/examples/ldapgroup/')
427         qs = LdapGroup.objects.all()
428         self.assertEquals(qs.count(), 1)
429
430     def test_group_search(self):
431         response = self.client.get('/admin/examples/ldapgroup/?q=foo')
432         self.assertContains(response, "Ldap groups")
433         self.assertContains(response, "foogroup")
434         self.assertContains(response, "1000")
435
436     def test_user_list(self):
437         response = self.client.get('/admin/examples/ldapuser/')
438         self.assertContains(response, "Ldap users")
439         self.assertContains(response, "foouser")
440         self.assertContains(response, "2000")
441
442         # order by username
443         response = self.client.get('/admin/examples/ldapuser/?o=1')
444         self.assertContains(response, "Ldap users")
445         self.assertContains(response, "foouser")
446         self.assertContains(response, "2000")
447
448         # order by uid
449         response = self.client.get('/admin/examples/ldapuser/?o=2')
450         self.assertContains(response, "Ldap users")
451         self.assertContains(response, "foouser")
452         self.assertContains(response, "2000")
453
454     def test_user_detail(self):
455         response = self.client.get('/admin/examples/ldapuser/foouser/')
456         self.assertContains(response, "foouser")
457         self.assertContains(response, "2000")
458
459     def test_user_delete(self):
460         response = self.client.post('/admin/examples/ldapuser/foouser/delete/', {'yes': 'post'})
461         self.assertRedirects(response, '/admin/examples/ldapuser/')
462