Referencia API para Selenium

Este documento es una referencia para los tipos proporcionados por el selenium paquete. La AxeSelenium clase 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 ejecuta realmente axe.

Results = new AxeSelenium()
    .include(".my-css-class")
    .skipping("aria-required-parent")
    .run(driver);

AxeSelenium()

Cree una nueva comprobación de accesibilidad AxeSelenium para un axe Driver.

AxeSelenium(final AxeBuilder axeBuilder, final AxeConfiguration axeConfiguration, final ResultsFilter resultsFilter, final AxeDevtoolsReporter reporter)

Cree una nueva comprobación de accesibilidad AxeSelenium para un axe Driver.

Results run(final AxeDriver page)

Ejecute axe contra la página usando axe.run.

page:Controlador AxeDevTools que representa la página en la que se realizará una comprobación a11y.

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 incluye(final Lista<String> selector)

Incluya un selector de iFrame.

selector:Una lista de selectores 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 su 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 excluye(final Lista<String> selector)

Excluir un selector.

selector:Una lista de selectores 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 su verificación.

Devuelve AxeSelenium para encadenamiento de métodos.

AxeSelenium accordingTo(final String... tags)

Según etiquetas de accesibilidad. Verifique solo las etiquetas de accesibilidad especificadas. Esta opción es incompatible con AxeSelenium::checkingOnly Consulte Descripciones de reglas.

tags: Lista de etiquetas para comprobar.

Devuelve AxeSelenium para encadenamiento de métodos.

AxeSelenium checkingOnly(final String... rules)

Comprobando únicamente las reglas de accesibilidad. Esta opción es incompatible con AxeSelenium::accordingTo Consulte Descripciones de reglas.

rules: Lista de reglas para la comprobación.

Devuelve AxeSelenium para encadenamiento de métodos.

AxeSelenium checking(final String... rules)

Verifique las normas de accesibilidad. Además de las etiquetas dadas, también verifique ciertas normas. Consulte Descripciones de reglas.

rules: Lista de reglas para la comprobación.

Devuelve AxeSelenium para encadenamiento de métodos.

AxeSelenium skipping(final String... rules)

Omitir las reglas de accesibilidad. Desde dentro de las etiquetas dadas, omita la comprobación de ciertas reglas. Consulte Descripciones de reglas.

rules: Lista de reglas para la comprobación.

Devuelve AxeSelenium para encadenamiento de métodos.

AxeSelenium forConfig(final URL auditConfigPath)

Proporciona una suite de auditoría por su URL.

auditConfigPath:la URL asociada con la suite de auditoría.

Devuelve AxeSelenium para encadenamiento de métodos.

AxeSelenium forConfig(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 AxeSelenium para encadenamiento de métodos.

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

AxeSelenium forRuleset(final String rulesetId)

Especifique un conjunto de reglas para la comprobación de accesibilidad. La configuración de una suite 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)

Especifique un conjunto de reglas para la comprobación de accesibilidad. La configuración de una suite 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 las violaciones de un selector y una identificación de regla determinada.

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 los resultados de la comprobación de accesibilidad una vez finalizada.

reportingOptions:Opciones que definen la serialización y la persistencia de la comprobación de accesibilidad. Devuelve AxeSelenium para encadenamiento de métodos.

boolean loggingConfigured()

Si se ha configurado o no el registro.

Devuelve si se ha configurado o no el registro.

com.deque.html.axedevtools.selenium.AxeDriver

Interactúe con una página usando AxeDriver.

Envuelve el controlador web de Selenium para proporcionar una funcionalidad específica de axe-DevTools.

AxeDriver(final WebDriver webDriver)

Cree un AxeDriver a partir de un Selenium WebDriver.

webDriver: A Selenium WebDriver para la página que debe comprobarse.

com.deque.html.axedevtools.selenium.AxeConfiguration

Configure las propiedades del script de Axe, como la ubicación del archivo y la configuración. Clase Singleton, utilice 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 comprobación de accesibilidad de axe. La única forma de obtener AxeConfiguration una instancia.

Devuelve un objeto de configuración para configurar la suite de auditoría globalmente.

static void reset()

Restablece las preferencias predeterminadas.

AxeConfiguration forAuditSuite(final URL auditConfigPath)

Proporciona una suite de auditoría por su URL.

auditConfigPath:la URL asociada con la suite 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.

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

AxeConfiguration withAxeScript(URL axeScript)

Proporciona un script básico de Axe que se utilizará para realizar la verificación de accesibilidad.

