TestWithScenarios doesn't set shortDescription()

Bug #873241 reported by John A Meinel on 2011-10-13
This bug affects 1 person
Affects Status Importance Assigned to Milestone

Bug Description

If I try to run my test suite using:
$ py -c "import sys; from testtools import run; import unittest; prog = run.TestProgram(testRunner=unittest.TextTestRunner(verbosity=2), stdout=sys.stdout)" discover

(so force testtools.run to actually be verbose about the tests being run), I see odd behavior.

If I just inherit from TestCaseWithScenario I see:
test__sync_exchange_updates_indexes (u1db.tests.test_backends.DatabaseIndexTests) ... ok
test__sync_exchange_updates_indexes (u1db.tests.test_backends.DatabaseIndexTests) ... ok
test_create_index (u1db.tests.test_backends.DatabaseIndexTests) ... ok
test_create_index (u1db.tests.test_backends.DatabaseIndexTests) ... ok

If I change the code so that I inherit from testtools.TestCase, and I implement load_tests() as:
def load_tests(loader, standard_tests, pattern):
    suite = loader.suiteClass()
    return suite

I then see:
u1db.tests.test_backends.DatabaseIndexTests.test__sync_exchange_updates_indexes (mem) ... ok
u1db.tests.test_backends.DatabaseIndexTests.test__sync_exchange_updates_indexes (sqlite) ... ok
u1db.tests.test_backends.DatabaseIndexTests.test_create_index (mem) ... ok
u1db.tests.test_backends.DatabaseIndexTests.test_create_index (sqlite) ... ok

Even weirder, if I inherit directly from unittest.TestCase instead of testtools.TestCase, I see:
test__sync_exchange_updates_indexes (u1db.tests.test_backends.DatabaseIndexTests) ... ok
test__sync_exchange_updates_indexes (u1db.tests.test_backends.DatabaseIndexTests) ... ok
test_create_index (u1db.tests.test_backends.DatabaseIndexTests) ... ok
test_create_index (u1db.tests.test_backends.DatabaseIndexTests) ... ok

It looks like this is because unittest.TextTestRunner has getDescription defined as:
    def getDescription(self, test):
        if self.descriptions:
            return test.shortDescription() or str(test)
            return str(test)
And the unittest.TestCase.shortDescription tries to return the docstring or None, while testtools.TestCase.shortDescription returns self.id().

So it looks like testscenarios.TestWithScenarios should either inherit from testtools.TestCase, or just provide def shortDescription(): return self.id().

I think inheriting from testtools.TestCase is reasonable, given that testscenarios already has a dependency on testtools.clone_test_with_new_id().

John A Meinel (jameinel) on 2011-10-13
summary: - TestWithScenarios doesn't seem to update .id() in time for
- TextTestRunner
+ TestWithScenarios doesn't set shortDescription()
description: updated
Robert Collins (lifeless) wrote :

what version of unittest are you using? e.g. do you have voidspaces new one? You may be affected by http://code.google.com/p/unittest-ext/issues/detail?id=72

John A Meinel (jameinel) wrote :

It doesn't seem to be a problem in python 2.7.2, maybe it was an issue in python 2.6. I don't seem to be able to reproduce the original issue.

Changed in testscenarios:
status: New → Incomplete
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.