Merge dev to main: Security improvements and comprehensive test infrastructure #39
@@ -0,0 +1,115 @@
|
|||||||
|
name: Run Tests
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
pull_request:
|
||||||
|
branches: [main]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
backend-tests:
|
||||||
|
name: Backend Tests
|
||||||
|
runs-on: nas-runner
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
working-directory: dashboard/backend
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Set up Python
|
||||||
|
uses: actions/setup-python@v4
|
||||||
|
with:
|
||||||
|
python-version: '3.12'
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
pip install -r requirements.txt
|
||||||
|
pip install -r requirements-dev.txt
|
||||||
|
|
||||||
|
- name: Run unit tests
|
||||||
|
run: |
|
||||||
|
pytest tests/unit/ -v --cov=. --cov-report=term --cov-report=html --cov-report=xml
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Run integration tests
|
||||||
|
run: |
|
||||||
|
pytest tests/integration/ -v --cov=. --cov-append --cov-report=term --cov-report=html --cov-report=xml
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Upload backend coverage report
|
||||||
|
if: always()
|
||||||
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: backend-coverage
|
||||||
|
path: dashboard/backend/htmlcov/
|
||||||
|
|
||||||
|
- name: Upload backend coverage XML
|
||||||
|
if: always()
|
||||||
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: backend-coverage-xml
|
||||||
|
path: dashboard/backend/coverage.xml
|
||||||
|
|
||||||
|
frontend-tests:
|
||||||
|
name: Frontend Tests
|
||||||
|
runs-on: nas-runner
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
working-directory: dashboard/frontend
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Set up Node.js
|
||||||
|
uses: actions/setup-node@v3
|
||||||
|
with:
|
||||||
|
node-version: '20'
|
||||||
|
cache: 'npm'
|
||||||
|
cache-dependency-path: dashboard/frontend/package-lock.json
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Run tests with coverage
|
||||||
|
run: npm run test:coverage
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Upload frontend coverage report
|
||||||
|
if: always()
|
||||||
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: frontend-coverage
|
||||||
|
path: dashboard/frontend/coverage/
|
||||||
|
|
||||||
|
test-summary:
|
||||||
|
name: Test Summary
|
||||||
|
runs-on: nas-runner
|
||||||
|
needs: [backend-tests, frontend-tests]
|
||||||
|
if: always()
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Download backend coverage
|
||||||
|
uses: actions/download-artifact@v3
|
||||||
|
with:
|
||||||
|
name: backend-coverage-xml
|
||||||
|
path: ./backend-coverage
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Download frontend coverage
|
||||||
|
uses: actions/download-artifact@v3
|
||||||
|
with:
|
||||||
|
name: frontend-coverage
|
||||||
|
path: ./frontend-coverage
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Test Summary
|
||||||
|
run: |
|
||||||
|
echo "## Test Results" >> $GITHUB_STEP_SUMMARY
|
||||||
|
echo "" >> $GITHUB_STEP_SUMMARY
|
||||||
|
echo "✅ Backend tests completed" >> $GITHUB_STEP_SUMMARY
|
||||||
|
echo "✅ Frontend tests completed" >> $GITHUB_STEP_SUMMARY
|
||||||
|
echo "" >> $GITHUB_STEP_SUMMARY
|
||||||
|
echo "Coverage reports uploaded as artifacts." >> $GITHUB_STEP_SUMMARY
|
||||||
+295
@@ -0,0 +1,295 @@
|
|||||||
|
# Testing Guide
|
||||||
|
|
||||||
|
This document describes how to run and write tests for the NAS Dashboard project.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
The project has comprehensive test coverage for both backend (Python/FastAPI) and frontend (Svelte 5):
|
||||||
|
|
||||||
|
- **Backend**: pytest with unit and integration tests
|
||||||
|
- **Frontend**: Vitest with unit and component tests
|
||||||
|
- **CI**: Automated testing via Gitea Actions
|
||||||
|
|
||||||
|
## Backend Testing
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd dashboard/backend
|
||||||
|
pip install -r requirements.txt
|
||||||
|
pip install -r requirements-dev.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
### Running Tests
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run all tests
|
||||||
|
pytest
|
||||||
|
|
||||||
|
# Run with coverage
|
||||||
|
pytest --cov=. --cov-report=term --cov-report=html
|
||||||
|
|
||||||
|
# Run only unit tests
|
||||||
|
pytest tests/unit/ -v
|
||||||
|
|
||||||
|
# Run only integration tests
|
||||||
|
pytest tests/integration/ -v
|
||||||
|
|
||||||
|
# Run specific test file
|
||||||
|
pytest tests/unit/test_auth.py -v
|
||||||
|
|
||||||
|
# Run specific test
|
||||||
|
pytest tests/unit/test_auth.py::TestPasswordHashing::test_hash_and_verify_password -v
|
||||||
|
```
|
||||||
|
|
||||||
|
### Test Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
dashboard/backend/tests/
|
||||||
|
├── conftest.py # Shared fixtures
|
||||||
|
├── unit/
|
||||||
|
│ ├── test_auth.py # JWT, TOTP, password hashing
|
||||||
|
│ ├── test_rbac.py # Role-based access control
|
||||||
|
│ └── test_config.py # IP parsing, env validation
|
||||||
|
└── integration/
|
||||||
|
├── test_auth_flow.py # Login, refresh, logout flows
|
||||||
|
├── test_docker.py # Container operations
|
||||||
|
└── test_files.py # File operations
|
||||||
|
```
|
||||||
|
|
||||||
|
### Key Fixtures
|
||||||
|
|
||||||
|
- `mock_config`: Mocked configuration with test values
|
||||||
|
- `temp_auth_file`: Temporary auth.json for testing
|
||||||
|
- `temp_rbac_file`: Temporary rbac.json for testing
|
||||||
|
- `valid_access_token`: Valid JWT access token
|
||||||
|
- `admin_headers`: Headers with admin authentication
|
||||||
|
- `mock_docker_client`: Mocked Docker SDK client
|
||||||
|
|
||||||
|
### Writing Tests
|
||||||
|
|
||||||
|
Example unit test:
|
||||||
|
|
||||||
|
```python
|
||||||
|
def test_hash_and_verify_password(self):
|
||||||
|
"""Test that password hashing and verification works."""
|
||||||
|
password = "test_password_123"
|
||||||
|
hashed = get_password_hash(password)
|
||||||
|
|
||||||
|
assert hashed != password
|
||||||
|
assert verify_password(password, hashed)
|
||||||
|
```
|
||||||
|
|
||||||
|
Example integration test:
|
||||||
|
|
||||||
|
```python
|
||||||
|
def test_login_success_no_2fa(self, test_app, mock_config, temp_auth_file):
|
||||||
|
"""Test successful login without 2FA."""
|
||||||
|
password = "test_password"
|
||||||
|
hashed = get_password_hash(password)
|
||||||
|
save_password_hash(hashed)
|
||||||
|
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/auth/login",
|
||||||
|
json={"username": "testadmin", "password": password, "totp_code": ""}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert response.json()["user"] == "testadmin"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Frontend Testing
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd dashboard/frontend
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
### Running Tests
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run all tests
|
||||||
|
npm test
|
||||||
|
|
||||||
|
# Run with coverage
|
||||||
|
npm run test:coverage
|
||||||
|
|
||||||
|
# Run in watch mode
|
||||||
|
npm test -- --watch
|
||||||
|
|
||||||
|
# Run specific test file
|
||||||
|
npm test -- tests/unit/api.test.js
|
||||||
|
|
||||||
|
# Run with UI
|
||||||
|
npm run test:ui
|
||||||
|
```
|
||||||
|
|
||||||
|
### Test Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
dashboard/frontend/tests/
|
||||||
|
├── setup.js # Global test setup
|
||||||
|
├── unit/
|
||||||
|
│ └── api.test.js # API client tests
|
||||||
|
├── components/
|
||||||
|
│ └── Login.test.js # Login component tests
|
||||||
|
└── integration/
|
||||||
|
└── (future tests)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Mocked APIs
|
||||||
|
|
||||||
|
The test setup (`tests/setup.js`) provides mocks for:
|
||||||
|
|
||||||
|
- `fetch` - HTTP requests
|
||||||
|
- `WebSocket` - WebSocket connections
|
||||||
|
- `SpeechRecognition` / `speechSynthesis` - Web Speech API
|
||||||
|
- `navigator.credentials` - WebAuthn
|
||||||
|
- `localStorage` - Local storage
|
||||||
|
- `ResizeObserver` - Resize observer
|
||||||
|
- `MutationObserver` - Mutation observer
|
||||||
|
|
||||||
|
### Writing Tests
|
||||||
|
|
||||||
|
Example unit test:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
it('should set and get token', () => {
|
||||||
|
setToken('test-token-123');
|
||||||
|
expect(getToken()).toBe('test-token-123');
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
Example component test:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
it('should render login form', () => {
|
||||||
|
render(Login);
|
||||||
|
|
||||||
|
expect(screen.getByLabelText(/username/i)).toBeTruthy();
|
||||||
|
expect(screen.getByLabelText(/password/i)).toBeTruthy();
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Coverage Goals
|
||||||
|
|
||||||
|
- **Backend**: 80%+ overall, 95%+ for critical paths (auth, RBAC)
|
||||||
|
- **Frontend**: 70%+ overall, 80%+ for critical components
|
||||||
|
|
||||||
|
## CI Integration
|
||||||
|
|
||||||
|
Tests run automatically on:
|
||||||
|
- Push to `main` branch
|
||||||
|
- Pull requests to `main`
|
||||||
|
|
||||||
|
The CI workflow (`.gitea/workflows/test.yml`) runs:
|
||||||
|
1. Backend unit tests
|
||||||
|
2. Backend integration tests
|
||||||
|
3. Frontend tests with coverage
|
||||||
|
4. Uploads coverage reports as artifacts
|
||||||
|
|
||||||
|
### Viewing CI Results
|
||||||
|
|
||||||
|
1. Go to the Gitea repository
|
||||||
|
2. Click on "Actions" tab
|
||||||
|
3. Select the workflow run
|
||||||
|
4. Download coverage artifacts
|
||||||
|
|
||||||
|
## Common Issues
|
||||||
|
|
||||||
|
### Backend Tests
|
||||||
|
|
||||||
|
**Issue**: `ModuleNotFoundError: No module named 'fastapi'`
|
||||||
|
**Solution**: Install dependencies: `pip install -r requirements.txt -r requirements-dev.txt`
|
||||||
|
|
||||||
|
**Issue**: `RuntimeError: SECRET_KEY must be set`
|
||||||
|
**Solution**: Tests use mocked config, ensure `conftest.py` is loaded
|
||||||
|
|
||||||
|
**Issue**: Permission denied on temp files
|
||||||
|
**Solution**: Check that `/tmp` is writable
|
||||||
|
|
||||||
|
### Frontend Tests
|
||||||
|
|
||||||
|
**Issue**: `Cannot find module '@testing-library/svelte'`
|
||||||
|
**Solution**: Install dependencies: `npm install`
|
||||||
|
|
||||||
|
**Issue**: `ReferenceError: WebSocket is not defined`
|
||||||
|
**Solution**: Ensure `tests/setup.js` is loaded (check `vitest.config.js`)
|
||||||
|
|
||||||
|
**Issue**: Component tests fail with Svelte 5 runes
|
||||||
|
**Solution**: Use `@testing-library/svelte` v5.2.3+ which supports Svelte 5
|
||||||
|
|
||||||
|
## Best Practices
|
||||||
|
|
||||||
|
### Backend
|
||||||
|
|
||||||
|
1. **Use fixtures**: Leverage shared fixtures from `conftest.py`
|
||||||
|
2. **Mock external services**: Always mock Docker, SSH, HTTP clients
|
||||||
|
3. **Test edge cases**: Invalid inputs, expired tokens, permission errors
|
||||||
|
4. **Atomic tests**: Each test should be independent
|
||||||
|
5. **Clear test names**: Use descriptive names that explain what's being tested
|
||||||
|
|
||||||
|
### Frontend
|
||||||
|
|
||||||
|
1. **Test behavior, not implementation**: Focus on user interactions
|
||||||
|
2. **Mock API calls**: Use `vi.fn()` to mock fetch responses
|
||||||
|
3. **Test accessibility**: Use `getByRole`, `getByLabelText` from testing-library
|
||||||
|
4. **Avoid testing internal state**: Test what the user sees
|
||||||
|
5. **Keep tests simple**: One assertion per test when possible
|
||||||
|
|
||||||
|
## Debugging Tests
|
||||||
|
|
||||||
|
### Backend
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run with verbose output
|
||||||
|
pytest -vv
|
||||||
|
|
||||||
|
# Run with print statements visible
|
||||||
|
pytest -s
|
||||||
|
|
||||||
|
# Run with debugger on failure
|
||||||
|
pytest --pdb
|
||||||
|
|
||||||
|
# Run specific test with full output
|
||||||
|
pytest tests/unit/test_auth.py::TestPasswordHashing -vv -s
|
||||||
|
```
|
||||||
|
|
||||||
|
### Frontend
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run with verbose output
|
||||||
|
npm test -- --reporter=verbose
|
||||||
|
|
||||||
|
# Run in UI mode for debugging
|
||||||
|
npm run test:ui
|
||||||
|
|
||||||
|
# Run single test file in watch mode
|
||||||
|
npm test -- tests/unit/api.test.js --watch
|
||||||
|
```
|
||||||
|
|
||||||
|
## Adding New Tests
|
||||||
|
|
||||||
|
### Backend
|
||||||
|
|
||||||
|
1. Create test file in appropriate directory (`tests/unit/` or `tests/integration/`)
|
||||||
|
2. Import necessary fixtures from `conftest.py`
|
||||||
|
3. Write test classes and methods
|
||||||
|
4. Run tests to verify
|
||||||
|
|
||||||
|
### Frontend
|
||||||
|
|
||||||
|
1. Create test file in appropriate directory (`tests/unit/`, `tests/components/`, or `tests/integration/`)
|
||||||
|
2. Import necessary mocks and utilities
|
||||||
|
3. Write test cases using `describe` and `it`
|
||||||
|
4. Run tests to verify
|
||||||
|
|
||||||
|
## Resources
|
||||||
|
|
||||||
|
- [pytest documentation](https://docs.pytest.org/)
|
||||||
|
- [Vitest documentation](https://vitest.dev/)
|
||||||
|
- [Testing Library documentation](https://testing-library.com/)
|
||||||
|
- [FastAPI testing guide](https://fastapi.tiangolo.com/tutorial/testing/)
|
||||||
|
- [Svelte testing guide](https://svelte.dev/docs/testing)
|
||||||
@@ -0,0 +1,503 @@
|
|||||||
|
# Testing Infrastructure Implementation Plan
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
Add comprehensive unit and integration testing for the NAS Dashboard backend (Python/FastAPI) and frontend (Svelte 5). Currently, the codebase has zero test coverage and relies only on smoke tests and manual verification.
|
||||||
|
|
||||||
|
## Backend Testing Strategy
|
||||||
|
|
||||||
|
### 1. Testing Framework Setup
|
||||||
|
- **Framework**: pytest 8.x with pytest-asyncio for async tests
|
||||||
|
- **Coverage**: pytest-cov for coverage reporting
|
||||||
|
- **Mocking**: pytest-mock + unittest.mock
|
||||||
|
- **HTTP Testing**: httpx for TestClient (FastAPI built-in)
|
||||||
|
- **Fixtures**: Centralized fixtures for common test data
|
||||||
|
|
||||||
|
### 2. Test Structure
|
||||||
|
```
|
||||||
|
dashboard/backend/
|
||||||
|
├── tests/
|
||||||
|
│ ├── __init__.py
|
||||||
|
│ ├── conftest.py # Shared fixtures
|
||||||
|
│ ├── unit/
|
||||||
|
│ │ ├── test_auth.py # JWT, TOTP, password hashing
|
||||||
|
│ │ ├── test_rbac.py # Permission checks, role resolution
|
||||||
|
│ │ ├── test_config.py # IP parsing, env validation
|
||||||
|
│ │ └── test_utils.py # Path validation, encryption
|
||||||
|
│ └── integration/
|
||||||
|
│ ├── test_auth_flow.py # Login, refresh, logout flows
|
||||||
|
│ ├── test_docker.py # Container operations (mocked)
|
||||||
|
│ ├── test_files.py # File operations with permissions
|
||||||
|
│ ├── test_terminal.py # WebSocket terminal (mocked SSH)
|
||||||
|
│ ├── test_passkey.py # WebAuthn flows
|
||||||
|
│ └── test_security.py # Rate limiting, audit logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Key Test Areas
|
||||||
|
|
||||||
|
#### Unit Tests (High Priority)
|
||||||
|
1. **auth.py** (~300 lines to test)
|
||||||
|
- JWT token generation/validation
|
||||||
|
- Token expiry and refresh logic
|
||||||
|
- TOTP generation/verification
|
||||||
|
- Password hashing/verification
|
||||||
|
- Token version management
|
||||||
|
- Encryption/decryption (Fernet + legacy fallback)
|
||||||
|
|
||||||
|
2. **rbac.py** (~200 lines to test)
|
||||||
|
- Role resolution (admin/member/viewer)
|
||||||
|
- Page access checks
|
||||||
|
- Sidebar link filtering
|
||||||
|
- User override logic
|
||||||
|
- Atomic JSON persistence
|
||||||
|
|
||||||
|
3. **config.py** (~150 lines to test)
|
||||||
|
- IP range parsing (LAN, Tailscale, trusted proxies)
|
||||||
|
- Environment variable validation
|
||||||
|
- Default value handling
|
||||||
|
|
||||||
|
4. **Path validation utilities**
|
||||||
|
- Traversal protection
|
||||||
|
- Symlink resolution
|
||||||
|
- Blocked directory checks
|
||||||
|
|
||||||
|
#### Integration Tests (High Priority)
|
||||||
|
1. **Authentication Flow** (routers/auth.py - 316 lines)
|
||||||
|
- POST /api/auth/login → TOTP required → token issued
|
||||||
|
- POST /api/auth/refresh → new tokens
|
||||||
|
- POST /api/auth/logout → token revoked
|
||||||
|
- Proxy auth with Remote-User header
|
||||||
|
- Rate limiting enforcement
|
||||||
|
|
||||||
|
2. **Docker Operations** (routers/docker_router.py - 37 lines)
|
||||||
|
- GET /api/docker/containers → list with health status
|
||||||
|
- POST /api/docker/containers/{id}/start → admin only
|
||||||
|
- GET /api/docker/containers/{id}/logs → tail limit
|
||||||
|
|
||||||
|
3. **File Operations** (routers/files.py - 128 lines)
|
||||||
|
- GET /api/files/browse → directory listing
|
||||||
|
- POST /api/files/upload → 100MB limit, admin only
|
||||||
|
- DELETE /api/files/delete → permission checks
|
||||||
|
|
||||||
|
4. **Terminal WebSocket** (routers/terminal.py - 220 lines)
|
||||||
|
- WebSocket /ws/terminal?host=nas → auth validation
|
||||||
|
- Session reservation (max 5 global, 5 per user)
|
||||||
|
- SSH connection lifecycle (mocked)
|
||||||
|
- Keepalive ping/pong
|
||||||
|
|
||||||
|
5. **Passkey/WebAuthn** (routers/passkey.py - 188 lines)
|
||||||
|
- Registration challenge generation
|
||||||
|
- Credential verification
|
||||||
|
- Credential management
|
||||||
|
|
||||||
|
### 4. Mocking Strategy
|
||||||
|
|
||||||
|
**Docker SDK** (docker.DockerClient):
|
||||||
|
```python
|
||||||
|
@pytest.fixture
|
||||||
|
def mock_docker_client(mocker):
|
||||||
|
client = mocker.Mock()
|
||||||
|
client.containers.list.return_value = [
|
||||||
|
mocker.Mock(id="abc123", name="test-container", status="running")
|
||||||
|
]
|
||||||
|
return client
|
||||||
|
```
|
||||||
|
|
||||||
|
**asyncssh** (SSH connections):
|
||||||
|
```python
|
||||||
|
@pytest.fixture
|
||||||
|
async def mock_ssh_connection(mocker):
|
||||||
|
conn = mocker.AsyncMock()
|
||||||
|
conn.create_process.return_value = mocker.AsyncMock()
|
||||||
|
mocker.patch('asyncssh.connect', return_value=conn)
|
||||||
|
return conn
|
||||||
|
```
|
||||||
|
|
||||||
|
**httpx** (External API calls):
|
||||||
|
```python
|
||||||
|
@pytest.fixture
|
||||||
|
def mock_httpx_client(mocker):
|
||||||
|
client = mocker.AsyncMock()
|
||||||
|
mocker.patch('httpx.AsyncClient', return_value=client)
|
||||||
|
return client
|
||||||
|
```
|
||||||
|
|
||||||
|
### 5. Test Fixtures (conftest.py)
|
||||||
|
|
||||||
|
```python
|
||||||
|
@pytest.fixture
|
||||||
|
def test_app():
|
||||||
|
"""FastAPI test client with overridden dependencies"""
|
||||||
|
from main import app
|
||||||
|
return TestClient(app)
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def valid_jwt_token():
|
||||||
|
"""Generate valid JWT for testing"""
|
||||||
|
return create_access_token({"sub": "testuser", "role": "admin"})
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def mock_rbac_data():
|
||||||
|
"""Sample RBAC configuration"""
|
||||||
|
return {
|
||||||
|
"role_defaults": {"admin": {"pages": "*", "sidebar_links": "*"}},
|
||||||
|
"user_overrides": {}
|
||||||
|
}
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def temp_auth_file(tmp_path):
|
||||||
|
"""Temporary auth.json for testing"""
|
||||||
|
auth_file = tmp_path / "auth.json"
|
||||||
|
auth_file.write_text('{"totp_secrets": {}, "passkey_credentials": {}}')
|
||||||
|
return auth_file
|
||||||
|
```
|
||||||
|
|
||||||
|
### 6. Coverage Goals
|
||||||
|
- **Target**: 80%+ overall coverage
|
||||||
|
- **Critical paths**: 95%+ (auth, RBAC, path validation)
|
||||||
|
- **Routers**: 70%+ (focus on happy path + error cases)
|
||||||
|
|
||||||
|
### 7. CI Integration
|
||||||
|
Add to `.gitea/workflows/test.yml`:
|
||||||
|
```yaml
|
||||||
|
name: Backend Tests
|
||||||
|
on: [push, pull_request]
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: nas-runner
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
- name: Run pytest
|
||||||
|
run: |
|
||||||
|
cd dashboard/backend
|
||||||
|
pip install -r requirements.txt -r requirements-dev.txt
|
||||||
|
pytest --cov=. --cov-report=term --cov-report=html
|
||||||
|
- name: Upload coverage
|
||||||
|
if: always()
|
||||||
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: coverage-report
|
||||||
|
path: dashboard/backend/htmlcov/
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Frontend Testing Strategy
|
||||||
|
|
||||||
|
### 1. Testing Framework Setup
|
||||||
|
- **Framework**: Vitest 2.x (Vite-native, fast)
|
||||||
|
- **Component Testing**: @testing-library/svelte for Svelte 5
|
||||||
|
- **Mocking**: vi.mock() for modules, vi.fn() for functions
|
||||||
|
- **Coverage**: @vitest/coverage-v8
|
||||||
|
|
||||||
|
### 2. Test Structure
|
||||||
|
```
|
||||||
|
dashboard/frontend/
|
||||||
|
├── tests/
|
||||||
|
│ ├── setup.js # Global test setup
|
||||||
|
│ ├── unit/
|
||||||
|
│ │ ├── api.test.js # API client, token management
|
||||||
|
│ │ └── voice.test.js # VoiceSession class
|
||||||
|
│ ├── components/
|
||||||
|
│ │ ├── Sidebar.test.js # Navigation, drag-drop, RBAC
|
||||||
|
│ │ └── App.test.js # Routing, auth flow
|
||||||
|
│ └── integration/
|
||||||
|
│ ├── Login.test.js # Passkey + password flows
|
||||||
|
│ ├── Terminal.test.js # WebSocket, reconnection
|
||||||
|
│ ├── Docker.test.js # Container management
|
||||||
|
│ └── Files.test.js # File browser operations
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Key Test Areas
|
||||||
|
|
||||||
|
#### Unit Tests
|
||||||
|
1. **api.js** (~200 lines)
|
||||||
|
- Token storage/retrieval
|
||||||
|
- Auto-refresh on 401
|
||||||
|
- Error handling
|
||||||
|
- Request methods (get, post, put, del)
|
||||||
|
|
||||||
|
2. **voice.js** (~150 lines)
|
||||||
|
- VoiceSession state management
|
||||||
|
- STT/TTS integration (mocked)
|
||||||
|
- Language switching
|
||||||
|
- Talk mode handling
|
||||||
|
|
||||||
|
#### Component Tests
|
||||||
|
1. **App.svelte** (~400 lines)
|
||||||
|
- Initial auth check
|
||||||
|
- Page routing via query params
|
||||||
|
- Theme toggle persistence
|
||||||
|
- User info loading
|
||||||
|
|
||||||
|
2. **Sidebar.svelte** (~800 lines)
|
||||||
|
- Category rendering
|
||||||
|
- Drag-drop reordering
|
||||||
|
- Role-based link filtering
|
||||||
|
- Collapse state persistence
|
||||||
|
|
||||||
|
3. **Login.svelte** (~230 lines)
|
||||||
|
- Passkey authentication flow
|
||||||
|
- Password + TOTP flow
|
||||||
|
- Error message display
|
||||||
|
- Form validation
|
||||||
|
|
||||||
|
4. **Terminal.svelte** (~652 lines)
|
||||||
|
- WebSocket connection lifecycle
|
||||||
|
- Tab management
|
||||||
|
- Reconnection with exponential backoff
|
||||||
|
- Auth failure recovery
|
||||||
|
- Image upload (drag-drop/paste)
|
||||||
|
|
||||||
|
5. **Docker.svelte** (~133 lines)
|
||||||
|
- Container list rendering
|
||||||
|
- Start/stop/restart actions
|
||||||
|
- Log modal display
|
||||||
|
|
||||||
|
6. **Files.svelte** (~151 lines)
|
||||||
|
- Directory navigation
|
||||||
|
- File upload
|
||||||
|
- Download/delete actions
|
||||||
|
|
||||||
|
### 4. Mocking Strategy
|
||||||
|
|
||||||
|
**Fetch API**:
|
||||||
|
```javascript
|
||||||
|
beforeEach(() => {
|
||||||
|
global.fetch = vi.fn();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('login success', async () => {
|
||||||
|
fetch.mockResolvedValueOnce({
|
||||||
|
ok: true,
|
||||||
|
json: async () => ({ access_token: 'test-token' })
|
||||||
|
});
|
||||||
|
// test logic
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
**WebSocket**:
|
||||||
|
```javascript
|
||||||
|
class MockWebSocket {
|
||||||
|
constructor(url) {
|
||||||
|
this.url = url;
|
||||||
|
this.readyState = WebSocket.CONNECTING;
|
||||||
|
setTimeout(() => {
|
||||||
|
this.readyState = WebSocket.OPEN;
|
||||||
|
this.onopen?.();
|
||||||
|
}, 0);
|
||||||
|
}
|
||||||
|
send(data) { /* mock */ }
|
||||||
|
close() { /* mock */ }
|
||||||
|
}
|
||||||
|
global.WebSocket = MockWebSocket;
|
||||||
|
```
|
||||||
|
|
||||||
|
**Web Speech API**:
|
||||||
|
```javascript
|
||||||
|
global.SpeechRecognition = vi.fn(() => ({
|
||||||
|
start: vi.fn(),
|
||||||
|
stop: vi.fn(),
|
||||||
|
addEventListener: vi.fn()
|
||||||
|
}));
|
||||||
|
|
||||||
|
global.speechSynthesis = {
|
||||||
|
speak: vi.fn(),
|
||||||
|
cancel: vi.fn()
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
**xterm.js**:
|
||||||
|
```javascript
|
||||||
|
vi.mock('@xterm/xterm', () => ({
|
||||||
|
Terminal: vi.fn(() => ({
|
||||||
|
open: vi.fn(),
|
||||||
|
write: vi.fn(),
|
||||||
|
onData: vi.fn(),
|
||||||
|
dispose: vi.fn()
|
||||||
|
}))
|
||||||
|
}));
|
||||||
|
```
|
||||||
|
|
||||||
|
### 5. Test Configuration (vitest.config.js)
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
import { defineConfig } from 'vitest/config';
|
||||||
|
import { svelte } from '@sveltejs/vite-plugin-svelte';
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
|
plugins: [svelte({ hot: !process.env.VITEST })],
|
||||||
|
test: {
|
||||||
|
globals: true,
|
||||||
|
environment: 'jsdom',
|
||||||
|
setupFiles: ['./tests/setup.js'],
|
||||||
|
coverage: {
|
||||||
|
provider: 'v8',
|
||||||
|
reporter: ['text', 'html', 'lcov'],
|
||||||
|
exclude: ['node_modules/', 'tests/', 'dist/']
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### 6. Coverage Goals
|
||||||
|
- **Target**: 70%+ overall coverage
|
||||||
|
- **Critical components**: 80%+ (Terminal, Login, App)
|
||||||
|
- **API client**: 90%+ (core infrastructure)
|
||||||
|
|
||||||
|
### 7. CI Integration
|
||||||
|
Add to `.gitea/workflows/test.yml`:
|
||||||
|
```yaml
|
||||||
|
frontend-tests:
|
||||||
|
runs-on: nas-runner
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
cd dashboard/frontend
|
||||||
|
npm ci
|
||||||
|
- name: Run tests
|
||||||
|
run: |
|
||||||
|
cd dashboard/frontend
|
||||||
|
npm run test -- --coverage
|
||||||
|
- name: Upload coverage
|
||||||
|
if: always()
|
||||||
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: frontend-coverage
|
||||||
|
path: dashboard/frontend/coverage/
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Implementation Phases
|
||||||
|
|
||||||
|
### Phase 1: Backend Foundation (Priority: High)
|
||||||
|
1. Install pytest, pytest-asyncio, pytest-cov, pytest-mock
|
||||||
|
2. Create test directory structure
|
||||||
|
3. Write conftest.py with shared fixtures
|
||||||
|
4. Implement unit tests for auth.py (JWT, TOTP, encryption)
|
||||||
|
5. Implement unit tests for rbac.py (permissions, role resolution)
|
||||||
|
6. Implement unit tests for config.py (IP parsing)
|
||||||
|
|
||||||
|
**Estimated effort**: 4-6 hours
|
||||||
|
**Files created**: 6-8 test files, conftest.py, requirements-dev.txt
|
||||||
|
|
||||||
|
### Phase 2: Backend Integration Tests (Priority: High)
|
||||||
|
1. Mock Docker SDK for container tests
|
||||||
|
2. Mock asyncssh for terminal tests
|
||||||
|
3. Mock httpx for external API tests
|
||||||
|
4. Implement integration tests for auth flow (login, refresh, logout)
|
||||||
|
5. Implement integration tests for Docker operations
|
||||||
|
6. Implement integration tests for file operations
|
||||||
|
7. Implement integration tests for terminal WebSocket
|
||||||
|
|
||||||
|
**Estimated effort**: 6-8 hours
|
||||||
|
**Files created**: 7-10 integration test files
|
||||||
|
|
||||||
|
### Phase 3: Frontend Foundation (Priority: Medium)
|
||||||
|
1. Install vitest, @testing-library/svelte, @vitest/coverage-v8, jsdom
|
||||||
|
2. Create vitest.config.js
|
||||||
|
3. Create test directory structure and setup.js
|
||||||
|
4. Implement unit tests for api.js (token management, auto-refresh)
|
||||||
|
5. Implement unit tests for voice.js (VoiceSession)
|
||||||
|
|
||||||
|
**Estimated effort**: 3-4 hours
|
||||||
|
**Files created**: vitest.config.js, setup.js, 2-3 test files
|
||||||
|
|
||||||
|
### Phase 4: Frontend Component Tests (Priority: Medium)
|
||||||
|
1. Mock fetch, WebSocket, Web Speech API, xterm.js
|
||||||
|
2. Implement component tests for App.svelte (routing, auth)
|
||||||
|
3. Implement component tests for Login.svelte (passkey, password flows)
|
||||||
|
4. Implement component tests for Sidebar.svelte (drag-drop, RBAC)
|
||||||
|
5. Implement component tests for Terminal.svelte (WebSocket, reconnection)
|
||||||
|
6. Implement component tests for Docker.svelte (actions, logs)
|
||||||
|
7. Implement component tests for Files.svelte (browse, upload)
|
||||||
|
|
||||||
|
**Estimated effort**: 8-10 hours
|
||||||
|
**Files created**: 6-8 component test files
|
||||||
|
|
||||||
|
### Phase 5: CI Integration (Priority: Medium)
|
||||||
|
1. Create .gitea/workflows/test.yml
|
||||||
|
2. Configure pytest in CI with coverage reporting
|
||||||
|
3. Configure vitest in CI with coverage reporting
|
||||||
|
4. Add coverage badges to README (optional)
|
||||||
|
5. Configure coverage thresholds (fail if below target)
|
||||||
|
|
||||||
|
**Estimated effort**: 2-3 hours
|
||||||
|
**Files created**: 1 workflow file
|
||||||
|
|
||||||
|
### Phase 6: Documentation & Maintenance (Priority: Low)
|
||||||
|
1. Add TESTING.md with instructions for running tests
|
||||||
|
2. Document mocking patterns and fixtures
|
||||||
|
3. Add pre-commit hook for running tests (optional)
|
||||||
|
4. Set up coverage monitoring
|
||||||
|
|
||||||
|
**Estimated effort**: 1-2 hours
|
||||||
|
**Files created**: TESTING.md
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Dependencies to Add
|
||||||
|
|
||||||
|
### Backend (requirements-dev.txt)
|
||||||
|
```
|
||||||
|
pytest==8.3.4
|
||||||
|
pytest-asyncio==0.24.0
|
||||||
|
pytest-cov==6.0.0
|
||||||
|
pytest-mock==3.14.0
|
||||||
|
```
|
||||||
|
|
||||||
|
### Frontend (package.json devDependencies)
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"vitest": "^2.1.8",
|
||||||
|
"@testing-library/svelte": "^5.2.3",
|
||||||
|
"@vitest/coverage-v8": "^2.1.8",
|
||||||
|
"jsdom": "^25.0.1"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Success Criteria
|
||||||
|
|
||||||
|
1. **Backend**: 80%+ test coverage with all critical paths tested
|
||||||
|
2. **Frontend**: 70%+ test coverage with key components tested
|
||||||
|
3. **CI**: Tests run automatically on push/PR with coverage reports
|
||||||
|
4. **Documentation**: Clear instructions for running and writing tests
|
||||||
|
5. **Maintainability**: Fixtures and mocks are reusable and well-documented
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Risks & Mitigations
|
||||||
|
|
||||||
|
**Risk**: Tests may be slow due to Docker/SSH mocking complexity
|
||||||
|
**Mitigation**: Use lightweight mocks, avoid actual Docker/SSH connections
|
||||||
|
|
||||||
|
**Risk**: Frontend tests may be brittle due to Svelte 5 runes
|
||||||
|
**Mitigation**: Use @testing-library/svelte best practices, test behavior not implementation
|
||||||
|
|
||||||
|
**Risk**: CI runner may lack resources for parallel test execution
|
||||||
|
**Mitigation**: Run tests sequentially if needed, optimize test fixtures
|
||||||
|
|
||||||
|
**Risk**: Existing code may need refactoring for testability
|
||||||
|
**Mitigation**: Minimal refactoring, focus on testing current behavior first
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Open Questions
|
||||||
|
|
||||||
|
1. Should we add E2E tests with Playwright in addition to unit/integration tests?
|
||||||
|
- **Recommendation**: Start with unit/integration, add E2E later if needed
|
||||||
|
|
||||||
|
2. Should we enforce coverage thresholds in CI (fail build if below target)?
|
||||||
|
- **Recommendation**: Yes, but start with lenient thresholds (60%) and increase gradually
|
||||||
|
|
||||||
|
3. Should we test all 13 routers or focus on high-risk areas first?
|
||||||
|
- **Recommendation**: Focus on auth, docker, terminal, files first (80% of risk)
|
||||||
|
|
||||||
|
4. Should we mock the file system or use temporary directories?
|
||||||
|
- **Recommendation**: Use pytest's tmp_path fixture for real file operations
|
||||||
|
|
||||||
|
5. Should we test WebSocket reconnection logic in detail?
|
||||||
|
- **Recommendation**: Yes, it's complex and critical (Terminal.svelte has 652 lines)
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
pytest==8.3.4
|
||||||
|
pytest-asyncio==0.24.0
|
||||||
|
pytest-cov==6.0.0
|
||||||
|
pytest-mock==3.14.0
|
||||||
@@ -190,18 +190,31 @@ async def ws_endpoint(websocket: WebSocket, host: str = Query("nas")):
|
|||||||
rows = struct.unpack("!H", data[3:5])[0]
|
rows = struct.unpack("!H", data[3:5])[0]
|
||||||
process.channel.change_terminal_size(cols, rows)
|
process.channel.change_terminal_size(cols, rows)
|
||||||
else:
|
else:
|
||||||
|
try:
|
||||||
process.stdin.write(data)
|
process.stdin.write(data)
|
||||||
|
except (BrokenPipeError, OSError) as e:
|
||||||
|
logger.warning("Failed to write to stdin for %s: %s", host, e)
|
||||||
|
break
|
||||||
elif "text" in msg and msg["text"]:
|
elif "text" in msg and msg["text"]:
|
||||||
if msg["text"] == "__ping__":
|
if msg["text"] == "__ping__":
|
||||||
logger.debug("Received ping from %s, sending pong", host)
|
logger.debug("Received ping from %s, sending pong", host)
|
||||||
await websocket.send_text("__pong__")
|
await websocket.send_text("__pong__")
|
||||||
continue
|
continue
|
||||||
|
try:
|
||||||
process.stdin.write(msg["text"].encode())
|
process.stdin.write(msg["text"].encode())
|
||||||
|
except (BrokenPipeError, OSError) as e:
|
||||||
|
logger.warning("Failed to write to stdin for %s: %s", host, e)
|
||||||
|
break
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
logger.warning("WebSocket receive loop ended for %s: %s", host, e)
|
logger.warning("WebSocket receive loop ended for %s: %s", host, e)
|
||||||
finally:
|
finally:
|
||||||
read_task.cancel()
|
read_task.cancel()
|
||||||
|
try:
|
||||||
|
await asyncio.wait_for(read_task, timeout=2.0)
|
||||||
|
except (asyncio.TimeoutError, asyncio.CancelledError):
|
||||||
|
pass
|
||||||
process.close()
|
process.close()
|
||||||
finally:
|
finally:
|
||||||
conn.close()
|
conn.close()
|
||||||
|
await conn.wait_closed()
|
||||||
await _release_session(session_id)
|
await _release_session(session_id)
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
# Backend tests
|
||||||
@@ -0,0 +1,192 @@
|
|||||||
|
"""
|
||||||
|
Shared pytest fixtures for backend tests.
|
||||||
|
"""
|
||||||
|
import os
|
||||||
|
import json
|
||||||
|
import pytest
|
||||||
|
from datetime import timedelta
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
from unittest.mock import Mock, AsyncMock, patch
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def temp_volume_root(tmp_path):
|
||||||
|
"""Create temporary volume root for testing."""
|
||||||
|
volume_root = tmp_path / "volume1"
|
||||||
|
volume_root.mkdir()
|
||||||
|
(volume_root / "docker" / "nas-dashboard").mkdir(parents=True)
|
||||||
|
return str(volume_root)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def mock_config(temp_volume_root, monkeypatch):
|
||||||
|
"""Mock config module with test values."""
|
||||||
|
monkeypatch.setenv("SECRET_KEY", "test-secret-key-at-least-32-chars-long")
|
||||||
|
monkeypatch.setenv("ADMIN_USER", "testadmin")
|
||||||
|
monkeypatch.setenv("ADMIN_PASSWORD_HASH", "$pbkdf2-sha256$29000$N2YMIQQgBAAgxBgjhPD.vw$1234567890abcdef")
|
||||||
|
monkeypatch.setenv("VOLUME_ROOT", temp_volume_root)
|
||||||
|
monkeypatch.setenv("DOCKER_HOST", "tcp://mock-docker:2375")
|
||||||
|
monkeypatch.setenv("GITEA_URL", "http://mock-gitea:3000")
|
||||||
|
monkeypatch.setenv("GITEA_TOKEN", "mock-token")
|
||||||
|
|
||||||
|
# Reload config module to pick up new env vars
|
||||||
|
import config
|
||||||
|
import importlib
|
||||||
|
importlib.reload(config)
|
||||||
|
|
||||||
|
return config
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def temp_auth_file(temp_volume_root):
|
||||||
|
"""Create temporary auth.json file."""
|
||||||
|
auth_file = os.path.join(temp_volume_root, "docker/nas-dashboard/auth.json")
|
||||||
|
data = {
|
||||||
|
"totp_secret": "",
|
||||||
|
"passkey_credentials": [],
|
||||||
|
"token_version": 0,
|
||||||
|
"last_totp_ts": 0
|
||||||
|
}
|
||||||
|
with open(auth_file, "w") as f:
|
||||||
|
json.dump(data, f)
|
||||||
|
return auth_file
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def temp_rbac_file(temp_volume_root):
|
||||||
|
"""Create temporary rbac.json file."""
|
||||||
|
rbac_file = os.path.join(temp_volume_root, "docker/nas-dashboard/rbac.json")
|
||||||
|
data = {
|
||||||
|
"role_defaults": {
|
||||||
|
"admin": {"pages": "*", "sidebar_links": "*"},
|
||||||
|
"member": {"pages": ["dashboard", "docker"], "sidebar_links": "*"},
|
||||||
|
"viewer": {"pages": ["dashboard"], "sidebar_links": ["dashboard"]}
|
||||||
|
},
|
||||||
|
"user_overrides": {}
|
||||||
|
}
|
||||||
|
with open(rbac_file, "w") as f:
|
||||||
|
json.dump(data, f)
|
||||||
|
return rbac_file
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def valid_access_token(mock_config):
|
||||||
|
"""Generate a valid access token for testing."""
|
||||||
|
from auth import create_access_token
|
||||||
|
return create_access_token(
|
||||||
|
data={"sub": "testuser", "role": "admin"},
|
||||||
|
expires_delta=timedelta(minutes=30)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def valid_refresh_token(mock_config, temp_auth_file):
|
||||||
|
"""Generate a valid refresh token for testing."""
|
||||||
|
from auth import create_refresh_token
|
||||||
|
return create_refresh_token(data={"sub": "testuser", "role": "admin"})
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def expired_access_token(mock_config):
|
||||||
|
"""Generate an expired access token for testing."""
|
||||||
|
from auth import create_access_token
|
||||||
|
return create_access_token(
|
||||||
|
data={"sub": "testuser", "role": "admin"},
|
||||||
|
expires_delta=timedelta(seconds=-1)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def mock_docker_client():
|
||||||
|
"""Mock Docker client for testing."""
|
||||||
|
client = Mock()
|
||||||
|
|
||||||
|
# Mock container
|
||||||
|
container = Mock()
|
||||||
|
container.id = "abc123"
|
||||||
|
container.name = "test-container"
|
||||||
|
container.status = "running"
|
||||||
|
container.attrs = {
|
||||||
|
"State": {"Health": {"Status": "healthy"}},
|
||||||
|
"Config": {"Image": "test-image:latest"}
|
||||||
|
}
|
||||||
|
container.logs.return_value = b"test log line 1\ntest log line 2\n"
|
||||||
|
|
||||||
|
client.containers.list.return_value = [container]
|
||||||
|
client.containers.get.return_value = container
|
||||||
|
|
||||||
|
return client
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def mock_ssh_connection():
|
||||||
|
"""Mock asyncssh connection for testing."""
|
||||||
|
conn = AsyncMock()
|
||||||
|
process = AsyncMock()
|
||||||
|
process.stdout = AsyncMock()
|
||||||
|
process.stdin = AsyncMock()
|
||||||
|
process.stderr = AsyncMock()
|
||||||
|
conn.create_process.return_value = process
|
||||||
|
return conn
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def mock_httpx_client():
|
||||||
|
"""Mock httpx AsyncClient for testing."""
|
||||||
|
client = AsyncMock()
|
||||||
|
response = AsyncMock()
|
||||||
|
response.status_code = 200
|
||||||
|
response.json.return_value = {"status": "ok"}
|
||||||
|
client.get.return_value = response
|
||||||
|
client.post.return_value = response
|
||||||
|
return client
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def test_app(mock_config, temp_auth_file, temp_rbac_file, mock_docker_client):
|
||||||
|
"""Create FastAPI test client with mocked dependencies."""
|
||||||
|
# Patch Docker client before importing main
|
||||||
|
with patch("docker.DockerClient", return_value=mock_docker_client):
|
||||||
|
from main import app
|
||||||
|
client = TestClient(app)
|
||||||
|
yield client
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def admin_headers(valid_access_token):
|
||||||
|
"""Headers with admin access token."""
|
||||||
|
return {"Authorization": f"Bearer {valid_access_token}"}
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def mock_rbac_data():
|
||||||
|
"""Sample RBAC configuration for testing."""
|
||||||
|
return {
|
||||||
|
"role_defaults": {
|
||||||
|
"admin": {"pages": "*", "sidebar_links": "*"},
|
||||||
|
"member": {"pages": ["dashboard", "docker", "files"], "sidebar_links": "*"},
|
||||||
|
"viewer": {"pages": ["dashboard"], "sidebar_links": ["dashboard"]}
|
||||||
|
},
|
||||||
|
"user_overrides": {
|
||||||
|
"customuser": {
|
||||||
|
"pages": ["dashboard", "docker"],
|
||||||
|
"sidebar_links": ["dashboard", "docker", "files"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def sample_totp_secret():
|
||||||
|
"""Sample TOTP secret for testing."""
|
||||||
|
return "JBSWY3DPEHPK3PXP" # Base32 encoded secret
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def mock_request():
|
||||||
|
"""Mock FastAPI Request object."""
|
||||||
|
request = Mock()
|
||||||
|
request.client = Mock()
|
||||||
|
request.client.host = "192.168.31.100"
|
||||||
|
request.headers = {}
|
||||||
|
return request
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
# Integration tests
|
||||||
@@ -0,0 +1,318 @@
|
|||||||
|
"""
|
||||||
|
Integration tests for authentication flow.
|
||||||
|
"""
|
||||||
|
import pytest
|
||||||
|
import pyotp
|
||||||
|
from fastapi import status
|
||||||
|
from auth import get_password_hash, save_totp_secret, save_password_hash
|
||||||
|
|
||||||
|
|
||||||
|
class TestLoginFlow:
|
||||||
|
"""Test login endpoint."""
|
||||||
|
|
||||||
|
def test_login_success_no_2fa(self, test_app, mock_config, temp_auth_file):
|
||||||
|
"""Test successful login without 2FA."""
|
||||||
|
# Set up password
|
||||||
|
password = "test_password"
|
||||||
|
hashed = get_password_hash(password)
|
||||||
|
save_password_hash(hashed)
|
||||||
|
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/auth/login",
|
||||||
|
json={"username": "testadmin", "password": password, "totp_code": ""}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
data = response.json()
|
||||||
|
assert data["user"] == "testadmin"
|
||||||
|
assert data["role"] == "admin"
|
||||||
|
assert data["has_2fa"] is False
|
||||||
|
assert "access_token" in data
|
||||||
|
assert "refresh_token" in data
|
||||||
|
assert data["token_type"] == "bearer"
|
||||||
|
|
||||||
|
def test_login_success_with_2fa(self, test_app, mock_config, temp_auth_file, sample_totp_secret):
|
||||||
|
"""Test successful login with 2FA."""
|
||||||
|
password = "test_password"
|
||||||
|
hashed = get_password_hash(password)
|
||||||
|
save_password_hash(hashed)
|
||||||
|
save_totp_secret(sample_totp_secret)
|
||||||
|
|
||||||
|
totp = pyotp.TOTP(sample_totp_secret)
|
||||||
|
valid_code = totp.now()
|
||||||
|
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/auth/login",
|
||||||
|
json={"username": "testadmin", "password": password, "totp_code": valid_code}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
data = response.json()
|
||||||
|
assert data["user"] == "testadmin"
|
||||||
|
assert data["has_2fa"] is True
|
||||||
|
|
||||||
|
def test_login_wrong_password(self, test_app, mock_config, temp_auth_file):
|
||||||
|
"""Test login with wrong password."""
|
||||||
|
password = "correct_password"
|
||||||
|
hashed = get_password_hash(password)
|
||||||
|
save_password_hash(hashed)
|
||||||
|
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/auth/login",
|
||||||
|
json={"username": "testadmin", "password": "wrong_password", "totp_code": ""}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
assert "Invalid credentials" in response.json()["detail"]
|
||||||
|
|
||||||
|
def test_login_wrong_username(self, test_app, mock_config, temp_auth_file):
|
||||||
|
"""Test login with wrong username."""
|
||||||
|
password = "test_password"
|
||||||
|
hashed = get_password_hash(password)
|
||||||
|
save_password_hash(hashed)
|
||||||
|
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/auth/login",
|
||||||
|
json={"username": "wronguser", "password": password, "totp_code": ""}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
def test_login_missing_2fa_code(self, test_app, mock_config, temp_auth_file, sample_totp_secret):
|
||||||
|
"""Test login with 2FA enabled but no code provided."""
|
||||||
|
password = "test_password"
|
||||||
|
hashed = get_password_hash(password)
|
||||||
|
save_password_hash(hashed)
|
||||||
|
save_totp_secret(sample_totp_secret)
|
||||||
|
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/auth/login",
|
||||||
|
json={"username": "testadmin", "password": password, "totp_code": ""}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 403
|
||||||
|
assert "2FA code required" in response.json()["detail"]
|
||||||
|
|
||||||
|
def test_login_invalid_2fa_code(self, test_app, mock_config, temp_auth_file, sample_totp_secret):
|
||||||
|
"""Test login with invalid 2FA code."""
|
||||||
|
password = "test_password"
|
||||||
|
hashed = get_password_hash(password)
|
||||||
|
save_password_hash(hashed)
|
||||||
|
save_totp_secret(sample_totp_secret)
|
||||||
|
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/auth/login",
|
||||||
|
json={"username": "testadmin", "password": password, "totp_code": "000000"}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
def test_login_sets_cookies(self, test_app, mock_config, temp_auth_file):
|
||||||
|
"""Test that login sets auth cookies."""
|
||||||
|
password = "test_password"
|
||||||
|
hashed = get_password_hash(password)
|
||||||
|
save_password_hash(hashed)
|
||||||
|
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/auth/login",
|
||||||
|
json={"username": "testadmin", "password": password, "totp_code": ""}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
# Check that cookies are set
|
||||||
|
assert "nas_access_token" in response.cookies
|
||||||
|
assert "nas_refresh_token" in response.cookies
|
||||||
|
|
||||||
|
|
||||||
|
class TestRefreshFlow:
|
||||||
|
"""Test token refresh endpoint."""
|
||||||
|
|
||||||
|
def test_refresh_with_valid_token(self, test_app, mock_config, temp_auth_file, valid_refresh_token):
|
||||||
|
"""Test refreshing with valid refresh token."""
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/auth/refresh",
|
||||||
|
json={"refresh_token": valid_refresh_token}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
data = response.json()
|
||||||
|
assert "access_token" in data
|
||||||
|
assert "refresh_token" in data
|
||||||
|
assert data["access_token"] != valid_refresh_token
|
||||||
|
|
||||||
|
def test_refresh_with_cookie(self, test_app, mock_config, temp_auth_file, valid_refresh_token):
|
||||||
|
"""Test refreshing with refresh token in cookie."""
|
||||||
|
test_app.cookies.set("nas_refresh_token", valid_refresh_token)
|
||||||
|
|
||||||
|
response = test_app.post("/api/auth/refresh", json={})
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
data = response.json()
|
||||||
|
assert "access_token" in data
|
||||||
|
|
||||||
|
def test_refresh_with_invalid_token(self, test_app, mock_config, temp_auth_file):
|
||||||
|
"""Test refreshing with invalid token."""
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/auth/refresh",
|
||||||
|
json={"refresh_token": "invalid.token.here"}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
def test_refresh_with_expired_token(self, test_app, mock_config, temp_auth_file, expired_access_token):
|
||||||
|
"""Test refreshing with expired token."""
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/auth/refresh",
|
||||||
|
json={"refresh_token": expired_access_token}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
def test_refresh_missing_token(self, test_app, mock_config, temp_auth_file):
|
||||||
|
"""Test refresh without providing token."""
|
||||||
|
response = test_app.post("/api/auth/refresh", json={})
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
assert "Missing refresh token" in response.json()["detail"]
|
||||||
|
|
||||||
|
def test_refresh_with_access_token_fails(self, test_app, mock_config, temp_auth_file, valid_access_token):
|
||||||
|
"""Test that access token cannot be used for refresh."""
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/auth/refresh",
|
||||||
|
json={"refresh_token": valid_access_token}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
assert "Invalid token type" in response.json()["detail"]
|
||||||
|
|
||||||
|
|
||||||
|
class TestLogoutFlow:
|
||||||
|
"""Test logout endpoint."""
|
||||||
|
|
||||||
|
def test_logout_success(self, test_app, mock_config, temp_auth_file, admin_headers):
|
||||||
|
"""Test successful logout."""
|
||||||
|
response = test_app.post("/api/auth/logout", headers=admin_headers)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
data = response.json()
|
||||||
|
assert data["message"] == "Logged out successfully"
|
||||||
|
|
||||||
|
def test_logout_clears_cookies(self, test_app, mock_config, temp_auth_file, admin_headers):
|
||||||
|
"""Test that logout clears auth cookies."""
|
||||||
|
response = test_app.post("/api/auth/logout", headers=admin_headers)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
# Cookies should be deleted (max-age=0 or expires in past)
|
||||||
|
# TestClient doesn't fully simulate cookie deletion, but we can check response
|
||||||
|
|
||||||
|
def test_logout_without_auth(self, test_app, mock_config, temp_auth_file):
|
||||||
|
"""Test logout without authentication."""
|
||||||
|
response = test_app.post("/api/auth/logout")
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
|
||||||
|
class TestUserInfo:
|
||||||
|
"""Test user info endpoint."""
|
||||||
|
|
||||||
|
def test_get_user_info(self, test_app, mock_config, temp_auth_file, temp_rbac_file, admin_headers):
|
||||||
|
"""Test getting current user info."""
|
||||||
|
response = test_app.get("/api/auth/me", headers=admin_headers)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
data = response.json()
|
||||||
|
assert data["username"] == "testuser"
|
||||||
|
assert data["role"] == "admin"
|
||||||
|
assert "pages" in data
|
||||||
|
assert "sidebar_links" in data
|
||||||
|
|
||||||
|
def test_get_user_info_without_auth(self, test_app, mock_config, temp_auth_file):
|
||||||
|
"""Test getting user info without authentication."""
|
||||||
|
response = test_app.get("/api/auth/me")
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
|
||||||
|
class TestProxyAuth:
|
||||||
|
"""Test proxy authentication endpoint."""
|
||||||
|
|
||||||
|
def test_proxy_auth_from_trusted_source(self, test_app, mock_config, temp_auth_file, temp_rbac_file):
|
||||||
|
"""Test proxy auth from trusted proxy."""
|
||||||
|
response = test_app.get(
|
||||||
|
"/api/auth/proxy",
|
||||||
|
headers={
|
||||||
|
"Remote-User": "proxyuser",
|
||||||
|
"Remote-Groups": "dashboard_admin"
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
# Note: This test may need adjustment based on actual proxy auth implementation
|
||||||
|
# The test client's default host may not be in trusted proxies
|
||||||
|
assert response.status_code in [200, 403]
|
||||||
|
|
||||||
|
def test_proxy_auth_from_untrusted_source(self, test_app, mock_config, temp_auth_file):
|
||||||
|
"""Test proxy auth from untrusted source."""
|
||||||
|
# Mock request from untrusted IP
|
||||||
|
response = test_app.get(
|
||||||
|
"/api/auth/proxy",
|
||||||
|
headers={
|
||||||
|
"Remote-User": "proxyuser",
|
||||||
|
"Remote-Groups": "dashboard_admin"
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
# Should reject untrusted proxy
|
||||||
|
assert response.status_code == 403
|
||||||
|
|
||||||
|
|
||||||
|
class TestPasswordChange:
|
||||||
|
"""Test password change endpoint."""
|
||||||
|
|
||||||
|
def test_change_password_success(self, test_app, mock_config, temp_auth_file, admin_headers):
|
||||||
|
"""Test successful password change."""
|
||||||
|
old_password = "old_password"
|
||||||
|
new_password = "new_password_123"
|
||||||
|
|
||||||
|
# Set initial password
|
||||||
|
hashed = get_password_hash(old_password)
|
||||||
|
save_password_hash(hashed)
|
||||||
|
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/auth/change-password",
|
||||||
|
headers=admin_headers,
|
||||||
|
json={
|
||||||
|
"old_password": old_password,
|
||||||
|
"new_password": new_password
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
|
||||||
|
def test_change_password_wrong_old_password(self, test_app, mock_config, temp_auth_file, admin_headers):
|
||||||
|
"""Test password change with wrong old password."""
|
||||||
|
old_password = "old_password"
|
||||||
|
hashed = get_password_hash(old_password)
|
||||||
|
save_password_hash(hashed)
|
||||||
|
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/auth/change-password",
|
||||||
|
headers=admin_headers,
|
||||||
|
json={
|
||||||
|
"old_password": "wrong_password",
|
||||||
|
"new_password": "new_password_123"
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
def test_change_password_without_auth(self, test_app, mock_config, temp_auth_file):
|
||||||
|
"""Test password change without authentication."""
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/auth/change-password",
|
||||||
|
json={
|
||||||
|
"old_password": "old",
|
||||||
|
"new_password": "new"
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
@@ -0,0 +1,181 @@
|
|||||||
|
"""
|
||||||
|
Integration tests for Docker operations.
|
||||||
|
"""
|
||||||
|
import pytest
|
||||||
|
from unittest.mock import Mock, patch
|
||||||
|
|
||||||
|
|
||||||
|
class TestDockerContainerList:
|
||||||
|
"""Test listing Docker containers."""
|
||||||
|
|
||||||
|
def test_list_containers_success(self, test_app, admin_headers):
|
||||||
|
"""Test listing containers successfully."""
|
||||||
|
response = test_app.get("/api/docker/containers", headers=admin_headers)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
data = response.json()
|
||||||
|
assert isinstance(data, list)
|
||||||
|
if len(data) > 0:
|
||||||
|
container = data[0]
|
||||||
|
assert "id" in container
|
||||||
|
assert "name" in container
|
||||||
|
assert "status" in container
|
||||||
|
|
||||||
|
def test_list_containers_without_auth(self, test_app):
|
||||||
|
"""Test listing containers without authentication."""
|
||||||
|
response = test_app.get("/api/docker/containers")
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
|
||||||
|
class TestDockerContainerActions:
|
||||||
|
"""Test Docker container start/stop/restart actions."""
|
||||||
|
|
||||||
|
def test_start_container_success(self, test_app, admin_headers, mock_docker_client):
|
||||||
|
"""Test starting a container."""
|
||||||
|
container_id = "abc123"
|
||||||
|
|
||||||
|
response = test_app.post(
|
||||||
|
f"/api/docker/containers/{container_id}/start",
|
||||||
|
headers=admin_headers
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
data = response.json()
|
||||||
|
assert "message" in data or "status" in data
|
||||||
|
|
||||||
|
def test_stop_container_success(self, test_app, admin_headers, mock_docker_client):
|
||||||
|
"""Test stopping a container."""
|
||||||
|
container_id = "abc123"
|
||||||
|
|
||||||
|
response = test_app.post(
|
||||||
|
f"/api/docker/containers/{container_id}/stop",
|
||||||
|
headers=admin_headers
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
|
||||||
|
def test_restart_container_success(self, test_app, admin_headers, mock_docker_client):
|
||||||
|
"""Test restarting a container."""
|
||||||
|
container_id = "abc123"
|
||||||
|
|
||||||
|
response = test_app.post(
|
||||||
|
f"/api/docker/containers/{container_id}/restart",
|
||||||
|
headers=admin_headers
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
|
||||||
|
def test_container_action_without_auth(self, test_app):
|
||||||
|
"""Test container action without authentication."""
|
||||||
|
response = test_app.post("/api/docker/containers/abc123/start")
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
def test_container_action_invalid_action(self, test_app, admin_headers):
|
||||||
|
"""Test container action with invalid action."""
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/docker/containers/abc123/invalid_action",
|
||||||
|
headers=admin_headers
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 404
|
||||||
|
|
||||||
|
|
||||||
|
class TestDockerContainerLogs:
|
||||||
|
"""Test Docker container logs retrieval."""
|
||||||
|
|
||||||
|
def test_get_container_logs_success(self, test_app, admin_headers, mock_docker_client):
|
||||||
|
"""Test getting container logs."""
|
||||||
|
container_id = "abc123"
|
||||||
|
|
||||||
|
response = test_app.get(
|
||||||
|
f"/api/docker/containers/{container_id}/logs",
|
||||||
|
headers=admin_headers
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
data = response.json()
|
||||||
|
assert "logs" in data or isinstance(data, str)
|
||||||
|
|
||||||
|
def test_get_container_logs_with_tail(self, test_app, admin_headers, mock_docker_client):
|
||||||
|
"""Test getting container logs with tail limit."""
|
||||||
|
container_id = "abc123"
|
||||||
|
|
||||||
|
response = test_app.get(
|
||||||
|
f"/api/docker/containers/{container_id}/logs?tail=100",
|
||||||
|
headers=admin_headers
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
|
||||||
|
def test_get_container_logs_without_auth(self, test_app):
|
||||||
|
"""Test getting logs without authentication."""
|
||||||
|
response = test_app.get("/api/docker/containers/abc123/logs")
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
def test_get_container_logs_nonexistent(self, test_app, admin_headers, mock_docker_client):
|
||||||
|
"""Test getting logs for nonexistent container."""
|
||||||
|
# Mock container not found
|
||||||
|
mock_docker_client.containers.get.side_effect = Exception("Container not found")
|
||||||
|
|
||||||
|
response = test_app.get(
|
||||||
|
"/api/docker/containers/nonexistent/logs",
|
||||||
|
headers=admin_headers
|
||||||
|
)
|
||||||
|
|
||||||
|
# Should handle error gracefully
|
||||||
|
assert response.status_code in [404, 500]
|
||||||
|
|
||||||
|
|
||||||
|
class TestDockerPermissions:
|
||||||
|
"""Test Docker operation permissions."""
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def member_token(self, mock_config, temp_auth_file, temp_rbac_file):
|
||||||
|
"""Create token for member role."""
|
||||||
|
from auth import create_access_token
|
||||||
|
from datetime import timedelta
|
||||||
|
return create_access_token(
|
||||||
|
data={"sub": "memberuser", "role": "member"},
|
||||||
|
expires_delta=timedelta(minutes=30)
|
||||||
|
)
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def member_headers(self, member_token):
|
||||||
|
"""Headers with member access token."""
|
||||||
|
return {"Authorization": f"Bearer {member_token}"}
|
||||||
|
|
||||||
|
def test_member_can_list_containers(self, test_app, member_headers):
|
||||||
|
"""Test that member can list containers."""
|
||||||
|
response = test_app.get("/api/docker/containers", headers=member_headers)
|
||||||
|
|
||||||
|
# Members should be able to view containers
|
||||||
|
assert response.status_code == 200
|
||||||
|
|
||||||
|
def test_member_cannot_start_container(self, test_app, member_headers):
|
||||||
|
"""Test that member cannot start containers (admin only)."""
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/docker/containers/abc123/start",
|
||||||
|
headers=member_headers
|
||||||
|
)
|
||||||
|
|
||||||
|
# Should be forbidden for non-admin
|
||||||
|
assert response.status_code == 403
|
||||||
|
|
||||||
|
def test_viewer_can_list_containers(self, test_app, mock_config, temp_auth_file, temp_rbac_file):
|
||||||
|
"""Test that viewer can list containers if they have docker page access."""
|
||||||
|
from auth import create_access_token
|
||||||
|
from datetime import timedelta
|
||||||
|
|
||||||
|
viewer_token = create_access_token(
|
||||||
|
data={"sub": "vieweruser", "role": "viewer"},
|
||||||
|
expires_delta=timedelta(minutes=30)
|
||||||
|
)
|
||||||
|
headers = {"Authorization": f"Bearer {viewer_token}"}
|
||||||
|
|
||||||
|
response = test_app.get("/api/docker/containers", headers=headers)
|
||||||
|
|
||||||
|
# Viewer may not have docker page access by default
|
||||||
|
assert response.status_code in [200, 403]
|
||||||
@@ -0,0 +1,189 @@
|
|||||||
|
"""
|
||||||
|
Integration tests for file operations.
|
||||||
|
"""
|
||||||
|
import pytest
|
||||||
|
import os
|
||||||
|
|
||||||
|
|
||||||
|
class TestFileBrowse:
|
||||||
|
"""Test file browsing."""
|
||||||
|
|
||||||
|
def test_browse_root(self, test_app, admin_headers, temp_volume_root):
|
||||||
|
"""Test browsing root directory."""
|
||||||
|
response = test_app.get(
|
||||||
|
"/api/files/browse",
|
||||||
|
headers=admin_headers,
|
||||||
|
params={"path": "/"}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
data = response.json()
|
||||||
|
assert "files" in data or isinstance(data, list)
|
||||||
|
|
||||||
|
def test_browse_without_auth(self, test_app):
|
||||||
|
"""Test browsing without authentication."""
|
||||||
|
response = test_app.get("/api/files/browse", params={"path": "/"})
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
def test_browse_blocked_directory(self, test_app, admin_headers):
|
||||||
|
"""Test browsing blocked directory."""
|
||||||
|
response = test_app.get(
|
||||||
|
"/api/files/browse",
|
||||||
|
headers=admin_headers,
|
||||||
|
params={"path": "/@appstore"}
|
||||||
|
)
|
||||||
|
|
||||||
|
# Should be forbidden
|
||||||
|
assert response.status_code == 403
|
||||||
|
|
||||||
|
def test_browse_path_traversal_attempt(self, test_app, admin_headers):
|
||||||
|
"""Test path traversal protection."""
|
||||||
|
response = test_app.get(
|
||||||
|
"/api/files/browse",
|
||||||
|
headers=admin_headers,
|
||||||
|
params={"path": "/../../../etc"}
|
||||||
|
)
|
||||||
|
|
||||||
|
# Should be forbidden
|
||||||
|
assert response.status_code == 403
|
||||||
|
|
||||||
|
|
||||||
|
class TestFileUpload:
|
||||||
|
"""Test file upload."""
|
||||||
|
|
||||||
|
def test_upload_file_success(self, test_app, admin_headers, temp_volume_root):
|
||||||
|
"""Test uploading a file."""
|
||||||
|
test_content = b"test file content"
|
||||||
|
files = {"file": ("test.txt", test_content, "text/plain")}
|
||||||
|
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/files/upload",
|
||||||
|
headers=admin_headers,
|
||||||
|
files=files,
|
||||||
|
data={"path": "/"}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code in [200, 201]
|
||||||
|
|
||||||
|
def test_upload_without_auth(self, test_app):
|
||||||
|
"""Test upload without authentication."""
|
||||||
|
files = {"file": ("test.txt", b"content", "text/plain")}
|
||||||
|
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/files/upload",
|
||||||
|
files=files,
|
||||||
|
data={"path": "/"}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
def test_upload_as_member_forbidden(self, test_app, mock_config, temp_auth_file, temp_rbac_file):
|
||||||
|
"""Test that non-admin cannot upload."""
|
||||||
|
from auth import create_access_token
|
||||||
|
from datetime import timedelta
|
||||||
|
|
||||||
|
member_token = create_access_token(
|
||||||
|
data={"sub": "memberuser", "role": "member"},
|
||||||
|
expires_delta=timedelta(minutes=30)
|
||||||
|
)
|
||||||
|
headers = {"Authorization": f"Bearer {member_token}"}
|
||||||
|
files = {"file": ("test.txt", b"content", "text/plain")}
|
||||||
|
|
||||||
|
response = test_app.post(
|
||||||
|
"/api/files/upload",
|
||||||
|
headers=headers,
|
||||||
|
files=files,
|
||||||
|
data={"path": "/"}
|
||||||
|
)
|
||||||
|
|
||||||
|
# Upload should be admin-only
|
||||||
|
assert response.status_code == 403
|
||||||
|
|
||||||
|
|
||||||
|
class TestFileDelete:
|
||||||
|
"""Test file deletion."""
|
||||||
|
|
||||||
|
def test_delete_file_success(self, test_app, admin_headers, temp_volume_root):
|
||||||
|
"""Test deleting a file."""
|
||||||
|
# Create a test file first
|
||||||
|
test_file = os.path.join(temp_volume_root, "test_delete.txt")
|
||||||
|
with open(test_file, "w") as f:
|
||||||
|
f.write("test content")
|
||||||
|
|
||||||
|
response = test_app.delete(
|
||||||
|
"/api/files/delete",
|
||||||
|
headers=admin_headers,
|
||||||
|
params={"path": "/test_delete.txt"}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code in [200, 204]
|
||||||
|
|
||||||
|
def test_delete_without_auth(self, test_app):
|
||||||
|
"""Test delete without authentication."""
|
||||||
|
response = test_app.delete(
|
||||||
|
"/api/files/delete",
|
||||||
|
params={"path": "/test.txt"}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
def test_delete_as_member_forbidden(self, test_app, mock_config, temp_auth_file, temp_rbac_file):
|
||||||
|
"""Test that non-admin cannot delete."""
|
||||||
|
from auth import create_access_token
|
||||||
|
from datetime import timedelta
|
||||||
|
|
||||||
|
member_token = create_access_token(
|
||||||
|
data={"sub": "memberuser", "role": "member"},
|
||||||
|
expires_delta=timedelta(minutes=30)
|
||||||
|
)
|
||||||
|
headers = {"Authorization": f"Bearer {member_token}"}
|
||||||
|
|
||||||
|
response = test_app.delete(
|
||||||
|
"/api/files/delete",
|
||||||
|
headers=headers,
|
||||||
|
params={"path": "/test.txt"}
|
||||||
|
)
|
||||||
|
|
||||||
|
# Delete should be admin-only
|
||||||
|
assert response.status_code == 403
|
||||||
|
|
||||||
|
|
||||||
|
class TestFileDownload:
|
||||||
|
"""Test file download."""
|
||||||
|
|
||||||
|
def test_download_file_success(self, test_app, admin_headers, temp_volume_root):
|
||||||
|
"""Test downloading a file."""
|
||||||
|
# Create a test file
|
||||||
|
test_file = os.path.join(temp_volume_root, "test_download.txt")
|
||||||
|
test_content = "test download content"
|
||||||
|
with open(test_file, "w") as f:
|
||||||
|
f.write(test_content)
|
||||||
|
|
||||||
|
response = test_app.get(
|
||||||
|
"/api/files/download",
|
||||||
|
headers=admin_headers,
|
||||||
|
params={"path": "/test_download.txt"}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert test_content in response.text or response.content == test_content.encode()
|
||||||
|
|
||||||
|
def test_download_without_auth(self, test_app):
|
||||||
|
"""Test download without authentication."""
|
||||||
|
response = test_app.get(
|
||||||
|
"/api/files/download",
|
||||||
|
params={"path": "/test.txt"}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 401
|
||||||
|
|
||||||
|
def test_download_nonexistent_file(self, test_app, admin_headers):
|
||||||
|
"""Test downloading nonexistent file."""
|
||||||
|
response = test_app.get(
|
||||||
|
"/api/files/download",
|
||||||
|
headers=admin_headers,
|
||||||
|
params={"path": "/nonexistent.txt"}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.status_code == 404
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
# Unit tests
|
||||||
@@ -0,0 +1,322 @@
|
|||||||
|
"""
|
||||||
|
Unit tests for auth.py - JWT, TOTP, password hashing, encryption.
|
||||||
|
"""
|
||||||
|
import pytest
|
||||||
|
import jwt
|
||||||
|
import pyotp
|
||||||
|
from datetime import datetime, timedelta, timezone
|
||||||
|
from auth import (
|
||||||
|
verify_password,
|
||||||
|
get_password_hash,
|
||||||
|
create_access_token,
|
||||||
|
create_refresh_token,
|
||||||
|
user_from_access_token,
|
||||||
|
verify_totp,
|
||||||
|
load_totp_secret,
|
||||||
|
save_totp_secret,
|
||||||
|
load_password_hash,
|
||||||
|
save_password_hash,
|
||||||
|
increment_token_version,
|
||||||
|
verify_token_version,
|
||||||
|
_encrypt,
|
||||||
|
_decrypt,
|
||||||
|
load_passkey_credentials,
|
||||||
|
save_passkey_credential,
|
||||||
|
clear_passkey_credentials,
|
||||||
|
)
|
||||||
|
from fastapi import HTTPException
|
||||||
|
|
||||||
|
|
||||||
|
class TestPasswordHashing:
|
||||||
|
"""Test password hashing and verification."""
|
||||||
|
|
||||||
|
def test_hash_and_verify_password(self):
|
||||||
|
"""Test that password hashing and verification works."""
|
||||||
|
password = "test_password_123"
|
||||||
|
hashed = get_password_hash(password)
|
||||||
|
|
||||||
|
assert hashed != password
|
||||||
|
assert verify_password(password, hashed)
|
||||||
|
|
||||||
|
def test_verify_wrong_password(self):
|
||||||
|
"""Test that wrong password fails verification."""
|
||||||
|
password = "correct_password"
|
||||||
|
wrong_password = "wrong_password"
|
||||||
|
hashed = get_password_hash(password)
|
||||||
|
|
||||||
|
assert not verify_password(wrong_password, hashed)
|
||||||
|
|
||||||
|
def test_different_hashes_for_same_password(self):
|
||||||
|
"""Test that same password produces different hashes (salt)."""
|
||||||
|
password = "test_password"
|
||||||
|
hash1 = get_password_hash(password)
|
||||||
|
hash2 = get_password_hash(password)
|
||||||
|
|
||||||
|
assert hash1 != hash2
|
||||||
|
assert verify_password(password, hash1)
|
||||||
|
assert verify_password(password, hash2)
|
||||||
|
|
||||||
|
|
||||||
|
class TestJWTTokens:
|
||||||
|
"""Test JWT token creation and validation."""
|
||||||
|
|
||||||
|
def test_create_access_token(self, mock_config):
|
||||||
|
"""Test access token creation."""
|
||||||
|
data = {"sub": "testuser", "role": "admin"}
|
||||||
|
token = create_access_token(data)
|
||||||
|
|
||||||
|
assert token is not None
|
||||||
|
payload = jwt.decode(token, mock_config.SECRET_KEY, algorithms=[mock_config.ALGORITHM])
|
||||||
|
assert payload["sub"] == "testuser"
|
||||||
|
assert payload["role"] == "admin"
|
||||||
|
assert payload["type"] == "access"
|
||||||
|
assert "exp" in payload
|
||||||
|
|
||||||
|
def test_create_access_token_with_custom_expiry(self, mock_config):
|
||||||
|
"""Test access token with custom expiration."""
|
||||||
|
data = {"sub": "testuser"}
|
||||||
|
expires_delta = timedelta(minutes=60)
|
||||||
|
token = create_access_token(data, expires_delta)
|
||||||
|
|
||||||
|
payload = jwt.decode(token, mock_config.SECRET_KEY, algorithms=[mock_config.ALGORITHM])
|
||||||
|
exp_time = datetime.fromtimestamp(payload["exp"], tz=timezone.utc)
|
||||||
|
now = datetime.now(timezone.utc)
|
||||||
|
|
||||||
|
# Should expire in approximately 60 minutes
|
||||||
|
time_diff = (exp_time - now).total_seconds()
|
||||||
|
assert 3500 < time_diff < 3700 # ~60 minutes with some tolerance
|
||||||
|
|
||||||
|
def test_create_refresh_token(self, mock_config, temp_auth_file):
|
||||||
|
"""Test refresh token creation."""
|
||||||
|
data = {"sub": "testuser", "role": "member"}
|
||||||
|
token = create_refresh_token(data)
|
||||||
|
|
||||||
|
assert token is not None
|
||||||
|
payload = jwt.decode(token, mock_config.SECRET_KEY, algorithms=[mock_config.ALGORITHM])
|
||||||
|
assert payload["sub"] == "testuser"
|
||||||
|
assert payload["role"] == "member"
|
||||||
|
assert payload["type"] == "refresh"
|
||||||
|
assert "tv" in payload # token version
|
||||||
|
assert "exp" in payload
|
||||||
|
|
||||||
|
def test_user_from_valid_access_token(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test extracting user from valid access token."""
|
||||||
|
token = create_access_token({"sub": "testuser", "role": "admin"})
|
||||||
|
user = user_from_access_token(token)
|
||||||
|
|
||||||
|
assert user.username == "testuser"
|
||||||
|
assert user.role == "admin"
|
||||||
|
assert user.pages == "*"
|
||||||
|
assert user.sidebar_links == "*"
|
||||||
|
|
||||||
|
def test_user_from_expired_token(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test that expired token raises HTTPException."""
|
||||||
|
token = create_access_token(
|
||||||
|
{"sub": "testuser", "role": "admin"},
|
||||||
|
expires_delta=timedelta(seconds=-1)
|
||||||
|
)
|
||||||
|
|
||||||
|
with pytest.raises(HTTPException) as exc_info:
|
||||||
|
user_from_access_token(token)
|
||||||
|
|
||||||
|
assert exc_info.value.status_code == 401
|
||||||
|
|
||||||
|
def test_user_from_invalid_token(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test that invalid token raises HTTPException."""
|
||||||
|
with pytest.raises(HTTPException) as exc_info:
|
||||||
|
user_from_access_token("invalid.token.here")
|
||||||
|
|
||||||
|
assert exc_info.value.status_code == 401
|
||||||
|
|
||||||
|
def test_user_from_refresh_token_fails(self, mock_config, temp_rbac_file, temp_auth_file):
|
||||||
|
"""Test that refresh token cannot be used as access token."""
|
||||||
|
token = create_refresh_token({"sub": "testuser", "role": "admin"})
|
||||||
|
|
||||||
|
with pytest.raises(HTTPException) as exc_info:
|
||||||
|
user_from_access_token(token)
|
||||||
|
|
||||||
|
assert exc_info.value.status_code == 401
|
||||||
|
|
||||||
|
def test_user_from_token_without_username(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test that token without username fails."""
|
||||||
|
# Create token without 'sub' field
|
||||||
|
token = jwt.encode(
|
||||||
|
{"role": "admin", "type": "access", "exp": datetime.now(timezone.utc) + timedelta(minutes=30)},
|
||||||
|
mock_config.SECRET_KEY,
|
||||||
|
algorithm=mock_config.ALGORITHM
|
||||||
|
)
|
||||||
|
|
||||||
|
with pytest.raises(HTTPException) as exc_info:
|
||||||
|
user_from_access_token(token)
|
||||||
|
|
||||||
|
assert exc_info.value.status_code == 401
|
||||||
|
|
||||||
|
|
||||||
|
class TestEncryption:
|
||||||
|
"""Test encryption and decryption functions."""
|
||||||
|
|
||||||
|
def test_encrypt_decrypt(self, mock_config):
|
||||||
|
"""Test basic encryption and decryption."""
|
||||||
|
plaintext = "my-secret-totp-key"
|
||||||
|
encrypted = _encrypt(plaintext)
|
||||||
|
|
||||||
|
assert encrypted != plaintext
|
||||||
|
assert encrypted != ""
|
||||||
|
|
||||||
|
decrypted = _decrypt(encrypted)
|
||||||
|
assert decrypted == plaintext
|
||||||
|
|
||||||
|
def test_encrypt_empty_string(self, mock_config):
|
||||||
|
"""Test encrypting empty string."""
|
||||||
|
encrypted = _encrypt("")
|
||||||
|
assert encrypted == ""
|
||||||
|
|
||||||
|
decrypted = _decrypt("")
|
||||||
|
assert decrypted == ""
|
||||||
|
|
||||||
|
def test_decrypt_invalid_ciphertext(self, mock_config):
|
||||||
|
"""Test decrypting invalid ciphertext returns original."""
|
||||||
|
invalid = "not-a-valid-encrypted-string"
|
||||||
|
decrypted = _decrypt(invalid)
|
||||||
|
|
||||||
|
# Should fallback to returning the original string
|
||||||
|
assert decrypted == invalid
|
||||||
|
|
||||||
|
def test_encrypt_decrypt_unicode(self, mock_config):
|
||||||
|
"""Test encryption with unicode characters."""
|
||||||
|
plaintext = "测试密钥🔐"
|
||||||
|
encrypted = _encrypt(plaintext)
|
||||||
|
decrypted = _decrypt(encrypted)
|
||||||
|
|
||||||
|
assert decrypted == plaintext
|
||||||
|
|
||||||
|
|
||||||
|
class TestTOTP:
|
||||||
|
"""Test TOTP functionality."""
|
||||||
|
|
||||||
|
def test_save_and_load_totp_secret(self, mock_config, temp_auth_file):
|
||||||
|
"""Test saving and loading TOTP secret."""
|
||||||
|
secret = "JBSWY3DPEHPK3PXP"
|
||||||
|
save_totp_secret(secret)
|
||||||
|
|
||||||
|
loaded = load_totp_secret()
|
||||||
|
assert loaded == secret
|
||||||
|
|
||||||
|
def test_load_totp_secret_from_env(self, mock_config, temp_auth_file, monkeypatch):
|
||||||
|
"""Test loading TOTP secret from environment variable."""
|
||||||
|
monkeypatch.setenv("TOTP_SECRET", "ENV_SECRET_KEY")
|
||||||
|
import importlib
|
||||||
|
import config
|
||||||
|
importlib.reload(config)
|
||||||
|
|
||||||
|
# When no secret in file, should return env var
|
||||||
|
loaded = load_totp_secret()
|
||||||
|
assert loaded == "ENV_SECRET_KEY"
|
||||||
|
|
||||||
|
def test_verify_totp_valid_code(self, mock_config, temp_auth_file, sample_totp_secret):
|
||||||
|
"""Test verifying valid TOTP code."""
|
||||||
|
save_totp_secret(sample_totp_secret)
|
||||||
|
totp = pyotp.TOTP(sample_totp_secret)
|
||||||
|
valid_code = totp.now()
|
||||||
|
|
||||||
|
assert verify_totp(valid_code)
|
||||||
|
|
||||||
|
def test_verify_totp_invalid_code(self, mock_config, temp_auth_file, sample_totp_secret):
|
||||||
|
"""Test verifying invalid TOTP code."""
|
||||||
|
save_totp_secret(sample_totp_secret)
|
||||||
|
|
||||||
|
assert not verify_totp("000000")
|
||||||
|
|
||||||
|
def test_verify_totp_no_secret_enabled(self, mock_config, temp_auth_file):
|
||||||
|
"""Test that TOTP verification passes when 2FA not enabled."""
|
||||||
|
# No secret saved, should return True (2FA disabled)
|
||||||
|
assert verify_totp("any_code")
|
||||||
|
|
||||||
|
def test_verify_totp_replay_protection(self, mock_config, temp_auth_file, sample_totp_secret):
|
||||||
|
"""Test that same TOTP code cannot be used twice."""
|
||||||
|
save_totp_secret(sample_totp_secret)
|
||||||
|
totp = pyotp.TOTP(sample_totp_secret)
|
||||||
|
valid_code = totp.now()
|
||||||
|
|
||||||
|
# First use should succeed
|
||||||
|
assert verify_totp(valid_code)
|
||||||
|
|
||||||
|
# Second use of same code should fail (replay protection)
|
||||||
|
assert not verify_totp(valid_code)
|
||||||
|
|
||||||
|
|
||||||
|
class TestPasswordPersistence:
|
||||||
|
"""Test password hash persistence."""
|
||||||
|
|
||||||
|
def test_save_and_load_password_hash(self, mock_config, temp_auth_file):
|
||||||
|
"""Test saving and loading password hash."""
|
||||||
|
hashed = get_password_hash("new_password")
|
||||||
|
save_password_hash(hashed)
|
||||||
|
|
||||||
|
loaded = load_password_hash()
|
||||||
|
assert loaded == hashed
|
||||||
|
|
||||||
|
def test_load_password_hash_from_env(self, mock_config, temp_auth_file):
|
||||||
|
"""Test loading password hash from environment variable."""
|
||||||
|
# When no hash in file, should return env var
|
||||||
|
loaded = load_password_hash()
|
||||||
|
assert loaded == mock_config.ADMIN_PASSWORD_HASH
|
||||||
|
|
||||||
|
|
||||||
|
class TestPasskeyCredentials:
|
||||||
|
"""Test passkey credential management."""
|
||||||
|
|
||||||
|
def test_save_and_load_passkey_credentials(self, mock_config, temp_auth_file):
|
||||||
|
"""Test saving and loading passkey credentials."""
|
||||||
|
cred1 = {"id": "cred1", "public_key": "key1"}
|
||||||
|
cred2 = {"id": "cred2", "public_key": "key2"}
|
||||||
|
|
||||||
|
save_passkey_credential(cred1)
|
||||||
|
save_passkey_credential(cred2)
|
||||||
|
|
||||||
|
creds = load_passkey_credentials()
|
||||||
|
assert len(creds) == 2
|
||||||
|
assert cred1 in creds
|
||||||
|
assert cred2 in creds
|
||||||
|
|
||||||
|
def test_clear_passkey_credentials(self, mock_config, temp_auth_file):
|
||||||
|
"""Test clearing all passkey credentials."""
|
||||||
|
save_passkey_credential({"id": "cred1"})
|
||||||
|
save_passkey_credential({"id": "cred2"})
|
||||||
|
|
||||||
|
clear_passkey_credentials()
|
||||||
|
|
||||||
|
creds = load_passkey_credentials()
|
||||||
|
assert len(creds) == 0
|
||||||
|
|
||||||
|
|
||||||
|
class TestTokenVersion:
|
||||||
|
"""Test token version management for refresh token rotation."""
|
||||||
|
|
||||||
|
def test_increment_token_version(self, mock_config, temp_auth_file):
|
||||||
|
"""Test incrementing token version."""
|
||||||
|
v1 = increment_token_version()
|
||||||
|
assert v1 == 1
|
||||||
|
|
||||||
|
v2 = increment_token_version()
|
||||||
|
assert v2 == 2
|
||||||
|
|
||||||
|
v3 = increment_token_version()
|
||||||
|
assert v3 == 3
|
||||||
|
|
||||||
|
def test_verify_token_version(self, mock_config, temp_auth_file):
|
||||||
|
"""Test verifying token version."""
|
||||||
|
v1 = increment_token_version()
|
||||||
|
assert verify_token_version(v1)
|
||||||
|
|
||||||
|
v2 = increment_token_version()
|
||||||
|
assert verify_token_version(v2)
|
||||||
|
assert not verify_token_version(v1) # Old version should fail
|
||||||
|
|
||||||
|
def test_token_version_in_refresh_token(self, mock_config, temp_auth_file):
|
||||||
|
"""Test that refresh token includes current token version."""
|
||||||
|
current_version = increment_token_version()
|
||||||
|
token = create_refresh_token({"sub": "testuser"})
|
||||||
|
|
||||||
|
payload = jwt.decode(token, mock_config.SECRET_KEY, algorithms=[mock_config.ALGORITHM])
|
||||||
|
assert payload["tv"] == current_version
|
||||||
@@ -0,0 +1,297 @@
|
|||||||
|
"""
|
||||||
|
Unit tests for config.py - IP parsing, environment validation.
|
||||||
|
"""
|
||||||
|
import pytest
|
||||||
|
from unittest.mock import Mock
|
||||||
|
from config import (
|
||||||
|
_parse_ip,
|
||||||
|
_ip_matches_ranges,
|
||||||
|
is_lan_ip,
|
||||||
|
is_tailscale_ip,
|
||||||
|
is_trusted_proxy,
|
||||||
|
get_forwarded_client_ip,
|
||||||
|
get_client_ip,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestParseIP:
|
||||||
|
"""Test IP address parsing."""
|
||||||
|
|
||||||
|
def test_parse_valid_ipv4(self):
|
||||||
|
"""Test parsing valid IPv4 address."""
|
||||||
|
ip = _parse_ip("192.168.1.1")
|
||||||
|
assert ip is not None
|
||||||
|
assert str(ip) == "192.168.1.1"
|
||||||
|
|
||||||
|
def test_parse_valid_ipv6(self):
|
||||||
|
"""Test parsing valid IPv6 address."""
|
||||||
|
ip = _parse_ip("2001:db8::1")
|
||||||
|
assert ip is not None
|
||||||
|
assert str(ip) == "2001:db8::1"
|
||||||
|
|
||||||
|
def test_parse_localhost_ipv4(self):
|
||||||
|
"""Test parsing localhost IPv4."""
|
||||||
|
ip = _parse_ip("127.0.0.1")
|
||||||
|
assert ip is not None
|
||||||
|
assert str(ip) == "127.0.0.1"
|
||||||
|
|
||||||
|
def test_parse_localhost_ipv6(self):
|
||||||
|
"""Test parsing localhost IPv6."""
|
||||||
|
ip = _parse_ip("::1")
|
||||||
|
assert ip is not None
|
||||||
|
assert str(ip) == "::1"
|
||||||
|
|
||||||
|
def test_parse_invalid_ip(self):
|
||||||
|
"""Test parsing invalid IP returns None."""
|
||||||
|
assert _parse_ip("not.an.ip.address") is None
|
||||||
|
assert _parse_ip("999.999.999.999") is None
|
||||||
|
assert _parse_ip("") is None
|
||||||
|
assert _parse_ip(" ") is None
|
||||||
|
|
||||||
|
def test_parse_ip_with_whitespace(self):
|
||||||
|
"""Test parsing IP with surrounding whitespace."""
|
||||||
|
ip = _parse_ip(" 192.168.1.1 ")
|
||||||
|
assert ip is not None
|
||||||
|
assert str(ip) == "192.168.1.1"
|
||||||
|
|
||||||
|
|
||||||
|
class TestIPMatchesRanges:
|
||||||
|
"""Test IP range matching."""
|
||||||
|
|
||||||
|
def test_match_single_ip(self):
|
||||||
|
"""Test matching against single IP."""
|
||||||
|
assert _ip_matches_ranges("192.168.1.1", ["192.168.1.1"])
|
||||||
|
assert not _ip_matches_ranges("192.168.1.2", ["192.168.1.1"])
|
||||||
|
|
||||||
|
def test_match_cidr_range(self):
|
||||||
|
"""Test matching against CIDR range."""
|
||||||
|
ranges = ["192.168.1.0/24"]
|
||||||
|
assert _ip_matches_ranges("192.168.1.1", ranges)
|
||||||
|
assert _ip_matches_ranges("192.168.1.100", ranges)
|
||||||
|
assert _ip_matches_ranges("192.168.1.254", ranges)
|
||||||
|
assert not _ip_matches_ranges("192.168.2.1", ranges)
|
||||||
|
|
||||||
|
def test_match_multiple_ranges(self):
|
||||||
|
"""Test matching against multiple ranges."""
|
||||||
|
ranges = ["192.168.1.0/24", "10.0.0.0/8", "172.16.0.1"]
|
||||||
|
assert _ip_matches_ranges("192.168.1.50", ranges)
|
||||||
|
assert _ip_matches_ranges("10.5.10.20", ranges)
|
||||||
|
assert _ip_matches_ranges("172.16.0.1", ranges)
|
||||||
|
assert not _ip_matches_ranges("8.8.8.8", ranges)
|
||||||
|
|
||||||
|
def test_match_ipv6_range(self):
|
||||||
|
"""Test matching IPv6 against range."""
|
||||||
|
ranges = ["2001:db8::/32"]
|
||||||
|
assert _ip_matches_ranges("2001:db8::1", ranges)
|
||||||
|
assert _ip_matches_ranges("2001:db8:1234::5678", ranges)
|
||||||
|
assert not _ip_matches_ranges("2001:db9::1", ranges)
|
||||||
|
|
||||||
|
def test_match_invalid_ip(self):
|
||||||
|
"""Test that invalid IP returns False."""
|
||||||
|
assert not _ip_matches_ranges("invalid", ["192.168.1.0/24"])
|
||||||
|
assert not _ip_matches_ranges("", ["192.168.1.0/24"])
|
||||||
|
|
||||||
|
def test_match_empty_ranges(self):
|
||||||
|
"""Test matching against empty ranges."""
|
||||||
|
assert not _ip_matches_ranges("192.168.1.1", [])
|
||||||
|
|
||||||
|
def test_match_with_whitespace_in_ranges(self):
|
||||||
|
"""Test matching with whitespace in range strings."""
|
||||||
|
ranges = [" 192.168.1.0/24 ", " 10.0.0.1 "]
|
||||||
|
assert _ip_matches_ranges("192.168.1.50", ranges)
|
||||||
|
assert _ip_matches_ranges("10.0.0.1", ranges)
|
||||||
|
|
||||||
|
def test_match_with_empty_string_in_ranges(self):
|
||||||
|
"""Test that empty strings in ranges are skipped."""
|
||||||
|
ranges = ["192.168.1.0/24", "", " ", "10.0.0.1"]
|
||||||
|
assert _ip_matches_ranges("192.168.1.50", ranges)
|
||||||
|
assert _ip_matches_ranges("10.0.0.1", ranges)
|
||||||
|
|
||||||
|
def test_match_with_invalid_range(self):
|
||||||
|
"""Test that invalid ranges are skipped."""
|
||||||
|
ranges = ["192.168.1.0/24", "invalid-range", "10.0.0.1"]
|
||||||
|
assert _ip_matches_ranges("192.168.1.50", ranges)
|
||||||
|
assert _ip_matches_ranges("10.0.0.1", ranges)
|
||||||
|
assert not _ip_matches_ranges("8.8.8.8", ranges)
|
||||||
|
|
||||||
|
|
||||||
|
class TestIsLanIP:
|
||||||
|
"""Test LAN IP detection."""
|
||||||
|
|
||||||
|
def test_is_lan_ip_default_range(self, mock_config):
|
||||||
|
"""Test LAN IP detection with default range."""
|
||||||
|
# Default is 192.168.31.0/24
|
||||||
|
assert is_lan_ip("192.168.31.1")
|
||||||
|
assert is_lan_ip("192.168.31.100")
|
||||||
|
assert is_lan_ip("192.168.31.254")
|
||||||
|
assert not is_lan_ip("192.168.30.1")
|
||||||
|
assert not is_lan_ip("192.168.32.1")
|
||||||
|
|
||||||
|
def test_is_lan_ip_not_tailscale(self, mock_config):
|
||||||
|
"""Test that Tailscale IPs are not considered LAN."""
|
||||||
|
assert not is_lan_ip("100.64.0.1")
|
||||||
|
assert not is_lan_ip("100.78.131.124")
|
||||||
|
|
||||||
|
|
||||||
|
class TestIsTailscaleIP:
|
||||||
|
"""Test Tailscale IP detection."""
|
||||||
|
|
||||||
|
def test_is_tailscale_ip_valid(self):
|
||||||
|
"""Test Tailscale IP detection."""
|
||||||
|
assert is_tailscale_ip("100.64.0.1")
|
||||||
|
assert is_tailscale_ip("100.78.131.124")
|
||||||
|
assert is_tailscale_ip("100.100.100.100")
|
||||||
|
assert is_tailscale_ip("100.127.255.254")
|
||||||
|
|
||||||
|
def test_is_tailscale_ip_invalid(self):
|
||||||
|
"""Test non-Tailscale IPs."""
|
||||||
|
assert not is_tailscale_ip("100.63.255.255") # Just below range
|
||||||
|
assert not is_tailscale_ip("100.128.0.0") # Just above range
|
||||||
|
assert not is_tailscale_ip("192.168.1.1")
|
||||||
|
assert not is_tailscale_ip("10.0.0.1")
|
||||||
|
|
||||||
|
def test_is_tailscale_ip_boundary(self):
|
||||||
|
"""Test Tailscale IP range boundaries."""
|
||||||
|
# 100.64.0.0/10 means 100.64.0.0 to 100.127.255.255
|
||||||
|
assert is_tailscale_ip("100.64.0.0") # Start of range
|
||||||
|
assert is_tailscale_ip("100.127.255.255") # End of range
|
||||||
|
|
||||||
|
|
||||||
|
class TestIsTrustedProxy:
|
||||||
|
"""Test trusted proxy detection."""
|
||||||
|
|
||||||
|
def test_is_trusted_proxy_default(self, mock_config):
|
||||||
|
"""Test trusted proxy detection with default config."""
|
||||||
|
# Default: 127.0.0.1,::1,172.21.0.1
|
||||||
|
assert is_trusted_proxy("127.0.0.1")
|
||||||
|
assert is_trusted_proxy("::1")
|
||||||
|
assert is_trusted_proxy("172.21.0.1")
|
||||||
|
assert not is_trusted_proxy("192.168.1.1")
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetForwardedClientIP:
|
||||||
|
"""Test forwarded client IP extraction."""
|
||||||
|
|
||||||
|
def test_get_forwarded_ip_from_trusted_proxy(self, mock_config):
|
||||||
|
"""Test extracting forwarded IP from trusted proxy."""
|
||||||
|
request = Mock()
|
||||||
|
request.client = Mock()
|
||||||
|
request.client.host = "127.0.0.1" # Trusted proxy
|
||||||
|
request.headers = {"x-forwarded-for": "203.0.113.1"}
|
||||||
|
|
||||||
|
ip = get_forwarded_client_ip(request)
|
||||||
|
assert ip == "203.0.113.1"
|
||||||
|
|
||||||
|
def test_get_forwarded_ip_from_untrusted_proxy(self, mock_config):
|
||||||
|
"""Test that untrusted proxy returns None."""
|
||||||
|
request = Mock()
|
||||||
|
request.client = Mock()
|
||||||
|
request.client.host = "8.8.8.8" # Not trusted
|
||||||
|
request.headers = {"x-forwarded-for": "203.0.113.1"}
|
||||||
|
|
||||||
|
ip = get_forwarded_client_ip(request)
|
||||||
|
assert ip is None
|
||||||
|
|
||||||
|
def test_get_forwarded_ip_multiple_hops(self, mock_config):
|
||||||
|
"""Test extracting first IP from multiple forwarded IPs."""
|
||||||
|
request = Mock()
|
||||||
|
request.client = Mock()
|
||||||
|
request.client.host = "127.0.0.1"
|
||||||
|
request.headers = {"x-forwarded-for": "203.0.113.1, 198.51.100.1, 192.0.2.1"}
|
||||||
|
|
||||||
|
ip = get_forwarded_client_ip(request)
|
||||||
|
assert ip == "203.0.113.1"
|
||||||
|
|
||||||
|
def test_get_forwarded_ip_no_header(self, mock_config):
|
||||||
|
"""Test when x-forwarded-for header is missing."""
|
||||||
|
request = Mock()
|
||||||
|
request.client = Mock()
|
||||||
|
request.client.host = "127.0.0.1"
|
||||||
|
request.headers = {}
|
||||||
|
|
||||||
|
ip = get_forwarded_client_ip(request)
|
||||||
|
assert ip is None
|
||||||
|
|
||||||
|
def test_get_forwarded_ip_empty_header(self, mock_config):
|
||||||
|
"""Test when x-forwarded-for header is empty."""
|
||||||
|
request = Mock()
|
||||||
|
request.client = Mock()
|
||||||
|
request.client.host = "127.0.0.1"
|
||||||
|
request.headers = {"x-forwarded-for": ""}
|
||||||
|
|
||||||
|
ip = get_forwarded_client_ip(request)
|
||||||
|
assert ip is None
|
||||||
|
|
||||||
|
def test_get_forwarded_ip_no_client(self, mock_config):
|
||||||
|
"""Test when request has no client."""
|
||||||
|
request = Mock()
|
||||||
|
request.client = None
|
||||||
|
request.headers = {"x-forwarded-for": "203.0.113.1"}
|
||||||
|
|
||||||
|
ip = get_forwarded_client_ip(request)
|
||||||
|
assert ip is None
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetClientIP:
|
||||||
|
"""Test client IP extraction."""
|
||||||
|
|
||||||
|
def test_get_client_ip_direct(self, mock_config):
|
||||||
|
"""Test getting client IP from direct connection."""
|
||||||
|
request = Mock()
|
||||||
|
request.client = Mock()
|
||||||
|
request.client.host = "192.168.1.100"
|
||||||
|
request.headers = {}
|
||||||
|
|
||||||
|
ip = get_client_ip(request)
|
||||||
|
assert ip == "192.168.1.100"
|
||||||
|
|
||||||
|
def test_get_client_ip_via_trusted_proxy(self, mock_config):
|
||||||
|
"""Test getting client IP via trusted proxy."""
|
||||||
|
request = Mock()
|
||||||
|
request.client = Mock()
|
||||||
|
request.client.host = "127.0.0.1"
|
||||||
|
request.headers = {"x-forwarded-for": "203.0.113.1"}
|
||||||
|
|
||||||
|
ip = get_client_ip(request)
|
||||||
|
assert ip == "203.0.113.1"
|
||||||
|
|
||||||
|
def test_get_client_ip_via_untrusted_proxy(self, mock_config):
|
||||||
|
"""Test getting client IP via untrusted proxy falls back to direct."""
|
||||||
|
request = Mock()
|
||||||
|
request.client = Mock()
|
||||||
|
request.client.host = "8.8.8.8"
|
||||||
|
request.headers = {"x-forwarded-for": "203.0.113.1"}
|
||||||
|
|
||||||
|
ip = get_client_ip(request)
|
||||||
|
assert ip == "8.8.8.8"
|
||||||
|
|
||||||
|
def test_get_client_ip_no_client(self, mock_config):
|
||||||
|
"""Test getting client IP when request has no client."""
|
||||||
|
request = Mock()
|
||||||
|
request.client = None
|
||||||
|
request.headers = {}
|
||||||
|
|
||||||
|
ip = get_client_ip(request)
|
||||||
|
assert ip == ""
|
||||||
|
|
||||||
|
|
||||||
|
class TestConfigValidation:
|
||||||
|
"""Test configuration validation."""
|
||||||
|
|
||||||
|
def test_secret_key_validation(self, monkeypatch):
|
||||||
|
"""Test that short SECRET_KEY raises error."""
|
||||||
|
monkeypatch.setenv("SECRET_KEY", "short")
|
||||||
|
|
||||||
|
with pytest.raises(RuntimeError, match="SECRET_KEY must be set and at least 32 characters"):
|
||||||
|
import config
|
||||||
|
import importlib
|
||||||
|
importlib.reload(config)
|
||||||
|
|
||||||
|
def test_secret_key_empty(self, monkeypatch):
|
||||||
|
"""Test that empty SECRET_KEY raises error."""
|
||||||
|
monkeypatch.delenv("SECRET_KEY", raising=False)
|
||||||
|
|
||||||
|
with pytest.raises(RuntimeError, match="SECRET_KEY must be set and at least 32 characters"):
|
||||||
|
import config
|
||||||
|
import importlib
|
||||||
|
importlib.reload(config)
|
||||||
@@ -0,0 +1,316 @@
|
|||||||
|
"""
|
||||||
|
Unit tests for rbac.py - Role-based access control.
|
||||||
|
"""
|
||||||
|
import pytest
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
from rbac import (
|
||||||
|
load_rbac,
|
||||||
|
save_rbac,
|
||||||
|
update_rbac,
|
||||||
|
resolve_role,
|
||||||
|
get_pages,
|
||||||
|
get_sidebar_links,
|
||||||
|
get_sidebar_order,
|
||||||
|
DEFAULT_RBAC,
|
||||||
|
ROLE_GROUP_MAP,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestLoadRBAC:
|
||||||
|
"""Test loading RBAC configuration."""
|
||||||
|
|
||||||
|
def test_load_rbac_from_file(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test loading RBAC from existing file."""
|
||||||
|
rbac = load_rbac()
|
||||||
|
|
||||||
|
assert "role_defaults" in rbac
|
||||||
|
assert "user_overrides" in rbac
|
||||||
|
assert "admin" in rbac["role_defaults"]
|
||||||
|
assert "member" in rbac["role_defaults"]
|
||||||
|
assert "viewer" in rbac["role_defaults"]
|
||||||
|
|
||||||
|
def test_load_rbac_missing_file(self, mock_config, temp_volume_root):
|
||||||
|
"""Test loading RBAC when file doesn't exist returns defaults."""
|
||||||
|
# Don't create rbac file
|
||||||
|
rbac = load_rbac()
|
||||||
|
|
||||||
|
assert rbac == DEFAULT_RBAC
|
||||||
|
|
||||||
|
def test_load_rbac_corrupted_file(self, mock_config, temp_volume_root):
|
||||||
|
"""Test loading RBAC with corrupted file returns defaults."""
|
||||||
|
rbac_file = os.path.join(temp_volume_root, "docker/nas-dashboard/rbac.json")
|
||||||
|
os.makedirs(os.path.dirname(rbac_file), exist_ok=True)
|
||||||
|
|
||||||
|
# Write invalid JSON
|
||||||
|
with open(rbac_file, "w") as f:
|
||||||
|
f.write("invalid json {{{")
|
||||||
|
|
||||||
|
rbac = load_rbac()
|
||||||
|
assert rbac == DEFAULT_RBAC
|
||||||
|
|
||||||
|
|
||||||
|
class TestSaveRBAC:
|
||||||
|
"""Test saving RBAC configuration."""
|
||||||
|
|
||||||
|
def test_save_rbac(self, mock_config, temp_volume_root):
|
||||||
|
"""Test saving RBAC configuration."""
|
||||||
|
rbac_file = os.path.join(temp_volume_root, "docker/nas-dashboard/rbac.json")
|
||||||
|
test_data = {
|
||||||
|
"role_defaults": {"admin": {"pages": "*"}},
|
||||||
|
"user_overrides": {"testuser": {"pages": ["dashboard"]}}
|
||||||
|
}
|
||||||
|
|
||||||
|
save_rbac(test_data)
|
||||||
|
|
||||||
|
assert os.path.exists(rbac_file)
|
||||||
|
with open(rbac_file) as f:
|
||||||
|
loaded = json.load(f)
|
||||||
|
assert loaded == test_data
|
||||||
|
|
||||||
|
def test_save_rbac_creates_directory(self, mock_config, temp_volume_root):
|
||||||
|
"""Test that save_rbac creates directory if it doesn't exist."""
|
||||||
|
rbac_file = os.path.join(temp_volume_root, "docker/nas-dashboard/rbac.json")
|
||||||
|
|
||||||
|
# Remove directory
|
||||||
|
import shutil
|
||||||
|
if os.path.exists(os.path.dirname(rbac_file)):
|
||||||
|
shutil.rmtree(os.path.dirname(rbac_file))
|
||||||
|
|
||||||
|
test_data = {"role_defaults": {}, "user_overrides": {}}
|
||||||
|
save_rbac(test_data)
|
||||||
|
|
||||||
|
assert os.path.exists(rbac_file)
|
||||||
|
|
||||||
|
|
||||||
|
class TestUpdateRBAC:
|
||||||
|
"""Test atomic RBAC updates."""
|
||||||
|
|
||||||
|
def test_update_rbac_with_mutator(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test updating RBAC with mutator function."""
|
||||||
|
def add_user_override(data):
|
||||||
|
data["user_overrides"]["newuser"] = {"pages": ["dashboard", "docker"]}
|
||||||
|
return "success"
|
||||||
|
|
||||||
|
result = update_rbac(add_user_override)
|
||||||
|
|
||||||
|
assert result == "success"
|
||||||
|
|
||||||
|
# Verify changes persisted
|
||||||
|
rbac = load_rbac()
|
||||||
|
assert "newuser" in rbac["user_overrides"]
|
||||||
|
assert rbac["user_overrides"]["newuser"]["pages"] == ["dashboard", "docker"]
|
||||||
|
|
||||||
|
def test_update_rbac_thread_safe(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test that update_rbac is thread-safe."""
|
||||||
|
import threading
|
||||||
|
|
||||||
|
results = []
|
||||||
|
|
||||||
|
def increment_counter(data):
|
||||||
|
current = data.get("counter", 0)
|
||||||
|
data["counter"] = current + 1
|
||||||
|
return data["counter"]
|
||||||
|
|
||||||
|
# Run multiple updates concurrently
|
||||||
|
threads = []
|
||||||
|
for _ in range(10):
|
||||||
|
t = threading.Thread(target=lambda: results.append(update_rbac(increment_counter)))
|
||||||
|
threads.append(t)
|
||||||
|
t.start()
|
||||||
|
|
||||||
|
for t in threads:
|
||||||
|
t.join()
|
||||||
|
|
||||||
|
# Final counter should be 10
|
||||||
|
rbac = load_rbac()
|
||||||
|
assert rbac.get("counter") == 10
|
||||||
|
|
||||||
|
|
||||||
|
class TestResolveRole:
|
||||||
|
"""Test role resolution from groups."""
|
||||||
|
|
||||||
|
def test_resolve_role_admin(self):
|
||||||
|
"""Test resolving admin role."""
|
||||||
|
groups = ["dashboard_admin", "other_group"]
|
||||||
|
role = resolve_role(groups)
|
||||||
|
assert role == "admin"
|
||||||
|
|
||||||
|
def test_resolve_role_member(self):
|
||||||
|
"""Test resolving member role."""
|
||||||
|
groups = ["dashboard_member"]
|
||||||
|
role = resolve_role(groups)
|
||||||
|
assert role == "member"
|
||||||
|
|
||||||
|
def test_resolve_role_viewer(self):
|
||||||
|
"""Test resolving viewer role."""
|
||||||
|
groups = ["dashboard_viewer", "unrelated_group"]
|
||||||
|
role = resolve_role(groups)
|
||||||
|
assert role == "viewer"
|
||||||
|
|
||||||
|
def test_resolve_role_no_match(self):
|
||||||
|
"""Test resolving role with no matching groups."""
|
||||||
|
groups = ["other_group", "another_group"]
|
||||||
|
role = resolve_role(groups)
|
||||||
|
assert role is None
|
||||||
|
|
||||||
|
def test_resolve_role_empty_groups(self):
|
||||||
|
"""Test resolving role with empty groups list."""
|
||||||
|
role = resolve_role([])
|
||||||
|
assert role is None
|
||||||
|
|
||||||
|
def test_resolve_role_priority(self):
|
||||||
|
"""Test that first matching group is used."""
|
||||||
|
groups = ["dashboard_admin", "dashboard_member"]
|
||||||
|
role = resolve_role(groups)
|
||||||
|
assert role == "admin"
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetPages:
|
||||||
|
"""Test page access resolution."""
|
||||||
|
|
||||||
|
def test_get_pages_admin_default(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test getting pages for admin with default settings."""
|
||||||
|
pages = get_pages("testuser", "admin")
|
||||||
|
assert pages == "*"
|
||||||
|
|
||||||
|
def test_get_pages_member_default(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test getting pages for member with default settings."""
|
||||||
|
pages = get_pages("testuser", "member")
|
||||||
|
assert isinstance(pages, list)
|
||||||
|
assert "dashboard" in pages
|
||||||
|
assert "docker" in pages
|
||||||
|
|
||||||
|
def test_get_pages_viewer_default(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test getting pages for viewer with default settings."""
|
||||||
|
pages = get_pages("testuser", "viewer")
|
||||||
|
assert pages == ["dashboard"]
|
||||||
|
|
||||||
|
def test_get_pages_with_user_override(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test getting pages with user-specific override."""
|
||||||
|
# Add user override
|
||||||
|
def add_override(data):
|
||||||
|
data["user_overrides"]["customuser"] = {"pages": ["dashboard", "files"]}
|
||||||
|
|
||||||
|
update_rbac(add_override)
|
||||||
|
|
||||||
|
pages = get_pages("customuser", "admin")
|
||||||
|
assert pages == ["dashboard", "files"]
|
||||||
|
|
||||||
|
def test_get_pages_unknown_role(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test getting pages for unknown role returns empty list."""
|
||||||
|
pages = get_pages("testuser", "unknown_role")
|
||||||
|
assert pages == []
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetSidebarLinks:
|
||||||
|
"""Test sidebar link access resolution."""
|
||||||
|
|
||||||
|
def test_get_sidebar_links_admin_default(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test getting sidebar links for admin."""
|
||||||
|
links = get_sidebar_links("testuser", "admin")
|
||||||
|
assert links == "*"
|
||||||
|
|
||||||
|
def test_get_sidebar_links_member_default(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test getting sidebar links for member."""
|
||||||
|
links = get_sidebar_links("testuser", "member")
|
||||||
|
assert links == "*"
|
||||||
|
|
||||||
|
def test_get_sidebar_links_viewer_default(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test getting sidebar links for viewer."""
|
||||||
|
links = get_sidebar_links("testuser", "viewer")
|
||||||
|
assert links == ["dashboard"]
|
||||||
|
|
||||||
|
def test_get_sidebar_links_with_user_override(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test getting sidebar links with user override."""
|
||||||
|
def add_override(data):
|
||||||
|
data["user_overrides"]["customuser"] = {
|
||||||
|
"pages": "*",
|
||||||
|
"sidebar_links": ["dashboard", "docker", "files"]
|
||||||
|
}
|
||||||
|
|
||||||
|
update_rbac(add_override)
|
||||||
|
|
||||||
|
links = get_sidebar_links("customuser", "admin")
|
||||||
|
assert links == ["dashboard", "docker", "files"]
|
||||||
|
|
||||||
|
def test_get_sidebar_links_no_override(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test that user without sidebar_links override gets role default."""
|
||||||
|
def add_override(data):
|
||||||
|
data["user_overrides"]["customuser"] = {"pages": ["dashboard"]}
|
||||||
|
# No sidebar_links specified
|
||||||
|
|
||||||
|
update_rbac(add_override)
|
||||||
|
|
||||||
|
links = get_sidebar_links("customuser", "admin")
|
||||||
|
assert links == "*" # Should fall back to admin default
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetSidebarOrder:
|
||||||
|
"""Test sidebar order retrieval."""
|
||||||
|
|
||||||
|
def test_get_sidebar_order_no_override(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test getting sidebar order when user has no override."""
|
||||||
|
order = get_sidebar_order("testuser")
|
||||||
|
assert order is None
|
||||||
|
|
||||||
|
def test_get_sidebar_order_with_override(self, mock_config, temp_rbac_file):
|
||||||
|
"""Test getting sidebar order with user override."""
|
||||||
|
custom_order = {
|
||||||
|
"Main": ["dashboard", "docker"],
|
||||||
|
"Media": ["navidrome", "immich"]
|
||||||
|
}
|
||||||
|
|
||||||
|
def add_override(data):
|
||||||
|
data["user_overrides"]["customuser"] = {"sidebar_order": custom_order}
|
||||||
|
|
||||||
|
update_rbac(add_override)
|
||||||
|
|
||||||
|
order = get_sidebar_order("customuser")
|
||||||
|
assert order == custom_order
|
||||||
|
|
||||||
|
|
||||||
|
class TestDefaultRBAC:
|
||||||
|
"""Test default RBAC configuration."""
|
||||||
|
|
||||||
|
def test_default_rbac_structure(self):
|
||||||
|
"""Test that DEFAULT_RBAC has correct structure."""
|
||||||
|
assert "role_defaults" in DEFAULT_RBAC
|
||||||
|
assert "user_overrides" in DEFAULT_RBAC
|
||||||
|
|
||||||
|
assert "admin" in DEFAULT_RBAC["role_defaults"]
|
||||||
|
assert "member" in DEFAULT_RBAC["role_defaults"]
|
||||||
|
assert "viewer" in DEFAULT_RBAC["role_defaults"]
|
||||||
|
|
||||||
|
def test_default_rbac_admin_permissions(self):
|
||||||
|
"""Test admin has full permissions by default."""
|
||||||
|
admin = DEFAULT_RBAC["role_defaults"]["admin"]
|
||||||
|
assert admin["pages"] == "*"
|
||||||
|
assert admin["sidebar_links"] == "*"
|
||||||
|
|
||||||
|
def test_default_rbac_member_permissions(self):
|
||||||
|
"""Test member has limited permissions."""
|
||||||
|
member = DEFAULT_RBAC["role_defaults"]["member"]
|
||||||
|
assert isinstance(member["pages"], list)
|
||||||
|
assert "dashboard" in member["pages"]
|
||||||
|
assert member["sidebar_links"] == "*"
|
||||||
|
|
||||||
|
def test_default_rbac_viewer_permissions(self):
|
||||||
|
"""Test viewer has minimal permissions."""
|
||||||
|
viewer = DEFAULT_RBAC["role_defaults"]["viewer"]
|
||||||
|
assert viewer["pages"] == ["dashboard"]
|
||||||
|
assert viewer["sidebar_links"] == ["dashboard"]
|
||||||
|
|
||||||
|
|
||||||
|
class TestRoleGroupMap:
|
||||||
|
"""Test role group mapping."""
|
||||||
|
|
||||||
|
def test_role_group_map_completeness(self):
|
||||||
|
"""Test that ROLE_GROUP_MAP has all expected mappings."""
|
||||||
|
assert "dashboard_admin" in ROLE_GROUP_MAP
|
||||||
|
assert "dashboard_member" in ROLE_GROUP_MAP
|
||||||
|
assert "dashboard_viewer" in ROLE_GROUP_MAP
|
||||||
|
|
||||||
|
assert ROLE_GROUP_MAP["dashboard_admin"] == "admin"
|
||||||
|
assert ROLE_GROUP_MAP["dashboard_member"] == "member"
|
||||||
|
assert ROLE_GROUP_MAP["dashboard_viewer"] == "viewer"
|
||||||
@@ -5,12 +5,19 @@
|
|||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "vite",
|
"dev": "vite",
|
||||||
"build": "vite build"
|
"build": "vite build",
|
||||||
|
"test": "vitest",
|
||||||
|
"test:ui": "vitest --ui",
|
||||||
|
"test:coverage": "vitest --coverage"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@sveltejs/vite-plugin-svelte": "^6.2.0",
|
"@sveltejs/vite-plugin-svelte": "^6.2.0",
|
||||||
|
"@testing-library/svelte": "^5.2.3",
|
||||||
|
"@vitest/coverage-v8": "^2.1.8",
|
||||||
|
"jsdom": "^25.0.1",
|
||||||
"svelte": "^5.0.0",
|
"svelte": "^5.0.0",
|
||||||
"vite": "^6.3.0",
|
"vite": "^6.3.0",
|
||||||
|
"vitest": "^2.1.8",
|
||||||
"tailwindcss": "^4.0.0",
|
"tailwindcss": "^4.0.0",
|
||||||
"@tailwindcss/vite": "^4.0.0"
|
"@tailwindcss/vite": "^4.0.0"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -296,7 +296,9 @@
|
|||||||
ws.send("__ping__");
|
ws.send("__ping__");
|
||||||
// Set timeout to detect missing pong
|
// Set timeout to detect missing pong
|
||||||
pongTimeout = setTimeout(() => {
|
pongTimeout = setTimeout(() => {
|
||||||
if (ws.readyState === 1) {
|
// Check if still the same WebSocket instance and still open
|
||||||
|
const currentTab = tabData.get(tabId);
|
||||||
|
if (currentTab?.ws === ws && ws.readyState === 1) {
|
||||||
ws.close(1000, "keepalive ping timeout");
|
ws.close(1000, "keepalive ping timeout");
|
||||||
}
|
}
|
||||||
}, PONG_TIMEOUT);
|
}, PONG_TIMEOUT);
|
||||||
@@ -339,8 +341,8 @@
|
|||||||
};
|
};
|
||||||
ws.onclose = async (e) => {
|
ws.onclose = async (e) => {
|
||||||
const reason = e.reason || `Connection closed (code ${e.code})`;
|
const reason = e.reason || `Connection closed (code ${e.code})`;
|
||||||
d = tabData.get(tabId);
|
const tabState = tabData.get(tabId);
|
||||||
if (d) d.ws = null;
|
if (tabState) tabState.ws = null;
|
||||||
|
|
||||||
// Handle auth failures (code 1008)
|
// Handle auth failures (code 1008)
|
||||||
if (e.code === 1008) {
|
if (e.code === 1008) {
|
||||||
@@ -355,8 +357,8 @@
|
|||||||
// Try to refresh session
|
// Try to refresh session
|
||||||
if (!closedManually && !authRecoveryInFlight) {
|
if (!closedManually && !authRecoveryInFlight) {
|
||||||
authRecoveryInFlight = true;
|
authRecoveryInFlight = true;
|
||||||
|
try {
|
||||||
const refreshed = await tryRefreshSession();
|
const refreshed = await tryRefreshSession();
|
||||||
authRecoveryInFlight = false;
|
|
||||||
if (refreshed && !closedManually) {
|
if (refreshed && !closedManually) {
|
||||||
reconnecting = true;
|
reconnecting = true;
|
||||||
updateTab(tabId, {
|
updateTab(tabId, {
|
||||||
@@ -368,6 +370,11 @@
|
|||||||
void connect(false);
|
void connect(false);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
} catch (err) {
|
||||||
|
console.error("Session refresh failed:", err);
|
||||||
|
} finally {
|
||||||
|
authRecoveryInFlight = false;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
handleAuthExpired("Session expired — please log in again");
|
handleAuthExpired("Session expired — please log in again");
|
||||||
return;
|
return;
|
||||||
@@ -382,8 +389,8 @@
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
ws.onerror = () => {
|
ws.onerror = () => {
|
||||||
d = tabData.get(tabId);
|
const tabState = tabData.get(tabId);
|
||||||
if (d) d.ws = null;
|
if (tabState) tabState.ws = null;
|
||||||
if (!closedManually) scheduleReconnect("Connection failed");
|
if (!closedManually) scheduleReconnect("Connection failed");
|
||||||
else updateTab(tabId, { connected: false, error: "Connection failed" });
|
else updateTab(tabId, { connected: false, error: "Connection failed" });
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -0,0 +1,50 @@
|
|||||||
|
/**
|
||||||
|
* Component tests for Login.svelte
|
||||||
|
*/
|
||||||
|
import { describe, it, expect, beforeEach, vi } from 'vitest';
|
||||||
|
import { render, screen, fireEvent } from '@testing-library/svelte';
|
||||||
|
import Login from '../../src/routes/Login.svelte';
|
||||||
|
|
||||||
|
// Mock the API module
|
||||||
|
vi.mock('../../src/lib/api.js', () => ({
|
||||||
|
login: vi.fn(),
|
||||||
|
setToken: vi.fn(),
|
||||||
|
setCurrentUser: vi.fn(),
|
||||||
|
}));
|
||||||
|
|
||||||
|
describe('Login Component', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
vi.clearAllMocks();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should render login form', () => {
|
||||||
|
render(Login);
|
||||||
|
|
||||||
|
// Check for username and password inputs
|
||||||
|
expect(screen.getByLabelText(/username/i) || screen.getByPlaceholderText(/username/i)).toBeTruthy();
|
||||||
|
expect(screen.getByLabelText(/password/i) || screen.getByPlaceholderText(/password/i)).toBeTruthy();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should have login button', () => {
|
||||||
|
render(Login);
|
||||||
|
|
||||||
|
const loginButton = screen.getByRole('button', { name: /login/i }) ||
|
||||||
|
screen.getByText(/login/i);
|
||||||
|
expect(loginButton).toBeTruthy();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should accept user input', async () => {
|
||||||
|
render(Login);
|
||||||
|
|
||||||
|
const usernameInput = screen.getByLabelText(/username/i) ||
|
||||||
|
screen.getByPlaceholderText(/username/i);
|
||||||
|
const passwordInput = screen.getByLabelText(/password/i) ||
|
||||||
|
screen.getByPlaceholderText(/password/i);
|
||||||
|
|
||||||
|
await fireEvent.input(usernameInput, { target: { value: 'testuser' } });
|
||||||
|
await fireEvent.input(passwordInput, { target: { value: 'testpass' } });
|
||||||
|
|
||||||
|
expect(usernameInput.value).toBe('testuser');
|
||||||
|
expect(passwordInput.value).toBe('testpass');
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
/**
|
||||||
|
* Global test setup for Vitest
|
||||||
|
*/
|
||||||
|
import { vi } from 'vitest';
|
||||||
|
|
||||||
|
// Mock Web APIs that may not be available in jsdom
|
||||||
|
|
||||||
|
// Mock WebSocket
|
||||||
|
global.WebSocket = class MockWebSocket {
|
||||||
|
constructor(url) {
|
||||||
|
this.url = url;
|
||||||
|
this.readyState = 0; // CONNECTING
|
||||||
|
setTimeout(() => {
|
||||||
|
this.readyState = 1; // OPEN
|
||||||
|
this.onopen?.();
|
||||||
|
}, 0);
|
||||||
|
}
|
||||||
|
send(data) {}
|
||||||
|
close() {
|
||||||
|
this.readyState = 3; // CLOSED
|
||||||
|
this.onclose?.();
|
||||||
|
}
|
||||||
|
addEventListener(event, handler) {
|
||||||
|
this[`on${event}`] = handler;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// Mock Web Speech API
|
||||||
|
global.SpeechRecognition = vi.fn(() => ({
|
||||||
|
start: vi.fn(),
|
||||||
|
stop: vi.fn(),
|
||||||
|
abort: vi.fn(),
|
||||||
|
addEventListener: vi.fn(),
|
||||||
|
removeEventListener: vi.fn()
|
||||||
|
}));
|
||||||
|
|
||||||
|
global.webkitSpeechRecognition = global.SpeechRecognition;
|
||||||
|
|
||||||
|
global.speechSynthesis = {
|
||||||
|
speak: vi.fn(),
|
||||||
|
cancel: vi.fn(),
|
||||||
|
pause: vi.fn(),
|
||||||
|
resume: vi.fn(),
|
||||||
|
getVoices: vi.fn(() => [])
|
||||||
|
};
|
||||||
|
|
||||||
|
global.SpeechSynthesisUtterance = vi.fn();
|
||||||
|
|
||||||
|
// Mock WebAuthn
|
||||||
|
global.navigator.credentials = {
|
||||||
|
create: vi.fn(),
|
||||||
|
get: vi.fn()
|
||||||
|
};
|
||||||
|
|
||||||
|
// Mock localStorage
|
||||||
|
const localStorageMock = {
|
||||||
|
getItem: vi.fn(),
|
||||||
|
setItem: vi.fn(),
|
||||||
|
removeItem: vi.fn(),
|
||||||
|
clear: vi.fn()
|
||||||
|
};
|
||||||
|
global.localStorage = localStorageMock;
|
||||||
|
|
||||||
|
// Mock ResizeObserver
|
||||||
|
global.ResizeObserver = vi.fn(() => ({
|
||||||
|
observe: vi.fn(),
|
||||||
|
unobserve: vi.fn(),
|
||||||
|
disconnect: vi.fn()
|
||||||
|
}));
|
||||||
|
|
||||||
|
// Mock MutationObserver
|
||||||
|
global.MutationObserver = vi.fn(() => ({
|
||||||
|
observe: vi.fn(),
|
||||||
|
disconnect: vi.fn(),
|
||||||
|
takeRecords: vi.fn(() => [])
|
||||||
|
}));
|
||||||
|
|
||||||
|
// Mock fetch
|
||||||
|
global.fetch = vi.fn();
|
||||||
|
|
||||||
|
// Reset mocks before each test
|
||||||
|
beforeEach(() => {
|
||||||
|
vi.clearAllMocks();
|
||||||
|
localStorageMock.getItem.mockReturnValue(null);
|
||||||
|
});
|
||||||
@@ -0,0 +1,397 @@
|
|||||||
|
/**
|
||||||
|
* Unit tests for API client (api.js)
|
||||||
|
*/
|
||||||
|
import { describe, it, expect, beforeEach, vi } from 'vitest';
|
||||||
|
import {
|
||||||
|
setToken,
|
||||||
|
getToken,
|
||||||
|
setCurrentUser,
|
||||||
|
currentUser,
|
||||||
|
get,
|
||||||
|
post,
|
||||||
|
del,
|
||||||
|
put,
|
||||||
|
login,
|
||||||
|
checkAuth,
|
||||||
|
logout,
|
||||||
|
tryRefreshSession,
|
||||||
|
} from '../src/lib/api.js';
|
||||||
|
|
||||||
|
describe('API Client - Token Management', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
localStorage.clear();
|
||||||
|
setToken('');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should set and get token', () => {
|
||||||
|
setToken('test-token-123');
|
||||||
|
expect(getToken()).toBe('test-token-123');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should store token in localStorage', () => {
|
||||||
|
setToken('test-token-123');
|
||||||
|
expect(localStorage.setItem).toHaveBeenCalledWith('token', 'test-token-123');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should remove token from localStorage when cleared', () => {
|
||||||
|
setToken('test-token-123');
|
||||||
|
setToken('');
|
||||||
|
expect(localStorage.removeItem).toHaveBeenCalledWith('token');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should set current user', () => {
|
||||||
|
const user = { username: 'testuser', role: 'admin', pages: ['dashboard'] };
|
||||||
|
setCurrentUser(user);
|
||||||
|
expect(currentUser).toEqual(user);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('API Client - GET Requests', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
vi.clearAllMocks();
|
||||||
|
setToken('test-token');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should make GET request with auth header', async () => {
|
||||||
|
const mockData = { result: 'success' };
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: true,
|
||||||
|
status: 200,
|
||||||
|
json: async () => mockData,
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await get('/test/endpoint');
|
||||||
|
|
||||||
|
expect(fetch).toHaveBeenCalledWith(
|
||||||
|
'/api/test/endpoint',
|
||||||
|
expect.objectContaining({
|
||||||
|
headers: expect.objectContaining({
|
||||||
|
Authorization: 'Bearer test-token',
|
||||||
|
}),
|
||||||
|
})
|
||||||
|
);
|
||||||
|
expect(result).toEqual(mockData);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should make GET request without auth header when no token', async () => {
|
||||||
|
setToken('');
|
||||||
|
const mockData = { result: 'success' };
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: true,
|
||||||
|
status: 200,
|
||||||
|
json: async () => mockData,
|
||||||
|
});
|
||||||
|
|
||||||
|
await get('/test/endpoint');
|
||||||
|
|
||||||
|
expect(fetch).toHaveBeenCalledWith(
|
||||||
|
'/api/test/endpoint',
|
||||||
|
expect.objectContaining({
|
||||||
|
headers: expect.not.objectContaining({
|
||||||
|
Authorization: expect.anything(),
|
||||||
|
}),
|
||||||
|
})
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should throw error on 404', async () => {
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: false,
|
||||||
|
status: 404,
|
||||||
|
json: async () => ({ error: 'Not found' }),
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(get('/test/endpoint')).rejects.toThrow('HTTP 404');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('API Client - POST Requests', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
vi.clearAllMocks();
|
||||||
|
setToken('test-token');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should make POST request with JSON body', async () => {
|
||||||
|
const mockData = { result: 'created' };
|
||||||
|
const postData = { name: 'test', value: 123 };
|
||||||
|
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: true,
|
||||||
|
status: 200,
|
||||||
|
json: async () => mockData,
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await post('/test/endpoint', postData);
|
||||||
|
|
||||||
|
expect(fetch).toHaveBeenCalledWith(
|
||||||
|
'/api/test/endpoint',
|
||||||
|
expect.objectContaining({
|
||||||
|
method: 'POST',
|
||||||
|
headers: expect.objectContaining({
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
Authorization: 'Bearer test-token',
|
||||||
|
}),
|
||||||
|
body: JSON.stringify(postData),
|
||||||
|
})
|
||||||
|
);
|
||||||
|
expect(result).toEqual(mockData);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('API Client - DELETE Requests', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
vi.clearAllMocks();
|
||||||
|
setToken('test-token');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should make DELETE request', async () => {
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: true,
|
||||||
|
status: 200,
|
||||||
|
json: async () => ({ message: 'deleted' }),
|
||||||
|
});
|
||||||
|
|
||||||
|
await del('/test/endpoint');
|
||||||
|
|
||||||
|
expect(fetch).toHaveBeenCalledWith(
|
||||||
|
'/api/test/endpoint',
|
||||||
|
expect.objectContaining({
|
||||||
|
method: 'DELETE',
|
||||||
|
})
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('API Client - PUT Requests', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
vi.clearAllMocks();
|
||||||
|
setToken('test-token');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should make PUT request with JSON body', async () => {
|
||||||
|
const putData = { name: 'updated' };
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: true,
|
||||||
|
status: 200,
|
||||||
|
json: async () => ({ result: 'updated' }),
|
||||||
|
});
|
||||||
|
|
||||||
|
await put('/test/endpoint', putData);
|
||||||
|
|
||||||
|
expect(fetch).toHaveBeenCalledWith(
|
||||||
|
'/api/test/endpoint',
|
||||||
|
expect.objectContaining({
|
||||||
|
method: 'PUT',
|
||||||
|
headers: expect.objectContaining({
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
}),
|
||||||
|
body: JSON.stringify(putData),
|
||||||
|
})
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('API Client - Authentication Methods', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
vi.clearAllMocks();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should login with credentials', async () => {
|
||||||
|
const mockResponse = {
|
||||||
|
access_token: 'new-token',
|
||||||
|
user: 'testuser',
|
||||||
|
role: 'admin',
|
||||||
|
};
|
||||||
|
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: true,
|
||||||
|
status: 200,
|
||||||
|
json: async () => mockResponse,
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await login({ username: 'testuser', password: 'pass123' });
|
||||||
|
|
||||||
|
expect(fetch).toHaveBeenCalledWith(
|
||||||
|
'/api/auth/login',
|
||||||
|
expect.objectContaining({
|
||||||
|
method: 'POST',
|
||||||
|
credentials: 'same-origin',
|
||||||
|
})
|
||||||
|
);
|
||||||
|
expect(result).toEqual(mockResponse);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should check auth status', async () => {
|
||||||
|
setToken('test-token');
|
||||||
|
const mockUser = { username: 'testuser', role: 'admin' };
|
||||||
|
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: true,
|
||||||
|
status: 200,
|
||||||
|
json: async () => mockUser,
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await checkAuth();
|
||||||
|
|
||||||
|
expect(fetch).toHaveBeenCalledWith('/api/auth/me', expect.anything());
|
||||||
|
expect(result).toEqual(mockUser);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should logout', async () => {
|
||||||
|
setToken('test-token');
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: true,
|
||||||
|
status: 200,
|
||||||
|
json: async () => ({ message: 'logged out' }),
|
||||||
|
});
|
||||||
|
|
||||||
|
await logout();
|
||||||
|
|
||||||
|
expect(fetch).toHaveBeenCalledWith(
|
||||||
|
'/api/auth/logout',
|
||||||
|
expect.objectContaining({
|
||||||
|
method: 'POST',
|
||||||
|
credentials: 'same-origin',
|
||||||
|
})
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('API Client - Token Refresh', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
vi.clearAllMocks();
|
||||||
|
setToken('');
|
||||||
|
localStorage.clear();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should refresh token from cookie', async () => {
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: true,
|
||||||
|
status: 200,
|
||||||
|
json: async () => ({ access_token: 'new-token' }),
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await tryRefreshSession();
|
||||||
|
|
||||||
|
expect(result).toBe(true);
|
||||||
|
expect(getToken()).toBe('new-token');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should try legacy refresh token if cookie refresh fails', async () => {
|
||||||
|
localStorage.getItem.mockReturnValue('legacy-refresh-token');
|
||||||
|
|
||||||
|
// First call (cookie) fails
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: false,
|
||||||
|
status: 401,
|
||||||
|
});
|
||||||
|
|
||||||
|
// Second call (legacy) succeeds
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: true,
|
||||||
|
status: 200,
|
||||||
|
json: async () => ({ access_token: 'new-token-from-legacy' }),
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await tryRefreshSession();
|
||||||
|
|
||||||
|
expect(result).toBe(true);
|
||||||
|
expect(getToken()).toBe('new-token-from-legacy');
|
||||||
|
expect(localStorage.removeItem).toHaveBeenCalledWith('refresh_token');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should return false if all refresh attempts fail', async () => {
|
||||||
|
global.fetch.mockResolvedValue({
|
||||||
|
ok: false,
|
||||||
|
status: 401,
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await tryRefreshSession();
|
||||||
|
|
||||||
|
expect(result).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should auto-refresh on 401 response', async () => {
|
||||||
|
setToken('expired-token');
|
||||||
|
|
||||||
|
// First request returns 401
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: false,
|
||||||
|
status: 401,
|
||||||
|
});
|
||||||
|
|
||||||
|
// Refresh succeeds
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: true,
|
||||||
|
status: 200,
|
||||||
|
json: async () => ({ access_token: 'refreshed-token' }),
|
||||||
|
});
|
||||||
|
|
||||||
|
// Retry original request succeeds
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: true,
|
||||||
|
status: 200,
|
||||||
|
json: async () => ({ data: 'success' }),
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await get('/test/endpoint');
|
||||||
|
|
||||||
|
expect(result).toEqual({ data: 'success' });
|
||||||
|
expect(getToken()).toBe('refreshed-token');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should clear token on final 401', async () => {
|
||||||
|
setToken('expired-token');
|
||||||
|
|
||||||
|
// First request returns 401
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: false,
|
||||||
|
status: 401,
|
||||||
|
});
|
||||||
|
|
||||||
|
// Refresh fails
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: false,
|
||||||
|
status: 401,
|
||||||
|
});
|
||||||
|
|
||||||
|
// Retry original request still 401
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: false,
|
||||||
|
status: 401,
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(get('/test/endpoint')).rejects.toThrow('Unauthorized');
|
||||||
|
expect(getToken()).toBe('');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('API Client - Error Handling', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
vi.clearAllMocks();
|
||||||
|
setToken('test-token');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should handle network errors', async () => {
|
||||||
|
global.fetch.mockRejectedValueOnce(new Error('Network error'));
|
||||||
|
|
||||||
|
await expect(get('/test/endpoint')).rejects.toThrow('Network error');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should include error body in thrown error', async () => {
|
||||||
|
const errorBody = { error: 'Bad request', details: 'Invalid input' };
|
||||||
|
global.fetch.mockResolvedValueOnce({
|
||||||
|
ok: false,
|
||||||
|
status: 400,
|
||||||
|
json: async () => errorBody,
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
await get('/test/endpoint');
|
||||||
|
expect.fail('Should have thrown');
|
||||||
|
} catch (error) {
|
||||||
|
expect(error.status).toBe(400);
|
||||||
|
expect(error.body).toEqual(errorBody);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
import { defineConfig } from 'vitest/config';
|
||||||
|
import { svelte } from '@sveltejs/vite-plugin-svelte';
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
|
plugins: [svelte({ hot: !process.env.VITEST })],
|
||||||
|
test: {
|
||||||
|
globals: true,
|
||||||
|
environment: 'jsdom',
|
||||||
|
setupFiles: ['./tests/setup.js'],
|
||||||
|
coverage: {
|
||||||
|
provider: 'v8',
|
||||||
|
reporter: ['text', 'html', 'lcov'],
|
||||||
|
exclude: ['node_modules/', 'tests/', 'dist/', '*.config.js']
|
||||||
|
}
|
||||||
|
},
|
||||||
|
resolve: {
|
||||||
|
alias: {
|
||||||
|
'@': '/src'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
# NAS Platform Comparison
|
||||||
|
|
||||||
|
| Feature | TrueNAS | Unraid | Synology (benchmark) |
|
||||||
|
|---|---|---|---|
|
||||||
|
| Cost | Free (CORE/SCALE) | $59–$129 license | Hardware + DSM included |
|
||||||
|
| OS Base | FreeBSD (CORE) / Linux (SCALE) | Linux (Slackware) | Linux (DSM) |
|
||||||
|
| File System | ZFS | XFS/Btrfs per disk, custom parity | Btrfs / ext4 |
|
||||||
|
| RAID Approach | ZFS pools (raidz1/2/3, mirror) | Custom parity (mixed disk sizes OK) | Standard RAID + SHR |
|
||||||
|
| Drive Flexibility | All drives in vdev must match | Mix any sizes, add one at a time | Must match within RAID group |
|
||||||
|
| Data Protection | ZFS checksums, scrubs, snapshots | Single/dual parity, no checksums on data | Btrfs checksums (if Btrfs), snapshots |
|
||||||
|
| VM Support | Yes (bhyve/KVM) | Yes (KVM, well-integrated) | Yes (Virtual Machine Manager) |
|
||||||
|
| Docker/Containers | Yes (SCALE has native K3s/Docker) | Yes (excellent Docker support) | Yes (Container Manager) |
|
||||||
|
| App Ecosystem | TrueCharts / built-in apps | Community Apps (large catalog) | Synology Package Center (curated) |
|
||||||
|
| Hardware | DIY / any x86 | DIY / any x86 | Proprietary appliance |
|
||||||
|
| Ease of Use | Moderate (more admin knowledge) | Easy (great web UI) | Easiest (polished consumer UX) |
|
||||||
|
| Performance | High (ZFS ARC caching, ECC RAM rec.) | Good (parity rebuild is slower) | Good for its hardware class |
|
||||||
|
| Best For | Data integrity, enterprise/homelab | Media server, flexible home storage | Set-and-forget, non-technical users |
|
||||||
Reference in New Issue
Block a user