source4/scripting/devel/speedtest.py

   1 #!/usr/bin/env python3
   2 # -*- coding: utf-8 -*-
   3 #
   4 # Unix SMB/CIFS implementation.
   5 # This speed test aims to show difference in execution time for bulk
   6 # creation of user objects. This will help us compare
   7 # Samba4 vs MS Active Directory performance.
   8
   9 # Copyright (C) Zahari Zahariev <zahari.zahariev@postpath.com> 2010
  10 #
  11 # This program is free software; you can redistribute it and/or modify
  12 # it under the terms of the GNU General Public License as published by
  13 # the Free Software Foundation; either version 3 of the License, or
  14 # (at your option) any later version.
  15 #
  16 # This program is distributed in the hope that it will be useful,
  17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 # GNU General Public License for more details.
  20 #
  21 # You should have received a copy of the GNU General Public License
  22 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23 #
  24
  25 import optparse
  26 import sys
  27 import time
  28 import base64
  29 from decimal import Decimal
  30
  31 sys.path.insert(0, "bin/python")
  32 import samba
  33 from samba.tests.subunitrun import TestProgram, SubunitOptions
  34
  35 import samba.getopt as options
  36
  37 from ldb import SCOPE_BASE, SCOPE_SUBTREE
  38 from samba.ndr import ndr_unpack
  39 from samba.dcerpc import security
  40
  41 from samba.auth import system_session
  42 from samba import gensec, sd_utils
  43 from samba.samdb import SamDB
  44 from samba.credentials import Credentials
  45 import samba.tests
  46 from samba.tests import delete_force
  47
  48 parser = optparse.OptionParser("speedtest.py [options] <host>")
  49 sambaopts = options.SambaOptions(parser)
  50 parser.add_option_group(sambaopts)
  51 parser.add_option_group(options.VersionOptions(parser))
  52
  53 # use command line creds if available
  54 credopts = options.CredentialsOptions(parser)
  55 parser.add_option_group(credopts)
  56 subunitopts = SubunitOptions(parser)
  57 parser.add_option_group(subunitopts)
  58 opts, args = parser.parse_args()
  59
  60 if len(args) < 1:
  61     parser.print_usage()
  62     sys.exit(1)
  63
  64 host = args[0]
  65
  66 lp = sambaopts.get_loadparm()
  67 creds = credopts.get_credentials(lp)
  68 creds.set_gensec_features(creds.get_gensec_features() | gensec.FEATURE_SEAL)
  69
  70 #
  71 # Tests start here
  72 #
  73
  74
  75 class SpeedTest(samba.tests.TestCase):
  76
  77     def find_domain_sid(self, ldb):
  78         res = ldb.search(base=self.base_dn, expression="(objectClass=*)", scope=SCOPE_BASE)
  79         return ndr_unpack(security.dom_sid, res[0]["objectSid"][0])
  80
  81     def setUp(self):
  82         super(SpeedTest, self).setUp()
  83         self.ldb_admin = ldb
  84         self.base_dn = ldb.domain_dn()
  85         self.domain_sid = security.dom_sid(ldb.get_domain_sid())
  86         self.user_pass = "samba123@"
  87         print("baseDN: %s" % self.base_dn)
  88
  89     def create_user(self, user_dn):
  90         ldif = """
  91 dn: """ + user_dn + """
  92 sAMAccountName: """ + user_dn.split(",")[0][3:] + """
  93 objectClass: user
  94 unicodePwd:: """ + base64.b64encode(("\"%s\"" % self.user_pass).encode('utf-16-le')).decode('utf8') + """
  95 url: www.example.com
  96 """
  97         self.ldb_admin.add_ldif(ldif)
  98
  99     def create_group(self, group_dn, desc=None):
 100         ldif = """
 101 dn: """ + group_dn + """
 102 objectClass: group
 103 sAMAccountName: """ + group_dn.split(",")[0][3:] + """
 104 groupType: 4
 105 url: www.example.com
 106 """
 107         self.ldb_admin.add_ldif(ldif)
 108
 109     def create_bundle(self, count):
 110         for i in range(count):
 111             self.create_user("cn=speedtestuser%d,cn=Users,%s" % (i + 1, self.base_dn))
 112
 113     def remove_bundle(self, count):
 114         for i in range(count):
 115             delete_force(self.ldb_admin, "cn=speedtestuser%d,cn=Users,%s" % (i + 1, self.base_dn))
 116
 117     def remove_test_users(self):
 118         res = ldb.search(base="cn=Users,%s" % self.base_dn, expression="(objectClass=user)", scope=SCOPE_SUBTREE)
 119         dn_list = [item.dn for item in res if "speedtestuser" in str(item.dn)]
 120         for dn in dn_list:
 121             delete_force(self.ldb_admin, dn)
 122
 123
 124 class SpeedTestAddDel(SpeedTest):
 125
 126     def setUp(self):
 127         super(SpeedTestAddDel, self).setUp()
 128
 129     def run_bundle(self, num):
 130         print("\n=== Test ADD/DEL %s user objects ===\n" % num)
 131         avg_add = Decimal("0.0")
 132         avg_del = Decimal("0.0")
 133         for x in [1, 2, 3]:
 134             start = time.time()
 135             self.create_bundle(num)
 136             res_add = Decimal(str(time.time() - start))
 137             avg_add += res_add
 138             print("   Attempt %s ADD: %.3fs" % (x, float(res_add)))
 139             #
 140             start = time.time()
 141             self.remove_bundle(num)
 142             res_del = Decimal(str(time.time() - start))
 143             avg_del += res_del
 144             print("   Attempt %s DEL: %.3fs" % (x, float(res_del)))
 145         print("Average ADD: %.3fs" % float(Decimal(avg_add) / Decimal("3.0")))
 146         print("Average DEL: %.3fs" % float(Decimal(avg_del) / Decimal("3.0")))
 147         print("")
 148
 149     def test_00000(self):
 150         """ Remove possibly undeleted test users from previous test
 151         """
 152         self.remove_test_users()
 153
 154     def test_00010(self):
 155         self.run_bundle(10)
 156
 157     def test_00100(self):
 158         self.run_bundle(100)
 159
 160     def test_01000(self):
 161         self.run_bundle(1000)
 162
 163     def _test_10000(self):
 164         """ This test should be enabled preferably against MS Active Directory.
 165             It takes quite the time against Samba4 (1-2 days).
 166         """
 167         self.run_bundle(10000)
 168
 169
 170 class AclSearchSpeedTest(SpeedTest):
 171
 172     def setUp(self):
 173         super(AclSearchSpeedTest, self).setUp()
 174         self.ldb_admin.newuser("acltestuser", "samba123@")
 175         self.sd_utils = sd_utils.SDUtils(self.ldb_admin)
 176         self.ldb_user = self.get_ldb_connection("acltestuser", "samba123@")
 177         self.user_sid = self.sd_utils.get_object_sid(self.get_user_dn("acltestuser"))
 178
 179     def tearDown(self):
 180         super(AclSearchSpeedTest, self).tearDown()
 181         delete_force(self.ldb_admin, self.get_user_dn("acltestuser"))
 182
 183     def run_search_bundle(self, num, _ldb):
 184         print("\n=== Creating %s user objects ===\n" % num)
 185         self.create_bundle(num)
 186         mod = "(A;;LC;;;%s)(D;;RP;;;%s)" % (str(self.user_sid), str(self.user_sid))
 187         for i in range(num):
 188             self.sd_utils.dacl_add_ace("cn=speedtestuser%d,cn=Users,%s" %
 189                                        (i + 1, self.base_dn), mod)
 190         print("\n=== %s user objects created ===\n" % num)
 191         print("\n=== Test search on %s user objects ===\n" % num)
 192         avg_search = Decimal("0.0")
 193         for x in [1, 2, 3]:
 194             start = time.time()
 195             res = _ldb.search(base=self.base_dn, expression="(objectClass=*)", scope=SCOPE_SUBTREE)
 196             res_search = Decimal(str(time.time() - start))
 197             avg_search += res_search
 198             print("   Attempt %s SEARCH: %.3fs" % (x, float(res_search)))
 199         print("Average Search: %.3fs" % float(Decimal(avg_search) / Decimal("3.0")))
 200         self.remove_bundle(num)
 201
 202     def get_user_dn(self, name):
 203         return "CN=%s,CN=Users,%s" % (name, self.base_dn)
 204
 205     def get_ldb_connection(self, target_username, target_password):
 206         creds_tmp = Credentials()
 207         creds_tmp.set_username(target_username)
 208         creds_tmp.set_password(target_password)
 209         creds_tmp.set_domain(creds.get_domain())
 210         creds_tmp.set_realm(creds.get_realm())
 211         creds_tmp.set_workstation(creds.get_workstation())
 212         creds_tmp.set_gensec_features(creds_tmp.get_gensec_features()
 213                                       | gensec.FEATURE_SEAL)
 214         ldb_target = SamDB(url=host, credentials=creds_tmp, lp=lp)
 215         return ldb_target
 216
 217     def test_search_01000(self):
 218         self.run_search_bundle(1000, self.ldb_admin)
 219
 220     def test_search2_01000(self):
 221         # allow the user to see objects but not attributes, all attributes will be filtered out
 222         mod = "(A;;LC;;;%s)(D;;RP;;;%s)" % (str(self.user_sid), str(self.user_sid))
 223         self.sd_utils.dacl_add_ace("CN=Users,%s" % self.base_dn, mod)
 224         self.run_search_bundle(1000, self.ldb_user)
 225
 226 # Important unit running information
 227
 228
 229 if "://" not in host:
 230     host = "ldap://%s" % host
 231
 232 ldb_options = ["modules:paged_searches"]
 233 ldb = SamDB(host, credentials=creds, session_info=system_session(), lp=lp, options=ldb_options)
 234
 235 TestProgram(module=__name__, opts=subunitopts)