aitbc
f506b66211
Test Documentation Update - Complete: ✅ TEST DOCUMENTATION UPDATED: Comprehensive update reflecting recent changes - tests/docs/README.md: Updated with current project structure and locations - Added recent updates section documenting March 30, 2026 improvements - Removed duplicate content and cleaned up structure ✅ STRUCTURE IMPROVEMENTS DOCUMENTED: 📁 Scripts Organization: Test scripts moved to scripts/testing/ and scripts/utils/ 📁 Logs Consolidation: All test logs now in /var/log/aitbc/ 🐍 Virtual Environment: Using central /opt/aitbc/venv ⚙️ Development Environment: Using /etc/aitbc/.env for configuration ✅ UPDATED TEST STRUCTURE: 📁 tests/: Core test directory with conftest.py, test_runner.py, load_test.py 📁 scripts/testing/: Main testing scripts (comprehensive_e2e_test_fixed.py, test_workflow.sh) 📁 scripts/utils/: Testing utilities (setup.sh, requirements_migrator.py) 📁 /var/log/aitbc/: Centralized test logging location ✅ ENHANCED PREREQUISITES: 🐍 Environment Setup: Use central /opt/aitbc/venv virtual environment ⚙️ Configuration: Use /etc/aitbc/.env for environment settings 🔧 Services: Updated service requirements and status checking 📦 Dependencies: Updated to use central virtual environment ✅ IMPROVED RUNNING TESTS: 🚀 Quick Start: Updated commands for current structure 🎯 Specific Types: Unit, integration, CLI, performance tests 🔧 Advanced Testing: Scripts/testing/ directory usage 📊 Coverage: Updated coverage reporting instructions ✅ UPDATED TROUBLESHOOTING: 📋 Common Issues: Service status, environment, database problems 📝 Test Logs: All logs now in /var/log/aitbc/ 🔍 Getting Help: Updated help section with current locations ✅ CLEAN DOCUMENTATION: 📚 Removed duplicate content and old structure references 📖 Clear structure with recent updates section 🎯 Accurate instructions reflecting actual project organization 📅 Updated timestamp and contact information RESULT: Successfully updated test documentation to accurately reflect the current project structure after all organizational improvements, providing developers with current and accurate testing guidance.
240 lines
6.3 KiB
Markdown
240 lines
6.3 KiB
Markdown
# AITBC Test Suite - Updated Structure
|
|
|
|
This directory contains the comprehensive test suite for the AITBC platform, including unit tests, integration tests, end-to-end tests, security tests, and load tests.
|
|
|
|
## Recent Updates (March 30, 2026)
|
|
|
|
### ✅ Structure Improvements Completed
|
|
- **Scripts Organization**: Test scripts moved to `scripts/testing/` and `scripts/utils/`
|
|
- **Logs Consolidation**: All test logs now in `/var/log/aitbc/`
|
|
- **Virtual Environment**: Using central `/opt/aitbc/venv`
|
|
- **Development Environment**: Using `/etc/aitbc/.env` for configuration
|
|
|
|
## Table of Contents
|
|
|
|
1. [Test Structure](#test-structure)
|
|
2. [Prerequisites](#prerequisites)
|
|
3. [Running Tests](#running-tests)
|
|
4. [Test Types](#test-types)
|
|
5. [Configuration](#configuration)
|
|
6. [CI/CD Integration](#cicd-integration)
|
|
7. [Troubleshooting](#troubleshooting)
|
|
|
|
## Test Structure
|
|
|
|
```
|
|
tests/
|
|
├── conftest.py # Shared fixtures and configuration
|
|
├── test_runner.py # Test suite runner script
|
|
├── load_test.py # Load testing utilities
|
|
├── integration_test.sh # Integration test shell script
|
|
├── docs/ # Test documentation
|
|
│ ├── README.md
|
|
│ ├── USAGE_GUIDE.md
|
|
│ ├── TEST_REFACTORING_COMPLETED.md
|
|
│ └── test-integration-completed.md
|
|
├── e2e/ # End-to-end tests
|
|
├── fixtures/ # Test fixtures and data
|
|
├── openclaw_marketplace/ # OpenClaw marketplace tests
|
|
├── .pytest_cache/ # Pytest cache (auto-generated)
|
|
└── __pycache__/ # Python cache (auto-generated)
|
|
```
|
|
|
|
### Related Test Scripts
|
|
```
|
|
scripts/testing/ # Main testing scripts
|
|
├── comprehensive_e2e_test_fixed.py # Comprehensive E2E testing
|
|
├── test_workflow.sh # Workflow testing
|
|
├── run_all_tests.sh # All tests runner
|
|
└── test-all-services.sh # Service testing
|
|
|
|
scripts/utils/ # Testing utilities
|
|
├── setup.sh # System setup (includes testing)
|
|
└── requirements_migrator.py # Dependency management
|
|
```
|
|
|
|
## Prerequisites
|
|
|
|
### Environment Setup
|
|
```bash
|
|
# Activate central virtual environment
|
|
source /opt/aitbc/venv/bin/activate
|
|
|
|
# Ensure test dependencies are installed
|
|
pip install pytest pytest-cov pytest-asyncio
|
|
|
|
# Set environment configuration
|
|
source /etc/aitbc/.env # Central environment configuration
|
|
```
|
|
|
|
### Service Requirements
|
|
- AITBC blockchain node running
|
|
- Coordinator API service active
|
|
- Database accessible (SQLite/PostgreSQL)
|
|
- GPU services (if running AI tests)
|
|
|
|
## Running Tests
|
|
|
|
### Quick Start
|
|
```bash
|
|
# Run all fast tests
|
|
python tests/test_runner.py
|
|
|
|
# Run comprehensive test suite
|
|
python tests/test_runner.py --all
|
|
|
|
# Run with coverage
|
|
python tests/test_runner.py --coverage
|
|
```
|
|
|
|
### Specific Test Types
|
|
```bash
|
|
# Unit tests only
|
|
python tests/test_runner.py --unit
|
|
|
|
# Integration tests only
|
|
python tests/test_runner.py --integration
|
|
|
|
# CLI tests only
|
|
python tests/test_runner.py --cli
|
|
|
|
# Performance tests
|
|
python tests/test_runner.py --performance
|
|
```
|
|
|
|
### Advanced Testing
|
|
```bash
|
|
# Comprehensive E2E testing
|
|
python scripts/testing/comprehensive_e2e_test_fixed.py
|
|
|
|
# Workflow testing
|
|
bash scripts/testing/test_workflow.sh
|
|
|
|
# All services testing
|
|
bash scripts/testing/test-all-services.sh
|
|
```
|
|
|
|
## Test Types
|
|
|
|
### Unit Tests
|
|
- **Location**: `tests/unit/` (if exists)
|
|
- **Purpose**: Test individual components in isolation
|
|
- **Speed**: Fast (< 1 second per test)
|
|
- **Coverage**: Core business logic
|
|
|
|
### Integration Tests
|
|
- **Location**: `tests/integration/` and `tests/e2e/`
|
|
- **Purpose**: Test component interactions
|
|
- **Speed**: Medium (1-10 seconds per test)
|
|
- **Coverage**: API endpoints, database operations
|
|
|
|
### End-to-End Tests
|
|
- **Location**: `tests/e2e/` and `scripts/testing/`
|
|
- **Purpose**: Test complete workflows
|
|
- **Speed**: Slow (10-60 seconds per test)
|
|
- **Coverage**: Full user scenarios
|
|
|
|
### Performance Tests
|
|
- **Location**: `tests/load_test.py`
|
|
- **Purpose**: Test system performance under load
|
|
- **Speed**: Variable (depends on test parameters)
|
|
- **Coverage**: API response times, throughput
|
|
|
|
## Configuration
|
|
|
|
### Test Configuration Files
|
|
- **pytest.ini**: Pytest configuration (in root)
|
|
- **conftest.py**: Shared fixtures and configuration
|
|
- **pyproject.toml**: Project-wide test configuration
|
|
|
|
### Environment Variables
|
|
```bash
|
|
# Test database (different from production)
|
|
TEST_DATABASE_URL=sqlite:///test_aitbc.db
|
|
|
|
# Test logging
|
|
TEST_LOG_LEVEL=DEBUG
|
|
TEST_LOG_FILE=/var/log/aitbc/test.log
|
|
|
|
# Test API endpoints
|
|
TEST_API_BASE_URL=http://localhost:8011
|
|
```
|
|
|
|
## CI/CD Integration
|
|
|
|
### GitHub Actions
|
|
Test suite is integrated with CI/CD pipeline:
|
|
- **Unit Tests**: Run on every push
|
|
- **Integration Tests**: Run on pull requests
|
|
- **E2E Tests**: Run on main branch
|
|
- **Performance Tests**: Run nightly
|
|
|
|
### Local CI Simulation
|
|
```bash
|
|
# Simulate CI pipeline locally
|
|
python tests/test_runner.py --all --coverage
|
|
|
|
# Generate coverage report
|
|
coverage html -o coverage_html/
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
### Common Issues
|
|
|
|
#### Test Failures Due to Services
|
|
```bash
|
|
# Check service status
|
|
systemctl status aitbc-blockchain-node
|
|
systemctl status aitbc-coordinator
|
|
|
|
# Restart services if needed
|
|
sudo systemctl restart aitbc-blockchain-node
|
|
sudo systemctl restart aitbc-coordinator
|
|
```
|
|
|
|
#### Environment Issues
|
|
```bash
|
|
# Check virtual environment
|
|
which python
|
|
python --version
|
|
|
|
# Check dependencies
|
|
pip list | grep pytest
|
|
|
|
# Reinstall if needed
|
|
pip install -e .
|
|
```
|
|
|
|
#### Database Issues
|
|
```bash
|
|
# Reset test database
|
|
rm test_aitbc.db
|
|
python -m alembic upgrade head
|
|
|
|
# Check database connectivity
|
|
python -c "from aitbc_core.db import engine; print(engine.url)"
|
|
```
|
|
|
|
### Test Logs
|
|
All test logs are now centralized in `/var/log/aitbc/`:
|
|
- **test.log**: General test output
|
|
- **test_results.txt**: Test results summary
|
|
- **performance_test.log**: Performance test results
|
|
|
|
### Getting Help
|
|
1. Check test logs in `/var/log/aitbc/`
|
|
2. Review test documentation in `tests/docs/`
|
|
3. Run tests with verbose output: `pytest -v`
|
|
4. Check service status and configuration
|
|
|
|
---
|
|
|
|
*Last updated: March 30, 2026*
|
|
*For questions or suggestions, please open an issue or contact the development team.*
|
|
|
|
---
|
|
|
|
*Last updated: March 30, 2026*
|
|
*For questions or suggestions, please open an issue or contact the development team.*
|