API-referentie voor Selenium
API-referentie voor AxeSelenium, AxeConfiguration en de gerelateerde selector-, rapportage- en resultatenklassen in Axe DevTools voor Web Java
Dit document is een referentie voor de AxeSelenium- en AxeConfiguration-klassen, en voor de selector-, rapportage- en resultaatstypen die ze gebruiken. De AxeSelenium-klasse zou de meeste gebruiksscenario's moeten dekken, en AxeConfiguration zou de rest moeten behandelen.
De voorbeelden op deze pagina gaan ervan uit dat webDriver uw Selenium WebDriver is en dat driver een AxeDriver is die deze omhult.
com.deque.html.axedevtools.selenium.AxeSelenium
Configureert een toegankelijkheidsscan en voert deze uit. Elke configuratiemethode retourneert dezelfde AxeSelenium-instantie, zodat oproepen kunnen worden gekoppeld, en run(AxeDriver) voert de scan uit.
Results results = new AxeSelenium()
.include(".my-css-class")
.skipping("aria-required-parent")
.run(driver);AxeSelenium()
Maakt een AxeSelenium-scan die de globale AxeConfiguration-instellingen gebruikt, zoals de regels, de auditsuite en de uitvoermap voor rapporten. Gebruik deze constructor tenzij u de onderliggende AxeBuilder moet aanpassen.
public AxeSelenium();Voorbeeld
Results results = new AxeSelenium().run(driver);AxeSelenium(AxeBuilder)
Maakt een AxeSelenium-scan die u door de door u opgegeven AxeBuilder laat lopen, afkomstig van de axe-core Selenium-integratie (com.deque.html.axecore.selenium.AxeBuilder). Gebruik het om AxeBuilder-opties te bereiken die AxeSelenium niet biedt, zoals de legacy-modus. De globale AxeConfiguration-instellingen blijven van toepassing.
public AxeSelenium(AxeBuilder axeBuilder);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
axeBuilder |
AxeBuilder |
De bouwer die wordt gebruikt om axe-core in de pagina te injecteren en uit te voeren. |
Voorbeeld
import com.deque.html.axecore.selenium.AxeBuilder;
Results results = new AxeSelenium(new AxeBuilder().setLegacyMode())
.run(driver);run(AxeDriver)
Scant de pagina die page momenteel toont, met gebruik van elke geconfigureerde optie op deze AxeSelenium, en retourneert de resultaten. Genegeerde overtredingen (zie AxeSelenium.ignoring(String, String)) worden verwijderd uit de resultaten en, als logResults is aangeroepen, worden de rapportbestanden geschreven voordat run retourneert.
Als axe-core tijdens het scannen een fout rapporteert, gooit run deze in plaats van resultaten terug te geven.
public Results run(AxeDriver page);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
page |
AxeDriver |
De te scannen pagina. |
Retourneert
Een Results-object (com.deque.html.axecore.results.Results) dat de overtredingen, goedkeuringen, onvolledige en niet-toepasbare resultaten bevat.
Gooi
AxeRuntimeException(com.deque.html.axecore.results.AxeRuntimeException) wanneer axe-core een fout retourneert in plaats van resultaten.RuntimeExceptionwanneer de scan zelf mislukt, bijvoorbeeld wanneeraxe.finishRunfaalt of de driver niet tussen vensters kan schakelen.
Voorbeeld
webDriver.get("https://example.com");
Results results = new AxeSelenium().run(driver);
if (!results.violationFree()) {
System.out.println(results.getViolations().size() + " rules have violations");
}runCommand()
Retourneert het generieke axe.run-script dat AxeSelenium in de browser uitvoert in de legacy-modus. Het script bevat niet de context of opties van deze scan, en met axe-core 4.3 of later (de standaard, niet-legacy-modus) worden scans uitgevoerd via een andere reeks oproepen. AxeSelenium geeft dit script door aan de beheerder, dus het is vooral nuttig wanneer u uw eigen rapporttekst maakt met AxeDevtoolsReporter.generateReport.
public String runCommand();Retourneert
Het script, als een String.
include(String)
Beperkt de scan tot de elementen die door één CSS-selector en hun afstammelingen worden ingevuld. Elke oproep voegt een ander gebied toe aan de scan, dus om verschillende niet-gerelateerde delen van de pagina te testen, gebruikt u include eenmaal voor elk daarvan. Een enkele komma-gescheiden selector (".sidebar, .some-class") werkt ook, omdat deze rechtstreeks naar de browser wordt verzonden.
public AxeSelenium include(String cssSelector);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
cssSelector |
String |
Elke geldige CSS-selector. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// Test .sidebar and .some-class, which are both in the top-level document
Results results = new AxeSelenium()
.include(".sidebar")
.include(".some-class")
.run(driver);include(List\<String>)
Beperkt de scan tot een element binnen een of meer genestelde iFrames. Elke string, behalve de laatste, komt overeen met één niveau van iFrame-nesting; de laatste komt overeen met het te testen element binnen het binnenste iFrame. De lijst beschrijft één pad, niet meerdere selectors.
Omdat er geen include(String...) overload is, leidt het doorgeven van meer dan één string aan include ook tot een enkele iFrame-selector in plaats van afzonderlijke toevoegingen: include("#parent-iframe", "#html") komt neer op include(Object...) en betekent hetzelfde als het onderstaande voorbeeld.
include(FromFrames) drukt hetzelfde uit op een explicietere manier en is de aanbevolen vorm voor nieuwe tests.
public AxeSelenium include(List<String> selector);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
selector |
List\<String> |
Eén CSS-selector per niveau van iFrame-nesting, gevolgd door een CSS-selector voor het element binnen het binnenste iFrame. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// Test #html inside the iframe matched by #parent-iframe
Results results = new AxeSelenium()
.include(Arrays.asList("#parent-iframe", "#html"))
.run(driver);include(FromFrames)
Beperkt de scan tot een element binnen een of meer genestelde iFrames, met een expliciete FromFrames-selector.
public AxeSelenium include(FromFrames fromFrames);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
fromFrames |
FromFrames |
Elke selector, behalve de laatste, komt overeen met één niveau van iFrame-nesting; de laatste komt overeen met het te testen element binnen het binnenste iFrame. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// Test the form inside the #payment-frame iframe
Results results = new AxeSelenium()
.include(new FromFrames("#payment-frame", "form"))
.run(driver);include(FromShadowDom)
Beperkt de scan tot een element binnen een of meer genestelde schaduw-DOM-bomen, met een expliciete FromShadowDom-selector.
public AxeSelenium include(FromShadowDom fromShadowDom);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
fromShadowDom |
FromShadowDom |
Elke selector, behalve de laatste, komt overeen met een schaduwhost; de laatste komt overeen met het te testen element binnen de binnenste schaduwwortel. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// Test the #search form inside the shadow root attached to .app-header
Results results = new AxeSelenium()
.include(new FromShadowDom(".app-header", "form#search"))
.run(driver);include(Object)
Beperkt de scan met een selector die als één enkel object wordt geleverd. Java selecteert deze overlading alleen als het statische type van het argument geen van de bovenstaande typen is, zoals een variabele die is gedeclareerd als Object. Geef de voorkeur aan de getypte overladingen.
public AxeSelenium include(Object selector);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
selector |
Object |
Een CSS-selectorstring, een lijst met strings, een FromFrames-selector of een FromShadowDom-selector. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// The selector's type is chosen at runtime, so it's held as Object
Object scope = useFrame ? new FromFrames("#frame", "main") : "main";
Results results = new AxeSelenium()
.include(scope)
.run(driver);include(Object...)
Beperkt de scan met een selector die gewone CSS-selectors mixt met FromFrames- of FromShadowDom-selectors, voor gevallen die de andere overladingen niet kunnen uitdrukken. Alle argumenten samen vormen één pad naar één element; ze zijn geen afzonderlijke inclusies.
Deze overload wordt geselecteerd wanneer de oproep meer dan één argument doorgeeft. Door een enkele FromFrames of FromShadowDom door te geven, selecteert include(FromFrames) of include(FromShadowDom) in plaats daarvan.
Om een iFrame te bereiken dat zich binnen een schaduwwortel bevindt, nest de FromShadowDom-selector binnen de FromFrames-selector. Het omgekeerde kan niet worden uitgedrukt, omdat FromShadowDom alleen strings accepteert.
public AxeSelenium include(Object... selector);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
selector |
Object... |
Een gemengde set van CSS-selectors en selectorobjecten die een enkel pad vormen naar het te testen element. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// Test .target inside the shadow root attached to #host, inside the #frame iframe
Results results = new AxeSelenium()
.include("#frame", new FromShadowDom("#host", ".target"))
.run(driver);exclude(String)
Verwijdert de elementen die overeenkomen met één CSS-selector en hun afstammelingen uit de scan. Elke oproep verwijdert een ander gebied, dus om verschillende niet-gerelateerde delen van de pagina over te slaan, gebruikt u exclude eenmaal voor elk daarvan. Uitsluitingen gelden bovenop eventuele include-oproepen, wat u in staat stelt een regio te testen behalve een deel ervan.
public AxeSelenium exclude(String cssSelector);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
cssSelector |
String |
Elke geldige CSS-selector. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// Test main, but skip the .cookie-banner and .ad-slot inside it
Results results = new AxeSelenium()
.include("main")
.exclude(".cookie-banner")
.exclude(".ad-slot")
.run(driver);exclude(List\<String>)
Verwijdert een element binnen een of meer genestelde iFrames uit de scan. Elke string, behalve de laatste, komt overeen met één niveau van iFrame-nesting; de laatste komt overeen met het over te slaan element binnen het binnenste iFrame. De lijst beschrijft één pad, niet meerdere selectors.
Omdat er geen exclude(String...) overload is, leidt het doorgeven van meer dan één string aan exclude ook tot een enkele iFrame-selector in plaats van afzonderlijke uitsluitingen: exclude(".iframe1", ".third-party-ad") komt neer op exclude(Object...) en betekent hetzelfde als het onderstaande voorbeeld.
exclude(FromFrames) drukt hetzelfde uit op een explicietere manier en is de aanbevolen vorm voor nieuwe tests.
public AxeSelenium exclude(List<String> selector);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
selector |
List\<String> |
Eén CSS-selector per niveau van iFrame-nesting, gevolgd door een CSS-selector voor het element binnen het binnenste iFrame. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// Skip .third-party-ad inside the iframe matched by .iframe1
Results results = new AxeSelenium()
.exclude(Arrays.asList(".iframe1", ".third-party-ad"))
.run(driver);exclude(FromFrames)
Verwijdert een element binnen een of meer genestelde iFrames uit de scan, met een expliciete FromFrames-selector.
public AxeSelenium exclude(FromFrames fromFrames);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
fromFrames |
FromFrames |
Elke selector, behalve de laatste, komt overeen met één niveau van iFrame-nesting; de laatste komt overeen met het over te slaan element binnen het binnenste iFrame. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// Skip the form inside the #payment-frame iframe
Results results = new AxeSelenium()
.exclude(new FromFrames("#payment-frame", "form"))
.run(driver);exclude(FromShadowDom)
Verwijdert een element binnen een of meer genestelde schaduw-DOM-bomen uit de scan, met een expliciete FromShadowDom-selector.
public AxeSelenium exclude(FromShadowDom fromShadowDom);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
fromShadowDom |
FromShadowDom |
Elke selector, behalve de laatste, komt overeen met een schaduwhost; de laatste komt overeen met het over te slaan element binnen de binnenste schaduwwortel. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// Skip the #search form inside the shadow root attached to .app-header
Results results = new AxeSelenium()
.exclude(new FromShadowDom(".app-header", "form#search"))
.run(driver);exclude(Object)
Verwijdert een gebied uit de scan met een selector die als één enkel object wordt geleverd. Java selecteert deze overlading alleen als het statische type van het argument geen van de bovenstaande typen is, zoals een variabele die is gedeclareerd als Object. Geef de voorkeur aan de getypte overladingen.
public AxeSelenium exclude(Object selector);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
selector |
Object |
Een CSS-selectorstring, een lijst met strings, een FromFrames-selector of een FromShadowDom-selector. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// The selector's type is chosen at runtime, so it's held as Object
Object skip = adInFrame ? new FromFrames("#ad-frame", ".ad") : ".ad";
Results results = new AxeSelenium()
.exclude(skip)
.run(driver);exclude(Object...)
Verwijdert een gebied uit de scan met een selector die gewone CSS-selectors mixt met FromFrames- of FromShadowDom-selectors, voor gevallen die de andere overladingen niet kunnen uitdrukken. Alle argumenten samen vormen één pad naar één element; ze zijn geen afzonderlijke uitsluitingen.
Deze overload wordt geselecteerd wanneer de oproep meer dan één argument doorgeeft. Door een enkele FromFrames of FromShadowDom door te geven, selecteert exclude(FromFrames) of exclude(FromShadowDom) in plaats daarvan.
Om een iFrame te bereiken dat zich binnen een schaduwwortel bevindt, nest de FromShadowDom-selector binnen de FromFrames-selector. Het omgekeerde kan niet worden uitgedrukt, omdat FromShadowDom alleen strings accepteert.
public AxeSelenium exclude(Object... selector);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
selector |
Object... |
Een gemengde set van CSS-selectors en selectorobjecten die een enkel pad vormen naar het over te slaan element. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// Skip .target inside the shadow root attached to #host, inside the #frame iframe
Results results = new AxeSelenium()
.exclude("#frame", new FromShadowDom("#host", ".target"))
.run(driver);accordingTo(String...)
Voert alleen de regels uit die ten minste één van de gegeven tags bevatten, zoals wcag2a of best-practice. Gebruik het om te testen tegen een deel van een standaard, bijvoorbeeld alleen WCAG 2.0 Level A, in plaats van een hele regelset.
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 AxeSelenium accordingTo(String... tags);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
tags |
String... |
Een of meer axe-core-tags. Zie Regelbeschrijvingen voor de tags op elke regel. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// Run only the WCAG 2.0 Level A and Section 508 rules
Results results = new AxeSelenium()
.accordingTo("wcag2a", "section508")
.run(driver);checkingOnly(String...)
Voert alleen de genoemde regels uit en geen andere. Gebruik het om een test te richten op een of twee regels, bijvoorbeeld tijdens het oplossen van een specifiek probleem.
checkingOnly en accordingTo stellen dezelfde optie in, dus alleen de laatste van de twee aanroepen heeft effect. Een tweede checkingOnly-aanroep vervangt ook de regels van de eerste, dus geef alle regel-ID's in één aanroep door.
public AxeSelenium checkingOnly(String... rules);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
rules |
String... |
Een of meer axe-core regel-ID's. Zie Regelbeschrijvingen. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// Run only the label and color-contrast rules
Results results = new AxeSelenium()
.checkingOnly("label", "color-contrast")
.run(driver);checking(String...)
Schakelt de genoemde regels in, aanvullend op de regels die al door het regelsjabloon of door accordingTo zijn geselecteerd. Gebruik het om een regel toe te voegen die door de geselecteerde tags of regelsjabloon wordt weggelaten, zoals een best-practice-regel.
checking en skipping stellen dezelfde optie in, dus alleen de laatste van de twee aanroepen heeft effect, en een tweede checking-aanroep vervangt de regels van de eerste. Geef alle regel-ID's in één aanroep door en combineer checking niet met skipping in dezelfde scan.
public AxeSelenium checking(String... rules);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
rules |
String... |
Een of meer axe-core regel-ID's. Zie Regelbeschrijvingen. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// Run the WCAG 2.0 Level A rules, plus the tabindex best-practice rule
Results results = new AxeSelenium()
.accordingTo("wcag2a")
.checking("tabindex")
.run(driver);skipping(String...)
Schakelt de genoemde regels uit, waarbij de rest van het geselecteerde regelsjabloon of de tags behouden blijft. Gebruik het om een regel volledig uit te schakelen; om de overtreding op één element te laten vallen en de andere resultaten van de regel te behouden, gebruik je in plaats daarvan ignoring.
skipping en checking stellen dezelfde optie in, dus alleen de laatste van de twee aanroepen heeft effect, en een tweede skipping-aanroep vervangt de regels van de eerste. Geef alle regel-ID's in één aanroep door en combineer skipping niet met checking in dezelfde scan.
public AxeSelenium skipping(String... rules);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
rules |
String... |
Een of meer axe-core regel-ID's. Zie Regelbeschrijvingen. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// Run the default ruleset without the color-contrast and image-alt rules
Results results = new AxeSelenium()
.skipping("color-contrast", "image-alt")
.run(driver);forConfig(URL)
Selecteert de auditsuite (een JSON regelconfiguratiebestand) om mee te scannen, via URL. Dit stelt de globale auditsuite in op AxeConfiguration, dus het is ook van toepassing op elke latere AxeSelenium-scan, niet alleen deze.
Wanneer er geen auditsuite is ingesteld, gebruikt Axe DevTools het bestand dat is benoemd door de AXE_RULESET_PATH-omgevingsvariabele of, als dat niet is ingesteld, een config/axe-ruleset.json-resource op de classpath.
public AxeSelenium forConfig(URL auditConfigPath);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
auditConfigPath |
URL |
De URL van het auditsuite-bestand. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
URL auditSuite = getClass().getResource("/config/my-audit-suite.json");
Results results = new AxeSelenium()
.forConfig(auditSuite)
.run(driver);forConfig(String)
Selecteert de auditsuite om mee te scannen, via het pad op het bestandssysteem. Net als forConfig(URL) stelt het de globale auditsuite in, zodat het ook van toepassing is op latere scans.
public AxeSelenium forConfig(String auditConfigPath) throws MalformedURLException;Parameters
| Naam | Type | Beschrijving |
|---|---|---|
auditConfigPath |
String |
Het bestandssysteempad van het auditsuite-bestand. |
Retourneert
Dit AxeSelenium, voor method chaining.
Gooi
MalformedURLException als het pad niet kan worden omgezet naar een URL.
Voorbeeld
Results results = new AxeSelenium()
.forConfig("/opt/axe/my-audit-suite.json")
.run(driver);AxeSelenium.forRuleset(String)
Selecteert de regelset om mee te scannen, zoals wcag2.2 of 508, met best practice-regels uitgeschakeld. Het standaardregelsjabloon is wcag2.1. Indien er ook een auditsuite is geconfigureerd, wijzigt deze het geselecteerde regelsjabloon.
Dit stelt het globale regelsjabloon in op AxeConfiguration, waardoor het ook van toepassing is op elke latere scan. Zie AxeConfiguration.forRuleset(String) voor de lijst met regelsjabloon-ID's.
public AxeSelenium forRuleset(String rulesetId);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
rulesetId |
String |
De ID van het regelsjabloon. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
Results results = new AxeSelenium()
.forRuleset("wcag2.2")
.run(driver);AxeSelenium.forRuleset(String, boolean)
Selecteert de regelset om mee te scannen en of de best practice-regels ook uitgevoerd moeten worden. Anders gedraagt het zich zoals AxeSelenium.forRuleset(String), inclusief het instellen van het regelsjabloon globaal.
public AxeSelenium forRuleset(String rulesetId, boolean enableBestPractices);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
rulesetId |
String |
De ID van het regelsjabloon. |
enableBestPractices |
boolean |
true om ook best practice-regels uit te voeren. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// WCAG 2.1 rules plus best-practice rules
Results results = new AxeSelenium()
.forRuleset("wcag2.1", true)
.run(driver);AxeSelenium.ignoring(String, String)
Verwijdert de overtredingen van een regel uit de resultaten na de scan wanneer die regel faalt op een bepaald element. De regel wordt nog steeds uitgevoerd en rapporteert nog steeds zijn geslaagde resultaten. Eén aanroep per regel is voldoende, omdat een match de volledige invoer van de regel verwijdert. Roep het niet twee keer aan voor dezelfde regel: als beide selectors overeenkomen met falende elementen, gooit de scan een IllegalStateException.
Filtering werkt op hele regels: als een element dat de regel niet haalt overeenkomt met de selector, wordt de volledige invoer van de regel verwijderd uit de overtredingen, inclusief falen op andere elementen. Om die te behouden, beperk de scan dan met exclude.
De selector moet exact overeenkomen met de target van het element in de resultaten, zoals Java een lijst print: de doelselector tussen blokhaken, zoals "[#sidebar]", of "[#frame, .ad]" voor een element binnen een iFrame. Kopieer het uit de resultaten van een eerdere scan in plaats van het met de hand te schrijven.
public AxeSelenium ignoring(String attestSelector, String ruleId);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
attestSelector |
String |
De target van het element, zoals het in de resultaten verschijnt. |
ruleId |
String |
De ID van de regel waarvan de overtreding moet worden genegeerd. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// Ignore the known color-contrast violation on the sidebar
Results results = new AxeSelenium()
.ignoring("[#sidebar]", "color-contrast")
.run(driver);disableIframeTesting()
Voorkomt dat Axe DevTools axe-core in iFrames injecteert en resultaten daaruit verzamelt, zodat alleen het bovenliggende document wordt getest. Gebruik het wanneer de inhoud van iFrames buiten uw controle is of wanneer het injecteren in iFrames tot fouten leidt.
public AxeSelenium disableIframeTesting();Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
Results results = new AxeSelenium()
.disableIframeTesting()
.run(driver);setTimeout(int)
Stelt in hoelang, in seconden, axe-core de pagina mag analyseren voordat de scan mislukt met een timeout. De standaard is 30 seconden. Verhoog het voor zeer grote pagina's.
public AxeSelenium setTimeout(int timeout);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
timeout |
int |
De timeout, in seconden. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
Results results = new AxeSelenium()
.setTimeout(120)
.run(driver);logResults(AxeReportingOptions)
Schrijft een rapport van deze scan nadat run is voltooid: een .log-bestand met de overtredingen en een .json-bestand met de volledige resultaten. De bestandsnamen en locatie komen van reportingOptions; zie AxeReportingOptions. Zonder deze aanroep worden er geen rapportbestanden geschreven.
Als reportingOptions geen regelnummer heeft ingesteld, registreert Axe DevTools de regel van uw test die logResults aanriep.
public AxeSelenium logResults(AxeReportingOptions reportingOptions);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
reportingOptions |
AxeReportingOptions |
Waar het rapport moet worden geschreven en hoe de test daarin moet worden beschreven. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
// Writes axe-reports/checkout-page-loaded.log and .json
AxeReportingOptions options = new AxeReportingOptions()
.testSuiteName("checkout")
.uiState("page-loaded")
.outputDirectory("axe-reports");
Results results = new AxeSelenium()
.logResults(options)
.run(driver);loggingConfigured()
Rapporteert of logResults is aangeroepen op deze AxeSelenium.
public boolean loggingConfigured();Retourneert
true als rapportopties zijn ingesteld.
enableTracking(boolean)
Schakelt de gebruikersservice aan of uit voor deze AxeSelenium. De gebruikersservice staat standaard aan. Wanneer de AXE_TRACK_USAGE-omgevingsvariabele is ingesteld, krijgt deze voorrang en heeft deze methode geen effect: true schakelt de service in en elke andere waarde schakelt deze uit.
public AxeSelenium enableTracking(boolean state);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
state |
boolean |
true om gebruiksgegevens te verzenden, false om te stoppen met het verzenden ervan. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
Results results = new AxeSelenium()
.enableTracking(false)
.run(driver);trackingEnabled()
Rapporteert of deze AxeSelenium gebruiksgegevens verzendt.
public boolean trackingEnabled();Retourneert
true als de gebruikersservice is ingeschakeld.
setTrackingUrl(String)
Stelt de URL in waarnaar gebruiksgegevens worden verzonden. De standaard is de AXE_METRICS_URL-omgevingsvariabele, of https://usage.deque.com als deze niet is ingesteld. Wanneer AXE_METRICS_URL is ingesteld, heeft deze methode geen effect.
public AxeSelenium setTrackingUrl(String url);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
url |
String |
De URL van de gebruikersservice. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
Results results = new AxeSelenium()
.setTrackingUrl("https://usage.example.com")
.run(driver);setDistinctId(String)
Stelt de unieke ID in die met gebruiksgegevens wordt verzonden, waarmee de gebruikersservice de gebeurtenissen van één gebruiker of machine kan groeperen. De ID wordt opgeslagen in ~/.deque/distinct_id, zodat latere sessies op dezelfde machine deze blijven gebruiken. Wanneer de ID afkomstig is van de AXE_DISTINCT_ID-omgevingsvariabele, heeft deze methode geen effect.
public AxeSelenium setDistinctId(String id);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
id |
String |
De unieke ID. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
Results results = new AxeSelenium()
.setDistinctId("build-agent-7")
.run(driver);setAnalyticsComponentName(String)
Stelt de projectnaam in die met gebruiksgegevens wordt verzonden. Hierdoor worden eerdere setTrackingUrl- en enableTracking-aanroepen op deze AxeSelenium teruggezet naar hun standaardwaarden, dus roep het vóór die methoden aan. Een unieke ID ingesteld met setDistinctId wordt behouden.
public AxeSelenium setAnalyticsComponentName(String name);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
name |
String |
De projectnaam. |
Retourneert
Dit AxeSelenium, voor method chaining.
Voorbeeld
Results results = new AxeSelenium()
.setAnalyticsComponentName("storefront-tests")
.setDistinctId("build-agent-7")
.run(driver);com.deque.html.axecore.args.FromFrames
Een selector die een element in een of meer geneste iFrames target. Geef deze door aan include of exclude op AxeSelenium.
import com.deque.html.axecore.args.FromFrames;FromFrames(Object...)
Maakt een FromFrames-selector van een pad door geneste iFrames naar één element.
public FromFrames(Object... selectors);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
selectors |
Object... |
Eén selector per niveau van iFrame-nesting, gevolgd door een selector voor het element in het binnenste iFrame. Elke invoer is een CSS-selector string, of een FromShadowDom-selector wanneer het iFrame zelf binnen een shadow root leeft. |
Voorbeeld
// The form inside #inner-frame, which is inside #outer-frame
FromFrames checkoutForm = new FromFrames("#outer-frame", "#inner-frame", "form");
// The main element inside an iframe that lives in the shadow root attached to #widget
FromFrames widgetFrame = new FromFrames(new FromShadowDom("#widget", "iframe"), "main");getFromFrames()
Geeft de selectors terug die het pad door de geneste iFrames vormen.
public List<Object> getFromFrames();Retourneert
De selectors, als een List\<Object>.
setFromFrames(Object...)
Vervangt de selectors die het pad door de geneste iFrames vormen.
public void setFromFrames(Object... fromFrames);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
fromFrames |
Object... |
Het nieuwe pad, in dezelfde vorm als de constructor aanneemt. |
Voorbeeld
FromFrames selector = new FromFrames("#frame", "form");
selector.setFromFrames("#frame", "nav");com.deque.html.axecore.args.FromShadowDom
Een selector die een element in een of meer geneste shadow DOM-bomen target. Geef deze door aan include of exclude op AxeSelenium.
import com.deque.html.axecore.args.FromShadowDom;FromShadowDom(String...)
Maakt een FromShadowDom-selector van een pad door geneste shadow roots naar één element.
public FromShadowDom(String... selectors);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
selectors |
String... |
Eén selector per schaduwhost, gevolgd door een selector voor het element binnen de binnenste schaduwroot. |
Voorbeeld
// The button inside the shadow root of .dialog, which is inside the shadow root of app-shell
FromShadowDom closeButton = new FromShadowDom("app-shell", ".dialog", "button.close");getFromShadowDom()
Retourneert de selectors die het pad vormen door de geneste schaduwroots.
public List<String> getFromShadowDom();Retourneert
De selectors, als een List\<String>.
setFromShadowDom(String...)
Vervangt de selectors die het pad vormen door de geneste schaduwroots.
public void setFromShadowDom(String... fromShadowDom);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
fromShadowDom |
String... |
Het nieuwe pad, in dezelfde vorm als de constructor aanneemt. |
Voorbeeld
FromShadowDom selector = new FromShadowDom("app-shell", "nav");
selector.setFromShadowDom("app-shell", "footer");com.deque.html.axedevtools.selenium.AxeDriver
Omwikkelt een Selenium-WebDriver zodat Axe DevTools axe-core kan injecteren in de pagina die het controleert. Elke AxeSelenium-scan en elke Hamcrest-matcher neemt een AxeDriver. Blijf uw WebDriver gebruiken om de pagina te navigeren en ermee te interageren.
AxeDriver(WebDriver)
Maakt een AxeDriver voor een Selenium-WebDriver.
public AxeDriver(WebDriver webDriver);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
webDriver |
WebDriver |
De Selenium-WebDriver die de te controleren pagina aanstuurt. |
Voorbeeld
WebDriver webDriver = new ChromeDriver();
AxeDriver driver = new AxeDriver(webDriver);
webDriver.get("https://example.com");
Results results = new AxeSelenium().run(driver);com.deque.html.axedevtools.selenium.AxeConfiguration
Bevat instellingen die op elke scan in de testrun van toepassing zijn: het axe-core script, de audit suite, de regels, en de standaardinstellingen die in rapporten worden gebruikt. Er is één gedeelde instantie, die u verkrijgt met AxeConfiguration.configure(). Stel het één keer in, voordat tests worden uitgevoerd.
Methoden op AxeSelenium zoals forRuleset en forConfig wijzigen deze gedeelde instantie ook.
// Code runs once before any tests are run
public void setupOnce() {
AxeConfiguration.configure()
.withAxeScript(axeURL)
.forAuditSuite(auditURL)
.forRuleset("508")
.outputDirectory("my-axe-results");
}configure()
Retourneert de gedeelde AxeConfiguration-instantie. Deze statische methode is de enige manier om een AxeConfiguration te verkrijgen.
public static AxeConfiguration configure();Retourneert
De gedeelde AxeConfiguration.
Voorbeeld
AxeConfiguration config = AxeConfiguration.configure();reset()
Vervangt de gedeelde configuratie door een nieuwe met standaardinstellingen. Gebruik het tussen testklassen die verschillende globale instellingen nodig hebben. Een AxeConfiguration die u eerder heeft verkregen voordat u reset aanroept, behoudt zijn oude instellingen; roep daarna opnieuw configure() aan.
public static void reset();Voorbeeld
@AfterClass
public static void tearDown() {
AxeConfiguration.reset();
}forAuditSuite(URL)
Selecteert de auditsuït (een JSON-regelconfiguratiebestand) voor elke scan, via URL. Wanneer er geen auditsuït is ingesteld, gebruikt Axe DevTools het bestand dat door de AXE_RULESET_PATH-omgevingsvariabele wordt genoemd of, als dat niet is ingesteld, een config/axe-ruleset.json-resource op het classpath.
public AxeConfiguration forAuditSuite(URL auditConfigPath);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
auditConfigPath |
URL |
De URL van het auditsuite-bestand. |
Retourneert
Dit AxeConfiguration, voor method chaining.
Voorbeeld
AxeConfiguration.configure()
.forAuditSuite(getClass().getResource("/config/my-audit-suite.json"));forAuditSuite(String)
Selecteert de auditsuït voor elke scan, via zijn pad op het bestandssysteem.
public AxeConfiguration forAuditSuite(String auditConfigPath) throws MalformedURLException;Parameters
| Naam | Type | Beschrijving |
|---|---|---|
auditConfigPath |
String |
Het bestandssysteempad van het auditsuite-bestand. |
Retourneert
Dit AxeConfiguration, voor method chaining.
Gooi
MalformedURLException als het pad niet kan worden omgezet naar een URL.
Voorbeeld
AxeConfiguration.configure()
.forAuditSuite("/opt/axe/my-audit-suite.json");withAxeScript(URL)
Selecteert het axe-core script om in de pagina te injecteren, in plaats van het script dat bij Axe DevTools is inbegrepen. Gebruik het om een specifieke axe-core build vast te zetten.
public AxeConfiguration withAxeScript(URL axeScript);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
axeScript |
URL |
De URL van het axe-core script. |
Retourneert
Dit AxeConfiguration, voor method chaining.
Voorbeeld
AxeConfiguration.configure()
.withAxeScript(getClass().getResource("/axe.min.js"));AxeConfiguration.forRuleset(String)
Selecteert de regelset voor elke scan, met de best-practice-regels uitgeschakeld. Het standaardregels is wcag2.1.
public AxeConfiguration forRuleset(String rulesetId);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
rulesetId |
String |
Een van de regels-ID's hieronder. |
De regels-ID's zijn:
wcag2wcag2.1wcag2.2wcag2aaawcag2.1aaawcag2.2aaa508ttv5en301549rgaav4
Retourneert
Dit AxeConfiguration, voor method chaining.
Voorbeeld
AxeConfiguration.configure().forRuleset("wcag2.2");AxeConfiguration.forRuleset(String, boolean)
Selecteert de regelset voor elke scan, en of de best-practice-regels ook uitgevoerd moeten worden.
public AxeConfiguration forRuleset(String rulesetId, boolean enableBestPractices);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
rulesetId |
String |
Zie AxeConfiguration.forRuleset(String) voor de regels-ID's. |
enableBestPractices |
boolean |
true om ook best practice-regels uit te voeren. |
Retourneert
Dit AxeConfiguration, voor method chaining.
Voorbeeld
AxeConfiguration.configure().forRuleset("508", true);getTestSuiteName()
Retourneert de standaard naam van de testsuite die in rapporten wordt gebruikt. De standaard is axe-run.
public String getTestSuiteName();AxeConfiguration.testSuiteName(String)
Stelt de standaard naam van de testsuite in die in bestandsnamen en rapportinhoud wordt gebruikt. Een AxeReportingOptions.testSuiteName(String)-waarde overschrijft het voor één rapport.
public AxeConfiguration testSuiteName(String testSuiteName);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
testSuiteName |
String |
De naam van de testsuite. |
Retourneert
Dit AxeConfiguration, voor method chaining.
Voorbeeld
AxeConfiguration.configure().testSuiteName("storefront");AxeConfiguration.getOutputDirectory()
Retourneert de standaard map waar rapporten worden geschreven. De standaard is axe-reports.
public String getOutputDirectory();AxeConfiguration.outputDirectory(String)
Stelt de standaard map in waar rapporten worden geschreven. Ontbrekende mappen worden aangemaakt als een rapport wordt geschreven. Een AxeReportingOptions.outputDirectory(String)-waarde overschrijft het voor één rapport.
public AxeConfiguration outputDirectory(String outputDirectory);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
outputDirectory |
String |
Het pad naar de map. |
Retourneert
Dit AxeConfiguration, voor method chaining.
Voorbeeld
AxeConfiguration.configure().outputDirectory("target/axe-reports");AxeConfiguration.getUserAgent()
Retourneert de standaard gebruikersagent die in rapporten wordt opgenomen, of null als er geen is ingesteld.
public String getUserAgent();AxeConfiguration.userAgent(String)
Stelt de standaard gebruikersagent in die in rapporten wordt opgenomen. Het is alleen een label en verandert de gebruikersagent die de browser verzendt niet. Een AxeReportingOptions.userAgent(String)-waarde overschrijft het voor één rapport.
public AxeConfiguration userAgent(String userAgent);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
userAgent |
String |
De gebruikersagent om te registreren. |
Retourneert
Dit AxeConfiguration, voor method chaining.
Voorbeeld
AxeConfiguration.configure().userAgent("Chrome 130 headless");AxeConfiguration.getTestMachine()
Retourneert de standaard testmachinenaam die in rapporten wordt opgenomen, of null als er geen is ingesteld.
public String getTestMachine();AxeConfiguration.testMachine(String)
Stelt de standaard testmachinenaam in die in rapporten wordt opgenomen. Een AxeReportingOptions.testMachine(String)-waarde overschrijft het voor één rapport.
public AxeConfiguration testMachine(String testMachine);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
testMachine |
String |
De naam van de testmachine. |
Retourneert
Dit AxeConfiguration, voor method chaining.
Voorbeeld
AxeConfiguration.configure().testMachine(System.getenv("HOSTNAME"));com.deque.html.axedevtools.selenium.reporter.AxeReportingOptions
Beschrijft één rapport: waar het moet worden geschreven, en de testsuite, UI-status, gebruikersagent, testmachine en regelnummer die erin worden opgenomen. Geef het door aan logResults. Het implementeert ReportingOptions.
Elke waarde die u niet instelt valt terug op de overeenkomstige AxeConfiguration-instelling. De rapportbestanden worden genoemd <test suite name>-<UI state>.log en .json, dus geef elke controle in een testsuite zijn eigen UI-status, anders overschrijft het latere rapport het eerdere.
AxeReportingOptions()
Maakt een AxeReportingOptions zonder ingestelde waarden, zodat elke waarde van AxeConfiguration komt totdat u het instelt. De UI-status heeft geen standaard en moet worden ingesteld voordat een rapport wordt geschreven.
public AxeReportingOptions();Voorbeeld
AxeReportingOptions options = new AxeReportingOptions()
.uiState("home-page");defaultAuditReportingOptions()
Retourneert nieuwe opties met de uitvoermap target/axe-report, testsuitenaam accessibility en UI-status check, zodat het rapport wordt geschreven naar target/axe-report/accessibility-check.log en .json. Dit zijn de opties die de Hamcrest-isAuditedForAccessibility()-matcher gebruikt wanneer u logResults niet aanroept.
public static AxeReportingOptions defaultAuditReportingOptions();Retourneert
Een nieuwe AxeReportingOptions.
Voorbeeld
Results results = new AxeSelenium()
.logResults(AxeReportingOptions.defaultAuditReportingOptions())
.run(driver);getSuiteTestName()
Retourneert de testsuitenaam voor dit rapport, of de AxeConfiguration-standaard als er geen is ingesteld.
public String getSuiteTestName();AxeReportingOptions.testSuiteName(String)
Stelt de testsuitenaam in voor dit rapport. Het is het eerste deel van de rapportbestandsnamen.
public AxeReportingOptions testSuiteName(String testSuiteName);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
testSuiteName |
String |
De naam van de testsuite. |
Retourneert
Dit AxeReportingOptions, voor method chaining.
Voorbeeld
AxeReportingOptions options = new AxeReportingOptions()
.testSuiteName("checkout")
.uiState("payment-step");getUiState()
Retourneert de UI-status voor dit rapport.
public String getUiState();Gooi
MissingUIStateException als er geen UI-status is ingesteld.
uiState(String)
Stelt de UI-status in voor dit rapport: een korte naam voor hoe de pagina eruit zag toen deze werd gecontroleerd, zoals menu-open of form-errors. Het is het tweede deel van de rapportbestandsnamen, en het is vereist: het schrijven van een rapport zonder dit geeft MissingUIStateException.
public AxeReportingOptions uiState(String uiState);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
uiState |
String |
De naam van de UI-status. |
Retourneert
Dit AxeReportingOptions, voor method chaining.
Voorbeeld
webDriver.findElement(By.id("menu-button")).click();
Results results = new AxeSelenium()
.logResults(new AxeReportingOptions().uiState("menu-open"))
.run(driver);AxeReportingOptions.getOutputDirectory()
Retourneert de map waarin dit rapport wordt geschreven, of de AxeConfiguration-standaard als er geen is ingesteld.
public String getOutputDirectory();AxeReportingOptions.outputDirectory(String)
Stelt de map in waarin dit rapport wordt geschreven. Ontbrekende mappen worden gemaakt wanneer het rapport wordt geschreven.
public AxeReportingOptions outputDirectory(String outputDirectory);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
outputDirectory |
String |
Het pad naar de map. |
Retourneert
Dit AxeReportingOptions, voor method chaining.
Voorbeeld
AxeReportingOptions options = new AxeReportingOptions()
.outputDirectory("target/axe-reports/checkout")
.uiState("cart");getFileName()
Retourneert de rapportbestandsnaam zonder extensie: de testsuitenaam en UI-status verbonden door een koppelteken, gevolgd door een tijdstempel als useUniqueFilename aan is.
public String getFileName();getFilePath(String)
Retourneert het volledige pad van een rapportbestand: de uitvoermap, een /, de bestandsnaam en extension.
public String getFilePath(String extension);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
extension |
String |
De bestandsextensie, inclusief de punt die eraan voorafgaat, zoals .json. |
Retourneert
Het bestands pad.
Voorbeeld
AxeReportingOptions options = new AxeReportingOptions()
.testSuiteName("checkout")
.uiState("cart")
.outputDirectory("axe-reports");
String jsonPath = options.getFilePath(".json"); // axe-reports/checkout-cart.jsonuseUniqueFilename(boolean)
Voegt een UTC-tijdstempel toe aan de bestandsnamen van het rapport, zodat bij het opnieuw uitvoeren van dezelfde controle nieuwe bestanden worden geschreven in plaats van het vorige rapport te overschrijven.
Deze methode retourneert de ReportingOptions-interface in plaats van AxeReportingOptions, dus roep dit aan als een afzonderlijke instructie, zoals in het voorbeeld, in plaats van in een keten die u toewijst aan een AxeReportingOptions of doorgeeft aan logResults. De .log- en .json-bestandsnamen worden afzonderlijk opgebouwd, zodat hun tijdstempels iets kunnen verschillen.
public ReportingOptions useUniqueFilename(boolean uniqueFilename);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
uniqueFilename |
boolean |
true om een tijdstempel aan bestandsnamen toe te voegen. |
Retourneert
Dit object, getypt als ReportingOptions.
Voorbeeld
AxeReportingOptions options = new AxeReportingOptions()
.testSuiteName("nightly")
.uiState("home");
options.useUniqueFilename(true);AxeReportingOptions.getUserAgent()
Retourneert de gebruikersagent die in dit rapport is vastgelegd, of de AxeConfiguration-standaard als er geen is ingesteld.
public String getUserAgent();AxeReportingOptions.userAgent(String)
Stelt de gebruikersagent in die in dit rapport is vastgelegd. Het is slechts een label en verandert de gebruikersagent die de browser verzendt niet.
public AxeReportingOptions userAgent(String userAgent);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
userAgent |
String |
De gebruikersagent om te registreren. |
Retourneert
Dit AxeReportingOptions, voor method chaining.
Voorbeeld
String userAgent = (String) ((JavascriptExecutor) webDriver).executeScript("return navigator.userAgent");
AxeReportingOptions options = new AxeReportingOptions()
.userAgent(userAgent)
.uiState("home");AxeReportingOptions.getTestMachine()
Retourneert de naam van de testmachine die in dit rapport is vastgelegd, of de AxeConfiguration-standaard als er geen is ingesteld.
public String getTestMachine();AxeReportingOptions.testMachine(String)
Stelt de naam van de testmachine in die in dit rapport is vastgelegd.
public AxeReportingOptions testMachine(String testMachine);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
testMachine |
String |
De naam van de testmachine. |
Retourneert
Dit AxeReportingOptions, voor method chaining.
Voorbeeld
AxeReportingOptions options = new AxeReportingOptions()
.testMachine("ci-linux-04")
.uiState("home");getLineNum()
Retourneert het testregelnumer dat in dit rapport is vastgelegd, of null als er geen is ingesteld.
public String getLineNum();lineNum(String)
Stelt het testregelnummer in dat in dit rapport is vastgelegd en vervangt daarmee elke eerder ingestelde waarde. U heeft het zelden nodig: logResults registreert automatisch de aanroepregel wanneer er geen regelnummer is ingesteld.
public AxeReportingOptions lineNum(String lineNum);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
lineNum |
String |
Het regelnummer. |
Retourneert
Dit AxeReportingOptions, voor method chaining.
Voorbeeld
AxeReportingOptions options = new AxeReportingOptions()
.lineNum("42")
.uiState("home");lineNumIfEmpty(String)
Stelt het testregelnummer alleen in als er nog geen is ingesteld. logResults gebruikt het om de aanroepregel te registreren zonder een waarde overschrijven die u heeft ingesteld met lineNum.
Deze methode retourneert de ReportingOptions-interface in plaats van AxeReportingOptions, dus roep dit aan als een afzonderlijke instructie in plaats van in een keten die u toewijst aan een AxeReportingOptions of doorgeeft aan logResults.
public ReportingOptions lineNumIfEmpty(String lineNum);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
lineNum |
String |
Het regelnummer. |
Retourneert
Dit object, getypt als ReportingOptions.
com.deque.html.axedevtools.selenium.reporter.MissingUIStateException
Een RuntimeException die wordt gegooid wanneer een rapport wordt geschreven met rapportopties die geen UI-status hebben, met het bericht "Geef de UI-status van de huidige te testen pagina op". Om dit te vermijden, roept u uiState aan op elke AxeReportingOptions die u doorgeeft aan logResults.
com.deque.html.axedevtools.selenium.results.ResultsFilter
Bevat de te verwijderen elementen en regelparen uit de resultaten. Elke AxeSelenium maakt zijn eigen ResultsFilter, die u toevoegen met AxeSelenium.ignoring(String, String) in plaats van er zelf een aan te maken. U kunt ook een ResultsFilter direct gebruiken om een Results-object dat u al hebt te filteren.
filterIgnoredViolations(Results)
Verwijdert de genegeerde overtredingen van results. De hele invoer van een regel wordt uit de overtredingen verwijderd wanneer de regel-ID overeenkomt en een van de knooppunten een target heeft die overeenkomt met een genegeerde selector, zelfs als andere knooppunten niet overeenkomen. Het Results-object dat u invoert, wordt aangepast en geretourneerd.
public Results filterIgnoredViolations(Results results);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
results |
Results |
De resultaten om te filteren. |
Retourneert
Hetzelfde Results-object, met de genegeerde overtredingen verwijderd.
Voorbeeld
Results results = new AxeSelenium().run(driver);
new ResultsFilter()
.ignoring("[#legacy-widget]", "aria-allowed-attr")
.filterIgnoredViolations(results);ResultsFilter.ignoring(String, String)
Voegt een te negeren element- en regelpaar toe. De selector moet precies overeenkomen met een knooppunt's target, in de vorm "[#sidebar]"; zie AxeSelenium.ignoring(String, String).
public ResultsFilter ignoring(String cssSelector, String ruleId);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
cssSelector |
String |
De target van het element, zoals het in de resultaten verschijnt. |
ruleId |
String |
De ID van de regel waarvan de overtreding moet worden genegeerd. |
Retourneert
Dit ResultsFilter, voor method chaining.
Voorbeeld
ResultsFilter filter = new ResultsFilter()
.ignoring("[#sidebar]", "color-contrast")
.ignoring("[.third-party-iframe]", "frame-title");com.deque.html.axedevtools.reporter.AxeDevtoolsReporter
Schrijft de .log- en .json-rapportbestanden voor een scan. AxeSelenium en de Hamcrest-matchers gebruiken het voor u wanneer u logResults aanroept; gebruik het alleen direct om te rapporteren over Results die u al hebt.
AxeDevtoolsReporter()
Maakt een AxeDevtoolsReporter.
public AxeDevtoolsReporter();Voorbeeld
AxeDevtoolsReporter reporter = new AxeDevtoolsReporter();generateReport(Results, String)
Retourneert een tekstsamenvatting van de overtredingen in results: de helpteskst en URL van elke regel, het doel van elk getroffen knooppunt en de controles om te herstellen, gevolgd door de opdracht die de resultaten heeft opgeleverd. Dit is de tekst die naar het .log-bestand wordt geschreven, en de tekst die de Hamcrest isAxeClean()-matcher toont wanneer een bewering faalt.
public String generateReport(Results results, String executedCommand);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
results |
Results |
De scanresultaten. |
executedCommand |
String |
De opdrachttekst om in het rapport op te nemen, bijvoorbeeld van runCommand(). |
Retourneert
De rapporttekst.
Voorbeeld
AxeSelenium axe = new AxeSelenium();
Results results = axe.run(driver);
String report = new AxeDevtoolsReporter().generateReport(results, axe.runCommand());
System.out.println(report);report(ReportingOptions, Results, String)
Schrijft het rapport voor results naar twee bestanden op het pad dat door reportingOptions wordt gegeven: een .log-bestand met de generateReport-tekst en een .json-bestand met de volledige resultaten. Als reportingOptions null is, wordt er niets geschreven.
public void report(ReportingOptions reportingOptions, Results results, String executedCommand);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
reportingOptions |
ReportingOptions |
Waar het rapport moet worden geschreven, meestal een AxeReportingOptions. |
results |
Results |
De scanresultaten. |
executedCommand |
String |
De opdracht die de resultaten heeft opgeleverd. |
Gooi
MissingUIStateException als reportingOptions geen UI-status heeft, of een RuntimeException als de bestanden niet kunnen worden geschreven.
Voorbeeld
AxeSelenium axe = new AxeSelenium();
Results results = axe.run(driver);
new AxeDevtoolsReporter().report(
new AxeReportingOptions().uiState("after-login"),
results,
axe.runCommand());com.deque.html.axedevtools.utils.FileUtils
Bestandshulpmiddelen die Axe DevTools intern gebruikt om rapportbestanden te lezen en te schrijven. Het is niet bedoeld voor gebruik in uw tests.
