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
|
from zope.interface import implementer
from twisted.trial import unittest
from twisted.test import proto_helpers
from twisted.internet import defer
from txtorcon import ITorControlProtocol, TorInfo, TorControlProtocol
@implementer(ITorControlProtocol)
class FakeControlProtocol:
def __init__(self, answers):
self.answers = answers
self.pending = []
self.post_bootstrap = defer.succeed(self)
def get_info_raw(self, info):
if len(self.answers) == 0:
d = defer.Deferred()
self.pending.append(d)
return d
d = defer.succeed(self.answers[0])
self.answers = self.answers[1:]
return d
get_info = get_info_raw
class CheckAnswer:
def __init__(self, test, ans):
self.answer = ans
self.test = test
def __call__(self, x):
self.test.assertEqual(x, self.answer)
class MagicContainerTests(unittest.TestCase):
def test_repr(self):
from txtorcon.torinfo import MagicContainer
m = MagicContainer('foo')
self.assertTrue(repr(m) == 'foo')
self.assertTrue(str(m) == 'foo')
m._setup_complete()
self.assertTrue(repr(m) == 'foo')
self.assertTrue(str(m) == 'foo')
class ProtocolIntegrationTests(unittest.TestCase):
"""
Tests which use a real TorControlProtocol objects, not a mock.
"""
def setUp(self):
self.protocol = TorControlProtocol(lambda: defer.succeed('foo'))
self.transport = proto_helpers.StringTransport()
def send(self, line):
self.protocol.dataReceived(line.strip() + b"\r\n")
@defer.inlineCallbacks
def test_with_arg(self):
info = TorInfo(self.protocol)
pb = info.post_bootstrap
# now we hook up the protocol like it connected to a real Tor
self.protocol.makeConnection(self.transport)
# answer all the requests generated by TorControlProtocol
# boostrapping etc.
self.send(b'250-AUTH METHODS=HASHEDPASSWORD')
self.send(b'250 OK')
# response to AUTHENTICATE
self.send(b'250 OK')
# now we're in _bootstrap() in TorControlProtocol()
self.send(b"250-signal/names=")
self.send(b"250 OK")
self.send(b"250-version=foo")
self.send(b"250 OK")
self.send(b"250-events/names=")
self.send(b"250 OK")
self.send(b"250 OK") # for USEFEATURE
# do the TorInfo magic
self.send(b'250-info/names=')
self.send(b'250-multi/path/arg/* a documentation string')
self.send(b'250 OK')
# we had to save this up above due to the "interesting" way
# TorInfo switches to become a possible-nice magic thingy
# that does attribute-access for you.
yield pb
self.assertTrue(hasattr(info, 'multi'))
self.assertTrue(hasattr(getattr(info, 'multi'), 'path'))
self.assertTrue(
hasattr(getattr(getattr(info, 'multi'), 'path'), 'arg')
)
# Finally! The test! We see if we can get this multi-path
# value with an argument...
# a "real" tor example is "net/listeners/socks" which shows
# up in info/names as "net/listeners/*"
d = info.multi.path.arg('quux')
d.addCallback(CheckAnswer(self, 'foo'))
self.send(b"250-multi/path/arg/quux=foo")
self.send(b"250 OK")
yield d
class InfoTests(unittest.TestCase):
def setUp(self):
self.protocol = FakeControlProtocol([])
def test_simple(self):
self.protocol.answers.append('''info/names=
something a documentation string
multi/path a documentation string
''')
info = TorInfo(self.protocol)
self.assertTrue(hasattr(info, 'something'))
self.assertTrue(hasattr(info, 'multi'))
self.assertTrue(hasattr(getattr(info, 'multi'), 'path'))
self.protocol.answers.append('something=\nfoo')
d = info.something()
d.addCallback(CheckAnswer(self, 'foo'))
return d
def test_same_prefix(self):
self.protocol.answers.append('''info/names=
something/one a documentation string
something/two a second documentation string
''')
info = TorInfo(self.protocol)
self.assertTrue(hasattr(info, 'something'))
self.assertTrue(hasattr(info.something, 'one'))
self.assertTrue(hasattr(info.something, 'two'))
self.protocol.answers.append('something/two=bar')
d = info.something.two()
d.addCallback(CheckAnswer(self, 'bar'))
return d
@defer.inlineCallbacks
def test_attribute_access(self):
'''
test that our post-setup TorInfo pretends to only have
attributes that correspond to (valid) GETINFO calls.
'''
self.protocol.answers.append('''info/names=
something/one a documentation string
something/two a second documentation string
''')
info = TorInfo(self.protocol)
yield self.protocol.post_bootstrap
self.assertTrue('something' in dir(info))
self.assertTrue(dir(info.something) == ['one', 'two'] or
dir(info.something) == ['two', 'one'])
def test_member_access(self):
self.protocol.answers.append('info/names blam a thinkg\r\n')
info = TorInfo(self.protocol)
from txtorcon import torinfo
c = torinfo.MagicContainer(None)
c._setup = True
self.assertEqual([], c.__members__)
self.assertEqual(['info'], info.__members__)
# make sure __magic__ attr access doesn't throw
c.__class__
self.assertRaises(AttributeError, lambda: c.foo_mc_bar_bar)
def test_iterator_access(self):
'''
confirm we can use the iterator protocol
'''
self.protocol.answers.append('''info/names=
something/one a documentation string
something/two a second documentation string
''')
info = TorInfo(self.protocol)
self.assertTrue(len(info) == 1)
all = []
for x in info:
all.append(x)
self.assertTrue(len(all) == 1)
self.assertTrue(len(info.something) == 2)
all = []
for x in info.something:
all.append(x)
self.assertTrue(len(all) == 2)
def test_accessors_not_setup(self):
info = TorInfo(self.protocol)
self.assertTrue(info.__dict__['_setup'] is False)
self.assertRaises(TypeError, len, info)
dir(info)
try:
info[0]
self.fail("Should have raised TypeError")
except TypeError:
pass
def handle_error(self, f):
if 'Already had something' in f.getErrorMessage():
self.error_happened = True
def test_prefix_error(self):
self.protocol.answers.append('''info/names=
something not allowed I hope
something/one a documentation string
''')
self.error_happened = False
TorInfo(self.protocol, self.handle_error)
self.assertTrue(self.error_happened)
def test_prefix_error_other_order(self):
self.protocol.answers.append('''info/names=
other/one a documentation string
other not allowed I hope
''')
self.error_happened = False
TorInfo(self.protocol, self.handle_error)
self.assertTrue(self.error_happened)
def test_with_arg(self):
self.protocol.answers.append('''info/names=
multi/path/arg/* a documentation string
''')
info = TorInfo(self.protocol)
self.assertTrue(hasattr(info, 'multi'))
self.assertTrue(hasattr(getattr(info, 'multi'), 'path'))
self.assertTrue(
hasattr(getattr(getattr(info, 'multi'), 'path'), 'arg')
)
# FIXME should have a test that "really" goes out through
# TorControlProtocol instance for this stuff...
# TorControlProtocol now strips the OK line...
self.protocol.answers.append('multi/path/arg/quux=\nbar\nbaz\nquux')
try:
info.multi.path.arg()
self.assertTrue(False)
except TypeError:
pass
d = info.multi.path.arg('quux')
d.addCallback(CheckAnswer(self, 'bar\nbaz\nquux'))
return d
def test_with_arg_error(self):
self.protocol.answers.append('''info/names=
multi/no-arg docstring
''')
info = TorInfo(self.protocol)
try:
info.multi.no_arg('an argument')
self.assertTrue(False)
except TypeError:
pass
def test_dump(self):
self.protocol.answers.append('''info/names=
multi/path/arg/* a documentation string
''')
info = TorInfo(self.protocol)
info.dump()
def test_config_star_workaround(self):
'''
ensure we ignore config/* for now
'''
self.protocol.answers.append('''info/names=
config/* a documentation string
''')
info = TorInfo(self.protocol)
self.assertEqual(dir(info), [])
def test_other_bootstrap(self):
self.protocol.answers.append('''info/names=
multi/path/arg/* a documentation string
''')
self.protocol.post_bootstrap = None
TorInfo(self.protocol)
def test_str(self):
'''rather silly test to cover string creation'''
self.protocol.answers.append('''info/names=
version docstring
foo/* bar
''')
info = TorInfo(self.protocol)
# not the end of the world if this fails
self.assertTrue(str(info.version) == "version()")
self.assertTrue(str(info.foo) == "foo(arg)")
|