Skip to content

Accept invite tests and documentation update#717

Open
Phillipe-Bojorquez wants to merge 2 commits intoChildMindInstitute:devfrom
Phillipe-Bojorquez:clean-accept-invite
Open

Accept invite tests and documentation update#717
Phillipe-Bojorquez wants to merge 2 commits intoChildMindInstitute:devfrom
Phillipe-Bojorquez:clean-accept-invite

Conversation

@Phillipe-Bojorquez
Copy link
Copy Markdown
Contributor

  • Tests for the changes have been added
  • Related documentation has been added / updated

📝 Description

🔗 Jira Ticket M2-#?
I do not have access to the CMI Jira instance to retrieve the Jira story id to include here. If someone could update this for me, I would appreciate it.

This PR enhances the Playwright E2E test suite by adding comprehensive user invitation testing capabilities and improving test maintainability through shared API helpers.

Changes include:

  • Added browser-based user invitation acceptance test (tests/e2e/specs/invitations/user-invite.spec.ts)
  • Created shared API helper classes for applets, users, invitations, and client operations
  • Added shared credential loading utility (tests/utils/credentials.ts)
  • Updated storage state path configuration and cross-env scripts for Windows compatibility
  • Refactored existing test specs to use shared helpers instead of inline environment checks
  • Added comprehensive JSDoc documentation to all test helper functions and classes

🪤 Peer Testing

Requires yarn install

To test the changes:

  1. Verify test execution: Run the user invite test suite.

- Add browser-based user invitation acceptance test
- Create shared API classes for applets, users, invitations, and client
- Add shared credential loading utility
- Update storage state path and cross-env scripts
- Refactor specs to use shared helpers
- Add comprehensive JSDoc to API helper classes (applets, users, invitations, client)
- Document utility functions in api.ts, file.ts, loginPage.ts, userApi.ts
- Add type annotations and parameter descriptions for better IDE support
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant