Geavanceerd API-gebruik met Ruby

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

Geavanceerd gebruik van Axe DevTools voor Web Ruby, inclusief aangepaste regels, rapportage-opties en de gebruiksservice

Not for use with personal data

Dit document bespreekt aangepaste regels, rapportage-opties en de gebruiksservice met Ruby.

Aangepaste elementen en ElementInternals

Vanaf Axe DevTools Ruby 4.13.0 lezen scans de ARIA-semantiek die webcomponenten in JavaScript declareren via ElementInternals, in plaats van alleen de role en aria-* attributen die aanwezig zijn in de markup. Er is geen configuratie vereist. Semantiek in de DOM heeft nog steeds voorrang: een expliciet role of aria-* attribuut op het element overschrijft de waarde van ElementInternals.

Uw componenten moeten hun internals publiceren om dit effect te hebben, en een component die deze in een privé klasseveld opslaat kan niet worden gelezen. Zie Aangepaste elementen testen die ElementInternals gebruiken.

Aangepaste regels

U kunt aangepaste axe-core regels specificeren in een JSON bestand.

note

Als u nog geen aangepaste regels heeft en met een leeg regelsysteem wilt beginnen, maak dan een axe-ruleset.json bestand aan in de lokale map met een leeg JavaScript-object, bijvoorbeeld: {}.

Aangepaste regels configureren via een omgevingsvariabele

De standaardconfiguratie verwacht dat de locatie van het aangepaste regelbestand config/axe-ruleset.json is, relatief ten opzichte van de huidige werkmap.

U kunt deze locatie overschrijven met de AXE_RULESET_PATH omgevingsvariabele of handmatig via de Axe DevTools-configuratie.

Stel de AXE_RULESET_PATH omgevingsvariabele in om de locatie van uw axe-ruleset.json te wijzigen:

AXE_RULESET_PATH=/path/to/your/axe-ruleset.json

Aangepaste regels configureren via Axe DevTools Configuratie

Er is een configuratieobject beschikbaar voor het definiëren van een aangepaste regellocatie met behulp van de AxeDevTools.configure methode als u niet met de AXE_RULESET_PATH omgevingsvariabele wilt werken.

Alle hieronder vermelde instellingen zijn optioneel. U kunt de gehele AxeDevTools.configure aanroep weglaten om de originele standaardwaarden te gebruiken.

AxeDevTools.configure do |config|
  # path to json configuration providing custom rules and checks
  # set defaults to "config/axe-ruleset.json"
  config.axe_ruleset_path = "config/axe-ruleset.json"

  # Configure user pre-defined standard rule sets. Custom
  # rules override these rule sets. See https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md
  config.rule_set_id = '508'
end

Rapportageopties

Rapportageopties configureren met Axe DevTools Configuratie

De axe-devtools-* gems maken het mogelijk om testresultaten te loggen. Gebruik de AxeDevTools.Configure aanroep om een globale configuratie voor rapportage in te stellen:

AxeDevTools.configure do |config|
  config.output_directory: 'my-results',
  config.test_machine: 'my-server',
  config.test_suite_name: 'Accessibility Tests For Application',
  config.user_agent: 'Headless Chrome'
end

expect(page).to be_audited_for_accessibility.logging_results({
  ui_state: 'Landing Page Load',
})

De rapportageconfiguratie kan de volgende eigenschappen hebben:

Attribuut Standaardwaarde Beschrijving
ui_state (Verplicht) Attribuut om door te geven in options object.
output_directory (Optioneel) axe-reports Naam van de map waarin de rapporten moeten worden gegenereerd.
test_machine (Optioneel) Waarde om aan te geven waar de test wordt uitgevoerd. Bijvoorbeeld, CircleCI, TesterMachine01
test_suite_name (Optioneel) axe-a11yCheck Naam van de test suite. Bijvoorbeeld, My Module Test Suite
user_agent (Optioneel) null Geef een doelgebruikersagent door. Bijvoorbeeld, chrome.
verbose (Optioneel) false Vlag om gedetailleerde logging van stack-trace en berichten in te schakelen/uit te schakelen.

Let ook op dat al de bovenstaande opties voor AxeDevTools.configure kunnen worden doorgegeven bij het configureren van de WebDriver naar keuze. Bijvoorbeeld:

require 'axe-devtools-capybara'

AxeCapybara.configure do |config|
 config.axe_config_path = 'config/my-ruleset.json'
end

Zie ook

Gebruik Service

Met de gebruiksservice kunt u inzicht krijgen in de gebruikstrends van Axe DevTools binnen uw organisatie.

Standaard is de gebruiksservice ingeschakeld, en de tracking-URL is https://usage.deque.com.

note

Gebruik in de Ruby API de enableTracking configuratie-eigenschap die hieronder beschreven wordt om het gebruiksvolgen uit te schakelen, in plaats van de AXE_TRACK_USAGE omgevingsvariabele. Als uw gebruiksgebeurtenissen Deque niet bereiken, stel de tracking-URL dan expliciet in met setTrackingUrl.

Gebruik Service-opties configureren met Axe DevTools Configuratie

De axe-devtools-* gems bieden de mogelijkheid om de gebruiksservice te configureren via een globale configuratie:

AxeDevTools.configure do |config|
  config.setTrackingUrl: 'https://usage.deque.com',
