Orientações técnicas/Quando Usar Framework Testes

Orientações técnicas/Quando Usar Framework Testes 1.1 (Edição mínima)

2013-01-09T20:00:11Z

Linha 1

<<TableOfContents>>

Linha 2

Linha 3

**Quando usar cada framework de testes durante o desenvolvimento dos testes unitários ?**

Linha 4

Linha 5

**JUnit**

Linha 6

Para utilização do JUnit integrado ao Eclipse IDE podemos tomar como base o seguinte artigo: [[http://onjava.com/pub/a/onjava/2004/02/04/juie.html|'Como utilizar JUnit com Eclipse']]. Além da documentação disponível no próprio site do projeto JUnit.

Linha 7

No caso dos projetos utilizando o framework demoiselle, em particular o demoiselle-crud, o JUnit já é disponibilizado juntamente com o framework, o que dispensa sua instalação prévia.

Linha 8

Vale como recomendação de boa prática que seja criado um projeto de testes anexo ao projeto em desenvolvimento. Nesse projeto de testes serão incluídos os casos de teste para cada classe desenvolvida no projeto principal.

Linha 9

É interessante que dentro do projeto de testes a estrutura de pacotes do projeto principal seja mantida, para facilitar a navegação pelo desenvolvedor.

Linha 10

Outra orientação de boa prática é que o nome das classes de teste sejam o mesmo nome das classes a serem testadas, exceto a terminação do nome com a inclusão da palavra Test. Exemplo: classe a ser testada ClasseGenerica.java, classe de testes ClasseGenericaTest.java.

Linha 11

Dentro de cada classe de testes é interessante que o nome de cada caso de teste que representará um teste específico para um método da classe principal, seja um nome de faça referência ao nome do método a ser testado e o tipo de teste que está sendo realizado.

Linha 12

Exemplo:

Linha 13

método principal a ser testado: public void insert()

Linha 14

}

Linha 15

Linha 16

No exemplo acima temos dois casos de testes para o mesmo método insert() da classe principal a ser testada. Fica claro que método está sendo testado e o tipo de teste que está sendo realizado. Outra orientação é a inclusão de comentários no cabeçalho de cada método de testes explicando como o teste será realizado.

Linha 17

O JUnit será utilizado para todos os casos de testes do projeto, inclusive os que utilizam o Easymock, Easymock classextendion e o JMockit, ou a combinação deles.

Linha 18

Linha 19

**Easymock**

Linha 20

No caso das bibliotecas do Easymock existirá um emprego específico do Easymock ou do Easymock Classextension dependendo do foco do teste.

Linha 21

Para o caso de haver a necessidade de se mockar uma interface, deverá ser utilizado o Easymock. Já para os casos de haver a necessidade de mockar classes, o classextension será o indicado.

Linha 22

A utilização do Easymock em um modo geral será nos casos em que são passadas classes ou interfaces como parâmetros dentro da chamada de métodos das classes sob testes. No caso de serem necessários mocks para classes internas ao método que está sendo testado, o indicado é se utilizar o JMockit para substituir a execução dessa classe.

Linha 23

Outro indicador de se utilizar o Easymock é a necessidade de serem mockados somente alguns métodos e seus retornos da classe em questão. O que não acontece com o JMockit quando se trata de interfaces, onde ele força a implementação (ou pelo menos a declaração) de todos os métodos da interface.

Linha 24

A utilização do Easymock também é interessante quando se quer definir um valor fixo para o retorno do método que está sendo mockado.

Linha 25

Uma limitação para a utilização do Easymock é a impossibilidade de se mockar métodos privados, estáticos e finais das classes.

Linha 26

Segue abaixo um exemplo de utilização do Easymock nos testes das classes do demoiselle-crud.

Linha 27

A classe sob testes é a MessageDecorator e o método que se deseja testar especificamente dessa classe é o método getLocale()

Linha 28

Para essa caso foi criada uma classe CrudMessageDecoratorTest para a realização dos casos de testes. Veja classe abaixo.

Linha 29

Linha 30

}

Linha 31

Linha 32

private ICrudMessage crudMessage;

Linha 33

Linha 34

