Axe DevTools per Cucumber Web
Installazione e utilizzo della gemma axe-devtools-cucumber per il test di accessibilità basato su Cucumber
La gemma axe-devtools-cucumber fornisce definizioni di passi personalizzati per valutare se una determinata pagina è conforme ad axe.
Questa gemma si espande sui passi forniti dal readme della gemma axe-core-cucumber.
Installazione e Uso
Assicurati di avere accesso a Deque's registry. Se non ne hai, refer to setup.
- Aggiungi
axe-devtools-cucumberal tuo file Gemfile o gemspec ed eseguibundle install.
gem "axe-devtools-cucumber"spec.add_dependency "axe-devtools-cucumber"- Richiedi le definizioni di passi offerte dalla gemma. In genere, puoi farlo aggiungendo un file di setup cucumber esistente sotto
features/support/env.rb.
require 'axe-cucumber-steps'- Usa con il WebDriver di tua scelta.
API
Step - Sii Conformemente ad axe (be axe clean)
Il passo be axe clean è il componente principale dell'integrazione. È un passo completo di per sé e verificherà che la pagina attualmente caricata sia conformemente ad axe utilizzando la configurazione predefinita di axe.run (l'intero documento è verificato utilizzando le regole predefinite).
Then the page should be axe cleanStep - Essere Auditati per l'Accessibilità (be audited for accessibility)
Questo passo ti permette di auditare l'accessibilità del tuo sito senza fallire la suite di test. Per violations identificati i matcher convertiranno l'esempio di test a pending e riporteranno le violazioni dettagliate.
Then the page should be audited for accessibility [including]
[excluding] [according to/according to ruleset] [checking rules/checking-only-rules]
[skipping rules] [logging results for]Clausole
Le clausole sono metodi concatenabili per le definizioni dei passi be axe clean e be audited for accessibility.
Le clausole configurabili consentono una maggiore granularità nei test e nelle aspettative.
within- Clausola di Inclusione
La clausola di inclusione (within "#selector") specifica quali elementi della pagina devono essere verificati. Deve essere fornito un valido CSS selector e racchiuso tra virgolette doppie. È possibile utilizzare selettori composti per selezionare più elementi, ad esempio, within "#header, .footer". Per ulteriori informazioni, vedi il context parameter documentation.
Then the page should be axe clean within "#selector"excluding- Clausola di Esclusione
La clausola di esclusione (excluding "#selector") specifica quali elementi del documento devono essere ignorati. Deve essere fornito un valido CSS selector e racchiuso tra virgolette doppie. È possibile utilizzare selettori composti per selezionare più elementi, ad esempio, excluding "#widget, .ad". Per ulteriori informazioni, vedi il context parameter documentation.
Then the page should be audited for accessibility excluding "#selector"Se desiderato, un punto e virgola (;) o la parola but possono essere usati per separare la clausola di esclusione dalla clausola di inclusione (se presente).
Then the page should be audited for accessibility within "main"; excluding "aside"
Then the page should be axe clean within "main" but excluding "aside"according to- Clausola Standard di Accessibilità (Tag)
La clausola del tag specifica quale standard (o standard) di accessibilità dovrebbe essere utilizzato per verificare la pagina. Gli standard di accessibilità sono specificati per nome (tag). Possono essere specificati più standard quando separati da virgole, ad esempio, according to: wcag2a, section508. Gli tag names are documented accettabili così come un complete listing of rules che corrisponda a ciascun tag.
Then the page should be audited for accessibility according to: tag-nameSe desiderato, un punto e virgola (;) può essere usato per separare la clausola del tag dalla clausola precedente.
Then the page should be axe clean within "#header"; according to: best-practicechecking- Clausola delle Regole di Verifica
La clausola delle regole di verifica specifica quali aggiuntive regole eseguire (in aggiunta ai tag specificati, se presenti, o al set di regole predefinito). Le regole sono specificate tramite ID di regola separati da virgole.
Then the page should be axe clean checking: ruleIdPer un elenco di ID di regola validi, vedi il rules documentation.
Se desiderato, un punto e virgola (;) o la parola and possono essere usati per separare la clausola delle regole di verifica dalla clausola precedente.
Then the page should be axe clean according to: wcag2a; checking: color-contrast
Then the page should be audited for accessibility according to: wcag2a and checking: color-contrastchecking only- Clausola delle Regole Esclusive
Questa clausola non è realmente una clausola separata. Ma piuttosto, aggiungendo la parola only alla clausola delle regole di verifica, il significato del passo può essere cambiato. Come descritto sopra, di default la clausola delle regole di verifica specifica aggiuntive regole da eseguire. Se viene usata la parola only, allora solo le regole specificate sono verificate.
Then the page should be axe clean checking only: ruleIdskipping- Clausola delle Regole da Saltare
La clausola delle regole da saltare specifica quali regole saltare. Questo permette di fornire uno standard di accessibilità (tramite la clausola del tag) ignorando una regola particolare. Le regole sono specificate tramite ID di regola separati da virgole.
Then the page should be audited for accessibility skipping: ruleIdPer un elenco di ID di regola validi, vedi il rules documentation.
Puoi usare un punto e virgola (;) o la parola but per separare la clausola delle regole da saltare dalla clausola precedente, come mostrato di seguito:
Then the page should be axe clean according to: wcag2a; skipping: accesskeys
Then the page should be audited for accessibility according to: wcag2a but skipping: accesskeysClausole disponibili solo per lo step - Essere Auditati per l'accessibilità
Il matcher be audited for accessibility supporta due clausole aggiuntive.
according to ruleset- Clausola del Set di Regole
La clausola del set di regole [according to ruleset] aiuta a specificare un singolo set di regole (ad esempio, 508, wcag2, wcag21) da utilizzare per verificare la pagina.
Then the page should be axe clean according to ruleset: wcag2logging results- Clausola di Registrazione dei Risultati
Per registrare i risultati dal matcher di base e delle clausole, invoca il metodo concatenabile logging results come mostrato di seguito. La clausola logging results for: report_name permette di specificare il nome del report generato al termine dell'esecuzione dello step.
Then the page should be audited for accessibility logging results for: axe_report_of_my_siteInteroperabilità tra clausole
Tutte le clausole descritte possono essere combinate e abbinate tramite il chaining dei metodi. Di seguito alcuni esempi.
Then the page should be audited for accessibility within "main, header" but excluding "footer"
Then the page should be axe clean excluding "#sidebar" according to: wcag2a, wcag2aa but skipping: color-contrast
Then the page should be audited for accessibility checking only: document-title, label
Then the page should be axe clean according to: best-practice and checking: aria-roles, definition-listUso avanzato dell'API
Consultare advanced usage per vedere come configurare l'API per:
- Regole personalizzate
- Percorso personalizzato alla fonte di axe
- Registrazione dell'uso
- Rapporti
