Riferimento API per Cucumber
Riferimento API per la classe AxeWorld in Axe DevTools per Java Web
Questo documento è un riferimento per la classe AxeWorld nel pacchetto com.deque.html.axedevtools.cucumber. A differenza dei pacchetti Selenium e Hamcrest, il pacchetto Cucumber non ha una classe builder o matcher per l'ambito e la configurazione delle regole. Queste opzioni sono invece espresse direttamente nel testo dei passi Gherkin, come descritto in Scrivere test Cucumber. La classe AxeWorld contiene solo lo stato e la configurazione che i passi Gherkin non possono esprimere, come la pagina da controllare, le impostazioni analitiche, le opzioni di reporting personalizzato e il timeout di axe-core.
com.deque.html.axedevtools.cucumber.AxeWorld
Contiene la pagina e la configurazione utilizzate da Passi di accessibilità Cucumber durante la verifica dell'accessibilità. Il tuo framework di iniezione delle dipendenze crea AxeWorld (PicoContainer, ad esempio, ne crea uno per scenario) e lo passa sia alle tue definizioni di passi che ai passi di Axe DevTools, quindi qualsiasi cosa imposti su di esso in un hook @Before o in un passo precedente si applica ai passi di accessibilità nello stesso scenario.
Le impostazioni vengono lette ogni volta che viene eseguito un passo di accessibilità. Non viene verificato o inviato nulla quando chiami i metodi setter.
public StepDefinitions(AxeWorld axeWorld) {
this.axeWorld = axeWorld;
}
@Before
public void setup() {
webDriver = new ChromeDriver();
axeWorld.setPage(new AxeDriver(webDriver));
}AxeWorld()
Crea un AxeWorld senza pagina e senza configurazione. Normalmente non lo chiami tu stesso: dichiara un parametro AxeWorld nel costruttore della classe di definizione del passo, e il tuo framework di iniezione delle dipendenze crea e condivide l'istanza.
public AxeWorld();getPage()
Restituisce la pagina che i passi di accessibilità verificano, oppure null se setPage non è stato chiamato.
public AxeDriver getPage();Restituisce
La AxeDriver impostata su questo contesto.
setPage(AxeDriver)
Imposta la pagina che i passi di accessibilità verificano. Chiama questo metodo prima che qualsiasi passo di accessibilità venga eseguito, di solito in un hook @Before. I passi verificano qualsiasi pagina che il WebDriver incapsulato stia mostrando quando il passo viene eseguito, quindi naviga con il tuo WebDriver nei passi precedenti come di consueto.
public void setPage(AxeDriver page);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
page |
AxeDriver |
La pagina da controllare, che incapsula il tuo Selenium WebDriver. |
Esempio
@Before
public void setup() {
webDriver = new ChromeDriver();
axeWorld.setPage(new AxeDriver(webDriver));
}enableAnalytics(boolean)
Attiva o disattiva servizio di utilizzo per i passi di accessibilità. Quando non lo chiami, il servizio di utilizzo è attivo. Quando la variabile di ambiente AXE_TRACK_USAGE è impostata, ha la precedenza e questo metodo non ha effetto: true attiva il servizio e qualsiasi altro valore lo disattiva.
public void enableAnalytics(boolean state);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
state |
boolean |
true per inviare dati di utilizzo, false per interrompere l'invio. |
Esempio
@Before
public void setup() {
axeWorld.enableAnalytics(false);
}setAnalyticsUrl(String)
Imposta l'URL a cui vengono inviati i dati di utilizzo. Il valore predefinito è la variabile di ambiente AXE_METRICS_URL, o https://usage.deque.com quando questa non è impostata. Quando AXE_METRICS_URL è impostata, questo metodo non ha effetto.
public void setAnalyticsUrl(String url);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
url |
String |
L'URL del servizio di utilizzo. |
Esempio
axeWorld.setAnalyticsUrl("https://usage.example.com");setAnalyticsDistinctId(String)
Imposta l'ID distinto inviato con i dati di utilizzo, il che permette al servizio di utilizzo di raggruppare gli eventi dall'utente o dalla macchina. L'ID viene salvato su ~/.deque/distinct_id, quindi le esecuzioni successive sulla stessa macchina continueranno ad utilizzarlo. Quando l'ID proviene dalla variabile di ambiente AXE_DISTINCT_ID, questo metodo non ha effetto.
public void setAnalyticsDistinctId(String did);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
did |
String |
L'ID distinto. |
Esempio
axeWorld.setAnalyticsDistinctId(System.getenv("CI_RUNNER_ID"));setAnalyticsComponentName(String)
Imposta il nome del progetto inviato con i dati di utilizzo.
I passi di accessibilità applicano il nome del componente dopo le altre impostazioni analitiche e impostarlo reimposta l'URL e il valore enableAnalytics ai loro valori predefiniti. Pertanto, quando imposti un nome di componente, qualsiasi valore setAnalyticsUrl o enableAnalytics sullo stesso AxeWorld non ha effetto. Un valore setAnalyticsDistinctId viene mantenuto, perché l'ID distinto è salvato su file.
public void setAnalyticsComponentName(String name);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
name |
String |
Il nome del progetto. |
Esempio
axeWorld.setAnalyticsComponentName("storefront-features");setReportingOptions(AxeReportingOptions)
Imposta dove il passo Then the page should be audited for accessibility scrive il suo rapporto e come descrive il test. Senza di essa, quel passo scrive su target/axe-report/accessibility-check.log e .json. Vedi AxeReportingOptions per le opzioni. Le opzioni che passi sostituiscono completamente i valori predefiniti: qualsiasi valore che non imposti torna a AxeConfiguration (i rapporti vanno a axe-reports a meno che non lo imposti su outputDirectory) e devi impostare uiState.
Non ha effetto sul passo Then the page should be axe clean, che non scrive un rapporto.
public void setReportingOptions(AxeReportingOptions reportingOptions);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
reportingOptions |
AxeReportingOptions |
Le opzioni di reporting da utilizzare. |
Esempio
@Before
public void setup(Scenario scenario) {
axeWorld.setReportingOptions(new AxeReportingOptions()
.outputDirectory("target/axe-report")
.testSuiteName("checkout")
.uiState(scenario.getName().replaceAll("\\W+", "-")));
}setTimeout(int)
Imposta quanto tempo, in secondi, axe-core può analizzare la pagina prima che il passo fallisca con un timeout. Il valore predefinito è 30 secondi. Aumentalo per pagine molto grandi.
public void setTimeout(int timeout);Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
timeout |
int |
Il timeout, in secondi. |
Esempio
axeWorld.setTimeout(120);