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

[tests-only] accessibility test for basic functionalities of file view #12155

Open
wants to merge 15 commits into
base: master
Choose a base branch
from

Conversation

koebel
Copy link
Contributor

@koebel koebel commented Feb 4, 2025

Description

setup axe core and implementation of a basic accessibility test for the basic functionalities for file view (personal space, without sidebar) as an example for what aspects of accessibility can be tested in an automatic fashion using the axe-core plugin

  • add initial test setup for axe-core
  • create feature
  • add step implementation
  • create a11y page object
  • update dependencies

Related Issue

Motivation and Context

make sure that oCIS web is compliant with the WCAG accessibility standards in light of European Accessibility Act (EAA) being implemented in June 2025

User Story
As a user with limited accessibility
I want to be able to access all features of oCIS
So that regardless of my abilities and circumstances, I can benefit from oCIS

How Has This Been Tested?

  • test cases are passing
  • currently some test cases contain excludes for components with know accessibility issues. it has been implemented in a way that these tests will fail once those issues have been fixed and the excludes can then be removed.

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Technical debt
  • Tests
  • Documentation
  • Maintenance (e.g. dependency updates or tooling)

Open tasks / next steps (won't be covered in this PR):

see also #12018 (comment)

  • decide which accessibility guidelines should be included (currently WACA & best practice, see list of all available tags offered by axe-core)
  • decide where to report findings
  • consider if/which of the following aspects should be covered with similar accessibility tests
    • login page
    • app header functionalities (search, notifications, account page, app switcher, etc)
    • left navigation sidebar of files view
    • side bar with sub menus of files view
    • shares (only functionalities that differ from personal files view)
    • spaces? (it doesn’t seem to have any unique UI elements that aren’t used in other views)
    • deleted files (trashbin)
  • refactor page object if a lot more tests get implemented, create accessibility utility function

Copy link

update-docs bot commented Feb 4, 2025

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

@koebel koebel self-assigned this Feb 4, 2025
@koebel koebel requested a review from saw-jan February 5, 2025 04:22
@koebel koebel changed the title accessibility test for basic functionalities of file view [tests-only] accessibility test for basic functionalities of file view Feb 5, 2025
tests/e2e/cucumber/features/a11y/a11y.feature Outdated Show resolved Hide resolved
tests/e2e/cucumber/features/a11y/a11y.feature Outdated Show resolved Hide resolved
tests/e2e/support/objects/a11y/actions.ts Outdated Show resolved Hide resolved
tests/e2e/cucumber/steps/ui/a11y.ts Outdated Show resolved Hide resolved
tests/e2e/support/objects/a11y/actions.ts Outdated Show resolved Hide resolved
async function (this: World, stepUser: string): Promise<void> {
const { page } = this.actorsEnvironment.getActor({ key: stepUser })

const a11yObject = new objects.a11y.Accessibility({ page })
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

confused about the name of the pageObject

tests/e2e/support/objects/a11y/actions.ts Outdated Show resolved Hide resolved
Copy link

sonarqubecloud bot commented Feb 6, 2025

@koebel koebel marked this pull request as ready for review February 6, 2025 10:39
@koebel koebel requested a review from mzner February 6, 2025 10:40
@koebel koebel added the Status:Needs-Review Needs review from a maintainer label Feb 6, 2025
@@ -54,6 +55,7 @@
"@vue/compiler-dom": "3.5.13",
"@vue/compiler-sfc": "3.5.13",
"@vue/test-utils": "2.4.6",
"axe-core": "^4.10.2",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should not be required when using @axe-core/playwright

Suggested change
"axe-core": "^4.10.2",

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status:Needs-Review Needs review from a maintainer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants