How to Catch a11y Defects During Unit and E2E Testing

Rate this content
Bookmark

For developers, it is better to catch any a11y defects during unit and e2e testings. This talk is going to show how to automate a11y testing using jest and cypress.

7 min
19 Nov, 2021

Comments

Sign in or register to post your comment.

AI Generated Video Summary

This Talk provides ways to catch accessibility defects during testing, including adding accessibility testing to a website for Studio Ghibli using React, NX, Jazz, JazzX, Cypress, and CypressX. The importance of unitizing components and conducting end-to-end testing with Cypress and CypressX is emphasized to ensure accessibility. The process of setting up CypressX testing is explained, highlighting the use of typings and the CypressX support file. These tools make it easier for developers to avoid accessibility bugs during development.

1. Introduction to Accessibility Testing

Short description:

I'm going to show you some ways to catch accessibility defects during testing. Accessibility bugs are challenging to fix, especially when testing is done at the end of a project. I'll demonstrate how to add accessibility testing to a website for Studio Ghibli. The tech stack includes React, NX, Jazz, JazzX, Cypress, and CypressX.

Hello everyone, I'm going to show you some ways to catch accessibility defects during unit and end-to-end testing.

First, a bit about myself, I'm Emily, I'm a developer in Toronto, and I currently work for a company named Narwhal.

So this is how fixing accessibility bug feels like to me, basically doing a lot of patch fixes. As a developer, accessibility is the type of bug I do not wish to be assigned to. In my past projects, accessibility testing is usually done at the very end of the project, by the time I need to fix those bugs, the page is already built. It is very hard to make any structure change and move components around.

This talk will show you some ways for developers to automate some accessibility testing while we are doing the development. I'm going to show you how I add accessibility testing to this simple website I've created. It is a search engine for Studio Ghibli. Studio Ghibli is a Japanese animation company. This simple app would allow you to search any films and characters under this studio. This is what this website looks like. You can search anything, for example princess. If I enter princess here and search, it will show me any princess-related films. If I search for example Kiki here, it will show me films and characters related to Kiki. I can click the film here and it shows me the film detail.

Quickly go through the tech stack. Frontend is React. MonorepoTool is NX which is built by my company Noworld. NX is a powerful tool that will set up unit and end-to-end testing for your outdoor box. So I highly recommend you to check it out. For unit testing, I'm going to use jazz and JazzX. For end-to-end testing, I'm going to use Cypress and CypressX. For unit testing, I use Jazz and JazzX. You can install JazzX and it's typing. Use the command here. Now with JazzX installed, I need to set up. I add a setup file named Jazz.setup.js here. Inside the JazzConfig file, I need to add the key SetupFileAfterEnvironment and point to the Jazz.setup.js here. Inside Jazz.setup.js, this is what it looks like.

2. Unitizing Components and End-to-End Testing

Short description:

The setup is done. Now I want to unitize the search form component to check for accessibility violations. Developers can add similar tests to each component of the app to ensure accessibility. Let's move on to end-to-end testing with Cypress and CypressX. Here's a Cypress test for the search page.

It's very simple. You just have an import from Jazz.so.x here. And it also extends Jazz's expect function to have no violation from Jazz.x. Now the setup is done.

I want to unitize the search form component on the top here. It's a really simple search form. It has a text field and a search submit button. Currently, you have a default text to check whether it renders successfully or not.

Now I want to unitize for the component to check whether it has any accessibility violation. Note I've imported from jazz.x on the top here. Then I added unitize to check for accessibility violations. It renders the component here and then it passes the container to this x from jazz.x library. You would expect the output here to have no violations. The unit test would be very simple. It has two lines here. It's pretty easy to add. Now when I run the unit testing again, I will notice that the test failed which is actually great. It means the tests are actually working. It will show the accessibility errors in the console here.

Developer could add similar tests to each component of the app. If all the components are accessible, the entire app is more likely to be accessible. It is good that we allow developers to add accessible unit tests while just building the components. The components could be stand-alone and do not even need to show up on the browser page. This would help to avoid accessibility bug at the component level.

