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

All pages in the DSpace User Interface should have automated accessibility tests #2780

Closed
tdonohue opened this issue Jan 29, 2024 · 2 comments · Fixed by #3213
Closed

All pages in the DSpace User Interface should have automated accessibility tests #2780

tdonohue opened this issue Jan 29, 2024 · 2 comments · Fixed by #3213
Assignees
Labels
accessibility bug claimed: 4Science 4Science team is working on this issue & will contribute back e/50 Estimate in hours funded Task is funded via the DSpace Development Fund high priority
Milestone

Comments

@tdonohue
Copy link
Member

Description

As of #2711, the following User Interface pages have automated accessibility scanning (via Deque's Axe tool) enabled:

  • All current, anonymous-access pages (at least that I'm aware of)
  • Submission / MyDSpace / Workflow pages
  • Community/Collection/Item Edit pages (all tabs)
  • Login, new user registration & user menu
  • Admin sidebar

The following pages are believed to be missing accessibility scanning:

  • All admin pages linked of Admin Sidebar not listed above.
  • Any additional features (or new features) not listed above

Proposed solution

All DSpace user interface pages / modals should have an automatic accessibility scan enabled.

  • This requires building a Cypress e2e test script for that page (if one doesn't exist), loading the page and running the testA11y() function on the page similar to the examples in Add more automated accessibility scanning to e2e tests & fix a few minor accessibility bugs #2711
  • If the testA11y() script fails (because accessibility issues exist on the page), then either the issues should be fixed or a temporary exclusion can be added to the testA11y() script until those issues can be fixed. For examples of exclusions see [submission.cy.ts](https://github.com/DSpace/dspace-angular/blob/main/cypress/e2e/submission.cy.ts)

This ticket need not be solved by a single PR. In fact, it may be easier to implement these improvements over several PRs. Therefore, multiple people can claim this ticket provided they are clear about which pages they are working on.

Related work

Related to the work in #2711, which builds on some earlier automatic accessibility scanning.

@atarix83
Copy link
Contributor

atarix83 commented Jul 1, 2024

@tdonohue @hostle83

4science is interested in working on this task.
In order to resolve the problem we're going to add an e2e test where required. Where not going to add any validation test in the new e2e created expect for the accessibility scanning.

Estimation is about 50h including any possible fixes for accessibility issues detected when the e2e test is created

@tdonohue
Copy link
Member Author

tdonohue commented Jul 1, 2024

@atarix83 : I think it's perfectly OK to only create the accessibility validation for the new e2e tests. That also has the benefit of creating a "basic scaffolding" for all pages to have more thorough e2e tests in the future (as part of a future effort).

Assigned to you and adding estimate details as a label.

@tdonohue tdonohue added e/50 Estimate in hours claimed: 4Science 4Science team is working on this issue & will contribute back funded Task is funded via the DSpace Development Fund and removed help wanted Needs a volunteer to claim to move forward labels Jul 1, 2024
@tdonohue tdonohue moved this from 📋 To Do to 🏗 In Progress in DSpace 8.x and 7.6.x Maintenance Jul 1, 2024
@github-project-automation github-project-automation bot moved this from 🏗 In Progress to ✅ Done in DSpace 8.x and 7.6.x Maintenance Oct 9, 2024
@tdonohue tdonohue added this to the 8.1 milestone Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility bug claimed: 4Science 4Science team is working on this issue & will contribute back e/50 Estimate in hours funded Task is funded via the DSpace Development Fund high priority
Projects
Development

Successfully merging a pull request may close this issue.

2 participants