Doctests

De Stoq Wiki
Ir para: navegação, pesquisa

Doctests para módulos de domínio

Doctests para módulos de domínio serão escritos sempre em arquivo no formato .txt e no idioma inglês. A parte de documentação destes arquivos fará uso da sintaxe do componente do pacote docutils reStructuredText. A documentação sobre a sintaxe se encontra em uma Quick reference page. Haverá sempre um arquivo doctest para cada arquivo presente em stoq/domain, sendo que estes deverão estar localizados no diretório docs/domain.

A grande vantagem de documentar os testes usando a sintaxe do docutils é permitir gerar .htmls facilmente baseados nestes arquivos e que serão posteriormente integrados na página do Stoq. Vide script buildhtml.py do docutils.

Para testar a suíte de doctests faça:

 $ cd stoq/tests
 $ ./runtests.py

Um argumento '-v' irá listar em detalhes a execução dos testes. Por padrão a base de dados de exemplo é criada automaticamente ao se executar este script. Para pular esta etapa basta fornecer um argumento '-i'.

É recomendável usar uma base de dados exclusiva para testes. Ao executar runtests.py o sistema procura pela base de dados de testes definida em ~/.stoq/stoq.conf na seção testdb. Caso o desenvolvedor não deseje usar uma base exclusiva para testes basta definir nesta seção o mesmo nome da base de dados padrão do sistema.