Compare commits

..

13 Commits

Author SHA1 Message Date
hsaturn
da3ec41d71 Update network-tests.ino
Remove useless code
2022-01-10 05:27:15 +01:00
hsaturn
5f7b4537c8 Enhance PR#22 2022-01-05 02:03:42 +01:00
hsaturn
cce4fecac6 Fix test local_client_should_unregister_when_destroyed 2022-01-05 02:02:18 +01:00
hsaturn
737e217172 fix type return value 2022-01-05 02:01:22 +01:00
hsaturn
8fe3517894 added packed attribute for enums 2022-01-05 02:00:02 +01:00
hsaturn
710503663a better type management 2022-01-05 01:59:16 +01:00
hsaturn
a5b8afc0bd Added some ifdef for debugging purposes 2022-01-05 01:56:45 +01:00
terror
f1d3a15498 added reply to message subscribe and unsubscribe 2021-09-25 15:44:09 +03:00
hsaturn
dfd5983715 Rewrite comments and added hudge payload test 2021-09-20 01:57:40 +02:00
hsaturn
4dcc6a6cf4 Minor changes 2021-09-19 12:40:04 +02:00
hsaturn
b58f3e3d67 Merge branch 'issue_2_broken_large_payloads' into main 2021-09-17 22:35:28 +02:00
hsaturn
a6b3540cb8 Fix issue_2 : Broken large payloads 2021-09-17 22:32:00 +02:00
hsaturn
ccbf42f81b howto added for building and running tests 2021-09-17 19:58:24 +02:00
13 changed files with 511 additions and 118 deletions

View File

@@ -12,7 +12,7 @@ TinyMqtt is a small, fast and capable Mqtt Broker and Client for Esp8266 / Esp32
## Features ## Features
- Very (very !!) fast broker I saw it re-sent 1000 topics per second for two - Very fast broker I saw it re-sent 1000 topics per second for two
clients that had subscribed (payload ~15 bytes ESP8266). No topic lost. clients that had subscribed (payload ~15 bytes ESP8266). No topic lost.
The max I've seen was 2k msg/s (1 client 1 subscription) The max I've seen was 2k msg/s (1 client 1 subscription)
- Act as as a mqtt broker and/or a mqtt client - Act as as a mqtt broker and/or a mqtt client

View File

@@ -6,7 +6,7 @@
"type": "git", "type": "git",
"url": "https://github.com/hsaturn/TinyMqtt.git" "url": "https://github.com/hsaturn/TinyMqtt.git"
}, },
"version": "0.7.9", "version": "0.8.0",
"exclude": "", "exclude": "",
"examples": "examples/*/*.ino", "examples": "examples/*/*.ino",
"frameworks": "arduino", "frameworks": "arduino",

View File

@@ -1,5 +1,5 @@
name=TinyMqtt name=TinyMqtt
version=0.7.9 version=0.8.0
author=Francois BIOT, HSaturn, <hsaturn@gmail.com> author=Francois BIOT, HSaturn, <hsaturn@gmail.com>
maintainer=Francois BIOT, HSaturn, <hsaturn@gmail.com> maintainer=Francois BIOT, HSaturn, <hsaturn@gmail.com>
sentence=A tiny broker and client library for MQTT messaging. sentence=A tiny broker and client library for MQTT messaging.

View File

@@ -38,6 +38,7 @@
4. Simple _FMT mechanism ala printf, but without the typeunsafetyness 4. Simple _FMT mechanism ala printf, but without the typeunsafetyness
and no internal buffers for replaceable stream printing and no internal buffers for replaceable stream printing
*/ */
#pragma once
#ifndef ARDUINO_STREAMING #ifndef ARDUINO_STREAMING
#define ARDUINO_STREAMING #define ARDUINO_STREAMING

View File

