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
|
# Unix SMB/CIFS implementation.
# Copyright (C) Sean Dague <sdague@linux.vnet.ibm.com> 2011
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# This provides a wrapper around the cmd interface so that tests can
# easily be built on top of it and have minimal code to run basic tests
# of the commands. A list of the environmental variables can be found in
# ~/selftest/selftest.pl
#
# These can all be accessed via os.environ["VARIABLENAME"] when needed
import os
import sys
import random
import string
from io import StringIO
import samba.getopt as options
import samba.tests
from samba.auth import system_session
from samba.getopt import OptionParser
from samba.netcmd.main import cmd_sambatool
from samba.samdb import SamDB
def truncate_string(s, cutoff=100):
if len(s) < cutoff + 15:
return s
return s[:cutoff] + '[%d more characters]' % (len(s) - cutoff)
class SambaToolCmdTest(samba.tests.BlackboxTestCase):
# Use a class level reference to StringIO, which subclasses can
# override if they need to (to e.g. add a lying isatty() method).
stringIO = StringIO
@staticmethod
def getSamDB(*argv):
"""a convenience function to get a samdb instance so that we can query it"""
parser = OptionParser()
sambaopts = options.SambaOptions(parser)
credopts = options.CredentialsOptions(parser)
hostopts = options.HostOptions(parser)
parser.parse_args(list(argv))
lp = sambaopts.get_loadparm()
creds = credopts.get_credentials(lp, fallback_machine=True)
return SamDB(url=hostopts.H, session_info=system_session(),
credentials=creds, lp=lp)
@classmethod
def _run(cls, *argv, verbose=False, catch_error=False):
"""run a samba-tool command.
positional arguments are effectively what gets passed to
bin/samba-tool.
Add catch_error=True to make samba-tool exceptions into
failures.
Add verbose=True during development to see the expanded
command and results.
"""
try:
cmd, args = cmd_sambatool()._resolve('samba-tool', *argv,
outf=cls.stringIO(),
errf=cls.stringIO())
result = cmd._run(*args)
out = cmd.outf.getvalue()
err = cmd.errf.getvalue()
except (Exception, SystemExit) as e:
# We need to catch SystemExit as well as Exception,
# because samba-tool will often convert exceptions into
# exits (SystemExit is a subclass of BaseException but not
# Exception).
if catch_error:
raise AssertionError(f"'samba-tool {' '.join(argv)}' raised {e}")
raise
if verbose:
print(f"bin/samba-tool {' '.join(argv)}\n\nstdout:\n"
f"{out}\n\nstderr:\n{err}\nresult: {result}\n",
file=sys.stderr)
return (result, out, err)
runcmd = _run
runsubcmd = _run
def runsublevelcmd(self, name, sublevels, *args):
"""run a command with any number of sub command levels"""
# This is a weird and clunky interface for running a
# subcommand. Use self.runcmd() instead.
return self._run(name, *sublevels, *args)
def assertCmdSuccess(self, exit, out, err, msg=""):
# Make sure we allow '\n]\n' in stdout and stderr
# without causing problems with the subunit protocol.
# We just inject a space...
msg = "exit[%s] stdout[%s] stderr[%s]: %s" % (exit, out, err, msg)
self.assertIsNone(exit, msg=msg.replace("\n]\n", "\n] \n"))
def assertCmdFail(self, val, msg=""):
self.assertIsNotNone(val, msg)
def assertMatch(self, base, string, msg=None):
# Note: we should stop doing this and just use self.assertIn()
if msg is None:
msg = "%r is not in %r" % (truncate_string(string),
truncate_string(base))
self.assertIn(string, base, msg)
def randomName(self, count=8):
"""Create a random name, cap letters and numbers, and always starting with a letter"""
name = random.choice(string.ascii_uppercase)
name += ''.join(random.choice(string.ascii_uppercase + string.ascii_lowercase + string.digits) for x in range(count - 1))
return name
def randomXid(self):
# pick some unused, high UID/GID range to avoid interference
# from the system the test runs on
# initialize a list to store used IDs
try:
self.used_xids
except AttributeError:
self.used_xids = []
# try to get an unused ID
failed = 0
while failed < 50:
xid = random.randint(4711000, 4799000)
if xid not in self.used_xids:
self.used_xids += [xid]
return xid
failed += 1
assert False, "No Xid are available"
def assertWithin(self, val1, val2, delta, msg=""):
"""Assert that val1 is within delta of val2, useful for time computations"""
self.assertTrue(((val1 + delta) > val2) and ((val1 - delta) < val2), msg)
def cleanup_join(self, netbios_name):
(result, out, err) \
= self.runsubcmd("domain",
"demote",
("--remove-other-dead-server=%s " % netbios_name),
("-U%s%%%s" % (os.environ["USERNAME"], os.environ["PASSWORD"])),
("--server=%s" % os.environ["SERVER"]))
self.assertCmdSuccess(result, out, err)
|
