Mantenha a arquitetura de componentes equilibrada

Mais um post da série de qualidade de código em teste de software

Se você está chegando neste post agora e ainda não leu os conteúdos anteriores, recomendo começar por eles. Seguem os links:

• Escreva pequenas unidades de código
• Escreva simples unidades de código
• Escreva código uma só vez
• Mantenha as interfaces da unidade pequenas
• Separe responsabilidades em módulos
• Acople a arquitetura de componentes fracamente

Agora se você já leu os primeiros posts da série, vamos falar sobre a sétima guideline do Better Code Hub: Mantenha a arquitetura de componentes equilibrada.

Segundo o BCH:

• Equilibrar o número e o tamanho relativo dos componentes facilita a localização do código.
• Organize o código-fonte de forma que o número de componentes esteja entre 2 e 12 e garanta que os componentes tenham aproximadamente o mesmo tamanho (mantenha a uniformidade do tamanho dos componentes em menos de 0,71).

Equilibrar o número e o tamanho relativo dos componentes facilita a localização do código

Para exemplificar esta guideline publiquei o seguinte projeto de testes automatizados end-to-end, o qual é separado pelos seguintes componentes:

• specifications (arquivos com a definição dos testes) – 95 linhas de código – aproximadamente 42,8% do código-fonte
• page-objects (abstração das páginas web da aplicação em teste) – 22 linhas de código –  aproximadamente 9,9% do código-fonte
• components (abstração dos elementos web e métodos, os quais compõe os page-objects) – 47 linhas de código – aproximadamente 21,2 % do código-fonte
• configurations (configurações padrão, e específicas por navegador, para execução dos testes) – 52 linhas de código – aproximadamente 23,4 % do código-fonte
• constants (strings constantes utilizadas por testes) – 6 linhas de código – aproximadamente 2,7 % do código fonte

Total de linhas de código: 222

Perceba que tal organização torna fácil navegar entre os diferentes componentes, além seu seu tamanho relativo não variar muito, com excessão do arquivo de constantes, o qual não é um problema, visto que é um arquivo bastante pequeno quando comparado com os outros componentes.

Organize o código-fonte de forma que o número de componentes esteja entre 2 e 12 e garanta que os componentes tenham aproximadamente o mesmo tamanho

Seguindo com o mesmo exemplo, o projeto de testes automatizados end-to-end demonstrado contém 5 componentes principais, ou seja, está entre 2 e 12. ✅

Com isso, a uniformidade do tamanho dos componentes é de 0,37, conforme pode ser visto na imagem abaixo. ✅

Portanto, quando estiver escrevendo seus testes automatizados, pense nisso, e nas outras guidelines, e assim sua arquitetura e código serão mantidos “limpos”.

O próximo post da série será: Mantenha sua base de código pequena.

Até a próxima e bons testes! 👋