Charon/docs/troubleshooting/e2e-tests.md

E2E Test Troubleshooting

Common issues and solutions for Playwright E2E tests.

---

Quick Diagnostics

Run these commands first:

# Check emergency token is set
grep CHARON_EMERGENCY_TOKEN .env

# Verify token length
echo -n "$(grep CHARON_EMERGENCY_TOKEN .env | cut -d= -f2)" | wc -c
# Should output: 64

# Check Docker container is running
docker ps | grep charon

# Check health endpoint
curl -f http://localhost:8080/api/v1/health || echo "Health check failed"

---

Error: "CHARON_EMERGENCY_TOKEN is not set"

Symptoms

• Tests fail immediately with environment configuration error
• Error appears in global setup before any tests run

Cause

Emergency token not configured in .env file.

Solution

1. Generate token:

   openssl rand -hex 32
   

2. Add to .env file:

   echo "CHARON_EMERGENCY_TOKEN=<paste_token_here>" >> .env
   

3. Verify:

   grep CHARON_EMERGENCY_TOKEN .env
   

4. Run tests:

   npx playwright test --project=chromium
   

📖 More Info: See Getting Started - Emergency Token Configuration

---

Error: "CHARON_EMERGENCY_TOKEN is too short"

Symptoms

• Global setup fails with message about token length
• Current token length shown in error (e.g., "32 chars, minimum 64")

Cause

Token is shorter than 64 characters (security requirement).

Solution

1. Regenerate token with correct length:

   openssl rand -hex 32  # Generates 64-char hex string
   

2. Update .env file:

   sed -i "s/CHARON_EMERGENCY_TOKEN=.*/CHARON_EMERGENCY_TOKEN=<new_token>/" .env
   

3. Verify length:

   echo -n "$(grep CHARON_EMERGENCY_TOKEN .env | cut -d= -f2)" | wc -c
   # Should output: 64
   

---

Error: "Failed to reset security modules using emergency token"

Symptoms

• Security teardown fails
• Causes 20+ cascading test failures
• Error message about emergency reset

Possible Causes

1. Token too short (< 64 chars)
2. Token doesn't match backend configuration
3. Backend not running or unreachable
4. Network/container issues

Solution

Step 1: Verify token configuration

# Check token exists and is 64 chars
echo -n "$(grep CHARON_EMERGENCY_TOKEN .env | cut -d= -f2)" | wc -c

# Check backend env matches (if using Docker)
docker exec charon env | grep CHARON_EMERGENCY_TOKEN

Step 2: Verify backend is running

curl http://localhost:8080/api/v1/health
# Should return: {"status":"ok"}

Step 3: Test emergency endpoint directly

curl -X POST http://localhost:8080/api/v1/emergency/security-reset \
  -H "X-Emergency-Token: $(grep CHARON_EMERGENCY_TOKEN .env | cut -d= -f2)" \
  -H "Content-Type: application/json" \
  -d '{"reason":"manual test"}' | jq

Step 4: Check backend logs

# Docker Compose
docker compose logs charon | tail -50

# Docker Run
docker logs charon | tail -50

Step 5: Regenerate token if needed

# Generate new token
NEW_TOKEN=$(openssl rand -hex 32)

# Update .env
sed -i "s/CHARON_EMERGENCY_TOKEN=.*/CHARON_EMERGENCY_TOKEN=${NEW_TOKEN}/" .env

# Restart backend with new token
docker restart charon

# Wait for health
sleep 5 && curl http://localhost:8080/api/v1/health

---

Error: "Blocked by access control list" (403)

Symptoms

• Most tests fail with 403 Forbidden errors
• Error message contains "Blocked by access control"

Cause

Security teardown did not successfully disable ACL before tests ran.

Solution

1. Run teardown script manually:

   npx playwright test tests/security-teardown.setup.ts
   

2. Check teardown output for errors:

   • Look for "Emergency reset successful" message
   • Verify no error messages about missing token

3. Verify ACL is disabled:

   curl http://localhost:8080/api/v1/security/status | jq
   # acl.enabled should be false
   

4. If still blocked, manually disable via API:

   # Using emergency token
   curl -X POST http://localhost:8080/api/v1/emergency/security-reset \
     -H "X-Emergency-Token: $(grep CHARON_EMERGENCY_TOKEN .env | cut -d= -f2)" \
     -H "Content-Type: application/json" \
     -d '{"reason":"manual disable before tests"}'
   

5. Run tests again:

   npx playwright test --project=chromium
   

---

Tests Pass Locally but Fail in CI/CD

Symptoms

