Skip to main content

Test-Driven Development

Neste documento, vamos detalhar o planejamento de testes unitários para o projeto EcoVigilância, focando no sistema de broker MQTT, no servidor e na segurança das aplicações. Os testes serão desenvolvidos utilizando a linguagem Go e abordarão diversas áreas críticas do sistema para garantir sua qualidade e robustez.

Sistema de Broker MQTT​

Testes de Comunicação​

  • Verificar se o broker MQTT está recebendo e enviando mensagens corretamente.

  • Testar os casos de sucesso e falha para garantir a integridade da comunicação entre os clientes MQTT e o broker.

  • Garantir que as mensagens sejam entregues corretamente aos clientes inscritos nos tópicos relevantes.

Testes de Segurança​

  • Testar a autenticação de clientes MQTT para garantir que apenas usuários autorizados tenham acesso ao sistema.

  • Verificar se as permissões de acesso aos tópicos estão sendo aplicadas corretamente para evitar acessos não autorizados.

  • Testar casos de ataques de negação de serviço (DoS) para avaliar a resiliência do sistema a esses tipos de ataques.

Servidor - Backend​

Testes de Rotas HTTP​

  • Verificar se as rotas HTTP do servidor estão respondendo corretamente aos diferentes métodos HTTP (GET, POST, etc.).

  • Testar os casos de sucesso e falha para garantir o correto funcionamento das rotas protegidas e não protegidas.

Testes de Segurança​

  • Testar os mecanismos de autenticação e autorização para garantir que apenas usuários autenticados tenham acesso aos recursos protegidos.

  • Verificar se o servidor está protegido contra ataques de injeção de código, XSS e CSRF.

Considerações de Segurança​

Testes de Injeção de SQL​

  • Garantir que o servidor esteja protegido contra ataques de injeção de SQL, verificando se as consultas SQL são sanitizadas corretamente.

Testes de XSS (Cross-Site Scripting)​

  • Testar se o servidor está protegido contra ataques XSS, validando se os dados de entrada são corretamente sanitizados antes de serem renderizados no navegador.

Testes de CSRF (Cross-Site Request Forgery)​

  • Verificar se o servidor está protegido contra ataques CSRF, garantindo que todas as solicitações estejam acompanhadas de tokens de autenticação válidos.

Esses testes unitários ajudarão a garantir a qualidade e segurança do sistema EcoVigilância, permitindo uma implementação robusta e confiável.

Implementação dos testes​

Rodando os testes:​

Todos os comandos necessários estão sendo abstraídos por um arquivo Makefile. Se você tiver curiosidade para saber o que o comando abaixo faz, basta conferir aqui.

Comando:​
make test
Output:​
[+] Running 1/1
✔ Container backend-broker-1  Started                                                                                                          0.0s 
Running the tests
?       github.com/Inteli-College/2024-T0002-EC09-G04/cmd/api-test      [no test files]
?       github.com/Inteli-College/2024-T0002-EC09-G04/cmd/simulation    [no test files]
ok      github.com/Inteli-College/2024-T0002-EC09-G04/internal/gas      0.003s  coverage: 100.0% of statements
ok      github.com/Inteli-College/2024-T0002-EC09-G04/internal/rad_lum  0.003s  coverage: 100.0% of statements
ok      github.com/Inteli-College/2024-T0002-EC09-G04/pkg/station       2.011s  coverage: 88.5% of statements
[+] Running 2/2
✔ Container backend-broker-1  Removed                                                                                                          0.2s 
✔ Network backend_default     Removed
NOTE
  • No meio do processo, é necessário subir um broker local para realizar os testes de transmissão de mensagens entre os tópicos.

Rodando a visualização da cobertura de testes:​

Novamente, todos os comandos necessários estão sendo abstraídos por um arquivo Makefile. Se você tiver curiosidade para saber o que o comando abaixo faz, basta conferir aqui.

Comando:​
make coverage
Output:​

output_coverage

NOTE
  • Este comando está criando, a partir do arquivo coverage_sheet.md, uma visualização da cobertura de testes nos principais arquivos Go.

Apêndice​

Testes automatizados são essenciais no desenvolvimento de software, integrados com ferramentas de CI/CD para proporcionar uma abordagem consistente e eficiente. Essa prática permite identificar rapidamente problemas, reduzir erros e acelerar o ciclo de entrega, resultando em software de maior qualidade e lançamentos mais rápidos e confiáveis. Implementamos uma primeira versão dessa estrategia, para mais detalhes acesse o workflow de testes do Github Actions.