CODEWITHSUNDEEP
pythonpytest
Alex Okrushko
Alex Okrushko

Reputation: 7372

pytest 2.3 adding teardowns within the class

I'm researching new version of pytest (2.3) and getting very excited about the new functionality where you

"can precisely control teardown by registering one or multiple teardown functions as soon as they have performed some actions which need undoing, eliminating the no need for a separate “teardown” decorator"

from here

It's all pretty clear when it's used as function, but how to use it in the class?

class Test(object):

    @pytest.setup(scope='class')
    def stp(self):
        self.propty = "something"

    def test_something(self):
    ... # some code
    # need to add something to the teardown

    def test_something_else(self):
    ... # some code
    # need to add even more to the teardown

Upvotes: 1

Views: 3439

Answers (2)

Alex Okrushko
Alex Okrushko

Reputation: 7372

Ok, I got it working by having a 'session'-wide funcarg finalizer:

@pytest.fixture(scope = "session")
def finalizer():
    return Finalizer()

class Finalizer(object):

    def __init__(self):
        self.fin_funcs = []

    def add_fin_func(self, func):
        self.fin_funcs.append(func)

    def remove_fin_func(self, func):
        try:
            self.fin_funcs.remove(func)
        except:
            pass

    def execute(self):
        for func in reversed(self.fin_funcs): 
            func()
        self.fin_funcs = []     

class TestSomething(object):

    @classmethod
    @pytest.fixture(scope = "class", autouse = True)
    def setup(self, request, finalizer):

        self.finalizer = finalizer
        request.addfinalizer(self.finalizer.execute)
        self.finalizer.add_fin_func(lambda: some_teardown())

    def test_with_teardown(self):

        #some test
        self.finalizer.add_fin_func(self.additional_teardown)

    def additional_teardown(self):
        #additional teardown

Thanks @hpk42 for answering e-mails and helping me get the final version.

NOTE: together with xfailing the rest of the steps and improved scenarios this now makes a pretty good Test-Step structure

Upvotes: 3

hpk42
hpk42

Reputation: 23561

Indeed, there are no good examples for teardown yet. The request object has a addfinalizer method. Here is an example usage:

@pytest.setup(scope=...)
def mysetup(request):
     ...
     request.addfinalizer(finalizerfunction)
     ...

The finalizerfunction will be called when all tests withing the scope finished execution.

Upvotes: 0

Related Questions