TESTING.md

Testing

Testing instructions and guidance are listed here. All unit tests are written using the pytest library.

Cloning The Repository

This repository is managed by Astral uv Python package manager and can be installed by cloning the repository and syncing with uv.

git clone git@gitlab.com:micropython-iot-projects/libraries/micropython-networkutils.git
cd micropython-networkutils
uv sync --all-extras

Activate Virtual Environment

Activate the virtual environment:

. .venv/bin/activate

Test Layout

...
├── tests                                      <-- Main test directory
│   ├── integration                            <-- Integration tests
│   │   ├── __init__.py
│   │   └── test_connection_and_package.py     <-- WIP for integration tests
│   ├── unit                                   <-- Unit tests
│   │   ├── __init__.py
│   │   ├── test_network_config.py             <-- Network configuration tests
│   │   ├── test_network_interface_complete.py <-- Complete interface tests
│   │   └── test_network_interface_complex.py  <-- Complex interface unit tests
│   ├── __init__.py
│   └── conftest.py                            <-- Fixtures & mocks for MicroPython modules

Unit Testing

The unit test functions can be run with the following command:

pytest --cov=networkutils -v

Integration Testing

Important

Integration tests (tests/integration) are a WIP.

Having experimented with mpremote, I have found a way to install the networkutils package and connect to a microcontroller in a script context, rather than through the CLI. Through a programmatic connection to the REPL, it is possible to send commands that utilise and test the package on the device, returning any output as a string for assertions within pytest functions.

A serial_connection fixture with 'module' scope ensures all tests use the same SerialTransport instance, which is used to send commands over the raw REPL. If the fixture raises an exception or all tests have skipped/failed/completed, cleanup and teardown of the connection is carried out by the fixture.

Note

Integration tests will skip, if a device is not connected or if the serial connection failed.

Integration Testing Flow

flowchart TD
    A([Run Pytest])
    B([serial_connection fixture])
    C{SerialTransport}
    D([Assert open connection])
    E{Connected}
    F([Yield SerialTransport])
    G([test_enter_raw_repl])
    H([test_package_installation])
    I([test_package_import])
    J([test_network_config])
    K{Results}
    L([Log output])
    M([Test Summary])
    N([serial_connection fixture<br/>cleanup & teardown])

    A --> B
    B --> C
    C -- No --> N
    C -- Yes --> D
    D --> E
    E -- True --> F
    E -- False --> N
    F --> G
    G --> H
    H --> I
    I --> J
    J --> K
    K -- Fail --> L
    K -- Pass --> M
    L --> M
    M --> N

Loading