clerk-testing
tarafından clerk
Clerk kimlik doğrulama akışları için Playwright ve Cypress'te E2E test yardımcı programları. Hem Playwright hem de Cypress çerçevelerini, çerçeveye özgü kurulum desenleriyle (Playwright için globalSetup, Cypress için özel komutlar) destekler. Test ortamlarını başlatmak ve bot algılamayı atlamak için clerkSetup() ve setupClerkTestingToken() yardımcı programlarını sağlar. Test yürütme süresini azaltmak için testler arasında kimliği doğrulanmış oturumları yeniden kullanmak üzere storageState kalıcılığını içerir. Test API anahtarları (pk_test_*, ...) gerektirir.
npx skills add https://github.com/clerk/skills --skill clerk-testingTesting
Decision Tree
Mental Model
Test auth = isolated session state. Each test needs fresh auth context.
clerkSetup()initializes test environmentsetupClerkTestingToken()bypasses bot detectionstorageStatepersists auth between tests for speed
Workflow
- Identify test framework (Playwright or Cypress)
- WebFetch the appropriate URL from decision tree above
- Follow official setup instructions
- Use
pk_test_*andsk_test_*keys only
Best Practices
- Use
setupClerkTestingToken()before navigating to auth pages - Use test API keys:
pk_test_xxx,sk_test_xxx - Save auth state with
storageStatefor faster tests - Use
page.waitForSelector('[data-clerk-component]')for Clerk UI
Anti-Patterns
| Pattern | Problem | Fix |
|---|---|---|
| Production keys in tests | Security risk | Use pk_test_* keys |
No setupClerkTestingToken() | Auth fails | Call before navigation |
| UI-based sign-in every test | Slow tests | Use storageState |
Framework-Specific
Playwright: Use globalSetup for auth state
Cypress: Add addClerkCommands({ Cypress, cy }) to support file
See Also
clerk-setup- Install Clerk before adding testsclerk-nextjs-patterns- Next.js patterns being tested- Demo Repo