Gestão de políticas de análise de códigos

As políticas de análise de códigos são um conjunto de regras que podem ser aplicadas a diferentes projetos, permitindo a flexibilidade ao introduzir normas de codificação.

Para melhorar a qualidade do código, você pode como administrador:
  • Criar políticas com regras diferentes.
  • Você pode aplicar diferentes políticas a diferentes pastas na página Automação .
  • Acessar facilmente às informações das regras políticas ao mesmo tempo que gere as políticas de análise de códigos.

Configurar a política de análise de código

Como administrador, ative a política de análise de código ao acessar a guia Administração > Configurações > Políticas. Clique em Editar para ativar a política de análise de códigos. Ao ativar a política de análise de códigos:

  • A análise de códigos é executada automaticamente em todos os bots no espaço de trabalho público com status Não verificado e ficam em pastas às quais é atribuída uma política de análise de código. Isso proporciona visibilidade sobre a codificação das melhores práticas para a bots no espaço de trabalho público. A análise do código é executada a cada cinco minutos e verifica 1.000 arquivos de bot em cinco minutos.
  • A análise do código é invocada quando se guarda uma bot na Editor de bot.
  • O resumo dos resultados da análise do código é visível na página Automação.
  • Os resultados da análise do código são apresentados no separador Assistente.
  • O ícone Executar análise de código está disponível a partir da ação de nível de linha na página Automação. A execução da análise de código na página Automação permite baixar o relatório de violação da análise de código.

Ao desativar a política de análise de código, as funções e características da análise de código não ficam disponíveis.

Impacto no desempenho da verificação em segundo plano

A verificação automatizada para análise de código é um trabalho em segundo plano executado na Control Room. Ela é executada a cada cinco minutos e verifica arquivos em lotes de 1.000.

Para minimizar o impacto no desempenho da Control Room, a análise automatizada de código é executada apenas em um único nó da Control Room (no caso de implantações de múltiplos nós). Apenas um trabalho de verificação em segundo plano é executado por vez, ou seja, o trabalho é executado até ser concluído antes de outra instância do trabalho ser iniciada. O trabalho em segundo plano verifica os arquivos sequencialmente, um por um, portanto, o número máximo de arquivos verificados por ele a qualquer momento é apenas um.

São apresentadas a seguir as condições de quando uma verificação completa de todo o repositório público é iniciada:
  • Política adicionada à pasta raiz.
  • Política aplicada à pasta raiz é alterada.
  • Política é adicionada ou alterada em todas as pastas do repositório público.
Nota:
  • Para repositórios maiores, o trabalho de verificação em segundo plano levará várias horas.
  • A verificação acontece somente nos arquivos com status Não verificado, com a análise de código automatizada e, se você alterar as políticas, todos os arquivos nas pastas que possuem as políticas atualizadas serão definidos para o status Não verificado.

Independente da análise de código estar ativada ou desativada, ainda é possível criar múltiplas políticas e atribuir essas políticas a diferentes pastas na página Automação.

O vídeo a seguir mostra como configurar a política de análise de código:

Criar e atribuir uma política de análise de código

É possível configurar múltiplas políticas nomeadas para a análise de código. Com esse recurso, você pode criar diferentes políticas com diferentes regras configuradas com diferentes configurações e diferentes níveis de severidade. Você pode utilizar essas políticas nomeadas de análise de código para definir diferentes normas de qualidade de código e aplicá-las a diferentes projetos de automação, atribuindo a política a pastas específicas. Isto proporciona a flexibilidade para introduzir gradualmente normas de qualidade de código em projetos existentes e antigos e aplicar normas mais firmes em projetos mais recentes.

Você precisa das permissões Exibir políticas e Gerenciar políticas para configurar uma política de análise de código. Essas permissões permitem que você visualize, edite e atribua políticas que definem como os desenvolvedores podem criar automações. A permissão Gerenciar políticas permite a atribuição de políticas às pastas às quais você tem acesso.

A página Administração > Políticas tem duas guias: Políticas e Atribuir. Você pode criar e nomear essas políticas na guia Políticas. Você pode criar quantas políticas quiser. Você pode pesquisar qualquer política utilizando a ferramenta de pesquisa no topo. Você pode usar o nome ou descrição da apólice na janela de seleção de apólices para procurar uma apólice. Você também pode visualizar, editar e apagar quaisquer políticas clicando no menu de ações (elipses verticais) à direita e selecionando a ação apropriada.

Utilize a guia Atribuir para atribuir uma política a uma pasta na página Automação. Você pode opcionalmente remover a política atribuída em qualquer pasta clicando no menu de ações (elipses verticais) à direita e selecionando a Cancelar atribuição de política.

Pop-up de resumo da política: O pop-up de resumo da política fornece uma referência rápida e fácil aos detalhes da regra definida na política e sua gravidade. Com esse pop-up, é mais fácil entender qual política é aplicada a diferentes pastas sem precisar navegar para frente e para trás entre as guias de política e atribuição no gerenciador de políticas. Ele também ajuda a decidir rapidamente qual política você deseja atribuir a uma determinada pasta.

Esse pop-up de resumo da política é fornecido nas guias a seguir:
  • Guia Política: Clique no número de regras.
  • Guia Atribuir: Clique na política atribuída ou no número de regras na opção Atribuir política.

Comportamento político em operações de pastas

O quadro seguinte descreve o comportamento das políticas quando determinadas operações são realizadas na pasta.
Operação de pasta Comportamento da política
Criar A pasta herda a política da pasta principal mais próxima
Renomear A pasta mantém a política atual
Mover A pasta mantém a política atual ou herda a política da pasta principal mais próxima
Excluir A política atribuída à pasta é removida

Quando você executa a análise de código em um bot, a política aplicável é usada para a pasta (atribuída ou herdada) onde o bot está localizado.