How to create an Accessibility test

How to Accessibility test¶

In this how to guide you will learn how to create, deploy, and run an Accessibility test for a Platform service (Web App, User Interface etc) for your team.

Prerequisites¶

Before adding tests for your service, you will need to ensure that:

Overview¶

By completing this guide, you will have completed these actions:

Learned how to add an Accessibility test for your service.
Learned how to run an Accessibility test locally.
How to customize your pipeline to run Accessibility tests for different env.

Guide¶

Note

Every pipeline run includes steps to run varoious tests pre deployment and post deployment. These tests may include unit, integration, acceptance, performance, accessibilty etc as long as they are defined for the service.

The pipeline will check for the existence of the file .docker-compose.axe.yaml to determine if Accessibility tests have been defined.

How to add an Accessibility test for your service?¶

Refer to the ffc-demo-web example.

Requirments for local development¶

Docker Desktop 2.2.0.3 (42716) or higher

How to run an Accessibility test locally?¶

Executre the above commands in bash or PowerShell

# this will execute the docker-compose at the root folder to create an instance of the service and its dependences
docker-compose -f docker-compose.yaml -f docker-compose.axe.yaml run --rm axe

How to customize your pipeline to run Accessibility tests?¶

You can customize the environments where you would like to run Accessibility test (within the pipeline it is referred as integration test)

postDeployTest:
  envToTest: 'snd4, dev1'
  testEnvs:
    accessibilityTests: 'snd4, dev1'
  testsToRun: 'accessibility'

If not defined, the pipeline will run with following default settings.

postDeployTest:
  envToTest: 'snd4, dev1, tst1, pre1'
  testEnvs:
    accessibilityTests: 'snd4'
  testsToRun: 'owasp;accessibility;performance;service-acceptance;acceptance'

Please refer ffc-demo-web pipeline:

How to disable test?¶

if you want to disable the test for any reason please refer Disable Test