File: test_fixtures.py

package info (click to toggle)
python-pytest-unmagic 1.0.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 172 kB
  • sloc: python: 1,199; makefile: 3
file content (704 lines) | stat: -rw-r--r-- 17,303 bytes parent folder | download
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
from contextlib import contextmanager
from inspect import isgeneratorfunction
from unittest.mock import patch

import pytest

from unmagic import fence, fixture, get_request, use

from .util import get_source, unmagic_tester


@fixture
def tracer():
    yield []


@fixture
@tracer
def fix():
    traces = tracer()
    traces.append("fixing...")
    yield "fixed value"
    traces.append("fix done")


@tracer
@fixture
def check_done():
    traces = tracer()
    yield
    assert traces[-1].endswith("done")


@use(check_done, fix, tracer)
def test_unmagic_fixture():
    assert fix() == "fixed value"
    assert tracer() == ["fixing..."]
    assert test_unmagic_fixture.unmagic_fixtures == [check_done, fix, tracer]


@pytest.mark.parametrize("p1, p2", [(1, 2), (2, 3)])
@check_done
def test_params(p1, p2):
    assert p1 + 1 == p2
    tracer().append("done")


@check_done
@fix
def test_unmagic_fixture_as_decorator():
    assert tracer() == ["fixing..."]
    assert fix() == "fixed value"
    assert test_unmagic_fixture_as_decorator.unmagic_fixtures \
        == [tracer, fix, check_done]


def test_use_generator_should_return_generator():
    @fix
    def gen():
        yield
    assert isgeneratorfunction(gen)


class Thing:
    x = 0
    y = 4000
    z = -1


@fixture
@use(
    patch.object(Thing, "x", 2),
    patch.object(Thing, "z", -2),
)
def patch_things():
    yield (Thing.x, Thing.y, Thing.z)


@patch.object(Thing, "y")
def test_patch_with_unmagic_fixture(mock):
    assert patch_things() == (2, mock, -2)


@contextmanager
def plain_context():
    yield "other"


def test_plain_contextmanager_fixture():
    other_fixture = fixture(plain_context)
    assert other_fixture() == "other"


def test_module_is_fenced():
    assert fence.is_fenced(test_module_is_fenced)


def test_use_magic_fixture():
    cap = fixture("capsys")()
    print("hello")
    captured = cap.readouterr()
    assert captured.out == "hello\n"


def test_malformed_unmagic_fixture():
    with pytest.raises(TypeError, match=r"<.+broken_fix .*> is not a fixture"):
        @fixture
        def broken_fix():
            return "nope"


def test_malformed_unmagic_fixture_using_other_fixtures():
    @fixture
    def do_not_call_me():
        assert 0, "should not get here"
        yield

    with pytest.raises(TypeError, match=r"<.+broken_fix .*> is not a fixture"):
        @fixture
        @use(do_not_call_me)
        def broken_fix():
            return "nope"


def test_fixture_is_not_a_test():
    @get_source
    def test_py():
        from unmagic import fixture

        @fixture(scope="session")
        def test_tracer():
            traces = []
            yield traces
            print("", " ".join(traces))

        def test_thing():
            test_tracer().append("x0")

    pytester = unmagic_tester()
    pytester.makepyfile(test_py)
    result = pytester.runpytest("-sv")
    result.stdout.fnmatch_lines([
        "* x0",
    ])
    result.assert_outcomes(passed=1)


def test_improper_fixture_dependency():
    @get_source
    def test_py():
        from unmagic import fixture

        @fixture
        def tracer():
            yield []

        @fixture(scope="class")
        def class_tracer():
            traces = tracer()
            yield traces
            print("", " ".join(traces))

        @class_tracer
        def test():
            assert 0, "should not get here"

    pytester = unmagic_tester()
    pytester.makepyfile(test_py)
    result = pytester.runpytest("-sv", "--setup-show")
    result.stdout.fnmatch_lines([
        "* tried to access the function scoped fixture tracer "
        "with a class scoped request *"
    ])
    result.assert_outcomes(failed=1)


