extreme Programming Brasil Testes de Unidade Java com em Java argonavis.com.br Helder da Rocha

Transcrição

1 extreme Programming Brasil Testes de Unidade Java com em Java Helder da Rocha argonavis.com.br

2 Objetivos 1. Apresentar o framework JUnit e demonstrar como utilizá-lo para testar aplicações em Java 2. Discutir dificuldades relativas à prática de testar, como descobrir testes, dependências, GUIs, etc. 3. Apresentar extensões do JUnit para lidar com dificuldades e cenários específicos de teste Público-alvo: Programadores Java 2

3 Por que testar? Por que não? Como saber se o recurso funciona sem testar? Como saber se ainda funciona após refatoramento? Testes dão maior segurança: coragem para mudar Que adianta a OO isolar a interface da implementação se programador tem medo de mudar a implementação? Código testado é mais confiável Código testado pode ser alterado sem medo Como saber quando o projeto está pronto Testes == requisitos 'executáveis' Testes de unidade devem ser executados o tempo todo Escreva os testes antes. Quando todos rodarem 100%, o projeto está concluído! 3

4 O que é JUnit? Um framework que facilita o desenvolvimento e execução de testes de unidade em código Java Uma API para construir os testes Aplicações para executar testes A API Classes Test, TestCase, TestSuite, etc. oferecem a infraestrutura necessária para criar os testes Métodos asserttrue(), assertequals(), fail(), etc. são usados para testar os resultados Aplicação TestRunner Roda testes individuais e suites de testes Versões texto, Swing e AWT Apresenta diagnóstico sucesso/falha e detalhes 4

5 Para que serve? 'Padrão' para testes de unidade em Java Desenvolvido por Kent Beck e Erich Gamma Design muito simples Testar é uma boa prática, mas é chato; JUnit torna as coisas mais agradáveis, facilitando A criação e execução automática de testes A apresentação dos resultados JUnit pode verificar se cada unidade de código funciona da forma esperada Permite agrupar e rodar vários testes ao mesmo tempo Na falha, mostra a causa em cada teste Serve de base para extensões 5

6 Arquitetura do JUnit Diagrama de classes Fonte: Manual do JUnit (Cooks Tour) 6

7 Como usar o JUnit? Há várias formas de usar o JUnit. Depende da metodologia de testes que está sendo usada Código existente: precisa-se escrever testes para classes que já foram implementadas Desenvolvimento guiado por testes (TDD): código novo só é escrito se houver um teste sem funcionar Onde obter? Como instalar? Incluir o arquivo junit.jar no classpath para compilar e rodar os programas de teste 7

8 JUnit para testar código existente Exemplo de um roteiro típico 1. Crie uma classe que estenda junit.framework.testcase para cada classe a ser testada import junit.framework.*; class SuaClasseTest extends TestCase { Para cada método xxx(args) a ser testado defina um método public void testxxx() no test case SuaClasse: public boolean equals(object o) {... SuaClasseTest: public void testequals() {... Sobreponha o método setup(), se necessário Sobreponha o método teardown(), se necessário 8

9 JUnit para guiar o desenvolvimento Cenário de Test-Driven Development (TDD) 1. Defina uma lista de tarefas a implementar 2. Escreva uma classe (test case) e implemente um método de teste para uma tarefa da lista. 3. Rode o JUnit e certifique-se que o teste falha 4. Implemente o código mais simples que rode o teste Crie classes, métodos, etc. para que código compile Código pode ser código feio, óbvio, mas deve rodar! 5. Refatore o código para remover a duplicação de dados 6. Escreva mais um teste ou refine o teste existente 7. Repita os passos 2 a 6 até implementar toda a lista 9

10 Como implementar? Dentro de cada teste, utilize os métodos herdados da classe TestCase assertequals(objetoesperado, objetorecebido), asserttrue(valorbooleano), assertnotnull(objeto) assertsame(objetoum, objetodois), fail (),... Exemplo de test case com um setup() e um teste: public class CoisaTest extends TestCase { // construtor padrão omitido private Coisa coisa; public void setup() { coisa = new Coisa("Bit"); public void testtostring() { assertequals("<coisa>bit</coisa>", coisa.tostring()); 10

11 Como funciona? O TestRunner recebe uma subclasse TestCase de junit.framework.testcase Usa reflection para descobrir seus métodos Para cada método testxxx(), executa: 1. o método setup() 2. o próprio método testxxx() setup() 3. o método teardown() testxxx() testyyy() O test case é instanciado para executar teardown() um método testxxx() de cada vez. As alterações que ele fizer ao estado do objeto não afetarão os demais testes Método pode terminar, falhar ou provocar exceção setup() teardown() MeuTestCase 11

12 Exemplo: uma classe package junitdemo; import java.io.*; public class TextUtils { public static String removewhitespaces(string text) throws IOException { StringReader reader = new StringReader(text); StringBuffer buffer = new StringBuffer(text.length()); int c; while( (c = reader.read())!= -1) { if (c ==' ' c =='\n' c =='\r' c =='\f' c =='\t') { ; /* do nothing */ else { buffer.append((char)c); return buffer.tostring(); veja código em junitdemo.zip 12

13 Exemplo: um test case para a classe package junitdemo; import junit.framework.*; import java.io.ioexception; Construtor precisa ser publico, receber String name e chamar super(string name) public class TextUtilsTest extends TestCase { public TextUtilsTest(String name) { super(name); Método começa com "test" e é sempre public void public void testremovewhitespaces() throws IOException { String teststring = "one, ( two three+), "+ "(((four+ \t five)?\n \n, six?"; String expectedstring = "one,(two three+)"+ ",(((four+ five)?,six?"; String results = TextUtils.removeWhiteSpaces(testString); assertequals(expectedstring, results); 13

14 Exemplo: como executar Use a interface de texto java -cp junit.jar junit.textui.testrunner junitdemo.textutilstest Ou use a interface gráfica java -cp junit.jar junit.swingui.testrunner junitdemo.textutilstest Use Ant <junit> tarefa do Apache Ant Ou forneça um main(): public static void main (String[] args) { TestSuite suite = new TestSuite(TextUtilsTest.class); junit.textui.testrunner.run(suite); veja demonstração em junitdemo.zip 14

15 TestSuite Permite executar uma coleção de testes Método addtest(testsuite) adiciona um teste na lista Padrão de codificação (usando reflection): retornar um TestSuite em cada test-case: public static TestSuite suite() { return new TestSuite(SuaClasseTest.class); criar uma classe AllTests que combina as suites: public class AllTests { Pode incluir outras suites public static Test suite() { TestSuite testsuite = new TestSuite("Roda tudo"); testsuite.addtest(pacote.alltests.suite()); testsuite.addtest(minhaclassetest.suite()); testsuite.addtest(suaclassetest.suite()); return testsuite; veja demonstração em junitdemo.zip 15

16 Fixtures São os dados reutilizados por vários testes Inicializados no setup() e destruídos no teardown() (se necessário) public class AttributeEnumerationTest extends TestCase { String teststring; String[] testarray; AttributeEnumeration testenum; public void setup() { teststring = "(alpha beta gamma)"; Extensão JXUnit (jxunit.sourceforge.net) permite manter dados de teste em arquivo XML (*.jxu) separado do código Mais flexibilidade. Permite escrever testes mais rigorosos, com muitos dados Fixture testarray = new String[]{"alpha", "beta", "gamma"; testenum = new AttributeEnumeration(testArray); public void testgetnames() { assertequals(testenum.getnames(), testarray); public void testtostring() { assertequals(testenum.tostring(), teststring); (...) veja exemplo jxunitdemo.zip 16

17 Teste situações de falha É tão importante testar o cenário de falha do seu codigo quanto o sucesso Método fail() provoca uma falha Use para verificar se exceções ocorrem quando se espera que elas ocorram Exemplo public void testentitynotfoundexception() { resetentitytable(); // no entities to resolve! try { // Following method call must cause exception! ParameterEntityTag tag = parser.resolveentity("bogus"); fail("should have caused EntityNotFoundException!"); catch (EntityNotFoundException e) { // success: exception occurred as expected 17

18 Afirmações do J2SDK1.4 (assertions) São expressões booleanas que o programador define para afirmar uma condição que ele acredita ser verdade Afirmações são usadas para validar código (ter a certeza que um vetor tem determinado tamanho, ter a certeza que o programa não passou por determinado lugar) Melhoram a qualidade do código: tipo de teste Devem ser usadas durante o desenvolvimento e desligadas na produção (afeta a performance) Não devem ser usadas como parte da lógica do código Afirmações são um recurso novo do JSDK1.4.0 Nova palavra-chave: assert É preciso compilar usando a opção -source 1.4: > javac -source 1.4 Classe.java Para executar, é preciso habilitar afirmações (enable assertions): > java -ea Classe 18

19 JUnit vs. afirmações Afirmações do J2SDK 1.4 são usadas dentro do código Podem incluir testes dentro da lógica procedural de um programa if (i%3 == 0) { dothis(); else if (i%3 == 1) { dothat(); else { assert i%3 == 2: "Erro interno!"; Provocam um AssertionError quando falham (que pode ser encapsulado pelas exceções do JUnit) Afirmações do JUnit são usadas em classe separada (TestCase) Não têm acesso ao interior dos métodos (verificam se a interface dos métodos funciona como esperado) Afirmações do J2SDK1.4 e JUnit são complementares JUnit testa a interface dos métodos assert testa trechos de lógica dentro dos métodos veja exemplo junitdemo.zip 19

20 Limitações do JUnit Acesso aos dados de métodos sob teste Métodos private e variáveis locais não podem ser testadas com JUnit. Dados devem ser pelo menos package-private (friendly) Soluções com refatoramento Isolar em métodos private apenas código inquebrável Transformar métodos private em package-private Desvantagem: quebra ou redução do encapsulamento Classes de teste devem estar no mesmo pacote que as classes testadas para ter acesso Solução usando extensão do JUnit JUnitX: usa reflection para ter acesso a dados private 20

21 Como escrever bons testes JUnit facilita bastante a criação e execução de testes, mas elaborar bons testes exige mais O que testar? Como saber se testes estão completos? "Teste tudo o que pode falhar" [2] Métodos triviais (get/set) não precisam ser testados. E se houver uma rotina de validação no método set? É melhor ter testes a mais que testes a menos Escreva testes curtos (quebre testes maiores) Use assertnotnull() (reduz drasticamente erros de NullPointerException difíceis de encontrar) Reescreva seu código para que fique mais fácil de testar 21

22 Como descobrir testes? Listas de tarefas (to-do list) Comece pelas mais simples e deixe os testes "realistas" para o final Requerimentos, use-cases, diagramas UML: rescreva os requerimentos em termos de testes Dados Use apenas dados suficientes (não teste 10 condições se três forem suficientes) Bugs revelam testes Achou um bug? Não conserte sem antes escrever um teste que o pegue (se você não o fizer, ele volta)! 22

23 Test-Driven Development (TDD) Desenvolvimento guiado pelos testes Só escreva código novo se um teste falhar Refatore até que o teste funcione Alternância: "red/green/refactor" - nunca passe mais de 10 minutos sem que a barra do JUnit fique verde. Técnicas "Fake It Til You Make It": faça um teste rodar simplesmente fazendo método retornar constante Triangulação: abstraia o código apenas quando houver dois ou mais testes que esperam respostas diferentes Implementação óbvia: se operações são simples, implemente-as e faça que os testes rodem 23

24 Como lidar com testes difíceis Testes devem ser simples e suficientes XP: design mais simples que resolva o problema; sempre pode-se escrever novos testes, quando necessário Não complique Não teste o que é responsabilidade de outra classe/método Assuma que outras classes e métodos funcionam Testes difíceis (ou que parecem difíceis) Aplicações gráficas: eventos, layouts, threads Objetos inaccessíveis, métodos privativos, Singletons Objetos que dependem de outros objetos Objetos cujo estado varia devido a fatores imprevisíveis Soluções Alterar o design da aplicação para facilitar os testes Simular dependências usando proxies e stubs 24

25 Como testar GUIs O que testar? [11] Assumir que GUI (Swing, AWT, etc.) funciona Concentrar-se na lógica de negócio e não na UI Como testar? "Emagrecer" o código para reduzir a chance de falha Usar MVC: isolar lógica de apresentação e controle Separar código confiável do código que pode falhar Usar mediadores (Mediator pattern) para intermediar interações entre componentes Exemplo: event handlers Devem ter 0% de lógica de negócio: "A Stupid GUI is an Unbreakable GUI" (Robert Koss, Object Mentor) [5] Responsabilidades delegadas a mediadores testáveis 25

26 Dependência de código-fonte Problema Como testar componente que depende do código de outros componentes? Classe-alvo não oferece o que testar: Tanque CarroTest +testacelera() Carro +acelera() Se houver tinta e se houver papel método void imprime() deve funcionar Como saber se há ou não tinta e papel? Fonte: nivel() Ignição +ligada() public void testacelera() { Carro carro = new Carro(); carro.acelera(); assert???(???); 26

27 Stubs: objetos "impostores" É possível remover dependências de código-fonte refatorando o código para usar interfaces A antes B A depois «interface» InterB B A não conhece mais o tipo concreto de B Agora B pode ser substituída por um stub BStub está sob controle total de ATest (1) Em alguns casos, ATest pode implementar InterB (2) ATest «cria» Fonte: A (1) BStub «interface» InterB B ATest A (2) self-shunt pattern «interface» InterB B 27

28 Dependência: solução usando stubs CarroTest +testtanquevaziosemign() +testtanquecheiosemign() +testtanquevaziocomign() +testtanquecheiocomign() Carro +acelera() «interface» Tanque +nivel():float «interface» Ignicao +ligada(): bool TanqueImpl +nivel():float IgnicaoImpl +ligada():bool Quando usar stubs Dependência não existe ainda (não está pronta) Dependências tem estado mutante, imprevisível ou estão indisponíveis durante o desenvolvimento BDs, servidores de aplicação, servidores Web, hardware Fonte:

29 Dependências de servidores Usar stubs para simular serviços e dados É preciso implementar classes que devolvam as respostas esperadas para diversas situações Complexidade muito grande da dependência pode não compensar investimento (não deixe de fazer testes por causa disto!) Vários tipos de stubs: mock objects, self-shunts. Usar proxies (mediadores) para serviços reais Oferecem interface para simular comunicação e testa a integração real do componente com seu ambiente Não é teste unitário: teste pode falhar quando código está correto (se os fatores externos falharem) 29

30 Mock Objects Mock objects (MO) é uma estratégia similar ao uso de stubs mas que não implementa nenhuma lógica Um mock object não é, portanto, um stub, pois não simula o funcionamento do objeto em qualquer situação Comportamento é controlado pela classe de teste que Define comportamento esperado (valores retornados, etc.) Passa MO configurado para objeto a ser testado Chama métodos do objeto (que usam o MO) Implementações open-source que facilitam uso de MOs EasyMock (tammofreese.de/easymock/) e MockMaker ( geram MOs a partir de interfaces Projeto MO (mockobjects.sourceforge.net) coleção de mock objects e utilitários para usá-los veja exemplo mockdemo.zip 30

31 Testes de interface Caso específico: resposta de servidores Web Verificar se uma página HTML ou XML contém determinado texto ou determinado elemento Verificar se resposta está de acordo com dados passados na requisição: testes funcionais tipo "caixa-preta" Soluções (extensões do JUnit) HttpUnit e ServletUnit: permite testar dados de árvore DOM HTML gerada JXWeb (combinação do JXUnit com HttpUnit) permite especificar os dados de teste em arquivos XML arquivos de teste Java são gerados a partir do XML XMLUnit extensão simples para testar árvores XML Onde encontrar: (httpunit jxunit xmlunit).sourceforge.net 31

32 Testes de performance JUnitPerf ( Coleção de decoradores para medir performance e escalabilidade em testes JUnit existentes TimedTest Executa um teste e mede o tempo transcorrido Define um tempo máximo para a execução. Teste falha se execução durar mais que o tempo estabelecido LoadTest Executa um teste com uma carga simulada Utiliza timers para distribuir as cargas usando distribuições randômicas Combinado com TimerTest para medir tempo com carga ThreadedTest Executa o teste em um thread separado 32

33 JUnitPerf: exemplo import com.clarkware.junitperf.*; import junit.framework.*; public class ExampleLoadTest extends TestCase { public ExampleLoadTest(String name) { super(name); public static Test suite() { TestSuite suite = new TestSuite(); Timer timer = new ConstantTimer(1000); TestCase existente int maxusr = 10; int iters = 10; long maxelapsedtime = 20000; Test test = new ExampleTestCase("testOneSecondResp"); Test loadtest = new LoadTest(test, maxusr, iters, timer); Test timedtest = new TimedTest(loadTest, maxelapsedtime); suite.addtest(timedtest); return suite; Decorador de tempo public static void main(string args[]) { junit.textui.testrunner.run(suite()); TestRunner Decorador de carga Example TestCase LoadTest TimedTest Suite 33

34 Ant + JUnit Ant: ferramenta para automatizar processos de construção de aplicações Java Pode-se executar todos os testes após a integração com um único comando: ant roda-testes Com as tarefas <junit> e <junitreport> é possível executar todos os testes gerar um relatório simples ou detalhado, em diversos formatos (XML, HTML, etc.) executar testes de integração São tarefas opcionais. É preciso ter no $ANT_HOME/lib optional.jar (distribuído com Ant) junit.jar (distribuído com JUnit) 34

35 Exemplo: <junit> <target name="test" depends="build"> <junit printsummary="true" dir="${build.dir" fork="true"> <formatter type="plain" usefile="false" /> <classpath path="${build.dir" / <test name="argonavis.dtd.alltests" /> </junit> </target> <target name="batchtest" depends="build" > <junit dir="${build.dir" fork="true"> <formatter type="xml" usefile="true" /> <classpath path="${build.dir" /> <batchtest todir="${test.report.dir"> <fileset dir="${src.dir"> <include name="**/*test.java" /> <exclude name="**/alltests.java" /> </fileset> </batchtest> </junit> </target> Gera arquivo XML Inclui todos os arquivos que terminam em TEST.java Formata os dados na tela (plain) Roda apenas arquivo AllTests 35

36 <junitreport> Gera um relatório detalhado (estilo JavaDoc) de todos os testes, sucessos, falhas, exceções, tempo,... <target name="test-report" depends="batchtest" > <junitreport todir="${test.report.dir"> <fileset dir="${test.report.dir"> <include name="test-*.xml" /> </fileset> <report todir="${test.report.dir/html" format="frames" /> </junitreport> </target> veja demonstração junitdemo.zip veja demonstração dtdreader.zip Usa arquivos XML gerados por <formatter> 36

37 Resumo e conclusões JUnit é uma ferramenta open-source que ajuda a implementar testes em projetos Java Com JUnit, é fácil viabilizar práticas como Refactoring, Integração Contínua e Test-Driven Development (TDD) Em um processo TDD, testes que falham são escritos no JUnit para que, a partir deles, se possa implementar código que os faça rodar com sucesso Mock objects podem ser usados para representar dependência e diminuir as responsabilidades de testes Para testes em domínios específicos e para lidar com limitações do JUnit há várias extensões open-source HttpUnit, Cactus, JUnitPerf, JXUnit, JUnitX, JUnitEE... 37

38 Fontes (1) [1] R. Hightower, N. Lesiecki. Java Tools for extreme Programming. Wiley, Explora ferramentas Ant, JUnit, Cactus e outras usando estudo de caso com processo XP. [2] Jeffries, Anderson, Hendrickson. extreme Programming Installed, Addison- Wesley, Contém exemplos de estratégias para testes. [3] Kent Beck, Erich Gamma. JUnit Test Infected: programmers love writing tests. (JUnit docs). Aprenda a usar JUnit em uma hora. [4] Andy Schneider. JUnit Best Practices. JavaWorld, Dec Dicas do que fazer ou não fazer para construir bons testes. [5] Robert Koss, Testing Things that are Hard to Test. Object Mentor, Mostra estratégias para testar GUIs e código com dependências usando stubs. 38

39 Fontes (2) [6] Mackinnon, Freeman, Craig. Endo-testing with Mock Objects. O autor apresenta técnicas para testes usando uma variação da técnica de stubs chamada de "mock objects". [7] William Wake. Test/Code Cycle in XP. Part 1: Model, Part II: GUI. Ótimo tutorial em duas partes sobre a metodologia "test-first" mostrando estratégias para testar GUIs na segunda parte. [8] Steve Freeman, Developing JDBC Applications Test First Tutorial sobre metodolodia test-first com mock objects para JDBC. [9] Martin Fowler. Refactoring: improving the design of existing code. Addison- Wesley, Cap 4 (building tests) é um tutorial usando JUnit. [10] Kent Beck. Test-driven development. Addison-Wesley, Mostra como utilizar testes como "requerimentos executáveis" para guiar o desenvolvimento. 39

40 Palestra: JUnit Selecione o link relativo a esta palestra no endereço /xpbrasil2002 Recursos disponíveis no site: Palestra completa em PDF Todo o código-fonte usado nos exemplos e demonstrações Instruções detalhadas sobre como rodar e instalar os exemplos Links para software utilizado e documentação Tutorial: Implementando extreme Programming em Java XP Brasil 2002, São Paulo 2002, Helder da Rocha