Debian Codegraph @

tests/helpers/common/test_prog.py

raw
1 # Copyright (c) Meta Platforms, Inc. and affiliates.
2 # SPDX-License-Identifier: LGPL-2.1-or-later
3
4 import contextlib
5 import unittest.mock
6
7 from drgn import NoDefaultProgramError, Object, get_default_prog, set_default_prog
8 from drgn.helpers.common.prog import (
9 takes_object_or_program_or_default,
10 takes_program_or_default,
11 )
12 from tests import IdenticalMatcher, TestCase, mock_program
13
14
15 @contextlib.contextmanager
16 def mock_default_prog():
17 try:
18 old_default_prog = get_default_prog()
19 except NoDefaultProgramError:
20 old_default_prog = None
21 prog = mock_program()
22 try:
23 set_default_prog(prog)
24 yield prog
25 finally:
26 set_default_prog(old_default_prog)
27
28
29 class TestTakesProgramOrDefault(TestCase):
30 def setUp(self):
31 def f1(prog):
32 pass
33
34 self.mock1 = unittest.mock.create_autospec(f1)
35
36 def f2(prog, x):
37 pass
38
39 self.mock2 = unittest.mock.create_autospec(f2)
40
41 def f3(prog, x, s):
42 pass
43
44 self.mock3 = unittest.mock.create_autospec(f3)
45
46 def test_explicit_prog_no_args(self):
47 prog = mock_program()
48 takes_program_or_default(self.mock1)(prog)
49 self.mock1.assert_called_once_with(prog)
50
51 def test_explicit_prog_kwarg_no_args(self):
52 prog = mock_program()
53 takes_program_or_default(self.mock1)(prog=prog)
54 self.mock1.assert_called_once_with(prog=prog)
55
56 def test_default_prog_no_args(self):
57 with mock_default_prog() as prog:
58 takes_program_or_default(self.mock1)()
59 self.mock1.assert_called_once_with(prog)
60
61 def test_explicit_prog_one_arg(self):
62 prog = mock_program()
63 takes_program_or_default(self.mock2)(prog, 1)
64 self.mock2.assert_called_once_with(prog, 1)
65
66 def test_explicit_prog_one_kwarg(self):
67 prog = mock_program()
68 takes_program_or_default(self.mock2)(prog, x=1)
69 self.mock2.assert_called_once_with(prog, x=1)
70
71 def test_explicit_prog_kwarg_one_kwarg(self):
72 prog = mock_program()
73 takes_program_or_default(self.mock2)(prog=prog, x=1)
74 self.mock2.assert_called_once_with(prog=prog, x=1)
75
76 def test_object_prog_one_arg(self):
77 prog = mock_program()
78 takes_program_or_default(self.mock2)(Object(prog, "int", 1))
79 self.mock2.assert_called_once_with(
80 prog, IdenticalMatcher(Object(prog, "int", 1))
81 )
82
83 def test_object_prog_one_kwarg(self):
84 prog = mock_program()
85 takes_program_or_default(self.mock2)(x=Object(prog, "int", 1))
86 self.mock2.assert_called_once_with(
87 prog, x=IdenticalMatcher(Object(prog, "int", 1))
88 )
89
90 def test_default_prog_one_arg(self):
91 with mock_default_prog() as prog:
92 takes_program_or_default(self.mock2)(1)
93 self.mock2.assert_called_once_with(prog, 1)
94
95 def test_default_prog_one_kwarg(self):
96 with mock_default_prog() as prog:
97 takes_program_or_default(self.mock2)(x=1)
98 self.mock2.assert_called_once_with(prog, x=1)
99
100 def test_explicit_prog_two_args(self):
101 prog = mock_program()
102 takes_program_or_default(self.mock3)(prog, 1, "foo")
103 self.mock3.assert_called_once_with(prog, 1, "foo")
104
105 def test_explicit_prog_one_arg_one_kwarg(self):
106 prog = mock_program()
107 takes_program_or_default(self.mock3)(prog, 1, s="foo")
108 self.mock3.assert_called_once_with(prog, 1, s="foo")
109
110 def test_explicit_prog_two_kwargs(self):
111 prog = mock_program()
112 takes_program_or_default(self.mock3)(prog, x=1, s="foo")
113 self.mock3.assert_called_once_with(prog, x=1, s="foo")
114
115 def test_explicit_prog_kwarg_two_kwargs(self):
116 prog = mock_program()
117 takes_program_or_default(self.mock3)(prog=prog, x=1, s="foo")
118 self.mock3.assert_called_once_with(prog=prog, x=1, s="foo")
119
120 def test_object_prog_two_args(self):
121 prog = mock_program()
122 takes_program_or_default(self.mock3)(Object(prog, "int", 2), "foo")
123 self.mock3.assert_called_once_with(
124 prog, IdenticalMatcher(Object(prog, "int", 2)), "foo"
125 )
126
127 def test_object_prog_one_arg_one_kwarg(self):
128 prog = mock_program()
129 takes_program_or_default(self.mock3)(Object(prog, "int", 2), s="foo")
130 self.mock3.assert_called_once_with(
131 prog, IdenticalMatcher(Object(prog, "int", 2)), s="foo"
132 )
133
134 def test_object_prog_two_kwargs(self):
135 prog = mock_program()
136 takes_program_or_default(self.mock3)(x=Object(prog, "int", 2), s="foo")
137 self.mock3.assert_called_once_with(
138 prog, x=IdenticalMatcher(Object(prog, "int", 2)), s="foo"
139 )
140
141 def test_default_prog_two_args(self):
142 with mock_default_prog() as prog:
143 takes_program_or_default(self.mock3)(2, "foo")
144 self.mock3.assert_called_once_with(prog, 2, "foo")
145
146 def test_default_prog_one_arg_one_kwarg(self):
147 with mock_default_prog() as prog:
148 takes_program_or_default(self.mock3)(2, s="foo")
149 self.mock3.assert_called_once_with(prog, 2, s="foo")
150
151 def test_default_prog_two_kwargs(self):
152 with mock_default_prog() as prog:
153 takes_program_or_default(self.mock3)(x=2, s="foo")
154 self.mock3.assert_called_once_with(prog, x=2, s="foo")
155
156
157 class TestTakesObjectOrProgramOrDefault(TestCase):
158 def setUp(self):
159 def f1(prog, obj):
160 pass
161
162 self.mock1 = unittest.mock.create_autospec(f1)
163
164 def f2(prog, obj, x):
165 pass
166
167 self.mock2 = unittest.mock.create_autospec(f2)
168
169 def f3(prog, obj, x, s):
170 pass
171
172 self.mock3 = unittest.mock.create_autospec(f3)
173
174 def test_explicit_prog_no_args(self):
175 prog = mock_program()
176 takes_object_or_program_or_default(self.mock1)(prog)
177 self.mock1.assert_called_once_with(prog, None)
178
179 def test_explicit_prog_kwarg_no_args(self):
180 prog = mock_program()
181 takes_object_or_program_or_default(self.mock1)(prog=prog)
182 self.mock1.assert_called_once_with(prog=prog, obj=None)
183
184 def test_obj_no_args(self):
185 prog = mock_program()
186 takes_object_or_program_or_default(self.mock1)(Object(prog, "int", 1))
187 self.mock1.assert_called_once_with(
188 prog, IdenticalMatcher(Object(prog, "int", 1))
189 )
190
191 def test_obj_kwarg_no_args(self):
192 prog = mock_program()
193 takes_object_or_program_or_default(self.mock1)(obj=Object(prog, "int", 1))
194 self.mock1.assert_called_once_with(
195 prog, obj=IdenticalMatcher(Object(prog, "int", 1))
196 )
197
198 def test_default_prog_no_args(self):
199 with mock_default_prog() as prog:
200 takes_object_or_program_or_default(self.mock1)()
201 self.mock1.assert_called_once_with(prog, None)
202
203 def test_explicit_prog_one_arg(self):
204 prog = mock_program()
205 takes_object_or_program_or_default(self.mock2)(prog, 1)
206 self.mock2.assert_called_once_with(prog, None, 1)
207
208 def test_explicit_prog_one_kwarg(self):
209 prog = mock_program()
210 takes_object_or_program_or_default(self.mock2)(prog, x=1)
211 self.mock2.assert_called_once_with(prog, None, x=1)
212
213 def test_explicit_prog_kwarg_one_kwarg(self):
214 prog = mock_program()
215 takes_object_or_program_or_default(self.mock2)(prog=prog, x=1)
216 self.mock2.assert_called_once_with(prog=prog, obj=None, x=1)
217
218 def test_obj_one_arg(self):
219 prog = mock_program()
220 takes_object_or_program_or_default(self.mock2)(Object(prog, "int", 1), 2)
221 self.mock2.assert_called_once_with(
222 prog, IdenticalMatcher(Object(prog, "int", 1)), 2
223 )
224
225 def test_obj_one_kwarg(self):
226 prog = mock_program()
227 takes_object_or_program_or_default(self.mock2)(Object(prog, "int", 1), x=2)
228 self.mock2.assert_called_once_with(
229 prog, IdenticalMatcher(Object(prog, "int", 1)), x=2
230 )
231
232 def test_obj_kwarg_one_kwarg(self):
233 prog = mock_program()
234 takes_object_or_program_or_default(self.mock2)(obj=Object(prog, "int", 1), x=2)
235 self.mock2.assert_called_once_with(
236 prog, obj=IdenticalMatcher(Object(prog, "int", 1)), x=2
237 )
238
239 def test_object_prog_one_arg(self):
240 prog = mock_program()
241 takes_object_or_program_or_default(self.mock2)(Object(prog, "int", 2))
242 self.mock2.assert_called_once_with(
243 prog, None, IdenticalMatcher(Object(prog, "int", 2))
244 )
245
246 def test_object_prog_one_kwarg(self):
247 prog = mock_program()
248 takes_object_or_program_or_default(self.mock2)(x=Object(prog, "int", 2))
249 self.mock2.assert_called_once_with(
250 prog, None, x=IdenticalMatcher(Object(prog, "int", 2))
251 )
252
253 def test_default_prog_one_arg(self):
254 with mock_default_prog() as prog:
255 takes_object_or_program_or_default(self.mock2)(2)
256 self.mock2.assert_called_once_with(prog, None, 2)
257
258 def test_default_prog_one_kwarg(self):
259 with mock_default_prog() as prog:
260 takes_object_or_program_or_default(self.mock2)(x=2)
261 self.mock2.assert_called_once_with(prog, None, x=2)
262
263 def test_explicit_prog_two_args(self):
264 prog = mock_program()
265 takes_object_or_program_or_default(self.mock3)(prog, 1, "foo")
266 self.mock3.assert_called_once_with(prog, None, 1, "foo")
267
268 def test_explicit_prog_one_arg_one_kwarg(self):
269 prog = mock_program()
270 takes_object_or_program_or_default(self.mock3)(prog, 1, s="foo")
271 self.mock3.assert_called_once_with(prog, None, 1, s="foo")
272
273 def test_explicit_prog_two_kwargs(self):
274 prog = mock_program()
275 takes_object_or_program_or_default(self.mock3)(prog, x=1, s="foo")
276 self.mock3.assert_called_once_with(prog, None, x=1, s="foo")
277
278 def test_explicit_prog_kwarg_two_kwargs(self):
279 prog = mock_program()
280 takes_object_or_program_or_default(self.mock3)(prog=prog, x=1, s="foo")
281 self.mock3.assert_called_once_with(prog=prog, obj=None, x=1, s="foo")
282
283 def test_obj_two_args(self):
284 prog = mock_program()
285 takes_object_or_program_or_default(self.mock3)(Object(prog, "int", 1), 2, "foo")
286 self.mock3.assert_called_once_with(
287 prog, IdenticalMatcher(Object(prog, "int", 1)), 2, "foo"
288 )
289
290 def test_obj_one_arg_one_kwarg(self):
291 prog = mock_program()
292 takes_object_or_program_or_default(self.mock3)(
293 Object(prog, "int", 1), 2, s="foo"
294 )
295 self.mock3.assert_called_once_with(
296 prog, IdenticalMatcher(Object(prog, "int", 1)), 2, s="foo"
297 )
298
299 def test_obj_two_kwargs(self):
300 prog = mock_program()
301 takes_object_or_program_or_default(self.mock3)(
302 Object(prog, "int", 1), x=2, s="foo"
303 )
304 self.mock3.assert_called_once_with(
305 prog, IdenticalMatcher(Object(prog, "int", 1)), x=2, s="foo"
306 )
307
308 def test_obj_kwarg_two_kwargs(self):
309 prog = mock_program()
310 takes_object_or_program_or_default(self.mock3)(
311 obj=Object(prog, "int", 1), x=2, s="foo"
312 )
313 self.mock3.assert_called_once_with(
314 prog, obj=IdenticalMatcher(Object(prog, "int", 1)), x=2, s="foo"
315 )
316
317 def test_object_prog_two_args(self):
318 prog = mock_program()
319 takes_object_or_program_or_default(self.mock3)(Object(prog, "int", 2), "foo")
320 self.mock3.assert_called_once_with(
321 prog, None, IdenticalMatcher(Object(prog, "int", 2)), "foo"
322 )
323
324 def test_object_prog_one_arg_one_kwarg(self):
325 prog = mock_program()
326 takes_object_or_program_or_default(self.mock3)(Object(prog, "int", 2), s="foo")
327 self.mock3.assert_called_once_with(
328 prog, None, IdenticalMatcher(Object(prog, "int", 2)), s="foo"
329 )
330
331 def test_object_prog_two_kwargs(self):
332 prog = mock_program()
333 takes_object_or_program_or_default(self.mock3)(
334 x=Object(prog, "int", 2), s="foo"
335 )
336 self.mock3.assert_called_once_with(
337 prog, None, x=IdenticalMatcher(Object(prog, "int", 2)), s="foo"
338 )
339
340 def test_default_prog_two_args(self):
341 with mock_default_prog() as prog:
342 takes_object_or_program_or_default(self.mock3)(2, "foo")
343 self.mock3.assert_called_once_with(prog, None, 2, "foo")
344
345 def test_default_prog_one_arg_one_kwarg(self):
346 with mock_default_prog() as prog:
347 takes_object_or_program_or_default(self.mock3)(2, s="foo")
348 self.mock3.assert_called_once_with(prog, None, 2, s="foo")
349
350 def test_default_prog_two_kwargs(self):
351 with mock_default_prog() as prog:
352 takes_object_or_program_or_default(self.mock3)(x=2, s="foo")
353 self.mock3.assert_called_once_with(prog, None, x=2, s="foo")