Intégration CI/CD pour l'accessibilité RGAA

Installation

Installez le CLI RGAA Checker via npm pour l'utiliser dans vos pipelines CI/CD ou en local.

npm install -g @rgaa-checker/cli

npx @rgaa-checker/cli scan https://example.com

# Ajouter comme dépendance de développement
npm install --save-dev @rgaa-checker/cli

# Puis utiliser via npm scripts dans package.json
{
  "scripts": {
    "test:a11y": "rgaa-checker scan https://localhost:3000 --threshold 80"
  }
}

Fichier de configuration .rgaachecker.json

Créez un fichier .rgaachecker.json à la racine de votre projet pour configurer les options par défaut du CLI.

{
  "url": "https://staging.example.com",
  "threshold": 80,
  "timeout": 60000,
  "auth": {
    "type": "basic",
    "username": "$BASIC_USER",
    "password": "$BASIC_PASS"
  }
}

Authentification Basic Auth

Scannez vos environnements de staging proteges par authentification HTTP Basic. Utilisez des variables d'environnement pour ne pas exposer vos identifiants.

rgaa-checker scan https://staging.example.com \
  --basic-user admin \
  --basic-pass secret123

{
  "url": "https://staging.example.com",
  "auth": {
    "type": "basic",
    "username": "admin",
    "password": "secret123"
  }
}

"auth": {
  "type": "basic",
  "username": "$STAGING_USER",
  "password": "$STAGING_PASS"
}

Rapports JUnit XML

Exportez les resultats au format JUnit XML pour les integrer a vos outils de CI (Jenkins, GitLab, Azure DevOps, etc.). Chaque critere RGAA echoue devient un test case.

# CLI - Exporter au format JUnit
rgaa-checker scan https://example.com --format junit > report.xml

# Ou avec un fichier de sortie
rgaa-checker scan https://example.com --format junit --output accessibility.xml

<?xml version="1.0" encoding="UTF-8"?>
<testsuites name="RGAA Checker" tests="106" failures="8" time="12.500">
  <testsuite name="RGAA Audit - https://example.com" tests="106" failures="8">
    <testcase name="Overall Score" classname="RGAA">
      <failure message="Score 75% is below threshold 80%">
        The accessibility score does not meet the required threshold.
      </failure>
    </testcase>
    <testcase name="[1.1] Images" classname="RGAA.1.1">
      <failure message="3 issues found">
        &lt;img src="logo.png"&gt;
        &lt;img src="banner.jpg"&gt;
      </failure>
    </testcase>
  </testsuite>
</testsuites>

Rate Limiting et Quotas

L'API CI est soumise a des limites pour garantir la disponibilite du service pour tous les utilisateurs.

Déclencher un crawl multi-pages

Pour auditer plusieurs pages en une seule requête (site complet, parcours utilisateur), utilisez POST /api/ci/crawl plutôt que d'enchaîner des appels à /api/ci/scan. Le crawl est déclenché de façon asynchrone : la requête répond immédiatement (202), et le résultat est disponible par sondage ou par webhook.

Requête

curl -X POST https://rgaa-checker.com/api/ci/crawl \
  -H "Authorization: Bearer rgaa_ci_votre_cle" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": ["https://site.fr", "https://site.fr/contact"],
    "webhook_url": "https://hooks.example.com/rgaa"
  }'

Réponse (202 Accepted)

{
  "success": true,
  "crawl_id": "8f1e2c3a-4b5d-4e6f-9a1b-2c3d4e5f6a7b",
  "pages": 2,
  "status": "running",
  "status_url": "/api/crawl/8f1e2c3a-4b5d-4e6f-9a1b-2c3d4e5f6a7b",
  "page_scan_ids": ["…", "…"],
  "job_ids": ["…", "…"],
  "webhook": {
    "url": "https://hooks.example.com/rgaa",
    "secret": "whsec_xxxxxxxxxxxxxxxxxxxxxxxx",
    "signature_header": "X-RGAA-Signature",
    "algorithm": "HMAC-SHA256 hex, format sha256=<hex>",
    "note": "Store this secret now: it is only returned once."
  }
}

Quota : N pages = N scans

Chaque URL du tableau urls consomme une unité de votre quota mensuel de scans (le même quota que vos scans web et vos appels /api/ci/scan). Le quota est vérifié et décompté avantle lancement du crawl (fail-closed) : si le quota restant est insuffisant, la requête est rejetée et aucune page n'est scannée.

Suivi de l'avancement

Interrogez l'URL retournée dans status_url (équivalente à GET /api/crawl/:id, détaillée dans le guide API REST) pour suivre la progression :

{
  "status": "running",
  "pagesProgress": {
    "completed": 1,
    "failed": 0,
    "pending": 1
  }
}

status passe de running à completed dès que toutes les pages sont sorties de l'état pending. Le sondage reste la source de vérité, que le webhook soit livré ou non.

Webhook de complétion

Si webhook_url est fourni, RGAA Checker envoie un POST à cette URL une fois le crawl terminé (évènement crawl.completed), signé avec le secret reçu à la création. Vérifiez systématiquement la signature avant de traiter le corps de la requête :

const crypto = require('node:crypto');

const expected = 'sha256=' + crypto.createHmac('sha256', secret)
  .update(rawBody).digest('hex');
const valid = crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(receivedSignature));
// receivedSignature = en-tête X-RGAA-Signature ; rawBody = corps brut, non parsé

• • En-tête X-RGAA-Signature, format sha256=<hex>
• • 3 tentatives de livraison (immédiate, puis +5 s, puis +25 s) ; au-delà, seul le sondage de status_url fait foi
• • Le secret est purgé côté serveur juste après la dernière tentative de livraison, qu'elle ait réussi ou non

Limites du crawl