end

De gebruiksservice specifieke configuratie-eigenschappen zijn:

Attribuut Standaardwaarde Beschrijving
enableTracking true Optie om het gebruik bij te houden.
setTrackingUrl https://usage.deque.com Optie om de tracking-URL te overschrijven.
teams De teams die uw tests uitvoeren, als een array van { id: "...", name: "..." } hashes. Zie Teams.

Merk ook op dat al de bovenstaande opties voor AxeDevTools.configure ook kunnen worden doorgegeven bij het configureren van de gewenste WebDriver. Bijvoorbeeld, voor Capybara:

require 'axe-devtools-capybara'

AxeCapybara.configure do |config|
 config.enableTracking = false
end

Teams

U kunt de teams die uw tests uitvoeren vastleggen in gebruiksgebeurtenissen. Elk team is een hash met stringwaarden voor id en name. Invoeren zonder beide worden genegeerd en een lege array stuurt geen teams.

U kunt teams op drie plaatsen instellen. Indien meer dan één is ingesteld, wordt de eerste in deze lijst gebruikt:

  1. Voor een enkele RSpec-controle, de for_teams-clausule.

  2. Voor de hele run, de teams configuratie-eigenschap:

    AxeDevTools.configure do |config|
      config.teams = [{ id: "1", name: "Web" }]
    end
  3. De AXE_TEAMS omgevingsvariabele, ingesteld op een JSON-array van { "id": "...", "name": "..." } objecten of naar het pad van een JSON-bestand met een dergelijk object. Als de waarde niet kan worden gelezen, geeft de API een waarschuwing en stuurt geen teams, en de scan gaat verder.

De Cucumber-gem heeft geen optie per controle, dus gebruik de teams configuratie-eigenschap of AXE_TEAMS met Cucumber.

Gebruiksgebeurtenissen registreren ook of een persoon of een geautomatiseerde pijplijn de tests heeft uitgevoerd. De API meldt automation wanneer een algemene CI omgevingsvariabele zoals CI, GITHUB_ACTIONS of JENKINS_URL is ingesteld, en anders human. Stel AXE_ACTOR in op human of automation om dit te overschrijven.

Gebruik Service-opties configureren met omgevingsvariabelen

Daarnaast kunnen opties voor de gebruiksservice worden geconfigureerd via omgevingsvariabelen.

Naam Type Kan Override Beschrijving
AXE_DISTINCT_ID String — Een UUID-identificator die hetzelfde blijft voor de ingelogde gebruiker (tenzij deze wordt opnieuw gegenereerd). In Ruby is deze variabele genoemd DEQUE_DISTINCT_ID.
AXE_INCLUDE_TEST_RESULTS Boolean — Stel in op true om de volledige axe-core-resultaten op te nemen in het testResults-object van elk evenement (standaard is false). Wordt alleen ondersteund door de CLI en de Node.js API's.
AXE_METRICS_URL String — De URL van het REST-gebruikendpunt (standaard is https://usage.deque.com)
AXE_TRACK_USAGE Boolean — Stel in op false om rapportage van de gebruiksdienst uit te schakelen. Rapportage is standaard ingeschakeld.
AXE_ACTOR String — Stel in op human of automation om te bepalen of gebeurtenissen een persoon of een geautomatiseerde pipeline registreren als uitvoerenden van de tests. Standaard wordt automation gedetecteerd vanuit algemene CI-omgevingsvariabelen. Ondersteund door de CLI, de Node.js API's en alleen de Ruby API.
AXE_APPLICATION String false De applicatie die werd gebruikt om toegankelijkheidsfouten te controleren
AXE_DEV_INSTANCE Boolean true Geeft aan of dit evenement afkomstig is van acties van een softwareontwikkelaar. Nuttig voor het markeren en later verwijderen van evenementen die tijdens ontwikkeling of testen zijn geregistreerd.
AXE_DEPARTMENT String true De afdeling van de gebruiker binnen de organisatie
AXE_KEYCLOAK_ID String false De Keycloak-ID van de gebruiker
AXE_LOGGED_IN Boolean false Registreert of de gebruiker is ingelogd op de toepassing onder test
AXE_ORGANIZATION String true De organisatie van de gebruiker. Om uw gebruik in Axe Reports weer te geven, stel dit in op de ID van uw organisatie (neem contact op met Deque om deze te verkrijgen).
AXE_SESSION_ID String false Een UUID die de sessie van de gebruiker identificeert
AXE_TEAMS String false De teams die de tests uitvoeren, als een JSON-array van { "id": "...", "name": "..." } objecten of het pad naar een JSON-bestand dat er een bevat. Een waarde doorgegeven aan de --set-teams optie van de CLI, een setTeams methode van de Node.js API, of de for_teams clausule of teams configuratie-eigenschap van de Ruby API heeft voorrang. Alleen ondersteund door de CLI, de Node.js API's en de Ruby API.
AXE_USER_ID String false De identiteit van een specifieke gebruiker, zoals een e-mailadres, naam of inlog-ID. Axe Reports telt unieke gebruikers op basis van deze waarde.
AXE_USER_JOB_ROLE String false De functie van de gebruiker
AXE_USER_STATUS String false Statusinformatie die u aan de gebruiker wilt koppelen