@@ -1,13 +1,9 @@
#include "TinyMqtt.h" #include "TinyMqtt.h"
#include <sstream> #include <sstream>
void outstring(const char* prefix, const char*p, uint16_t len) #ifdef EPOXY_DUINO
{ std::map<MqttMessage::Type, int> MqttClient::counters;
return; #endif
Serial << prefix << "='";
while(len--) Serial << (char)*p++;
Serial << '\'' << endl;
}
MqttBroker::MqttBroker(uint16_t port) MqttBroker::MqttBroker(uint16_t port)
{ {
@@ -38,7 +34,11 @@ MqttClient::MqttClient(MqttBroker* parent, TcpClient* new_client)
#else #else
client = new WiFiClient(*new_client); client = new WiFiClient(*new_client);
#endif #endif
alive = millis()+5000; // client expires after 5s if no CONNECT msg #ifdef EPOXY_DUINO
alive = millis()+500000;
#else
alive = millis()+5000; // TODO MAGIC client expires after 5s if no CONNECT msg
#endif
} }
MqttClient::MqttClient(MqttBroker* parent, const std::string& id) MqttClient::MqttClient(MqttBroker* parent, const std::string& id)
@@ -84,7 +84,7 @@ void MqttClient::connect(MqttBroker* parentBroker)
void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka) void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka)
{ {
debug("cnx: closing"); debug("MqttClient::connect");
keep_alive = ka; keep_alive = ka;
close(); close();
if (client) delete client; if (client) delete client;
@@ -190,7 +190,7 @@ MqttError MqttBroker::subscribe(const Topic& topic, uint8_t qos)
return MqttNowhereToSend; return MqttNowhereToSend;
} }
MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, const MqttMessage& msg) const MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, MqttMessage& msg) const
{ {
MqttError retval = MqttOk; MqttError retval = MqttOk;
@@ -250,7 +250,11 @@ void MqttClient::clientAlive(uint32_t more_seconds)
{ {
if (keep_alive) if (keep_alive)
{ {
#ifdef EPOXY_DUINO
alive=millis()+500000;
#else
alive=millis()+1000*(keep_alive+more_seconds); alive=millis()+1000*(keep_alive+more_seconds);
#endif
} }
else else
alive=0; alive=0;
@@ -395,11 +399,8 @@ MqttError MqttClient::sendTopic(const Topic& topic, MqttMessage::Type type, uint
return msg.sendTo(this); return msg.sendTo(this);
} }
long MqttClient::counter=0; void MqttClient::processMessage(MqttMessage* mesg)
void MqttClient::processMessage(const MqttMessage* mesg)
{ {
counter++;
#ifdef TINY_MQTT_DEBUG #ifdef TINY_MQTT_DEBUG
if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::Type::PingResp) if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::Type::PingResp)
{ {
@@ -417,7 +418,11 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
uint16_t len; uint16_t len;
bool bclose=true; bool bclose=true;
switch(mesg->type() & 0XF0) #ifdef EPOXY_DUINO
counters[mesg->type()]++;
#endif
switch(mesg->type())
{ {
case MqttMessage::Type::Connect: case MqttMessage::Type::Connect:
if (mqtt_connected) if (mqtt_connected)
@@ -447,11 +452,9 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
if (mqtt_flags & FlagWill) // Will topic if (mqtt_flags & FlagWill) // Will topic
{ {
mesg->getString(payload, len); // Will Topic mesg->getString(payload, len); // Will Topic
outstring("WillTopic", payload, len);
payload += len; payload += len;
mesg->getString(payload, len); // Will Message mesg->getString(payload, len); // Will Message
outstring("WillMessage", payload, len);
payload += len; payload += len;
} }
// FIXME forgetting credential is allowed (security hole) // FIXME forgetting credential is allowed (security hole)
@@ -468,7 +471,9 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
payload += len; payload += len;
} }
Serial << "Connected client:" << clientId.c_str() << ", keep alive=" << keep_alive << '.' << endl; #ifdef TINY_MQTT_DEBUG
Serial << "Connected client:" << clientId.c_str() << ", keep alive=" << keep_alive << '.' << endl;
#endif
bclose = false; bclose = false;
mqtt_connected=true; mqtt_connected=true;
{ {
@@ -518,18 +523,25 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
payload = header+2; payload = header+2;
debug("un/subscribe loop"); debug("un/subscribe loop");
std::string qoss;
while(payload < mesg->end()) while(payload < mesg->end())
{ {
mesg->getString(payload, len); // Topic mesg->getString(payload, len); // Topic
debug( " topic (" << std::string(payload, len) << ')'); debug( " topic (" << std::string(payload, len) << ')');
outstring(" un/subscribes", payload, len);
// subscribe(Topic(payload, len)); // subscribe(Topic(payload, len));
Topic topic(payload, len); Topic topic(payload, len);
payload += len; payload += len;
if ((mesg->type() & 0XF0) == MqttMessage::Type::Subscribe) if (mesg->type() == MqttMessage::Type::Subscribe)
{ {
uint8_t qos = *payload++; uint8_t qos = *payload++;
if (qos != 0) debug("Unsupported QOS" << qos << endl); if (qos != 0)
{
debug("Unsupported QOS" << qos << endl);
qoss.push_back(0x80);
}
else
qoss.push_back(qos);
subscriptions.insert(topic); subscriptions.insert(topic);
} }
else else
@@ -541,7 +553,12 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
} }
debug("end loop"); debug("end loop");
bclose = false; bclose = false;
// TODO SUBACK
MqttMessage ack(mesg->type() == MqttMessage::Type::Subscribe ? MqttMessage::Type::SubAck : MqttMessage::Type::UnSuback);
ack.add(header[0]);
ack.add(header[1]);
ack.add(qoss.c_str(), qoss.size(), false);
ack.sendTo(this);
} }
break; break;
@@ -556,7 +573,7 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
#endif #endif
if (mqtt_connected or client == nullptr) if (mqtt_connected or client == nullptr)
{ {
uint8_t qos = mesg->type() & 0x6; uint8_t qos = mesg->flags();
payload = header; payload = header;
mesg->getString(payload, len); mesg->getString(payload, len);
Topic published(payload, len); Topic published(payload, len);
@@ -602,10 +619,12 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
}; };
if (bclose) if (bclose)
{ {
Serial << "*************** Error msg 0x" << _HEX(mesg->type()); #ifdef TINY_MQTT_DEBUG
mesg->hexdump("-------ERROR ------"); Serial << "*************** Error msg 0x" << _HEX(mesg->type());
dump(); mesg->hexdump("-------ERROR ------");
Serial << endl; dump();
Serial << endl;
#endif
close(); close();
} }
else else
@@ -627,6 +646,8 @@ MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pa
MqttMessage msg(MqttMessage::Publish); MqttMessage msg(MqttMessage::Publish);
msg.add(topic); msg.add(topic);
msg.add(payload, pay_length, false); msg.add(payload, pay_length, false);
msg.complete();
if (parent) if (parent)
{ {
return parent->publish(this, topic, msg); return parent->publish(this, topic, msg);
@@ -638,7 +659,7 @@ MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pa
} }
// republish a received publish if it matches any in subscriptions // republish a received publish if it matches any in subscriptions
MqttError MqttClient::publishIfSubscribed(const Topic& topic, const MqttMessage& msg) MqttError MqttClient::publishIfSubscribed(const Topic& topic, MqttMessage& msg)
{ {
MqttError retval=MqttOk; MqttError retval=MqttOk;
@@ -682,29 +703,23 @@ void MqttMessage::incoming(char in_byte)
switch(state) switch(state)
{ {
case FixedHeader: case FixedHeader:
size=0; size=MaxBufferLength;
state = Length; state = Length;
break; break;
case Length: case Length:
if (size==0)
if (size==MaxBufferLength)
size = in_byte & 0x7F; size = in_byte & 0x7F;
else if (size<128)
size += static_cast<uint16_t>(in_byte & 0x7F)<<7;
else else
state = Error; // Really don't want to handle msg with length > 16k size += static_cast<uint16_t>(in_byte & 0x7F)<<7;
if (size > MaxBufferLength) if (size > MaxBufferLength)
{
state = Error; state = Error;
}
else if ((in_byte & 0x80) == 0) else if ((in_byte & 0x80) == 0)
{ {
vheader = buffer.length(); vheader = buffer.length();
if (size==0) if (size==0)
state = Complete; state = Complete;
else if (size > 500) // TODO magic
{
state = Error;
}
else else
{ {
buffer.reserve(size); buffer.reserve(size);
@@ -726,8 +741,10 @@ void MqttMessage::incoming(char in_byte)
break; break;
case Complete: case Complete:
default: default:
Serial << "Spurious " << _HEX(in_byte) << endl; #ifdef TINY_MQTT_DEBUG
hexdump("spurious"); Serial << "Spurious " << _HEX(in_byte) << endl;
hexdump("spurious");
#endif
reset(); reset();
break; break;
} }
@@ -749,35 +766,21 @@ void MqttMessage::add(const char* p, size_t len, bool addLength)
while(len--) incoming(*p++); while(len--) incoming(*p++);
} }
void MqttMessage::encodeLength() const void MqttMessage::encodeLength()
{ {
if (state != Complete) if (state != Complete)
{ {
int length = buffer.size()-2; // 1 byte for header, 1 byte for pre-reserved length field. int length = buffer.size()-3; // 3 = 1 byte for header + 2 bytes for pre-reserved length field.
std::string::size_type ins=1; buffer[1] = 0x80 | (length & 0x7F);
do buffer[2] = (length >> 7);
{ vheader = 3;
uint8_t encoded(length & 0x7F);
length >>=7; // We could check that buffer[2] < 128 (end of length encoding)
if (length) encoded |= 0x80; state = Complete;
}
if (ins==1)
buffer[ins]=encoded;
else
buffer.insert(ins, 1, encoded);
// On pourrait optimiser, cet insert est couteux, il faudrait en fait non pas
// insérer, mais réserver 4 octets pour les remplir
// plus tard avec ke fixed header et la taille.
// Cela changerait en revanche le début du message qui ne serait plus
// buffer[0], mais buffer[0..3] selon la taille du message.
++ins;
} while (length);
state = Complete;
}
}; };
MqttError MqttMessage::sendTo(MqttClient* client) const MqttError MqttMessage::sendTo(MqttClient* client)
{ {
if (buffer.size()) if (buffer.size())
{ {
@@ -796,6 +799,8 @@ MqttError MqttMessage::sendTo(MqttClient* client) const
void MqttMessage::hexdump(const char* prefix) const void MqttMessage::hexdump(const char* prefix) const
{ {
(void)prefix;
#ifdef TINY_MQTT_DEBUG
uint16_t addr=0; uint16_t addr=0;
const int bytes_per_row = 8; const int bytes_per_row = 8;
const char* hex_to_str = " | "; const char* hex_to_str = " | ";
@@ -831,4 +836,5 @@ void MqttMessage::hexdump(const char* prefix) const
} }
Serial << endl; Serial << endl;
#endif
} }

View File

@@ -29,7 +29,7 @@
// #define TINY_MQTT_DEBUG // #define TINY_MQTT_DEBUG
#ifdef TINY_MQTT_DEBUG #ifdef TINY_MQTT_DEBUG
#define debug(what) { Serial << __LINE__ << ' ' << what << endl; delay(100); } #define debug(what) { Serial << (int)__LINE__ << ' ' << what << endl; delay(100); }
#else #else
#define debug(what) {} #define debug(what) {}
#endif #endif
@@ -42,7 +42,7 @@
using TcpServer = WiFiServer; using TcpServer = WiFiServer;
#endif #endif
enum MqttError enum __attribute__((packed)) MqttError
{ {
MqttOk = 0, MqttOk = 0,
MqttNowhereToSend=1, MqttNowhereToSend=1,
@@ -64,9 +64,9 @@ class Topic : public IndexedString
class MqttClient; class MqttClient;
class MqttMessage class MqttMessage
{ {
const uint16_t MaxBufferLength = 4096; //hard limit: 16k const uint16_t MaxBufferLength = 4096; //hard limit: 16k due to size decoding
public: public:
enum Type enum __attribute__((packed)) Type
{ {
Unknown = 0, Unknown = 0,
Connect = 0x10, Connect = 0x10,
@@ -76,12 +76,12 @@ class MqttMessage
Subscribe = 0x80, Subscribe = 0x80,
SubAck = 0x90, SubAck = 0x90,
UnSubscribe = 0xA0, UnSubscribe = 0xA0,
UnSuback = 0xB0, UnSuback = 0xB0,
PingReq = 0xC0, PingReq = 0xC0,
PingResp = 0xD0, PingResp = 0xD0,
Disconnect = 0xE0 Disconnect = 0xE0
}; };
enum State enum __attribute__((packed)) State
{ {
FixedHeader=0, FixedHeader=0,
Length=1, Length=1,
@@ -101,6 +101,7 @@ class MqttMessage
void add(const Topic& t) { add(t.str()); } void add(const Topic& t) { add(t.str()); }
const char* end() const { return &buffer[0]+buffer.size(); } const char* end() const { return &buffer[0]+buffer.size(); }
const char* getVHeader() const { return &buffer[vheader]; } const char* getVHeader() const { return &buffer[vheader]; }
void complete() { encodeLength(); }
void reset(); void reset();
@@ -110,34 +111,37 @@ class MqttMessage
Type type() const Type type() const
{ {
return state == Complete ? static_cast<Type>(buffer[0]) : Unknown; return state == Complete ? static_cast<Type>(buffer[0] & 0xF0) : Unknown;
} }
uint8_t flags() const { return static_cast<uint8_t>(buffer[0] & 0x0F); }
void create(Type type) void create(Type type)
{ {
buffer=(char)type; buffer=(decltype(buffer)::value_type)type;
buffer+='\0'; // reserved for msg length buffer+='\0'; // reserved for msg length byte 1/2
vheader=2; buffer+='\0'; // reserved for msg length byte 2/2 (fixed)
vheader=3; // Should never change
size=0; size=0;
state=Create; state=Create;
} }
MqttError sendTo(MqttClient*) const; MqttError sendTo(MqttClient*);
void hexdump(const char* prefix=nullptr) const; void hexdump(const char* prefix=nullptr) const;
private: private:
void encodeLength() const; void encodeLength();
mutable std::string buffer; // mutable -> sendTo() std::string buffer;
uint8_t vheader; uint8_t vheader;
uint16_t size; // bytes left to receive uint16_t size; // bytes left to receive
mutable State state; // mutable -> encodeLength() State state;
}; };
class MqttBroker; class MqttBroker;
class MqttClient class MqttClient
{ {
using CallBack = void (*)(const MqttClient* source, const Topic& topic, const char* payload, size_t payload_length); using CallBack = void (*)(const MqttClient* source, const Topic& topic, const char* payload, size_t payload_length);
enum Flags enum __attribute__((packed)) Flags
{ {
FlagUserName = 128, FlagUserName = 128,
FlagPassword = 64, FlagPassword = 64,
@@ -158,6 +162,8 @@ class MqttClient
void connect(MqttBroker* parent); void connect(MqttBroker* parent);
void connect(std::string broker, uint16_t port, uint16_t keep_alive = 10); void connect(std::string broker, uint16_t port, uint16_t keep_alive = 10);
// TODO it seems that connected returns true in tcp mode even if
// no negociation occured (only if tcp link is established)
bool connected() { return bool connected() { return
(parent!=nullptr and client==nullptr) or (parent!=nullptr and client==nullptr) or
(client and client->connected()); } (client and client->connected()); }
@@ -196,27 +202,32 @@ class MqttClient
void dump(std::string indent="") void dump(std::string indent="")
{ {
uint32_t ms=millis(); (void)indent;
Serial << indent << "+-- " << '\'' << clientId.c_str() << "' " << (connected() ? " ON " : " OFF"); #ifdef TINY_MQTT_DEBUG
Serial << ", alive=" << alive << '/' << ms << ", ka=" << keep_alive << ' '; uint32_t ms=millis();
Serial << (client && client->connected() ? "" : "dis") << "connected"; Serial << indent << "+-- " << '\'' << clientId.c_str() << "' " << (connected() ? " ON " : " OFF");
if (subscriptions.size()) Serial << ", alive=" << alive << '/' << ms << ", ka=" << keep_alive << ' ';
{ Serial << (client && client->connected() ? "" : "dis") << "connected";
bool c = false; if (subscriptions.size())
Serial << " ["; {
for(auto s: subscriptions) bool c = false;
{ Serial << " [";
if (c) Serial << ", "; for(auto s: subscriptions)
Serial << s.str().c_str(); (void)indent;
c=true; {
} if (c) Serial << ", ";
Serial << ']'; Serial << s.str().c_str();
} c=true;
Serial << endl; }
Serial << ']';
}
Serial << endl;
#endif
} }
/** Count the number of messages that have been sent **/ #ifdef EPOXY_DUINO
static long counter; static std::map<MqttMessage::Type, int> counters; // Number of processed messages
#endif
private: private:
@@ -231,10 +242,10 @@ class MqttClient
friend class MqttBroker; friend class MqttBroker;
MqttClient(MqttBroker* parent, TcpClient* client); MqttClient(MqttBroker* parent, TcpClient* client);
// republish a received publish if topic matches any in subscriptions // republish a received publish if topic matches any in subscriptions
MqttError publishIfSubscribed(const Topic& topic, const MqttMessage& msg); MqttError publishIfSubscribed(const Topic& topic, MqttMessage& msg);
void clientAlive(uint32_t more_seconds); void clientAlive(uint32_t more_seconds);
void processMessage(const MqttMessage* message); void processMessage(MqttMessage* message);
bool mqtt_connected = false; bool mqtt_connected = false;
char mqtt_flags; char mqtt_flags;
@@ -255,7 +266,7 @@ class MqttClient
class MqttBroker class MqttBroker
{ {
enum State enum __attribute__((packed)) State
{ {
Disconnected, // Also the initial state Disconnected, // Also the initial state
Connecting, // connect and sends a fake publish to avoid circular cnx Connecting, // connect and sends a fake publish to avoid circular cnx
@@ -291,7 +302,7 @@ class MqttBroker
{ return compareString(auth_password, password, len); } { return compareString(auth_password, password, len); }
MqttError publish(const MqttClient* source, const Topic& topic, const MqttMessage& msg) const; MqttError publish(const MqttClient* source, const Topic& topic, MqttMessage& msg) const;
MqttError subscribe(const Topic& topic, uint8_t qos); MqttError subscribe(const Topic& topic, uint8_t qos);

7
tests/howto Normal file
View File

@@ -0,0 +1,7 @@
cd TinyMqtt/tests/../..
git clone https://github.com/hsaturn/EspMock.git
git clone https://github.com/bxparks/AUnit.git
git clone https://github.com/bxparks/EpoxyDuino.git
cd TinyMqtt/tests
make
make runtests

View File

@@ -1,6 +1,11 @@
# See https://github.com/bxparks/EpoxyDuino for documentation about this # See https://github.com/bxparks/EpoxyDuino for documentation about this
# Makefile to compile and run Arduino programs natively on Linux or MacOS. # Makefile to compile and run Arduino programs natively on Linux or MacOS.
EXTRA_CXXFLAGS=-g3 -O0
# Remove flto flag from EpoxyDuino (too many <optimized out>)
CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
APP_NAME := local-tests APP_NAME := local-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP
ARDUINO_LIB_DIRS := ../../../EspMock/libraries ARDUINO_LIB_DIRS := ../../../EspMock/libraries

View File

@@ -31,12 +31,10 @@ void onPublish(const MqttClient* srce, const Topic& topic, const char* payload,
test(local_client_should_unregister_when_destroyed) test(local_client_should_unregister_when_destroyed)
{ {
return;
assertEqual(broker.clientsCount(), (size_t)0); assertEqual(broker.clientsCount(), (size_t)0);
{ {
MqttClient client;
assertEqual(broker.clientsCount(), (size_t)0); // Ensure client is not yet connected assertEqual(broker.clientsCount(), (size_t)0); // Ensure client is not yet connected
client.connect("127.0.0.1", 1883); MqttClient client(&broker);
assertEqual(broker.clientsCount(), (size_t)1); // Ensure client is now connected assertEqual(broker.clientsCount(), (size_t)1); // Ensure client is now connected
} }
assertEqual(broker.clientsCount(), (size_t)0); assertEqual(broker.clientsCount(), (size_t)0);
@@ -68,8 +66,8 @@ test(local_publish_should_be_dispatched)
publisher.publish("a/c"); publisher.publish("a/c");
assertEqual(published.size(), (size_t)1); // 1 client has received something assertEqual(published.size(), (size_t)1); // 1 client has received something
assertTrue(published[""]["a/b"] == 1); assertEqual(published[""]["a/b"], 1);
assertTrue(published[""]["a/c"] == 2); assertEqual(published[""]["a/c"], 2);
} }
test(local_publish_should_be_dispatched_to_local_clients) test(local_publish_should_be_dispatched_to_local_clients)
@@ -91,10 +89,10 @@ test(local_publish_should_be_dispatched_to_local_clients)
publisher.publish("a/c"); publisher.publish("a/c");
assertEqual(published.size(), (size_t)2); // 2 clients have received something assertEqual(published.size(), (size_t)2); // 2 clients have received something
assertTrue(published["A"]["a/b"] == 1); assertEqual(published["A"]["a/b"], 1);
assertTrue(published["A"]["a/c"] == 1); assertEqual(published["A"]["a/c"], 1);
assertTrue(published["B"]["a/b"] == 1); assertEqual(published["B"]["a/b"], 1);
assertTrue(published["B"]["a/c"] == 0); assertEqual(published["B"]["a/c"], 0);
} }
test(local_unsubscribe) test(local_unsubscribe)
@@ -114,7 +112,7 @@ test(local_unsubscribe)
publisher.publish("a/b"); publisher.publish("a/b");
publisher.publish("a/b"); publisher.publish("a/b");
assertTrue(published[""]["a/b"] == 1); // Only one publish has been received assertEqual(published[""]["a/b"], 1); // Only one publish has been received
} }
test(local_nocallback_when_destroyed) test(local_nocallback_when_destroyed)
@@ -143,7 +141,7 @@ void setup() {
Serial.begin(115200); Serial.begin(115200);
while(!Serial); while(!Serial);
Serial.println("=============[ NO WIFI CONNECTION TinyMqtt TESTS ]========================"); Serial.println("=============[ LOCAL TinyMqtt TESTS ]========================");
} }
void loop() { void loop() {

View File

@@ -0,0 +1,13 @@
# See https://github.com/bxparks/EpoxyDuino for documentation about this
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
EXTRA_CXXFLAGS=-g3 -O0
# Remove flto flag from EpoxyDuino (too many <optimized out>)
CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
APP_NAME := network-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
EPOXY_CORE := EPOXY_CORE_ESP8266
include ../../../EpoxyDuino/EpoxyDuino.mk

View File

@@ -0,0 +1,331 @@
#include <Arduino.h>
#include <AUnit.h>
#include <TinyMqtt.h>
#include <map>
/**
* TinyMqtt network unit tests.
*
* No wifi connection unit tests.
* Checks with a local broker. Clients must connect to the local broker
**/
using namespace std;
String toString(const IPAddress& ip)
{
return String(ip[0])+'.'+String(ip[1])+'.'+String(ip[2])+'.'+String(ip[3]);
}
MqttBroker broker(1883);
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
char* lastPayload = nullptr;
size_t lastLength;
void start_servers(int n, bool early_accept = true)
{
ESP8266WiFiClass::resetInstances();
ESP8266WiFiClass::earlyAccept = early_accept;
while(n)
{
ESP8266WiFiClass::selectInstance(n--);
WiFi.mode(WIFI_STA);
WiFi.begin("fake_ssid", "fake_pwd");
}
}
void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
{
if (srce)
published[srce->id()][topic]++;
if (lastPayload) free(lastPayload);
lastPayload = strdup(payload);
lastLength = length;
}
test(network_single_broker_begin)
{
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
broker.begin();
// TODO Nothing is tested here !
}
test(suback)
{
start_servers(2, true);
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
broker.begin();
IPAddress broker_ip = WiFi.localIP();
ESP8266WiFiClass::selectInstance(2);
MqttClient client;
client.connect(broker_ip.toString().c_str(), 1883);
broker.loop();
assertTrue(broker.clientsCount() == 1);
assertTrue(client.connected());
MqttClient::counters[MqttMessage::Type::SubAck] = 0;
client.subscribe("a/b");
// TODO how to avoid these loops ???
broker.loop();
client.loop();
assertEqual(MqttClient::counters[MqttMessage::Type::SubAck], 1);
}
test(network_client_to_broker_connexion)
{
start_servers(2, true);
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
broker.begin();
IPAddress broker_ip = WiFi.localIP();
ESP8266WiFiClass::selectInstance(2);
MqttClient client;
client.connect(broker_ip.toString().c_str(), 1883);
broker.loop();
assertTrue(broker.clientsCount() == 1);
assertTrue(client.connected());
}
test(network_one_client_one_broker_publish_and_subscribe_through_network)
{
start_servers(2, true);
published.clear();
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
broker.begin();
IPAddress ip_broker = WiFi.localIP();
// We have a 2nd ESP in order to test through wifi (opposed to local)
ESP8266WiFiClass::selectInstance(2);
MqttClient client;
client.connect(ip_broker.toString().c_str(), 1883);
broker.loop();
assertTrue(client.connected());
client.setCallback(onPublish);
client.subscribe("a/b");
client.publish("a/b", "ab");
for (int i =0; i<2; i++)
{
client.loop();
broker.loop();
}
assertEqual(published.size(), (size_t)1);
assertEqual((int)lastLength, (int)2); // sizeof(ab)
}
test(network_one_client_one_broker_hudge_publish_and_subscribe_through_network)
{
start_servers(2, true);
published.clear();
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
broker.begin();
IPAddress ip_broker = WiFi.localIP();
// We have a 2nd ESP in order to test through wifi (opposed to local)
ESP8266WiFiClass::selectInstance(2);
MqttClient client;
client.connect(ip_broker.toString().c_str(), 1883);
broker.loop();
assertTrue(client.connected());
std::string sent;
for(int i=0; i<200; i++)
sent += char('0'+i%10);
client.setCallback(onPublish);
client.subscribe("a/b");
client.publish("a/b", sent.c_str());
for (int i =0; i<2; i++)
{
client.loop();
broker.loop();
}
assertEqual(published.size(), (size_t)1);
assertEqual((unsigned int)lastLength, (unsigned int)sent.size());
}
test(network_client_should_unregister_when_destroyed)
{
assertEqual(broker.clientsCount(), (size_t)0);
{
MqttClient client(&broker);
assertEqual(broker.clientsCount(), (size_t)1);
}
assertEqual(broker.clientsCount(), (size_t)0);
}
// THESE TESTS ARE IN LOCAL MODE
// WE HAVE TO CONVERT THEM TO WIFI MODE (pass through virtual TCP link)
test(network_connect)
{
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient client(&broker);
assertTrue(client.connected());
assertEqual(broker.clientsCount(), (size_t)1);
}
test(network_publish_should_be_dispatched)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber(&broker);
subscriber.subscribe("a/b");
subscriber.subscribe("a/c");
subscriber.setCallback(onPublish);
MqttClient publisher(&broker);
publisher.publish("a/b");
publisher.publish("a/c");
publisher.publish("a/c");
assertEqual(published.size(), (size_t)1); // 1 client has received something
assertEqual(published[""]["a/b"], 1);
assertEqual(published[""]["a/c"], 2);
}
test(network_publish_should_be_dispatched_to_clients)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber_a(&broker, "A");
subscriber_a.setCallback(onPublish);
subscriber_a.subscribe("a/b");
subscriber_a.subscribe("a/c");
MqttClient subscriber_b(&broker, "B");
subscriber_b.setCallback(onPublish);
subscriber_b.subscribe("a/b");
MqttClient publisher(&broker);
publisher.publish("a/b"); // A and B should receive this
publisher.publish("a/c"); // A should receive this
assertEqual(published.size(), (size_t)2); // 2 clients have received something
assertEqual(published["A"]["a/b"], 1);
assertEqual(published["A"]["a/c"], 1);
assertEqual(published["B"]["a/b"], 1);
assertEqual(published["B"]["a/c"], 0);
}
test(network_unsubscribe)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber(&broker);
subscriber.setCallback(onPublish);
subscriber.subscribe("a/b");
MqttClient publisher(&broker);
publisher.publish("a/b"); // This publish is received
subscriber.unsubscribe("a/b");
publisher.publish("a/b"); // Those one, no (unsubscribed)
publisher.publish("a/b");
assertEqual(published[""]["a/b"], 1); // Only one publish has been received
}
test(network_nocallback_when_destroyed)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient publisher(&broker);
{
MqttClient subscriber(&broker);
subscriber.setCallback(onPublish);
subscriber.subscribe("a/b");
publisher.publish("a/b");
}
publisher.publish("a/b");
assertEqual(published.size(), (size_t)1); // Only one publish has been received
}
test(network_small_payload)
{
published.clear();
const char* payload="abcd";
MqttClient subscriber(&broker);
subscriber.setCallback(onPublish);
subscriber.subscribe("a/b");
MqttClient publisher(&broker);
publisher.publish("a/b", payload, strlen(payload)); // This publish is received
// coming from MqttClient::publish(...)
assertEqual(payload, lastPayload);
assertEqual(lastLength, (size_t)4);
}
test(network_hudge_payload)
{
const char* payload="This payload is hudge, just because its length exceeds 127. Thus when encoding length, we have to encode it on two bytes at min. This should not prevent the message from being encoded and decoded successfully !";
MqttClient subscriber(&broker);
subscriber.setCallback(onPublish);
subscriber.subscribe("a/b");
MqttClient publisher(&broker);
publisher.publish("a/b", payload); // This publish is received
// onPublish should have filled lastPayload and lastLength
assertEqual(payload, lastPayload);
assertEqual(lastLength, strlen(payload));
assertEqual(strcmp(payload, lastPayload), 0);
}
//----------------------------------------------------------------------------
// setup() and loop()
void setup() {
/* delay(1000);
Serial.begin(115200);
while(!Serial);
*/
Serial.println("=============[ FAKE NETWORK TinyMqtt TESTS ]========================");
WiFi.mode(WIFI_STA);
WiFi.begin("network", "password");
}
void loop() {
aunit::TestRunner::run();
if (Serial.available()) ESP.reset();
}

View File

@@ -1,6 +1,11 @@
# See https://github.com/bxparks/EpoxyDuino for documentation about this # See https://github.com/bxparks/EpoxyDuino for documentation about this
# Makefile to compile and run Arduino programs natively on Linux or MacOS. # Makefile to compile and run Arduino programs natively on Linux or MacOS.
EXTRA_CXXFLAGS=-g3 -O0
# Remove flto flag from EpoxyDuino (too many <optimized out>)
CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
APP_NAME := nowifi-tests APP_NAME := nowifi-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP
ARDUINO_LIB_DIRS := ../../../EspMock/libraries ARDUINO_LIB_DIRS := ../../../EspMock/libraries

View File

@@ -132,7 +132,7 @@ test(nowifi_nocallback_when_destroyed)
assertEqual(published.size(), (size_t)1); // Only one publish has been received assertEqual(published.size(), (size_t)1); // Only one publish has been received
} }
test(nowifi_payload_nullptr) test(nowifi_small_payload)
{ {
published.clear(); published.clear();
@@ -150,6 +150,22 @@ test(nowifi_payload_nullptr)
assertEqual(lastLength, (size_t)4); assertEqual(lastLength, (size_t)4);
} }
test(nowifi_hudge_payload)
{
const char* payload="This payload is hudge, just because its length exceeds 127. Thus when encoding length, we have to encode it on two bytes at min. This should not prevent the message from being encoded and decoded successfully !";
MqttClient subscriber(&broker);
subscriber.setCallback(onPublish);
subscriber.subscribe("a/b");
MqttClient publisher(&broker);
publisher.publish("a/b", payload); // This publish is received
// onPublish should have filled lastPayload and lastLength
assertEqual(payload, lastPayload);
assertEqual(lastLength, strlen(payload));
}
//---------------------------------------------------------------------------- //----------------------------------------------------------------------------
// setup() and loop() // setup() and loop()
void setup() { void setup() {