#####
Tests
#####


*****
About
*****
- The Terkin Datalogger tests suite is executed within
  a ``pytest`` environment on regular CPython 3.x.
- The environment provides a fake filesystem and other
  infrastructure to invoke integration tests.
- Docker is used to spin up infrastructure services
  like Mosquitto in the background.


*****
Setup
*****

=====================
Install prerequisites
=====================

Docker
------
Infrastructure services may be invoked through Docker.

- https://docs.docker.com/install/linux/docker-ce/debian/
- https://docs.docker.com/docker-for-mac/install/
- https://docs.docker.com/docker-for-windows/wsl-tech-preview/


Mosquitto
---------
::

    apt install mosquitto
    systemctl start mosquitto


===================
Install environment
===================
Install 3rd-party MicroPython modules::

    make setup

Install pytest modules and addons::

    make setup-tests


*******
Operate
*******

=====
Basic
=====
Invoke whole test suite::

    make test

Invoke specific tests, with markers::

    # Only run tests tagged with "esp32".
    make test marker="esp32"

    # Don't run tests tagged with "docker".
    make test marker="not docker"

With log output::

    make test-verbose

With coverage report::

    make test-coverage

========
Advanced
========
Prepare::

    source .venv/bin/activate

Invoke specific tests, with names::

    pytest test --capture=no -k test_basic_esp32

Display detailed coverage report::

    coverage report --show-missing

Output full trace::

    pytest --full-trace --capture=no -vvvvvvv -m spot