def test_module_fixture_using_session_pytest_fixture():
    @get_source
    def test_py():
        import pytest
        from unmagic import fixture, use

        traces = []

        @pytest.fixture(scope="session")
        def tracer():
            traces.append("session")
            yield

        @fixture(scope="module")
        @use("tracer")
        def class_tracer():
            traces.append("module")
            yield

        @class_tracer
        def test():
            assert "session" in traces
            assert "module" in traces

    pytester = unmagic_tester()
    pytester.makepyfile(test_py)
    result = pytester.runpytest("-s")
    result.assert_outcomes(passed=1)


@fixture(scope="module")
def module_request():
    yield get_request()


def test_fixture_request():
    assert get_request().scope == "function"
    assert module_request().scope == "module"


class TestMethodUse:

    @check_done
    def test_use(self):
        tracer().append("done")


def test_class_and_session_scope():
    @get_source
    def test_py():
        from unmagic import fixture, get_request

        @fixture(scope="session")
        def ss_tracer():
            traces = []
            yield traces
            print("", " ".join(traces))

        @fixture(scope="class")
        def cls_fix():
            name = get_request().cls.__name__[-1]
            traces = ss_tracer()
            traces.append(f"{name}-a")
            yield name
            traces.append(f"{name}-z")

        class TestX:
            def test_one(self):
                ss_tracer().append("x1")

            def test_two(self):
                ss_tracer().append(f"{cls_fix()}-x2")

            def test_three(self):
                ss_tracer().append("x3")

        class TestY:
            def test_one(self):
                ss_tracer().append("y1")

            def test_two(self):
                ss_tracer().append(f"{cls_fix()}-y2")

            def test_three(self):
                ss_tracer().append("y3")

    pytester = unmagic_tester()
    pytester.makepyfile(test_py)
    result = pytester.runpytest("-s")
    result.stdout.fnmatch_lines([
        "* x1 X-a X-x2 x3 X-z y1 Y-a Y-y2 y3 Y-z",
    ])
    result.assert_outcomes(passed=6)


def test_fixture_as_class_decorator():
    @get_source
    def test_py():
        from unittest import TestCase
        from unmagic import fixture, get_request

        traces = []

        @fixture(scope="session")
        def ss_tracer():
            yield traces
            print("", " ".join(traces))

        @fixture(scope="class")
        @ss_tracer
        def cls_fix():
            name = get_request().cls.__name__[-1]
            traces.append(f"{name}-a")
            yield name
            traces.append(f"{name}-z")

        @cls_fix
        class TestX:
            def test_one(self):
                traces.append("X1")

            def test_two(self):
                traces.append("X2")

            def test_three(self):
                traces.append("X3")

        @cls_fix
        class TestY(TestCase):
            def test_one(self):
                traces.append("Y1")

            def test_two(self):
                traces.append("Y2")

            def test_three(self):
                traces.append("Y3")

    pytester = unmagic_tester()
    pytester.makepyfile(test_py)
    result = pytester.runpytest("-s")
    result.stdout.fnmatch_lines([
        "* X-a X1 X2 X3 X-z Y-a Y1 Y3 Y2 Y-z",
    ])
    result.assert_outcomes(passed=6)


def test_non_function_scoped_contextmanager_fixture():
    @get_source
    def test_py():
        from contextlib import contextmanager
        from unmagic import fixture

        traces = []

        @contextmanager
        def context():
            traces.append("setup")
            yield
            traces.append("teardown")
            print("", " ".join(traces))

        @fixture(context, scope="class")
        class Tests:
            def test_one(self):
                traces.append("1")

            def test_two(self):
                traces.append("2")

            def test_three(self):
                traces.append("3")

    pytester = unmagic_tester()
    pytester.makepyfile(test_py)
    result = pytester.runpytest("-s")
    result.stdout.fnmatch_lines(["* setup 1 2 3 teardown"])
    result.assert_outcomes(passed=3)


