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

Investigate and Update Cypress E2E Test #31

Open
NewJerseyStyle opened this issue Oct 16, 2024 · 5 comments · May be fixed by #42
Open

Investigate and Update Cypress E2E Test #31

NewJerseyStyle opened this issue Oct 16, 2024 · 5 comments · May be fixed by #42
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request

Comments

@NewJerseyStyle
Copy link
Member

Description:

The Cypress E2E test GitHub Action currently set up for testing the web server's UIs appears to be outdated and hasn't been maintained for some time. We need to determine its current functionality and identify any necessary updates.

Tasks:

  • Verify Functionality: Run the existing Cypress E2E tests to confirm whether they are still passing and accurately reflect the current UI state. Document any failures or unexpected behavior.
  • Assess Test Coverage: Evaluate the existing test suite for completeness. Are all critical UI elements and user flows adequately covered? Identify any missing tests, particularly focusing on areas that could benefit from additional verification, such as keyboard shortcuts.
  • Update Tests (if necessary): Based on the findings from the previous steps, update the Cypress tests to address any failures, improve coverage, and incorporate tests for missing functionality (e.g., keyboard shortcuts).
  • Documentation: Update the documentation to reflect any changes made to the tests and their coverage.

Expected Outcome:

A functional and up-to-date Cypress E2E test suite that provides comprehensive coverage of the web server's UI, including keyboard shortcuts and other essential user interactions. The GitHub Action should be reliable and consistently reflect the current state of the application.

Priority: Medium (Investigate and update as soon as possible to ensure test reliability)

@NewJerseyStyle NewJerseyStyle added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request labels Oct 16, 2024
@ballPointPenguin
Copy link

FYI I recently updated the github action for e2e tests in the compdem repo https://github.com/compdemocracy/polis/blob/edge/.github/workflows/cypress-tests.yml
and they are generally running and passing.
Coverage could be expanded, and libraries updated for certain.
Robust API request specs would be ⭐

@Zen-cronic
Copy link
Collaborator

Here are my findings:

Tasks:

Verify Functionality: Run the existing Cypress E2E tests to confirm whether they are still passing and accurately reflect the current UI state. Document any failures or unexpected behavior.

All the current e2e tests pass.

Assess Test Coverage: Evaluate the existing test suite for completeness. Are all critical UI elements and user flows adequately covered? Identify any missing tests, particularly focusing on areas that could benefit from additional verification, such as keyboard shortcuts.

Keyboard shortcuts are not implemented.

Update Tests (if necessary): Based on the findings from the previous steps, update the Cypress tests to address any failures, improve coverage, and incorporate tests for missing functionality (e.g., keyboard shortcuts).

We could use the @cypress/code-coverage plugin to test coverage.

Documentation: Update the documentation to reflect any changes made to the tests and their coverage.

No changes made so far.

The GitHub Action flow in this branch is already the exact same as @ballPointPenguin has updated.

Summary: we could use the cypress coverage plugin and implement keyboard shortcuts if that feature is a top-priority.

@NewJerseyStyle
Copy link
Member Author

About the feature request of testing keyboard shortcuts, it is for testing pull request #3 . However as you may notice we are pausing all PR to check our branches and decide which branch should we use for development, the implementation may not be a top-priority.

@Zen-cronic
Copy link
Collaborator

Gotcha. So, i believe we'll follow this path:

  1. decide on the dev branch
  2. merge the keyboard shortcuts pr - we should have this feature as part of our accessibility revamp (https://developer.mozilla.org/en-US/docs/Web/Accessibility/Keyboard-navigable_JavaScript_widgets)
  3. after merge, write cypress tests for the shortcuts

@NewJerseyStyle
Copy link
Member Author

Good, I will assign you on the PR after decision of dev branch, feel free to read our discussion on PR32 where we discovered the issue of the branches (a rename operation was done without announcement so we did some merge and edit on wrong branch we are trying to revert it now)

@thomassth thomassth linked a pull request Oct 19, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants