PDF - VERSÃO DE IMPRESSÃO

Lição 19 - Frameworks de testes do Python

objetivo

Olá, estudante, tudo bem? Na lição passada, compreendemos o uso de controles, eventos e propriedades, agora, dando sequência aos nossos estudos, você conhecerá os frameworks de testes da linguagem de programação Python! Preparado(a)?

O objetivo desta lição é apresentar os conceitos e práticas fundamentais dos frameworks de testes no Python, com enfoque particular nas ferramentas mais amplamente utilizadas, como unittest, pytest e doctest. Você aprenderá a importância dos testes automatizados no desenvolvimento de software, como eles contribuem para a manutenção da qualidade do código e a prevenção de bugs.

Na lição, você verá desde a configuração básica dos frameworks de testes até a implementação de testes unitários, de integração e funcionais. Será demonstrado como desenvolver testes eficazes, como interpretar seus resultados e integrá-los ao fluxo de desenvolvimento contínuo. Por meio de exemplos práticos, você adquirirá as habilidades necessárias para aplicar esses frameworks em seus próprios projetos, garantindo assim que seu código, além de robusto e confiável, mantenha alta qualidade ao longo do tempo. São muitos conteúdos, então, sem mais demora, vamos lá!

problematização

No desenvolvimento de sistemas, garantir que o código funcione corretamente e esteja livre de erros é um desafio contínuo. Sem mecanismos adequados para verificar a funcionalidade do software, erros podem passar despercebidos, resultando em falhas críticas que afetam a experiência do usuário e a confiabilidade do sistema.

Nesse sentido, frameworks de testes em Python, como unittest, pytest e doctest, oferecem uma solução robusta, pois permitem a criação de testes automatizados que verificam o comportamento do código em diversas situações, desde testes unitários até testes funcionais. A implementação desses frameworks resulta em benefícios significativos, como a detecção precoce de erros, maior eficiência no processo de desenvolvimento e melhor documentação do comportamento esperado do sistema.

Com uma base sólida de testes, a manutenção e a evolução do software tornam-se mais seguras e previsíveis, o que resulta em um produto final de alta qualidade, apto a atender às expectativas dos usuários e aos requisitos de negócios. Portanto, sabendo o quanto a utilização de frameworks de testes em Python é importante, vamos nos aprofundar?

case

Para que você possa conectar a utilização de frameworks de testes em Python com algo prático, conheça uma empresa especializada no desenvolvimento de software para startups, a qual enfrentava problemas constantes com a qualidade de seus produtos. Muitos dos sistemas desenvolvidos apresentavam erros após o lançamento, gerando retrabalho e insatisfação dos clientes. A falta de um processo de teste sistemático resultava em falhas que passavam despercebidas durante o desenvolvimento e só eram detectadas em produção, portanto, afetava tanto a confiabilidade quanto a reputação da empresa.

Para resolver essa situação, a equipe de desenvolvimento decidiu adotar frameworks de testes em Python, como unittest e pytest. A equipe começou pela criação de testes unitários com objetivo de validar individualmente cada função e método do código. Além disso, foram implementados testes de integração para garantir que os diferentes módulos do sistema funcionassem corretamente juntos, e testes funcionais para verificar a aplicação do ponto de vista do usuário final. A utilização desses frameworks possibilitou a execução automática e repetida dos testes, garantindo que qualquer modificação no código fosse verificada imediatamente quanto a possíveis erros.

Ao final do projeto, a implementação dos frameworks de testes resultou em melhorias significativas na qualidade dos produtos da empresa. Os erros passaram a ser detectados e corrigidos rapidamente, antes mesmo de os sistemas serem lançados em produção, com isso, a empresa observou aumento na eficiência do processo de desenvolvimento, além da redução considerável no retrabalho.

Assim, com esse exemplo, mesmo sendo hipotético, conseguimos notar uma aplicação prática do conteúdo da lição de hoje! Agora, vamos nos aprofundar!

Conceitualização

Os testes automatizados são uma prática essencial no desenvolvimento de software, consistindo em scripts que executam testes predefinidos para verificar a funcionalidade do código de forma automática. Eles desempenham um papel importante na garantia da qualidade do software, pois detectam e previnem bugs antes que o código seja liberado para produção. De acordo com Matthes (2023), ao escrever testes, você confiará que seu código funcionará corretamente quando mais pessoas começarem a usar seus programas.

Nesse contexto, a importância dos testes automatizados reside na capacidade deles de fornecer feedback rápido sobre a integridade do software após cada alteração, permitindo que os desenvolvedores identifiquem e corrijam problemas rapidamente. Portanto, é certo afirmar o seguinte: os testes automatizados contribuem significativamente para a manutenção da qualidade do código, aumentando a eficiência do processo de desenvolvimento e a satisfação do usuário final.

Visão geral dos frameworks de testes em Python

No ecossistema Python, três frameworks de testes destacam-se por sua popularidade e eficácia, sendo eles: unittest, pytest e doctest. Cada um deles tem suas próprias características e vantagens, veremos com mais detalhes cada um deles, porém, de maneira geral, o unittest é ideal para projetos que requerem uma estrutura de teste rigorosa e completa; o pytest é preferido por sua facilidade de uso e capacidade de extensão; o doctest caracteriza-se por ser particularmente útil para garantir a precisão da documentação técnica. Assim, a escolha do framework adequado depende das necessidades específicas do projeto e das preferências da equipe de desenvolvimento.

Unittest

O unittest é o framework de testes integrado ao Python projetado para fornecer uma estrutura robusta à criação e à organização de testes automatizados. Inspirado no JUnit de Java, ele é amplamente utilizado por desenvolvedores devido à sua familiaridade e às suas capacidades abrangentes. O unittest permite que os desenvolvedores escrevam testes de unidade, os quais verificam a funcionalidade de pequenas partes do código, como funções ou métodos individuais. Sobre esse assunto, Matthes (2023) nos fala que os testes de unidade verificam se um aspecto específico do comportamento de uma função está correto.

A estrutura básica de um teste unitário usando unittest envolve a criação de uma classe de teste que é herdada de unittest.TestCase. Dentro dessa classe, são definidos métodos de teste, cada um começando com a palavra “test”. Esses métodos contêm as chamadas para o código que está sendo testado, bem como as asserções as quais verificam se o comportamento do código é o esperado. Veja um exemplo na Figura 1:

Figura 1 - UnittestFonte: o autor.

#PraCegoVer: a figura é uma captura de tela que mostra na linha 1 import unittest na linha 3 def soma(a, b): na linha 4 return a + b na linha 6 class TestSoma(unittest.TestCase): na linha 7 def test_soma_positivos(self): na linha 8 self.assertEqual(soma(1, 2), 3) na linha 10 def test_soma_positivo_negativo(self): na linha 14 self.assertEqual(soma(1, -1), 0) na linha 16 if __name__ == '__main__': na linha 17 unittest.main(). Nas linhas 2, 5, 9, 12 e 15 não há conteúdo escrito.

Observe como, nesse exemplo, temos uma função soma que é testada por três métodos na classe TestSoma. Cada método usa uma asserção assertEqual para verificar se a função soma retorna o resultado esperado para diferentes entradas. Além disso, note que a execução dos testes pode ser feita rodando o script diretamente, o que invocará unittest.main() para descobrir e executar todos os métodos de teste definidos na classe. Durante a execução, o unittest fornece relatórios detalhados sobre quais testes passaram, falharam ou apresentaram erros, permitindo a identificação tão rápida quanto precisa de problemas no código.

Resumidamente, unittest é o framework integrado ao Python inspirado no JUnit de Java, amplamente utilizado devido à sua robustez e à familiaridade para quem já conhece outras ferramentas de testes. Ele oferece uma estrutura completa para escrever e organizar testes, incluindo suporte a fixtures, testes de unidade e de integração.

Pytest

O pytest é um framework de testes poderoso e flexível para Python que facilita a escrita e a execução de testes. Ele é conhecido por sua simplicidade e por permitir que os desenvolvedores escrevam testes com menos código boilerplate (trechos de códigos repetitivos) em comparação ao unittest. O pytest suporta testes unitários, testes de integração e testes funcionais, tornando-se uma escolha popular para projetos de todas as escalas.

Em comparação com o unittest, veja que o pytest oferece várias vantagens, como:

Sintaxe simplificada: não há necessidade de criar classes de teste, você pode escrever testes como funções simples.
Melhores relatórios de erro: os relatórios de falhas do pytest são mais detalhados e amigáveis.
Fixtures poderosas: o pytest usa fixtures (conjuntos de dados) para configurar e limpar o estado antes e depois dos testes, facilitando a reutilização do código.
Parametrização: permite executar o mesmo teste com múltiplas entradas de dados, o que economiza tempo e esforço.
Extensibilidade: o pytest possui grande variedade de plugins que adicionam funcionalidades, como integração contínua e testes de desempenho.

Veja, na Figura 2, um exemplo em que se utiliza o pytest:

Figura 2 - PytestFonte: o autor.

#PraCegoVer: a figura é uma captura de tela que mostra na linha 1 import pytest na linha 3 def soma(a, b): na linha 4 return a + b na linha 6 def test_soma_positivos(): na linha 7 assert soma(1, 2) == 3 na linha 9 def test_soma_negativos(): na linha 10 assert soma(-1, -2) == -3 na linha 12 def test_soma_positivo_negativo(): na linha 13 assert soma(1, -1) == 0. Nas linhas 2, 4, 8 e 11 não há conteúdo escrito.

Para executar os testes, basta utilizar o comando pytest no diretório onde o arquivo de teste está localizado. Nesse exemplo, temos a conversão do exemplo da Figura 1 com o unittest para o pytest.

De maneira geral, o pytest é conhecido por sua simplicidade e poder. Ele possibilita escrever testes com menos código e oferece uma sintaxe mais intuitiva, facilitando a criação bem como a manutenção dos testes. O pytest também suporta uma ampla variedade de plugins que estendem suas funcionalidades, tornando-o altamente flexível e adaptável a diferentes necessidades de teste.

Doctest

O doctest é um módulo embutido no Python que possibilita incluir testes diretamente nas docstrings (uma forma de documentação usada em código-fonte para explicar o propósito e o funcionamento de funções, classes, métodos ou módulos) e, assim, facilita a validação de exemplos de uso, além de garantir que o código se mantenha correto ao longo do desenvolvimento.

Esse módulo testa exemplos interativos inseridos nas docstrings de funções, métodos, classes ou módulos, comparando a saída real com a esperada. A simplicidade do doctest torna-o uma ferramenta excelente para documentação e validação simultâneas. De maneira geral, os testes no doctest são escritos como se fossem exemplos de uso interativo do Python. Eles são incluídos nas docstrings das funções, métodos, classes ou módulos, e executados para verificar se o output dos exemplos corresponde ao esperado. Veja um exemplo de aplicação na Figura 3:

Figura 3 - DoctestFonte: o autor.

#PraCegoVer: a figura é uma captura de tela que mostra na linha 1 def soma(a, b): na linha 2 """ na linha 3 Retorna a soma de dois números. Na linha 5 >>> soma(1, 2) na linha 6 3 na linha 7 >>> soma(-1, -2) na linha 8 -3 na linha 9 >>> soma(1, -1) na linha 10 0 na linha 11 """ na linha 12 return a + b na linha 14 if __name__ == "__main__": na linha 15 import doctest na linha 16 doctest.testmod(). Nas linhas 4 e 13 não há conteúdo descrito.

Quando você executa o script, o doctest procura pelas docstrings e executa os testes. Assim, se todos os testes passarem, não haverá output. Porém, caso algum teste falhe, o doctest exibirá uma mensagem de erro detalhando a discrepância. Se preferir, você também pode rodar os testes do doctest diretamente na linha de comando: python -m doctest -v nome_do_arquivo.py

Uma vantagem significativa do doctest é sua integração com a documentação do código. Como os testes são escritos diretamente nas docstrings, eles servem como exemplos práticos de uso do código. Isso não só ajuda na manutenção da documentação atualizada, mas também assegura que os exemplos fornecidos realmente funcionem conforme esperado.

Resumidamente, o doctest é um framework mais específico, projetado para testar exemplos de código embutidos na documentação. Ele verifica se os resultados apresentados na documentação correspondem à saída real do código, garantindo que os exemplos estejam corretos e atualizados.

Agora, chegando ao final da lição, espero que você tenha adquirido uma compreensão sólida dos principais frameworks de teste em Python, visto que eles são essenciais para garantir a qualidade e a robustez do código, por meio de diferentes abordagens da criação e execução de testes.

Ao dominar essas ferramentas, você estará bem preparado(a) para implementar práticas eficazes de teste e manutenção em seus projetos Python, portanto, promoverá o desenvolvimento mais confiável e eficiente.

saiba aplicar

A compreensão e aplicação dos frameworks de testes em Python, como unittest, pytest e doctest, são essenciais para você, futuro(a) Técnico em Desenvolvimento de Sistemas, pois, como vimos, esse conhecimento proporciona o controle rigoroso sobre a qualidade do código. De maneira geral, os testes automatizados identificam e corrigem erros de forma precoce, evitando que falhas se propaguem para as versões finais do software, assim, ao utilizar essas ferramentas, é possível garantir que o código funciona conforme o esperado em diferentes cenários, facilitando tanto a manutenção quanto a evolução do sistema.

Nesse contexto, o domínio desses frameworks, além de melhorar a robustez do software, também contribui com a eficiência do processo de desenvolvimento, pois permite que alterações sejam feitas com maior segurança e agilidade.

Agora, chega de conversa! Vamos colocar a mão na massa utilizando o framework pytest, esse que vimos nesta lição? Para isso, primeiramente, você deverá instalá-lo em sua máquina, por meio do comando: pip install pytest

O desafio é criar o arquivo, como o disponibilizado na Figura 4, contendo a funcionalidade que você deseja testar. A seguir, temos um exemplo simples de um arquivo chamado calculator.py, que contém funções básicas de uma calculadora. Observe:

Figura 4 - calculator.pyFonte: o autor.

#PraCegoVer: a figura é uma captura de tela que mostra na linha 1 s def add(a, b): na linha 2 return a + b na linha 4 def subtract(a, b): na linha 5 return a - b na linha 7 def multiply(a, b): na linha 8 return a * b na linha 10 def divide(a, b): na linha 11 if b == 0: raise ValueError(“Cannot divide by zero”) na linha 12 return a / b. Nas linhas 3, 6 e 9 não há conteúdo descrito.

Agora, crie um arquivo separado para os testes. Ele deve começar com test_ para ser reconhecido pelo pytest. Chamaremos esse arquivo de test_calculator.py. Acompanhe na Figura 5:

Figura 5 - test_calculator.pyFonte: o autor.

#PraCegoVer: a figura é uma captura de tela que mostra na linha 1 import pytest na linha 2 from calculator import add, subtract, multiply, divid na linha 4 def test_add(): na linha 5 assert add(2, 3) == 5 na linha 6 assert add(-1, 1) == 0 na linha 7 assert add(0, 0) == 0 na linha 9 def test_subtract(): na linha 10 assert subtract(5, 3) == 2 na linha 11 assert subtract(-1, -1) == 0 na linha 12 assert subtract(0, 5) == -5 na linha 14 def test_multiply(): na linha 15 assert multiply(2, 3) == 6 na linha 16 assert multiply(-1, 1) == -1 na linha 17 assert multiply(0, 10) == 0 na linha 19 def test_divide(): na linha 20 assert divide(6, 3) == 2 na linha 21 assert divide(-6, -2) == 3 na linha 22 assert divide(0, 1) == 0 na linha 23 with pytest.raises(ValueError): na linha 24 divide(1, 0). Nas linhas 3, 8, 13 e 18 não há conteúdo escrito.

No terminal, navegue até o diretório onde estão localizados os arquivos calculator.py e test_calculator.py. Execute o comando pytest para rodar os testes: pytest

O pytest encontrará todos os arquivos de teste que seguem o padrão test_*.py e executará as funções as quais começam com test_. O resultado dos testes será exibido no terminal, mostrando quais deles passaram e quais falharam. Feito isso, revise a saída do pytest no terminal. Se todos os testes passarem, você verá uma mensagem indicando sucesso, porém, caso algum teste falhe, o pytest fornecerá detalhes sobre o que deu errado, permitindo você ajustar seu código ou seus testes, conforme necessário.

À medida que você adicionar novas funcionalidades ao seu código, crie novos testes para garantir que estejam corretas. Isso é importante para manter uma boa cobertura de testes, pois ajuda a garantir a qualidade e a confiabilidade contínuas do seu software.

Seguindo esses passos, você pode começar a criar e executar testes unitários eficazes usando pytest, o que lhe ajudará a manter não só a integridade, mas também a qualidade do seu código ao longo do desenvolvimento. Chame seus colegas e professores, crie mais cenários e situações com o pytest, ou outros frameworks, conforme sua preferência. Pronto(a)? 3, 2, 1! Vamos lá!

REFERÊNCIAS

MATTHES, E. Curso intensivo de Python: Uma introdução prática e baseada em projetos à programação. 3. ed. São Paulo: Novatec, 2023.

Page updated

Google Sites

Report abuse