How do I test if a certain log message is logged in a Django test case?

python django unit-testing testing python-unittest
Krystian Cybulski picture Krystian Cybulski · Feb 4, 2013 · Viewed 13.8k times · Source

I want to ensure that a certain condition in my code causes a log message to be written to the django log. How would I do this with the Django unit testing framework?

Is there a place where I can check logged messages, similarly to how I can check sent emails? My unit test extends django.test.TestCase.

Answer

Simeon Visser picture Simeon Visser · Feb 4, 2013

Using the mock module for mocking the logging module or the logger object. When you've done that, check the arguments with which the logging function is called.

For example, if you code looks like this:

import logging

logger = logging.getLogger('my_logger')

logger.error("Your log message here")

it would look like:

from unittest.mock import patch # For python 2.x use from mock import patch

@patch('this.is.my.module.logger')
def test_check_logging_message(self, mock_logger):
    mock_logger.error.assert_called_with("Your log message here")

Related questions

How to automatically run tests when there's any change in my project (Django)?

At the moment I am running python manage.py test every once in a while after I make significant changes in my django project. Is it possible to run those tests automatically whenever I change and save a file in …

Read More
Running a specific test case in Django when your app has a tests directory

The Django documentation (http://docs.djangoproject.com/en/1.3/topics/testing/#running-tests) says that you can run individual test cases by specifying them: $ ./manage.py test animals.AnimalTestCase This assumes that you have your tests in a tests.py file in …

Read More
Python/Django: how to assert that unit test result contains a certain string?

In a python unit test (actually Django), what is the correct assert statement that will tell me if my test result contains a string of my choosing? self.assertContainsTheString(result, {"car" : ["toyota","honda"]}) I want to make sure that my …

Read More