def test_module_scope():
    @get_source
    def fix_py():
        from unmagic import fixture, get_request

        @fixture(scope="session")
        def ss_tracer():
            traces = []
            yield traces
            print("", " ".join(traces))

        @fixture(scope="module")
        def mod_fix():
            name = get_request().module.__name__[-4:]
            traces = ss_tracer()
            traces.append(f"{name}-a")
            yield name
            traces.append(f"{name}-z")

    @get_source
    def mod1_py():
        from fix import ss_tracer, mod_fix

        def test_one():
            ss_tracer().append("x1")

        def test_two():
            ss_tracer().append(f"{mod_fix()}-x2")

        def test_three():
            ss_tracer().append("x3")

    @get_source
    def mod2_py():
        from fix import ss_tracer, mod_fix

        def test_one():
            ss_tracer().append("y1")

        def test_two():
            ss_tracer().append(f"{mod_fix()}-y2")

        def test_three():
            ss_tracer().append("y3")

    pytester = unmagic_tester()
    pytester.makepyfile(fix=fix_py, test_mod1=mod1_py, test_mod2=mod2_py)
    result = pytester.runpytest("-s")
    result.stdout.fnmatch_lines([
        "* x1 mod1-a mod1-x2 x3 mod1-z y1 mod2-a mod2-y2 y3 mod2-z",
    ])
    result.assert_outcomes(passed=6)


def test_package_scope():
    @get_source
    def fix_py():
        from unmagic import fixture

        @fixture(scope="session")
        def ss_tracer():
            traces = []
            yield traces
            print("\n", " ".join(traces))

    @get_source
    def init_py():
        from unmagic import fixture, get_request
        from fix import ss_tracer

        @fixture(scope="package")
        def pkg_fix():
            name = get_request().node.nodeid.replace("/", ".")
            traces = ss_tracer()
            traces.append(f"{name}-a")
            yield
            traces.append(f"{name}-z")

    @get_source
    def mod_py():
        from unmagic import fixture
        from fix import ss_tracer
        from . import pkg_fix

        @fixture(scope="module")
        @pkg_fix
        def modname():
            yield __name__.rsplit(".", 1)[-1].replace("test_mod", "m")

        def test_one():
            ss_tracer().append(f"{modname()}.t1")

        def test_two():
            ss_tracer().append(f"{modname()}.t2")

    pytester = unmagic_tester()
    (pytester.path / "pkg/sub").mkdir(parents=True)
    (pytester.path / "pkg/sub/__init__.py").write_text(init_py)
    (pytester.path / "pkg/sub/test_mod0.py").write_text(mod_py)

    (pytester.path / "pkg/__init__.py").write_text(init_py)
    (pytester.path / "pkg/test_mod1.py").write_text(mod_py)
    (pytester.path / "pkg/test_mod2.py").write_text(mod_py)

    (pytester.path / "pkg/up").mkdir()
    (pytester.path / "pkg/up/__init__.py").write_text(init_py)
    (pytester.path / "pkg/up/test_mod3.py").write_text(mod_py)

    (pytester.path / "fix.py").write_text(fix_py)

    result = pytester.runpytest("-s")
    result.stdout.fnmatch_lines([
        " pkg.sub-a m0.t1 m0.t2 pkg.sub-z"
        " pkg-a m1.t1 m1.t2 m2.t1 m2.t2 pkg.up-a m3.t1 m3.t2 pkg.up-z pkg-z"
    ])
    result.assert_outcomes(passed=8)


def test_fixture_autouse():

    @get_source
    def fix_py():
        from unmagic import fixture, get_request

        @fixture(scope="session")
        def ss_tracer():
            traces = []
            yield traces
            print("", " ".join(traces))

        @fixture(scope="module", autouse=True)
        def mod_fix():
            name = get_request().module.__name__[-4:]
            traces = ss_tracer()
            traces.append(f"{name}-a")
            yield name
            traces.append(f"{name}-z")

    @get_source
    def mod_py():
        from fix import ss_tracer

        def test_one():
            ss_tracer().append("x1")

        def test_two():
            ss_tracer().append("x2")

        def test_three():
            ss_tracer().append("x3")

    pytester = unmagic_tester()
    pytester.makepyfile(fix=fix_py, test_mod1=mod_py, test_mod2=mod_py)

    result = pytester.runpytest("-s")
    result.stdout.fnmatch_lines([
        "* mod1-a x1 x2 x3 mod1-z mod2-a x1 x2 x3 mod2-z",
    ])
    result.assert_outcomes(passed=6)


