Referencia de API para Selenium

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)

Incluir un selector.

cssSelector: Cualquier selector CSS válido.

Devuelve AxeSelenium para encadenamiento de métodos.

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.

AxeSelenium exclude(final String cssSelector)

Excluir un selector.

cssSelector: Cualquier selector CSS válido. Devuelve AxeSelenium para encadenamiento de métodos.

AxeSelenium exclude(final List<String> selector)

Excluir un selector.

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.

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)

Proveer 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

Proveer un conjunto de auditoría por su ubicación en el sistema de archivos.

auditConfigPath: La ruta absoluta del archivo del conjunto de auditoría.

Devuelve AxeSelenium para encadenamiento de métodos.

Lanza MalformedURLException si la ruta de auditoría es una ruta de sistema de archivos no válida.

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 activar 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.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)

Proveer un conjunto de auditoría por su URL.

auditConfigPath: la URL asociada con el conjunto de auditoría.

Devuelve AxeConfiguration para encadenamiento de métodos.

AxeConfiguration forAuditSuite(final String auditConfigPath) lanza MalformedURLException

Proporciona una suite 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 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 encadenamiento de métodos.

AxeConfiguration forRuleset(final String rulesetId)

Elige qué conjunto de reglas ejecutar

rulesetId: Uno de:

• wcag2
• wcag2.1
• wcag2.2
• wcag2aaa
• wcag2.1aaa
• wcag2.2aaa
• 508
• ttv5
• en301549
• rgaav4

Devuelve AxeConfiguration para 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 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 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 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 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.