2 # -*- coding: utf-8 -*-
3 from __future__ import print_function
7 sys.path.insert(0, 'bin/python')
11 import samba.getopt as options
18 from samba.netcmd.main import cmd_sambatool
20 # We try to use the test infrastructure of Samba 4.3+, but if it
21 # doesn't work, we are probably in a back-ported patch and trying to
22 # run on 4.1 or something.
24 # Don't copy this horror into ordinary tests -- it is special for
25 # performance tests that want to apply to old versions.
27 from samba.tests.subunitrun import SubunitOptions, TestProgram
31 samba.ensure_external_module("testtools", "testtools")
32 samba.ensure_external_module("subunit", "subunit/python")
33 from subunit.run import SubunitTestRunner
36 from samba.samdb import SamDB
37 from samba.auth import system_session
38 from ldb import Message, MessageElement, Dn, LdbError
39 from ldb import FLAG_MOD_ADD, FLAG_MOD_REPLACE, FLAG_MOD_DELETE
40 from ldb import SCOPE_BASE, SCOPE_SUBTREE, SCOPE_ONELEVEL
41 from ldb import ERR_NO_SUCH_OBJECT
43 parser = optparse.OptionParser("ad_dc_performance.py [options] <host>")
44 sambaopts = options.SambaOptions(parser)
45 parser.add_option_group(sambaopts)
46 parser.add_option_group(options.VersionOptions(parser))
49 subunitopts = SubunitOptions(parser)
50 parser.add_option_group(subunitopts)
52 # use command line creds if available
53 credopts = options.CredentialsOptions(parser)
54 parser.add_option_group(credopts)
55 opts, args = parser.parse_args()
64 lp = sambaopts.get_loadparm()
65 creds = credopts.get_credentials(lp)
70 class PerfTestException(Exception):
75 LINK_BATCH_SIZE = 1000
76 DELETE_BATCH_SIZE = 50
80 class GlobalState(object):
84 next_relinked_user = 0
85 next_linked_user_3 = 0
86 next_removed_link_0 = 0
90 class UserTests(samba.tests.TestCase):
92 def add_if_possible(self, *args, **kwargs):
93 """In these tests sometimes things are left in the database
94 deliberately, so we don't worry if we fail to add them a second
97 self.ldb.add(*args, **kwargs)
102 super(UserTests, self).setUp()
103 self.state = GlobalState # the class itself, not an instance
105 self.ldb = SamDB(host, credentials=creds,
106 session_info=system_session(lp), lp=lp)
107 self.base_dn = self.ldb.domain_dn()
108 self.ou = "OU=pid%s,%s" % (os.getpid(), self.base_dn)
109 self.ou_users = "OU=users,%s" % self.ou
110 self.ou_groups = "OU=groups,%s" % self.ou
111 self.ou_computers = "OU=computers,%s" % self.ou
113 self.state.test_number += 1
114 random.seed(self.state.test_number)
117 super(UserTests, self).tearDown()
119 def test_00_00_do_nothing(self):
120 # this gives us an idea of the overhead
123 def test_00_01_do_nothing_relevant(self):
124 # takes around 1 second on i7-4770
126 for i in range(30000000):
129 def test_00_02_do_nothing_sleepily(self):
132 def test_00_03_add_ous_and_groups(self):
133 # initialise the database
140 "objectclass": "organizationalUnit"
143 for i in range(N_GROUPS):
145 "dn": "cn=g%d,%s" % (i, self.ou_groups),
146 "objectclass": "group"
149 self.state.n_groups = N_GROUPS
151 def _add_users(self, start, end):
152 for i in range(start, end):
154 "dn": "cn=u%d,%s" % (i, self.ou_users),
155 "objectclass": "user"
158 def _add_users_ldif(self, start, end):
160 for i in range(start, end):
161 lines.append("dn: cn=u%d,%s" % (i, self.ou_users))
162 lines.append("objectclass: user")
164 self.ldb.add_ldif('\n'.join(lines))
166 def _test_join(self):
167 tmpdir = tempfile.mkdtemp()
169 server = host.split('://', 1)[1]
172 cmd = cmd_sambatool.subcommands['domain'].subcommands['join']
173 result = cmd._run("samba-tool domain join",
175 "dc", "-U%s%%%s" % (creds.get_username(),
176 creds.get_password()),
177 '--targetdir=%s' % tmpdir,
178 '--server=%s' % server)
180 shutil.rmtree(tmpdir)
182 def _test_unindexed_search(self):
184 ('(&(objectclass=user)(description='
185 'Built-in account for adminstering the computer/domain))'),
186 '(description=Built-in account for adminstering the computer/domain)',
187 '(objectCategory=*)',
188 '(samaccountname=Administrator*)'
190 for expression in expressions:
193 self.ldb.search(self.ou,
194 expression=expression,
197 print('%d %s took %s' % (i, expression,
201 def _test_indexed_search(self):
202 expressions = ['(objectclass=group)',
203 '(samaccountname=Administrator)'
205 for expression in expressions:
207 for i in range(4000):
208 self.ldb.search(self.ou,
209 expression=expression,
212 print('%d runs %s took %s' % (i, expression,
216 def _test_base_search(self):
217 for dn in [self.base_dn, self.ou, self.ou_users,
218 self.ou_groups, self.ou_computers]:
219 for i in range(4000):
224 except LdbError as e:
226 if num != ERR_NO_SUCH_OBJECT:
229 def _test_base_search_failing(self):
230 pattern = 'missing%d' + self.ou
231 for i in range(4000):
233 self.ldb.search(pattern % i,
236 except LdbError as (num, msg):
237 if num != ERR_NO_SUCH_OBJECT:
240 def search_expression_list(self, expressions, rounds,
242 scope=SCOPE_SUBTREE):
243 for expression in expressions:
245 for i in range(rounds):
246 self.ldb.search(self.ou,
247 expression=expression,
250 print('%d runs %s took %s' % (i, expression,
254 def _test_complex_search(self, n=100):
255 classes = ['samaccountname', 'objectCategory', 'dn', 'member']
256 values = ['*', '*t*', 'g*', 'user']
257 comparators = ['=', '<=', '>='] # '~=' causes error
258 maybe_not = ['!(', '']
261 # The number of permuations is 18432, which is not huge but
262 # would take hours to search. So we take a sample.
263 all_permutations = list(itertools.product(joiners,
266 comparators, comparators,
267 maybe_not, maybe_not))
271 for (j, c1, c2, v1, v2,
272 o1, o2, n1, n2) in random.sample(all_permutations, n):
273 expression = ''.join(['(', j,
279 expressions.append(expression)
281 self.search_expression_list(expressions, 1)
283 def _test_member_search(self, rounds=10):
286 expressions.append('(member=cn=u%d,%s)' % (d + 500, self.ou_users))
287 expressions.append('(member=u%d*)' % (d + 700,))
289 self.search_expression_list(expressions, rounds)
291 def _test_memberof_search(self, rounds=200):
293 for i in range(min(self.state.n_groups, rounds)):
294 expressions.append('(memberOf=cn=g%d,%s)' % (i, self.ou_groups))
295 expressions.append('(memberOf=cn=g%d*)' % (i,))
296 expressions.append('(memberOf=cn=*%s*)' % self.ou_groups)
298 self.search_expression_list(expressions, 2)
300 def _test_add_many_users(self, n=BATCH_SIZE):
301 s = self.state.next_user_id
303 self._add_users(s, e)
304 self.state.next_user_id = e
306 def _test_add_many_users_ldif(self, n=BATCH_SIZE):
307 s = self.state.next_user_id
309 self._add_users_ldif(s, e)
310 self.state.next_user_id = e
312 def _link_user_and_group(self, u, g):
314 if link in self.state.active_links:
318 m.dn = Dn(self.ldb, "CN=g%d,%s" % (g, self.ou_groups))
319 m["member"] = MessageElement("cn=u%d,%s" % (u, self.ou_users),
320 FLAG_MOD_ADD, "member")
322 self.state.active_links.add(link)
325 def _unlink_user_and_group(self, u, g):
327 if link not in self.state.active_links:
330 user = "cn=u%d,%s" % (u, self.ou_users)
331 group = "CN=g%d,%s" % (g, self.ou_groups)
333 m.dn = Dn(self.ldb, group)
334 m["member"] = MessageElement(user, FLAG_MOD_DELETE, "member")
336 self.state.active_links.remove(link)
339 def _test_link_many_users(self, n=LINK_BATCH_SIZE):
340 # this links unevenly, putting more users in the first group
341 # and fewer in the last.
342 ng = self.state.n_groups
343 nu = self.state.next_user_id
345 u = random.randrange(nu)
346 g = random.randrange(random.randrange(ng) + 1)
347 if self._link_user_and_group(u, g):
350 def _test_link_many_users_batch(self, n=(LINK_BATCH_SIZE * 10)):
351 # this links unevenly, putting more users in the first group
352 # and fewer in the last.
353 ng = self.state.n_groups
354 nu = self.state.next_user_id
358 m.dn = Dn(self.ldb, "CN=g%d,%s" % (g, self.ou_groups))
362 u = random.randrange(nu)
363 g = random.randrange(random.randrange(ng) + 1)
365 if link in self.state.active_links:
368 m["member%s" % u] = MessageElement("cn=u%d,%s" %
370 FLAG_MOD_ADD, "member")
371 self.state.active_links.add(link)
377 except LdbError as e:
381 def _test_remove_some_links(self, n=(LINK_BATCH_SIZE // 2)):
382 victims = random.sample(list(self.state.active_links), n)
384 self._unlink_user_and_group(*x)
386 test_00_11_join_empty_dc = _test_join
388 test_00_12_adding_users_2000 = _test_add_many_users
390 test_00_20_join_unlinked_2k_users = _test_join
391 test_00_21_unindexed_search_2k_users = _test_unindexed_search
392 test_00_22_indexed_search_2k_users = _test_indexed_search
394 test_00_23_complex_search_2k_users = _test_complex_search
395 test_00_24_member_search_2k_users = _test_member_search
396 test_00_25_memberof_search_2k_users = _test_memberof_search
398 test_00_27_base_search_2k_users = _test_base_search
399 test_00_28_base_search_failing_2k_users = _test_base_search_failing
401 test_01_01_link_2k_users = _test_link_many_users
402 test_01_02_link_2k_users_batch = _test_link_many_users_batch
404 test_02_10_join_2k_linked_dc = _test_join
405 test_02_11_unindexed_search_2k_linked_dc = _test_unindexed_search
406 test_02_12_indexed_search_2k_linked_dc = _test_indexed_search
408 test_04_01_remove_some_links_2k = _test_remove_some_links
410 test_05_01_adding_users_after_links_4k_ldif = _test_add_many_users_ldif
412 test_06_04_link_users_4k = _test_link_many_users
413 test_06_05_link_users_4k_batch = _test_link_many_users_batch
415 test_07_01_adding_users_after_links_6k = _test_add_many_users
417 def _test_ldif_well_linked_group(self, link_chance=1.0):
418 g = self.state.n_groups
419 self.state.n_groups += 1
420 lines = ["dn: CN=g%d,%s" % (g, self.ou_groups),
421 "objectclass: group"]
423 for i in xrange(self.state.next_user_id):
424 if random.random() <= link_chance:
425 lines.append("member: cn=u%d,%s" % (i, self.ou_users))
426 self.state.active_links.add((i, g))
429 self.ldb.add_ldif('\n'.join(lines))
431 test_09_01_add_fully_linked_group = _test_ldif_well_linked_group
433 def test_09_02_add_exponentially_diminishing_linked_groups(self):
435 while linkage > 0.01:
436 self._test_ldif_well_linked_group(linkage)
439 test_09_04_link_users_6k = _test_link_many_users
441 test_10_01_unindexed_search_6k_users = _test_unindexed_search
442 test_10_02_indexed_search_6k_users = _test_indexed_search
444 test_10_27_base_search_6k_users = _test_base_search
445 test_10_28_base_search_failing_6k_users = _test_base_search_failing
447 def test_10_03_complex_search_6k_users(self):
448 self._test_complex_search(n=50)
450 def test_10_04_member_search_6k_users(self):
451 self._test_member_search(rounds=1)
453 def test_10_05_memberof_search_6k_users(self):
454 self._test_memberof_search(rounds=5)
456 test_11_02_join_full_dc = _test_join
458 test_12_01_remove_some_links_6k = _test_remove_some_links
460 def _test_delete_many_users(self, n=DELETE_BATCH_SIZE):
461 e = self.state.next_user_id
463 self.state.next_user_id = s
464 for i in range(s, e):
465 self.ldb.delete("cn=u%d,%s" % (i, self.ou_users))
467 for x in tuple(self.state.active_links):
469 self.state.active_links.remove(x)
471 test_20_01_delete_users_6k = _test_delete_many_users
473 def test_21_01_delete_10_groups(self):
474 for i in range(self.state.n_groups - 10, self.state.n_groups):
475 self.ldb.delete("cn=g%d,%s" % (i, self.ou_groups))
476 self.state.n_groups -= 10
477 for x in tuple(self.state.active_links):
478 if x[1] >= self.state.n_groups:
479 self.state.active_links.remove(x)
481 test_21_02_delete_users_5950 = _test_delete_many_users
483 def test_22_01_delete_all_groups(self):
484 for i in range(self.state.n_groups):
485 self.ldb.delete("cn=g%d,%s" % (i, self.ou_groups))
486 self.state.n_groups = 0
487 self.state.active_links = set()
489 # XXX assert the state is as we think, using searches
491 def test_23_01_delete_users_5900_after_groups(self):
492 # we do not delete everything because it takes too long
493 n = 4 * DELETE_BATCH_SIZE
494 self._test_delete_many_users(n=n)
496 test_24_02_join_after_partial_cleanup = _test_join
499 if "://" not in host:
500 if os.path.isfile(host):
501 host = "tdb://%s" % host
503 host = "ldap://%s" % host
507 runner = SubunitTestRunner()
508 if not runner.run(unittest.makeSuite(UserTests)).wasSuccessful():
512 TestProgram(module=__name__, opts=subunitopts)