{"meta":{"title":"Configurando a cobertura de código para seu repositório","intro":"Use a cobertura de código integrada do Code Quality para encontrar código não testado em pull requests, sem precisar pagar por nem manter um serviço separado de terceiros.","product":"Qualidade de segurança e código","breadcrumbs":[{"href":"/pt/enterprise-cloud@latest/code-security","title":"Qualidade de segurança e código"},{"href":"/pt/enterprise-cloud@latest/code-security/how-tos","title":"How-tos"},{"href":"/pt/enterprise-cloud@latest/code-security/how-tos/maintain-quality-code","title":"Manter o código de qualidade"},{"href":"/pt/enterprise-cloud@latest/code-security/how-tos/maintain-quality-code/set-up-code-coverage","title":"Configurar a cobertura de código"}],"documentType":"article"},"body":"# Configurando a cobertura de código para seu repositório\n\nUse a cobertura de código integrada do Code Quality para encontrar código não testado em pull requests, sem precisar pagar por nem manter um serviço separado de terceiros.\n\nVocê pode configurar a cobertura de código para seu repositório de duas maneiras:\n\n* **Configuração automática:** Use o agente alimentado por IA para gerar um fluxo de trabalho automaticamente. Escolha essa opção se:\n * Você deseja começar rapidamente sem escrever a configuração do YAML.\n * Seu projeto usa estruturas de teste comuns e padrões de build.\n * Você se sente à vontade para iterar sobre um fluxo de trabalho gerado por IA.\n* **Configuração manual:** Configure seu fluxo de trabalho de CI por conta própria. Escolha essa opção se:\n * Você precisa de controle preciso sobre o processo de cobertura.\n * Você tem requisitos complexos de CI (como registros privados ou etapas de build personalizadas).\n * Você deseja entender exatamente como a cobertura está configurada.\n\n## Configuração automática\n\nVocê pode usar a opção de configuração automática para gerar um fluxo de trabalho funcional para cobertura de código sem redigir manualmente a configuração de CI. Um agente analisa seu repositório, identifica sua estrutura de teste e abre uma solicitação de pull com um fluxo de trabalho de cobertura pronto para revisão.\n\n> \\[!NOTE]\n> A instalação automática usa a IA para gerar o arquivo de fluxo de trabalho. Não há custo adicional para usar esse recurso.\n\n### Pré-requisitos para configuração automática\n\n* Code Quality está habilitado para seu repositório. Consulte [Habilitando o GitHub Code Quality](/pt/enterprise-cloud@latest/code-security/how-tos/maintain-quality-code/enable-code-quality).\n* Seu repositório já possui uma suíte de testes.\n\n### Gerar automaticamente um fluxo de trabalho de cobertura\n\n1. Em GitHub, acesse a página principal do repositório.\n2. No nome do repositório, clique em ** Settings**. Caso não consiga ver a guia \"Configurações\", selecione o menu suspenso **** , clique em **Configurações**.\n\n \n3. Na barra lateral, em \"Segurança\", clique ** Qualidade do código** para exibir a página \"Qualidade do código\".\n4. Na seção \"Análise de cobertura de código\", clique na caixa suspensa **Configuração**.\n5. Na lista, selecione **Gerar fluxo de trabalho com IA**. Aguarde até que o agente analise seu repositório. O agente abre um pull request em rascunho e publica um checklist das etapas em que está trabalhando.\n6. Para examinar a solicitação de pull, clique **em Examinar solicitação de pull**.\n Examine a solicitação de pull assim que o agente concluir seu trabalho. A descrição da solicitação de pull resume as alterações, incluindo atualizações de configuração de projeto, alterações de arquivo de fluxo de trabalho e configurações de saída de cobertura.\n7. Se o fluxo de trabalho for executado com êxito na CI e a cobertura for carregada corretamente, mescle a solicitação de pull.\n\n Se o fluxo de trabalho precisar de ajustes, consulte [Configuração automática de cobertura de código](/pt/enterprise-cloud@latest/code-security/concepts/code-quality/automatic-code-coverage-setup) para obter diretrizes sobre os diferentes resultados e como iterar.\n\nPara obter mais informações sobre como o agente funciona e o que esperar, consulte [Configuração automática de cobertura de código](/pt/enterprise-cloud@latest/code-security/concepts/code-quality/automatic-code-coverage-setup).\n\n## Configuração manual\n\nA cobertura de código integrada permite acompanhar com que profundidade seus testes exercitam o código, sem precisar adicionar um serviço de terceiros ao seu conjunto de ferramentas nem ao orçamento. Nos procedimentos a seguir, você gerará um relatório de cobertura no formato Cobertura XML a partir do seu conjunto de testes, fará upload dele para GitHub e visualizará os resultados da cobertura em seus pull requests.\n\n### Pré-requisitos para configuração manual\n\n* Code Quality está habilitado para seu repositório.\n* Seu repositório possui uma suíte de testes executada em GitHub Actions.\n* Sua estrutura de teste pode produzir um relatório de cobertura no formato **Cobertura XML** .\n\n### Etapa 1: gerar um relatório de cobertura Cobertura XML\n\nConfigure seu framework de testes para gerar um relatório de cobertura no formato Cobertura XML. A cobertura de código funciona com qualquer linguagem de programação que possa produzir esse formato.\n\n1. Identifique a ferramenta de cobertura do seu idioma na tabela abaixo.\n2. Adicione o comando ou a configuração apropriada ao fluxo de trabalho de CI para que um arquivo XML do Cobertura seja gerado sempre que os testes forem executados.\n\n| Linguagem | Estrutura/Ferramenta | Como gerar Cobertura XML |\n| --------------------- | ------------------------------- | --------------------------------------------------------------------------------- |\n| Python | `pytest` + `pytest-cov` | `pytest --cov=. --cov-report=xml` |\n| Java | JaCoCo | Usar o script `cover2cover.py` ou o plug-in JaCoCo-to-Cobertura Gradle/Maven |\n| JavaScript/TypeScript | Istambul/ `nyc` | `nyc report --reporter=cobertura` |\n| Ruby | SimpleCov | Adicionar `SimpleCov::Formatter::CoberturaFormatter` |\n| Go | `go test` + `gocover-cobertura` | `go test -coverprofile=cover.out && gocover-cobertura < cover.out > coverage.xml` |\n\n> \\[!TIP]\n> Se o seu framework não estiver listado acima, verifique na documentação dele se há suporte para saída no formato Cobertura. Muitas ferramentas têm suporte nativo a esse formato ou podem converter de outros formatos para o XML Cobertura.\n\n### Etapa 2: Carregar o relatório de cobertura\n\nDepois que seus testes gerarem um relatório Cobertura XML, faça upload dele para GitHub para que os resultados de cobertura apareçam nos pull requests.\n\n1. Abra o arquivo de fluxo de trabalho ci do repositório (por exemplo, `.github/workflows/ci.yml`).\n\n2. Adicione a seguinte etapa após a etapa que executa seus testes e gere o relatório de cobertura:\n\n ```yaml copy\n - name: Upload coverage report\n if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository\n uses: actions/upload-code-coverage@v1\n with:\n file: COVERAGE-FILE-PATH.xml\n language: LANGUAGE\n label: LABEL\n ```\n\n3. Substitua os seguintes valores:\n * **`COVERAGE-FILE-PATH.xml`**: o caminho para o relatório XML do Cobertura (por exemplo, `coverage.xml` ou `target/site/jacoco/cobertura.xml`).\n * **`LANGUAGE`**: o idioma principal do código que está sendo coberto (por exemplo, `Python`, `Java`, `JavaScript`).\n * **`LABEL`**: um rótulo para identificar esse relatório de cobertura (por exemplo, `code-coverage/pytest`).\n\n4. Confirme e envie por push a alteração do fluxo de trabalho.\n\n### Exemplo de fluxo de trabalho completo\n\nEste exemplo executa Python testes com `pytest-cov` e carrega o relatório de cobertura:\n\n```yaml annotate copy\n# This workflow runs your test suite, generates a Cobertura XML coverage report, and uploads it to GitHub. Once this workflow is committed, coverage results appear automatically on every pull request.\nname: Code Coverage\n\n# Run on pushes to the default branch (to establish the baseline) and on pull requests (to compare against it). Code Quality compares PR branch coverage to the default branch, so both triggers are needed.\non:\n push:\n branches: [main]\n pull_request:\n branches: [main]\n\n# The `code-quality: write` permission is required to upload coverage data. No other elevated permissions are needed.\npermissions:\n contents: read\n code-quality: write\n\njobs:\n test:\n runs-on: ubuntu-latest\n steps:\n # Check out the PR head commit (not the merge commit) so coverage line numbers map correctly to the diff.\n - uses: actions/checkout@v6\n with:\n ref: ${{ github.event.pull_request.head.sha || github.sha }}\n\n # Replace this step with whatever language setup your project uses (Node.js, Java, Go, etc.). The upload action works with any language that produces a Cobertura XML report.\n - uses: actions/setup-python@v5\n with:\n python-version: \"3.x\"\n\n - name: Install dependencies\n run: |\n python -m pip install --upgrade pip\n pip install -r requirements.txt\n pip install pytest pytest-cov\n\n # Adapt this step for your test framework. The key requirement is producing a Cobertura XML file. For other languages, see the framework table earlier in this article.\n - name: Run tests with coverage\n run: pytest --cov=. --cov-report=xml\n\n # This step replaces any third-party coverage upload (Codecov, Coveralls, etc.). After this runs, the `github-code-quality[bot]` bot posts a coverage summary directly on the pull request.\n - name: Upload coverage report\n if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository\n uses: actions/upload-code-coverage@v1\n with:\n file: coverage.xml\n language: Python\n label: code-coverage/pytest\n```\n\n### Etapa 3: Exibir os resultados de cobertura em pull requests\n\n1. Abra uma solicitação de pull (ou envie por push para uma existente) que dispare o fluxo de trabalho configurado.\n2. Após a conclusão do fluxo de trabalho, procure um comentário de `github-code-quality[bot]` na pull request. O comentário inclui:\n * O percentual de cobertura de linha agregada para o branch de solicitação de pull em comparação com o branch padrão.\n * Um detalhamento por arquivo mostrando quais arquivos ganharam ou perderam a cobertura."}