Comprehensive Test Suite Implementation (293 tests, 99.3% passing)

.github/workflows/tests.yml

@@ -0,0 +1,136 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main, upstream_refactor ]
+  pull_request:
+    branches: [ main, upstream_refactor ]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.11', '3.12', '3.13']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+
+    - name: Install system dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y \
+          libportaudio2 \
+          libmpv-dev \
+          mpv \
+          build-essential
+
+    - name: Install Python dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest pytest-asyncio pytest-cov pytest-mock
+        pip install -e .
+
+    - name: Install development dependencies
+      run: |
+        pip install black flake8 mypy pylint
+
+    - name: Lint with flake8
+      run: |
+        # Stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # Exit-zero treats all errors as warnings
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
+    - name: Check formatting with black
+      run: |
+        black --check linux_voice_assistant/ tests/
+
+    - name: Type check with mypy
+      run: |
+        mypy linux_voice_assistant/ --ignore-missing-imports || true
+
+    - name: Run tests with pytest
+      run: |
+        pytest tests/ -v --tb=short --cov=linux_voice_assistant --cov-report=xml --cov-report=term-missing
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v4
+      with:
+        file: ./coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+        fail_ci_if_error: false
+
+  test-hardware:
+    runs-on: [self-hosted, linux]
+    if: github.event_name == 'workflow_dispatch'
+    strategy:
+      matrix:
+        hardware: [xvf3800, resppeaker2mic]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest pytest-asyncio
+        pip install -e .
+
+    - name: Run hardware-specific tests
+      run: |
+        pytest tests/ -v -m hardware -k ${{ matrix.hardware }}
+
+  test-performance:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch'
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest pytest-benchmark
+        pip install -e .
+
+    - name: Run performance benchmarks
+      run: |
+        pytest tests/ -v -m benchmark --benchmark-only
+
+  security-scan:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Run security scan
+      run: |
+        pip install bandit
+        bandit -r linux_voice_assistant/ -f json -o bandit-report.json || true
+
+    - name: Upload security scan results
+      uses: actions/upload-artifact@v4
+      with:
+        name: security-scan-results
+        path: bandit-report.json

README.md

@@ -236,6 +236,7 @@ linux-voice-assistant/
 │   ├── linux-voice-assistant-xvf3800.md        # ReSpeaker XVF3800 4-Mic USB Array configuration
 │   ├── linux-voice-assistant-xvf3800-mute.md    # Hardware mute button and LED sync details
 │   ├── lva-desktop.md                            # Running LVA on a Linux desktop with the tray client
+│   ├── testing-guide.md                        # Comprehensive testing documentation
 │   └── xvf3800_legacy_led_effects_mapping.md    # LED functions when running firmware older than 2.0.7
 ├── linux_voice_assistant
 │   ├── api_server.py                            # ESPHome API server
@@ -250,9 +251,11 @@ linux-voice-assistant/
 │   ├── __init__.py
 │   ├── led_controller.py                        # LED effects and state mapping
 │   ├── __main__.py                                # Application entry point
+│   ├── microwakeword.py                            # Micro wake word detection module
 │   ├── models.py                                # Shared state and data models
 │   ├── mpv_player.py                            # Media playback via mpv
 │   ├── mqtt_controller.py                        # MQTT discovery and entity management
+│   ├── openwakeword.py                              # Open wake word detection module
 │   ├── satellite.py                            # ESPHome voice assistant protocol
 │   ├── sendspin                                # Sendspin client subsystem
 │   │   ├── client.py                            # WebSocket connection and protocol
@@ -302,13 +305,30 @@ linux-voice-assistant/
 │   │   └── timer_finished.flac
 │   └── wakeup                                    # Wake word triggered sounds
 │       └── wake_word_triggered.flac
-├── tests
-│   ├── lva_mic_capture.py
-│   ├── ok_nabu.wav
-│   ├── test_microwakeword.py
-│   ├── test_openwakeword.py
-│   ├── xvf3800_hid_mute_probe.py
-│   └── xvf3800_probe.py
+├── tests                                              # Comprehensive test suite (293 tests, 99.3% passing)
+│   ├── README.md                                      # Test documentation
+│   ├── conftest.py                                    # Shared pytest fixtures
+│   ├── diagnose_imports.py                            # Import diagnostic utility
+│   ├── test_audio_engine.py                           # Audio engine tests
+│   ├── test_button_controller.py                      # Button controller tests
+│   ├── test_configuration.py                         # Configuration management tests
+│   ├── test_end_to_end_workflows.py                  # End-to-end integration tests
+│   ├── test_event_bus.py                              # Event system architecture tests
+│   ├── test_format_mac.py                             # MAC address formatting tests
+│   ├── test_led_controller.py                         # LED control tests
+│   ├── test_microwakeword.py                          # MicroWakeWord detection tests
+│   ├── test_mqtt_controller.py                        # MQTT integration tests
+│   ├── test_openwakeword.py                           # OpenWakeWord detection tests
+│   ├── test_sendspin_client.py                        # Sendspin client tests
+│   ├── test_sendspin_discovery.py                     # Sendspin discovery tests
+│   ├── test_state_management.py                       # State management tests
+│   ├── test_volume_management.py                      # Volume control tests
+│   ├── test_xvf3800_button_controller.py             # XVF3800 button hardware tests
+│   ├── test_xvf3800_led_backend.py                   # XVF3800 LED hardware tests
+│   ├── lva_mic_capture.py                             # Audio capture utility
+│   ├── ok_nabu.wav                                    # Test audio file
+│   ├── xvf3800_hid_mute_probe.py                     # XVF3800 hardware probe
+│   └── xvf3800_probe.py                               # XVF3800 device probe
 ├── wakewords                                    # Wake word models
 │   ├── alexa.json
 │   ├── alexa.tflite
@@ -359,6 +379,66 @@ linux-voice-assistant/
 
 ---
 
+## Development & Testing
+
+### Running Tests
+
+The project includes a comprehensive test suite covering the fork's new architecture:
+
+```bash
+# Install development dependencies
+./script/setup --dev
+
+# Run all tests
+./script/test
+
+# Run specific test file
+./script/test test_event_bus.py
+
+# Run with coverage report
+pytest tests/ --cov=linux_voice_assistant --cov-report=html
+
+# Run specific test with verbose output
+pytest tests/test_event_bus.py -v
+
+# Run excluding hardware tests
+pytest tests/ -m "not hardware"
+```
+
+### Test Structure
+
+- **Unit Tests**: Core architecture (EventBus, State, Configuration)
+- **Integration Tests**: Controllers and hardware abstractions
+- **Hardware Tests**: Physical device integration (XVF3800, ReSpeaker)
+- **End-to-End Tests**: Complete voice assistant workflows
+
+### Current Test Status
+
+- **Total Tests**: 293
+- **Passing**: 291 (99.3%)
+- **Skipped**: 2 (hardware-dependent tests)
+- **Test Framework**: pytest 7.4.4 with asyncio, mock, and coverage support
+
+See [Testing Guide](docs/testing-guide.md) for detailed testing documentation and [tests/README.md](tests/README.md) for test-specific information.
+
+### Code Quality
+
+```bash
+# Format code
+black linux_voice_assistant/ tests/
+
+# Lint code
+flake8 linux_voice_assistant/ tests/
+
+# Type checking
+mypy linux_voice_assistant/
+
+# Run diagnostics
+python tests/diagnose_imports.py
+```
+
+---
+
 ## License
 
 Licensed under the [Apache License 2.0](LICENSE.md).