API-Referenz für Cucumber
API-Referenz für die AxeWorld-Klasse in Axe DevTools für Web Java
Dieses Dokument ist eine Referenz für die AxeWorld-Klasse im com.deque.html.axedevtools.cucumber-Paket. Anders als die Selenium- und Hamcrest-Pakete hat das Cucumber-Paket keine Builder- oder Matcher-Klasse für die Definition von Scopes und Regeln. Diese Optionen werden stattdessen direkt im Gherkin-Schritttext ausgedrückt, wie in Cucumber-Tests schreiben beschrieben. Die AxeWorld-Klasse speichert nur den Zustand und die Konfiguration, die Gherkin-Schritte nicht ausdrücken können, wie zum Beispiel die zu überprüfende Seite, Analytik-Einstellungen, benutzerdefinierte Berichtsoptionen und das axe-core-Timeout.
com.deque.html.axedevtools.cucumber.AxeWorld
Enthält die Seite und die Konfiguration, die von der Cucumber-Zugriffsschritte verwendet werden, wenn die Barrierefreiheit überprüft wird. Ihr Dependency-Injection-Framework erstellt die AxeWorld (PicoContainer erstellt z. B. eine pro Szenario) und übergibt sie sowohl an Ihre Schrittdefinitionen als auch an die Axe DevTools-Schritte, sodass alles, was Sie in einem @Before-Hook oder einem früheren Schritt einstellen, auf die Barrierefreiheitsschritte im selben Szenario angewendet wird.
Die Einstellungen werden jedes Mal gelesen, wenn ein Barrierefreiheitsschritt ausgeführt wird. Es wird nichts überprüft oder gesendet, wenn Sie die Setter aufrufen.
public StepDefinitions(AxeWorld axeWorld) {
this.axeWorld = axeWorld;
}
@Before
public void setup() {
webDriver = new ChromeDriver();
axeWorld.setPage(new AxeDriver(webDriver));
}AxeWorld()
Erstellt eine AxeWorld ohne Seite und ohne Konfiguration. Normalerweise rufen Sie sie nicht selbst auf: Deklarieren Sie einen AxeWorld-Parameter im Konstruktor Ihrer Schrittdefinitionsklasse, und Ihr Dependency-Injection-Framework erstellt und teilt die Instanz.
public AxeWorld();getPage()
Gibt die Seite zurück, die die Barrierefreiheitsschritte überprüfen, oder null, falls setPage nicht aufgerufen wurde.
public AxeDriver getPage();Gibt zurück
Die auf dieser Welt gesetzte AxeDriver.
setPage(AxeDriver)
Setzt die Seite, die die Barrierefreiheitsschritte überprüfen. Rufen Sie es auf, bevor ein Barrierefreiheitsschritt ausgeführt wird, normalerweise in einem @Before-Hook. Die Schritte überprüfen, welche Seite der umschlossene WebDriver zeigt, wenn der Schritt ausgeführt wird, also navigieren Sie wie gewohnt mit Ihrem WebDriver in früheren Schritten.
public void setPage(AxeDriver page);Parameter
| Name | Typ | Beschreibung |
|---|---|---|
page |
AxeDriver |
Die zu überprüfende Seite, die Ihr Selenium WebDriver umschließt. |
Beispiel
@Before
public void setup() {
webDriver = new ChromeDriver();
axeWorld.setPage(new AxeDriver(webDriver));
}enableAnalytics(boolean)
Schaltet den Nutzungsdienst für die Barrierefreiheitsschritte ein oder aus. Wenn Sie es nicht aufrufen, ist der Nutzungsdienst eingeschaltet. Wenn die AXE_TRACK_USAGE-Umgebungsvariable gesetzt ist, hat sie Vorrang und diese Methode hat keine Wirkung: true schaltet den Dienst ein und jeder andere Wert schaltet ihn aus.
public void enableAnalytics(boolean state);Parameter
| Name | Typ | Beschreibung |
|---|---|---|
state |
boolean |
true, um Nutzungsdaten zu senden, false, um das Senden zu stoppen. |
Beispiel
@Before
public void setup() {
axeWorld.enableAnalytics(false);
}setAnalyticsUrl(String)
Setzt die URL, an die Nutzungsdaten gesendet werden. Die Standardeinstellung ist die AXE_METRICS_URL-Umgebungsvariable, oder https://usage.deque.com, wenn diese nicht gesetzt ist. Wenn AXE_METRICS_URL gesetzt ist, hat diese Methode keine Wirkung.
public void setAnalyticsUrl(String url);Parameter
| Name | Typ | Beschreibung |
|---|---|---|
url |
String |
Die URL des Nutzungsdienstes. |
Beispiel
axeWorld.setAnalyticsUrl("https://usage.example.com");setAnalyticsDistinctId(String)
Setzt die eindeutige ID, die mit den Nutzungsdaten gesendet wird, wodurch der Nutzungsdienst die Ereignisse eines Benutzers oder einer Maschine gruppieren kann. Die ID wird in ~/.deque/distinct_id gespeichert, sodass spätere Ausführungen auf derselben Maschine sie weiterhin verwenden. Wenn die ID aus der AXE_DISTINCT_ID-Umgebungsvariable stammt, hat diese Methode keine Wirkung.
public void setAnalyticsDistinctId(String did);Parameter
| Name | Typ | Beschreibung |
|---|---|---|
did |
String |
Die eindeutige ID. |
Beispiel
axeWorld.setAnalyticsDistinctId(System.getenv("CI_RUNNER_ID"));setAnalyticsComponentName(String)
Setzt den Projektnamen, der mit den Nutzungsdaten gesendet wird.
Die Barrierefreiheitsschritte wenden den Komponentenname nach den anderen Analytikeinstellungen an, und wenn er gesetzt wird, werden die URL und der enableAnalytics-Wert auf ihre Standardeinstellungen zurückgesetzt. Wenn Sie also einen Komponentenname setzen, hat ein beliebiger setAnalyticsUrl- oder enableAnalytics-Wert auf dem selben AxeWorld keine Wirkung. Ein setAnalyticsDistinctId-Wert bleibt erhalten, da die eindeutige ID in einer Datei gespeichert wird.
public void setAnalyticsComponentName(String name);Parameter
| Name | Typ | Beschreibung |
|---|---|---|
name |
String |
Der Projektname. |
Beispiel
axeWorld.setAnalyticsComponentName("storefront-features");setReportingOptions(AxeReportingOptions)
Legt fest, wo der Then the page should be audited for accessibility-Schritt seinen Bericht schreibt und wie er den Test beschreibt. Ohne ihn schreibt dieser Schritt nach target/axe-report/accessibility-check.log und .json. Siehe AxeReportingOptions für die Optionen. Die Optionen, die Sie übergeben, ersetzen die Standardwerte vollständig: Jeder Wert, den Sie nicht festlegen, fällt auf AxeConfiguration zurück (Berichte gehen an axe-reports, es sei denn, Sie setzen outputDirectory), und Sie müssen uiState festlegen.
Es hat keine Wirkung auf den Then the page should be axe clean-Schritt, der keinen Bericht schreibt.
public void setReportingOptions(AxeReportingOptions reportingOptions);Parameter
| Name | Typ | Beschreibung |
|---|---|---|
reportingOptions |
AxeReportingOptions |
Die zu verwendenden Berichtsoptionen. |
Beispiel
@Before
public void setup(Scenario scenario) {
axeWorld.setReportingOptions(new AxeReportingOptions()
.outputDirectory("target/axe-report")
.testSuiteName("checkout")
.uiState(scenario.getName().replaceAll("\\W+", "-")));
}setTimeout(int)
Legt fest, wie lange axe-core die Seite analysieren darf, bevor der Schritt mit einem Timeout fehlschlägt. Die Standardeinstellung beträgt 30 Sekunden. Erhöhen Sie den Wert für sehr große Seiten.
public void setTimeout(int timeout);Parameter
| Name | Typ | Beschreibung |
|---|---|---|
timeout |
int |
Das Timeout in Sekunden. |
Beispiel
axeWorld.setTimeout(120);