API-referentie voor Cucumber
API-referentie voor de AxeWorld-klasse in Axe DevTools voor Web Java
Dit document is een referentie voor de AxeWorld klasse in het com.deque.html.axedevtools.cucumber pakket. In tegenstelling tot de Selenium- en Hamcrest-pakketten heeft het Cucumber-pakket geen builder of matcher klasse voor scoping en regelconfiguratie. Deze opties worden in plaats daarvan direct uitgedrukt in de Gherkin-staptekst, zoals beschreven in Schrijf Cucumber-tests. De AxeWorld klasse bevat alleen de toestand en configuratie die Gherkin-stappen niet kunnen uitdrukken, zoals de pagina om te controleren, analytische instellingen, aangepaste rapportage-opties en de axe-core time-out.
com.deque.html.axedevtools.cucumber.AxeWorld
Bevat de pagina en configuratie die door de Cucumber toegankelijkheidsstappen worden gebruikt bij het controleren van toegankelijkheid. Uw dependency injection framework creëert de AxeWorld (PicoContainer creëert er bijvoorbeeld één per scenario) en levert deze aan zowel uw stapdefinities als de Axe DevTools-stappen, zodat alles wat u instelt in een @Before hook of een eerdere stap van toepassing is op de toegankelijkheidsstappen in hetzelfde scenario.
De instellingen worden gelezen elke keer dat een toegankelijkheidsstap wordt uitgevoerd. Er wordt niets gecontroleerd of verzonden wanneer u de setters aanroept.
public StepDefinitions(AxeWorld axeWorld) {
this.axeWorld = axeWorld;
}
@Before
public void setup() {
webDriver = new ChromeDriver();
axeWorld.setPage(new AxeDriver(webDriver));
}AxeWorld()
Creëert een AxeWorld zonder pagina en zonder configuratie. U roept het meestal niet zelf aan: declareer een AxeWorld parameter in de constructor van uw stapdefinitieklasse, en uw dependency injection framework creëert en deelt de instantie.
public AxeWorld();getPage()
Geeft de pagina terug die door de toegankelijkheidsstappen wordt gecontroleerd, of null als setPage niet is aangeroepen.
public AxeDriver getPage();Geeft terug
De AxeDriver ingesteld op deze wereld.
setPage(AxeDriver)
Stelt de pagina in die door de toegankelijkheidsstappen wordt gecontroleerd. Roep het aan voordat een toegankelijkheidsstap wordt uitgevoerd, meestal in een @Before hook. De stappen controleren welke pagina de gewrapte WebDriver toont wanneer de stap wordt uitgevoerd, dus navigeer met uw WebDriver in eerdere stappen zoals gewoonlijk.
public void setPage(AxeDriver page);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
page |
AxeDriver |
De pagina om te controleren, waarbij uw Selenium WebDriver wordt omwikkeld. |
Voorbeeld
@Before
public void setup() {
webDriver = new ChromeDriver();
axeWorld.setPage(new AxeDriver(webDriver));
}enableAnalytics(boolean)
Zet de gebruikersdienst aan of uit voor de toegankelijkheidsstappen. Wanneer u het niet aanroept, staat de gebruikerdienst aan. Wanneer de AXE_TRACK_USAGE omgevingsvariabele is ingesteld, heeft deze voorrang en heeft deze methode geen effect: true zet de dienst aan en elke andere waarde zet hem uit.
public void enableAnalytics(boolean state);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
state |
boolean |
true om gebruiksgegevens te verzenden, false om het te stoppen. |
Voorbeeld
@Before
public void setup() {
axeWorld.enableAnalytics(false);
}setAnalyticsUrl(String)
Stelt de URL in waarnaar gebruiksgegevens worden verzonden. De standaard is de AXE_METRICS_URL omgevingsvariabele, of https://usage.deque.com wanneer deze niet is ingesteld. Wanneer AXE_METRICS_URL is ingesteld, heeft deze methode geen effect.
public void setAnalyticsUrl(String url);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
url |
String |
De URL van de gebruikerdienst. |
Voorbeeld
axeWorld.setAnalyticsUrl("https://usage.example.com");setAnalyticsDistinctId(String)
Stelt de distinctieve ID in die met gebruiksgegevens wordt verzonden, waardoor de gebruikerdienst de gebeurtenissen van één gebruiker of machine kan groeperen. De ID wordt opgeslagen in ~/.deque/distinct_id, zodat latere runs op dezelfde machine het blijven gebruiken. Wanneer de ID afkomstig is van de AXE_DISTINCT_ID omgevingsvariabele, heeft deze methode geen effect.
public void setAnalyticsDistinctId(String did);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
did |
String |
De distinctieve ID. |
Voorbeeld
axeWorld.setAnalyticsDistinctId(System.getenv("CI_RUNNER_ID"));setAnalyticsComponentName(String)
Stelt de projectnaam in die met gebruiksgegevens wordt verzonden.
De toegankelijkheidsstappen passen de componentnaam toe na de andere analytische instellingen en het instellen ervan reset de URL en enableAnalytics waarde naar hun standaardwaarden. Dus wanneer u een componentnaam instelt, heeft elke setAnalyticsUrl of enableAnalytics waarde op dezelfde AxeWorld geen effect. Een setAnalyticsDistinctId waarde blijft behouden, omdat de distinctieve ID in een bestand wordt opgeslagen.
public void setAnalyticsComponentName(String name);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
name |
String |
De projectnaam. |
Voorbeeld
axeWorld.setAnalyticsComponentName("storefront-features");setReportingOptions(AxeReportingOptions)
Stelt in waar de Then the page should be audited for accessibility stap zijn rapport schrijft en hoe deze de test beschrijft. Zonder deze schrijft die stap naar target/axe-report/accessibility-check.log en .json. Zie AxeReportingOptions voor de opties. De opties die u doorgeeft vervangen de standaardinstellingen volledig: elke waarde die u niet instelt, valt terug op AxeConfiguration (rapporten gaan naar axe-reports tenzij u outputDirectory instelt), en u moet uiState instellen.
Het heeft geen effect op de Then the page should be axe clean stap, die geen rapport schrijft.
public void setReportingOptions(AxeReportingOptions reportingOptions);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
reportingOptions |
AxeReportingOptions |
De te gebruiken rapportage-opties. |
Voorbeeld
@Before
public void setup(Scenario scenario) {
axeWorld.setReportingOptions(new AxeReportingOptions()
.outputDirectory("target/axe-report")
.testSuiteName("checkout")
.uiState(scenario.getName().replaceAll("\\W+", "-")));
}setTimeout(int)
Stelt in hoe lang, in seconden, axe-core de pagina mag analyseren voordat de stap faalt met een time-out. De standaard is 30 seconden. Verhoog het voor zeer grote pagina's.
public void setTimeout(int timeout);Parameters
| Naam | Type | Beschrijving |
|---|---|---|
timeout |
int |
De time-out, in seconden. |
Voorbeeld
axeWorld.setTimeout(120);