2005-07-29 15:15:40 +00:00
#!/usr/bin/env python
2006-01-17 17:56:33 +00:00
import os , re , sys , time , traceback
2005-07-29 15:15:40 +00:00
# doctest is included in the same package as this module, because this testing
# framework uses features only available in the Python 2.4 version of doctest,
# and Django aims to work with Python 2.3+.
import doctest
APP_NAME = ' testapp '
2005-08-01 19:09:07 +00:00
OTHER_TESTS_DIR = " othertests "
2005-07-29 15:15:40 +00:00
TEST_DATABASE_NAME = ' django_test_db '
error_list = [ ]
def log_error ( model_name , title , description ) :
error_list . append ( {
2005-08-01 19:09:07 +00:00
' title ' : " %r module: %s " % ( model_name , title ) ,
2005-07-29 15:15:40 +00:00
' description ' : description ,
} )
2005-07-29 22:35:54 +00:00
MODEL_DIR = os . path . join ( os . path . dirname ( __file__ ) , APP_NAME , ' models ' )
def get_test_models ( ) :
return [ f [ : - 3 ] for f in os . listdir ( MODEL_DIR ) if f . endswith ( ' .py ' ) and not f . startswith ( ' __init__ ' ) ]
2005-07-29 15:15:40 +00:00
class DjangoDoctestRunner ( doctest . DocTestRunner ) :
def __init__ ( self , verbosity_level , * args , * * kwargs ) :
self . verbosity_level = verbosity_level
doctest . DocTestRunner . __init__ ( self , * args , * * kwargs )
2005-08-10 18:00:52 +00:00
self . _checker = DjangoDoctestOutputChecker ( )
2005-08-10 18:10:38 +00:00
self . optionflags = doctest . ELLIPSIS
2005-07-29 15:15:40 +00:00
def report_start ( self , out , test , example ) :
if self . verbosity_level > 1 :
out ( " >>> %s \n " % example . source . strip ( ) )
def report_failure ( self , out , test , example , got ) :
log_error ( test . name , " API test failed " ,
" Code: %r \n Line: %s \n Expected: %r \n Got: %r " % ( example . source . strip ( ) , example . lineno , example . want , got ) )
def report_unexpected_exception ( self , out , test , example , exc_info ) :
tb = ' ' . join ( traceback . format_exception ( * exc_info ) [ 1 : ] )
log_error ( test . name , " API test raised an exception " ,
" Code: %r \n Line: %s \n Exception: %s " % ( example . source . strip ( ) , example . lineno , tb ) )
2005-09-19 01:18:04 +00:00
2006-01-17 17:56:33 +00:00
normalize_long_ints = lambda s : re . sub ( r ' (?<![ \ w])( \ d+)L(?![ \ w]) ' , ' \\ 1 ' , s )
2005-08-10 18:00:52 +00:00
class DjangoDoctestOutputChecker ( doctest . OutputChecker ) :
def check_output ( self , want , got , optionflags ) :
ok = doctest . OutputChecker . check_output ( self , want , got , optionflags )
2006-01-17 17:56:33 +00:00
# Doctest does an exact string comparison of output, which means long
# integers aren't equal to normal integers ("22L" vs. "22"). The
# following code normalizes long integers so that they equal normal
# integers.
if not ok :
return normalize_long_ints ( want ) == normalize_long_ints ( got )
2005-08-10 18:00:52 +00:00
return ok
2005-07-29 15:15:40 +00:00
class TestRunner :
2005-09-19 01:18:04 +00:00
def __init__ ( self , verbosity_level = 0 , which_tests = None ) :
2005-07-29 15:15:40 +00:00
self . verbosity_level = verbosity_level
2005-09-19 01:18:04 +00:00
self . which_tests = which_tests
2005-07-29 15:15:40 +00:00
def output ( self , required_level , message ) :
if self . verbosity_level > required_level - 1 :
print message
def run_tests ( self ) :
from django . conf import settings
from django . core . db import db
2005-07-29 20:25:02 +00:00
from django . core import management , meta
2005-07-29 15:15:40 +00:00
# Manually set INSTALLED_APPS to point to the test app.
settings . INSTALLED_APPS = ( APP_NAME , )
2005-09-19 01:18:04 +00:00
# Determine which models we're going to test.
test_models = get_test_models ( )
if self . which_tests :
# Only run the specified tests.
bad_models = [ m for m in self . which_tests if m not in test_models ]
if bad_models :
sys . stderr . write ( " Models not found: %s \n " % bad_models )
sys . exit ( 1 )
else :
test_models = self . which_tests
self . output ( 0 , " Running tests with database %r " % settings . DATABASE_ENGINE )
2005-07-29 22:35:54 +00:00
# If we're using SQLite, it's more convenient to test against an
# in-memory database.
2005-07-29 19:22:50 +00:00
if settings . DATABASE_ENGINE == " sqlite3 " :
global TEST_DATABASE_NAME
TEST_DATABASE_NAME = " :memory: "
2005-07-29 22:35:54 +00:00
else :
# Create the test database and connect to it. We need autocommit()
# because PostgreSQL doesn't allow CREATE DATABASE statements
# within transactions.
2005-07-29 19:22:50 +00:00
cursor = db . cursor ( )
try :
2005-10-08 20:56:34 +00:00
db . connection . autocommit ( 1 )
2005-07-29 19:22:50 +00:00
except AttributeError :
pass
self . output ( 1 , " Creating test database " )
try :
2005-07-29 15:15:40 +00:00
cursor . execute ( " CREATE DATABASE %s " % TEST_DATABASE_NAME )
2005-12-01 06:39:39 +00:00
except Exception , e :
sys . stderr . write ( " Got an error creating the test database: %s \n " % e )
confirm = raw_input ( " It appears the test database, %s , already exists. Type ' yes ' to delete it, or ' no ' to cancel: " % TEST_DATABASE_NAME )
2005-07-29 19:22:50 +00:00
if confirm == ' yes ' :
cursor . execute ( " DROP DATABASE %s " % TEST_DATABASE_NAME )
cursor . execute ( " CREATE DATABASE %s " % TEST_DATABASE_NAME )
else :
print " Tests cancelled. "
return
2005-07-29 15:15:40 +00:00
db . close ( )
old_database_name = settings . DATABASE_NAME
settings . DATABASE_NAME = TEST_DATABASE_NAME
# Initialize the test database.
cursor = db . cursor ( )
self . output ( 1 , " Initializing test database " )
management . init ( )
2005-07-29 22:35:54 +00:00
# Run the tests for each test model.
2005-08-01 19:09:07 +00:00
self . output ( 1 , " Running app tests " )
2005-09-19 01:18:04 +00:00
for model_name in test_models :
2005-07-29 15:15:40 +00:00
self . output ( 1 , " %s model: Importing " % model_name )
try :
2005-07-29 20:25:02 +00:00
mod = meta . get_app ( model_name )
2005-07-29 15:15:40 +00:00
except Exception , e :
log_error ( model_name , " Error while importing " , ' ' . join ( traceback . format_exception ( * sys . exc_info ( ) ) [ 1 : ] ) )
continue
self . output ( 1 , " %s model: Installing " % model_name )
management . install ( mod )
# Run the API tests.
p = doctest . DocTestParser ( )
test_namespace = dict ( [ ( m . _meta . module_name , getattr ( mod , m . _meta . module_name ) ) for m in mod . _MODELS ] )
dtest = p . get_doctest ( mod . API_TESTS , test_namespace , model_name , None , None )
# Manually set verbose=False, because "-v" command-line parameter
# has side effects on doctest TestRunner class.
runner = DjangoDoctestRunner ( verbosity_level = verbosity_level , verbose = False )
self . output ( 1 , " %s model: Running tests " % model_name )
2005-08-09 23:51:55 +00:00
try :
runner . run ( dtest , clear_globs = True , out = sys . stdout . write )
finally :
# Rollback, in case of database errors. Otherwise they'd have
# side effects on other tests.
db . rollback ( )
2005-09-19 01:18:04 +00:00
if not self . which_tests :
# Run the non-model tests in the other tests dir
self . output ( 1 , " Running other tests " )
other_tests_dir = os . path . join ( os . path . dirname ( __file__ ) , OTHER_TESTS_DIR )
test_modules = [ f [ : - 3 ] for f in os . listdir ( other_tests_dir ) if f . endswith ( ' .py ' ) and not f . startswith ( ' __init__ ' ) ]
for module in test_modules :
self . output ( 1 , " %s module: Importing " % module )
2005-08-01 19:09:07 +00:00
try :
2005-09-19 01:18:04 +00:00
mod = __import__ ( " othertests. " + module , ' ' , ' ' , [ ' ' ] )
2005-08-01 19:09:07 +00:00
except Exception , e :
2005-09-19 01:18:04 +00:00
log_error ( module , " Error while importing " , ' ' . join ( traceback . format_exception ( * sys . exc_info ( ) ) [ 1 : ] ) )
2005-08-01 19:09:07 +00:00
continue
2005-09-19 01:18:04 +00:00
if mod . __doc__ :
p = doctest . DocTestParser ( )
dtest = p . get_doctest ( mod . __doc__ , mod . __dict__ , module , None , None )
runner = DjangoDoctestRunner ( verbosity_level = verbosity_level , verbose = False )
self . output ( 1 , " %s module: running tests " % module )
runner . run ( dtest , clear_globs = True , out = sys . stdout . write )
if hasattr ( mod , " run_tests " ) and callable ( mod . run_tests ) :
self . output ( 1 , " %s module: running tests " % module )
try :
mod . run_tests ( verbosity_level )
except Exception , e :
log_error ( module , " Exception running tests " , ' ' . join ( traceback . format_exception ( * sys . exc_info ( ) ) [ 1 : ] ) )
continue
2005-08-09 23:51:55 +00:00
2005-07-29 22:35:54 +00:00
# Unless we're using SQLite, remove the test database to clean up after
# ourselves. Connect to the previous database (not the test database)
# to do so, because it's not allowed to delete a database while being
2005-07-29 19:22:50 +00:00
# connected to it.
if settings . DATABASE_ENGINE != " sqlite3 " :
db . close ( )
settings . DATABASE_NAME = old_database_name
cursor = db . cursor ( )
self . output ( 1 , " Deleting test database " )
try :
2005-10-08 20:56:34 +00:00
db . connection . autocommit ( 1 )
2005-07-29 19:22:50 +00:00
except AttributeError :
pass
else :
time . sleep ( 1 ) # To avoid "database is being accessed by other users" errors.
cursor . execute ( " DROP DATABASE %s " % TEST_DATABASE_NAME )
2005-07-29 15:15:40 +00:00
# Display output.
if error_list :
for d in error_list :
print
print d [ ' title ' ]
print " = " * len ( d [ ' title ' ] )
print d [ ' description ' ]
2005-09-19 01:18:04 +00:00
print " %s error %s : " % ( len ( error_list ) , len ( error_list ) != 1 and ' s ' or ' ' )
2005-07-29 15:15:40 +00:00
else :
print " All tests passed. "
if __name__ == " __main__ " :
from optparse import OptionParser
2005-09-19 01:18:04 +00:00
usage = " % prog [options] [model model model ...] "
2006-02-18 20:08:20 +00:00
parser = OptionParser ( usage = usage )
2005-07-29 15:15:40 +00:00
parser . add_option ( ' -v ' , help = ' How verbose should the output be? Choices are 0, 1 and 2, where 2 is most verbose. Default is 0. ' ,
type = ' choice ' , choices = [ ' 0 ' , ' 1 ' , ' 2 ' ] )
2005-08-10 15:36:16 +00:00
parser . add_option ( ' --settings ' ,
2006-01-01 18:37:33 +00:00
help = ' Python path to settings module, e.g. " myproject.settings " . If this isn \' t provided, the DJANGO_SETTINGS_MODULE environment variable will be used. ' )
2005-07-29 15:15:40 +00:00
options , args = parser . parse_args ( )
verbosity_level = 0
if options . v :
verbosity_level = int ( options . v )
2005-08-10 15:36:16 +00:00
if options . settings :
os . environ [ ' DJANGO_SETTINGS_MODULE ' ] = options . settings
2005-09-19 01:18:04 +00:00
t = TestRunner ( verbosity_level , args )
2005-07-29 15:15:40 +00:00
t . run_tests ( )