How about page level? I am going to talk about end-to-end testing. It is going to use Cypress and CypressX. Here are the commands to install CypressX.

I have a Cypress test for the search page, which is basically entering text in the search field. Submit the search form and make sure you redirect to the results page with the right query parameter. This is what the Cypress test looks like.

3. CypressX Testing and Accessibility

Short description:

To set up CypressX testing, add typings in the tx.config file and import from CypressX in the support file. Then, inject X in the before each statement and add the test. Check accessibility. Running the Cypress test again will show any accessibility violations on the search page. These tools make it easier for developers to avoid accessibility bugs during development.

You enter the text field and redirect to the results page. To set up CypressX testing, I need to add typings first. In the tx.config file, under compile option types, I need to add CypressX here. Also in the support file, I add the import from CypressX.

Now I am done with the CypressX testing. I am ready to add CypressX test. In the before each statement, I need to add a line to inject X here. Then I simply add the test. I just have one line. Check accessibility.

Now I run the Cypress test again. Notice it failed. I have added a console log to output accessibility violations on the search page here. This will help test app on the page level and prevent accessibility-related regression bugs. With all these tools, it will be easier for developer to avoid accessibility bug during development rather than going through them when the entire app is built. This is the end of my presentation.

Check out more articles and videos

We constantly think of articles and videos that might spark Git people interest / skill us up or help building a stellar career

TestJS Summit 2021TestJS Summit 2021
33 min
Network Requests with Cypress
Whether you're testing your UI or API, Cypress gives you all the tools needed to work with and manage network requests. This intermediate-level task demonstrates how to use the cy.request and cy.intercept commands to execute, spy on, and stub network requests while testing your application in the browser. Learn how the commands work as well as use cases for each, including best practices for testing and mocking your network requests.
TestJS Summit 2021TestJS Summit 2021
38 min
Testing Pyramid Makes Little Sense, What We Can Use Instead
Featured Video
The testing pyramid - the canonical shape of tests that defined what types of tests we need to write to make sure the app works - is ... obsolete. In this presentation, Roman Sandler and Gleb Bahmutov argue what the testing shape works better for today's web applications.


TestJS Summit 2021TestJS Summit 2021
31 min
Test Effective Development
Developers want to sleep tight knowing they didn't break production. Companies want to be efficient in order to meet their customer needs faster and to gain competitive advantage sooner. We ALL want to be cost effective... or shall I say... TEST EFFECTIVE!
But how do we do that?
Are the "unit" and "integration" terminology serves us right?
Or is it time for a change? When should we use either strategy to maximize our "test effectiveness"?
In this talk I'll show you a brand new way to think about cost effective testing with new strategies and new testing terms!
It’s time to go DEEPER!


TestJS Summit 2022TestJS Summit 2022
27 min
Full-Circle Testing With Cypress
Cypress has taken the world by storm by brining an easy to use tool for end to end testing. It’s capabilities have proven to be be useful for creating stable tests for frontend applications. But end to end testing is just a small part of testing efforts. What about your API? What about your components? Well, in my talk I would like to show you how we can start with end-to-end tests, go deeper with component testing and then move up to testing our API, circ
TestJS Summit 2022TestJS Summit 2022
20 min
Testing Web Applications with Playwright
Testing is hard, testing takes time to learn and to write, and time is money. As developers we want to test. We know we should but we don't have time. So how can we get more developers to do testing? We can create better tools.
Let me introduce you to Playwright - Reliable end-to-end cross browser testing for modern web apps, by Microsoft and fully open source. Playwright's codegen generates tests for you in JavaScript, TypeScript, Dot Net, Java or Python. Now you really have no excuses. It's time to play your tests wright.

Workshops on related topic

