Configurar varreduras do SonarQube em Azure DevOps pipelines

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 4 min. de leitura

    • Configure as varreduras do SonarQube ou do SonarCloud em pipelines MS Azure DevOps. Verifique Azure DevOps execuções de pipeline para verificações do SonarQube em todas as fases da execução do pipeline e busque listas e detalhes de verificações de qualquer fase para Velocidade de mudança para DevOps. Detalhar os detalhes da verificação com base nas categorias.

    Antes de Iniciar

    Certifique-se de atender aos seguintes pré-requisitos antes de configurar as verificações do SonarQube no pipeline Azure DevOps :
    • Você está usando uma versão do SonarQube compatível. Consulte Integrações do Velocidade de mudança para DevOps para obter versões da ferramenta compatíveis.
    • Conecte-se, configure a ferramenta Azure DevOps e descubra repositórios, tarefas de orquestração e pipelines existentes.
    • Crie um registro da ferramenta SonarQube. Para obter mais informações, consulte SonarQube integração com Velocidade de mudança para DevOps.
    • Instale a extensão SonarQube do Visual Studio Marketplace e configure a análise de ramificação para usar as tarefas do Azure DevOps em suas definições de compilação para analisar seus projetos. Para obter mais informações, consulte a documentação do SonarQube.
    • Instale as seguintes tarefas de extensão personalizadas em sua instância Azure DevOps.
    Função necessária:
    • admin ou sn_devops.admin em Velocidade de mudança para DevOps
    • administrador em Azure DevOps
    • Função de administrador no SonarQube com acesso a todos os projetos em que as varreduras do SonarQube estão configuradas.

    Por Que e Quando Desempenhar Esta Tarefa

    Por padrão, Azure DevOps fornece as seguintes tarefas para executar uma verificação do SonarQube em pipelines de compilação e versão:
    • Preparar análise no SonarCloud
    • Executar análise de código
    • Publicar resultado do portal de qualidade
    Adicione e configure tarefas de extensão personalizadas ServiceNow para que sejam tarefas padrão, para buscar os detalhes da verificação para ServiceNow DevOps de Azure DevOps criar e liberar pipelines. Os detalhes da verificação obtidos são:
    • pipelineName
    • buildNumber
    • stageName
    • Nome da ramificação
    • sonarProjectKey
    • sonarInstanceUrl

    Procedimento

    1. Defina e configure a Integração Azure DevOps e SonarQube para buscar análise de verificação dos pipelines de compilação.
      1. No console Azure DevOps, navegue até Organização > Integrações do Sonar > Pipelines > Trabalhos.
      2. Clique no ícone Adicionar tarefas ( Adicionar tarefas adicionais) e pesquise as extensões ServiceNow na barra de pesquisa Adicionar tarefas.
      3. Adicione as seguintes tarefas.
        • ServiceNow DevOps Criar tarefa de registro do Sonar.
        • ServiceNow DevOps Tarefa de registro do Sonar da versão.
      4. No formulário, preencha os campos.
        Tabela 1. ServiceNow DevOps Criar/versão do registro do Sonar
        Campo Descrição
        Nome de exibição Preenche automaticamente ao inserir a chave e a URL.
        ServiceNow endpoint O endpoint da instância ServiceNow que é criado automaticamente durante a configuração da ferramenta. Use a mesma conexão de serviço para esta tarefa.
        Chave do projeto do Sonar Insira o mesmo valor de chave de projeto que você usou ao configurar a tarefa Preparar análise no SonarCloud.
        URL da instância do Sonar Insira o mesmo URL que você usou para se conectar à ferramenta Sonar durante a criação da ferramenta.
        Nome do trabalho O nome do trabalho de pipeline Azure DevOps.

        Este campo aparece somente para a tarefa de registro do Sonar da versão do ServiceNow DevOps.
        Importante:
        Na lista de tarefas do trabalho de pipeline, certifique-se de que a tarefa Registro do Sonar de compilação da ServiceNow DevOps ou a tarefa Registro do Sonar da versão do ServiceNow DevOps seja adicionada após a tarefa Executar análise de código.
      Você configurou os pipelines de compilação para enviar resultados de verificação do sonar para sua aplicação DevOps. Os resultados da verificação são mapeados para a capacidade de qualidade do software e processados por um subfluxo do sistema de base associado (FetchSonarScanId), quando um evento é criado e processado na tabela Eventos de entrada.
    2. Associar etapas de pipelines do Azure no DevOps.
    3. 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 em ServiceNow DevOps. 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

    • 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.