axeScript:La URL asociada con el script de Axe Core que se utilizará para la verificación de accesibilidad.

Devuelve AxeConfiguration para el encadenamiento de métodos.

AxeConfiguration forRuleset(final String rulesetId)

Elija qué conjunto de reglas ejecutar

rulesetId: Uno de:

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

Devuelve AxeConfiguration para el encadenamiento de métodos.

AxeConfiguration forRuleset(final String rulesetId, final boolean enableBestPractices)

Elija qué conjunto de reglas ejecutar

rulesetId: Ver arriba para los valores posibles.

enableBestPractices:Si activar o no las reglas de "mejores prácticas".

Devuelve AxeConfiguration para el encadenamiento de métodos.

String getTestSuiteName()

Obtiene el nombre del conjunto de pruebas.

Devuelve el nombre del conjunto de pruebas.

AxeConfiguration testSuiteName(final String testSuiteName)

Establece el nombre del conjunto de pruebas. Se utiliza para generar informes.

testSuiteName:El nombre del conjunto de pruebas.

Devuelve AxeConfiguration para el encadenamiento de métodos.

String getOutputDirectory()

Obtiene el directorio de salida del informe.

Devuelve la ruta del directorio de salida.

AxeConfiguration outputDirectory(final String outputDirectory)

Establezca el directorio donde guardar 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 utilizado 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 utiliza 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. Se compara con el objetivo de cada nodo.

ruleId: ID de la regla a ignorar

com.deque.html.axedevtools.selenium.reporter.AxeReportingOptions implementa ReportingOptions

Configura las opciones de informes. Toma 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 del conjunto de pruebas configurado.

Devuelve el nombre.

AxeReportingOptions testSuiteName(final String testSuiteName)

Describe el conjunto de pruebas.

testSuiteName: Nombre del conjunto de pruebas.

Devuelve ReportingOptions para el encadenamiento de métodos.

String getUiState()

Obtiene el estado de la interfaz de usuario configurado.

Devuelve el estado.

AxeReportingOptions uiState(final String uiState)

Describe el estado de la interfaz de usuario durante la comprobació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)

Establezca 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 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)

Describe 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)

Especifique 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)

Especifique el número de línea, si aún no se ha configurado.

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

Establece las violaciones que se deben 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)

Filtrar los resultados para eliminar las infracciones ignoradas.

results: resultados para filtrar.

Devuelve resultados entrantes, filtrados para selectores CSS ignorados + ID de reglas.

ResultsFilter ignoring(final String cssSelector, final String ruleId)

Agregar una violación ignorada.

cssSelector: Selector CSS producido al ejecutar la suite de Accesibilidad/Auditoría.

ruleId: ID de regla producida al ejecutar la suite de Accesibilidad/Auditoría.

Devuelve ResultsFilter para encadenamiento de métodos.

com.deque.html.axedevtools.reporter.AxeDevtoolsReporter

Configure las opciones de informes al utilizar los matchers de Hamcrest.

AxeDevtoolsReporter reporter = new AxeDevtoolsReporter();
assertThat(axeDevtoolsSelenium, isAxeClean(axeSelenium, reporter));

AxeDevtoolsReporter()

Construya un AxeDevtoolsReporter

String generateReport(final Results results, final String executedCommand)

Crea una representación en cadena de la comprobación de accesibilidad.

results: Resultados de la comprobación de auditoría.

executedCommand: Comando ejecutado para producir resultados de auditoría.

Devuelve un informe legible de las violaciones de accesibilidad encontradas.

void report(final ReportingOptions reportingOptions, final Results results, final String executedCommand)

Informe sobre la comprobación de accesibilidad. Añadir informe al archivo de registro de resultados por fecha. Almacenar los resultados completos como archivo JSON.

reportingOptions: Opciones para registrar el informe.

results: Resultados de la comprobación de auditoría.

executedCommand: Comando ejecutado para producir resultados de auditoría.

com.deque.html.axedevtools.reporter.TestResultsGenerator

Genera TestResults a partir de Results y ReportingOptions. Se utiliza con el AxeDevtoolsReporter

TestResults generate(final ReportingOptions reportingOptions, final Results results)

Genera el {@link TestResults}.

reportingOptions:Opciones a partir de las cuales creamos nuestros resultados.

results: Resultados del funcionamiento de axe.

Devuelve la prueba

com.deque.html.axedevtools.reporter.ViolationsReporter

Informes únicamente sobre infracciones.

com.deque.html.axedevtools.utils.FileUtils

Utilidades de archivos para uso interno.