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

Se você estiver usando Python 2, você primeiro terá que instalar uma backport do módulo unittest.mock que está disponível no Python 3. Veja Rodando todos os testes para mais detalhes na instalação do mock e de outras dependências opcionais de teste.

Rodar os testes requer um módulo settings do Django que defina qual banco de dados usar. Para simplificar, Django fornece e usa um settings sample que utiliza o banco de dados SQLite. Para rodar os testes:

$ git clone https://github.com/django/django.git django-repo
$ cd django-repo/tests
$ PYTHONPATH=..:$PYTHONPATH ./runtests.py

Usuários Windows

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

Você pode evitar ter que escrever PYTHONPATH toda vez adicionando o local em que o código do Django foi baixado para o seu PYTHONPATH ou instalando o source checkout usando o pip. Veja Instalando a versão de desenvolvimento..

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

Usando outro módulo settings

O módulo settings incluído permite que você rode os testes usando o SQLite. Se você deseja testar um comportamento usando um banco diferente (e se você está propondo patches para o Django, é uma boa ideia testar para diferentes bancos), você pode precisar definir o seu próprio arquivo settings.

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 alias other. O banco de dados other é usado para estabelecer que queries podem ser direcionadas para bancos de dados diferentes. Como resultado, esse banco de dados pode usar qualquer backend que você deseje. Ele não precisa usar o mesmo backend como o banco de dados default (embora ele possa usar o mesmo backend se você quiser). Ele não pode ser o mesmo banco de dados que o default.

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 precisam do Selenium e de um Web browser (Firefox, Google Chrome, ou Internet Explorer). Para permitir que esses testes rodem ao invés de serem pulados, você deve instalar o pacote selenium dentro do seu Python path e executar os testes com a opção:: --selenium

$ ./runtests.py --settings=test_sqlite --selenium admin_inlines

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  # Python 2: py2.txt

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

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
New in Django 1.8:

As opções --reverse e --debug-sql foram adicionadas.

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.

New in Django 1.9:

Suporte para rodar testes em paralelo e a opção --parallel foram adicionados.

Back to Top