/**

Linha 35

* Initialize test class creating a mock object from ICrudMessage interface

Linha 36

Linha 37

Linha 38

Linha 39

@Before

Linha 40

public void setUp() throws Exception {

Linha 41

Linha 42

crudMessage = EasyMock.createMock(ICrudMessage.class);

Linha 43

EasyMock.expect(crudMessage.getLabel()).andReturn("myLabel").anyTimes();

Linha 44

String key = "crud.message.ok";

Linha 45

EasyMock.expect(crudMessage.getKey()).andReturn(key).anyTimes();

Linha 46

EasyMock.expect(crudMessage.getCustomPattern()).andReturn(key.replaceAll("crud.", "app.myMB.")).anyTimes();

Linha 47

Locale loc = new Locale("pt", "Br");

Linha 48

EasyMock.expect(crudMessage.getLocale()).andReturn(loc).anyTimes();

Linha 49

EasyMock.expect(crudMessage.getResourceName()).andReturn("META-INF/crud-messages").anyTimes();

Linha 50

EasyMock.expect(crudMessage.getAppResourceName()).andReturn("messages").anyTimes();

Linha 51

EasyMock.expect(crudMessage.getSeverity()).andReturn(Severity.ERROR).anyTimes();

Linha 52

Linha 53

EasyMock.replay(crudMessage);

Linha 54

Linha 55

}

Linha 56

Linha 57

Linha 58

@Test

Linha 59

public void testGetLocale() {

Linha 60

MessageDecorator msgDecorator = new MessageDecorator(crudMessage, "test");

Linha 61

Assert.assertEquals("pt_BR", msgDecorator.getLocale().toString());

Linha 62

}

Linha 63

Linha 64

}

Linha 65

Linha 66

Notem que no método setUp() da classe de testes foi criado um mock para a interface ICrudMessage utilizando o Easymock. Nele foram ensinados os comportamentos para diversos métodos dessa interface, bem como os retornos esperados. Já no caso de teste testGetLocale() foi passado no construtor do objeto da classe sob testes nosso objeto mock (MessageDecorator msgDecorator = new MessageDecorator(crudMessage, "test");)

Linha 67

Linha 68

**JMockit**

Linha 69

Como já foi citado anteriormente, a utilização do JMockit se faz interessante quando houver a necessidade de se mockar uma classe que está sendo utilizada internamente ao método da classe sob testes. Ou seja, essa classe não está sendo passada como parâmetro para o método que está sendo testado, porém em um determinado momento de sua execução a chamará, o que por ventura poderá ocasionar um erro dependendo do contexto do teste. Nesses casos o JMockit é recomendado, pois poderemos alterar o comportamento dos métodos que são chamados de classes terceiras que não estão sendo alvo do teste, porém estão dentro do escopo do método da classe sob testes.

Linha 70

No caso de uso do JMockit não implica a não utilização do Easymock, pelo contrário, poderemos utilizar um mix das duas soluções em conjunto.

Linha 71

Exemplo de utilização do JMockit juntamente com Easymock.

Linha 72

A classe sob testes é a ResourceBundleManager e os métodos em testes são getMessage() e getCurrentLoader().

Linha 73

No caso do teste para o getMessage(), internamente a esse método é feito um chamado para o método getCurrentInstance da classe FacesContext. Nesse caso é indicado mockar essa classe e o comportamento do método. Para isso foi utilizado JMokit. Já para se utilizar esse método foi necessário mockar o objeto de retorno do tipo FacesContext. Nesse caso foi utilizado o Easymock para resolver a questão. Veja código abaixo.

Linha 74

Linha 75

public class ResourceBundleManagerTest extends TestCase {

Linha 76

Linha 77

private ResourceBundleManager bm = null;

Linha 78

Linha 79

Linha 80

public static abstract class MockFacesContext

Linha 81

{

Linha 82

Linha 83

@Mock

Linha 84

}

Linha 85

FacesContext ctx = EasyMock.createMock(FacesContext.class);

Linha 86

Application app = EasyMock.createMock(Application.class);

Linha 87

ELContext ectx = EasyMock.createMock(ELContext.class);

Linha 88

ValueExpression vexp = EasyMock.createMock(ValueExpression.class);

Linha 89

EasyMock.expect(vexp.getValue(EasyMock.isA(ELContext.class))).andReturn("test");

Linha 90

Linha 91

EasyMock.replay(vexp);

Linha 92

EasyMock.replay(ectx);

Linha 93

Linha 94

ExpressionFactory exf = EasyMock.createMock(ExpressionFactory.class);

Linha 95

EasyMock.expect(exf.createValueExpression(EasyMock.isA(ELContext.class), EasyMock.isA(String.class),EasyMock.isA(Class.class))).andReturn(vexp);

Linha 96

EasyMock.replay(exf);

Linha 97

Linha 98

Linha 99

EasyMock.expect(app.getExpressionFactory()).andReturn(exf);

Linha 100

EasyMock.replay(app);

Linha 101

Linha 102

EasyMock.expect(ctx.getApplication()).andReturn(app);

Linha 103

EasyMock.expect(ctx.getELContext()).andReturn(ectx);

Linha 104

EasyMock.replay(ctx);

Linha 105

Linha 106

return ctx;

Linha 107

}

Linha 108

Linha 109

}

Linha 110

Linha 111

public void setUp(){

Linha 112

bm = new ResourceBundleManager();

Linha 113

}

Linha 114

Linha 115

public void testGetMessageFromResourceBundle(){

Linha 116

Mockit.setUpMock(FacesContext.class, MockFacesContext.class);

Linha 117

String msg = bm.getMessage("test");

Linha 118

assertEquals("test", msg);

Linha 119

}

Linha 120

Linha 121

public void testGetCurrentLoader(){

Linha 122

NoLayers nl = new NoLayers();

Linha 123

ClassLoader loader = bm.getCurrentLoader((Object)nl);

Linha 124

assertNotNull(loader);

Linha 125

}

Linha 126

Linha 127

}

Linha 1

~~New~~

Orientações técnicas/Quando Usar Framework Testes 1.2

2013-04-05T22:36:12Z

Linha 5

**JUnit**

Linha 13

Exemplo:

{{{

Linha 15

caso de teste 1: public void testInsert()

Linha 16

caso de teste 2: public void testInsertNullObject()

Linha 17

}}}

Linha 14

}

Linha 16

~~O JUnit será utilizado para todos os casos de testes do projeto, inclusive os que utilizam o Easymock, Easymock classextendion e o JMockit, ou a combinação deles.~~

Linha 20

O JUnit será utilizado para todos os casos de testes do projeto, inclusive os que utilizam o Easymock, Easymock classextendion e o JMockit, ou a combinação deles.

Linha 34

{{{

Linha 35

public class CrudMessageDecoratorTest extends TestCase {

Linha 30

}

Linha 32

~~private ICrudMessage crudMessage;~~

Linha 38

private ICrudMessage crudMessage;

Linha 34

/**

Linha 35

* Initialize test class creating a mock object from ICrudMessage interface

Linha 36

Linha 37

Linha 39

~~@Before~~

~~public void setUp() throws Exception {~~

Linha 41

/**

Linha 42

* Initialize test class creating a mock object from ICrudMessage interface

Linha 43

Linha 42

~~crudMessage = EasyMock.createMock(ICrudMessage.class);~~

Linha 43

~~EasyMock.expect(crudMessage.getLabel()).andReturn("myLabel").anyTimes();~~

Linha 44

~~String key = "crud.message.ok";~~

Linha 45

~~EasyMock.expect(crudMessage.getKey()).andReturn(key).anyTimes();~~

Linha 46

~~EasyMock.expect(crudMessage.getCustomPattern()).andReturn(key.replaceAll("crud.", "app.myMB.")).anyTimes();~~

Linha 47

~~Locale loc = new Locale("pt", "Br");~~

Linha 48

~~EasyMock.expect(crudMessage.getLocale()).andReturn(loc).anyTimes();~~

Linha 49

~~EasyMock.expect(crudMessage.getResourceName()).andReturn("META-INF/crud-messages").anyTimes();~~

Linha 50

~~EasyMock.expect(crudMessage.getAppResourceName()).andReturn("messages").anyTimes();~~

Linha 51

~~EasyMock.expect(crudMessage.getSeverity()).andReturn(Severity.ERROR).anyTimes();~~

Linha 53

~~EasyMock.replay(crudMessage);~~

Linha 46

@Before

Linha 47

public void setUp() throws Exception {

Linha 55

}

Linha 49

crudMessage = EasyMock.createMock(ICrudMessage.class);

EasyMock.expect(crudMessage.getLabel()).andReturn("myLabel").anyTimes();

String key = "crud.message.ok";

EasyMock.expect(crudMessage.getKey()).andReturn(key).anyTimes();

EasyMock.expect(crudMessage.getCustomPattern()).andReturn(key.replaceAll("crud.", "app.myMB.")).anyTimes();

Locale loc = new Locale("pt", "Br");

EasyMock.expect(crudMessage.getLocale()).andReturn(loc).anyTimes();

EasyMock.expect(crudMessage.getResourceName()).andReturn("META-INF/crud-messages").anyTimes();

EasyMock.expect(crudMessage.getAppResourceName()).andReturn("messages").anyTimes();

EasyMock.expect(crudMessage.getSeverity()).andReturn(Severity.ERROR).anyTimes();

Linha 60

EasyMock.replay(crudMessage);

Linha 58

~~@Test~~

Linha 59

~~public void testGetLocale() {~~

Linha 60

~~MessageDecorator msgDecorator = new MessageDecorator(crudMessage, "test");~~

Linha 61

~~Assert.assertEquals("pt_BR", msgDecorator.getLocale().toString());~~

Linha 62

}

Linha 62

}

@Test

public void testGetLocale() {

MessageDecorator msgDecorator = new MessageDecorator(crudMessage, "test");

Assert.assertEquals("pt_BR", msgDecorator.getLocale().toString());

}

Linha 72

}}}

Linha 66

Linha 74

Linha 83

{{{

Linha 77

Linha 86

private ResourceBundleManager bm = null;

Linha 78

Linha 87

Linha 79

Linha 88

Linha 80

Linha 89

public static abstract class MockFacesContext

Linha 81

Linha 90

{

Linha 82

Linha 91

Linha 83

Linha 92

@Mock

Linha 93

public static FacesContext getCurrentInstance() {

Linha 94

FacesContext ctx = EasyMock.createMock(FacesContext.class);

Linha 95

Application app = EasyMock.createMock(Application.class);

Linha 96

ELContext ectx = EasyMock.createMock(ELContext.class);

Linha 97

ValueExpression vexp = EasyMock.createMock(ValueExpression.class);

Linha 98

EasyMock.expect(vexp.getValue(EasyMock.isA(ELContext.class))).andReturn("test");

Linha 99

Linha 100

EasyMock.replay(vexp);

Linha 101

EasyMock.replay(ectx);

Linha 102

Linha 103

ExpressionFactory exf = EasyMock.createMock(ExpressionFactory.class);

Linha 104

EasyMock.expect(exf.createValueExpression(EasyMock.isA(ELContext.class), EasyMock.isA(String.class),EasyMock.isA(Class.class))).andReturn(vexp);

Linha 105

EasyMock.replay(exf);

Linha 106

Linha 107

Linha 108

EasyMock.expect(app.getExpressionFactory()).andReturn(exf);

Linha 109

EasyMock.replay(app);

Linha 110

Linha 111

EasyMock.expect(ctx.getApplication()).andReturn(app);

Linha 112

EasyMock.expect(ctx.getELContext()).andReturn(ectx);

Linha 113

EasyMock.replay(ctx);

Linha 114

Linha 115

return ctx;

Linha 116

}

Linha 117

Linha 118

}

Linha 119

Linha 120

public void setUp(){

Linha 121

bm = new ResourceBundleManager();

Linha 122

}

Linha 123

Linha 124

public void testGetMessageFromResourceBundle(){

Linha 125

Mockit.setUpMock(FacesContext.class, MockFacesContext.class);

Linha 126

String msg = bm.getMessage("test");

Linha 127

assertEquals("test", msg);

Linha 128

}

Linha 129

Linha 130

public void testGetCurrentLoader(){

Linha 131

NoLayers nl = new NoLayers();

Linha 132

ClassLoader loader = bm.getCurrentLoader((Object)nl);

Linha 133

assertNotNull(loader);

Linha 134

}

Linha 135

Linha 137

}}}

Linha 85

~~FacesContext ctx = EasyMock.createMock(FacesContext.class);~~

Linha 86

~~Application app = EasyMock.createMock(Application.class);~~

Linha 87

~~ELContext ectx = EasyMock.createMock(ELContext.class);~~

Linha 88

~~ValueExpression vexp = EasyMock.createMock(ValueExpression.class);~~

Linha 89

~~EasyMock.expect(vexp.getValue(EasyMock.isA(ELContext.class))).andReturn("test");~~

Linha 90

Linha 91

~~EasyMock.replay(vexp);~~

Linha 92

~~EasyMock.replay(ectx);~~

Linha 93

Linha 94

~~ExpressionFactory exf = EasyMock.createMock(ExpressionFactory.class);~~

Linha 95

~~EasyMock.expect(exf.createValueExpression(EasyMock.isA(ELContext.class), EasyMock.isA(String.class),EasyMock.isA(Class.class))).andReturn(vexp);~~

Linha 96

~~EasyMock.replay(exf);~~

Linha 97

Linha 98

Linha 99

~~EasyMock.expect(app.getExpressionFactory()).andReturn(exf);~~

Linha 100

~~EasyMock.replay(app);~~

Linha 101

Linha 102

~~EasyMock.expect(ctx.getApplication()).andReturn(app);~~

Linha 103

~~EasyMock.expect(ctx.getELContext()).andReturn(ectx);~~

Linha 104

~~EasyMock.replay(ctx);~~

Linha 105

Linha 106

~~return ctx;~~

Linha 107

}

Linha 108

Linha 109

}

Linha 110

Linha 111

~~public void setUp(){~~

Linha 112

~~bm = new ResourceBundleManager();~~

Linha 113

}

Linha 114

Linha 115

~~public void testGetMessageFromResourceBundle(){~~

Linha 116

~~Mockit.setUpMock(FacesContext.class, MockFacesContext.class);~~

Linha 117

~~String msg = bm.getMessage("test");~~

Linha 118

~~assertEquals("test", msg);~~

Linha 119

}

Linha 120

Linha 121

~~public void testGetCurrentLoader(){~~

Linha 122

~~NoLayers nl = new NoLayers();~~

Linha 123

~~ClassLoader loader = bm.getCurrentLoader((Object)nl);~~

Linha 124

~~assertNotNull(loader);~~

Linha 125

}

Linha 126

Linha 127

}