Premiers pas avec le service d'utilisation et le CLI

Cet article montre comment utiliser le service d'utilisation avec le CLI. Vous serez guidé à travers la configuration d'un serveur local pour diffuser les événements du service d'utilisation, montré comment envoyer des métriques d'utilisation au serveur avec le CLI, et comment modifier les événements du service d'utilisation en utilisant des variables d'environnement.

Le service d'utilisation vous permet de suivre les métriques d'utilisation pour l'utilisation du CLI par votre organisation. Activer le service d'utilisation peut être un outil important pour votre organisation afin de réaliser des audits de conformité de licences, tester les audits, et s'assurer que toutes les instances de axe DevTools for Web sont configurées selon les standards de votre organisation.

Pour un aperçu du service d'utilisation, voir Le service d'utilisation axe DevTools.

Prérequis

Vous devez installer Node.js pour utiliser cet exemple. Consultez Node.js pour l'installateur Node.js.

Configuration d'un serveur Echo

Créez un fichier contenant le code ci-dessous :

const express = require('express')
const bodyParser = require('body-parser')

const app = express()

// Parse JSON bodies.
app.use(bodyParser.json())
// Accept events.
app.post('/:version/event', (req, res) => {
  const event = req.body
  console.log(event)

  // Respond so the client is happy.
  res.status(200)
  res.send('Event accepted!')
})

// Listen for requests.
app.listen(3000)

Nous appellerons le fichier echo-server.js. Enregistrez-le dans un nouveau répertoire et changez de répertoire.

Le serveur écoute les requêtes sur le port 3000 et écrit le corps de la requête reçue sur la console. Ainsi, chaque fois qu'un client API ou un test CLI est exécuté (et que la journalisation d'utilisation est activée), le serveur echo écrit l'événement d'utilisation reçu.

Installez express et body-parser, deux dépendances nécessaires pour exécuter le code ci-dessus :

npm i express body-parser

Démarrez le serveur echo :

node echo-server.js

Tester un site avec le CLI

Vous devez maintenant définir deux variables d'environnement : d'abord, pour activer le service d'utilisation et, ensuite, pour fournir l'URL du serveur (le serveur local créé dans la section précédente) :

1. export AXE_TRACK_USAGE=true
2. export AXE_METRICS_URL=http://localhost:3000

Sur Linux ou macOS, vous pouvez définir les variables d'environnement et lancer une analyse CLI d'un site web sur une seule ligne comme indiqué ici :

AXE_TRACK_USAGE=true AXE_METRICS_URL=http://localhost:3000 axe https://broken-workshop.dequelabs.com/

set AXE_TRACK_USAGE=true
set AXE_METRICS_URL=http://localhost:3000

setx AXE_TRACK_USAGE true
setx AXE_METRICS_URL http://localhost:3000

Cette commande lance une analyse avec le CLI sur le site https://broken-workshop.dequelabs.com.

Revenez à la fenêtre de console où vous exécutez le serveur d'écho, et vous verrez les événements reçus par le serveur d'écho, un exemple d'événement est montré ci-dessous :

{
  dateTime: '2023-01-20T20:48:16.864Z',
  productComponent: 'api-cli',
  productName: 'axe-devtools-html',
  version: 'v2',
  event: 'uri: analyze',
  distinctId: 'f542d302-18a0-42a6-ab7f-ec1e42399bfe',
  applicationProperties: {
    target: 'https://broken-workshop.dequelabs.com/',
    target_medium: 'text/html',
    engineVersion: '4.5.2',
    failedRuleCount: 2,
    failedRuleNames: 'color-contrast,image-alt',
    failedItemCount: 12,
    inapplicableRuleCount: 33,
    incompleteRuleCount: 0,
    passedRuleCount: 27,
    testResults: {}
  }
}

Pour plus d'informations sur l'objet d'événement, voir L'objet d'événement.

Modifier l'événement à l'aide de variables d'environnement

Vous pouvez utiliser des variables d'environnement pour changer les propriétés de l'événement signalé. Par exemple, vous pouvez modifier ou ajouter la propriété rôleJobUtilisateur en définissant la variable d'environnement AXE_USER_JOB_ROLE :

AXE_TRACK_USAGE=true AXE_METRICS_URL=http://localhost:3000 AXE_USER_JOB_ROLE="testing" axe https://broken-workshop.dequelabs.com/

Un exemple des événements reçus par le serveur d'écho est montré ci-dessous :

{
  dateTime: '2023-01-20T20:52:23.878Z',
  productComponent: 'api-cli',
  productName: 'axe-devtools-html',
  version: 'v2',
  event: 'uri: analyze',
  distinctId: '9c55a1f8-5177-44ee-a0e3-5dafa5ef9fc9',
  applicationProperties: {
    target: 'https://broken-workshop.dequelabs.com/',
    target_medium: 'text/html',
    engineVersion: '4.5.2',
    failedRuleCount: 2,
    failedRuleNames: 'color-contrast,image-alt',
    failedItemCount: 12,
    inapplicableRuleCount: 33,
    incompleteRuleCount: 0,
    passedRuleCount: 27,
    testResults: {}
  },
  userJobRole: 'testing'}

La propriété rôleJobUtilisateur a été ajoutée en définissant la variable d'environnement AXE_USER_JOB_ROLE comme illustré par la ligne surlignée.

Pour définir d'autres propriétés dans l'événement, voir Contrôler le service d'utilisation via les variables d'environnement.

Prochaines étapes

Pour suivre une version de ce tutoriel pour les API axe DevTools, voir Premiers pas avec le service d'utilisation et les API.

Pour un aperçu du service d'utilisation, voir Le service d'utilisation. Pour des informations de référence sur l'objet d'événement, voir Référence des événements du service d'utilisation.