API-referentie voor Hamcrest
API-referentie voor de Axe DevTools voor Web Java Hamcrest matcher-types
Referentie voor types geleverd door het hamcrest-pakket.
De klassen IsAccessible en IsAuditedForAccessibility bieden de primaire functionaliteit. Je krijgt een instantie van een van beide via de statische fabrieksmethode isAxeClean() of isAuditedForAccessibility(), en kunt vervolgens de AxeDevtoolsMatcher-methoden eraan koppelen om de controle te configureren.
De voorbeelden op deze pagina gaan ervan uit dat webDriver jouw Selenium WebDriver is, driver een AxeDriver is die het omsluit, en deze statische imports. De selector klassen komen van com.deque.html.axedevtools.matchers.selectors, en AxeReportingOptions van com.deque.html.axedevtools.selenium.reporter.
import static org.hamcrest.MatcherAssert.assertThat;
import static com.deque.html.axedevtools.matchers.IsAccessible.isAxeClean;
import static com.deque.html.axedevtools.matchers.IsAuditedForAccessibility.isAuditedForAccessibility;com.deque.html.axedevtools.matchers.AxeDevtoolsMatcher
De basisklasse van de Axe DevTools matchers. Het breidt Hamcrest's TypeSafeMatcher<AxeDriver> uit, dus het komt overeen met een AxeDriver. Je maakt er niet direct een: gebruik IsAccessible of IsAuditedForAccessibility, die elke hieronder genoemde methode erven.
Elke configuratiemethode retourneert dezelfde matcher, zodat oproepen kunnen worden gekoppeld. De scan zelf wordt uitgevoerd wanneer assertThat de matcher evalueert. Achter de schermen voert elke matcher een AxeSelenium-scan uit, dus de daar beschreven regels voor het combineren van opties zijn hier ook van toepassing.
within(String...)
Beperkt de scan tot de elementen die overeenkomen met de gegeven CSS-selectoren en hun afgeleiden. Elke selector voegt een apart gebied aan de scan toe, dus within("#header", "#footer") test beide, hetzelfde als within één keer voor elk aanroepen. Dit verschilt van AxeSelenium.include(Object...), waarbij meerdere argumenten één pad vormen.
public AxeDevtoolsMatcher within(String... cssSelectors);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
cssSelectors |
String... |
Eén of meer CSS-selectoren, elk in het bovenliggende document. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
assertThat(driver, isAxeClean().within("#header", "#footer"));within(Selector...)
Beperkt de scan tot de gebieden die door Selector-objecten worden beschreven. Gebruik het met IFrameSelector om een element binnen een iFrame te testen. Elke selector voegt een apart gebied aan de scan toe.
public AxeDevtoolsMatcher within(Selector... selectors);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
selectors |
Selector... |
Eén of meer ElementSelector- of IFrameSelector-objecten. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
// Test the form inside the #payment-frame iframe
assertThat(driver, isAxeClean().within(new IFrameSelector("#payment-frame", "form")));within(Object...)
Beperkt de scan tot gebieden die door andere selectorobjecten worden beschreven, het nuttigst FromFrames en FromShadowDom. Gebruik het om een element binnen een shadow DOM-boom te testen, wat Selector objecten niet kunnen uitdrukken. Elk argument voegt een apart gebied aan de scan toe.
public AxeDevtoolsMatcher within(Object... selectors);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
selectors |
Object... |
Eén of meer selectors, elk een CSS-selector string, een lijst met strings, een FromFrames-selector of een FromShadowDom-selector. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
// Test the #search form inside the shadow root attached to .app-header
assertThat(driver, isAxeClean().within(new FromShadowDom(".app-header", "form#search")));excluding(String...)
Verwijdert de elementen die overeenkomen met de gegeven CSS-selectoren en hun afgeleiden uit de scan. Elke selector verwijdert een apart gebied. Uitsluitingen gelden bovenop eventuele within-oproepen, wat je in staat stelt om een gebied te testen behalve een deel ervan.
public AxeDevtoolsMatcher excluding(String... cssSelectors);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
cssSelectors |
String... |
Eén of meer CSS-selectoren, elk in het bovenliggende document. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
// Test main, but skip the .cookie-banner and .ad-slot inside it
assertThat(driver, isAxeClean().within("main").excluding(".cookie-banner", ".ad-slot"));excluding(Selector...)
Verwijdert de gebieden die door Selector-objecten worden beschreven uit de scan, zoals een element binnen een iFrame. Elke selector verwijdert een apart gebied.
public AxeDevtoolsMatcher excluding(Selector... selectors);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
selectors |
Selector... |
Eén of meer ElementSelector- of IFrameSelector-objecten. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
// Skip the third-party ad inside the #ad-frame iframe
assertThat(driver, isAxeClean().excluding(new IFrameSelector("#ad-frame", ".ad")));excluding(Object...)
Verwijdert gebieden die door andere selectorobjecten worden beschreven, het nuttigst FromFrames en FromShadowDom, uit de scan. Elk argument verwijdert een apart gebied.
public AxeDevtoolsMatcher excluding(Object... selectors);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
selectors |
Object... |
Eén of meer selectors, elk een CSS-selector string, een lijst met strings, een FromFrames-selector of een FromShadowDom-selector. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
// Skip the chat widget inside the shadow root attached to support-chat
assertThat(driver, isAxeClean().excluding(new FromShadowDom("support-chat", ".widget")));accordingTo(String...)
Voert alleen de regels uit die minstens één van de gegeven tags hebben, zoals wcag2a of best-practice.
accordingTo en checkingOnly stellen dezelfde optie in, dus alleen de laatste van de twee oproepen heeft effect. Een tweede accordingTo-oproep vervangt ook de tags van de eerste, dus geef alle tags in één oproep door.
public AxeDevtoolsMatcher accordingTo(String... tags);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
tags |
String... |
Eén of meer axe-core tags. Zie Regelbeschrijvingen voor de tags bij elke regel. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
assertThat(driver, isAxeClean().accordingTo("wcag2a", "wcag2aa"));checkingOnly(String...)
Voert alleen de genoemde regels uit en geen andere.
checkingOnly en accordingTo stellen dezelfde optie in, dus alleen de laatste van de twee oproepen heeft effect. Een tweede checkingOnly-oproep vervangt ook de regels van de eerste, dus geef alle regel-ID's in één oproep door.
public AxeDevtoolsMatcher checkingOnly(String... rules);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
rules |
String... |
Eén of meer axe-core regel-ID's. Zie Regelbeschrijvingen. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
assertThat(driver, isAxeClean().checkingOnly("label", "color-contrast"));checking(String...)
Schakelt de genoemde regels in, naast de al geselecteerde regels door de ruleset of door accordingTo.
checking en skipping stellen dezelfde optie in, dus alleen de laatste van de twee oproepen heeft effect, en een tweede checking-oproep vervangt de regels van de eerste. Geef alle regel-ID's in één oproep door en combineer checking niet met skipping in dezelfde controle.
public AxeDevtoolsMatcher checking(String... rules);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
rules |
String... |
Eén of meer axe-core regel-ID's. Zie Regelbeschrijvingen. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
// WCAG 2.0 Level A rules, plus the tabindex best-practice rule
assertThat(driver, isAxeClean().accordingTo("wcag2a").checking("tabindex"));skipping(String...)
Schakelt de genoemde regels uit, terwijl de rest van de geselecteerde ruleset of tags blijven bestaan.
skipping en checking stellen dezelfde optie in, dus alleen de laatste van de twee oproepen heeft effect, en een tweede skipping-oproep vervangt de regels van de eerste. Geef alle regel-ID's in één oproep door en combineer skipping niet met checking in dezelfde controle.
public AxeDevtoolsMatcher skipping(String... rules);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
rules |
String... |
Eén of meer axe-core regel-ID's. Zie Regelbeschrijvingen. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
assertThat(driver, isAxeClean().skipping("color-contrast", "image-alt"));ignoring(String, String)
Verwijdert de overtredingen van een regel uit de resultaten wanneer die regel faalt op een gegeven element, zodat ze de bewering niet doen mislukken. De selector moet exact overeenkomen met het target van het element in de resultaten, in de vorm "[#sidebar]".
Filtering werkt op hele regels: als een element dat faalt voor de regel overeenkomt met de selector, wordt de gehele regel vermelding verwijderd, inclusief fouten op andere elementen. Eén oproep per regel is genoeg; twee oproepen voor dezelfde regel die beide overeenkomen geven een IllegalStateException. Zie AxeSelenium.ignoring(String, String) voor details.
public AxeDevtoolsMatcher ignoring(String selector, String ruleId);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
selector |
String |
Het target van het element, zoals het in de resultaten verschijnt. |
ruleId |
String |
De ID van de regel waarvan de overtreding moet worden genegeerd. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
assertThat(driver, isAxeClean().ignoring("[#sidebar]", "color-contrast"));forConfig(URL)
Selecteert de audit suite (een JSON-regelconfiguratiebestand) waarmee moet worden gecontroleerd, via URL. Net als AxeSelenium.forConfig(URL) stelt dit de globale audit suite in, dus het is ook van toepassing op latere controles.
public AxeDevtoolsMatcher forConfig(URL auditPath);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
auditPath |
URL |
De URL van het audit suite bestand. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
URL auditSuite = getClass().getResource("/config/my-audit-suite.json");
assertThat(driver, isAxeClean().forConfig(auditSuite));forConfig(String)
Selecteert de audit suite waarmee moet worden gecontroleerd, via het pad op het bestandssysteem. Net als forConfig(URL) stelt het de globale audit suite in.
public AxeDevtoolsMatcher forConfig(String auditPath) throws MalformedURLException;Parameters
| Naam | Type | Beschrijving |
|---|---|---|
auditPath |
String |
Het bestandssysteem pad van het audit suite bestand. |
Retourneert
Deze matcher, voor method chaining.
Werpt
MalformedURLException als het pad niet naar een URL kan worden omgezet.
Voorbeeld
@Test
public void matchesAuditSuite() throws MalformedURLException {
assertThat(driver, isAxeClean().forConfig("/opt/axe/my-audit-suite.json"));
}forRuleset(String)
Selecteert het regelschema waarmee moet worden gecontroleerd, zoals wcag2.2 of 508, met best-practice regels uitgeschakeld. Het doorgeven van null selecteert de standaard, wcag2.1. Net als AxeSelenium.forRuleset(String) stelt dit de globale regelschema in, dus het is ook van toepassing op latere controles. Zie AxeConfiguration.forRuleset(String) voor de regelschema-ID's.
De matchers kunnen best-practice regels niet inschakelen samen met een regelschema. Om dat te doen, roep AxeConfiguration.configure().forRuleset(rulesetId, true) aan voor de controle en roep niet ook de matcher’s forRuleset aan, die best-practice regels weer uitschakelt.
public AxeDevtoolsMatcher forRuleset(String rulesetId);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
rulesetId |
String |
De ID van het regelschema. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
assertThat(driver, isAxeClean().forRuleset("wcag2.2"));logResults(AxeReportingOptions)
Schrijft een rapport van deze controle: een .log bestand met de overtredingen en een .json bestand met de volledige resultaten. De bestandsnamen en locatie komen van reportingOptions; zie AxeReportingOptions. Met isAxeClean() wordt er geen rapport geschreven tenzij je logResults aanroept.
Als reportingOptions geen regelnummer heeft ingesteld, registreert Axe DevTools de regel van je test die logResults heeft aangeroepen.
public AxeDevtoolsMatcher logResults(AxeReportingOptions reportingOptions);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
reportingOptions |
AxeReportingOptions |
Waar het rapport moet worden geschreven en hoe de test daarin moet worden beschreven. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
AxeReportingOptions options = new AxeReportingOptions()
.testSuiteName("checkout")
.uiState("page-loaded");
assertThat(driver, isAxeClean().logResults(options));setReportingOptions(AxeReportingOptions)
Vervangt de rapporteringsopties die isAuditedForAccessibility() gebruikt wanneer je logResults niet aanroept. Het heeft geen effect op isAxeClean(), die alleen een rapport schrijft via logResults. De opties die je doorgeeft vervangen de standaardopties volledig: elke waarde die je niet instelt, valt terug naar AxeConfiguration (rapporten gaan naar axe-reports tenzij je outputDirectory instelt), en je moet uiState instellen.
public AxeDevtoolsMatcher setReportingOptions(AxeReportingOptions reportingOptions);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
reportingOptions |
AxeReportingOptions |
De rapporteringsopties die moeten worden gebruikt. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
assertThat(driver, isAuditedForAccessibility()
.setReportingOptions(new AxeReportingOptions().testSuiteName("nightly").uiState("home")));setTimeout(int)
Stelt in hoe lang, in seconden, axe-core de pagina mag analyseren voordat de controle faalt met een timeout. De standaard is 30 seconden.
public AxeDevtoolsMatcher setTimeout(int timeout);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
timeout |
int |
De timeout, in seconden. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
assertThat(driver, isAxeClean().setTimeout(120));enableAnalytics(boolean)
Schakelt de gebruiksservice in of uit voor deze controle. De gebruiksservice is standaard ingeschakeld. Wanneer de omgevingsvariabele AXE_TRACK_USAGE is ingesteld, heeft deze voorrang en heeft deze methode geen effect: true schakelt de service in en elke andere waarde schakelt deze uit.
public AxeDevtoolsMatcher enableAnalytics(boolean state);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
state |
boolean |
true om gebruiksgegevens te verzenden, false om te stoppen met verzenden. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
assertThat(driver, isAxeClean().enableAnalytics(false));trackingEnabled()
Rapporteert of deze controle gebruiksgegevens verzendt.
public boolean trackingEnabled();Retourneert
true als de gebruiksservice is ingeschakeld.
setAnalyticsUrl(String)
Stelt de URL in waarnaar gebruiksgegevens worden verzonden. De standaardinstelling is de omgevingsvariabele AXE_METRICS_URL, of https://usage.deque.com wanneer deze niet is ingesteld. Wanneer AXE_METRICS_URL is ingesteld, heeft deze methode geen effect.
public AxeDevtoolsMatcher setAnalyticsUrl(String url);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
url |
String |
De gebruiksservice-URL. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
assertThat(driver, isAxeClean().setAnalyticsUrl("https://usage.example.com"));setAnalyticsDisinctId(String)
Stelt de unieke ID in die met gebruiksgegevens wordt verzonden. De methode is gespeld als Disinct in de API, dus typ deze exact zoals weergegeven. De ID wordt opgeslagen in ~/.deque/distinct_id, zodat latere runs op dezelfde machine deze blijven gebruiken. Wanneer de ID afkomstig is van de omgevingsvariabele AXE_DISTINCT_ID, heeft deze methode geen effect.
public AxeDevtoolsMatcher setAnalyticsDisinctId(String id);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
id |
String |
De unieke ID. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
assertThat(driver, isAxeClean().setAnalyticsDisinctId("build-agent-7"));setAnalyticsComponentName(String)
Stelt de projectnaam in die met gebruiksgegevens wordt verzonden. Dit reset ook eerdere setAnalyticsUrl en enableAnalytics aanroepen op deze matcher naar hun standaardwaarden, dus roep het aan vóór die methoden. Een unieke ID ingesteld met setAnalyticsDisinctId blijft behouden.
public AxeDevtoolsMatcher setAnalyticsComponentName(String name);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
name |
String |
De projectnaam. |
Retourneert
Deze matcher, voor method chaining.
Voorbeeld
assertThat(driver, isAxeClean()
.setAnalyticsComponentName("storefront-tests")
.setAnalyticsDisinctId("build-agent-7"));com.deque.html.axedevtools.matchers.IsAccessible
Een matcher die de bewering faalt wanneer de pagina toegankelijkheidsovertredingen bevat. Het breidt AxeDevtoolsMatcher uit, zodat elke bovenstaande methode eraan gekoppeld kan worden om de reikwijdte, regels, audit suite en rapportage in te stellen.
Wanneer de bewering mislukt, vermeldt het foutbericht elke overtreding, de aangetaste elementen en hoe deze te verhelpen, in hetzelfde formaat als het .log-rapport. Als axe-core in plaats van resultaten een fout retourneert, wordt een AxeRuntimeException geworpen in plaats van de bewering te laten mislukken.
assertThat(driver, isAxeClean()
.within("#header")
.within("#footer")
.excluding(".graphics")
.accordingTo("wcag2a", "wcag2aa"));isAxeClean()
Maakt een IsAccessible matcher. Deze statische methode is de enige manier om er een te krijgen. Zonder verdere configuratie controleert het de hele pagina tegen de globale regels, die standaard op wcag2.1 staan, en schrijft het geen rapport.
public static IsAccessible isAxeClean();Retourneert
Een nieuwe IsAccessible matcher.
Voorbeeld
@Test
public void homePageIsAccessible() {
webDriver.get("https://example.com");
assertThat(driver, isAxeClean());
}com.deque.html.axedevtools.matchers.IsAuditedForAccessibility
Een matcher die de pagina scant en een rapport schrijft, maar de bewering nooit laat mislukken vanwege overtredingen. Een axe-core-fout werpt nog steeds een AxeRuntimeException, zoals bij isAxeClean(). Gebruik het om resultaten te verzamelen voor monitoring zonder de build te breken; u moet regressies uit de rapporten bijhouden, buiten test slagen en falen om. Het breidt AxeDevtoolsMatcher uit, zodat elke bovenstaande methode eraan gekoppeld kan worden.
Tenzij u logResults aanroept, wordt het rapport geschreven naar target/axe-report/accessibility-check.log en target/axe-report/accessibility-check.json. Gebruik setReportingOptions om deze standaardwaarden te wijzigen. Elke controle overschrijft het vorige rapport op hetzelfde pad, dus geef elke controle zijn eigen testsuitenaam of UI-status via setReportingOptions of logResults, of schakel useUniqueFilename in.
assertThat(driver, isAuditedForAccessibility()
.within("#header")
.within("#footer")
.excluding(".graphics")
.accordingTo("wcag2a", "wcag2aa"));isAuditedForAccessibility()
Maakt een IsAuditedForAccessibility matcher. Deze statische methode is de enige manier om er een te krijgen.
public static IsAuditedForAccessibility isAuditedForAccessibility();Retourneert
Een nieuwe IsAuditedForAccessibility matcher.
Voorbeeld
@Test
public void auditCheckoutPage() {
webDriver.get("https://example.com/checkout");
assertThat(driver, isAuditedForAccessibility()
.logResults(new AxeReportingOptions().testSuiteName("checkout").uiState("loaded")));
}com.deque.html.axedevtools.matchers.selectors.Selector
De interface geïmplementeerd door ElementSelector en IFrameSelector. Geef selectors door aan within(Selector...) of excluding(Selector...).
toList()
Geeft de selector terug als een lijst met CSS-selectors: één per iFrame-niveau, gevolgd door de selector voor het element. Beide implementaties voorzien het. De matchers roepen het voor u aan; u hoeft het niet in tests aan te roepen.
List<String> toList();Retourneert
De CSS-selectors, als een List\<String>.
com.deque.html.axedevtools.matchers.selectors.ElementSelector
Een Selector voor een element in het huidige document. Op zichzelf is het gelijk aan het doorgeven van de CSS-selector-string aan within of excluding; het belangrijkste gebruik is als het binnenste deel van een IFrameSelector.
ElementSelector(String)
Maakt een selector voor de elementen die door een CSS-selector worden gematcht.
public ElementSelector(String cssSelector);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
cssSelector |
String |
Een CSS-selector. |
Voorbeeld
// The form inside #inner-frame, which is inside #outer-frame
Selector form = new IFrameSelector("#outer-frame",
new IFrameSelector("#inner-frame", new ElementSelector("form")));com.deque.html.axedevtools.matchers.selectors.IFrameSelector
Een Selector voor een element binnen een iFrame. Nest een IFrameSelector in een andere om een element binnen geneste iFrames te bereiken.
IFrameSelector(String, String)
Maakt een selector voor een element binnen één iFrame.
public IFrameSelector(String frameSelector, String cssSelector);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
frameSelector |
String |
Een CSS-selector voor het iFrame-element op de pagina. |
cssSelector |
String |
Een CSS-selector voor het element om binnen het iFrame te testen. |
Voorbeeld
assertThat(driver, isAxeClean().within(new IFrameSelector("#payment-frame", "form")));IFrameSelector(String, Selector)
Maakt een selector voor een element binnen een iFrame, waar het element wordt beschreven door een andere Selector. Geef een andere IFrameSelector door om een iFrame dieper te gaan, of een ElementSelector.
public IFrameSelector(String frameSelector, Selector selector);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
frameSelector |
String |
Een CSS-selector voor het iFrame-element op de pagina. |
selector |
Selector |
Een IFrameSelector voor een genest iFrame, of een ElementSelector voor het te testen element. |
Voorbeeld
// The form inside #inner-frame, which is inside #outer-frame
assertThat(driver, isAxeClean().within(
new IFrameSelector("#outer-frame", new IFrameSelector("#inner-frame", "form"))));