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
|
"""
Tests for L{eliot._generators}.
"""
from pprint import pformat
from unittest import TestCase
from eliot import Message, start_action
from ..testing import capture_logging, assertHasAction
from .._generators import eliot_friendly_generator_function
def assert_expected_action_tree(
testcase, logger, expected_action_type, expected_type_tree
):
"""
Assert that a logger has a certain logged action with certain children.
@see: L{assert_generator_logs_action_tree}
"""
logged_action = assertHasAction(testcase, logger, expected_action_type, True)
type_tree = logged_action.type_tree()
testcase.assertEqual(
{expected_action_type: expected_type_tree},
type_tree,
"Logger had messages:\n{}".format(pformat(logger.messages, indent=4)),
)
def assert_generator_logs_action_tree(
testcase, generator_function, logger, expected_action_type, expected_type_tree
):
"""
Assert that exhausting a generator from the given function logs an action
of the given type with children matching the given type tree.
@param testcase: A test case instance to use to make assertions.
@type testcase: L{unittest.TestCase}
@param generator_function: A no-argument callable that returns a generator
to be exhausted.
@param logger: A logger to inspect for logged messages.
@type logger: L{MemoryLogger}
@param expected_action_type: An action type which should be logged by the
generator.
@type expected_action_type: L{unicode}
@param expected_type_tree: The types of actions and messages which should
be logged beneath the expected action. The structure of this value
matches the structure returned by L{LoggedAction.type_tree}.
@type expected_type_tree: L{list}
"""
list(eliot_friendly_generator_function(generator_function)())
assert_expected_action_tree(
testcase, logger, expected_action_type, expected_type_tree
)
class EliotFriendlyGeneratorFunctionTests(TestCase):
"""
Tests for L{eliot_friendly_generator_function}.
"""
# Get our custom assertion failure messages *and* the standard ones.
longMessage = True
@capture_logging(None)
def test_yield_none(self, logger):
@eliot_friendly_generator_function
def g():
Message.log(message_type="hello")
yield
Message.log(message_type="goodbye")
g.debug = True # output yielded messages
with start_action(action_type="the-action"):
list(g())
assert_expected_action_tree(
self, logger, "the-action", ["hello", "yielded", "goodbye"]
)
@capture_logging(None)
def test_yield_value(self, logger):
expected = object()
@eliot_friendly_generator_function
def g():
Message.log(message_type="hello")
yield expected
Message.log(message_type="goodbye")
g.debug = True # output yielded messages
with start_action(action_type="the-action"):
self.assertEqual([expected], list(g()))
assert_expected_action_tree(
self, logger, "the-action", ["hello", "yielded", "goodbye"]
)
@capture_logging(None)
def test_yield_inside_another_action(self, logger):
@eliot_friendly_generator_function
def g():
Message.log(message_type="a")
with start_action(action_type="confounding-factor"):
Message.log(message_type="b")
yield None
Message.log(message_type="c")
Message.log(message_type="d")
g.debug = True # output yielded messages
with start_action(action_type="the-action"):
list(g())
assert_expected_action_tree(
self,
logger,
"the-action",
["a", {"confounding-factor": ["b", "yielded", "c"]}, "d"],
)
@capture_logging(None)
def test_yield_inside_nested_actions(self, logger):
@eliot_friendly_generator_function
def g():
Message.log(message_type="a")
with start_action(action_type="confounding-factor"):
Message.log(message_type="b")
yield None
with start_action(action_type="double-confounding-factor"):
yield None
Message.log(message_type="c")
Message.log(message_type="d")
Message.log(message_type="e")
g.debug = True # output yielded messages
with start_action(action_type="the-action"):
list(g())
assert_expected_action_tree(
self,
logger,
"the-action",
[
"a",
{
"confounding-factor": [
"b",
"yielded",
{"double-confounding-factor": ["yielded", "c"]},
"d",
]
},
"e",
],
)
@capture_logging(None)
def test_generator_and_non_generator(self, logger):
@eliot_friendly_generator_function
def g():
Message.log(message_type="a")
yield
with start_action(action_type="action-a"):
Message.log(message_type="b")
yield
Message.log(message_type="c")
Message.log(message_type="d")
yield
g.debug = True # output yielded messages
with start_action(action_type="the-action"):
generator = g()
next(generator)
Message.log(message_type="0")
next(generator)
Message.log(message_type="1")
next(generator)
Message.log(message_type="2")
self.assertRaises(StopIteration, lambda: next(generator))
assert_expected_action_tree(
self,
logger,
"the-action",
[
"a",
"yielded",
"0",
{"action-a": ["b", "yielded", "c"]},
"1",
"d",
"yielded",
"2",
],
)
@capture_logging(None)
def test_concurrent_generators(self, logger):
@eliot_friendly_generator_function
def g(which):
Message.log(message_type="{}-a".format(which))
with start_action(action_type=which):
Message.log(message_type="{}-b".format(which))
yield
Message.log(message_type="{}-c".format(which))
Message.log(message_type="{}-d".format(which))
g.debug = True # output yielded messages
gens = [g("1"), g("2")]
with start_action(action_type="the-action"):
while gens:
for g in gens[:]:
try:
next(g)
except StopIteration:
gens.remove(g)
assert_expected_action_tree(
self,
logger,
"the-action",
[
"1-a",
{"1": ["1-b", "yielded", "1-c"]},
"2-a",
{"2": ["2-b", "yielded", "2-c"]},
"1-d",
"2-d",
],
)
@capture_logging(None)
def test_close_generator(self, logger):
@eliot_friendly_generator_function
def g():
Message.log(message_type="a")
try:
yield
Message.log(message_type="b")
finally:
Message.log(message_type="c")
g.debug = True # output yielded messages
with start_action(action_type="the-action"):
gen = g()
next(gen)
gen.close()
assert_expected_action_tree(self, logger, "the-action", ["a", "yielded", "c"])
@capture_logging(None)
def test_nested_generators(self, logger):
@eliot_friendly_generator_function
def g(recurse):
with start_action(action_type="a-recurse={}".format(recurse)):
Message.log(message_type="m-recurse={}".format(recurse))
if recurse:
set(g(False))
else:
yield
g.debug = True # output yielded messages
with start_action(action_type="the-action"):
set(g(True))
assert_expected_action_tree(
self,
logger,
"the-action",
[
{
"a-recurse=True": [
"m-recurse=True",
{"a-recurse=False": ["m-recurse=False", "yielded"]},
]
}
],
)
|
