Regras de análise de código
- Última atualização2024/09/26
Regras de análise de código
As regras são a base da análise do código. Elas são usadas para avaliar alógica de automação (Task Bot e Tarefa de API). As regras podem ser simples ou complexas, dependendo da avaliação realizada. As regras incluem práticas de codificação que podem ser verificadas. Elas se aplicam a pacotes e ações no código de automação.
Uma regra consiste em um único RULE_CODE e uma descrição que indica a natureza da avaliação a ser feita no código. Você pode usar os níveis de severidade (baixo ou alto) para enfatizar a criticidade da regra.
A tabela a seguir lista as regras e sua descrição, as quais podem ser usadas na análise de código:
Importante: Você deve ter a licença Enterprise Platform para aplicar regras de análise de código a Tarefas de API e usar a regra de Governança de IA. Consulte Enterprise Platform.
Código da regra | Grupo | Título | Descrição da regra | Aplicável ao arquivo de automação |
---|---|---|---|---|
ACT-GEN-001 | Ações, gerais | Ação máxima | O número de ações no bot não pode exceder o máximo especificado | Task Bot, Tarefa de API |
ACT-GEN-002 | Ações, gerais | Cobertura Tentar/Capturar | Todas as ações sem comentários dentro da lógica do bot devem estar dentro de um bloco Tentar/Capturar. | Task Bot, Tarefa de API |
ACT-GEN-003 | Ações, gerais | Detecção de loop infinito | Exige a verificação de loops infinitos na lógica do bot | Task Bot, Tarefa de API |
VAR-NMG-001 | Variáveis, nomenclatura | Padrão de nome variável | Os nomes das variáveis devem corresponder ao padrão de nomenclatura especificado | Task Bot, Tarefa de API |
VAR-NMG-002 | Variáveis, nomenclatura | Comprimento do nome da variável | Os nomes das variáveis devem estar dentro do comprimento mínimo e máximo de caracteres especificado | Task Bot, Tarefa de API |
VAR-USG-001 | Variáveis, uso | Nenhuma variável não utilizada | Todas as variáveis devem ser utilizadas dentro do bot | Task Bot, Tarefa de API |
VAR-USG-002 | Variáveis, uso | Restringir o número de variáveis de entrada e saída | O número de variáveis de entrada e saída não deve exceder o máximo especificado | Task Bot, Tarefa de API |
ACT-COM-001 | Ações, comentários | Comentário de cabeçalho obrigatório | A primeira ação no bot deve ser uma de Comentário | Task Bot, Tarefa de API |
ACT-COM-002 | Ações, comentários | Cobertura de comentários | O número de ações de Comentário deve ser igual ou maior que a porcentagem especificada do total das ações de comando | Task Bot, Tarefa de API |
VAL-HCV-002 | Valores, valores codificados | Sem atraso codificado | O tempo de atraso na ação Atrasar deve ser definida usando uma variável | Task Bot, Tarefa de API |
VAL-HCV-003 | Valores, valores codificados | Sem caminho de arquivo codificado | O caminho do arquivo ou pasta deve ser definido usando uma variável | Task Bot |
VAL-HCV-004 | Valores, valores codificados | Sem endereço de e-mail codificado | O campo de ação do comando não deve conter um endereço de e-mail codificado | Task Bot, Tarefa de API |
VAL-CRE-001 | Valores, valores codificados | Restringir o uso de strings inseguras | Strings inseguras não devem ser usadas em ações, gatilhos ou variáveis | Task Bot, Tarefa de API |
ACT-ERR-001 | Ações, gerenciamento de erros | Sem captura vazia | O bloco de captura não pode estar vazio | Task Bot, Tarefa de API |
ACT-ERR-002 | Ações, gerenciamento de erros | Registro de captura obrigatório | O bloco de captura deve conter uma ação Registrar em arquivo | Task Bot, Tarefa de API |
ACT-ERR-003 | Ações, gerenciamento de erros | Captura obrigatória da tela de captura | O bloco de captura deve conter uma Captura de tela ação | Task Bot |
ACT-ERR-004 | Ações, gerenciamento de erros | Referência de linha de captura obrigatória | O erro do bloco de captura deve conter o número da linha de referência | Task Bot, Tarefa de API |
ACT-LOG-001 | Ações, registros | Log para cobertura de arquivo | A lógica do bot deve conter a proporção especificada de ações Registrar em arquivo | Task Bot |
VAL-LMT-001 | Limites de valor | Limitar valor máximo de itens na lista | O número de itens em uma lista não deve exceder o máximo especificado | Task Bot, Tarefa de API |
VAL-LMT-002 | Limites de valor | Limitar dimensões da tabela | As dimensões da tabela não devem exceder o máximo especificado | Task Bot, Tarefa de API |
VAL-LMT-003 | Limites de valor | Limitar o registro máximo de itens | O número de itens em um registro não deve exceder o máximo especificado | Task Bot, Tarefa de API |
VAL-LMT-004 | Limites de valor | Limitar o máximo de itens no dicionário | O número de itens em um dicionário não deve exceder o máximo especificado | Task Bot, Tarefa de API |
AIG-MDL-001 | Governança de IA | Uso do modelo | Permite controlar o publicador e o modelo ou ID de implantação para alguns modelos na região que o desenvolvedor pode usar. | Task Bot, Tarefa de API |
Para obter mais informações sobre Governança de IA, consulte Regra de análise de código de Governança de IA. |