python/samba/tests/samba_tool/group.py

   1 # Unix SMB/CIFS implementation.
   2 # Copyright (C) Michael Adam 2012
   3 #
   4 # This program is free software; you can redistribute it and/or modify
   5 # it under the terms of the GNU General Public License as published by
   6 # the Free Software Foundation; either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 #
  17
  18 import os
  19 import time
  20 import ldb
  21 from samba.tests.samba_tool.base import SambaToolCmdTest
  22 from samba import (
  23         nttime2unix,
  24         dsdb
  25         )
  26
  27
  28 class GroupCmdTestCase(SambaToolCmdTest):
  29     """Tests for samba-tool group subcommands"""
  30     groups = []
  31     samdb = None
  32
  33     def setUp(self):
  34         super(GroupCmdTestCase, self).setUp()
  35         self.samdb = self.getSamDB("-H", "ldap://%s" % os.environ["DC_SERVER"],
  36                                    "-U%s%%%s" % (os.environ["DC_USERNAME"], os.environ["DC_PASSWORD"]))
  37         self.groups = []
  38         self.groups.append(self._randomGroup({"name": "testgroup1"}))
  39         self.groups.append(self._randomGroup({"name": "testgroup2"}))
  40         self.groups.append(self._randomGroup({"name": "testgroup3"}))
  41         self.groups.append(self._randomGroup({"name": "testgroup4"}))
  42         self.groups.append(self._randomPosixGroup({"name": "posixgroup1"}))
  43         self.groups.append(self._randomPosixGroup({"name": "posixgroup2"}))
  44         self.groups.append(self._randomPosixGroup({"name": "posixgroup3"}))
  45         self.groups.append(self._randomPosixGroup({"name": "posixgroup4"}))
  46         self.groups.append(self._randomUnixGroup({"name": "unixgroup1"}))
  47         self.groups.append(self._randomUnixGroup({"name": "unixgroup2"}))
  48         self.groups.append(self._randomUnixGroup({"name": "unixgroup3"}))
  49         self.groups.append(self._randomUnixGroup({"name": "unixgroup4"}))
  50
  51         # setup the 12 groups and ensure they are correct
  52         for group in self.groups:
  53             (result, out, err) = group["createGroupFn"](group)
  54
  55             self.assertCmdSuccess(result, out, err)
  56             self.assertEquals(err, "", "There shouldn't be any error message")
  57
  58             if 'unix' in group["name"]:
  59                 self.assertIn("Modified Group '%s' successfully"
  60                               % group["name"], out)
  61             else:
  62                 self.assertIn("Added group %s" % group["name"], out)
  63
  64             group["checkGroupFn"](group)
  65
  66             found = self._find_group(group["name"])
  67
  68             self.assertIsNotNone(found)
  69
  70             self.assertEquals("%s" % found.get("name"), group["name"])
  71             self.assertEquals("%s" % found.get("description"), group["description"])
  72
  73     def tearDown(self):
  74         super(GroupCmdTestCase, self).tearDown()
  75         # clean up all the left over groups, just in case
  76         for group in self.groups:
  77             if self._find_group(group["name"]):
  78                 self.runsubcmd("group", "delete", group["name"])
  79
  80     def test_newgroup(self):
  81         """This tests the "group add" and "group delete" commands"""
  82         # try to add all the groups again, this should fail
  83         for group in self.groups:
  84             (result, out, err) = self._create_group(group)
  85             self.assertCmdFail(result, "Succeeded to create existing group")
  86             self.assertIn("LDAP error 68 LDAP_ENTRY_ALREADY_EXISTS", err)
  87
  88         # try to delete all the groups we just added
  89         for group in self.groups:
  90             (result, out, err) = self.runsubcmd("group", "delete", group["name"])
  91             self.assertCmdSuccess(result, out, err,
  92                                   "Failed to delete group '%s'" % group["name"])
  93             found = self._find_group(group["name"])
  94             self.assertIsNone(found,
  95                               "Deleted group '%s' still exists" % group["name"])
  96
  97         # test adding groups
  98         for group in self.groups:
  99             (result, out, err) = self.runsubcmd("group", "add", group["name"],
 100                                                 "--description=%s" % group["description"],
 101                                                 "-H", "ldap://%s" % os.environ["DC_SERVER"],
 102                                                 "-U%s%%%s" % (os.environ["DC_USERNAME"],
 103                                                               os.environ["DC_PASSWORD"]))
 104
 105             self.assertCmdSuccess(result, out, err)
 106             self.assertEquals(err, "", "There shouldn't be any error message")
 107             self.assertIn("Added group %s" % group["name"], out)
 108
 109             found = self._find_group(group["name"])
 110
 111             self.assertEquals("%s" % found.get("samaccountname"),
 112                               "%s" % group["name"])
 113
 114     def test_list(self):
 115         (result, out, err) = self.runsubcmd("group", "list",
 116                                             "-H", "ldap://%s" % os.environ["DC_SERVER"],
 117                                             "-U%s%%%s" % (os.environ["DC_USERNAME"],
 118                                                           os.environ["DC_PASSWORD"]))
 119         self.assertCmdSuccess(result, out, err, "Error running list")
 120
 121         search_filter = "(objectClass=group)"
 122
 123         grouplist = self.samdb.search(base=self.samdb.domain_dn(),
 124                                       scope=ldb.SCOPE_SUBTREE,
 125                                       expression=search_filter,
 126                                       attrs=["samaccountname"])
 127
 128         self.assertTrue(len(grouplist) > 0, "no groups found in samdb")
 129
 130         for groupobj in grouplist:
 131             name = str(groupobj.get("samaccountname", idx=0))
 132             found = self.assertMatch(out, name,
 133                                      "group '%s' not found" % name)
 134
 135     def test_list_verbose(self):
 136         (result, out, err) = self.runsubcmd("group", "list", "--verbose",
 137                                             "-H", "ldap://%s" % os.environ["DC_SERVER"],
 138                                             "-U%s%%%s" % (os.environ["DC_USERNAME"],
 139                                                           os.environ["DC_PASSWORD"]))
 140         self.assertCmdSuccess(result, out, err, "Error running list --verbose")
 141
 142         # use the output to build a dictionary, where key=group-name,
 143         # value=num-members
 144         output_memberships = {}
 145
 146         # split the output by line, skipping the first 2 header lines
 147         group_lines = out.split('\n')[2:-1]
 148         for line in group_lines:
 149             # split line by column whitespace (but keep the group name together
 150             # if it contains spaces)
 151             values = line.split("   ")
 152             name = values[0]
 153             num_members = int(values[-1])
 154             output_memberships[name] = num_members
 155
 156         # build up a similar dict using an LDAP search
 157         search_filter = "(objectClass=group)"
 158         grouplist = self.samdb.search(base=self.samdb.domain_dn(),
 159                                       scope=ldb.SCOPE_SUBTREE,
 160                                       expression=search_filter,
 161                                       attrs=["samaccountname", "member"])
 162         self.assertTrue(len(grouplist) > 0, "no groups found in samdb")
 163
 164         ldap_memberships = {}
 165         for groupobj in grouplist:
 166             name = str(groupobj.get("samaccountname", idx=0))
 167             num_members = len(groupobj.get("member", default=[]))
 168             ldap_memberships[name] = num_members
 169
 170         # check the command output matches LDAP
 171         self.assertTrue(output_memberships == ldap_memberships,
 172                         "Command output doesn't match LDAP results.\n" +
 173                         "Command='%s'\nLDAP='%s'" %(output_memberships,
 174                                                     ldap_memberships))
 175
 176     def test_listmembers(self):
 177         (result, out, err) = self.runsubcmd("group", "listmembers", "Domain Users",
 178                                             "-H", "ldap://%s" % os.environ["DC_SERVER"],
 179                                             "-U%s%%%s" % (os.environ["DC_USERNAME"],
 180                                                           os.environ["DC_PASSWORD"]))
 181         self.assertCmdSuccess(result, out, err, "Error running listmembers")
 182
 183         search_filter = "(|(primaryGroupID=513)(memberOf=CN=Domain Users,CN=Users,%s))" % self.samdb.domain_dn()
 184
 185         grouplist = self.samdb.search(base=self.samdb.domain_dn(),
 186                                       scope=ldb.SCOPE_SUBTREE,
 187                                       expression=search_filter,
 188                                       attrs=["samAccountName"])
 189
 190         self.assertTrue(len(grouplist) > 0, "no groups found in samdb")
 191
 192         for groupobj in grouplist:
 193             name = str(groupobj.get("samAccountName", idx=0))
 194             found = self.assertMatch(out, name, "group '%s' not found" % name)
 195
 196     def test_move(self):
 197         full_ou_dn = str(self.samdb.normalize_dn_in_domain("OU=movetest"))
 198         (result, out, err) = self.runsubcmd("ou", "create", full_ou_dn)
 199         self.assertCmdSuccess(result, out, err)
 200         self.assertEquals(err, "", "There shouldn't be any error message")
 201         self.assertIn('Created ou "%s"' % full_ou_dn, out)
 202
 203         for group in self.groups:
 204             (result, out, err) = self.runsubcmd(
 205                 "group", "move", group["name"], full_ou_dn)
 206             self.assertCmdSuccess(result, out, err, "Error running move")
 207             self.assertIn('Moved group "%s" into "%s"' %
 208                           (group["name"], full_ou_dn), out)
 209
 210         # Should fail as groups objects are in OU
 211         (result, out, err) = self.runsubcmd("ou", "delete", full_ou_dn)
 212         self.assertCmdFail(result)
 213         self.assertIn(("subtree_delete: Unable to delete a non-leaf node "
 214                        "(it has %d children)!") % len(self.groups), err)
 215
 216         for group in self.groups:
 217             new_dn = "CN=Users,%s" % self.samdb.domain_dn()
 218             (result, out, err) = self.runsubcmd(
 219                 "group", "move", group["name"], new_dn)
 220             self.assertCmdSuccess(result, out, err, "Error running move")
 221             self.assertIn('Moved group "%s" into "%s"' %
 222                           (group["name"], new_dn), out)
 223
 224         (result, out, err) = self.runsubcmd("ou", "delete", full_ou_dn)
 225         self.assertCmdSuccess(result, out, err,
 226                               "Failed to delete ou '%s'" % full_ou_dn)
 227
 228     def test_show(self):
 229         """Assert that we can show a group correctly."""
 230         (result, out, err) = self.runsubcmd("group", "show", "Domain Users",
 231                                             "-H", "ldap://%s" % os.environ["DC_SERVER"],
 232                                             "-U%s%%%s" % (os.environ["DC_USERNAME"],
 233                                                           os.environ["DC_PASSWORD"]))
 234         self.assertCmdSuccess(result, out, err)
 235         self.assertEquals(err, "", "Shouldn't be any error messages")
 236         self.assertIn("dn: CN=Domain Users,CN=Users,DC=samba,DC=example,DC=com", out)
 237
 238     def _randomGroup(self, base={}):
 239         """create a group with random attribute values, you can specify base
 240  attributes"""
 241         group = {
 242             "name": self.randomName(),
 243             "description": self.randomName(count=100),
 244             "createGroupFn": self._create_group,
 245             "checkGroupFn": self._check_group,
 246         }
 247         group.update(base)
 248         return group
 249
 250     def _randomPosixGroup(self, base={}):
 251         """create a group with random attribute values and additional RFC2307
 252         attributes, you can specify base attributes"""
 253         group = self._randomGroup({})
 254         group.update(base)
 255         posixAttributes = {
 256             "unixdomain": self.randomName(),
 257             "gidNumber": self.randomXid(),
 258             "createGroupFn": self._create_posix_group,
 259             "checkGroupFn": self._check_posix_group,
 260         }
 261         group.update(posixAttributes)
 262         group.update(base)
 263         return group
 264
 265     def _randomUnixGroup(self, base={}):
 266         """create a group with random attribute values and additional RFC2307
 267         attributes, you can specify base attributes"""
 268         group = self._randomGroup({})
 269         group.update(base)
 270         posixAttributes = {
 271             "gidNumber": self.randomXid(),
 272             "createGroupFn": self._create_unix_group,
 273             "checkGroupFn": self._check_unix_group,
 274         }
 275         group.update(posixAttributes)
 276         group.update(base)
 277         return group
 278
 279     def _check_group(self, group):
 280         """ check if a group from SamDB has the same attributes as
 281  its template """
 282         found = self._find_group(group["name"])
 283
 284         self.assertEquals("%s" % found.get("name"), group["name"])
 285         self.assertEquals("%s" % found.get("description"), group["description"])
 286
 287     def _check_posix_group(self, group):
 288         """ check if a posix_group from SamDB has the same attributes as
 289  its template """
 290         found = self._find_group(group["name"])
 291
 292         self.assertEquals("%s" % found.get("gidNumber"), "%s" %
 293                           group["gidNumber"])
 294         self._check_group(group)
 295
 296     def _check_unix_group(self, group):
 297         """ check if a unix_group from SamDB has the same attributes as its
 298 template """
 299         found = self._find_group(group["name"])
 300
 301         self.assertEquals("%s" % found.get("gidNumber"), "%s" %
 302                           group["gidNumber"])
 303         self._check_group(group)
 304
 305     def _create_group(self, group):
 306         return self.runsubcmd("group", "add", group["name"],
 307                               "--description=%s" % group["description"],
 308                               "-H", "ldap://%s" % os.environ["DC_SERVER"],
 309                               "-U%s%%%s" % (os.environ["DC_USERNAME"],
 310                                             os.environ["DC_PASSWORD"]))
 311
 312     def _create_posix_group(self, group):
 313         """ create a new group with RFC2307 attributes """
 314         return self.runsubcmd("group", "add", group["name"],
 315                               "--description=%s" % group["description"],
 316                               "--nis-domain=%s" % group["unixdomain"],
 317                               "--gid-number=%s" % group["gidNumber"],
 318                               "-H", "ldap://%s" % os.environ["DC_SERVER"],
 319                               "-U%s%%%s" % (os.environ["DC_USERNAME"],
 320                               os.environ["DC_PASSWORD"]))
 321
 322     def _create_unix_group(self, group):
 323         """ Add RFC2307 attributes to a group"""
 324         self._create_group(group)
 325         return self.runsubcmd("group", "addunixattrs", group["name"],
 326                               "%s" % group["gidNumber"],
 327                               "-H", "ldap://%s" % os.environ["DC_SERVER"],
 328                               "-U%s%%%s" % (os.environ["DC_USERNAME"],
 329                               os.environ["DC_PASSWORD"]))
 330
 331     def _find_group(self, name):
 332         search_filter = ("(&(sAMAccountName=%s)(objectCategory=%s,%s))" %
 333                          (ldb.binary_encode(name),
 334                           "CN=Group,CN=Schema,CN=Configuration",
 335                           self.samdb.domain_dn()))
 336         grouplist = self.samdb.search(base=self.samdb.domain_dn(),
 337                                       scope=ldb.SCOPE_SUBTREE,
 338                                       expression=search_filter)
 339         if grouplist:
 340             return grouplist[0]
 341         else:
 342             return None
 343
 344     def test_stats(self):
 345         (result, out, err) = self.runsubcmd("group", "stats",
 346                                             "-H", "ldap://%s" % os.environ["DC_SERVER"],
 347                                             "-U%s%%%s" % (os.environ["DC_USERNAME"],
 348                                                           os.environ["DC_PASSWORD"]))
 349         self.assertCmdSuccess(result, out, err, "Error running stats")
 350
 351         # sanity-check the command reports 'total groups' correctly
 352         search_filter = "(objectClass=group)"
 353         grouplist = self.samdb.search(base=self.samdb.domain_dn(),
 354                                       scope=ldb.SCOPE_SUBTREE,
 355                                       expression=search_filter,
 356                                       attrs=[])
 357
 358         total_groups = len(grouplist)
 359         self.assertTrue("Total groups: {0}".format(total_groups) in out,
 360                         "Total groups not reported correctly")