mirror of
https://github.com/crawlab-team/crawlab.git
synced 2026-01-21 17:21:09 +01:00
121 lines
3.7 KiB
Markdown
121 lines
3.7 KiB
Markdown
# Backend Unit Tests Status
|
|
|
|
## ⚠️ Current Status: ALL DISABLED
|
|
|
|
**All backend unit tests** (`*_test.go` files in `core/`) are currently **disabled in CI**.
|
|
|
|
## Why?
|
|
|
|
The tests throughout the backend codebase were labeled as "unit tests" but are actually **integration tests** that require infrastructure:
|
|
|
|
### Test Categories Found:
|
|
|
|
1. **Controllers** (`controllers/*_test.go`)
|
|
- Require HTTP server setup with Gin/Fizz
|
|
- Need full middleware stack (authentication, etc.)
|
|
- Test end-to-end API behavior
|
|
|
|
2. **Models/Services** (`models/client/*_test.go`, `models/service/*_test.go`)
|
|
- Require MongoDB running
|
|
- Need gRPC server setup
|
|
- Test database operations
|
|
|
|
3. **Other Infrastructure Tests**
|
|
- `grpc/server/*_test.go` - Requires gRPC + MongoDB
|
|
- `mongo/col_test.go` - Requires MongoDB
|
|
- `notification/service_test.go` - Requires MongoDB
|
|
- `fs/service_test.go` - Requires filesystem + MongoDB
|
|
|
|
4. **A Few Pure Unit Tests** (also disabled for simplicity)
|
|
- `utils/encrypt_test.go` - Pure AES encryption functions
|
|
- `utils/file_test.go`, `utils/process_test.go` - Utility functions
|
|
- `config/config_test.go` - Configuration parsing
|
|
|
|
## Key Problems
|
|
|
|
1. **Mislabeled Tests** - Integration tests running as unit tests
|
|
2. **Infrastructure Dependencies** - MongoDB, gRPC, HTTP servers required
|
|
3. **Setup Mismatches** - Test setup doesn't match production configuration
|
|
4. **False Confidence** - Tests passing/failing for wrong reasons
|
|
5. **Maintenance Burden** - Fixing broken tests that don't test the right things
|
|
|
|
## Specific Issues Identified
|
|
|
|
### Controllers
|
|
- **TestBaseController_GetList** - Missing `All` parameter support in `GetListParams`
|
|
- **TestPostUser_Success** - User context not properly set, nil pointer dereference
|
|
|
|
### Models/Services
|
|
- Both require full database + gRPC infrastructure
|
|
- Not isolated unit tests
|
|
|
|
## The Right Approach
|
|
|
|
The project **already has a proper integration test framework** in the `tests/` directory:
|
|
|
|
```bash
|
|
cd tests/
|
|
./test-runner.py --list-specs
|
|
```
|
|
|
|
Features:
|
|
- ✅ Scenario-based testing (infrastructure, dependencies, UI, API, integration)
|
|
- ✅ Docker environment detection
|
|
- ✅ Proper setup/teardown
|
|
- ✅ Real-world test scenarios
|
|
- ✅ Comprehensive documentation
|
|
|
|
## Moving Forward
|
|
|
|
### For Integration Testing
|
|
**Use the existing framework:**
|
|
```bash
|
|
cd tests/
|
|
./test-runner.py --spec specs/[category]/[test-name].md
|
|
```
|
|
|
|
See:
|
|
- `tests/TESTING_SOP.md` - Testing guidelines
|
|
- `tests/README.md` - Framework overview
|
|
- `tests/SPEC_TEMPLATE.md` - How to write test specs
|
|
|
|
### For True Unit Tests
|
|
When adding new unit tests in the future:
|
|
- ✅ Test pure functions with no dependencies
|
|
- ✅ Use table-driven tests
|
|
- ✅ Mock external dependencies
|
|
- ✅ Follow Go testing best practices
|
|
- ❌ Don't require MongoDB, gRPC, HTTP servers, etc.
|
|
|
|
### How to Re-enable
|
|
|
|
If you want to restore these tests:
|
|
|
|
1. **Don't** - They're integration tests, not unit tests
|
|
2. **Instead** - Convert them to proper integration test specs in `tests/specs/`
|
|
3. **Or** - Rewrite as true unit tests with mocked dependencies
|
|
|
|
To re-enable in CI (not recommended):
|
|
```yaml
|
|
# In .github/workflows/test.yml or docker-crawlab.yml
|
|
# Remove the "Skip backend unit tests" step
|
|
# Add back: go test ./...
|
|
```
|
|
|
|
## Philosophy
|
|
|
|
From project guidelines (`.github/copilot-instructions.md`):
|
|
> **Quality over continuity**: Well-architected solutions over preserving legacy
|
|
>
|
|
> **Breaking changes acceptable**: Not bound by API compatibility in early development
|
|
|
|
Better to have **no tests** than **misleading tests** that:
|
|
- Give false confidence
|
|
- Waste CI time
|
|
- Confuse developers about what's actually being tested
|
|
|
|
---
|
|
*Last Updated: October 9, 2025*
|
|
*Status: All backend unit tests disabled*
|
|
*Reason: Mislabeled integration tests - use `tests/` framework instead*
|