Referencia de API para Selenium
Referencia de API para las clases AxeSelenium y AxeConfiguration en Axe DevTools para Web Java
Este documento es una referencia para los tipos proporcionados por el paquete selenium. La clase AxeSelenium debería cubrir la mayoría de los casos de uso, y AxeConfiguration debería cubrir el resto.
com.deque.html.axedevtools.selenium.AxeSelenium
Configura cómo se ejecuta axe y realmente ejecuta axe.
Results = new AxeSelenium()
.include(".my-css-class")
.skipping("aria-required-parent")
.run(driver);AxeSelenium()
Crea una nueva verificación de accesibilidad AxeSelenium para un AxeDriver.
AxeSelenium(final AxeBuilder axeBuilder, final AxeConfiguration axeConfiguration, final ResultsFilter resultsFilter, final AxeDevtoolsReporter reporter)
Crea una nueva verificación de accesibilidad AxeSelenium para un AxeDriver.
Results run(final AxeDriver page)
Ejecutar axe contra la página usando axe.run.
page: Controlador AxeDevTools que representa la página para realizar una verificación de accesibilidad.
Devuelve un documento de resultados.
AxeSelenium include(final String cssSelector)
Incluye un solo selector. Para probar varias partes no relacionadas de la página, llama a include una vez por cada una, pasando un solo selector cada vez.
cssSelector: Cualquier selector CSS válido.
Devuelve AxeSelenium para encadenamiento de métodos.
// Test .sidebar and .some-class, which are both in the top-level document
Results results = new AxeSelenium()
.include(".sidebar")
.include(".some-class")
.run(driver);AxeSelenium include(final List<String> selector)
Incluir un selector de iFrame.
selector: Una lista de selectores de iFrame anidados.
Cada selector representará un selector CSS para un nivel de anidamiento.
El último representará un selector CSS para el elemento web dentro del iFrame más interno para la verificación.
Devuelve AxeSelenium para encadenamiento de métodos.
Debido a que no hay una sobrecarga de include(String...), pasar más de una cadena de texto a include también produce un único selector de iFrame en lugar de inclusiones separadas: include("#parent-iframe", "#html") se resuelve a include(Object...) y significa lo mismo que el ejemplo de abajo.
// Test #html inside the iframe matched by #parent-iframe
Results results = new AxeSelenium()
.include(Arrays.asList("#parent-iframe", "#html"))
.run(driver);include(FromFrames) expresa lo mismo de manera más explícita y es la forma recomendada para nuevas pruebas.
AxeSelenium include(FromFrames fromFrames)
Incluye un elemento dentro de uno o más iFrames anidados, usando un selector FromFrames explícito.
fromFrames: Un selector FromFrames.
Cada selector salvo el último coincide con un nivel de anidación de iFrame; el último coincide con el elemento a probar dentro del iFrame más interno.
Devuelve AxeSelenium para encadenamiento de métodos.
// Test the form inside the #payment-frame iframe
Results results = new AxeSelenium()
.include(new FromFrames("#payment-frame", "form"))
.run(driver);AxeSelenium include(FromShadowDom fromShadowDom)
Incluye un elemento dentro de uno o más árboles DOM de sombra anidados, usando un selector FromShadowDom explícito.
fromShadowDom: Un selector FromShadowDom.
Cada selector salvo el último coincide con un anfitrión de sombra; el último coincide con el elemento a probar dentro de la raíz de sombra más interna.
Devuelve AxeSelenium para encadenamiento de métodos.
// 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);AxeSelenium include(Object selector)
Incluye un selector proporcionado como un único objeto. Esta sobrecarga se selecciona solo cuando el tipo estático del argumento no es uno de los tipos mencionados anteriormente, como una variable declarada como Object. Prefiere las sobrecargas tipificadas.
selector: Una cadena de selector CSS, una lista de cadenas, un selector FromFrames o un selector FromShadowDom.
Devuelve AxeSelenium para encadenamiento de métodos.
AxeSelenium include(Object... selector)
Incluye un selector que combina selectores CSS simples con selectores FromFrames o FromShadowDom, para casos que las otras sobrecargas no pueden expresar.
Esta sobrecarga se selecciona siempre que la llamada pase más de un argumento. Pasar un solo FromFrames o FromShadowDom selecciona include(FromFrames) o include(FromShadowDom) en su lugar.
Para alcanzar un iFrame que se encuentra dentro de una raíz de sombra, el selector FromShadowDom debe estar anidado dentro del selector FromFrames; lo contrario causa un error.
selector: Un conjunto mixto de selectores CSS y objetos selector que forman un solo camino hacia el elemento a probar.
Devuelve AxeSelenium para encadenamiento de métodos.
// 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);AxeSelenium exclude(final String cssSelector)
Excluye un solo selector. Para omitir varias partes no relacionadas de la página, llama a exclude una vez por cada una, pasando un solo selector cada vez.
cssSelector: Cualquier selector CSS válido.
Devuelve AxeSelenium para encadenamiento de métodos.
// Skip .cookie-banner and .ad-slot, which are both in the top-level document
Results results = new AxeSelenium()
.exclude(".cookie-banner")
.exclude(".ad-slot")
.run(driver);AxeSelenium exclude(final List<String> selector)
Excluye un selector de iFrame.
selector: Una lista de selectores de iFrame anidados.
Cada selector representará un selector CSS para un nivel de anidamiento.
El último representará un selector CSS para el elemento web dentro del iFrame más interno para la verificación.
Devuelve AxeSelenium para encadenamiento de métodos.
Debido a que no hay una sobrecarga de exclude(String...), pasar más de una cadena de texto a exclude también produce un único selector de iFrame en lugar de exclusiones separadas: exclude(".iframe1", ".third-party-ad") se resuelve a exclude(Object...) y significa lo mismo que el ejemplo de abajo.
// 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) expresa lo mismo de manera más explícita y es la forma recomendada para nuevas pruebas.
AxeSelenium exclude(FromFrames fromFrames)
Excluye un elemento dentro de uno o más iFrames anidados, usando un selector FromFrames explícito.
fromFrames: Un selector FromFrames.
Cada selector salvo el último coincide con un nivel de anidación de iFrame; el último coincide con el elemento a omitir dentro del iFrame más interno.
Devuelve AxeSelenium para encadenamiento de métodos.
// Skip the form inside the #payment-frame iframe
Results results = new AxeSelenium()
.exclude(new FromFrames("#payment-frame", "form"))
.run(driver);AxeSelenium exclude(FromShadowDom fromShadowDom)
Excluye un elemento dentro de uno o más árboles DOM de sombra anidados, usando un selector FromShadowDom explícito.
fromShadowDom: Un selector FromShadowDom.
Cada selector salvo el último coincide con un anfitrión de sombra; el último coincide con el elemento a omitir dentro de la raíz de sombra más interna.
Devuelve AxeSelenium para encadenamiento de métodos.
// 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);AxeSelenium exclude(Object selector)
Excluye un selector proporcionado como un único objeto. Esta sobrecarga se selecciona solo cuando el tipo estático del argumento no es uno de los tipos mencionados anteriormente, como una variable declarada como Object. Prefiere las sobrecargas tipificadas.
selector: Una cadena de selector CSS, una lista de cadenas, un selector FromFrames o un selector FromShadowDom.
Devuelve AxeSelenium para encadenamiento de métodos.
AxeSelenium exclude(Object... selector)
Excluye un selector que combina selectores CSS simples con selectores FromFrames o FromShadowDom, para casos que las otras sobrecargas no pueden expresar.
Esta sobrecarga se selecciona siempre que la llamada pase más de un argumento. Pasar un solo FromFrames o FromShadowDom selecciona exclude(FromFrames) o exclude(FromShadowDom) en su lugar.
Para alcanzar un iFrame que se encuentra dentro de una raíz de sombra, el selector FromShadowDom debe estar anidado dentro del selector FromFrames; lo contrario causa un error.
selector: Un conjunto mixto de selectores CSS y objetos selector que forman un solo camino hacia el elemento a omitir.
Devuelve AxeSelenium para encadenamiento de métodos.
// 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);AxeSelenium accordingTo(final String... tags)
Según las etiquetas de accesibilidad. Comprobar solo las etiquetas de accesibilidad especificadas. Esta opción es incompatible con AxeSelenium::checkingOnly
Vea Descripciones de reglas.
tags: Lista de etiquetas para comprobar.
Devuelve AxeSelenium para encadenamiento de métodos.
AxeSelenium checkingOnly(final String... rules)
Comprobando solo reglas de accesibilidad. Esta opción es incompatible con AxeSelenium::accordingTo
Vea Descripciones de reglas.
rules: Lista de reglas para comprobar.
Devuelve AxeSelenium para encadenamiento de métodos.
AxeSelenium checking(final String... rules)
Comprobar reglas de accesibilidad. Además de las etiquetas dadas, también verifique ciertas reglas. Vea Descripciones de reglas.
rules: Lista de reglas para comprobar.
Devuelve AxeSelenium para encadenamiento de métodos.
AxeSelenium skipping(final String... rules)
Omitiendo reglas de accesibilidad. Dentro de las etiquetas dadas, omita la comprobación de ciertas reglas. Vea Descripciones de reglas.
rules: Lista de reglas para comprobar.
Devuelve AxeSelenium para encadenamiento de métodos.
AxeSelenium forConfig(final URL auditConfigPath)
Proporciona un conjunto de auditoría por su URL.
auditConfigPath: la URL asociada con el conjunto de auditoría.
Devuelve AxeSelenium para encadenamiento de métodos.
AxeSelenium forConfig(final String auditConfigPath) throws MalformedURLException
Proporciona un conjunto de auditoría por su ubicación en el sistema de archivos.
auditConfigPath: La ruta absoluta del archivo de la suite de auditoría.
Devuelve AxeSelenium para encadenamiento de métodos.
Lanza MalformedURLException si la ruta de auditoría es una ruta no válida del sistema de archivos.
AxeSelenium forRuleset(final String rulesetId)
Especificar un conjunto de reglas para la verificación de accesibilidad. Configurar un conjunto de auditoría modificará el conjunto de reglas especificado. Ver Conjuntos de reglas.
rulesetId: El id del conjunto de reglas para la configuración.
Devuelve AxeSelenium para encadenamiento de métodos.
AxeSelenium forRuleset(final String rulesetId, final boolean enableBestPractices)
Especificar un conjunto de reglas para la verificación de accesibilidad. Configurar un conjunto de auditoría modificará el conjunto de reglas especificado. Ver Conjuntos de reglas.
rulesetId: El id del conjunto de reglas para la configuración.
enableBestPractices: Si se activan o no las reglas de "mejores prácticas".
AxeSelenium: para encadenamiento de métodos.
AxeSelenium ignoring(final String selector, final String ruleId)
Ignorar violaciones para un selector y un id de regla dado.
selector: Selector producido por la suite de Accesibilidad/Auditoría de Axe DevTools.
ruleId: Id de regla a ignorar para el selector dado.
Devuelve AxeSelenium para encadenamiento de métodos.
AxeSelenium logResults(final AxeReportingOptions reportingOptions)
Registrar resultados de la verificación de accesibilidad al completarse.
reportingOptions: Opciones que definen la serialización y persistencia de la verificación de accesibilidad.
Devuelve AxeSelenium para encadenamiento de métodos.
boolean loggingConfigured()
Si el registro ha sido configurado o no.
Devuelve Si el registro ha sido configurado o no.
com.deque.html.axecore.args.FromFrames
Un selector que apunta a un elemento dentro de uno o más iFrames anidados.
Pásalo a AxeSelenium::include o AxeSelenium::exclude.
import com.deque.html.axecore.args.FromFrames;FromFrames(Object... selectors)
Crea un selector FromFrames.
selectors: Un selector por cada nivel de anidación de iFrame, seguido de un selector para el elemento dentro del iFrame más interno.
Cada entrada es una cadena de selector CSS o un selector FromShadowDom cuando el iFrame mismo se encuentra dentro de una raíz de sombra.
List<Object> getFromFrames()
Obtiene los selectores que forman el camino a través de los iFrames anidados.
Devuelve la lista de selectores.
void setFromFrames(Object... fromFrames)
Establece los selectores que forman el camino a través de los iFrames anidados.
fromFrames: Los selectores para usar.
com.deque.html.axecore.args.FromShadowDom
Un selector que apunta a un elemento dentro de uno o más árboles DOM de sombra anidados.
Pásalo a AxeSelenium::include o AxeSelenium::exclude.
import com.deque.html.axecore.args.FromShadowDom;FromShadowDom(String... selectors)
Crea un selector FromShadowDom.
selectors: Un selector por cada nivel de anidamiento del shadow DOM, seguido de un selector para el elemento dentro de la raíz de sombra más interna.
List<String> getFromShadowDom()
Obtiene los selectores que conforman el camino a través de las raíces de sombra anidadas.
Devuelve la lista de selectores.
void setFromShadowDom(String... fromShadowDom)
Establece los selectores que conforman el camino a través de las raíces de sombra anidadas.
fromShadowDom: Los selectores para usar.
com.deque.html.axedevtools.selenium.AxeDriver
Interactuar con una página usando AxeDriver.
Envuelve el controlador web de Selenium para proporcionar funcionalidad específica de axe-DevTools.
AxeDriver(final WebDriver webDriver)
Crear un AxeDriver a partir de un Selenium WebDriver.
webDriver: Un Selenium WebDriver para la página que debe verificarse.
com.deque.html.axedevtools.selenium.AxeConfiguration
Configurar propiedades del script axe tales como la ubicación del archivo y configuración.
Clase Singleton, use AxeConfiguration.configure() para acceder.
// Code runs once before any tests are run
public void setupOnce() {
AxeConfiguration.configure()
.withAxeScript(axeURL)
.forAuditPath(auditURL)
.forRuleset("508")
.outputDirectory("my-axe-results");
}static AxeConfiguration configure()
Configurar una verificación de accesibilidad con axe. La única forma de obtener una instancia de AxeConfiguration.
Devuelve Un objeto de configuración para configurar el conjunto de auditoría globalmente.
static void reset()
Restablece a las preferencias predeterminadas.
AxeConfiguration forAuditSuite(final URL auditConfigPath)
Proporciona un conjunto de auditoría por su URL.
auditConfigPath: la URL asociada con el conjunto de auditoría.
Devuelve AxeConfiguration para el encadenamiento de métodos.
AxeConfiguration forAuditSuite(final String auditConfigPath) lanza MalformedURLException
Proporciona un conjunto de auditoría por su ubicación en el sistema de archivos.
auditConfigPath: La ruta absoluta del archivo de la suite de auditoría.
Devuelve AxeConfiguration para el encadenamiento de métodos.
Lanza MalformedURLException si la ruta de auditoría es una ruta no válida del sistema de archivos.
AxeConfiguration withAxeScript(URL axeScript)
Proporciona un script de núcleo de axe para usar en la verificación de accesibilidad.
axeScript: La URL asociada con el script del núcleo de axe para usar en la verificación de accesibilidad.
Devuelve AxeConfiguration para el encadenamiento de métodos.
AxeConfiguration forRuleset(final String rulesetId)
Elige qué conjunto de reglas ejecutar
rulesetId: Uno de:
wcag2wcag2.1wcag2.2wcag2aaawcag2.1aaawcag2.2aaa508ttv5en301549rgaav4
Devuelve AxeConfiguration para el encadenamiento de métodos.
AxeConfiguration forRuleset(final String rulesetId, final boolean enableBestPractices)
Elige qué conjunto de reglas ejecutar
rulesetId: Ver anterior para valores posibles.
enableBestPractices: Si se activan o no las reglas de "mejores prácticas".
Devuelve AxeConfiguration para el encadenamiento de métodos.
String getTestSuiteName()
Obtiene el nombre de la suite de pruebas.
Devuelve el nombre de la suite de pruebas.
AxeConfiguration testSuiteName(final String testSuiteName)
Establece el nombre de la suite de pruebas. Se utiliza en la generación de informes.
testSuiteName: El nombre de la suite de pruebas.
Devuelve AxeConfiguration para el encadenamiento de métodos.
String getOutputDirectory()
Obtiene el directorio de salida de informes.
Devuelve la ruta del directorio de salida.
AxeConfiguration outputDirectory(final String outputDirectory)
Establece el directorio donde se guardarán los informes.
outputDirectory: La ruta al directorio.
Devuelve AxeConfiguration para el encadenamiento de métodos.
String getUserAgent()
Obtiene el valor utilizado como agente de usuario.
Devuelve el agente de usuario utilizado en la generación de informes.
AxeConfiguration userAgent(final String userAgent)
Establece el valor usado como agente de usuario al generar un informe. No afecta al agente de usuario real utilizado al ejecutar axe.
userAgent: El valor del agente de usuario.
Devuelve AxeConfiguration para el encadenamiento de métodos.
String getTestMachine()
Obtiene el nombre de la máquina de prueba.
Devuelve el nombre de la máquina de prueba.
AxeConfiguration testMachine(final String testMachine)
Establece el nombre de la máquina de prueba. Se usa en la generación de informes.
testMachine: El nombre de la máquina de prueba.
Devuelve AxeConfiguration para el encadenamiento de métodos.
com.deque.html.axedevtools.selenium.results.IgnoredViolation
IgnoredViolation(final String cssSelector, final String ruleId)
Crear una violación para ignorar.
cssSelector: Selector del nodo a ignorar. Compara con el objetivo de cada nodo.
ruleId: ID de la regla a ignorar
com.deque.html.axedevtools.selenium.reporter.AxeReportingOptions implements ReportingOptions
Configura opciones de informes. Toma los valores predeterminados de AxeConfiguration.
AxeReportingOptions()
Crea un AxeReportingOptions
static AxeReportingOptions defaultAuditReportingOptions()
Obtiene las opciones predeterminadas.
Devuelve el objeto de opciones predeterminado.
String getSuiteTestName()
Obtiene el nombre configurado de la suite de prueba.
Devuelve el nombre.
AxeReportingOptions testSuiteName(final String testSuiteName)
Describe la suite de prueba.
testSuiteName: Nombre de la suite de prueba.
Devuelve ReportingOptions para el encadenamiento de métodos.
String getUiState()
Obtiene el estado de la UI configurado.
Devuelve el estado.
AxeReportingOptions uiState(final String uiState)
Describe el estado de la UI durante la verificación de accesibilidad.
uiState: Estado de la UI.
Devuelve ReportingOptions para el encadenamiento de métodos.
String getOutputDirectory()
Obtiene el directorio de salida configurado.
Devuelve el directorio.
AxeReportingOptions outputDirectory(final String outputDirectory)
Establece el directorio de salida raíz para generar el informe de accesibilidad.
outputDirectory: Ruta del directorio.
Devuelve ReportingOptions para el encadenamiento de métodos.
String getFileName()
Nombre de archivo calculado a partir de los valores configurados.
Devuelve el nombre del archivo
String getFilePath(final String extension)
Calcula la ruta del archivo a partir de los valores configurados.
Devuelve la ruta.
String getUserAgent()
Obtiene el agente de usuario configurado.
Devuelve el agente de usuario.
AxeReportingOptions userAgent(final String userAgent)
Describa el agente de usuario utilizado para realizar la prueba de accesibilidad.
userAgent: Nombre del agente de usuario.
Devuelve ReportingOptions para el encadenamiento de métodos.
String getTestMachine()
Obtiene la máquina de prueba configurada.
Devuelve la máquina de prueba.
AxeReportingOptions testMachine(final String testMachine)
Describa la máquina utilizada para realizar la prueba de accesibilidad.
testMachine: Nombre de la máquina.
Devuelve ReportingOptions para el encadenamiento de métodos.
AxeReportingOptions lineNum(final String lineNum)
Especificar el número de línea de la prueba actual.
lineNum: Número de línea de la prueba actual.
Devuelve ReportingOptions para el encadenamiento de métodos.
ReportingOptions lineNumIfEmpty(final String lineNum)
Especificar el número de línea, si aún no se ha establecido.
lineNum: Número de línea de la prueba actual.
Devuelve ReportingOptions para el encadenamiento de métodos.
com.deque.html.axedevtools.selenium.reporter.MissingUIStateException
Excepción para cuando falta el estado de la interfaz de usuario.
com.deque.html.axedevtools.selenium.results.ResultsFilter
Configura las violaciones a ignorar.
ResultsFilter filter = new ResultsFilter()
.ignoring(".third-party-iframe", "label");
Results results = new AxeSelenium(axe, configuration, filter, reporter)
.run(driver);Results filterIgnoredViolations(final Results results)
Filtra los resultados para eliminar las violaciones ignoradas.
results: resultados para filtrar.
Devuelve resultados entrantes, filtrados por selectores CSS + Id de reglas ignorados.
ResultsFilter ignoring(final String cssSelector, final String ruleId)
Añadir una violación ignorada.
cssSelector: Selector CSS producido al ejecutar el conjunto de Accesibilidad/Auditoría.
ruleId: ID de regla producido al ejecutar el conjunto de Accesibilidad/Auditoría.
Devuelve ResultsFilter para el encadenamiento de métodos.
com.deque.html.axedevtools.reporter.AxeDevtoolsReporter
Configura opciones de reporte al usar coincidentes hamcrest.
AxeDevtoolsReporter reporter = new AxeDevtoolsReporter();
assertThat(axeDevtoolsSelenium, isAxeClean(axeSelenium, reporter));AxeDevtoolsReporter()
Construir un AxeDevtoolsReporter
String generateReport(final Results results, final String executedCommand)
Crear una representación en cadena de la verificación de accesibilidad.
results: Resultados de la verificación de auditoría.
executedCommand: Comando ejecutado para producir resultados de la auditoría.
Devuelve un informe legible de las violaciones de accesibilidad encontradas.
void report(final ReportingOptions reportingOptions, final Results results, final String executedCommand)
Informar sobre la verificación de accesibilidad. Anexar informe al archivo de registro de resultados por fecha. Almacenar resultados completos como archivo JSON.
reportingOptions: Opciones para registrar el informe.
results: Resultados de la verificación de auditoría.
executedCommand: Comando ejecutado para producir resultados de la auditoría.
com.deque.html.axedevtools.reporter.TestResultsGenerator
Genera un TestResults a partir de un Results y ReportingOptions.
Usado con el AxeDevtoolsReporter
TestResults generate(final ReportingOptions reportingOptions, final Results results)
Genera el {@link TestResults}.
reportingOptions: Opciones de las que creamos nuestros resultados.
results: Resultados de ejecutar axe.
Devuelve la prueba
com.deque.html.axedevtools.reporter.ViolationsReporter
Informes solo sobre infracciones.
com.deque.html.axedevtools.utils.FileUtils
Utilidades de archivo para uso interno.