Manual de uso da ferramenta

A Ferramenta

O TOTVS CodeAnalysis é uma ferramenta desenvolvida para permitir aos clientes

efetuarem uma verificação em seus fontes customizados, afim de certificar a qualidade dos
mesmos. Através de regras pré-determinadas.

A ferramenta possibilita que os requisitos indicados sejam corrigidos evitando um maior

impacto em atualizações.

Uma das recomendações da ferramenta é para a validação da utilização do ambiente do

cliente com Dicionário de Dados no Banco de Dados.

O serviço consiste no cadastro de um projeto no site do CodeAnalysis, envio de um

arquivo compactado (em .zip apenas) com os fontes a serem analisados, e agendamento da
análise desses fontes. Ao final, é exibida uma tela com o resultado da análise, apontando o
que precisa ser corrigido ou melhorado nos fontes.

Analise

A analise do TOTVS CodeAnalysis consiste na verificação de fontes buscando a ocorrência

de Bugs e possíveis problemas no código, como duplicidade de chamadas, funções
descontinuadas, bibliotecas customizadas não informadas no include, além da analise de
inconsistências na forma de escrita do código, ferindo as boas praticas de programação.
São apresentados no TOTVS CodeAnalysis, 3 tipos de Bugs, cada um com seu
determinado grau de severidade. Todos os bugs devem ser observados, uma vez que são
impeditivos para o bom funcionamento do sistema (todos são problemas).

Classificação dos bugs:

Blocker: é o bug mais crítico

Minor: bug menos crítico.
CodeSmell: é uma recomendação de correção (nada impede que no futuro um CodeSmell
torne-se um bug).

Os bugs podem ou não ser por performance, essa informação vem acompanhada na
descrição de cada issue.
Utilizando o TOTVS CodeAnalysis

Segue abaixo um passo-a-passo de uso da ferramenta CodeAnalysis.

Para acessar a ferramenta será necessário já ter criado um perfil de usuário, e um projeto
cadastrado devidamente já submetido a analise da ferramenta.

- Acesse o site https://codeanalysis.totvs.com.br e clique em Entrar

- Na tela acesso, é necessário informar seu login de cliente e senha.

Caso o projeto tenha sido criado por outro usuário(usuário administrador), deverá ser
solicitado ao mesmo a criação e autorização de seu usuário, para que seu acesso possa ser
realizado com sucesso.

- Ao acessar a ferramenta, será exibido um dashboard contendo os projetos criados,

lembrando que seu usuário deverá ter o acesso autorizado para cada projeto em questão.

Clique em Agendamentos, no Menu que aparece a esquerda da tela.

- Ao ser exibida a tela de Agendamentos, será possível visualizar os projetos que já foram
submetidos a analise da ferramenta. Clique no Link SonatQube para ser direcionado ao
dashboard de resultado de analise.
- Na tela do dashboard de analise, será possível visualizar diversos itens de menu incluindo
os indicadores de resultado da analise realizada pela ferramenta.

- Menus de navegação do SonarQube

Projects - Onde é possível verificar os projetos analisados.

Issues - Onde é exibida a relação de todos os bugs encontrados na analise, fonte a fonte.

Rules – Relação de todas as “etiquetas” de erro/problemas, utilizados para categorização

da analise pela ferramenta.

Quality Profiles – Exibe a quantidade de “etiquetas” encontradas e agrupadas por projeto.

Quality Profiles – Exibe a quantidade de “etiquetas” encontradas