CODEWITHSUNDEEP
pythondjangologgingconsole
Matt3o12
Matt3o12

Reputation: 4332

Django - logging when test fails

I have a lot of unit tests in Django and if a test fails, I often need to see the logs (in the console, if possible). I can't really use the log file because it gets really messy.
What I do right now is: activate console logging in the settings.py, and only run one specific test. I was hoping that there is a more convenient way to do it. I only want to see what was being logged for the failing tests and not the complete log.

Edit: even though an answer was posted — and I have accepted it — I'm not quite content. I want to see only the logging output of failing tests. I was looking for a solution like that which PHPUnit provides. It captures the complete output (for logging + print) and only writes it to stdout if the test fails.

Upvotes: 5

Views: 1464

Answers (3)

joel3000
joel3000

Reputation: 1319

The quick and dirty way to access your log output on the console is to monkey patch logging.. To overwrite logging.info for example:

def monkey_print(*args):
   print args
setattr(logging, 'info', monkey_print)

Then just delete it when you're done. Quick and dirty. It works with unittest too.

Upvotes: 0

Matt3o12
Matt3o12

Reputation: 4332

Well, I just figured out how to fix it.
Apparently there is a -b option that "buffers the output" unless the test fails when running a unit tests. It is very easy to use if your tests.py file executes unittest.main(). Just type python tests.py -b and the complete output will be buffered unless the test fails. 

...........F
Stdout:
OK :)
OK :)

======================================================================
FAIL: testStr (__main__.MyTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "tests.py", line 93, in testStr
    self.fail()
AssertionError: None

Stdout:
OK :)
OK :)

----------------------------------------------------------------------
Ran 12 tests in 0.005s

In this case, every test printed something to stdout but only the very last one (the failing one was shown). Since the log can also be printed to the console (see @Thomas's answer), you will only see relevant logs.

Upvotes: 2

Thomas
Thomas

Reputation: 11888

Set the root logger to use the console handler only when running tests. Easiest way to detect is to see if "test" is the second argv parameter. Make sure all interesting loggers have "propagate": True so that they forward their logs to the root logger.

# settings.py
import sys

if sys.argv[1] == 'test':
    LOGGING['root'] = {
        'handlers': ['console'],
        'level': 'DEBUG',
    }

Upvotes: 1

Related Questions