Skip to content

Commit d1062c5

Browse files
authored
Update README.md
1 parent 7933cd4 commit d1062c5

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

tests/README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

2-
# Integration Tests
2+
# 🧪 Integration Tests
33

44
Automated tests for OAuth2 infrastructure components.
55

6-
## Running Tests Locally
6+
## 🚀 Running Tests Locally
77

88
```
99
@@ -12,14 +12,14 @@ chmod +x tests/test_infrastructure.sh
1212
1313
```
1414

15-
## Test Coverage
15+
## 📊 Test Coverage
1616

1717
- ✅ Token storage directory (`/var/lib/hh-token`)
1818
- ✅ systemd timer configuration (`hh-token-refresh.timer`)
1919
- ✅ nginx reverse-proxy (`/etc/nginx/sites-available/hh-oauth2`)
2020
- ✅ Docker image availability (`ghcr.io/do6pbln9l/hh-oauth2-app`)
2121

22-
## Expected Output
22+
## 📈 Expected Output
2323

2424
```
2525
@@ -50,18 +50,23 @@ Tests failed: 0
5050
5151
```
5252

53-
## CI/CD Integration
53+
## 🌐 CI/CD Integration
5454

5555
Tests run automatically in GitHub Actions on every push to `main` branch. In CI environment, system-specific checks are skipped.
5656

57-
## Adding New Tests
57+
## 📝 Adding New Tests
5858

59-
1. Create test function in `test_infrastructure.sh`
60-
2. Follow naming convention: `test_<component_name>`
61-
3. Use `test_start`, `test_pass`, `test_fail` helpers
62-
4. Add test call to `main()` function
59+
1. ✏️ Create test function in `test_infrastructure.sh`
60+
2. 🏷️ Follow naming convention: `test_<component_name>`
61+
3. 🔧 Use `test_start`, `test_pass`, `test_fail` helpers
62+
4. Add test call to `main()` function
6363

64-
## Test Environment Variables
64+
## ⚙️ Test Environment Variables
6565

66-
- `CI=true` - Skips system-specific checks (for GitHub Actions)
66+
- 🔐 `CI=true` - Skips system-specific checks (for GitHub Actions)
6767

68+
## 💡 Pro Tips
69+
70+
- Run tests before each commit to catch issues early
71+
- Use `CI=true` locally to simulate GitHub Actions environment
72+
- Check `journalctl -u hh-token-refresh.timer` for systemd logs

0 commit comments

Comments
 (0)