1
0
mirror of https://github.com/qt/qtmqtt.git synced 2026-10-25 16:16:26 +00:00

Add README for using auto tests

As running the unit tests requires a specific setup, this should be
documented.

Change-Id: Ia9059e6590c54bd232842fc02a4dc91dd630f48f
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
This commit is contained in:
Maurice Kalinowski 2018-01-30 12:58:01 +01:00
parent 68fe97befd
commit 91df4c8ef8

21
tests/README.txt Normal file
View File

@ -0,0 +1,21 @@
The tests included in the subdirectories check for functionality and
conformance of the Qt MQTT module.
To be able to run the tests successfully, a broker needs to be available and
reachable.
The continuous integration utilized the paho conformance test broker. It can
be obtained at this location:
https://github.com/eclipse/paho.mqtt.testing
For the unit tests being able to locate this script, use the
MQTT_TEST_BROKER_LOCATION environment variable and set it
to “<install-path>/interoperability/startbroker.py”.
Alternatively, any broker can be instantiated and passed to the auto tests
by using the environment variable MQTT_TEST_BROKER. This must point to a
valid url. The broker must run on the standardized port 1883.
Note, that the unit tests verify functionality against the MQTT 3.1.1 version
of the standard, hence the broker needs to be compliant to the adherent
specifications.