{"meta":{"title":"Configuration de la couverture du code pour votre référentiel","intro":"Importez des rapports de couverture de tests pour afficher les résultats de couverture directement dans les pull requests, ce qui permet aux relecteurs d’identifier le code non testé avant leur fusion.","product":"Sécurité et qualité du code","breadcrumbs":[{"href":"/fr/enterprise-cloud@latest/code-security","title":"Sécurité et qualité du code"},{"href":"/fr/enterprise-cloud@latest/code-security/how-tos","title":"Guides pratiques"},{"href":"/fr/enterprise-cloud@latest/code-security/how-tos/maintain-quality-code","title":"Maintenir le code de qualité"},{"href":"/fr/enterprise-cloud@latest/code-security/how-tos/maintain-quality-code/set-up-code-coverage","title":"Configurer la couverture du code"}],"documentType":"article"},"body":"# Configuration de la couverture du code pour votre référentiel\n\nImportez des rapports de couverture de tests pour afficher les résultats de couverture directement dans les pull requests, ce qui permet aux relecteurs d’identifier le code non testé avant leur fusion.\n\n> \\[!NOTE]\n> GitHub Code Quality est actuellement dans préversion publique et peut être modifié.\n> Pendant préversion publique, Code Quality ne sera pas facturé, bien que les analyses Code Quality consomment GitHub Actions minutes.\n\nDans les procédures suivantes, vous allez générer un rapport de couverture XML Cobertura à partir de votre suite de tests, le téléverser vers GitHub, puis consulter les résultats de couverture sur vos pull requests.\n\n## Prerequisites\n\n* Code Quality est activé pour votre référentiel.\n* Votre référentiel a une suite de tests qui s’exécute dans GitHub Actions.\n* Votre infrastructure de test peut produire un rapport de couverture au format **XML Cobertura** .\n\n## Étape 1 : Générer un rapport de couverture XML Cobertura\n\nConfigurez votre infrastructure de test pour générer un rapport de couverture au format XML Cobertura. La couverture du code fonctionne avec n’importe quel langage de programmation qui peut produire ce format.\n\n1. Identifiez l’outil de couverture de votre langue dans le tableau ci-dessous.\n2. Ajoutez la commande ou la configuration appropriée à votre flux de travail CI afin qu’un fichier XML Cobertura soit généré chaque fois que vos tests s’exécutent.\n\n| Langage               | Framework / Outil               | Comment générer le XML Cobertura                                                   |\n| --------------------- | ------------------------------- | ---------------------------------------------------------------------------------- |\n| Python                | `pytest` + `pytest-cov`         | `pytest --cov=. --cov-report=xml`                                                  |\n| Java                  | JaCoCo                          | Utiliser le `cover2cover.py` script ou le plug-in JaCoCo-to-Cobertura Gradle/Maven |\n| JavaScript/TypeScript | Istanbul/ `nyc`                 | `nyc report --reporter=cobertura`                                                  |\n| Ruby                  | SimpleCov                       | Ajouter `SimpleCov::Formatter::CoberturaFormatter`                                 |\n| Go                    | `go test` + `gocover-cobertura` | `go test -coverprofile=cover.out && gocover-cobertura < cover.out > coverage.xml`  |\n\n> \\[!TIP]\n> Si votre framework n’est pas répertorié ci-dessus, consultez sa documentation pour vérifier la prise en charge du format de sortie Cobertura. De nombreux outils le prennent en charge directement ou peuvent être convertis en Xml Cobertura à partir d’autres formats.\n\n## Étape 2 : Charger le rapport de couverture\n\nUne fois que vos tests ont généré un rapport XML Cobertura, téléversez-le sur GitHub afin que les résultats de couverture s’affichent sur les demandes de fusion.\n\n1. Ouvrez le fichier de flux de travail CI de votre référentiel (par exemple). `.github/workflows/ci.yml`\n\n2. Ajoutez l’étape suivante après l’étape qui exécute vos tests et génère le rapport de couverture :\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. Remplacez les valeurs suivantes :\n   * **`COVERAGE-FILE-PATH.xml`**: chemin d’accès à votre rapport XML Cobertura (par exemple, `coverage.xml` ou `target/site/jacoco/cobertura.xml`).\n   * **`LANGUAGE`** : langage principal du code couvert (par exemple, `Python`, `Java`, `JavaScript`).\n   * **`LABEL`**: étiquette facultative pour identifier ce rapport de couverture (par exemple, `code-coverage/pytest`).\n\n4. Effectuez un commit et poussez la modification du flux de travail.\n\n### Exemple de flux de travail complet\n\nCet exemple exécute Python tests avec `pytest-cov` et charge le rapport de couverture :\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## Étape 3 : Afficher les résultats de couverture sur les pull requests\n\n1. Ouvrez une pull request (ou ajoutez des commits à une pull request existante) qui déclenche le workflow que vous avez configuré.\n2. Une fois le workflow terminé, recherchez un commentaire de `github-code-quality[bot]` sur la pull request. Le commentaire comprend :\n   * Le pourcentage de couverture agrégé de la branche de la pull request par rapport à la branche par défaut.\n   * Répartition par fichier montrant quels fichiers ont gagné ou perdu la couverture.\n\n## Étapes suivantes\n\n* **Interprétez les résultats :** Comprenez les indicateurs de couverture et le détail fichier par fichier dans vos pull requests. Consultez « [Interprétation des résultats de qualité du code pour votre référentiel](/fr/enterprise-cloud@latest/code-security/how-tos/maintain-quality-code/interpret-results) »."}