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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
|
# Released under GPLv3+ License
# Danial Behzadi <dani.behzi@ubuntu.com>, 2024.
"""
unit tests for actions
"""
import signal
import unittest
from unittest.mock import patch, MagicMock
from tractor import actions
class MsgHandler(unittest.TestCase):
"""
test case for message handlers
"""
@patch("builtins.print")
def test_print_bootstrap_lines_no(self, mock_print):
"""
should not print
"""
actions._print_bootstrap_lines("line")
mock_print.assert_not_called()
@patch("builtins.print")
def test_print_bootstrap_lines_yes(self, mock_print):
"""
should print
"""
actions._print_bootstrap_lines("Bootstrapped line")
mock_print.assert_called_once_with(
"\x1b[34mBootstrapped line\x1b[0m", flush=True
)
@patch("builtins.print")
def test_print_all_lines(self, mock_print):
"""
should print
"""
actions._print_all_lines("line")
mock_print.assert_called_once_with("\x1b[34mline\x1b[0m", flush=True)
class FinishNotification(unittest.TestCase):
"""
test case for _finish_notification
"""
@patch("tractor.checks.running", return_value=False)
@patch("sys.stdout")
@patch("tractor.checks.verbose_print")
def test_finish_notification_fail(self, mock_verbose_print, *_):
"""
couldn't connect
"""
actions._finish_notification(verbose=False)
mock_verbose_print.assert_not_called()
@patch("stem.util.term.format", return_value="connected")
@patch("tractor.checks.running", return_value=True)
@patch("tractor.db.get_val", return_value=True)
@patch("tractor.proxy.proxy_set")
@patch("tractor.checks.verbose_print")
def test_finish_notification_done(
self, mock_verbose_print, mock_proxy_set, *_
):
"""
connection is successful and proxy is auto-set
"""
actions._finish_notification(verbose=False)
mock_verbose_print.assert_called_once_with("connected", False)
mock_proxy_set.assert_called_once_with(False)
@patch("stem.util.term.format", return_value="connected")
@patch("tractor.checks.running", return_value=True)
@patch("tractor.db.get_val", return_value=False)
@patch("tractor.proxy.proxy_set")
@patch("tractor.checks.verbose_print")
def test_finish_notification_done_no_auto_set(
self, mock_verbose_print, mock_proxy_set, *_
):
"""
connection is successful and proxy is not auto-set
"""
actions._finish_notification(verbose=False)
mock_proxy_set.assert_not_called()
self.assertEqual(mock_verbose_print.call_count, 2)
class Launch(unittest.TestCase):
"""
test case for _launch
"""
@patch("os.rmdir")
@patch("os.remove")
@patch("sys.stdout")
@patch("os.path.exists", return_value=False)
@patch("tractor.actions.launch_tor", side_effect=OSError)
@patch("tractor.actions._finish_notification")
def test_launch_os_error(self, mock_finish, *_):
"""
Couldn't launch
"""
actions._launch("torrc", "tmpdir", False)
mock_finish.assert_not_called()
@patch("os.rmdir")
@patch("os.remove")
@patch("os.path.exists", return_value=False)
@patch("tractor.actions.launch_tor", side_effect=KeyboardInterrupt)
@patch("tractor.actions._finish_notification")
def test_launch_interrupt(self, mock_finish, *_):
"""
Keyboard interrupt
"""
actions._launch("torrc", "tmpdir", False)
mock_finish.assert_not_called()
@patch("os.rmdir")
@patch("os.remove")
@patch("os.path.exists", return_value=True)
@patch("tractor.db.set_val")
@patch("tractor.actions.launch_tor")
@patch("tractor.actions.rmtree")
@patch("tractor.actions._finish_notification")
def test_launch_ok(
self, mock_finish, mock_rmtree, mock_launch_tor, mock_set_val, *_
):
"""
successful
"""
# Arrange
mock_process = MagicMock()
mock_process.pid = 12345
mock_launch_tor.return_value = mock_process
# Act
actions._launch("torrc", "tmpdir", False)
# Assert
mock_finish.assert_called_once_with(False)
mock_set_val.assert_called_once_with("pid", 12345)
mock_rmtree.assert_called_once_with("tmpdir", ignore_errors=True)
class StartLaunch(unittest.TestCase):
"""
test case for _start_launch
"""
@patch("sys.stdout")
@patch("os.makedirs")
@patch("tractor.tractorrc.create", side_effect=ValueError)
@patch("tractor.actions._launch")
def test_start_launch_value_error(self, mock_launch, *_):
"""
configuration error
"""
actions._start_launch(verbose=False)
mock_launch.assert_not_called()
@patch("sys.stdout")
@patch("os.makedirs")
@patch("tractor.tractorrc.create", side_effect=EnvironmentError)
@patch("tractor.actions._launch")
def test_start_launch_env_error(self, mock_launch, *_):
"""
no bridge
"""
actions._start_launch(verbose=False)
mock_launch.assert_not_called()
@patch("sys.stdout")
@patch("os.makedirs")
@patch("tractor.tractorrc.create", return_value=("a", "b"))
@patch("tractor.actions._launch")
def test_start_launch_success(self, mock_launch, *_):
"""
starting launch
"""
actions._start_launch(verbose=False)
mock_launch.assert_called_once_with("b", "a", False)
class Start(unittest.TestCase):
"""
test case for start
"""
@patch("tractor.checks.running", return_value=False)
@patch("tractor.actions._start_launch")
def test_start_do(self, mock_launch, *_):
"""
tractor is not running
"""
actions.start()
mock_launch.assert_called_once()
@patch("sys.stdout")
@patch("tractor.checks.running", return_value=True)
@patch("tractor.actions._start_launch")
def test_start_dont(self, mock_launch, *_):
"""
tractor is already running
"""
actions.start()
mock_launch.assert_not_called()
class Stop(unittest.TestCase):
"""
test case for stop
"""
@patch("stem.util.term.format", return_value="Tractor stopped")
@patch("tractor.checks.running", return_value=True)
@patch("tractor.db.reset")
@patch("tractor.control.send_signal")
@patch("stem.connection.connect")
@patch("tractor.checks.verbose_print")
def test_stop_do(self, mock_verbose_print, *_):
"""
tractor is already running
"""
actions.stop()
mock_verbose_print.assert_called_with("Tractor stopped", False)
@patch("stem.util.term.format", return_value="Tractor is stopped")
@patch("tractor.checks.running", return_value=False)
@patch("tractor.checks.verbose_print")
def test_stop_dont(self, mock_verbose_print, *_):
"""
tractor is not running
"""
actions.stop()
mock_verbose_print.assert_called_once_with("Tractor is stopped", False)
class Restart(unittest.TestCase):
"""
test case for restart
"""
@patch("tractor.actions.stop")
@patch("tractor.actions.start")
def test_restart(self, mock_start, mock_stop):
"""
test restart
"""
actions.restart()
mock_stop.assert_called_once()
mock_start.assert_called_once()
class NewId(unittest.TestCase):
"""
test case for new_id
"""
@patch("sys.stdout")
@patch("tractor.checks.running", return_value=False)
@patch("tractor.control.send_signal")
def test_new_id_not_running(self, mock_send_signal, mock_running, *_):
"""
tractor is not running
"""
actions.new_id()
mock_running.assert_called_once()
mock_send_signal.assert_not_called()
@patch("stem.util.term.format", return_value="You have a new ID")
@patch("tractor.checks.running", return_value=True)
@patch("tractor.control.send_signal")
@patch("tractor.checks.verbose_print")
def test_new_id_running(self, mock_verbose_print, mock_send_signal, *_):
"""
tractor is running
"""
actions.new_id()
mock_send_signal.assert_called_once_with("newnym")
mock_verbose_print.assert_called_once_with("You have a new ID", False)
class KillTor(unittest.TestCase):
"""
test case for kill_tor
"""
@patch("stem.util.term.format", return_value="No process to kill")
@patch("tractor.control.get_pid", return_value=None)
@patch("os.killpg")
@patch("tractor.checks.verbose_print")
def test_kill_tor_not_running(self, mock_verbose_print, mock_killpg, *_):
"""
tractor is not running
"""
actions.kill_tor()
mock_killpg.assert_not_called()
mock_verbose_print.assert_called_once_with("No process to kill", False)
@patch("stem.util.term.format", return_value="Process killed")
@patch("tractor.control.get_pid", return_value=5734)
@patch("os.getpgid", return_value=1234)
@patch("tractor.db.reset")
@patch("os.killpg")
@patch("tractor.checks.verbose_print")
def test_kill_tor_running(self, mock_verbose_print, mock_killpg, *_):
"""
tractor is running
"""
actions.kill_tor()
mock_killpg.assert_called_once_with(1234, signal.SIGTERM)
mock_verbose_print.assert_called_once_with("Process killed", False)
|
