O Django vem com uma suíte de testes própria, no diretório tests do código. É nossa política garantir que todos os testes passem em todos os momentos.
Nós agradecemos toda e qualquer contribuição para a suíte de testes.
\nTodos os testes do Django usam a infraestrutura de testes que é distribuída com o Django para testar aplicações. Veja Writing and running tests para uma explicação de como escrever novos testes.
\nPrimeiro, faça o “fork”do Django no GitHub.
\nSegundo, crie e ative um ambiente virtual. Se não estiver familiar de como fazê-lo, leia nosso tutorial de como contribuir.
\nNext, clone your fork, install some requirements, and run the tests:
\nLinux / macOS
$ git clone https://github.com/YourGitHubName/django.git django-repo\n$ cd django-repo/tests\n$ python -m pip install -e ..\n$ python -m pip install -r requirements/py3.txt\n$ ./runtests.py\nWindows
...\\> git clone https://github.com/YourGitHubName/django.git django-repo\n...\\> cd django-repo\\tests\n...\\> py -m pip install -e ..\n...\\> py -m pip install -r requirements\\py3.txt\n...\\> runtests.py \nInstalling the requirements will likely require some operating system packages\nthat your computer doesn’t have installed. You can usually figure out which\npackage to install by doing a web search for the last line or so of the error\nmessage. Try adding your operating system to the search query if needed.
\nIf you have trouble installing an optional test dependency, you can skip that\ndependency locally. For example, if installing pylibmc fails, comment out\nits line in requirements/py3.txt and continue with ./runtests.py.\nTests that require pylibmc will be skipped automatically. See\nRodando todos os testes for details on installing the optional\ntest dependencies.
Running the tests requires a Django settings module that defines the databases\nto use. To help you get started, Django provides and uses a sample settings\nmodule that uses the SQLite database. See Usando outro módulo settings to\nlearn how to use a different settings module to run the tests with a different\ndatabase.
\nEstá tendo problemas? Veja Solução de Problemas para alguns problemas comuns.
\ntoxLink para este cabeçalho#Tox is a tool for running tests in different virtual\nenvironments. Django includes a basic tox.ini that automates some checks\nthat our build server performs on pull requests. To run the unit tests and\nother checks (such as import sorting, the\ndocumentation spelling checker, and\ncode formatting), install and run the tox\ncommand from any place in the Django source tree:
Linux / macOS
$ python -m pip install tox\n$ tox\nWindows
...\\> py -m pip install tox\n...\\> tox\nBy default, tox runs the test suite with the bundled test settings file for\nSQLite, black, blacken-docs, flake8, isort, lint-docs,\nzizmor, and the documentation spelling checker. In addition to the system\ndependencies noted elsewhere in this documentation, the command python3\nmust be on your path and linked to the appropriate version of Python. A list of\ndefault environments can be seen as follows:
Linux / macOS
$ tox -l\npy3\nblack\nblacken-docs\nflake8>=3.7.0\ndocs\nisort>=7.0.0\nlint-docs\nzizmor>=1.16.3\nWindows
...\\> tox -l\npy3\nblack\nblacken-docs\nflake8>=3.7.0\ndocs\nisort>=7.0.0\nlint-docs\nzizmor>=1.16.3\nIn addition to the default environments, tox supports running unit tests\nfor other versions of Python and other database backends. Since Django’s test\nsuite doesn’t bundle a settings file for database backends other than SQLite,\nhowever, you must create and provide your own test settings. For example, to run the tests on Python 3.12\nusing PostgreSQL:
Linux / macOS
$ tox -e py312-postgres -- --settings=my_postgres_settings\nWindows
...\\> tox -e py312-postgres -- --settings=my_postgres_settings\nThis command sets up a Python 3.12 virtual environment, installs Django’s\ntest suite dependencies (including those for PostgreSQL), and calls\nruntests.py with the supplied arguments (in this case,\n--settings=my_postgres_settings).
The remainder of this documentation shows commands for running tests without\ntox, however, any option passed to runtests.py can also be passed to\ntox by prefixing the argument list with --, as above.
Tox also respects the DJANGO_SETTINGS_MODULE environment\nvariable, if set. For example, the following is equivalent to the command\nabove:
$ DJANGO_SETTINGS_MODULE=my_postgres_settings tox -e py312-postgres\nWindows users should use:
\n...\\> set DJANGO_SETTINGS_MODULE=my_postgres_settings\n...\\> tox -e py312-postgres\nDjango includes a set of JavaScript unit tests for\nfunctions in certain contrib apps. The JavaScript tests aren’t run by default\nusing tox because they require Node.js to be installed and aren’t\nnecessary for the majority of patches. To run the JavaScript tests using\ntox:
Linux / macOS
$ tox -e javascript\nWindows
...\\> tox -e javascript\nThis command runs npm install to ensure test requirements are up to\ndate and then runs npm test.
django-docker-boxLink para este cabeçalho#django-docker-box allows you to run the Django’s test suite across all\nsupported databases and python versions. See the django-docker-box project\npage for installation and usage instructions.
\nsettingsLink para este cabeçalho#The included settings module (tests/test_sqlite.py) allows you to run the\ntest suite using SQLite. If you want to run the tests using a different\ndatabase, you’ll need to define your own settings file. Some tests, such as\nthose for contrib.postgres, are specific to a particular database backend\nand will be skipped if run with a different backend. Some tests are skipped or\nexpected failures on a particular database backend (see\nDatabaseFeatures.django_test_skips and\nDatabaseFeatures.django_test_expected_failures on each backend).
To run the tests with different settings, ensure that the module is on your\nPYTHONPATH and pass the module with --settings.
O setting DATABASES em qualquer settings de módulo de testes precisa definir dois bancos:
O banco default. Este banco deve usar o backend que você quer usar para testes primários.
Um banco de dados com o apelido other. O banco de dados other é usado para testar consultas que podem ser direcionadas a diferentes bancos de dados. Este banco de dados devem usar o mesmo “backend” que o default, e deve ter um nome diferente.
Se você está usando um backend que não é o SQLite, você irá precisar providenciar outros detalhes para cada banco de dados:
\nA opção USER deve especificar uma conta de usuário válida para o banco de dados. Esse usuário precisa ter permissão para executar CREATE DATABASE de modo que o banco de dados de teste possa ser criado.
A opção PASSWORD precisa fornecer uma senha para o user USER que foi especificado.
Os nomes dos bancos de dados de teste são gerados adicionando o prefixo test_ ao valor do campo NAME das configurações dos bancos de dados definidos dentro de DATABASES. Esses bancos de testes são deletados quando os testes são concluídos.
Você também terá que garantir que o seu banco de dados usa UTF-8 por padrão como charset. Se o servidor do seu banco de dados não usa UTF-8 como charset padrão, você terá que incluir um valor para CHARSET no dicionário do settings de teste para o banco de dados correspondente.
A suíte completa de testes do Django leva um tempo para rodar, e rodar cada um dos testes pode ser redundantes se, por exemplo, você deseja adicionar um teste no Django que você quer rodar rapidamente sem ter que rodar todo o resto. Você pode rodar um subconjunto de testes unitários adicionando os nomes dos módulos de teste para o comando runtests.py na linha de comando.
For example, if you’d like to run tests only for generic relations and\ninternationalization, type:
\nLinux / macOS
$ ./runtests.py --settings=path.to.settings generic_relations i18n\nWindows
...\\> runtests.py --settings=path.to.settings generic_relations i18n\nComo você pode saber os nomes de testes em específico? Procure em tests/ — cada nome de diretório lá representa o nome de um teste.
If you want to run only a particular class of tests, you can specify a list of\npaths to individual test classes. For example, to run the TranslationTests\nof the i18n module, type:
Linux / macOS
$ ./runtests.py --settings=path.to.settings i18n.tests.TranslationTests\nWindows
...\\> runtests.py --settings=path.to.settings i18n.tests.TranslationTests\nGoing beyond that, you can specify an individual test method like this:
\nLinux / macOS
$ ./runtests.py --settings=path.to.settings i18n.tests.TranslationTests.test_lazy_objects\nWindows
...\\> runtests.py --settings=path.to.settings i18n.tests.TranslationTests.test_lazy_objects\nYou can run tests starting at a specified top-level module with --start-at\noption. For example:
Linux / macOS
$ ./runtests.py --start-at=wsgi\nWindows
...\\> runtests.py --start-at=wsgi\nYou can also run tests starting after a specified top-level module with\n--start-after option. For example:
Linux / macOS
$ ./runtests.py --start-after=wsgi\nWindows
...\\> runtests.py --start-after=wsgi\nNote that the --reverse option doesn’t impact on --start-at or\n--start-after options. Moreover these options cannot be used with test\nlabels.
Some tests require Selenium and a web browser. To run these tests, you must\ninstall the selenium package and run the tests with the\n--selenium=<BROWSERS> option. For example, if you have Firefox and Google\nChrome installed:
Linux / macOS
$ ./runtests.py --selenium=firefox,chrome\nWindows
...\\> runtests.py --selenium=firefox,chrome\nVeja o pacote selenium.webdriver para uma lista de navegadores disponíveis.
\nDefinindo o --selenium automaticamente define --tags=selenium para rodar somente testes que requerem o selenium.
Some browsers (e.g. Chrome or Firefox) support headless testing, which can be\nfaster and more stable. Add the --headless option to enable this mode.
For testing changes to the admin UI, the selenium tests can be run with the\n--screenshots option enabled. Screenshots will be saved to the\ntests/screenshots/ directory.
To define when screenshots should be taken during a selenium test, the test\nclass must use the @django.test.selenium.screenshot_cases decorator with a\nlist of supported screenshot types ("desktop_size", "mobile_size",\n"small_screen_size", "rtl", "dark", and "high_contrast"). It\ncan then call self.take_screenshot("unique-screenshot-name") at the desired\npoint to generate the screenshots. For example:
from django.test.selenium import SeleniumTestCase, screenshot_cases\nfrom django.urls import reverse\n\n\nclass SeleniumTests(SeleniumTestCase):\n @screenshot_cases(["desktop_size", "mobile_size", "rtl", "dark", "high_contrast"])\n def test_login_button_centered(self):\n self.selenium.get(self.live_server_url + reverse("admin:login"))\n self.take_screenshot("login")\n ...\nThis generates multiple screenshots of the login page - one for a desktop\nscreen, one for a mobile screen, one for right-to-left languages on desktop,\none for the dark mode on desktop, and one for high contrast mode on desktop\nwhen using chrome.
\nSe você quiser rodar toda a suíte de testes, você precisará instalar algumas dependências:
\naiosmtpd 1.4.5+
argon2-cffi 23.1.0+
asgiref 3.9.1+ (required)
bcrypt 4.1.1+
colorama 0.4.6+
docutils 0.22+
geoip2 4.8.0+
Jinja2 2.11+
numpy 1.26.0+
Pillow 10.1.0+
PyYAML 6.0.2+
redis 5.1.0+
pymemcache, plus a supported Python binding
selenium 4.23.0+
sqlparse 0.5.0+ (required)
tblib 3.0.0+
You can find these dependencies in pip requirements files inside the\ntests/requirements directory of the Django source tree and install them\nlike so:
Linux / macOS
$ python -m pip install -r tests/requirements/py3.txt\nWindows
...\\> py -m pip install -r tests\\requirements\\py3.txt\nSe você encontrar algum erro durante a instalação, talvez esteja faltando no seu sistema alguma dependência de um ou mais pacotes do Python. Consulte a documentação dos pacotes com falha ou faça uma busca na web com a mensagem de erro que você encontrou.
\nVocê também pode instalar o adaptador (ou adaptadores) de sua escolha usando oracle.txt, mysql.txt, ou postgres.txt.
If you want to test the memcached or Redis cache backends, you’ll also need to\ndefine a CACHES setting that points at your memcached or Redis\ninstance respectively.
To run the GeoDjango tests, you will need to set up a spatial database\nand install the Geospatial libraries.
\nCada uma dessas dependências é opcional. Se você estiver esquecendo qualquer uma delas, os testes associados serão pulados.
\nTo run some of the autoreload tests, you’ll need to install the\nWatchman service.
\nVoluntários são encorajados a rodar a cobertura na suíte de testes para identificar áreas que precisam de mais testes. A instalação da ferramenta de cobertura e a sua utilização é descrita em testando a cobertura de código.
\nTo run coverage on the Django test suite using the standard test settings:
\nLinux / macOS
$ coverage run ./runtests.py --settings=test_sqlite\nWindows
...\\> coverage run runtests.py --settings=test_sqlite\nAfter running coverage, combine all coverage statistics by running:
\nLinux / macOS
$ coverage combine\nWindows
...\\> coverage combine\nAfter that generate the html report by running:
\nLinux / macOS
$ coverage html\nWindows
...\\> coverage html\nQuando executar a cobertura para testes do Django, o arquivo de settings incluído .coveragerc define coverage_html como sendo o diretório de saída para o relatório e também exclui vários diretórios não relevantes para os resultados (código de testes ou código externo incluídos no Django).
Django’s continuous integration (CI) system automatically runs code coverage\nanalysis on pull requests and posts a comment with a diff coverage report. This\nhelps reviewers see which lines in the changed code are covered by tests.
\nWhat the coverage report shows:
\nThe coverage report posted on pull requests uses diff-cover to analyze only\nthe lines that were changed or added in the PR. It shows:
\nLines that are covered by tests (✓)
Lines that are not covered by tests (✗)
Lines that cannot be covered (e.g., comments, blank lines)
Important limitations:
\nWhen reviewing coverage reports on pull requests, keep these limitations in\nmind:
\nDatabase-specific code: The CI coverage job runs tests using SQLite on\nWindows. Code paths specific to other databases (PostgreSQL, MySQL, Oracle)\nwill appear as “not covered” even if database-specific tests exist. This is\nexpected and acceptable.
Platform-specific code: Similarly, code that only runs on certain\noperating systems (Linux, macOS) will appear as not covered when run on\nWindows.
Coverage doesn’t equal quality: A line being “covered” only means it was\nexecuted during tests. It doesn’t guarantee the line is well-tested or that\nall edge cases are handled. During review, assess test quality beyond just\ncoverage numbers.
Missing coverage should be considered a warning rather than a blocker and\nshould be evaluated in context.
\nTests for contrib apps can be found in the tests/ directory,\ntypically under <app_name>_tests. For example, tests for contrib.auth\nare located in tests/auth_tests.
main branchLink para este cabeçalho#Ensure you have the latest point release of a supported Python version, since there are often bugs in earlier versions\nthat may cause the test suite to fail or hang.
\nOn macOS (High Sierra and newer versions), you might see this message\nlogged, after which the tests hang:
\nobjc[42074]: +[__NSPlaceholderDate initialize] may have been in progress in\nanother thread when fork() was called.\nTo avoid this set a OBJC_DISABLE_INITIALIZE_FORK_SAFETY environment\nvariable, for example:
$ OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES ./runtests.py\nOr add export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES to your shell’s\nstartup file (e.g. ~/.profile).
UnicodeEncodeErrorLink para este cabeçalho#Se o pacote de locales não estiver instalado, alguns testes irão falhar com um UnicodeEncodeError.
You can resolve this on Debian-based systems, for example, by running:
\n$ apt-get install locales\n$ dpkg-reconfigure locales\nYou can resolve this for macOS systems by configuring your shell’s locale:
\n$ export LANG="en_US.UTF-8"\n$ export LC_ALL="en_US.UTF-8"\nExecute o comando locale para confirmar a alteração. Opcionalmente, adicione os comandos de “export” para o arquivo de inicialização do seu “shell” (exemplo ~/.bashrc para o Bash) para evitar ter que redefini-los.
Caso um teste passe quando rodado isoladamente mas que falhe quando rodado dentro de uma suíte inteira de testes, nós temos algumas ferramentas para ajudar a analizar o problema.
\nA opção --bisect do runtests.py irá executar o teste que falhou enquanto reparte o conjunto de testes do qual o teste falho faz parte a cada nova iteração, geralmente permitindo identificar um pequeno número de testes que podem estar relacionados com a falha.
For example, suppose that the failing test that works on its own is\nModelTest.test_eq, then using:
Linux / macOS
$ ./runtests.py --bisect basic.tests.ModelTest.test_eq\nWindows
...\\> runtests.py --bisect basic.tests.ModelTest.test_eq\nNós vamos tentar descobrir um teste que interfere com o teste escolhido. Primeiro, o teste é rodado com a primeira metade da suíte de testes. Se uma falha ocorrer, a primeira metade da suíte de testes é dividida em dois grupos e cada grupo é então rodado com o teste especificado. Se não existe falha com a primeira metade da suíte de testes, a segunda metade da suíte é rodada com o teste especificado e dividida apropriadamente conforme descrito anteriormente. O processo se repete até que o conjunto de testes que falham é minimizado.
\nThe --pair option runs the given test alongside every other test from the\nsuite, letting you check if another test has side-effects that cause the\nfailure. So:
Linux / macOS
$ ./runtests.py --pair basic.tests.ModelTest.test_eq\nWindows
...\\> runtests.py --pair basic.tests.ModelTest.test_eq\nnós vamos parear test_eq com cada rótulo de teste
With both --bisect and --pair, if you already suspect which cases\nmight be responsible for the failure, you may limit tests to be cross-analyzed\nby specifying further test labels after\nthe first one:
Linux / macOS
$ ./runtests.py --pair basic.tests.ModelTest.test_eq queries transactions\nWindows
...\\> runtests.py --pair basic.tests.ModelTest.test_eq queries transactions\nYou can also try running any set of tests in a random or reverse order using\nthe --shuffle and --reverse options. This can help verify that\nexecuting tests in a different order does not cause any trouble:
Linux / macOS
$ ./runtests.py basic --shuffle\n$ ./runtests.py basic --reverse\nWindows
...\\> runtests.py basic --shuffle\n...\\> runtests.py basic --reverse\nIf you wish to examine the SQL being run in failing tests, you can turn on\nSQL logging using the --debug-sql option. If you\ncombine this with --verbosity=2, all SQL queries will be output:
Linux / macOS
$ ./runtests.py basic --debug-sql\nWindows
...\\> runtests.py basic --debug-sql\nBy default tests are run in parallel with one process per core. When the tests\nare run in parallel, however, you’ll only see a truncated traceback for any\ntest failures. You can adjust this behavior with the --parallel option:
Linux / macOS
$ ./runtests.py basic --parallel=1\nWindows
...\\> runtests.py basic --parallel=1\nYou can also use the DJANGO_TEST_PROCESSES environment variable for\nthis purpose.
To avoid polluting the global apps registry and prevent\nunnecessary table creation, models defined in a test method should be bound to\na temporary Apps instance. To do this, use the\nisolate_apps() decorator:
from django.db import models\nfrom django.test import SimpleTestCase\nfrom django.test.utils import isolate_apps\n\n\nclass TestModelDefinition(SimpleTestCase):\n @isolate_apps("app_label")\n def test_model_definition(self):\n class TestModel(models.Model):\n pass\n\n ...\n