• Tests work on your machine
• Same tests fail in GitHub Actions
• Error about missing emergency token in CI logs

Cause

CHARON_EMERGENCY_TOKEN not configured in GitHub Secrets.

Solution

1. Navigate to repository settings:

   • Go to: https://github.com/<your-org>/<your-repo>/settings/secrets/actions
   • Or: Repository → Settings → Secrets and Variables → Actions

2. Create secret:

   • Click "New repository secret"
   • Name: CHARON_EMERGENCY_TOKEN
   • Value: Generate with openssl rand -hex 32
   • Click "Add secret"

3. Verify secret is set:

   • Secret should appear in list (value is masked)
   • Cannot view value after creation (security)

4. Re-run workflow:

   • Navigate to Actions tab
   • Re-run failed workflow
   • Check "Validate Emergency Token Configuration" step passes

📖 Detailed Instructions: See GitHub Setup Guide

---

Error: "ECONNREFUSED" or "ENOTFOUND"

Symptoms

• Tests fail with connection refused errors
• Cannot reach localhost:8080 or configured base URL

Cause

Backend container not running or not accessible.

Solution

1. Check container status:

   docker ps | grep charon
   

2. If not running, start it:

   # Docker Compose
   docker compose up -d
   
   # Docker Run
   docker start charon
   

3. Wait for health:

   timeout 60 bash -c 'until curl -f http://localhost:8080/api/v1/health; do sleep 2; done'
   

4. Check logs if still failing:

   docker logs charon | tail -50
   

---

Error: Token appears to be a placeholder value

Symptoms

• Global setup validation fails
• Error mentions "placeholder value"

Cause

Token contains common placeholder strings like:

• test-emergency-token
• your_64_character
• replace_this
• 0000000000000000

Solution

1. Generate a unique token:

   openssl rand -hex 32
   

2. Replace placeholder in .env:

   sed -i "s/CHARON_EMERGENCY_TOKEN=.*/CHARON_EMERGENCY_TOKEN=<new_token>/" .env
   

3. Verify it's not a placeholder:

   grep CHARON_EMERGENCY_TOKEN .env
   # Should show a random hex string
   

---

Debug Mode

Run tests with full debugging for deeper investigation:

With Playwright Inspector

npx playwright test --debug

Interactive UI for stepping through tests.

With Full Traces

npx playwright test --trace=on

Capture execution traces for each test.

View Trace After Test

npx playwright show-trace test-results/traces/*.zip

Opens trace viewer in browser.

With Enhanced Logging

DEBUG=charon:*,charon-test:* PLAYWRIGHT_DEBUG=1 npx playwright test --project=chromium

Enables all debug output.

---

Performance Issues

Tests Running Slowly

Symptoms: Tests take > 5 minutes for full suite.

Solutions:

1. Use sharding (parallel execution):

   npx playwright test --shard=1/4 --project=chromium
   

2. Run specific test files:

   npx playwright test tests/manual-dns-provider.spec.ts
   

3. Skip slow tests during development:

   npx playwright test --grep-invert "@slow"
   

Container Startup Slow

Symptoms: Health check timeouts, tests fail before running.

Solutions:

1. Increase health check timeout:

   timeout 120 bash -c 'until curl -f http://localhost:8080/api/v1/health; do sleep 2; done'
   

2. Pre-pull Docker image:

   docker pull wikid82/charon:latest
   

3. Check Docker resource limits:

   docker stats charon
   # Ensure adequate CPU/memory
   

---

Getting Help

If you're still stuck after trying these solutions:

1. Check known issues:

   • Review E2E Triage Report
   • Search GitHub Issues

2. Collect diagnostic info:

   # Environment
   echo "OS: $(uname -a)"
   echo "Docker: $(docker --version)"
   echo "Node: $(node --version)"
   
   # Configuration
   echo "Base URL: ${PLAYWRIGHT_BASE_URL:-http://localhost:8080}"
   echo "Token set: $([ -n "$CHARON_EMERGENCY_TOKEN" ] && echo "Yes" || echo "No")"
   
   # Logs
   docker logs charon > charon-logs.txt
   npx playwright test --project=chromium > test-output.txt 2>&1
   

3. Open GitHub issue:

   • Include diagnostic info above
   • Attach charon-logs.txt and test-output.txt
   • Describe steps to reproduce
   • Tag with testing and e2e labels

4. Ask in community:

   • GitHub Discussions
   • Include relevant error messages (mask any secrets!)

---

Related Documentation

• Getting Started Guide
• GitHub Setup Guide
• E2E Triage Report
• Playwright Documentation

---

Last Updated: 2026-01-27