docs(tests): Add comprehensive test suite documentation

- Add detailed header documentation to playwright tests
- Document test categories and flows
- Add key selector documentation
- Document state verification and alert handling
- Include code examples and usage patterns
- Add important checks and requirements

The documentation helps developers understand the foundational tests that verify
basic application functionality before running more complex test suites.
This commit is contained in:
Matthew Raymer
2025-02-16 03:29:22 +00:00
parent 5550d6a411
commit a66093028e
10 changed files with 683 additions and 516 deletions

View File

@@ -1,3 +1,33 @@
/**
* @file Invitation Flow Test
* @description Tests the end-to-end functionality of inviting a new user to TimeSafari
*
* This test verifies:
* 1. User can create a new invitation with:
* - Custom notes
* - Custom expiration date
* 2. The invitation appears in the list after creation
* 3. A new user can accept the invitation and become connected
*
* Test Flow:
* 1. Imports User 0 (test account)
* 2. Creates an invitation with:
* - Random neighbor identifier
* - 14 day expiration
* - Custom notes
* 3. Verifies the invite appears in the list
* 4. Creates a new user with Ethr DID
* 5. Accepts the invitation as the new user
* 6. Verifies the connection is established
*
* Related Files:
* - Frontend invite handling: src/libs/endorserServer.ts
* - JWT creation: sw_scripts/safari-notifications.js
*
* @see Documentation on invitation flows in usage-guide.md
* @requires @playwright/test
* @requires ./testUtils - For user management utilities
*/
import { test, expect } from '@playwright/test';
import { deleteContact, generateNewEthrUser, generateRandomString, importUser, switchToUser } from './testUtils';