A ferramenta TOTVS Code Analysis é uma solução da TOTVS que permite a análise estática de código fonte de aplicações desenvolvidas em Protheus, plataforma de gestão empresarial da empresa.
Essa ferramenta realiza a análise do código fonte de forma automatizada e identifica potenciais problemas, tais como: código duplicado, variáveis não utilizadas, endentação incorreta, entre outros. Além disso, também é possível configurar a ferramenta para seguir boas práticas de programação e normas de segurança.
Com a utilização da TOTVS Code Analysis, os desenvolvedores podem identificar problemas no código fonte de forma mais rápida e eficiente, o que pode contribuir para a redução de erros e o aumento da qualidade do software desenvolvido.
Abaixo iremos detalhar os passos para efetuar essa validação.
No primeiro acesso, é necessário criar uma nova conta. Clique em Novo cliente
Preencha os dados conforme exemplo abaixo e clique em Cadastrar:
Obs.: é necessário inserir o Totvs ID utilizado no License Server Virtual do Cliente.
Acesse o e-mail, copie a senha temporária enviada, e na tela de login do CodeAnalysis, digite o e-mail que foi cadastrado, insira a senha temporária enviada e clique em Entrar
Insira a senha temporária atual, e então cadastre uma nova senha
Vai ser exibida uma mensagem de senha alterada com sucesso, e voltará para a tela de login. Digite então novamente o e-mail cadastrado e entre com a nova senha
– Vai aparecer uma tela para a inclusão de Projetos, que é o local onde iremos agendar o envio dos fontes e análise dos mesmos. Clique em +Projeto
Na tela seguinte, preencha os dados conforme exemplo abaixo, e clique em Confirmar
Nome do projeto: Defina o nome que será utilizado neste projeto
Descrição do projeto: Descrição deste projeto
Tipo de acesso dos arquivos: define como os fontes serão enviados para análise. Para o nosso exemplo, utilizaremos a opção Upload
Usuários: Selecione os usuários que terão acesso a este projeto. Por padrão o usuário inicial já está criado e pode ser selecionado. Se quiser adicionar outros usuários, utilize o menu lateral Usuários
Obs.:
Formato dos arquivos e pastas: os arquivos e pastas não devem conter espaços e/ou acentos em seus nomes.
ADVPL Include: Se o projeto tiver includes adicionais aos padrões do Protheus, a pasta dele deve ser indicada neste campo. O formato de digitação da pasta é baseado nas pastas que devem conter no arquivo compactado (em .zip) e também na linguagem, que é Case Sensitive. Obrigatoriamente o arquivo compactado deve conter uma pasta chamada src na raiz do zip, que conterá os fontes, e se tiver includes, uma pasta para eles. No nosso exemplo, o arquivo compactado contém a pasta my_include e a pasta src na raiz do zip, conforme imagem abaixo:
Após preencher as informações, clique em Confirmar
Vai ser exibida uma mensagem informando que o projeto foi cadastrado com sucesso, e a página mostrará o projeto criado. Se precisar alterar alguma informação, clique em Manutenção. Caso esteja OK, clique em Agendar
Vai ser exibida uma janela para o carregamento do arquivo compactado. Clique em Selecionar arquivo, selecione o seu arquivo compactado, e clique em Agendar
Vai ser exibida uma mensagem de Agendamento efetuado, confirmando o envio dos fontes
Ao enviar o seu Projeto para a análise, ele entrará em uma fila de execução, e assim que verificado, será exibida a informação de Status de Executado. Para verificar, no menu lateral, clique em Agendamentos
Na tabela dos agendamentos, na coluna Link SonarQube, será exibido o link com as informações da análise feita pela Totvs referentes ao seu projeto. Clique sobre o link para abrir o projeto no SonarQube
Nesta tela serão exibidas as informações analisadas. Para verificar as regras da Totvs, clique no menu Rules e use o filtro ADVPL
Classificação dos tipos de Bugs apontados pelo CodeAnalysis
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.
Conclusão
A análise de código é uma técnica importante para garantir a qualidade e a confiabilidade do software desenvolvido no Protheus. Ao analisar o código-fonte, os desenvolvedores podem identificar possíveis problemas, como erros de sintaxe, falhas de segurança e problemas de desempenho. Além disso, a análise de código também pode ajudar a identificar áreas que precisam ser aprimoradas para melhorar a manutenção do software.
Existem diversas ferramentas disponíveis para realizar a análise de código no Protheus, como o TOTVS Developer Studio e o TOTVS Smart Analytics. Essas ferramentas podem ajudar a automatizar a análise de código e a gerar relatórios que mostram os resultados da análise, permitindo que os desenvolvedores identifiquem os problemas de forma mais rápida e eficiente.
Em resumo, a análise de código é uma técnica importante para garantir a qualidade e a confiabilidade do software desenvolvido no Protheus. Ao utilizar as ferramentas disponíveis para realizar a análise de código, os desenvolvedores podem identificar e corrigir problemas de forma mais rápida e eficiente, melhorando a manutenção e a qualidade do software.
Fernando Bueno
Atuando desde 2005 no mercado de tecnologia, desenvolvendo e implantando e sistemas gerenciais, sistemas e sites web e ecommerce.
Siga-me no Linked In