camera

Testing and Coverage

This project has unit tests for the hub backend, firmware, and (in the future) UI.

✈️ Table of Pages

Below is a quick reference table of the main documentation pages.

Page	Description
What Sets it Apart	Why you should just do it yourself and the cost
MVP	High level project goals and summary
Status Tracker	Feature progress table
Unit Testing	Test and coverage instructions
Build It Yourself	Clone & Docker setup guide
Firmware	Firmware API reference
Hub Guide	Hub API reference
Communication Methods	Communication and architecture

---

What the tests cover

Hub

• Authentication workflow including token creation, password changes, and reset requests.
• Camera management endpoints for registering, updating, and deleting cameras.
• Streaming helpers such as the key exchange API, MJPEG endpoint fallback, and WebSocket relay.
• Utility functions like the built-in bandwidth speed test and database cleanup tasks.

Firmware

• Configuration storage on the SD card with config_set_* and config_load helpers.
• Passphrase reset logic to ensure recovery codes work as expected.
• Encrypted Wi-Fi storage verified by checking that passwords are Base64 encrypted and that backup settings persist.
• USB initialization through the usb_init() interface.

UI

• Vitest runs in a jsdom environment with the Vue plugin loaded.
• Shared helpers live in ui/src/__tests__/setup.ts.
• A sample test is available at ui/src/__tests__/CounterComponent.spec.ts.
• Run npm run test for a single pass.
• Use npm run test:watch while developing.

Running the tests

# hub
cd pi
pip install -r requirements.txt
pytest --cov=pi --cov-report=term-missing --cov-report=html

# firmware
cd ../esp/esp32-cammycam
bash ../../tools/pio_coverage.sh

# ui
cd ../../ui
npm ci
npm run test
npm run test:coverage

The goal is to maintain at least 69.42% overall coverage across the project.

Viewing Coverage Reports

After running the commands above each component will generate an HTML report:

• Hub – open pi/htmlcov/index.html to see the coverage summary. The settings for the Python collector live in coverage.ini.
• Firmware – tools/pio_coverage.sh writes results to esp/esp32-cammycam/coverage-report/index.html.
• UI – Vitest stores results under ui/coverage/index.html.

Keep the overall score above 69.42% to match the badge in the project README.

Test Workflow Diagram

requirementDiagram
    requirement Hub {
        id: HUB_TESTS
        text: pytest with coverage
        risk: medium
        verify: test
    }

    requirement Firmware {
        id: FW_TESTS
        text: PlatformIO unit tests
        risk: medium
        verify: test
    }

    requirement UI {
        id: UI_TESTS
        text: Vitest suite
        risk: low
        verify: test
    }

    testSuite overall {
        requirement Hub
        requirement Firmware
        requirement UI
    }