def test_setup_function():
    @get_source
    def test_py():
        from unmagic import fixture, get_request

        @fixture(scope="session")
        def ss_tracer():
            traces = []
            yield traces
            print("", " ".join(traces))

        @fixture
        def fun_fix():
            name = f"t{get_request().function.__name__[-1]}"
            traces = ss_tracer()
            traces.append(f"{name}-a")
            yield name
            traces.append(f"{name}-z")

        @fun_fix
        def setup_function():
            ss_tracer().append("sf")

        def test_x0():
            ss_tracer().append("x0")

        def test_x1():
            ss_tracer().append("x1")

        def test_x2():
            ss_tracer().append(f"x2-{fun_fix()}")

    pytester = unmagic_tester()
    pytester.makepyfile(test_py)
    result = pytester.runpytest("-sl", "--tb=long")
    result.stdout.fnmatch_lines([
        "* t0-a sf x0 t0-z t1-a sf x1 t1-z t2-a sf x2-t2 t2-z",
    ])
    result.assert_outcomes(passed=3)


class TestFixturesOption:

    def test_basic(self):
        @get_source
        def test_py():
            from unmagic import fixture

            @fixture
            def fix():
                "A fixture"
                yield

            @fix
            def test():
                pass

        pytester = unmagic_tester()
        pytester.makepyfile(test_py)
        result = pytester.runpytest("--fixtures")
        result.stdout.re_match_lines([
            r"-* fixtures defined from test_basic -*",
            r"fix -- test_basic.py:4",
            r" +A fixture",
        ])
        result.assert_outcomes()

    def test_fixture_uses_fixture(self):
        @get_source
        def test_py():
            from unmagic import fixture

            @fixture
            def first():
                "First fixture"
                yield

            @first  # important: @use applied after @fixture
            @fixture
            def second():
                "Second fixture"
                yield

            @second
            def test():
                pass

        pytester = unmagic_tester()
        pytester.makepyfile(test_py)
        result = pytester.runpytest("--fixtures")
        result.stdout.re_match_lines([
            r"-* fixtures defined from test_fixture_uses_fixture -*",
            r"second -- test_fixture_uses_fixture.py:9",
            r" +Second fixture",
        ])
        result.assert_outcomes()

    def test_use_magic_fixture(self):
        @get_source
        def test_py():
            from unmagic import use

            @use("capsys")
            def test():
                pass

        pytester = unmagic_tester()
        pytester.makepyfile(test_py)
        result = pytester.runpytest("--fixtures")
        result.stdout.re_match_lines([
            r"capsys -- \.{3}/_pytest/capture.py:\d+",
            r" +Enable text capturing .+",
        ])
        result.assert_outcomes()

    def test_use_contextmanager(self):
        @get_source
        def test_py():
            from contextlib import contextmanager
            from unmagic import use

            @contextmanager
            def plain_jane():
                """Plain Jane"""
                yield

            @use(plain_jane)
            def test():
                pass

        pytester = unmagic_tester()
        pytester.makepyfile(test_py)
        result = pytester.runpytest("--fixtures")
        result.stdout.re_match_lines([
            r"-* fixtures defined from test_use_contextmanager -*",
            r"plain_jane -- test_use_contextmanager.py:\d+",
            r" +Plain Jane",
        ])
        result.assert_outcomes()

    def test_use_patch(self):
        @get_source
        def test_py():
            from unittest.mock import patch
            from unmagic import use

            @use(patch.object(use, "x", 2))
            def test():
                pass

        pytester = unmagic_tester()
        pytester.makepyfile(test_py)
        result = pytester.runpytest("--fixtures")
        result.stdout.re_match_lines([
            r"-* fixtures defined from unittest.mock -*",
            r"<patch use\.x> -- .+/unittest/mock\.py:\d+",
        ])
        result.assert_outcomes()


class TestUnmagicFixtureId:

    @fixture
    def one():
        yield

    @fixture
    def two():
        yield

    def test_str(self):
        assert str(self.one._id) == "one"

    def test_repr(self):
        assert repr(self.one._id).startswith("<one ")

    def test_equality(self):
        assert self.one._id == self.one._id
        assert self.one._id != self.two._id
        assert self.one._id != "one"
        assert "one" != self.one._id

    def test_hash(self):
        data = {self.one._id: self.one, "one": object()}
        assert len(data) == 2
        assert data[self.one._id] is self.one
        assert data["one"] is not self.one