Configurar varreduras do SonarQube em Jenkins pipelines

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 2 min. de leitura
  • Configure as verificações do SonarQube em Jenkins pipelines.

    Antes de Iniciar

    Certifique-se de atender aos seguintes pré-requisitos antes de configurar os pipelines do Jenkins para verificações do SonarQube
    • SonarCloud ou SonarQube versão 8.6.1 edição da comunidade
    • O SonarQube Scanner para Jenkins 2.4 ou superior está instalado em sua instância/ambiente do Jenkins.
    • ServiceNow DevOps versão do plug-in 1.27 ou posterior para Jenkins.
    • Certifique-se de que as verificações do SonarQube estejam configuradas e existam em seus Jenkins pipelines usando o plug-in SonarQube Scanner para Jenkins. Para obter mais informações, consulte
    • Uma ferramenta SonarQube é criada e conectada ao servidor SonarQube. Para obter mais informações, consulte SonarQube integração com Velocidade de mudança para DevOps.
    Função necessária: sn_devops.admin

    Por Que e Quando Desempenhar Esta Tarefa

    Quando você executa um pipeline que tem execuções de verificação do SonarQube, os detalhes são obtidos em ServiceNow DevOps do pipeline Jenkins. Usando o plug-in Jenkins, verificamos se a execução da verificação está configurada no pipeline Jenkins e verificamos se há verificações do SonarQube em cada fase de orquestração, usando o marcador withSonarQubeEnv. Se uma análise do SonarQube tiver ocorrido em qualquer fase da execução do pipeline, como parte da nossa notificação de término, adicionamos um modelo com os detalhes de scanID e URL para cada verificação que ocorre em uma fase específica. Essas análises ou detalhes de verificação são correlacionados e exibidos na lista relacionada Resumo da qualidade do software em solicitações de mudança e execuções de tarefas.

    Procedimento

    1. No Jenkins, navegue até Gerenciar Jenkins > Configurar sistema, marque a caixa de seleção Habilitar injeção de configuração do servidor SonarQube como variáveis de ambiente de compilação na seção Servidores SonarQube e preencha os campos.
      Tabela 1. Instalações do SonarQube
      Campo Descrição
      Nome Um nome exclusivo para a configuração/projeto.
      URL do servidor URL ou endereço IP do servidor SonarQube.
      Autenticação do servidor Selecione o tipo de token de autenticação relevante para a configuração.
      Nota:
      Use esses mesmos detalhes ou valores do servidor SonarQube ao criar as ferramentas SonarQube em ServiceNow DevOps, bem como no pipeline Jenkins.
    2. Clique em Testar Conexão.
      Verifique se a mensagem de conexão bem-sucedida é mostrada.
    3. Clique em Aplicar e Salvar.
    4. Execute o pipeline.

    Resultado

    Com base nos resultados da verificação em várias fases da execução do pipeline, os resultados são mostrados na etapa correspondente do pipeline. Eventos de entrada são criados para notificações e subfluxos são acionados com base no tipo de notificação e na capacidade.

    O que Fazer Depois

    Nota:

    Navegue até a IU do pipeline para exibir os detalhes da verificação em Qualidade > Resultados de qualidade do software.

    • Exibir detalhes da verificação como parte das execuções de tarefa. Exiba detalhes de todas as verificações do Sonar que fazem parte da execução da tarefa mapeada para uma etapa de execução do pipeline de compilação ou versão.
      1. Navegar até DevOps > Orquestrar > Execução de tarefa clique em um registro de execução de tarefa relevante.
      2. Clique na lista relacionada Resumo da qualidade do software.
      3. Clique em um registro de ID de verificação relevante.
      O Resumo da verificação de qualidade do software e os Detalhes da verificação são exibidos.
    • Exibir detalhes da verificação como parte da solicitação de mudança. Exibir todas as verificações que fizeram parte deste pipeline de compilação/versão no Resultados de qualidade do software > Resumo da qualidade do software lista relacionada.
      1. Navegar até DevOps > Orquestrar > Solicitações de Mudança de Pipeline
      2. Clique na lista relacionada Resumo da qualidade do software.
      3. Clique em um registro de ID de verificação relevante.
      O Resumo da verificação de qualidade do software e os Detalhes da verificação são exibidos.