diff --git a/docs/internals/contributing.txt b/docs/internals/contributing.txt index 8258c5e819..2e1831aec8 100644 --- a/docs/internals/contributing.txt +++ b/docs/internals/contributing.txt @@ -826,6 +826,20 @@ following is a minimal settings file that can be used to test SQLite:: } } +As a convenience, this settings file is included in your Django +distribution. It is called ``test_sqlite`, and is included in +the ``tests`` directory. This allows you to get started running +the tests against the sqlite database without doing anything on +your filesystem. However it should be noted that running against +other database backends is recommended for certain types of test +cases. + +To run the tests with this included settings file, ``cd`` +to the ``tests/`` directory and type: + +.. code-block:: bash + + ./runtests.py --settings=test_sqlite If you're using another backend, you will need to provide other details for each database: diff --git a/tests/test_sqlite.py b/tests/test_sqlite.py new file mode 100644 index 0000000000..c789828589 --- /dev/null +++ b/tests/test_sqlite.py @@ -0,0 +1,23 @@ +# This is an example test settings file for use with the Django test suite. +# +# The 'sqlite3' backend requires only the ENGINE setting (an in- +# memory database will be used). All other backends will require a +# NAME and potentially authentication information. See the +# following section in the docs for more information: +# +# http://docs.djangoproject.com/en/dev/internals/contributing/#unit-tests +# +# The different databases that Django supports behave differently in certain +# situations, so it is recommended to run the test suite against as many +# database backends as possible. You may want to create a separate settings +# file for each of the backends you test against. + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3' + }, + 'other': { + 'ENGINE': 'django.db.backends.sqlite3', + 'TEST_NAME': 'other_db' + } +}