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.
\nDepois, clone o “fork”, instale alguns requisitos, e rode os testes:
\n$ git clone https://github.com/YourGitHubName/django.git django-repo\n$ cd django-repo/tests\n$ pip install -e ..\n$ pip install -r requirements/py3.txt\n$ ./runtests.py\nAo instalar os requisitos podem ser requeridos pacotes que ainda não estão instalados no seu computador. Você pode descobrir quais pacotes estão faltando, procurando na internet os termos da última linha da mensagem de erro da instalação. Tente adicionar o nome do seu sistema operacional nos termos procurados se necessário.
\nIf you have trouble installing the requirements, you can skip that step. See\nRodando todos os testes for details on installing the optional\ntest dependencies. If you don’t have an optional dependency installed, the\ntests that require it will be skipped.
\nRodando os testes requer um módulo de configuração Django que defina qual banco de dados usar. Para simplificar no início, Django fornece e usa um módulo de configuração de exemplo que usa o banco de dados SQLite. Veja em Usando outro módulo settings para aprender em como usar uma configuração diferente para executar os testes com um banco de dados diferente.
\n\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\nvirtual environments. Django includes a basic tox.ini that automates some\nchecks that our build server performs on pull requests. To run the unit tests\nand other 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:
$ pip install tox\n$ tox\nBy default, tox runs the test suite with the bundled test settings file for\nSQLite, flake8, isort, and the documentation spelling checker. In\naddition to the system dependencies noted elsewhere in this documentation,\nthe command python3 must be on your path and linked to the appropriate\nversion of Python. A list of default environments can be seen as follows:
$ tox -l\npy3\nflake8\ndocs\nisort\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.5\nusing PostgreSQL:
$ tox -e py35-postgres -- --settings=my_postgres_settings\nThis command sets up a Python 3.5 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 variable, if set.\nFor example, the following is equivalent to the command above:
$ DJANGO_SETTINGS_MODULE=my_postgres_settings tox -e py35-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:
$ 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#O módulo de definições (tests/test_sqlite.py) permite que você execute a suíte de testes usando o SQLite. Se quiser rodar os testes usando um banco de dados diferente, você precisa definir seu próprio arquivo de definições. Alguns testes, como aqueles para o contrib.postgres, são específicos para um “backend” particular de banco de dados e serão deixados de lado se executados com um “backend” diferente.
Para rodar os testes com um settings diferente, certifique-se de que o módulo está no seu PYTHONPATH e passe o módulo com --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.
Por exemplo, se você gostaria de rodar testes somente para internacionalização e relações genéricas, digite:
\n$ ./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.
Se você quiser rodar uma classe de testes em particular, você pode especificar uma lista de caminhos para cada uma das classes de testes. Por exemplo, para rodar a classe TranslationTests do módulo i18n, digite:
$ ./runtests.py --settings=path.to.settings i18n.tests.TranslationTests\nIndo além disso, você pode especificar um método de teste em específico da seguinte forma:
\n$ ./runtests.py --settings=path.to.settings i18n.tests.TranslationTests.test_lazy_objects\nAlguns testes requerem o Selenium e um navegador Web. Para rodar estes testes, você deve instalar o pacote slenium e rodar os testes com a opção --selenium=<BROWSERS>. Por exemplo, se você tem instalado o Firefox e o Google Chrome.
$ ./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.
Se você quiser rodar toda a suíte de testes, você precisará instalar algumas dependências:
\nargon2-cffi 16.1.0+
jinja2 2.7+
Pillow 4.2.0+
pytz (required)
sqlparse 0.2.2+ (required)
tblib 1.5.0+
Você pode encontrar essas dependências no arquivo de requirements do pip no diretório tests/requirements dentro do local onde o código-fonte do Django foi baixado e instalá-las da seguinte forma:
$ pip install -r tests/requirements/py3.txt\nSe encontrar algum erro durante a instalação, talvez esteja faltando no seu sistema alguma dependência de um ou mais pacotes Python. Consulte a documentação de pacotes faltantes ou procure na Web a mensagem de erro que encontrou.
\nVocê também pode instalar o adaptador (ou adaptadores) de sua escolha usando oracle.txt, mysql.txt, ou postgres.txt.
Se você quiser testar o backend memcached, você também terá que definir uma configuração CACHES que aponte para a sua instância do memcached.
Para rodar os testes do GeoDjango, você precisará instalar um banco de dados espacial e instalar as bibliotecas geoespaciais.
\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 Watchman\nservice.
\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.
\nA Cobertura deve ser executada em um único processo para obter estatísticas apuradas. Para rodar a cobertura na suíte de testes do Django usando configurações padrão de testes
\n$ coverage run ./runtests.py --settings=test_sqlite --parallel=1\nDepois de rodar a cobertura, gere um relatório html através do comando:
\n$ 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).
Testes para apps contrib pode ser encontrados no diretório tests/, tipicamente em <nome_app>_tests. Por exemplo, testes para o contrib.auth estão localizados em tests/auth_tests.
master 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.
Você pode solucionar isso em sistemas baseados em Debian, por exemplo, rodando o comando:
\n$ apt-get install locales\n$ dpkg-reconfigure locales\nPara sistemas macOS você pode resolver configurando a localização do seu “shell”:
\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.
Por exemplo, suponha que o teste que falha em grupo mas que funciona sozinho é o ``ModelTest.test_eq`, então usando:
\n$ ./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.
\nA opção --pair executa os testes dados junto de cada um dos demais testes da suíte, permitindo que você verifique se outro teste tem algum efeito colateral que causa a falha. Então:
$ ./runtests.py --pair basic.tests.ModelTest.test_eq\nnós vamos parear test_eq com cada rótulo de teste
Se você já tem uma suspeita de quais casos podem estar sendo responsáveis pela falha, você pode limitar os testes para fazer uma análise cruzada especificando mais rótulos de teste depois do primeiro:
\n$ ./runtests.py --pair basic.tests.ModelTest.test_eq queries transactions\nVocê também pode tentar rodar qualquer conjunto de testes em ordem reversa usando a opção --reverse para verificar se a execução dos testes em uma ordem diferente não causa problemas:
$ ./runtests.py basic --reverse\nSe você quer examinar o SQL sendo rodado em testes falhos, você pode ativar o SQL logging usando a opção --debug-sql. Se você combinar isso com --verbosity=2, todas as consultas SQL serão exibidas:
$ ./runtests.py basic --debug-sql\nPor padrão testes são executados em paralelo com um processo por core. Quando os testes são rodados em paralelo, porém, você só verá um traceback truncado em cada teste que falhar. Você pode ajustar esse comportamento com a opção --parallel.
$ ./runtests.py basic --parallel=1\nVocê também pode usar a variável de ambiente DJANGO_TEST_PROCESSES para isso.
Para evitar popular o registro apps global e prevenir que tabelas desnecessárias sejam criadas, os modelos definem um método de teste que deve ser vinculado a uma instância de Apps.
from django.apps.registry import Apps\nfrom django.db import models\nfrom django.test import SimpleTestCase\n\nclass TestModelDefinition(SimpleTestCase):\n def test_model_definition(self):\n test_apps = Apps(['app_label'])\n\n class TestModel(models.Model):\n class Meta:\n apps = test_apps\n ...\nJá que este padrão de desenvolvimento envolve vários códigos clichés, o Django fornece o decorador isolate_apps(). Este é usado assim:
from django.db import models\nfrom django.test import SimpleTestCase\nfrom django.test.utils import isolate_apps\n\nclass TestModelDefinition(SimpleTestCase):\n @isolate_apps('app_label')\n def test_model_definition(self):\n class TestModel(models.Model):\n pass\n ...\nO decorador pode também ser aplicado a classes:
\nfrom django.db import models\nfrom django.test import SimpleTestCase\nfrom django.test.utils import isolate_apps\n\n@isolate_apps('app_label')\nclass TestModelDefinition(SimpleTestCase):\n def test_model_definition(self):\n class TestModel(models.Model):\n pass\n ...\nA instância de Apps temporárias usadas para isolar o registro de modelos pode ser obtida como um atributo quando usado como um decorador de classe através do parâmetro attr_name:
from django.db import models\nfrom django.test import SimpleTestCase\nfrom django.test.utils import isolate_apps\n\n@isolate_apps('app_label', attr_name='apps')\nclass TestModelDefinition(SimpleTestCase):\n def test_model_definition(self):\n class TestModel(models.Model):\n pass\n self.assertIs(self.apps.get_model('app_label', 'TestModel'), TestModel)\nOu como argumento do método de teste usado como um decorador de métodos através do uso do parâmetro kwarg_name:
from django.db import models\nfrom django.test import SimpleTestCase\nfrom django.test.utils import isolate_apps\n\nclass TestModelDefinition(SimpleTestCase):\n @isolate_apps('app_label', kwarg_name='apps')\n def test_model_definition(self, apps):\n class TestModel(models.Model):\n pass\n self.assertIs(apps.get_model('app_label', 'TestModel'), TestModel)\n