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
|
import subprocess
import unittest
import pickle
from unittest import mock
import crmsh.sh
from crmsh.user_of_host import UserOfHost
class TestLocalShell(unittest.TestCase):
def setUp(self) -> None:
self.local_shell = crmsh.sh.LocalShell()
self.local_shell.get_effective_user_name = mock.Mock(self.local_shell.get_effective_user_name)
self.local_shell.geteuid = mock.Mock(self.local_shell.geteuid)
self.local_shell.hostname = mock.Mock(self.local_shell.hostname)
@mock.patch('os.environ')
@mock.patch('subprocess.run')
def test_su_subprocess_run(self, mock_run: mock.MagicMock, mock_environ: mock.MagicMock):
self.local_shell.get_effective_user_name.return_value = 'root'
self.local_shell.geteuid.return_value = 0
self.local_shell.su_subprocess_run(
'alice', 'foo',
input=b'bar',
)
mock_run.assert_called_once_with(
['su', 'alice', '--login', '-s', '/bin/sh', '-c', 'foo'],
input=b'bar',
env=mock_environ,
)
@mock.patch('os.environ')
@mock.patch('subprocess.run')
def test_su_subprocess_run_as_root(self, mock_run: mock.MagicMock, mock_environ: mock.MagicMock):
self.local_shell.get_effective_user_name.return_value = 'root'
self.local_shell.geteuid.return_value = 0
self.local_shell.su_subprocess_run(
'root', 'foo',
input=b'bar',
)
mock_run.assert_called_once_with(
['/bin/sh', '-c', 'foo'],
input=b'bar',
env=mock_environ,
)
@mock.patch('subprocess.run')
def test_su_subprocess_run_unauthorized(self, mock_run: mock.MagicMock):
self.local_shell.get_effective_user_name.return_value = 'bob'
self.local_shell.geteuid.return_value = 1001
with self.assertRaises(crmsh.sh.AuthorizationError) as ctx:
self.local_shell.su_subprocess_run(
'root', 'foo',
input=b'bar',
)
self.assertIsInstance(ctx.exception, ValueError)
def test_get_stdout_stderr_decoded_and_stripped(self):
self.local_shell.get_rc_stdout_stderr_raw = mock.Mock(self.local_shell.get_rc_stdout_stderr_raw)
self.local_shell.get_rc_stdout_stderr_raw.return_value = 1, b' out \n', b'\terr\t\n'
rc, out, err = self.local_shell.get_rc_stdout_stderr('alice', 'foo', 'input')
self.assertEqual(1, rc)
self.assertEqual('out', out)
self.assertEqual('err', err)
self.local_shell.get_rc_stdout_stderr_raw.assert_called_once_with(
'alice', 'foo', b'input',
)
def test_get_stdout_or_raise_error(self):
self.local_shell.su_subprocess_run = mock.Mock(self.local_shell.su_subprocess_run)
self.local_shell.su_subprocess_run.return_value = subprocess.CompletedProcess(
args=mock.Mock(),
returncode=1,
stdout=b'foo',
stderr=b' bar ',
)
with self.assertRaises(crmsh.sh.CommandFailure) as ctx:
self.local_shell.get_stdout_or_raise_error('root', 'foo')
self.assertIsInstance(ctx.exception, ValueError)
class TestSSHShell(unittest.TestCase):
def setUp(self) -> None:
self.ssh_shell = crmsh.sh.SSHShell(mock.Mock(crmsh.sh.LocalShell), 'alice')
self.ssh_shell.local_shell.hostname.return_value = 'node1'
self.ssh_shell.local_shell.get_effective_user_name.return_value = 'root'
self.ssh_shell.local_shell.can_run_as.return_value = True
def test_can_run_as(self):
self.ssh_shell.local_shell.get_rc_and_error.return_value = 255, 'bar'
self.assertFalse(self.ssh_shell.can_run_as('node2', 'root'))
self.ssh_shell.local_shell.can_run_as.assert_not_called()
def test_can_run_as_local(self):
self.assertTrue(self.ssh_shell.can_run_as(None, 'root'))
self.ssh_shell.local_shell.can_run_as.assert_called_once_with('root')
def test_subprocess_run_without_input(self):
self.ssh_shell.subprocess_run_without_input(
'node2', 'bob',
'foo',
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
args, kwargs = self.ssh_shell.local_shell.su_subprocess_run.call_args
self.assertEqual('alice', args[0])
self.assertIn('bob@node2', args[1])
self.assertEqual(b'foo', kwargs['input'])
self.assertEqual(subprocess.PIPE, kwargs['stdout'])
self.assertEqual(subprocess.PIPE, kwargs['stderr'])
def test_subprocess_run_without_input_with_input_kwargs(self):
with self.assertRaises(AssertionError):
self.ssh_shell.subprocess_run_without_input(
'node2', 'bob',
'foo',
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
input=b'bar'
)
self.ssh_shell.local_shell.su_subprocess_run.assert_not_called()
with self.assertRaises(AssertionError):
self.ssh_shell.subprocess_run_without_input(
'node2', 'bob',
'foo',
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
stdin=subprocess.PIPE,
)
self.ssh_shell.local_shell.su_subprocess_run.assert_not_called()
@mock.patch('os.environ')
@mock.patch('subprocess.run')
def test_subprocess_run_without_input_local(self, mock_run, mock_environ: mock.MagicMock):
self.ssh_shell.subprocess_run_without_input(
'node1', 'bob',
'foo',
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
self.ssh_shell.local_shell.su_subprocess_run.assert_not_called()
mock_run.assert_called_once_with(
['sudo', '-H', '-u', 'bob', '/bin/sh'],
input=b'foo',
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
env=mock_environ,
)
class TestClusterShell(unittest.TestCase):
def setUp(self) -> None:
self.cluster_shell = crmsh.sh.ClusterShell(mock.Mock(crmsh.sh.LocalShell), mock.Mock(UserOfHost))
self.cluster_shell.local_shell.hostname.return_value = 'node1'
self.cluster_shell.local_shell.get_effective_user_name.return_value = 'root'
self.cluster_shell.local_shell.can_run_as.return_value = True
self.cluster_shell.user_of_host.user_pair_for_ssh.return_value = ('alice', 'bob')
def test_subprocess_run_without_input(self):
self.cluster_shell.subprocess_run_without_input(
'node2',
None,
'foo',
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
self.cluster_shell.user_of_host.user_pair_for_ssh.assert_called_once_with('node2')
args, kwargs = self.cluster_shell.local_shell.su_subprocess_run.call_args
self.assertEqual('alice', args[0])
self.assertIn('bob@node2', args[1])
self.assertIn('-u root', args[1])
self.assertEqual(b'foo', kwargs['input'])
self.assertEqual(subprocess.PIPE, kwargs['stdout'])
self.assertEqual(subprocess.PIPE, kwargs['stderr'])
def test_subprocess_run_without_input_with_input_kwargs(self):
with self.assertRaises(AssertionError):
self.cluster_shell.subprocess_run_without_input(
'node2',
None,
'foo',
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
input=b'bar',
)
self.cluster_shell.local_shell.su_subprocess_run.assert_not_called()
with self.assertRaises(AssertionError):
self.cluster_shell.subprocess_run_without_input(
'node2',
None,
'foo',
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
stdin=subprocess.PIPE,
)
self.cluster_shell.local_shell.su_subprocess_run.assert_not_called()
class TestCommandFailurePickling(unittest.TestCase):
def test_pickling_unpickling(self):
# Create an instance of CommandFailure
original = crmsh.sh.CommandFailure(cmd="ls", host="localhost", user="root", msg="Permission denied")
# Pickle the object
pickled = pickle.dumps(original)
# Unpickle the object
unpickled = pickle.loads(pickled)
# Assert that the unpickled object retains the same attributes as the original
self.assertEqual(original.cmd, unpickled.cmd)
self.assertEqual(original.host, unpickled.host)
self.assertEqual(original.user, unpickled.user)
self.assertEqual(original.msg, unpickled.msg)
def test_pickling_unpickling_with_none_values(self):
# Create an instance of CommandFailure with None values for optional parameters
original = crmsh.sh.CommandFailure(cmd="ls", host=None, user=None, msg="No such file or directory")
# Pickle the object
pickled = pickle.dumps(original)
# Unpickle the object
unpickled = pickle.loads(pickled)
# Assert that the unpickled object retains the same attributes, including None values
self.assertEqual(original.cmd, unpickled.cmd)
self.assertEqual(original.host, unpickled.host)
self.assertEqual(original.user, unpickled.user)
self.assertEqual(original.msg, unpickled.msg)
|
