Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(role-helpers): improve coverage of logRoles fn #1248

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
247 changes: 247 additions & 0 deletions src/__tests__/__snapshots__/role-helpers.js.snap
Expand Up @@ -218,3 +218,250 @@ Name "":

--------------------------------------------------
`;

exports[`logRoles with hidden=true outputs all elements incl. hidden ones 1`] = `
region:

Name "a region":
<section
aria-label="a region"
data-testid="named-section"
/>

Name "":
<div
aria-hidden="true"
data-testid="a-hidden-div-without-a-generic-role"
role="region"
/>

Name "":
<div
data-testid="a-hidden-div-without-a-generic-role-and-with-hidden-attribute"
hidden=""
role="region"
/>

Name "":
<div
data-testid="a-hidden-div-without-a-generic-role-and-with-display-none"
role="region"
style="display: none"
/>

Name "":
<div
data-testid="a-hidden-div-without-a-generic-role-and-with-visibility-hidden"
role="region"
style="visibility: hidden"
/>

--------------------------------------------------
link:

Name "link":
<a
data-testid="a-link"
href="http://whatever.com"
/>

--------------------------------------------------
navigation:

Name "":
<nav
data-testid="a-nav"
/>

--------------------------------------------------
heading:

Name "Main Heading":
<h1
data-testid="a-h1"
/>

Name "Sub Heading":
<h2
data-testid="a-h2"
/>

Name "Tertiary Heading":
<h3
data-testid="a-h3"
/>

--------------------------------------------------
article:

Name "":
<article
data-testid="a-article"
/>

--------------------------------------------------
command:

Name "":
<menuitem
data-testid="a-menuitem-1"
/>

Name "":
<menuitem
data-testid="a-menuitem-2"
/>

--------------------------------------------------
menuitem:

Name "":
<menuitem
data-testid="a-menuitem-1"
/>

Name "":
<menuitem
data-testid="a-menuitem-2"
/>

--------------------------------------------------
list:

Name "":
<ul
data-testid="a-list"
/>

Name "":
<ul
data-testid="b-list"
/>

--------------------------------------------------
listitem:

Name "":
<li
data-testid="a-list-item-1"
/>

Name "":
<li
data-testid="a-list-item-2"
/>

Name "":
<li
data-testid="b-list-item-1"
/>

Name "":
<li
data-testid="b-list-item-2"
/>

--------------------------------------------------
table:

Name "":
<table
data-testid="a-table"
/>

--------------------------------------------------
rowgroup:

Name "":
<tbody
data-testid="a-tbody"
/>

--------------------------------------------------
row:

Name "Cell 1 Cell 2 Cell 3":
<tr
data-testid="a-row"
/>

--------------------------------------------------
cell:

Name "Cell 1":
<td
data-testid="a-cell-1"
/>

Name "Cell 2":
<td
data-testid="a-cell-2"
/>

Name "Cell 3":
<td
data-testid="a-cell-3"
/>

--------------------------------------------------
form:

Name "a form":
<form
aria-label="a form"
data-testid="named-form"
/>

--------------------------------------------------
radio:

Name "":
<input
data-testid="a-radio-1"
type="radio"
/>

Name "":
<input
data-testid="a-radio-2"
type="radio"
/>

--------------------------------------------------
textbox:

Name "":
<input
data-testid="a-input-1"
type="text"
/>

Name "":
<input
data-testid="a-input-2"
type="text"
/>

Name "":
<textarea
data-testid="a-textarea"
/>

--------------------------------------------------
term:

Name "":
<dt
data-testid="a-dt"
/>

--------------------------------------------------
definition:

Name "":
<dd
data-testid="a-dd"
/>

--------------------------------------------------
`;
47 changes: 47 additions & 0 deletions src/__tests__/role-helpers.js
Expand Up @@ -3,6 +3,7 @@ import {
logRoles,
getImplicitAriaRoles,
isInaccessible,
prettyRoles,
} from '../role-helpers'
import {render} from './helpers/test-utils'

Expand All @@ -23,6 +24,26 @@ function setup() {

<nav data-testid='a-nav' />

<div aria-hidden="true" data-testid="a-hidden-div-with-a-generic-role">
<span>Some hidden content</span>
</div>

<div aria-hidden="true" data-testid="a-hidden-div-without-a-generic-role" role="region">
naorpeled marked this conversation as resolved.
Show resolved Hide resolved
<span>Some hidden content</span>
</div>

<div data-testid="a-hidden-div-without-a-generic-role-and-with-hidden-attribute" role="region" hidden>
<span>Some hidden content</span>
</div>

<div data-testid="a-hidden-div-without-a-generic-role-and-with-display-none" role="region" style="display: none">
<span>Some hidden content</span>
</div>

<div data-testid="a-hidden-div-without-a-generic-role-and-with-visibility-hidden" role="region" style="visibility: hidden">
<span>Some hidden content</span>
</div>

<h1 data-testid='a-h1'>Main Heading</h1>
<h2 data-testid='a-h2'>Sub Heading</h2>
<h3 data-testid='a-h3'>Tertiary Heading</h3>
Expand Down Expand Up @@ -107,6 +128,19 @@ function setup() {
dt: getByTestId('a-dt'),
dd: getByTestId('a-dd'),
header: getByTestId('a-header'),
hiddenDivWithGenericRole: getByTestId('a-hidden-div-with-a-generic-role'),
hiddenDivWithoutGenericRole: getByTestId(
'a-hidden-div-without-a-generic-role',
),
hiddenDivWithoutGenericRoleAndWithHiddenAttribute: getByTestId(
'a-hidden-div-without-a-generic-role-and-with-hidden-attribute',
),
hiddenDivWithoutGenericRoleAndWithDisplayNone: getByTestId(
'a-hidden-div-without-a-generic-role-and-with-display-none',
),
hiddenDivWithoutGenericRoleAndWithVisibilityHidden: getByTestId(
'a-hidden-div-without-a-generic-role-and-with-visibility-hidden',
),
}
}

Expand Down Expand Up @@ -169,13 +203,26 @@ test('getRoles returns expected roles for various dom nodes', () => {
})
})

test('prettyRoles ignores elements with a "generic" role', () => {
const {hiddenDivWithGenericRole} = setup()
expect(prettyRoles(hiddenDivWithGenericRole, {})).toEqual('')
})

test('logRoles calls console.log with output from prettyRoles', () => {
const {namedSection} = setup()
logRoles(namedSection)
expect(console.log).toHaveBeenCalledTimes(1)
expect(console.log.mock.calls[0][0]).toMatchSnapshot()
})

test('logRoles with hidden=true outputs all elements incl. hidden ones', () => {
const {namedSection} = setup()
logRoles(namedSection, {hidden: true})

expect(console.log).toHaveBeenCalledTimes(1)
expect(console.log.mock.calls[0][0]).toMatchSnapshot()
})

test('getImplicitAriaRoles returns expected roles for various dom nodes', () => {
const {namedSection, h1, unnamedForm, radio, input} = setup()

Expand Down