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
|
# -*- coding: utf-8 -*-
# Copyright 2012 OpenStack Foundation
# Copyright 2013 IBM Corp.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import ldappool
import mock
from oslo_config import cfg
from oslotest import mockpatch
from keystone.common.ldap import core as ldap_core
from keystone.identity.backends import ldap
from keystone.tests import unit as tests
from keystone.tests.unit import fakeldap
from keystone.tests.unit import test_backend_ldap
CONF = cfg.CONF
class LdapPoolCommonTestMixin(object):
"""LDAP pool specific common tests used here and in live tests."""
def cleanup_pools(self):
ldap_core.PooledLDAPHandler.connection_pools.clear()
def test_handler_with_use_pool_enabled(self):
# by default use_pool and use_auth_pool is enabled in test pool config
user_ref = self.identity_api.get_user(self.user_foo['id'])
self.user_foo.pop('password')
self.assertDictEqual(user_ref, self.user_foo)
handler = ldap_core._get_connection(CONF.ldap.url, use_pool=True)
self.assertIsInstance(handler, ldap_core.PooledLDAPHandler)
@mock.patch.object(ldap_core.KeystoneLDAPHandler, 'connect')
@mock.patch.object(ldap_core.KeystoneLDAPHandler, 'simple_bind_s')
def test_handler_with_use_pool_not_enabled(self, bind_method,
connect_method):
self.config_fixture.config(group='ldap', use_pool=False)
self.config_fixture.config(group='ldap', use_auth_pool=True)
self.cleanup_pools()
user_api = ldap.UserApi(CONF)
handler = user_api.get_connection(user=None, password=None,
end_user_auth=True)
# use_auth_pool flag does not matter when use_pool is False
# still handler is non pool version
self.assertIsInstance(handler.conn, ldap_core.PythonLDAPHandler)
@mock.patch.object(ldap_core.KeystoneLDAPHandler, 'connect')
@mock.patch.object(ldap_core.KeystoneLDAPHandler, 'simple_bind_s')
def test_handler_with_end_user_auth_use_pool_not_enabled(self, bind_method,
connect_method):
# by default use_pool is enabled in test pool config
# now disabling use_auth_pool flag to test handler instance
self.config_fixture.config(group='ldap', use_auth_pool=False)
self.cleanup_pools()
user_api = ldap.UserApi(CONF)
handler = user_api.get_connection(user=None, password=None,
end_user_auth=True)
self.assertIsInstance(handler.conn, ldap_core.PythonLDAPHandler)
# For end_user_auth case, flag should not be false otherwise
# it will use, admin connections ldap pool
handler = user_api.get_connection(user=None, password=None,
end_user_auth=False)
self.assertIsInstance(handler.conn, ldap_core.PooledLDAPHandler)
def test_pool_size_set(self):
# get related connection manager instance
ldappool_cm = self.conn_pools[CONF.ldap.url]
self.assertEqual(CONF.ldap.pool_size, ldappool_cm.size)
def test_pool_retry_max_set(self):
# get related connection manager instance
ldappool_cm = self.conn_pools[CONF.ldap.url]
self.assertEqual(CONF.ldap.pool_retry_max, ldappool_cm.retry_max)
def test_pool_retry_delay_set(self):
# just make one identity call to initiate ldap connection if not there
self.identity_api.get_user(self.user_foo['id'])
# get related connection manager instance
ldappool_cm = self.conn_pools[CONF.ldap.url]
self.assertEqual(CONF.ldap.pool_retry_delay, ldappool_cm.retry_delay)
def test_pool_use_tls_set(self):
# get related connection manager instance
ldappool_cm = self.conn_pools[CONF.ldap.url]
self.assertEqual(CONF.ldap.use_tls, ldappool_cm.use_tls)
def test_pool_timeout_set(self):
# get related connection manager instance
ldappool_cm = self.conn_pools[CONF.ldap.url]
self.assertEqual(CONF.ldap.pool_connection_timeout,
ldappool_cm.timeout)
def test_pool_use_pool_set(self):
# get related connection manager instance
ldappool_cm = self.conn_pools[CONF.ldap.url]
self.assertEqual(CONF.ldap.use_pool, ldappool_cm.use_pool)
def test_pool_connection_lifetime_set(self):
# get related connection manager instance
ldappool_cm = self.conn_pools[CONF.ldap.url]
self.assertEqual(CONF.ldap.pool_connection_lifetime,
ldappool_cm.max_lifetime)
def test_max_connection_error_raised(self):
who = CONF.ldap.user
cred = CONF.ldap.password
# get related connection manager instance
ldappool_cm = self.conn_pools[CONF.ldap.url]
ldappool_cm.size = 2
# 3rd connection attempt should raise Max connection error
with ldappool_cm.connection(who, cred) as _: # conn1
with ldappool_cm.connection(who, cred) as _: # conn2
try:
with ldappool_cm.connection(who, cred) as _: # conn3
_.unbind_s()
self.fail()
except Exception as ex:
self.assertIsInstance(ex,
ldappool.MaxConnectionReachedError)
ldappool_cm.size = CONF.ldap.pool_size
def test_pool_size_expands_correctly(self):
who = CONF.ldap.user
cred = CONF.ldap.password
# get related connection manager instance
ldappool_cm = self.conn_pools[CONF.ldap.url]
ldappool_cm.size = 3
def _get_conn():
return ldappool_cm.connection(who, cred)
# Open 3 connections first
with _get_conn() as _: # conn1
self.assertEqual(len(ldappool_cm), 1)
with _get_conn() as _: # conn2
self.assertEqual(len(ldappool_cm), 2)
with _get_conn() as _: # conn2
_.unbind_ext_s()
self.assertEqual(len(ldappool_cm), 3)
# Then open 3 connections again and make sure size does not grow
# over 3
with _get_conn() as _: # conn1
self.assertEqual(len(ldappool_cm), 1)
with _get_conn() as _: # conn2
self.assertEqual(len(ldappool_cm), 2)
with _get_conn() as _: # conn3
_.unbind_ext_s()
self.assertEqual(len(ldappool_cm), 3)
def test_password_change_with_pool(self):
old_password = self.user_sna['password']
self.cleanup_pools()
# authenticate so that connection is added to pool before password
# change
user_ref = self.identity_api.authenticate(
context={},
user_id=self.user_sna['id'],
password=self.user_sna['password'])
self.user_sna.pop('password')
self.user_sna['enabled'] = True
self.assertDictEqual(user_ref, self.user_sna)
new_password = 'new_password'
user_ref['password'] = new_password
self.identity_api.update_user(user_ref['id'], user_ref)
# now authenticate again to make sure new password works with
# conneciton pool
user_ref2 = self.identity_api.authenticate(
context={},
user_id=self.user_sna['id'],
password=new_password)
user_ref.pop('password')
self.assertDictEqual(user_ref, user_ref2)
# Authentication with old password would not work here as there
# is only one connection in pool which get bind again with updated
# password..so no old bind is maintained in this case.
self.assertRaises(AssertionError,
self.identity_api.authenticate,
context={},
user_id=self.user_sna['id'],
password=old_password)
class LdapIdentitySqlAssignment(LdapPoolCommonTestMixin,
test_backend_ldap.LdapIdentitySqlAssignment,
tests.TestCase):
'''Executes existing base class 150+ tests with pooled LDAP handler to make
sure it works without any error.
'''
def setUp(self):
self.useFixture(mockpatch.PatchObject(
ldap_core.PooledLDAPHandler, 'Connector', fakeldap.FakeLdapPool))
super(LdapIdentitySqlAssignment, self).setUp()
self.addCleanup(self.cleanup_pools)
# storing to local variable to avoid long references
self.conn_pools = ldap_core.PooledLDAPHandler.connection_pools
# super class loads db fixtures which establishes ldap connection
# so adding dummy call to highlight connection pool initialization
# as its not that obvious though its not needed here
self.identity_api.get_user(self.user_foo['id'])
def config_files(self):
config_files = super(LdapIdentitySqlAssignment, self).config_files()
config_files.append(tests.dirs.tests_conf('backend_ldap_pool.conf'))
return config_files
@mock.patch.object(ldap_core, 'utf8_encode')
def test_utf8_encoded_is_used_in_pool(self, mocked_method):
def side_effect(arg):
return arg
mocked_method.side_effect = side_effect
# invalidate the cache to get utf8_encode function called.
self.identity_api.get_user.invalidate(self.identity_api,
self.user_foo['id'])
self.identity_api.get_user(self.user_foo['id'])
mocked_method.assert_any_call(CONF.ldap.user)
mocked_method.assert_any_call(CONF.ldap.password)
|
