Testes unitários

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.

Todos 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.

Rodando os testes unitários

Início Rápido

Primeiro, faça o “fork”do Django no GitHub.

Segundo, crie e ative um ambiente virtual. Se não estiver familiar de como fazê-lo, leia nosso tutorial de como contribuir.

Depois, clone o “fork”, instale alguns requisitos, e rode os testes:

$ git clone git@github.com:YourGitHubName/django.git django-repo
$ cd django-repo/tests
$ pip install -e ..
$ pip install -r requirements/py3.txt
$ ./runtests.py

Ao 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.

If you have trouble installing the requirements, you can skip that step. See Rodando todos os testes for details on installing the optional test dependencies. If you don’t have an optional dependency installed, the tests that require it will be skipped.

Rodando 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.

Usuários Windows

Nós recomendamos algo como Git Bash para rodar os testes usando a abordagem acima.

Está tendo problemas? Veja Solução de Problemas para alguns problemas comuns.

Running tests using tox

Tox is a tool for running tests in different virtual environments. Django includes a basic tox.ini that automates some checks that our build server performs on pull requests. To run the unit tests and other checks (such as import sorting, the documentation spelling checker, and code formatting), install and run the tox command from any place in the Django source tree:

$ pip install tox
$ tox

By default, tox runs the test suite with the bundled test settings file for SQLite, flake8, isort, and the documentation spelling checker. In addition to the system dependencies noted elsewhere in this documentation, the command python3 must be on your path and linked to the appropriate version of Python. A list of default environments can be seen as follows:

$ tox -l
py3
flake8
docs
isort

Testing other Python versions and database backends

In addition to the default environments, tox supports running unit tests for other versions of Python and other database backends. Since Django’s test suite doesn’t bundle a settings file for database backends other than SQLite, however, you must create and provide your own test settings. For example, to run the tests on Python 3.5 using PostgreSQL:

$ tox -e py35-postgres -- --settings=my_postgres_settings

This command sets up a Python 3.5 virtual environment, installs Django’s test suite dependencies (including those for PostgreSQL), and calls runtests.py with the supplied arguments (in this case, --settings=my_postgres_settings).

The remainder of this documentation shows commands for running tests without tox, however, any option passed to runtests.py can also be passed to tox by prefixing the argument list with --, as above.

Tox also respects the DJANGO_SETTINGS_MODULE environment variable, if set. For example, the following is equivalent to the command above:

$ DJANGO_SETTINGS_MODULE=my_postgres_settings tox -e py35-postgres

Running the JavaScript tests

Django includes a set of JavaScript unit tests for functions in certain contrib apps. The JavaScript tests aren’t run by default using tox because they require Node.js to be installed and aren’t necessary for the majority of patches. To run the JavaScript tests using tox:

$ tox -e javascript

This command runs npm install to ensure test requirements are up to date and then runs npm test.

Usando outro módulo settings

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:

  • A 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.

Rodando apenas alguns dos testes.

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:

$ ./runtests.py --settings=path.to.settings generic_relations i18n

Como 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

Indo além disso, você pode especificar um método de teste em específico da seguinte forma:

$ ./runtests.py --settings=path.to.settings i18n.tests.TranslationTests.test_lazy_objects

Rodando os testes do Selenium

Alguns 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

Veja o pacote selenium.webdriver para uma lista de navegadores disponíveis.

Definindo o --selenium automaticamente define --tags=selenium para rodar somente testes que requerem o selenium.

Rodando todos os testes

Se você quiser rodar toda a suíte de testes, você precisará instalar algumas dependências:

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

Se 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.

Você 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.

Cada uma dessas dependências é opcional. Se você estiver esquecendo qualquer uma delas, os testes associados serão pulados.

Cobertura de código

Voluntá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.

A 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

$ coverage run ./runtests.py --settings=test_sqlite --parallel=1

Depois de rodar a cobertura, gere um relatório html através do comando:

$ coverage html

Quando 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).

Contrib apps

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.

Solução de Problemas

Vários testes falham com UnicodeEncodeError

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:

$ apt-get install locales
$ dpkg-reconfigure locales

Para sistemas macOS você pode resolver configurando a localização do seu “shell”:

$ export LANG="en_US.UTF-8"
$ export LC_ALL="en_US.UTF-8"

Execute 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.

Testes que só falham em combinação

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.

A 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:

$ ./runtests.py --bisect basic.tests.ModelTest.test_eq

Nó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.

A 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

nó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:

$ ./runtests.py --pair basic.tests.ModelTest.test_eq queries transactions

Você 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

Verificando as consultas SQL realizadas durante os testes

Se 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

Visualizando todo o traceback de um teste falho

Por 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

Você também pode usar a variável de ambiente DJANGO_TEST_PROCESSES para isso.

Dicas para rodar testes

Isolando o registro de modelos

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
from django.db import models
from django.test import SimpleTestCase

class TestModelDefinition(SimpleTestCase):
    def test_model_definition(self):
        test_apps = Apps(['app_label'])

        class TestModel(models.Model):
            class Meta:
                apps = test_apps
        ...
django.test.utils.isolate_apps(*app_labels, attr_name=None, kwarg_name=None)

Já 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
from django.test import SimpleTestCase
from django.test.utils import isolate_apps

class TestModelDefinition(SimpleTestCase):
    @isolate_apps('app_label')
    def test_model_definition(self):
        class TestModel(models.Model):
            pass
        ...

A definição app_label

Modelos definidos em um método de teste sem explicitar o app_label são automaticamente assinalados com a etiqueta da aplicação na qual sua classe de teste está localizada.

De modo a ter certeza que os modelos definidos dentro do contexto das instâncias de isolate_apps() estão corretamente instalados, você deve passar a definição dos app_label alvo como argumentos:

tests/app_label/tests.py
from django.db import models
from django.test import SimpleTestCase
from django.test.utils import isolate_apps

class TestModelDefinition(SimpleTestCase):
    @isolate_apps('app_label', 'other_app_label')
    def test_model_definition(self):
        # This model automatically receives app_label='app_label'
        class TestModel(models.Model):
            pass

        class OtherAppModel(models.Model):
            class Meta:
                app_label = 'other_app_label'
        ...

O decorador pode também ser aplicado a classes:

from django.db import models
from django.test import SimpleTestCase
from django.test.utils import isolate_apps

@isolate_apps('app_label')
class TestModelDefinition(SimpleTestCase):
    def test_model_definition(self):
        class TestModel(models.Model):
            pass
        ...

A 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
from django.test import SimpleTestCase
from django.test.utils import isolate_apps

@isolate_apps('app_label', attr_name='apps')
class TestModelDefinition(SimpleTestCase):
    def test_model_definition(self):
        class TestModel(models.Model):
            pass
        self.assertIs(self.apps.get_model('app_label', 'TestModel'), TestModel)

Ou 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
from django.test import SimpleTestCase
from django.test.utils import isolate_apps

class TestModelDefinition(SimpleTestCase):
    @isolate_apps('app_label', kwarg_name='apps')
    def test_model_definition(self, apps):
        class TestModel(models.Model):
            pass
        self.assertIs(apps.get_model('app_label', 'TestModel'), TestModel)
Back to Top