Operação do Pipeline: Varredura de Código PMD

Execute verificações automatizadas de análise estática de código nos seus metadados Salesforce usando Apex PMD. Detecte problemas de qualidade de código, imponha boas práticas e evite implantar componentes com violações críticas.

O Escaneamento de Código a operação analisa seus metadados do Salesforce para identificar problemas de qualidade de código antes da implantação. Ele garante que classes Apex, triggers e componentes atendam aos padrões e limites de codificação definidos.

Esta operação usa Apex PMD para análise estática e reporta problemas por severidade (Bloqueador, Crítico, Importante, Menor, Informativo). Os resultados da verificação são exibidos nos logs do job do pipeline e também podem ser revisados detalhadamente através da página de Resultado do Escaneamento de Código .

Opções de Configuração

Ao criar ou editar um passo do pipeline, configure o seguinte:

• Nome: Qualquer rótulo descritivo (por exemplo, PMD CodeScan).

• Operação: Escaneamento de Código.

• Tipo de verificação: Apex PMD.

• Descrição: Resumo curto do que esta verificação executa (por exemplo, Executando CodeScan PMD).

• Limiar de severidade: Define o nível mínimo de severidade que causará uma falha (Bloqueador, Crítico, Importante, Menor, Informativo).

• Próximo passo (Em sucesso / Em falha): Escolha o que o pipeline faz em seguida se a verificação passar ou falhar.

Criando um Passo de Escaneamento de Código

1. Vá para Pipelines → Criar ou Editar um pipeline existente.

2. Clique no + ícone entre Início e Parar.

3. No painel de configuração, defina os seguintes campos:

   • Nome: PMD CodeScan

   • Operação: Escaneamento de Código

   • Tipo de Verificação: Apex PMD

   • Descrição: Executando CodeScan PMD

   • Limiar de Severidade: Informativo

   • Próximo Passo: Em sucesso → Parar, Em falha → Parar

4. Clique em Adicionar para salvar a configuração.

Seu pipeline agora inclui um passo de Escaneamento de Código, conforme mostrado abaixo:

Executando um Pipeline

1. Clique em Executar Pipeline no canto superior direito.

2. A operação de Escaneamento de Código é executada automaticamente em todas as classes Apex e triggers no seu branch conectado.

3. Um banner em tempo real aparece mostrando o status atual (Em progresso, Concluído, ou Exceção).

4. Quando concluído, o status do job aparece como:

   • Concluído: Nenhuma violação encontrada acima do limiar.

   • Exceção: Violações detectadas além da severidade selecionada.

Visualizando Resultados

Após a execução, navegue para Código → Branch → Atividades → Pipelines.

Cada job mostra detalhes principais, tais como:

• Tipo: Escaneamento de Código

• Status: Concluído / Exceção

• Duração: Tempo total de execução

• Criado Por: Usuário que iniciou a verificação

Clique no nome do job para abrir logs detalhados.

Logs e Exceções

Ao visualizar um job com falha ou concluído, selecione o passo PMD CodeScan para revisar sua saída.

O log inclui:

• Analisador de Código iniciado

• projeto Salesforce recuperado

• Análise concluída

• Resumo de resultados por severidade

Exemplo de saída de log:

[Informação] Job iniciado  
[Informação] Início da recuperação do projeto Salesforce  
[Informação] Recuperação dos componentes Salesforce concluída  
[Informação] Analisador de código iniciado  
[Informação] Analisador de código concluído  
[Erro] Job falhou: Escaneamento de código excedeu o limiar permitido

Página de Resultado do Escaneamento de Código

Quando você clica em Ver resultado, o sistema redireciona para a página de Resultado do Escaneamento de Código mostrando um resumo visual de problemas agrupados por severidade:

• Crítico – Problemas que devem ser corrigidos e que bloqueiam a implantação

• Alto / Médio – Avisos para possíveis problemas

• Baixo / Menor – Problemas informativos ou de estilo

Cada arquivo lista o número de problemas e suas categorias (por exemplo, desempenho, segurança, manutenibilidade).

Exemplo:

Severidade	Contagem
Crítico	0
Alto	12
Médio	10
Baixo	0
Menor	0

Arquivos escaneados:

• force-app/main/default/classes/RevvyDemo.cls – 9 problemas

• force-app/main/default/classes/RevvyDemoTest.cls – 10 problemas

Visualização de Resultado por Arquivo

Clicar no nome de um arquivo (por exemplo, RevvyDemo.cls) abre uma visualização de detalhes por linha mostrando cada violação com regra, mensagem e localização.

Para cada problema, as seguintes informações são exibidas:

• Regra: A regra do PMD violada (por exemplo, ApexDoc).

• Mensagem: Descrição da violação (por exemplo, Falta descrição ApexDoc @description).

• Linha / Coluna: Localização exata do problema no arquivo fonte.

Regra	Mensagem	Linha	Coluna
ApexDoc	Comentário ApexDoc ausente	1	21
ApexDoc	Falta descrição ApexDoc @description	5	19
ApexDoc	Falta ApexDoc @return	5	19
ApexDoc	Falta ou incompatibilidade em ApexDoc @param	5	19
ApexDoc	Falta descrição ApexDoc @description	13	19

Melhores Práticas

• Execute Escaneamentos de Código automaticamente antes de cada implantação.

• Defina limiares de severidade com base nas regras de CI/CD (por exemplo, falhar em Crítico).

• Revise regularmente o página de Resultado do Escaneamento de Código e corrija problemas recorrentes.

• Combine Escaneamento de Código com Passo Manual para revisão e aprovação antes da produção.

• Mantenha configurações de regras consistentes em todos os ambientes.