Referencia de la API para Cucumber
Referencia de la API para la clase AxeWorld en Axe DevTools para Web Java
Este documento es una referencia para la clase AxeWorld en el paquete com.deque.html.axedevtools.cucumber. A diferencia de los paquetes Selenium y Hamcrest, el paquete Cucumber no tiene una clase de constructor o coincidente para la configuración del alcance y las reglas. Esas opciones se expresan directamente en el texto del paso Gherkin, como se describe en Escribe Pruebas en Cucumber. La clase AxeWorld solo mantiene el estado y la configuración que los pasos Gherkin no pueden expresar, como la página a verificar, configuraciones de analítica, opciones de reporte personalizadas y el tiempo de espera de axe-core.
com.deque.html.axedevtools.cucumber.AxeWorld
Mantiene la página y la configuración utilizada por pasos de accesibilidad en Cucumber al verificar accesibilidad. Tu marco de inyección de dependencias crea AxeWorld (PicoContainer, por ejemplo, crea uno por escenario) y lo pasa tanto a tus definiciones de pasos como a los pasos de Axe DevTools, por lo que todo lo que configures en un gancho @Before o en un paso anterior se aplica a los pasos de accesibilidad en el mismo escenario.
Las configuraciones se leen cada vez que se ejecuta un paso de accesibilidad. No se comprueba ni se envía nada cuando llamas a los setters.
public StepDefinitions(AxeWorld axeWorld) {
this.axeWorld = axeWorld;
}
@Before
public void setup() {
webDriver = new ChromeDriver();
axeWorld.setPage(new AxeDriver(webDriver));
}AxeWorld()
Crea un AxeWorld sin página y sin configuración. Normalmente no lo llamas tú mismo: declara un parámetro AxeWorld en el constructor de la clase de definición de tu paso, y tu marco de inyección de dependencias crea y comparte la instancia.
public AxeWorld();getPage()
Devuelve la página que los pasos de accesibilidad verifican, o null si no se ha llamado a setPage.
public AxeDriver getPage();Devuelve
El AxeDriver configurado en este mundo.
setPage(AxeDriver)
Establece la página que los pasos de accesibilidad verifican. Llámalo antes de que se ejecute cualquier paso de accesibilidad, generalmente en un gancho @Before. Los pasos verifican cualquier página que muestre el WebDriver envuelto cuando se ejecuta el paso, por lo que navega con tu WebDriver en pasos anteriores como de costumbre.
public void setPage(AxeDriver page);Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
page |
AxeDriver |
La página a verificar, envolviendo tu Selenium WebDriver. |
Ejemplo
@Before
public void setup() {
webDriver = new ChromeDriver();
axeWorld.setPage(new AxeDriver(webDriver));
}enableAnalytics(boolean)
Activa o desactiva el servicio de uso para los pasos de accesibilidad. Cuando no lo llamas, el servicio de uso está activado. Cuando la variable de entorno AXE_TRACK_USAGE está configurada, tiene prioridad y este método no tiene efecto: true enciende el servicio y cualquier otro valor lo apaga.
public void enableAnalytics(boolean state);Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
state |
boolean |
true para enviar datos de uso, false para dejar de enviarlos. |
Ejemplo
@Before
public void setup() {
axeWorld.enableAnalytics(false);
}setAnalyticsUrl(String)
Establece la URL a la que se envían los datos de uso. El valor predeterminado es la variable de entorno AXE_METRICS_URL, o https://usage.deque.com cuando no está configurada. Cuando AXE_METRICS_URL está configurada, este método no tiene efecto.
public void setAnalyticsUrl(String url);Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
url |
String |
La URL del servicio de uso. |
Ejemplo
axeWorld.setAnalyticsUrl("https://usage.example.com");setAnalyticsDistinctId(String)
Establece el ID distinto enviado con los datos de uso, lo que permite al servicio de uso agrupar los eventos de un usuario o máquina. El ID se guarda en ~/.deque/distinct_id, por lo que ejecuciones posteriores en la misma máquina continúan usándolo. Cuando el ID proviene de la variable de entorno AXE_DISTINCT_ID, este método no tiene efecto.
public void setAnalyticsDistinctId(String did);Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
did |
String |
El ID distinto. |
Ejemplo
axeWorld.setAnalyticsDistinctId(System.getenv("CI_RUNNER_ID"));setAnalyticsComponentName(String)
Establece el nombre del proyecto enviado con los datos de uso.
Los pasos de accesibilidad aplican el nombre del componente después de las otras configuraciones de analítica, y establecerlo restablece la URL y el valor de enableAnalytics a sus valores predeterminados. Así que cuando estableces un nombre de componente, cualquier valor de setAnalyticsUrl o enableAnalytics en el mismo AxeWorld no tiene efecto. Se mantiene un valor setAnalyticsDistinctId, porque el ID distinto se guarda en un archivo.
public void setAnalyticsComponentName(String name);Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
name |
String |
El nombre del proyecto. |
Ejemplo
axeWorld.setAnalyticsComponentName("storefront-features");setReportingOptions(AxeReportingOptions)
Establece dónde el paso Then the page should be audited for accessibility escribe su reporte y cómo describe la prueba. Sin él, ese paso escribe a target/axe-report/accessibility-check.log y .json. Consulta AxeReportingOptions para conocer las opciones. Las opciones que pasas reemplazan completamente los valores predeterminados: cualquier valor que no configures vuelve a AxeConfiguration (los reportes se envían a axe-reports a menos que configures outputDirectory), y debes configurar uiState.
No tiene efecto en el paso Then the page should be axe clean, que no escribe un reporte.
public void setReportingOptions(AxeReportingOptions reportingOptions);Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
reportingOptions |
AxeReportingOptions |
Las opciones de reporte a utilizar. |
Ejemplo
@Before
public void setup(Scenario scenario) {
axeWorld.setReportingOptions(new AxeReportingOptions()
.outputDirectory("target/axe-report")
.testSuiteName("checkout")
.uiState(scenario.getName().replaceAll("\\W+", "-")));
}setTimeout(int)
Establece cuánto tiempo, en segundos, axe-core puede analizar la página antes de que el paso falle por un tiempo de espera. El valor predeterminado es 30 segundos. Auméntalo para páginas muy grandes.
public void setTimeout(int timeout);Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
timeout |
int |
El tiempo de espera, en segundos. |
Ejemplo
axeWorld.setTimeout(120);