CODEWITHSUNDEEP
pythonunit-testing
victorcampos
victorcampos

Reputation: 1390

Non-test methods in a Python TestCase

Ok, as Google search isn't helping me in a while (even when using the correct keywords).

I have a class extending from TestCase in which I want to have some auxiliary methods that are not going to be executed as part of the test, they'll be used to generate some mocked objects, etc, auxiliary things for almost any test.

I know I could use the @skip decorator so unittest doesn't run a particular test method, but I think that's an ugly hack to use for my purpose, any tips?

Thanks in advance, community :D

Upvotes: 72

Views: 24229

Answers (3)

Brian Riley
Brian Riley

Reputation: 109

The only methods that unittest will execute [1] are setUp, anything that starts with test, and tearDown [2], in that order. You can make helper methods and call them anything except for those three things, and they will not be executed by unittest.

You can think of setUp as __init__: if you're generating mock objects that are used by multiple tests, create them in setUp.

def setUp(self):
    self.mock_obj = MockObj()

[1]: This is not entirely true, but these are the main 3 groups of methods that you can concentrate on when writing tests.

[2]: For legacy reasons, unittest will execute both test_foo and testFoo, but test_foo is the preferred style these days. setUp and tearDown should appear as such.

Upvotes: 5

Mark Cidade
Mark Cidade

Reputation: 100027

The test runner will only directly execute methods beginning with test, so just make sure your helper methods' names don't begin with test.

Upvotes: 3

J Lundberg
J Lundberg

Reputation: 2363

I believe that you don't have to do anything. Your helper methods should just not start with test_.

Upvotes: 107

Related Questions