React Summit 2023React Summit 2023
151 min
Designing Effective Tests With React Testing Library
Featured Workshop
React Testing Library is a great framework for React component tests because there are a lot of questions it answers for you, so you don’t need to worry about those questions. But that doesn’t mean testing is easy. There are still a lot of questions you have to figure out for yourself: How many component tests should you write vs end-to-end tests or lower-level unit tests? How can you test a certain line of code that is tricky to test? And what in the world are you supposed to do about that persistent act() warning?
In this three-hour workshop we’ll introduce React Testing Library along with a mental model for how to think about designing your component tests. This mental model will help you see how to test each bit of logic, whether or not to mock dependencies, and will help improve the design of your components. You’ll walk away with the tools, techniques, and principles you need to implement low-cost, high-value component tests.
Table of contents
- The different kinds of React application tests, and where component tests fit in
- A mental model for thinking about the inputs and outputs of the components you test
- Options for selecting DOM elements to verify and interact with them
- The value of mocks and why they shouldn’t be avoided
- The challenges with asynchrony in RTL tests and how to handle them
Prerequisites
- Familiarity with building applications with React
- Basic experience writing automated tests with Jest or another unit testing framework
- You do not need any experience with React Testing Library
- Machine setup: Node LTS, Yarn
TestJS Summit 2022TestJS Summit 2022
146 min
How to Start With Cypress
Featured WorkshopFree
The web has evolved. Finally, testing has also. Cypress is a modern testing tool that answers the testing needs of modern web applications. It has been gaining a lot of traction in the last couple of years, gaining worldwide popularity. If you have been waiting to learn Cypress, wait no more! Filip Hric will guide you through the first steps on how to start using Cypress and set up a project on your own. The good news is, learning Cypress is incredibly easy. You'll write your first test in no time, and then you'll discover how to write a full end-to-end test for a modern web application. You'll learn the core concepts like retry-ability. Discover how to work and interact with your application and learn how to combine API and UI tests. Throughout this whole workshop, we will write code and do practical exercises. You will leave with a hands-on experience that you can translate to your own project.
React Summit 2022React Summit 2022
117 min
Detox 101: How to write stable end-to-end tests for your React Native application
WorkshopFree
Compared to unit testing, end-to-end testing aims to interact with your application just like a real user. And as we all know it can be pretty challenging. Especially when we talk about Mobile applications.
Tests rely on many conditions and are considered to be slow and flaky. On the other hand - end-to-end tests can give the greatest confidence that your app is working. And if done right - can become an amazing tool for boosting developer velocity.
Detox is a gray-box end-to-end testing framework for mobile apps. Developed by Wix to solve the problem of slowness and flakiness and
used by React Native itself
as its E2E testing tool.
Join me on this workshop to learn how to make your mobile end-to-end tests with Detox rock.
Prerequisites
- iOS/Android: MacOS Catalina or newer
- Android only: Linux
-
Install before the workshop
TestJS Summit - January, 2021TestJS Summit - January, 2021
173 min
Testing Web Applications Using Cypress
WorkshopFree
This workshop will teach you the basics of writing useful end-to-end tests using Cypress Test Runner.
We will cover writing tests, covering every application feature, structuring tests, intercepting network requests, and setting up the backend data.
Anyone who knows JavaScript programming language and has NPM installed would be able to follow along.


React Summit 2023React Summit 2023
109 min
Web Accessibility for Ninjas: A Practical Approach for Creating Accessible Web Applications
Workshop
In this hands-on workshop, we’ll equip you with the tools and techniques you need to create accessible web applications. We’ll explore the principles of inclusive design and learn how to test our websites using assistive technology to ensure that they work for everyone.
We’ll cover topics such as semantic markup, ARIA roles, accessible forms, and navigation, and then dive into coding exercises where you’ll get to apply what you’ve learned. We’ll use automated testing tools to validate our work and ensure that we meet accessibility standards.
By the end of this workshop, you’ll be equipped with the knowledge and skills to create accessible websites that work for everyone, and you’ll have hands-on experience using the latest techniques and tools for inclusive design and testing. Join us for this awesome coding workshop and become a ninja in web accessibility and inclusive design!
TestJS Summit 2021TestJS Summit 2021
85 min
Automated accessibility testing with jest-axe and Lighthouse CI
Workshop
Do your automated tests include a11y checks? This workshop will cover how to get started with jest-axe to detect code-based accessibility violations, and Lighthouse CI to validate the accessibility of fully rendered pages. No amount of automated tests can replace manual accessibility testing, but these checks will make sure that your manual testers aren't doing more work than they need to.