Specifiche del flusso di lavoro

This page is not available in the language you requested. You have been redirected to the English version of the page.

Link to this page copied to clipboard

Not for use with personal data

Il comando axe DevTools CLI spec esegue una specifica del flusso di lavoro JSON o YAML/YML, che consente di automatizzare il test di una raccolta di pagine web per problemi di accessibilità.

Formato del comando

axe spec <file-specifica> <dir-output> [opzioni]

Per esempio:

axe spec deque-workflow.json ./axe-reports --format csv

File di specifiche

Un file spec è un file JSON o YAML/YML che contiene una serie di pagine web da testare e varie proprietà di configurazione (come indicato di seguito).

Proprietà utilizzate in un file di specifiche

Ecco le proprietà utilizzate con un file di spec:

Proprietà	Tipo di dati	Descrizione
`projects`	array	Raggruppa test e flussi di lavoro.
. `metadata`	oggetto	Fornisce dati personalizzabili per il tuo caso d'uso.
. `name`	corda	Nome univoco del progetto.
. `id`	corda	Identificatore univoco del progetto.
. `globalActions`	array	(facoltativo) La CLI di axe DevTools attende che determinati elementi appaiano su una pagina e li elimina. Nell'esempio seguente, è necessario gestire i messaggi sui cookie e i popup del sondaggio utente prima di testare ogni pagina.
. `pageList`	array	Elenco delle pagine
.. `name`	corda	Nome della pagina
.. `url`	corda	URL della pagina
.. `actions`	array	(facoltativo) Esegue le azioni una dopo l'altra sulla pagina che viene testata. Ad esempio, è possibile compilare un modulo, navigare in un'app di una sola pagina e testare l'applicazione in diversi stati. Nell'esempio seguente, il flusso di lavoro immette "axe" nell'interfaccia utente di ricerca Deque. L'azione globale chiude il popup dei cookie. Per un elenco completo delle azioni, vedere azioni del flusso di lavoro.

Esempio di file JSON

Ecco un esempio di file di specifiche JSON:

{
  "projects": [
    {
      "metadata": {
        "products": ["CLI"],
        "environment": ["Prod"]
      },
      "name": "deque.com",
      "id": "deque.com",
      "globalActions": [
        "dismiss modal \"#CybotCookiebotDialog\" with close button \"#CybotCookiebotDialogBodyButtonAccept\""
      ],
      "pageList": [
        {
          "name": "Deque search",
          "url": "https://www.deque.com/",
          "actions": [
            "type \"axe\" into element \"#searchform input\"",
            "click element \"#searchform button\"",
            "wait for element \".m-search-page\" to be found",
            "analyze"
          ]
        },
        {
          "name": "Axe Dashboard",
          "url": "https://axe.deque.com/"
        }
      ]
    }
  ]
}

Esempio di file YAML/YML

projects:
  - metadata:
      products:
        - CLI
      environment:
        - Prod
    name: deque.com
    id: deque.com
    globalActions:
      - >-
        dismiss modal "#CybotCookiebotDialog" with close button
        "#CybotCookiebotDialogBodyButtonAccept"
    pageList:
      - name: Deque search
        url: https://www.deque.com/
        actions:
          - type "axe" into element "#searchform input"
          - click element "#searchform button"
          - wait for element ".m-search-page" to be found
          - analyze
      - name: Axe Dashboard
        url: https://axe.deque.com/

Directory di output

La directory di output è quella in cui axe DevTools CLI salva i risultati (come file JSON).

Il seguente frammento di codice salva i risultati JSON e i report CSV nella directory ./axe-results/ :

axe spec deque-workflow.json ./axe-results --format csv

Opzioni

Sono disponibili le seguenti opzioni per axe spec:

-c, --custom <percorso>

Specifica un set di regole personalizzato da utilizzare e sostituisce il set di regole predefinito.

--collegamenti discendenti

Ottiene i link sulla pagina web e li aggiunge ai risultati. Richiede la --verbose opzione.

--enable-tracking <stato>

Consente l'invio di dati alla libreria delle metriche.

--filter [type(s)]

Fornisce un elenco di tipi di risultati da filtrare: superati, violati, incompleti, inapplicabili. (È richiesta la --format csv opzione.)

axe reporter ./axe-reports/json/ --format=csv --filter passes,inapplicable

-f, --format [valore]

Specifica il tipo o i tipi di report [html|junit|csv|html+junit+csv]. Il valore predefinito è html.

--sorgente-pagina

Aggiunge la pagina HTML scansionata ai risultati della scansione. È necessario utilizzare questa opzione con l'opzione --verbose nome_opzione.

--nome-pagina <nome>

Esegue il test di una pagina specifica chiamata name dall'array pageList nel file di specifiche JSON.

--titolo-pagina

Ottiene il titolo della pagina durante la scansione e lo aggiunge ai risultati della scansione. Devi usare l'opzione --verbose .

--remote-proxy <server proxy>

Utilizza un server proxy remoto.

--resume-from <nome>

Esegue i test solo dopo una specifica pagina denominata name.

--url scansionato

Aggiunge metadati aggiuntivi ai risultati dettagliati: l'URL di base in cui è stata avviata la scansione e l'URL della scansione corrente. Funziona solo con il browser Chrome e richiede l'opzione --verbose .

--set-distinct-id <distinct-id>

Modifica il valore dell'ID distinto.

--set-tracking-url <url>

Modifica l'URL a cui vengono inviati i dati delle metriche.

-t, --tags

Filtra il set di regole standard per tag.

--user-agent

Utilizza l'agente utente del browser specificato.

--validate

Verifica il file spec senza eseguirlo.

-v, --verbose

Aumenta l'output per includere informazioni aggiuntive, tra cui risultati di axe e metadati come nome dello strumento di test, versione e ambiente.

Per altre opzioni, vedere flag di configurazione