/
test_controller.py
1203 lines (997 loc) · 40.8 KB
/
test_controller.py
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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import os
import functools
from os.path import join
from mock import Mock, patch
from six.moves import StringIO
from twisted.internet.interfaces import IReactorCore
from twisted.internet.interfaces import IListeningPort
from twisted.internet.interfaces import IStreamClientEndpoint
from twisted.internet.address import IPv4Address
from twisted.internet import defer, error, task
from twisted.python.failure import Failure
from twisted.trial import unittest
from twisted.test import proto_helpers
from txtorcon import TorConfig
from txtorcon import TorControlProtocol
from txtorcon import TorProcessProtocol
from txtorcon import launch
from txtorcon import connect
from txtorcon.controller import _is_non_public_numeric_address, Tor
from txtorcon.interface import ITorControlProtocol
from .util import TempDir
from zope.interface import implementer, directlyProvides
class FakeProcessTransport(proto_helpers.StringTransportWithDisconnection):
pid = -1
reactor = None
def signalProcess(self, signame):
assert self.reactor is not None
self.reactor.callLater(
0,
lambda: self.process_protocol.processEnded(
Failure(error.ProcessTerminated(signal=signame))
)
)
self.reactor.callLater(
0,
lambda: self.process_protocol.processExited(
Failure(error.ProcessTerminated(signal=signame))
)
)
def closeStdin(self):
self.process_protocol.outReceived(b"Bootstrap")
return
class FakeProcessTransportNeverBootstraps(FakeProcessTransport):
pid = -1
def closeStdin(self):
return
class FakeProcessTransportNoProtocol(FakeProcessTransport):
def closeStdin(self):
pass
@implementer(IListeningPort)
class FakePort(object):
def __init__(self, port):
self._port = port
def startListening(self):
pass
def stopListening(self):
pass
def getHost(self):
return IPv4Address('TCP', "127.0.0.1", self._port)
@implementer(IReactorCore)
class FakeReactor(task.Clock):
def __init__(self, test, trans, on_protocol, listen_ports=[]):
super(FakeReactor, self).__init__()
self.test = test
self.transport = trans
self.transport.reactor = self # XXX FIXME this is a cycle now
self.on_protocol = on_protocol
self.listen_ports = listen_ports
# util.available_tcp_port ends up 'asking' for free ports via
# listenTCP, ultimately, and the answers we send back are from
# this list
def spawnProcess(self, processprotocol, bin, args, env, path,
uid=None, gid=None, usePTY=None, childFDs=None):
self.protocol = processprotocol
self.protocol.makeConnection(self.transport)
self.transport.process_protocol = processprotocol
self.on_protocol(self.protocol)
return self.transport
def addSystemEventTrigger(self, *args):
self.test.assertEqual(args[0], 'before')
self.test.assertEqual(args[1], 'shutdown')
# we know this is just for the temporary file cleanup, so we
# nuke it right away to avoid polluting /tmp by calling the
# callback now.
args[2]()
def removeSystemEventTrigger(self, id):
pass
def listenTCP(self, *args, **kw):
port = self.listen_ports.pop()
return FakePort(port)
def connectTCP(self, host, port, factory, timeout=0, bindAddress=None):
return
def connectUNIX(self, *args, **kw):
return
class LaunchTorTests(unittest.TestCase):
def setUp(self):
self.protocol = TorControlProtocol()
self.protocol.connectionMade = lambda: None
self.transport = proto_helpers.StringTransport()
self.protocol.makeConnection(self.transport)
self.clock = task.Clock()
def test_ctor_timeout_no_ireactortime(self):
with self.assertRaises(RuntimeError) as ctx:
TorProcessProtocol(lambda: None, timeout=42)
self.assertTrue("Must supply an IReactorTime" in str(ctx.exception))
def _fake_queue(self, cmd):
if cmd.split()[0] == 'PROTOCOLINFO':
return defer.succeed('AUTH METHODS=NULL')
elif cmd == 'GETINFO config/names':
return defer.succeed('config/names=')
elif cmd == 'GETINFO signal/names':
return defer.succeed('signal/names=')
elif cmd == 'GETINFO version':
return defer.succeed('version=0.1.2.3')
elif cmd == 'GETINFO events/names':
return defer.succeed('events/names=STATUS_CLIENT')
return defer.succeed(None)
def _fake_event_listener(self, what, cb):
if what == 'STATUS_CLIENT':
# should ignore non-BOOTSTRAP messages
cb('STATUS_CLIENT not-bootstrap')
cb('STATUS_CLIENT BOOTSTRAP PROGRESS=100 TAG=foo SUMMARY=bar')
return defer.succeed(None)
@defer.inlineCallbacks
def test_launch_tor_unix_controlport(self):
trans = FakeProcessTransport()
trans.protocol = self.protocol
self.protocol.post_bootstrap.callback(self.protocol)
self.protocol._set_valid_events("STATUS_CLIENT")
self.protocol.add_event_listener = self._fake_event_listener
self.protocol.queue_command = self._fake_queue
def on_protocol(proto):
proto.outReceived(b'Bootstrapped 90%\n')
# launch() auto-discovers a SOCKS port
reactor = FakeReactor(self, trans, on_protocol, [9050])
reactor.connectUNIX = Mock()
# prepare a suitable directory for tor unix socket
with TempDir() as tmp:
tmpdir = str(tmp)
os.chmod(tmpdir, 0o0700)
socket_file = join(tmpdir, 'test_socket_file')
with patch('txtorcon.controller.UNIXClientEndpoint') as uce:
endpoint = Mock()
endpoint.connect = Mock(return_value=defer.succeed(self.protocol))
uce.return_value = endpoint
yield launch(
reactor,
control_port="unix:{}".format(socket_file),
tor_binary="/bin/echo",
stdout=Mock(),
stderr=Mock(),
)
self.assertTrue(endpoint.connect.called)
self.assertTrue(uce.called)
self.assertEqual(
socket_file,
uce.mock_calls[0][1][1],
)
@defer.inlineCallbacks
def test_launch_tor_unix_controlport_wrong_perms(self):
reactor = FakeReactor(self, Mock(), None, [9050])
with self.assertRaises(ValueError) as ctx:
with TempDir() as tmp:
tmpdir = str(tmp)
os.chmod(tmpdir, 0o0777)
socket_file = join(tmpdir, 'socket_test')
yield launch(
reactor,
control_port="unix:{}".format(socket_file),
tor_binary="/bin/echo",
stdout=Mock(),
stderr=Mock(),
)
self.assertTrue(
"must only be readable by the user" in str(ctx.exception)
)
@defer.inlineCallbacks
def test_launch_tor_unix_controlport_no_directory(self):
reactor = FakeReactor(self, Mock(), None, [9050])
with self.assertRaises(ValueError) as ctx:
socket_file = '/does/not/exist'
yield launch(
reactor,
control_port="unix:{}".format(socket_file),
tor_binary="/bin/echo",
stdout=Mock(),
stderr=Mock(),
)
self.assertTrue("must exist" in str(ctx.exception))
@patch('txtorcon.controller.find_tor_binary', return_value='/bin/echo')
@defer.inlineCallbacks
def test_launch_fails(self, ftb):
trans = FakeProcessTransport()
def on_proto(protocol):
protocol.processEnded(
Failure(error.ProcessTerminated(12, None, 'statusFIXME'))
)
reactor = FakeReactor(self, trans, on_proto, [1234, 9052])
try:
yield launch(reactor)
self.fail("Should fail")
except RuntimeError:
pass
errs = self.flushLoggedErrors(RuntimeError)
self.assertEqual(1, len(errs))
self.assertTrue(
"Tor exited with error-code 12" in str(errs[0])
)
@defer.inlineCallbacks
def test_launch_no_ireactorcore(self):
try:
yield launch(None)
self.fail("should get exception")
except ValueError as e:
self.assertTrue("provide IReactorCore" in str(e))
@patch('txtorcon.controller.find_tor_binary', return_value='/bin/echo')
@patch('txtorcon.controller.TorProcessProtocol')
@defer.inlineCallbacks
def test_successful_launch(self, tpp, ftb):
trans = FakeProcessTransport()
reactor = FakeReactor(self, trans, lambda p: None, [1, 2, 3])
config = TorConfig()
def boot(arg=None):
config.post_bootstrap.callback(config)
config.__dict__['bootstrap'] = Mock(side_effect=boot)
config.__dict__['attach_protocol'] = Mock(return_value=defer.succeed(None))
def foo(*args, **kw):
rtn = Mock()
rtn.post_bootstrap = defer.succeed(None)
rtn.when_connected = Mock(return_value=defer.succeed(rtn))
return rtn
tpp.side_effect = foo
tor = yield launch(reactor, _tor_config=config)
self.assertTrue(isinstance(tor, Tor))
@defer.inlineCallbacks
def test_quit(self):
tor = Tor(Mock(), Mock())
tor._protocol = Mock()
tor._process_protocol = Mock()
yield tor.quit()
@defer.inlineCallbacks
def test_quit_no_protocol(self):
tor = Tor(Mock(), Mock())
tor._protocol = None
tor._process_protocol = None
with self.assertRaises(RuntimeError) as ctx:
yield tor.quit()
self.assertTrue('no protocol instance' in str(ctx.exception))
@patch('txtorcon.controller.socks')
@defer.inlineCallbacks
def test_dns_resolve(self, fake_socks):
answer = object()
cfg = Mock()
proto = Mock()
proto.get_conf = Mock(return_value=defer.succeed({"SocksPort": "9050"}))
tor = Tor(Mock(), proto, _tor_config=cfg)
fake_socks.resolve = Mock(return_value=defer.succeed(answer))
ans = yield tor.dns_resolve("meejah.ca")
self.assertEqual(ans, answer)
@patch('txtorcon.controller.socks')
@defer.inlineCallbacks
def test_dns_resolve_existing_socks(self, fake_socks):
answer = object()
proto = Mock()
proto.get_conf = Mock(return_value=defer.succeed({"SocksPort": "9050"}))
tor = Tor(Mock(), proto)
fake_socks.resolve = Mock(return_value=defer.succeed(answer))
ans0 = yield tor.dns_resolve("meejah.ca")
# do it again to exercise the _default_socks_port() case when
# we already got the default
fake_socks.resolve = Mock(return_value=defer.succeed(answer))
ans1 = yield tor.dns_resolve("meejah.ca")
self.assertEqual(ans0, answer)
self.assertEqual(ans1, answer)
@patch('txtorcon.controller.socks')
@defer.inlineCallbacks
def test_dns_resolve_no_configured_socks(self, fake_socks):
answer = object()
proto = Mock()
proto.get_conf = Mock(return_value=defer.succeed({"SocksPort": "9050"}))
cfg = Mock()
tor = Tor(Mock(), proto, _tor_config=cfg)
def boom(*args, **kw):
raise RuntimeError("no socks")
cfg.socks_endpoint = Mock(side_effect=boom)
fake_socks.resolve = Mock(return_value=defer.succeed(answer))
ans = yield tor.dns_resolve("meejah.ca")
self.assertEqual(ans, answer)
@patch('txtorcon.controller.socks')
@defer.inlineCallbacks
def test_dns_resolve_ptr(self, fake_socks):
answer = object()
proto = Mock()
proto.get_conf = Mock(return_value=defer.succeed({"SocksPort": "9050"}))
tor = Tor(Mock(), proto)
fake_socks.resolve_ptr = Mock(return_value=defer.succeed(answer))
ans = yield tor.dns_resolve_ptr("4.3.2.1")
self.assertEqual(ans, answer)
@patch('txtorcon.controller.find_tor_binary', return_value='/bin/echo')
@defer.inlineCallbacks
def test_successful_launch_tcp_control(self, ftb):
"""
full end-to-end test of a launch, faking things out at a "lower
level" than most of the other tests
"""
trans = FakeProcessTransport()
def on_protocol(proto):
pass
reactor = FakeReactor(self, trans, on_protocol, [1, 2, 3])
def connect_tcp(host, port, factory, timeout=0, bindAddress=None):
addr = Mock()
factory.doStart()
proto = factory.buildProtocol(addr)
tpp = proto._wrappedProtocol
tpp.add_event_listener = self._fake_event_listener
tpp.queue_command = self._fake_queue
proto.makeConnection(Mock())
return proto
reactor.connectTCP = connect_tcp
config = TorConfig()
tor = yield launch(reactor, _tor_config=config, control_port='1234', timeout=30)
self.assertTrue(isinstance(tor, Tor))
@patch('txtorcon.controller.find_tor_binary', return_value='/bin/echo')
@patch('txtorcon.controller.sys')
@patch('txtorcon.controller.TorProcessProtocol')
@defer.inlineCallbacks
def test_successful_launch_tcp_control_non_unix(self, tpp, _sys, ftb):
_sys.platform = 'not darwin or linux2'
trans = FakeProcessTransport()
reactor = FakeReactor(self, trans, lambda p: None, [1, 2, 3])
config = TorConfig()
def boot(arg=None):
config.post_bootstrap.callback(config)
config.__dict__['bootstrap'] = Mock(side_effect=boot)
config.__dict__['attach_protocol'] = Mock(return_value=defer.succeed(None))
def foo(*args, **kw):
rtn = Mock()
rtn.post_bootstrap = defer.succeed(None)
rtn.when_connected = Mock(return_value=defer.succeed(rtn))
return rtn
tpp.side_effect = foo
tor = yield launch(reactor, _tor_config=config)
self.assertTrue(isinstance(tor, Tor))
@patch('txtorcon.controller.sys')
@patch('txtorcon.controller.pwd')
@patch('txtorcon.controller.os.geteuid')
@patch('txtorcon.controller.os.chown')
def test_launch_root_changes_tmp_ownership(self, chown, euid, _pwd, _sys):
_pwd.return_value = 1000
_sys.platform = 'linux2'
euid.return_value = 0
reactor = Mock()
directlyProvides(reactor, IReactorCore)
# note! we're providing enough options here that we react the
# "chown" before any 'yield' statements in launch, so we don't
# actually have to wait for it... a little rickety, though :/
launch(reactor, tor_binary='/bin/echo', user='chuffington', socks_port='1234')
self.assertEqual(1, chown.call_count)
@defer.inlineCallbacks
def test_launch_timeout_exception(self):
"""
we provide a timeout, and it expires
"""
trans = Mock()
trans.signalProcess = Mock(side_effect=error.ProcessExitedAlready)
trans.loseConnection = Mock()
on_proto = Mock()
react = FakeReactor(self, trans, on_proto, [1234])
def creator():
return defer.succeed(Mock())
d = launch(
reactor=react,
tor_binary='/bin/echo',
socks_port=1234,
timeout=10,
connection_creator=creator,
)
react.advance(12)
self.assertTrue(trans.loseConnection.called)
with self.assertRaises(RuntimeError) as ctx:
yield d
self.assertTrue("timeout while launching" in str(ctx.exception))
@defer.inlineCallbacks
def test_launch_timeout_process_exits(self):
# cover the "one more edge case" where we get a processEnded()
# but we've already "done" a timeout.
trans = Mock()
trans.signalProcess = Mock()
trans.loseConnection = Mock()
class MyFakeReactor(FakeReactor):
def spawnProcess(self, processprotocol, bin, args, env, path,
uid=None, gid=None, usePTY=None, childFDs=None):
self.protocol = processprotocol
self.protocol.makeConnection(self.transport)
self.transport.process_protocol = processprotocol
self.on_protocol(self.protocol)
status = Mock()
status.value.exitCode = None
processprotocol.processEnded(status)
return self.transport
react = MyFakeReactor(self, trans, Mock(), [1234, 9052])
d = launch(
reactor=react,
tor_binary='/bin/echo',
timeout=10,
data_directory='/dev/null',
)
react.advance(20)
try:
yield d
except RuntimeError as e:
self.assertTrue("Tor was killed" in str(e))
errs = self.flushLoggedErrors(RuntimeError)
self.assertEqual(1, len(errs))
self.assertTrue("Tor was killed" in str(errs[0]))
@defer.inlineCallbacks
def test_launch_wrong_stdout(self):
try:
yield launch(
FakeReactor(self, Mock(), Mock()),
stdout=object(),
tor_binary='/bin/echo',
)
self.fail("Should have thrown an error")
except RuntimeError as e:
self.assertTrue("file-like object needed" in str(e).lower())
@defer.inlineCallbacks
def test_launch_with_timeout(self):
# XXX not entirely sure what this was/is supposed to be
# testing, but it covers an extra 7 lines of code??
timeout = 5
def connector(proto, trans):
proto._set_valid_events('STATUS_CLIENT')
proto.makeConnection(trans)
proto.post_bootstrap.callback(proto)
return proto.post_bootstrap
def on_protocol(proto):
proto.outReceived(b'Bootstrapped 100%\n')
trans = FakeProcessTransportNeverBootstraps()
trans.protocol = self.protocol
creator = functools.partial(connector, Mock(), Mock())
react = FakeReactor(self, trans, on_protocol, [1234, 9052])
with self.assertRaises(RuntimeError) as ctx:
d = launch(react, connection_creator=creator,
timeout=timeout, tor_binary='/bin/echo')
# FakeReactor is a task.Clock subclass and +1 just to be sure
react.advance(timeout + 1)
yield d
self.assertTrue(
'timeout while launching Tor' in str(ctx.exception)
)
# could/should just use return from this to do asserts?
self.flushLoggedErrors(RuntimeError)
@defer.inlineCallbacks
def test_tor_produces_stderr_output(self):
def connector(proto, trans):
proto._set_valid_events('STATUS_CLIENT')
proto.makeConnection(trans)
proto.post_bootstrap.callback(proto)
return proto.post_bootstrap
def on_protocol(proto):
proto.errReceived('Something went horribly wrong!\n')
trans = FakeProcessTransport()
trans.protocol = Mock()
fakeout = StringIO()
fakeerr = StringIO()
creator = functools.partial(connector, Mock(), Mock())
try:
yield launch(
FakeReactor(self, trans, on_protocol, [1234, 9052]),
connection_creator=creator,
tor_binary='/bin/echo',
stdout=fakeout,
stderr=fakeerr,
)
self.fail() # should't get callback
except RuntimeError as e:
self.assertEqual('', fakeout.getvalue())
self.assertEqual('Something went horribly wrong!\n', fakeerr.getvalue())
self.assertTrue(
'Something went horribly wrong!' in str(e)
)
@patch('txtorcon.controller.find_tor_binary', return_value='/bin/echo')
@defer.inlineCallbacks
def test_tor_connection_fails(self, ftb):
trans = FakeProcessTransport()
def on_protocol(proto):
proto.outReceived(b'Bootstrapped 100%\n')
reactor = FakeReactor(self, trans, on_protocol, [1, 2, 3])
fails = ['one']
def connect_tcp(host, port, factory, timeout=0, bindAddress=None):
if len(fails):
fails.pop()
raise error.CannotListenError('on-purpose-error', None, None)
addr = Mock()
factory.doStart()
proto = factory.buildProtocol(addr)
tpp = proto._wrappedProtocol
def fake_event_listener(what, cb):
if what == 'STATUS_CLIENT':
# should ignore non-BOOTSTRAP messages
cb('STATUS_CLIENT not-bootstrap')
cb('STATUS_CLIENT BOOTSTRAP PROGRESS=100 TAG=foo SUMMARY=bar')
return defer.succeed(None)
tpp.add_event_listener = fake_event_listener
def fake_queue(cmd):
if cmd.split()[0] == 'PROTOCOLINFO':
return defer.succeed('AUTH METHODS=NULL')
elif cmd == 'GETINFO config/names':
return defer.succeed('config/names=')
elif cmd == 'GETINFO signal/names':
return defer.succeed('signal/names=')
elif cmd == 'GETINFO version':
return defer.succeed('version=0.1.2.3')
elif cmd == 'GETINFO events/names':
return defer.succeed('events/names=STATUS_CLIENT')
return defer.succeed(None)
tpp.queue_command = fake_queue
proto.makeConnection(Mock())
return proto
reactor.connectTCP = connect_tcp
config = TorConfig()
tor = yield launch(reactor, _tor_config=config, control_port='1234', timeout=30)
errs = self.flushLoggedErrors()
self.assertTrue(isinstance(tor, Tor))
self.assertEqual(1, len(errs))
def test_tor_connection_user_data_dir(self):
"""
Test that we don't delete a user-supplied data directory.
"""
config = TorConfig()
config.OrPort = 1234
class Connector:
def __call__(self, proto, trans):
proto._set_valid_events('STATUS_CLIENT')
proto.makeConnection(trans)
proto.post_bootstrap.callback(proto)
return proto.post_bootstrap
def on_protocol(proto):
proto.outReceived(b'Bootstrapped 90%\n')
with TempDir() as tmp:
my_dir = str(tmp)
config.DataDirectory = my_dir
trans = FakeProcessTransport()
trans.protocol = self.protocol
creator = functools.partial(Connector(), self.protocol, self.transport)
d = launch(
FakeReactor(self, trans, on_protocol, [1234, 9051]),
connection_creator=creator,
tor_binary='/bin/echo',
data_directory=my_dir,
control_port=0,
)
def still_have_data_dir(tor, tester):
tor._process_protocol.cleanup() # FIXME? not really unit-testy as this is sort of internal function
tester.assertTrue(os.path.exists(my_dir))
d.addCallback(still_have_data_dir, self)
d.addErrback(self.fail)
return d
def _test_tor_connection_user_control_port(self):
"""
Confirm we use a user-supplied control-port properly
"""
config = TorConfig()
config.OrPort = 1234
config.ControlPort = 4321
class Connector:
def __call__(self, proto, trans):
proto._set_valid_events('STATUS_CLIENT')
proto.makeConnection(trans)
proto.post_bootstrap.callback(proto)
return proto.post_bootstrap
def on_protocol(proto):
proto.outReceived(b'Bootstrapped 90%\n')
proto.outReceived(b'Bootstrapped 100%\n')
trans = FakeProcessTransport()
trans.protocol = self.protocol
creator = functools.partial(Connector(), self.protocol, self.transport)
d = launch(
FakeReactor(self, trans, on_protocol, [9052]),
connection_creator=creator,
tor_binary='/bin/echo',
socks_port=1234,
)
def check_control_port(proto, tester):
# we just want to ensure launch() didn't mess with
# the controlport we set
tester.assertEqual(config.ControlPort, 4321)
d.addCallback(check_control_port, self)
d.addErrback(self.fail)
return d
@defer.inlineCallbacks
def _test_tor_connection_default_control_port(self):
"""
Confirm a default control-port is set if not user-supplied.
"""
class Connector:
def __call__(self, proto, trans):
proto._set_valid_events('STATUS_CLIENT')
proto.makeConnection(trans)
proto.post_bootstrap.callback(proto)
return proto.post_bootstrap
def on_protocol(proto):
proto.outReceived(b'Bootstrapped 90%\n')
proto.outReceived(b'Bootstrapped 100%\n')
trans = FakeProcessTransport()
trans.protocol = self.protocol
creator = functools.partial(Connector(), self.protocol, self.transport)
tor = yield launch(
FakeReactor(self, trans, on_protocol, [9052]),
connection_creator=creator,
tor_binary='/bin/echo',
socks_port=1234,
)
cfg = yield tor.get_config()
self.assertEqual(cfg.ControlPort, 9052)
def test_progress_updates(self):
self.got_progress = False
def confirm_progress(p, t, s):
self.assertEqual(p, 10)
self.assertEqual(t, 'tag')
self.assertEqual(s, 'summary')
self.got_progress = True
process = TorProcessProtocol(None, confirm_progress)
process.progress(10, 'tag', 'summary')
self.assertTrue(self.got_progress)
def test_quit_process(self):
process = TorProcessProtocol(None)
process.transport = Mock()
d = process.quit()
self.assertFalse(d.called)
process.processExited(Failure(error.ProcessTerminated(exitCode=15)))
self.assertTrue(d.called)
process.processEnded(Failure(error.ProcessDone(None)))
self.assertTrue(d.called)
errs = self.flushLoggedErrors()
self.assertEqual(1, len(errs))
self.assertTrue("Tor exited with error-code" in str(errs[0]))
def test_quit_process_already(self):
process = TorProcessProtocol(None)
process.transport = Mock()
def boom(sig):
self.assertEqual(sig, 'TERM')
raise error.ProcessExitedAlready()
process.transport.signalProcess = Mock(side_effect=boom)
d = process.quit()
process.processEnded(Failure(error.ProcessDone(None)))
self.assertTrue(d.called)
errs = self.flushLoggedErrors()
self.assertEqual(1, len(errs))
self.assertTrue("Tor exited with error-code" in str(errs[0]))
@defer.inlineCallbacks
def test_quit_process_error(self):
process = TorProcessProtocol(None)
process.transport = Mock()
def boom(sig):
self.assertEqual(sig, 'TERM')
raise RuntimeError("Something bad")
process.transport.signalProcess = Mock(side_effect=boom)
try:
yield process.quit()
except RuntimeError as e:
self.assertEqual("Something bad", str(e))
def XXXtest_status_updates(self):
process = TorProcessProtocol(None)
process.status_client("NOTICE CONSENSUS_ARRIVED")
def XXXtest_tor_launch_success_then_shutdown(self):
"""
There was an error where we double-callbacked a deferred,
i.e. success and then shutdown. This repeats it.
"""
process = TorProcessProtocol(None)
process.status_client(
'STATUS_CLIENT BOOTSTRAP PROGRESS=100 TAG=foo SUMMARY=cabbage'
)
# XXX why this assert?
self.assertEqual(None, process._connected_cb)
class Value(object):
exitCode = 123
class Status(object):
value = Value()
process.processEnded(Status())
self.assertEqual(len(self.flushLoggedErrors(RuntimeError)), 1)
@defer.inlineCallbacks
def test_launch_no_control_port(self):
'''
See Issue #80. This allows you to launch tor with a TorConfig
with ControlPort=0 in case you don't want a control connection
at all. In this case you get back a TorProcessProtocol and you
own both pieces. (i.e. you have to kill it yourself).
'''
trans = FakeProcessTransportNoProtocol()
trans.protocol = self.protocol
def creator(*args, **kw):
print("Bad: connection creator called")
self.fail()
def on_protocol(proto):
self.process_proto = proto
proto.outReceived(b'Bootstrapped 90%\n')
proto.outReceived(b'Bootstrapped 100%\n')
reactor = FakeReactor(self, trans, on_protocol, [9052, 9999])
tor = yield launch(
reactor=reactor,
connection_creator=creator,
tor_binary='/bin/echo',
socks_port=1234,
control_port=0,
)
self.assertEqual(tor._process_protocol, self.process_proto)
d = tor.quit()
reactor.advance(0)
yield d
errs = self.flushLoggedErrors()
self.assertEqual(1, len(errs))
self.assertTrue("Tor was killed" in str(errs[0]))
def create_endpoint(*args, **kw):
ep = Mock()
directlyProvides(ep, IStreamClientEndpoint)
return ep
def create_endpoint_fails(*args, **kw):
def go_boom(*args, **kw):
raise RuntimeError("boom")
ep = Mock(side_effect=go_boom)
directlyProvides(ep, IStreamClientEndpoint)
return ep
class ConnectTorTests(unittest.TestCase):
@patch('txtorcon.controller.TorConfig')
@patch('txtorcon.controller.UNIXClientEndpoint', side_effect=create_endpoint)
@patch('txtorcon.controller.TCP4ClientEndpoint', side_effect=create_endpoint)
@defer.inlineCallbacks
def test_connect_defaults(self, fake_cfg, fake_unix, fake_tcp):
"""
happy-path test, ensuring there are no exceptions
"""
transport = Mock()
reactor = FakeReactor(self, transport, lambda: None)
yield connect(reactor)
@patch('txtorcon.controller.TorConfig')
@defer.inlineCallbacks
def test_connect_provide_endpoint(self, fake_cfg):
transport = Mock()
reactor = FakeReactor(self, transport, lambda: None)
ep = Mock()
with self.assertRaises(ValueError) as ctx:
yield connect(reactor, ep)
self.assertTrue('IStreamClientEndpoint' in str(ctx.exception))
@patch('txtorcon.controller.TorConfig')
@defer.inlineCallbacks
def test_connect_provide_multiple_endpoints(self, fake_cfg):
transport = Mock()
reactor = FakeReactor(self, transport, lambda: None)
ep0 = Mock()
ep1 = Mock()
with self.assertRaises(ValueError) as ctx:
yield connect(reactor, [ep0, ep1])
self.assertTrue('IStreamClientEndpoint' in str(ctx.exception))
@patch('txtorcon.controller.TorConfig')
@defer.inlineCallbacks
def test_connect_multiple_endpoints_error(self, fake_cfg):
transport = Mock()
reactor = FakeReactor(self, transport, lambda: None)
ep0 = Mock()
def boom(*args, **kw):
raise RuntimeError("the bad thing")
ep0.connect = boom
directlyProvides(ep0, IStreamClientEndpoint)
with self.assertRaises(RuntimeError) as ctx:
yield connect(reactor, ep0)
self.assertEqual("the bad thing", str(ctx.exception))
@patch('txtorcon.controller.TorConfig')
@defer.inlineCallbacks
def test_connect_multiple_endpoints_many_errors(self, fake_cfg):
transport = Mock()
reactor = FakeReactor(self, transport, lambda: None)
ep0 = Mock()
ep1 = Mock()
def boom0(*args, **kw):
raise RuntimeError("the bad thing")
def boom1(*args, **kw):
raise RuntimeError("more sadness")
ep0.connect = boom0
ep1.connect = boom1
directlyProvides(ep0, IStreamClientEndpoint)
directlyProvides(ep1, IStreamClientEndpoint)
with self.assertRaises(RuntimeError) as ctx:
yield connect(reactor, [ep0, ep1])
self.assertTrue("the bad thing" in str(ctx.exception))
self.assertTrue("more sadness" in str(ctx.exception))
@patch('txtorcon.controller.TorConfig')
@defer.inlineCallbacks
def test_connect_success(self, fake_cfg):
transport = Mock()
reactor = FakeReactor(self, transport, lambda: None)
torcfg = Mock()
fake_cfg.from_protocol = Mock(return_value=torcfg)
ep0 = Mock()
proto = object()
torcfg.protocol = proto
ep0.connect = Mock(return_value=proto)
directlyProvides(ep0, IStreamClientEndpoint)
ans = yield connect(reactor, [ep0])
cfg = yield ans.get_config()
self.assertEqual(cfg, torcfg)
self.assertEqual(ans.protocol, proto)
class WebAgentTests(unittest.TestCase):
def setUp(self):
proto = Mock()
self.pool = Mock()
self.expected_response = object()
proto.request = Mock(return_value=defer.succeed(self.expected_response))
self.pool.getConnection = Mock(return_value=defer.succeed(proto))
@defer.inlineCallbacks
def test_web_agent_defaults(self):
reactor = Mock()
# XXX is there a faster way to do this? better reactor fake?
fake_host = Mock()
fake_host.port = 1234
fake_port = Mock()
fake_port.getHost = Mock(return_value=fake_host)
reactor.listenTCP = Mock(return_value=fake_port)
cfg = Mock()
cfg.create_socks_endpoint = Mock(return_value=defer.succeed("9050"))
proto = Mock()
proto.get_conf = Mock(return_value=defer.succeed({}))
directlyProvides(proto, ITorControlProtocol)
tor = Tor(reactor, proto, _tor_config=cfg)
try:
agent = tor.web_agent(pool=self.pool)
except ImportError as e:
if 'IAgentEndpointFactory' in str(e):
print("Skipping; appears we don't have web support")
return
resp = yield agent.request('GET', b'meejah.ca')
self.assertEqual(self.expected_response, resp)
@defer.inlineCallbacks
def test_web_agent_deferred(self):
socks_d = defer.succeed("9151")
reactor = Mock()