¶ Levantamento sobre os apontamentos identificados pelo SonarQube no Sistema Folha de Pagamento (Governa)
| Data de elaboração | 28/02/2024 |
| Responsável pelo levantamento | Ádrian Rabelo Mendes (Assessor), Diego Gonçalves de Almeida (Assessor), Jônatas Legal (Técnico em Tecnologia da Informação e Comunicação) (Assessor), Rodrigo Stefano Sales Nascimento (Assessor) |
| Equipe | CAOS |
| Alvo | Sistema Governa |
| Origem | Objetivo estratégico |
| Objetivo | Porque o sistema gestão geral e recursos humanos, precisa se adequar ao padrão ideal no SonarQube. |
¶ 1. Introdução
Este documento tem como objetivo apresentar um levantamento dos apontamentos identificados pelo SonarQube na análise do Sistema Folha de Pagamento (Governa). O SonarQube é uma ferramenta de qualidade de código amplamente reconhecida, que permite identificar bugs, vulnerabilidades e «code smells» no código-fonte, contribuindo significativamente para a melhoria contínua da qualidade do software.
¶ 2. Metodologia
Para a análise do sistema em questão, foi utilizada a versão 7.0 do SonarQube, pois é compatível com a versão do Java 8, em que o sistema Governa é compilado.
¶ 3. Resultados obtidos
Na análise realizada, foram identificados os seguintes apontamentos pelo SonarQube:
Cobertura de Código: 0% -> Para ser aprovado no sonar, o projeto precisa ter ao menos 80% de cobertura de códigos com testes.
Bugs: 333 -> Será necessário corrigir todos os bugs para adequação do governa ao sonarqube.
Vulnerabilidades: 157 -> Será necessário corrigir todas as vulnerabilidades para adequação do governa ao sonarqube.
Code Smells: 7.408 -> Será necessário corrigir todos os code smells para adequação do governa ao sonarqube.
¶ 4. Justificativa
Devido à grande quantidade de apontamentos identificados pelo SonarQube, torna-se inviável a listagem ponto a ponto de todos os itens nesta documentação. A decisão por uma abordagem mais estratégica e focada na resolução de categorias de problemas pode permitir uma otimização do tempo. Para isto, será proposto um plano de ação.
¶ 5. Plano de ação
Redução dos Code Smells: -> Iniciar o plano de ação focando na redução dos 7.408 code smells identificados. Esta etapa foi abordada como inicial, pois pode-se resolver muitos code smells em pouco tempo e não há muito risco de impacto nas funcionalidades do sistema.
Correção dos Bugs: -> Focar na correção dos 333 bugs identificados. A refatoração prévia e a melhoria na legibilidade do código facilitarão a identificação e correção dos bugs.
Resolução das vulnerabilidades: -> A resolução de code smells e bugs das etapas anteriores reduzirá o risco de vulnerabilidades serem exploradas. Neste caso, seria o momento certo de mitigar as vulnerabilidades restantes.
Alcançar 80% de Cobertura de Código: -> : Por fim, implementar testes unitários e de integração para alcançar a meta de 80% de cobertura de código exigida pelo sonarqube.
¶ 6. Conclusão
Esforço estimado: -> A ferramenta sonarqube estima em aproximadamente 188 dias o esforço para a devida adequação do sistema.
