Compare commits

..

28 Commits

Author SHA1 Message Date
Francois BIOT
2587371457 Minor typo changes and add comments 2023-02-23 19:24:27 +01:00
hsaturn
a880a1ff2f Minor updates 2023-02-23 19:22:40 +01:00
hsaturn
143d57db2d Re-enabled lot of local unit tests 2023-02-22 07:40:12 +01:00
hsaturn
2a8dbd09c5 Memory deletion fixes 2023-02-20 05:24:35 +01:00
Francois BIOT
00333ed805 [TinyMqtt] Fix obsolete warning 2023-02-20 03:22:50 +01:00
hsaturn
9228408f57 [tests] Added -Wall and use TinyConsole::string 2023-02-20 02:39:43 +01:00
hsaturn
1653b2e386 [tests] Added a compilation test (based on example tiny-tests) 2023-02-20 02:28:22 +01:00
Francois BIOT
775fbc14ee [tests] Use TinyConsole::string instead of any 2023-02-20 02:24:39 +01:00
hsaturn
c21b7b63fb [tests] Removed warning and using namespace std 2023-02-20 02:21:33 +01:00
hsaturn
e45af112c2 Update README.md 2023-02-19 09:16:35 +01:00
hsaturn
f9c539ff6a Added TinyConsole aunit test and dependency 2023-02-19 09:16:10 +01:00
hsaturn
7dc23d322c TinyString moved to TinyConsole 2023-02-19 08:38:11 +01:00
Francois BIOT
4fb632ce3d [TinyString] change size_t to be more tolerant with signed ints 2023-02-19 06:04:54 +01:00
hsaturn
c9130c7a24 [TinyString] Added size_t, added find(char) 2023-02-19 05:21:55 +01:00
hsaturn
31c51aeaff [aunit] Use my git repo instead of bxpark's 2023-02-15 07:57:25 +01:00
hsaturn
2eeda4ecab [makefiles] Added missing Makefile.opt 2023-02-15 05:39:17 +01:00
hsaturn
787cb77a26 String indexer std::string removed 2023-02-15 05:37:23 +01:00
hsaturn
d324a913ec Merge pull request #59 from richievos/clearer-version-error
More informative error on version mismatch
2023-02-13 09:00:39 +01:00
Richie Vos
ac1eedd72a More informative error on version mismatch
I spent a lot of time debugging my arduino, trying to figure out why my
calls were all failing. Turned out to be due to the mqtt cli using v5, while
this library only supports v4. By mqtt cli I mean the [hivemq one](https://hivemq.github.io/mqtt-cli/),
which is the first one that shows up on google searches.

Being new to mqtt this burned me for awhile, so I'm hoping this helps the next
person. Both by having this PR show up if they search, and making the error
more informative.
2023-02-12 21:37:17 -08:00
hsaturn
0900e799a9 Update README.md 2023-02-02 03:15:57 +01:00
hsaturn
2086c7f0e7 Added auint test to unit tests array 2023-02-02 03:14:25 +01:00
hsaturn
72382bf351 Added missing dependency to bxparks AceRoutine 2023-02-02 03:02:03 +01:00
hsaturn
3fec7b87a8 Unit tests of dependencies projects added 2023-02-02 02:21:59 +01:00
hsaturn
8641627742 Re-added flto in makefile 2023-01-15 16:04:16 +01:00
hsaturn
3b2460572b Fix unit tests 2023-01-14 14:26:30 +01:00
hsaturn
a0435b2cfb Release 0.9.12 unit test build upgrade 2023-01-03 04:33:47 +01:00
hsaturn
bda041417d Release 0.9.12 2023-01-03 04:32:14 +01:00
hsaturn
baffda8a6d MqttClient - fix local disconnect after pulish + ka 2023-01-03 04:25:26 +01:00
25 changed files with 1267 additions and 413 deletions

View File

@@ -20,7 +20,7 @@ jobs:
git clone https://github.com/hsaturn/TinyConsole
git clone https://github.com/hsaturn/EpoxyDuino
git clone https://github.com/bxparks/AceRoutine
git clone https://github.com/bxparks/AUnit
git clone https://github.com/hsaturn/AUnit
git clone https://github.com/bxparks/AceCommon
git clone https://github.com/hsaturn/EspMock
- name: Verify tests

View File

@@ -10,6 +10,18 @@
TinyMqtt is a small, fast and capable Mqtt Broker and Client for Esp8266 / Esp32 / Esp WROOM
### Statuses of all unit tests of TinyMqtt and its dependencies
| Project | Unit tests result |
| ----------- | ------------ |
| TinyMqtt | [![](https://github.com/hsaturn/TinyMqtt/actions/workflows/aunit.yml/badge.svg)](https://github.com/hsaturn/TinyMqtt/actions/workflows/aunit.yml) |
| Dependencies ||
| TinyConsole | [![](https://github.com/hsaturn/TinyConsole/actions/workflows/aunit.yml/badge.svg)](https://github.com/hsaturn/TinyConsole/actions/workflows/aunit.yml) |
| EpoxyDuino | [![AUnit Tests](https://github.com/hsaturn/EpoxyDuino/actions/workflows/aunit_tests.yml/badge.svg)](https://github.com/hsaturn/EpoxyDuino/actions/workflows/aunit_tests.yml) |
| EspMock | [![AUnit Tests](https://github.com/hsaturn/EspMock/actions/workflows/aunit.yml/badge.svg)](https://github.com/hsaturn/EspMock/actions/workflows/aunit.yml) |
| AUnit | [![AUnit Tests](https://github.com/hsaturn/AUnit/actions/workflows/aunit_tests.yml/badge.svg)](https://github.com/hsaturn/AUnit/actions/workflows/aunit_tests.yml) |
| AceRoutine | [![AUnit Tests](https://github.com/bxparks/AceRoutine/actions/workflows/aunit_tests.yml/badge.svg)](https://github.com/bxparks/AceRoutine/actions/workflows/aunit_tests.yml) |
## Features
- Very fast broker I saw it re-sent 1000 topics per second for two

View File

@@ -15,6 +15,8 @@
#include <string>
#include <map>
using string = TinyString;
bool echo_on = true;
auto green = TinyConsole::green;
auto red = TinyConsole::red;
@@ -32,13 +34,13 @@ const char* password = "";
struct free_broker
{
public:
free_broker(const char* s, uint16_t p, const char* comment) : url(s), port(p) {}
free_broker(const char* s, uint16_t p, const char* /* comment */) : url(s), port(p) {}
std::string url;
string url;
uint16_t port;
};
const std::map<std::string, free_broker> list =
const std::map<string, free_broker> list =
{
{ "mqtthq", { "public.mqtthq.com" , 8083, "publish/subscribe" }},
{ "hivemq", { "broker.hivemq.com", 1883, "" }}
@@ -73,8 +75,8 @@ void onPublish(const MqttClient* srce, const Topic& topic, const char* payload,
}
}
std::map<std::string, MqttClient*> clients;
std::map<std::string, MqttBroker*> brokers;
std::map<string, MqttClient*> clients;
std::map<string, MqttBroker*> brokers;
void setup()
{
@@ -126,12 +128,12 @@ void setup()
if (Console.isTerm()) onCommand("every 333 view");
}
std::string getword(std::string& str, const char* if_empty=nullptr, char sep=' ');
string getword(string& str, const char* if_empty=nullptr, char sep=' ');
int getint(std::string& str, const int if_empty=0)
int getint(string& str, const int if_empty=0)
{
std::string str2=str;
std::string sword = getword(str);
string str2=str;
string sword = getword(str);
if (sword[0] and isdigit(sword[0]))
{
int ret=atoi(sword.c_str());
@@ -143,11 +145,11 @@ int getint(std::string& str, const int if_empty=0)
return if_empty;
}
std::string getword(std::string& str, const char* if_empty/*=nullptr*/, char sep/*=' '*/)
string getword(string& str, const char* if_empty/*=nullptr*/, char sep/*=' '*/)
{
char quote=(str[0]=='"' or str[0]=='\'' ? str[0] : 0);
if (quote) str.erase(0,1);
std::string sword;
string sword;
while(str.length() and (str[0]!=sep or quote))
{
if (str[0]==quote)
@@ -190,7 +192,7 @@ std::string getword(std::string& str, const char* if_empty/*=nullptr*/, char sep
return sword;
}
bool isaddr(std::string s)
bool isaddr(string s)
{
if (s.length()==0 or s.length()>3) return false;
for(char c: s)
@@ -198,14 +200,14 @@ bool isaddr(std::string s)
return true;
}
std::string getip(std::string& str, const char* if_empty=nullptr, char sep=' ')
string getip(string& str, const char* if_empty=nullptr, char sep=' ')
{
std::string addr=getword(str, if_empty, sep);
std::string ip=addr;
std::vector<std::string> build;
string addr=getword(str, if_empty, sep);
string ip=addr;
std::vector<string> build;
while(ip.length())
{
std::string b=getword(ip,nullptr,'.');
string b=getword(ip,nullptr,'.');
if (isaddr(b) && build.size()<4)
{
build.push_back(b);
@@ -219,9 +221,9 @@ std::string getip(std::string& str, const char* if_empty=nullptr, char sep=' ')
{
std::stringstream b;
b << (int)local[3-build.size()];
build.insert(build.begin(), b.str());
build.insert(build.begin(), b.str().c_str());
}
for(std::string s: build)
for(string s: build)
{
if (addr.length()) addr += '.';
addr += s;
@@ -230,22 +232,22 @@ std::string getip(std::string& str, const char* if_empty=nullptr, char sep=' ')
return addr;
}
std::map<std::string, std::string> vars;
std::map<string, string> vars;
std::set<std::string> commands = {
std::set<string> commands = {
"broker", "blink", "client", "connect",
"create", "delete", "debug", "help", "interval",
"list", "ls", "ip", "off", "on", "set",
"publish", "reset", "subscribe", "unsubscribe", "view", "echo", "every"
};
void convertToCommand(std::string& search)
void convertToCommand(string& search)
{
while(search[0]==' ') search.erase(0,1);
if (search.length()==0) return;
std::string matches;
string matches;
int count=0;
for(std::string cmd: commands)
for(string cmd: commands)
{
if (cmd.substr(0, search.length()) == search)
{
@@ -263,7 +265,7 @@ void convertToCommand(std::string& search)
}
}
void replace(const char* d, std::string& str, std::string srch, std::string to)
void replace(const char* d, string& str, string srch, string to)
{
if (d[0] && d[1])
{
@@ -271,7 +273,7 @@ void replace(const char* d, std::string& str, std::string srch, std::string to)
to=d[0]+to+d[1];
size_t pos = 0;
while((pos=str.find(srch, pos)) != std::string::npos)
while((pos=str.find(srch, pos)) != string::npos)
{
str.erase(pos, srch.length());
str.insert(pos, to);
@@ -280,7 +282,7 @@ void replace(const char* d, std::string& str, std::string srch, std::string to)
}
}
void replaceVars(std::string& cmd)
void replaceVars(string& cmd)
{
cmd = ' '+cmd+' ';
@@ -291,12 +293,12 @@ void replaceVars(std::string& cmd)
replace(" .", cmd, it.first, it.second);
replace(" ", cmd, it.first, it.second);
}
cmd.erase(0, cmd.find_first_not_of(" "));
cmd.erase(cmd.find_last_not_of(" ")+1);
cmd.erase(0, cmd.find_first_not_of(' '));
cmd.erase(cmd.find_last_not_of(' ')+1);
}
bool compare(std::string s, const char* cmd)
bool compare(string s, const char* cmd)
{
uint8_t p=0;
while(s[p++]==*cmd++)
@@ -307,11 +309,11 @@ bool compare(std::string s, const char* cmd)
return false;
}
using ClientFunction = void(*)(std::string& cmd, MqttClient* publish);
using ClientFunction = void(*)(string& cmd, MqttClient* publish);
struct Every
{
std::string cmd;
string cmd;
uint32_t ms;
uint32_t next;
uint32_t underrun=0;
@@ -341,19 +343,19 @@ int16_t blink;
std::vector<Every> everies;
void onCommand(const std::string& command)
void onCommand(const string& command)
{
Console << endl;
std::string cmd=command;
string cmd=command;
if (cmd.substr(0,3)!="set") replaceVars(cmd);
eval(cmd);
Console << endl;
Console.prompt();
}
void clientConnect(MqttClient* client, std::string& cmd)
void clientConnect(MqttClient* client, string& cmd)
{
std::string remote = getword(cmd);
string remote = getword(cmd);
uint16_t port;
auto it=list.find(remote);
if (it != list.end())
@@ -369,18 +371,18 @@ void clientConnect(MqttClient* client, std::string& cmd)
Console << (client->connected() ? "connected." : "not connected") << endl;
}
void eval(std::string& cmd)
void eval(string& cmd)
{
while(cmd.length())
{
MqttError retval = MqttOk;
std::string s;
string s;
MqttBroker* broker = nullptr;
MqttClient* client = nullptr;
// client.function notation
if (cmd.find('.') != std::string::npos &&
if (cmd.find('.') != string::npos &&
cmd.find('.') < cmd.find(' '))
{
s=getword(cmd, nullptr, '.');
@@ -632,7 +634,7 @@ void eval(std::string& cmd)
}
else if (compare(s, "broker"))
{
std::string id=getword(cmd);
string id=getword(cmd);
if (clients.find(id) != clients.end())
{
Console << "A client already have that name" << endl;
@@ -663,7 +665,7 @@ void eval(std::string& cmd)
}
else if (compare(s, "client"))
{
std::string id=getword(cmd);
string id=getword(cmd);
if (brokers.find(id) != brokers.end())
{
Console << "A broker have that name" << endl;
@@ -700,7 +702,7 @@ void eval(std::string& cmd)
}
else if (compare(s, "set"))
{
std::string name(getword(cmd));
string name(getword(cmd));
if (name.length()==0)
{
for(auto it: vars)
@@ -812,7 +814,7 @@ void loop()
if (not every.active) continue;
if (every.ms && every.cmd.length() && ms > every.next)
{
std::string cmd(every.cmd);
string cmd(every.cmd);
eval(cmd);
every.next += every.ms;
if (ms > every.next and ms > every.underrun)
@@ -845,7 +847,6 @@ void loop()
out++;
}
static long count;
#if defined(ESP9266)
MDNS.update();
#endif

View File

@@ -1,9 +1,9 @@
name=TinyMqtt
version=0.9.11
version=0.9.12
author=Francois BIOT, HSaturn, <hsaturn@gmail.com>
maintainer=Francois BIOT, HSaturn, <hsaturn@gmail.com>
maintainer=Francois BIOT <hsaturn@gmail.com>
sentence=A tiny broker and client library for MQTT messaging.
paragraph=MQTT is a lightweight messaging protocol ideal for small devices. This library allows to send and receive MQTT messages and to host a broker in your ESP 8266 and 32 WROOM. It does support MQTT 3.1.1 with QoS=0.
paragraph=MQTT is a lightweight messaging protocol. This library allows to host a broker or to use a mqtt client in your ESP 8266 or 32 WROOM. It does support MQTT 3.1.1 with QoS=0, and is intented to be as smallest as possible, keeping a good efficiency (about 1k msg per second on ESP8266 12F).
category=Communication
url=https://github.com/hsaturn/TinyMqtt
architectures=*

View File

@@ -1,3 +1,4 @@
#include "StringIndexer.h"
std::map<StringIndexer::index_t, StringIndexer::StringCounter> StringIndexer::strings;
StringIndexer::Strings StringIndexer::strings;

View File

@@ -1,18 +1,25 @@
// vim: ts=2 sw=2 expandtab
#pragma once
#include <assert.h>
#include <map>
#include <unordered_map>
#include "TinyConsole.h"
#include <string>
#include <string.h>
using string = TinyConsole::string;
/***
* Allows to store up to 255 different strings with one byte class
* very memory efficient when one string is used many times.
*/
class StringIndexer
{
private:
class StringCounter
{
std::string str;
string str;
uint8_t used=0;
friend class StringIndexer;
@@ -29,13 +36,13 @@ class StringIndexer
public:
using index_t = uint8_t;
static const std::string& str(const index_t& index)
{
static std::string dummy;
const auto& it=strings.find(index);
if (it == strings.end()) return dummy;
return it->second.str;
}
static const string& str(const index_t& index)
{
static string dummy;
const auto& it=strings.find(index);
if (it == strings.end()) return dummy;
return it->second.str;
}
static void use(const index_t& index)
{
@@ -77,7 +84,7 @@ class StringIndexer
{
if (strings.find(index)==strings.end())
{
strings[index].str = std::string(str, len);
strings[index].str = string(str, len);
strings[index].used++;
// Serial << "Creating index " << index << " for (" << strings[index].str.c_str() << ") len=" << len << endl;
return index;
@@ -86,7 +93,9 @@ class StringIndexer
return 0; // TODO out of indexes
}
static std::map<index_t, StringCounter> strings;
using Strings = std::unordered_map<index_t, StringCounter>;
static Strings strings;
};
class IndexedString
@@ -103,7 +112,7 @@ class IndexedString
index=StringIndexer::strToIndex(str, len);
}
IndexedString(const std::string& str) : IndexedString(str.c_str(), str.length()) {};
IndexedString(const string& str) : IndexedString(str.c_str(), str.length()) {};
~IndexedString() { StringIndexer::release(index); }
@@ -124,7 +133,7 @@ class IndexedString
return i1.index == i2.index;
}
const std::string& str() const { return StringIndexer::str(index); }
const string& str() const { return StringIndexer::str(index); }
const StringIndexer::index_t& getIndex() const { return index; }

View File

@@ -17,7 +17,7 @@ int TinyMqtt::debug=2;
MqttBroker::MqttBroker(uint16_t port)
{
server.reset(new TcpServer(port));
server = new TcpServer(port);
#ifdef TINY_MQTT_ASYNC
server->onClient(onClient, this);
#endif
@@ -27,31 +27,41 @@ MqttBroker::~MqttBroker()
{
while(clients.size())
{
delete clients[0];
auto client = clients[0];
client->local_broker = nullptr;
if (client->cltFlags & MqttClient::CltFlags::CltFlagToDelete)
{
// std::cout << "Deleting client" << std::endl;
delete client;
}
clients.erase(clients.begin());
}
delete server;
}
// private constructor used by broker only
MqttClient::MqttClient(MqttBroker* local_broker, TcpClient* new_client)
: local_broker(local_broker)
{
dclass;
connect(local_broker);
debug("MqttClient private with broker");
#ifdef TINY_MQTT_ASYNC
tcp_client.reset(new_client);
tcp_client = new_client;
tcp_client->onData(onData, this);
// client->onConnect() TODO
// client->onDisconnect() TODO
#else
tcp_client.reset(new WiFiClient(*new_client));
tcp_client = new WiFiClient(*new_client);
#endif
#ifdef EPOXY_DUINO
alive = millis()+500000;
#else
alive = millis()+5000; // TODO MAGIC client expires after 5s if no CONNECT msg
#endif
alive = millis()+5000;
}
MqttClient::MqttClient(MqttBroker* local_broker, const std::string& id)
MqttClient::MqttClient(MqttBroker* local_broker, const string& id)
: local_broker(local_broker), clientId(id)
{
dclass;
alive = 0;
keep_alive = 0;
@@ -60,15 +70,15 @@ MqttClient::MqttClient(MqttBroker* local_broker, const std::string& id)
MqttClient::~MqttClient()
{
dtor;
close();
delete tcp_client;
debug("*** MqttClient delete()");
}
void MqttClient::close(bool bSendDisconnect)
{
debug("close " << id().c_str());
mqtt_flags &= ~FlagConnected;
resetFlag(CltFlagConnected);
if (tcp_client) // connected to a remote broker
{
if (bSendDisconnect and tcp_client->connected())
@@ -90,18 +100,18 @@ void MqttClient::close(bool bSendDisconnect)
void MqttClient::connect(MqttBroker* local)
{
debug("MqttClient::connect_local");
alive = 0;
close();
local_broker = local;
clientAlive();
local_broker->addClient(this);
}
void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka)
void MqttClient::connect(string broker, uint16_t port, uint16_t ka)
{
debug("MqttClient::connect_to_host " << broker << ':' << port);
keep_alive = ka;
close();
tcp_client.reset(new TcpClient);
if (tcp_client) delete tcp_client;
tcp_client = new TcpClient;
#ifdef TINY_MQTT_ASYNC
tcp_client->onData(onData, this);
@@ -111,7 +121,7 @@ void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka)
if (tcp_client->connect(broker.c_str(), port))
{
debug("link established");
onConnect(this, tcp_client.get());
onConnect(this, tcp_client);
}
else
{
@@ -120,7 +130,13 @@ void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka)
#endif
}
void MqttBroker::connect(const std::string& host, uint16_t port)
void MqttBroker::addClient(MqttClient* client)
{
debug("MqttBroker::addClient");
clients.push_back(client);
}
void MqttBroker::connect(const string& host, uint16_t port)
{
debug("MqttBroker::connect");
if (remote_broker == nullptr) remote_broker = new MqttClient;
@@ -130,13 +146,24 @@ void MqttBroker::connect(const std::string& host, uint16_t port)
void MqttBroker::removeClient(MqttClient* remove)
{
local_clients.erase(remove);
for(auto it = clients.begin(); it!=clients.end(); it++)
if (*it == remove)
debug("removeClient");
for(auto it=clients.begin(); it!=clients.end(); it++)
{
auto client=*it;
if (client==remove)
{
// TODO if this broker is connected to an external broker
// we have to unsubscribe remove's topics.
// (but doing this, check that other clients are not subscribed...)
// Unless -> we could receive useless messages
// -> we are using (memory) one IndexedString plus its string for nothing.
debug("Remove " << clients.size());
clients.erase(it);
break;
debug("Client removed " << clients.size());
return;
}
}
debug(red << "Error cannot remove client"); // TODO should not occur
}
void MqttBroker::onClient(void* broker_ptr, TcpClient* client)
@@ -144,15 +171,16 @@ void MqttBroker::onClient(void* broker_ptr, TcpClient* client)
debug("MqttBroker::onClient");
MqttBroker* broker = static_cast<MqttBroker*>(broker_ptr);
broker->clients.push_back(new MqttClient(broker, client));
MqttClient* mqtt = new MqttClient(broker, client);
mqtt->setFlag(MqttClient::CltFlags::CltFlagToDelete);
broker->addClient(mqtt);
debug("New client");
}
void MqttBroker::loop()
{
#ifndef TINY_MQTT_ASYNC
if (not server) return;
WiFiClient client = server->available();
WiFiClient client = server->accept();
if (client)
{
@@ -166,12 +194,9 @@ void MqttBroker::loop()
remote_broker->loop();
}
// keep track on size because loop can remove a client from containers
// loop on remote clients (connected through network)
auto size = clients.size();
for(auto it = clients.begin(); it!=clients.end(); it++)
for(size_t i=0; i<clients.size(); i++)
{
MqttClient* client = *it;
MqttClient* client = clients[i];
if (client->connected())
{
client->loop();
@@ -180,16 +205,9 @@ void MqttBroker::loop()
{
debug("Client " << client->id().c_str() << " Disconnected, local_broker=" << (dbg_ptr)client->local_broker);
// Note: deleting a client not added by the broker itself will probably crash later.
delete client;
break;
}
if (size != clients.size()) break;
}
// loop on local clients (on same device as the broker's)
size = local_clients.size();
for(auto& client: local_clients)
{
client->loop();
if (local_clients.size() != size) break;
}
}
@@ -205,28 +223,40 @@ MqttError MqttBroker::subscribe(const Topic& topic, uint8_t qos)
MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, MqttMessage& msg) const
{
MqttError retval = MqttOk; // TODO here retval is badly computed
MqttError retval = MqttOk;
debug("MqttBroker::publish");
int i=0;
for(auto client: clients)
{
i++;
#if TINY_MQTT_DEBUG
Console << __LINE__ << " broker:" << (remote_broker && remote_broker->connected() ? "linked" : "alone") <<
" srce=" << (source->isLocal() ? "loc" : "rem") << " clt#" << i << ", local=" << client->isLocal() << ", con=" << client->connected() << endl;
#endif
bool doit = false;
if (remote_broker && remote_broker->connected()) // this (MqttBroker) is connected (to a external broker)
{
// ext_broker -> clients or clients -> ext_broker
if (source == remote_broker) // external broker -> internal clients
doit = true;
else // external clients -> this broker
{
// As this broker is connected to another broker, simply forward the msg
MqttError ret = remote_broker->publishIfSubscribed(topic, msg);
if (ret != MqttOk) retval = ret;
}
}
else // Disconnected
{
doit = true;
}
#if TINY_MQTT_DEBUG
Console << ", doit=" << doit << ' ';
#endif
if (remote_broker == nullptr or source == remote_broker) // external broker -> internal clients
{
for(auto& client: clients)
{
retval = client->publishIfSubscribed(topic, msg);
}
for(auto& client: local_clients)
{
retval = client->publishIfSubscribed(topic, msg);
}
}
else
{
if (remote_broker && remote_broker->connected())
{
MqttError ret = remote_broker->publishIfSubscribed(topic, msg);
if (ret != MqttOk) retval = ret;
}
if (doit) retval = client->publishIfSubscribed(topic, msg);
debug("");
}
return retval;
}
@@ -247,12 +277,16 @@ void MqttMessage::getString(const char* &buff, uint16_t& len)
buff+=2;
}
void MqttClient::clientAlive()
void MqttClient::clientAlive(uint32_t more_seconds)
{
debug("MqttClient::clientAlive");
if (keep_alive)
{
alive=millis()+1000*(keep_alive+(local_broker ? TINY_MQTT_CLIENT_ALIVE_TOLERANCE : 0));
#ifdef EPOXY_DUINO
alive=millis()+500000+0*more_seconds;
#else
alive=millis()+1000*(keep_alive+more_seconds);
#endif
}
else
alive=0;
@@ -264,7 +298,7 @@ void MqttClient::loop()
{
if (local_broker)
{
Serial << "timeout client " << clientId << endl;
debug(red << "timeout client");
close();
debug(red << "closed");
}
@@ -272,9 +306,8 @@ void MqttClient::loop()
{
debug("pingreq");
uint16_t pingreq = MqttMessage::Type::PingReq;
tcp_client->write((const char*)(&pingreq), 2);
clientAlive();
clientAlive(0);
// TODO when many MqttClient passes through a local broker
// there is no need to send one PingReq per instance.
@@ -310,7 +343,7 @@ void MqttClient::onConnect(void *mqttclient_ptr, TcpClient*)
msg.reset();
debug("cnx: mqtt sent " << (dbg_ptr)mqtt->local_broker);
mqtt->clientAlive();
mqtt->clientAlive(0);
}
#ifdef TINY_MQTT_ASYNC
@@ -417,14 +450,13 @@ void MqttClient::processMessage(MqttMessage* mesg)
switch(mesg->type())
{
case MqttMessage::Type::Connect:
if (mqtt_flags & FlagConnected)
if (mqtt_connected())
{
debug("already connected");
break;
}
payload = header+10;
// Todo should check that reserved == 0 (spec)
mqtt_flags = header[7] & ~FlagConnected;
mqtt_flags = header[7];
keep_alive = MqttMessage::getSize(header+8);
if (strncmp("MQTT", header+2,4))
{
@@ -433,13 +465,13 @@ void MqttClient::processMessage(MqttMessage* mesg)
}
if (header[6]!=0x04)
{
debug("unknown level");
debug("Unsupported MQTT version (" << (int) header[6] << "), only version=4 supported" << endl);
break; // Level 3.1.1
}
// ClientId
mesg->getString(payload, len);
clientId = std::string(payload, len);
clientId = string(payload, len);
payload += len;
if (mqtt_flags & FlagWill) // Will topic
@@ -468,7 +500,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
Console << yellow << "Client " << clientId << " connected : keep alive=" << keep_alive << '.' << white << endl;
#endif
bclose = false;
mqtt_flags |= FlagConnected;
setFlag(CltFlagConnected);
{
MqttMessage msg(MqttMessage::Type::ConnAck);
msg.add(0); // Session present (not implemented)
@@ -478,14 +510,14 @@ void MqttClient::processMessage(MqttMessage* mesg)
break;
case MqttMessage::Type::ConnAck:
mqtt_flags |= FlagConnected;
setFlag(CltFlagConnected);
bclose = false;
resubscribe();
break;
case MqttMessage::Type::SubAck:
case MqttMessage::Type::PubAck:
if (not (mqtt_flags & FlagConnected)) break;
if (not mqtt_connected()) break;
// Ignore acks
bclose = false;
break;
@@ -496,7 +528,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
break;
case MqttMessage::Type::PingReq:
if (not (mqtt_flags & FlagConnected)) break;
if (not mqtt_connected()) break;
if (tcp_client)
{
uint16_t pingreq = MqttMessage::Type::PingResp;
@@ -513,15 +545,15 @@ void MqttClient::processMessage(MqttMessage* mesg)
case MqttMessage::Type::Subscribe:
case MqttMessage::Type::UnSubscribe:
{
if (not (mqtt_flags & FlagConnected)) break;
if (not mqtt_connected()) break;
payload = header+2;
debug("un/subscribe loop");
std::string qoss;
string qoss;
while(payload < mesg->end())
{
mesg->getString(payload, len); // Topic
debug( " topic (" << std::string(payload, len) << ')');
debug( " topic (" << string(payload, len) << ')');
// subscribe(Topic(payload, len));
Topic topic(payload, len);
@@ -557,15 +589,15 @@ void MqttClient::processMessage(MqttMessage* mesg)
break;
case MqttMessage::Type::UnSuback:
if (not (mqtt_flags & FlagConnected)) break;
if (not mqtt_connected()) break;
bclose = false;
break;
case MqttMessage::Type::Publish:
#if TINY_MQTT_DEBUG
Console << "publish " << (mqtt_flags & FlagConnected) << '/' << (long) tcp_client.get() << endl;
Console << "publish " << mqtt_connected() << '/' << (long) tcp_client << endl;
#endif
if ((mqtt_flags & FlagConnected) or tcp_client == nullptr)
if (mqtt_connected() or tcp_client == nullptr)
{
uint8_t qos = mesg->flags();
payload = header;
@@ -575,7 +607,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
#if TINY_MQTT_DEBUG
Console << "Received Publish (" << published.str().c_str() << ") size=" << (int)len << endl;
#endif
// << '(' << std::string(payload, len).c_str() << ')' << " msglen=" << mesg->length() << endl;
// << '(' << string(payload, len).c_str() << ')' << " msglen=" << mesg->length() << endl;
if (qos) payload+=2; // ignore packet identifier if any
len=mesg->end()-payload;
// TODO reset DUP
@@ -606,8 +638,8 @@ void MqttClient::processMessage(MqttMessage* mesg)
case MqttMessage::Type::Disconnect:
// TODO should discard any will msg
if (not (mqtt_flags & FlagConnected)) break;
mqtt_flags &= ~FlagConnected;
if (not mqtt_connected()) break;
resetFlag(CltFlagConnected);
close(false);
bclose=false;
break;
@@ -628,7 +660,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
}
else
{
clientAlive();
clientAlive(local_broker ? 5 : 0);
}
}
@@ -867,7 +899,7 @@ void MqttMessage::hexdump(const char* prefix) const
(void)prefix;
#if TINY_MQTT_DEBUG
if (TinyMqtt::debug<2) return;
static std::map<Type, std::string> tts={
static std::map<Type, string> tts={
{ Connect, "Connect" },
{ ConnAck, "Connack" },
{ Publish, "Publish" },
@@ -880,7 +912,7 @@ void MqttMessage::hexdump(const char* prefix) const
{ PingResp, "Pingresp" },
{ Disconnect, "Disconnect" }
};
std::string t("Unknown");
string t("Unknown");
Type typ=static_cast<Type>(buffer[0] & 0xF0);
if (tts.find(typ) != tts.end())
t=tts[typ];
@@ -897,7 +929,7 @@ void MqttMessage::hexdump(const char* prefix) const
const char* hex_to_str = " | ";
const char* separator = hex_to_str;
const char* half_sep = " - ";
std::string ascii;
string ascii;
Console << prefix << " size(" << buffer.size() << "), state=" << state << endl;

View File

@@ -4,10 +4,6 @@
#ifndef TINY_MQTT_DEBUG
#define TINY_MQTT_DEBUG 0
#endif
#ifndef TINY_MQTT_DEFAULT_ALIVE
#define TINY_MQTT_DEFAULT_ALIVE 10
#endif
#define TINY_MQTT_CLIENT_ALIVE_TOLERANCE 5
// TODO Should add a AUnit with both TINY_MQTT_ASYNC and not TINY_MQTT_ASYNC
// #define TINY_MQTT_ASYNC // Uncomment this to use ESPAsyncTCP instead of normal cnx
@@ -57,15 +53,6 @@
#define debug(what) {}
#endif
#include <TinyConsole.h>
#if 0
#define dclass { Console << __LINE__ << ':' << __PRETTY_FUNCTION__ << ", this=" << (long)this << endl; }
#define dtor { Console << __LINE__ << ": ~" << __PRETTY_FUNCTION__ << ", this=" << (long)this << endl; }
#else
#define dclass
#define dtor
#endif
#ifdef TINY_MQTT_ASYNC
using TcpClient = AsyncClient;
using TcpServer = AsyncServer;
@@ -81,12 +68,15 @@ enum __attribute__((packed)) MqttError
MqttInvalidMessage=2,
};
using string = TinyConsole::string;
class Topic : public IndexedString
{
public:
Topic(const string& m) : IndexedString(m){}
Topic(const char* s, uint8_t len) : IndexedString(s,len){}
Topic(const char* s) : Topic(s, strlen(s)) {}
Topic(const std::string s) : Topic(s.c_str(), s.length()){};
// Topic(const string s) : Topic(s.c_str(), s.length()){};
const char* c_str() const { return str().c_str(); }
@@ -135,7 +125,7 @@ class MqttMessage
void incoming(char byte);
void add(char byte) { incoming(byte); }
void add(const char* p, size_t len, bool addLength=true );
void add(const std::string& s) { add(s.c_str(), s.length()); }
void add(const string& s) { add(s.c_str(), s.length()); }
void add(const Topic& t) { add(t.str()); }
const char* end() const { return &buffer[0]+buffer.size(); }
const char* getVHeader() const { return &buffer[vheader]; }
@@ -169,7 +159,7 @@ class MqttMessage
private:
void encodeLength();
std::string buffer;
string buffer;
uint8_t vheader;
uint16_t size; // bytes left to receive
State state;
@@ -186,9 +176,14 @@ class MqttClient
FlagWillQos = 16 | 8, // unsupported
FlagWill = 4, // unsupported
FlagCleanSession = 2, // unsupported
FlagReserved = 1
};
FlagReserved = 1, // use reserved as connected (save 1 byte)
FlagConnected = 1
enum __attribute__((packed)) CltFlags
{
CltFlagNone = 0,
CltFlagConnected = 1,
CltFlagToDelete = 2
};
public:
@@ -196,13 +191,13 @@ class MqttClient
/** Constructor. Broker is the adress of a local broker if not null
If you want to connect elsewhere, leave broker null and use connect() **/
MqttClient(MqttBroker* broker = nullptr, const std::string& id = TINY_MQTT_DEFAULT_CLIENT_ID);
MqttClient(const std::string& id) : MqttClient(nullptr, id){ dclass; }
MqttClient(MqttBroker* broker = nullptr, const string& id = TINY_MQTT_DEFAULT_CLIENT_ID);
MqttClient(const string& id) : MqttClient(nullptr, id){}
~MqttClient();
void connect(MqttBroker* local_broker);
void connect(std::string broker, uint16_t port, uint16_t keep_alive = TINY_MQTT_DEFAULT_ALIVE);
void connect(string broker, uint16_t port, uint16_t keep_alive = 10);
// TODO it seems that connected returns true in tcp mode even if
// no negociation occurred
@@ -217,8 +212,8 @@ class MqttClient
if (tcp_client) tcp_client->write(buf, length);
}
const std::string& id() const { return clientId; }
void id(const std::string& new_id) { clientId = new_id; }
const string& id() const { return clientId; }
void id(const string& new_id) { clientId = new_id; }
/** Should be called in main loop() */
void loop();
@@ -236,7 +231,7 @@ class MqttClient
MqttError publish(const Topic&, const char* payload, size_t pay_length);
MqttError publish(const Topic& t, const char* payload) { return publish(t, payload, strlen(payload)); }
MqttError publish(const Topic& t, const String& s) { return publish(t, s.c_str(), s.length()); }
MqttError publish(const Topic& t, const std::string& s) { return publish(t,s.c_str(),s.length());}
MqttError publish(const Topic& t, const string& s) { return publish(t,s.c_str(),s.length());}
MqttError publish(const Topic& t) { return publish(t, nullptr, 0);};
MqttError subscribe(Topic topic, uint8_t qos=0);
@@ -247,7 +242,7 @@ class MqttClient
// TODO seems to be useless
bool isLocal() const { return tcp_client == nullptr; }
void dump(std::string indent="")
void dump(string indent="")
{
(void)indent;
#if TINY_MQTT_DEBUG
@@ -284,6 +279,9 @@ class MqttClient
uint32_t keepAlive() const { return keep_alive; }
private:
bool mqtt_connected() const { return cltFlags & CltFlagConnected; }
void setFlag(CltFlags f) { cltFlags |= f; }
void resetFlag(CltFlags f) { cltFlags &= ~f; }
// event when tcp/ip link established (real or fake)
static void onConnect(void * client_ptr, TcpClient*);
@@ -298,23 +296,22 @@ class MqttClient
// republish a received publish if topic matches any in subscriptions
MqttError publishIfSubscribed(const Topic& topic, MqttMessage& msg);
void clientAlive();
void clientAlive(uint32_t more_seconds);
void processMessage(MqttMessage* message);
char mqtt_flags = 0;
uint16_t keep_alive = 30;
// for client connected to remote broker, PingReq is sent when millis() >= alive
// for a client managed by a broker, disconnect it if millis() >= alive
uint32_t alive; // PingReq if millis() > alive,
uint8_t cltFlags = CltFlagNone;
char mqtt_flags;
uint32_t keep_alive = 30;
uint32_t alive;
MqttMessage message;
// connection to local broker, or link to the parent
// when MqttBroker uses MqttClient for each external connexion
MqttBroker* local_broker=nullptr;
std::unique_ptr<TcpClient> tcp_client; // connection to remote broker
std::set<Topic> subscriptions;
std::string clientId;
TcpClient* tcp_client=nullptr; // connection to remote broker
std::set<Topic> subscriptions;
string clientId;
CallBack callback = nullptr;
};
@@ -324,30 +321,30 @@ class MqttBroker
{
Disconnected, // Also the initial state
Connecting, // connect and sends a fake publish to avoid circular cnx
Connected, // this->broker is connected and circular cnx avoided
Connected, // this->broker is connected and circular cnx avoided
};
public:
// TODO limit max number of clients
MqttBroker(uint16_t port);
~MqttBroker();
void begin() { if (server) server->begin(); }
void begin() { server->begin(); }
void loop();
void connect(const std::string& host, uint16_t port=1883);
/** Connect the broker to a parent broker */
void connect(const string& host, uint16_t port=1883);
/** returns true if connected to another broker */
bool connected() const { return state == Connected; }
size_t clientsCount() const { return clients.size(); }
void dump(std::string indent="")
void dump(string indent="")
{
for(auto& client: clients)
for(auto client: clients)
client->dump(indent);
}
size_t localClientsCount() const { return local_clients.size(); }
using Clients = std::vector<MqttClient*>;
const Clients& getClients() const { return clients; }
const std::vector<MqttClient*> getClients() const { return clients; }
private:
friend class MqttClient;
@@ -365,15 +362,14 @@ class MqttBroker
MqttError subscribe(const Topic& topic, uint8_t qos);
// For clients that are added not by the broker itself (local clients)
void addClient(MqttClient* local) { local_clients.insert(local); }
void addClient(MqttClient* client);
void removeClient(MqttClient* client);
bool compareString(const char* good, const char* str, uint8_t str_len) const;
Clients clients;
std::set<MqttClient*> local_clients;
std::vector<MqttClient*> clients;
private:
std::unique_ptr<TcpServer> server;
TcpServer* server = nullptr;
const char* auth_user = "guest";
const char* auth_password = "guest";

View File

@@ -1,11 +1,22 @@
SUB=
all:runtests
tests:
@set -e; \
for i in ${SUB}*-tests/Makefile; do \
for i in $(SUB)*-tests/Makefile; do \
echo '==== Making:' $$(dirname $$i); \
$(MAKE) -C $$(dirname $$i) -j; \
done
$(MAKE) -C compile-test
valgrind:
@set -e; \
$(MAKE) tests; \
for i in $(SUB)*-tests/Makefile; do \
echo '==== Running:' $$(dirname $$i); \
valgrind $$(dirname $$i)/$$(dirname $$i).out; \
done
debugtest:
@set -e; \
@@ -13,18 +24,17 @@ debugtest:
$(MAKE) -C debug-mode -j; \
debug-mode/debug-tests.out
runtests: debugtest
@$(MAKE) clean
@$(MAKE) tests
runtests:
@set -e; \
for i in ${SUB}*-tests/Makefile; do \
$(MAKE) tests; \
for i in $(SUB)*-tests/Makefile; do \
echo '==== Running:' $$(dirname $$i); \
$$(dirname $$i)/$$(dirname $$i).out; \
done
clean:
@set -e; \
for i in ${SUB}*-tests/Makefile; do \
for i in $(SUB)*-tests/Makefile; do \
echo '==== Cleaning:' $$(dirname $$i); \
$(MAKE) -C $$(dirname $$i) clean; \
done

11
tests/Makefile.opts Normal file
View File

@@ -0,0 +1,11 @@
# GCC
# CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
EXTRA_CXXFLAGS=-g3 -O0
CXXFLAGS=-D_GNU_SOURCE -Werror=return-type -std=gnu++17 -Wall -g3 -O0
# CLANG SANITIZE
# CXX=clang
# EXTRA_CXXFLAGS=-g3 -O0 -fsanitize=memory
# LDFLAGS = -lpthread -lstdc++

View File

@@ -3,9 +3,6 @@
EXTRA_CXXFLAGS=-g3 -O0 -DTINY_MQTT_TESTS
# Remove flto flag from EpoxyDuino (too many <optimized out>)
CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics -DEPOXY_TEST
APP_NAME := classbind-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP TinyConsole
ARDUINO_LIB_DIRS := ../../../EspMock/libraries

View File

@@ -17,9 +17,10 @@ class TestReceiver : public MqttClassBinder<TestReceiver>
public:
TestReceiver(const char* name) : MqttClassBinder(), name_(name) {}
void onPublish(const MqttClient* /* source */, const Topic& topic, const char* payload, size_t /* length */)
void onPublish(const MqttClient* /* source */, const Topic& topic, const char* /* payload */, size_t /* length */)
{
Serial << "--> routed message received by " << name_ << ':' << topic.c_str() << " = " << payload << endl;
(void) topic;
// Serial << "--> routed message received by " << name_ << ':' << topic.c_str() << " = " << payload << endl;
messages[name_]++;
}
@@ -35,7 +36,8 @@ std::map<std::string, int> TestReceiver::messages;
static int unrouted = 0;
void onUnrouted(const MqttClient*, const Topic& topic, const char*, size_t)
{
Serial << "--> unrouted: " << topic.c_str() << endl;
(void) topic;
// Serial << "--> unrouted: " << topic.c_str() << endl;
unrouted++;
}
@@ -127,52 +129,8 @@ void reset_and_start_servers(int n, bool early_accept = true)
}
}
test(classbind_two_subscribers_binded_one_sender_wildcard)
{
EpoxyTest::set_millis(0);
reset_and_start_servers(2, true);
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 mqtt_a(&broker, "mqtt_a");
MqttClient mqtt_b(&broker, "mqtt_a");
MqttClient mqtt_sender(&broker, "sender");
broker.loop();
assertTrue(mqtt_a.connected());
assertTrue(mqtt_b.connected());
TestReceiver receiver("receiver");
MqttClassBinder<TestReceiver>::onPublish(&mqtt_a, &receiver);
MqttClassBinder<TestReceiver>::onPublish(&mqtt_b, &receiver);
mqtt_a.subscribe("#");
mqtt_b.subscribe("#");
mqtt_sender.publish("a/b", "ab");
for (int i =0; i<10; i++)
{
EpoxyTest::add_millis(100);
mqtt_a.loop();
mqtt_b.loop();
mqtt_sender.loop();
broker.loop();
}
assertEqual(TestReceiver::messages["receiver"], 2);
assertEqual(unrouted, 0);
EpoxyTest::set_real_time();
}
test(classbind_one_client_receives_the_message)
{
EpoxyTest::set_millis(0);
reset_and_start_servers(2, true);
assertEqual(WiFi.status(), WL_CONNECTED);
@@ -182,7 +140,7 @@ test(classbind_one_client_receives_the_message)
// We have a 2nd ESP in order to test through wifi (opposed to local)
ESP8266WiFiClass::selectInstance(2);
MqttClient client("sender");
MqttClient client;
client.connect(ip_broker.toString().c_str(), 1883);
broker.loop();
assertTrue(client.connected());
@@ -195,14 +153,12 @@ test(classbind_one_client_receives_the_message)
for (int i =0; i<10; i++)
{
EpoxyTest::add_millis(100);
client.loop();
broker.loop();
}
assertEqual(TestReceiver::messages["receiver"], 1);
assertEqual(unrouted, 0);
EpoxyTest::set_real_time();
}
test(classbind_routes_should_be_empty_when_receiver_goes_out_of_scope)
@@ -384,7 +340,7 @@ void setup() {
while(!Serial);
*/
Serial.println("=============[ CLASS BINDER TinyMqtt TESTS ]========================");
Serial.println("=============[ TinyMqtt class-bind TESTS ]========================");
WiFi.mode(WIFI_STA);
WiFi.begin("network", "password");

View File

@@ -0,0 +1,11 @@
# See https://github.com/bxparks/EpoxyDuino for documentation about this
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
include ../Makefile.opts
APP_NAME := tinymqtt-test
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsync ESP8266mDNS TinyConsole
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
EPOXY_CORE := EPOXY_CORE_ESP8266
DUMMY := 1
include ../../../EpoxyDuino/EpoxyDuino.mk

View File

@@ -0,0 +1,848 @@
// vim: ts=2 sw=2 expandtab smartindent
#include <TinyConsole.h>
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
#include <TinyStreaming.h>
#include <sstream>
#include <string>
#include <map>
using string = TinyConsole::string;
bool echo_on = true;
auto green = TinyConsole::green;
auto red = TinyConsole::red;
auto white = TinyConsole::white;
auto cyan = TinyConsole::cyan;
auto yellow = TinyConsole::yellow;
auto magenta = TinyConsole::magenta;
auto save_cursor = TinyConsole::save_cursor;
auto restore_cursor = TinyConsole::restore_cursor;
auto erase_to_end = TinyConsole::erase_to_end;
const char* ssid = "";
const char* password = "";
struct free_broker
{
public:
free_broker(const char* s, uint16_t p, const char* /* comment */) : url(s), port(p) {}
string url;
uint16_t port;
};
const std::map<string, free_broker> list =
{
{ "mqtthq", { "public.mqtthq.com" , 8083, "publish/subscribe" }},
{ "hivemq", { "broker.hivemq.com", 1883, "" }}
};
/** Very complex example
* Console allowing to make any kind of test,
* even some stress tests.
*
* Upload the sketch, the use the terminal.
* Press H for mini help.
*
* tested with mqtt-spy-0.5.4
* TODO examples of scripts
*/
void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
{
Console << cyan << "--> " << srce->id().c_str() << ": received " << topic.c_str() << white;
if (payload)
{
Console << ", payload[" << length << "]=[";
while(length--)
{
const char c=*payload++;
if (c<32)
Console << '?';
else
Console << c;
}
Console << ']' << endl;
}
}
std::map<string, MqttClient*> clients;
std::map<string, MqttBroker*> brokers;
std::map<string, string> vars;
void eval(string& cmd);
void replace(const char* d, string& str, string srch, string to)
{
if (d[0] && d[1])
{
srch=d[0]+srch+d[1];
to=d[0]+to+d[1];
size_t pos = 0;
while((pos=str.find(srch, pos)) != string::npos)
{
str.erase(pos, srch.length());
str.insert(pos, to);
pos += to.length()-1;
}
}
}
void replaceVars(string& cmd)
{
cmd = ' '+cmd+' ';
for(auto it: vars)
{
replace("..", cmd, it.first, it.second);
replace(". ", cmd, it.first, it.second);
replace(" .", cmd, it.first, it.second);
replace(" ", cmd, it.first, it.second);
}
cmd.erase(0, cmd.find_first_not_of(' '));
cmd.erase(cmd.find_last_not_of(' ')+1);
}
void onCommand(const string& command)
{
Console << endl;
string cmd=command;
if (cmd.substr(0,3)!="set") replaceVars(cmd);
eval(cmd);
Console << endl;
Console.prompt();
}
void setup()
{
Serial.begin(115200);
Console.begin(Serial);
Console.setPrompt("> ");
Console.setCallback(onCommand);
delay(500);
Console.cls();
Console << endl << endl;
Console << yellow
<< "***************************************************************" << endl;
Console << "* Welcome to the TinyMqtt console" << endl;
Console << "* The console allows to test all features of the libraries." << endl;
Console << "* Enter help to view the list of commands." << endl;
Console << "***************************************************************" << endl;
Console << endl;
if (strlen(ssid)==0)
Console << red << "* ERROR: You must modify ssid/password in order" << endl
<< " to be able to connect to your Wifi network." << endl;
Console << endl << white;
Console << "Connecting to '" << ssid << "' ";
WiFi.mode(WIFI_STA);
WiFi.begin(ssid, password);
WiFi.mode(WIFI_STA);
WiFi.begin(ssid, password);
while (WiFi.status() != WL_CONNECTED)
{ Console << '-'; delay(500); }
Console << endl << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
const char* name="tinytest";
Console << "Starting MDNS, name= " << name;
MqttBroker* broker = new MqttBroker(1883);
broker->begin();
brokers["broker"] = broker;
if (Console.isTerm()) onCommand("every 333 view");
}
string getword(string& str, const char* if_empty=nullptr, char sep=' ');
int getint(string& str, const int if_empty=0)
{
string str2=str;
string sword = getword(str);
if (sword[0] and isdigit(sword[0]))
{
int ret=atoi(sword.c_str());
while(isdigit(sword[0]) or sword[0]==' ') sword.erase(0,1);
if (sword.length()) str = sword+' '+str;
return ret;
}
str=str2;
return if_empty;
}
string getword(string& str, const char* if_empty/*=nullptr*/, char sep/*=' '*/)
{
char quote=(str[0]=='"' or str[0]=='\'' ? str[0] : 0);
if (quote) str.erase(0,1);
string sword;
while(str.length() and (str[0]!=sep or quote))
{
if (str[0]==quote)
{
str.erase(0,1);
break;
}
sword += str[0];
str.erase(0,1);
}
while(str[0]==sep) str.erase(0,1);
if (if_empty and sword.length()==0) return if_empty;
if (quote==false and sword.length()>=4 and sword.substr(0,3)=="rnd")
{
sword.erase(0,3);
if (sword[0]=='(')
{
int to = 100;
sword.erase(0,1);
int from=getint(sword);
if (sword[0]==',')
{
sword.erase(0,1);
to = getint(sword);
if (sword[0]!=')') Console << "Missing ')'" << endl;
}
else
{
to=from;
from=0;
}
return String(random(from,to)).c_str();
}
else
{
Console << "Missing '('" << endl;
}
}
while(str[0]==' ') str.erase(0,1);
return sword;
}
bool isaddr(string s)
{
if (s.length()==0 or s.length()>3) return false;
for(char c: s)
if (c<'0' or c>'9') return false;
return true;
}
string getip(string& str, const char* if_empty=nullptr, char sep=' ')
{
string addr=getword(str, if_empty, sep);
string ip=addr;
std::vector<string> build;
while(ip.length())
{
string b=getword(ip,nullptr,'.');
if (isaddr(b) && build.size()<4)
{
build.push_back(b);
}
else
return addr;
}
IPAddress local=WiFi.localIP();
addr.clear();
while(build.size()!=4)
{
std::stringstream b;
b << (int)local[3-build.size()];
build.insert(build.begin(), b.str().c_str());
}
for(string s: build)
{
if (addr.length()) addr += '.';
addr += s;
}
Console << "connect address: " << addr << endl;
return addr;
}
std::set<string> commands = {
"broker", "blink", "client", "connect",
"create", "delete", "debug", "help", "interval",
"list", "ls", "ip", "off", "on", "set",
"publish", "reset", "subscribe", "unsubscribe", "view", "echo", "every"
};
void convertToCommand(string& search)
{
while(search[0]==' ') search.erase(0,1);
if (search.length()==0) return;
string matches;
int count=0;
for(string cmd: commands)
{
if (cmd.substr(0, search.length()) == search)
{
if (count) matches +=", ";
count++;
matches += cmd;
}
}
if (count==1)
search = matches;
else if (count>1)
{
Console << "Ambiguous command: " << matches << endl;
search.clear();
}
}
bool compare(string s, const char* cmd)
{
uint8_t p=0;
while(s[p++]==*cmd++)
{
if (*cmd==0 or s[p]==0) return true;
if (s[p]==' ') return true;
}
return false;
}
using ClientFunction = void(*)(string& cmd, MqttClient* publish);
struct Every
{
string cmd;
uint32_t ms;
uint32_t next;
uint32_t underrun=0;
bool active=true;
void dump()
{
if (active)
Console << green << "enabled";
else
Console << red << "disabled";
auto mill=millis();
Console << white << ms << "ms [" << cmd << "] next in ";
if (mill > next)
Console << "now";
else
Console << next-mill << "ms";
}
};
uint32_t blink_ms_on[16];
uint32_t blink_ms_off[16];
uint32_t blink_next[16];
bool blink_state[16];
int16_t blink;
std::vector<Every> everies;
void clientConnect(MqttClient* client, string& cmd)
{
string remote = getword(cmd);
uint16_t port;
auto it=list.find(remote);
if (it != list.end())
{
Console << "Connecting to free broker: " << remote << endl;
remote = it->second.url;
port=it->second.port;
}
else
port=getint(cmd);
client->connect(remote.c_str(), port, getint(cmd, 60));
Console << (client->connected() ? "connected." : "not connected") << endl;
}
void eval(string& cmd)
{
while(cmd.length())
{
MqttError retval = MqttOk;
string s;
MqttBroker* broker = nullptr;
MqttClient* client = nullptr;
// client.function notation
if (cmd.find('.') != string::npos &&
cmd.find('.') < cmd.find(' '))
{
s=getword(cmd, nullptr, '.');
if (s.length())
{
if (clients.find(s) != clients.end())
{
client = clients[s];
}
else if (brokers.find(s) != brokers.end())
{
broker = brokers[s];
}
else
{
Console << red << "Unknown class (" << s.c_str() << ")" << white << endl;
cmd.clear();
}
}
}
s = getword(cmd);
if (s.length()) convertToCommand(s);
if (s.length()==0)
{}
else if (compare(s, "debug"))
{
#if TINY_MQTT_DEBUG
TinyMqtt::debug = getint(cmd);
#else
Console << red << "TinyMqtt not compiled in debug" << endl;
#endif
}
else if (compare(s, "list"))
{
Console << "List of free servers" << endl;
for(const auto& fb: list)
{
Console << " " << fb.first << " : " << fb.second.url << ":" << fb.second.port << endl;
}
}
else if (compare(s, "delete"))
{
if (client==nullptr && broker==nullptr)
{
s = getword(cmd);
if (clients.find(s) != clients.end())
{
client = clients[s];
}
else if (brokers.find(s) != brokers.end())
{
broker = brokers[s];
}
else
Console << red << "Unable to find (" << s.c_str() << ")" << white << endl;
}
if (client)
{
for (auto it: clients)
{
if (it.second != client) continue;
Console << "deleted" << endl;
delete (it.second);
clients.erase(it.first);
break;
}
cmd += " ls";
}
else if (broker)
{
for(auto it: brokers)
{
if (broker != it.second) continue;
Console << "deleted" << endl;
delete (it.second);
brokers.erase(it.first);
break;
}
cmd += " ls";
}
else
Console << "Nothing to delete" << endl;
}
else if (broker)
{
if (compare(s,"connect"))
{
Console << "NYI" << endl;
}
else if (compare(s, "view"))
{
broker->dump();
}
else
{
Console << "Unknown broker command (" << s << ")" << endl;
s.clear();
}
}
else if (client)
{
if (compare(s,"connect"))
{
clientConnect(client, cmd);
}
else if (compare(s,"publish"))
{
retval = client->publish(getword(cmd), getword(cmd));
}
else if (compare(s,"subscribe"))
{
client->subscribe(getword(cmd));
}
else if (compare(s, "unsubscribe"))
{
client->unsubscribe(getword(cmd));
}
else if (compare(s, "view"))
{
client->dump();
}
else
{
Console << "Unknown client command (" << s << ")" << endl;
s.clear();
}
}
else if (compare(s, "on"))
{
uint8_t pin=getint(cmd, 2);
pinMode(pin, OUTPUT);
digitalWrite(pin, HIGH);
}
else if (compare(s, "off"))
{
uint8_t pin=getint(cmd, 2);
pinMode(pin, OUTPUT);
digitalWrite(pin, LOW);
}
else if (compare(s, "echo"))
{
s=getword(cmd);
if (s=="on")
echo_on = true;
else if (s=="off")
echo_on = false;
else
{
Console << s << ' ';
while(cmd.length())
{
Console << getword(cmd) << ' ';
}
}
}
else if (compare(s, "every"))
{
uint32_t ms = getint(cmd, 0);
if (ms)
{
if (cmd.length())
{
Every every;
every.ms=ms;
every.cmd=cmd;
every.next=millis()+ms;
everies.push_back(every);
every.dump();
Console << endl;
cmd.clear();
}
}
else if (compare(cmd, "off") or compare(cmd, "on"))
{
bool active=getword(cmd)=="on";
uint8_t ever=getint(cmd, 100);
uint8_t count=0;
for(auto& every: everies)
{
if (count==ever or (ever==100))
{
if (every.active != active)
{
Console << "every #" << count << (active ? " on" :" off") << endl;
every.active = active;
every.underrun = 0;
}
}
count++;
}
}
else if (compare(cmd, "list") or cmd.length()==0)
{
getword(cmd);
Console << "List of everies (ms=" << millis() << ")" << endl;
uint8_t count=0;
for(auto& every: everies)
{
Console << count << ": ";
every.dump();
Console << endl;
count++;
}
}
else if (compare(cmd, "remove"))
{
Console << "Removing..." << endl;
getword(cmd);
int8_t every=getint(cmd, -1);
if (every==-1 and compare(cmd, "last") and everies.size())
{
getword(cmd);
everies.erase(everies.begin()+everies.size()-1);
}
else if (every==-1 and compare(cmd, "all"))
{
getword(cmd);
everies.clear();
}
else if (everies.size() > (uint8_t)every)
{
everies.erase(everies.begin()+every);
}
else
Console << "Bad colmmand" << endl;
}
else
Console << "Bad command" << endl;
}
else if (compare(s, "blink"))
{
int8_t blink_nr = getint(cmd, -1);
if (blink_nr >= 0)
{
blink_ms_on[blink_nr]=getint(cmd, blink_ms_on[blink_nr]);
blink_ms_off[blink_nr]=getint(cmd, blink_ms_on[blink_nr]);
pinMode(blink_nr, OUTPUT);
blink_next[blink_nr] = millis();
Console << "Blink " << blink_nr << ' ' << (blink_ms_on[blink_nr] ? "on" : "off") << endl;
if (blink_ms_on[blink_nr])
blink |= 1<< blink_nr;
else
{
blink &= ~(1<< blink_nr);
}
}
}
else if (compare(s, "broker"))
{
string id=getword(cmd);
if (clients.find(id) != clients.end())
{
Console << "A client already have that name" << endl;
cmd.clear();
}
else if (id.length() or brokers.find(id)!=brokers.end())
{
int port=getint(cmd, 0);
if (port)
{
MqttBroker* broker = new MqttBroker(port);
broker->begin();
brokers[id] = broker;
Console << "new broker (" << id.c_str() << ")" << endl;
}
else
{
Console << "Missing port" << endl;
cmd.clear();
}
}
else
{
Console << "Missing or existing broker name (" << id.c_str() << ")" << endl;
cmd.clear();
}
}
else if (compare(s, "client"))
{
string id=getword(cmd);
if (brokers.find(id) != brokers.end())
{
Console << "A broker have that name" << endl;
cmd.clear();
}
else if (id.length() or clients.find(id)!=clients.end())
{
s=getword(cmd); // broker
if (s=="" or brokers.find(s) != brokers.end() or list.find(s) != list.end())
{
MqttBroker* broker = nullptr;
if (s.length()) broker = brokers[s];
MqttClient* client = new MqttClient(broker, id);
clients[id]=client;
client->setCallback(onPublish);
if (list.find(s) != list.end())
{
cmd=s+' '+cmd;
clientConnect(client, cmd);
}
Console << "new client (" << id.c_str() << ", " << s.c_str() << ')' << endl;
}
else if (s.length())
{
Console << " not found." << endl;
cmd.clear();
}
}
else
{
Console << "Missing or existing client name" << endl;
cmd.clear();
}
}
else if (compare(s, "set"))
{
string name(getword(cmd));
if (name.length()==0)
{
for(auto it: vars)
{
Console << " " << it.first << " -> " << it.second << endl;
}
}
else if (commands.find(name) != commands.end())
{
Console << "Reserved keyword (" << name << ")" << endl;
cmd.clear();
}
else
{
if (cmd.length())
{
vars[name] = cmd;
cmd.clear();
}
else if (vars.find(name) != vars.end())
vars.erase(vars.find(name));
}
}
else if (compare(s, "ls") or compare(s, "view"))
{
bool view = compare(s, "view");
if (view)
{
Console << save_cursor << magenta;
Console.gotoxy(1,1);
}
Console << "--< " << '/' << clients.size() << " client/s. >--" << erase_to_end << endl;
for(auto it: clients)
{
it.second->dump(" ");
}
Console << "--< " << brokers.size() << " brokers/s. >--" << erase_to_end << endl;
for(auto it: brokers)
{
Console << " +-- '" << it.first.c_str() << "' " << it.second->clientsCount() << " client/s."<< erase_to_end << endl;
it.second->dump(" ");
}
if (view)
{
Console.bg(white);
Console << erase_to_end << restore_cursor;
}
}
else if (compare(s, "reset"))
ESP.restart();
else if (compare(s, "ip"))
Console << "IP: " << WiFi.localIP() << endl;
else if (compare(s,"help"))
{
Console << "syntax:" << endl;
Console << " MqttBroker:" << endl;
Console << " broker {broker_name} {port} : create a new broker" << endl;
Console << " broker_name can be one of 'list'" << endl;
Console << " broker_name.delete : delete a broker (buggy)" << endl;
Console << " broker_name.view : dump a broker" << endl;
Console << endl;
Console << " MqttClient:" << endl;
Console << " client {name} {broker} : create a client then" << endl;
Console << " name.connect [ip] [port] [alive]" << endl;
Console << " name.[un]subscribe topic" << endl;
Console << " name.publish topic [payload]" << endl;
Console << " name.view" << endl;
Console << " name.delete" << endl;
Console << endl;
Console << " list : list of free brokers (debug 1 advised)" << endl;
Console << " debug #" << endl;
Console << " list : get list of free brokers" << endl;
Console << " blink [Dx on_ms off_ms] : make pin blink" << endl;
Console << " ls / ip / reset" << endl;
Console << " set [name][value]" << endl;
Console << " ! repeat last command" << endl;
Console << endl;
Console << " echo [on|off] or strings" << endl;
Console << " every ms [command]; every list; every remove [nr|all]; every (on|off) [#]" << endl;
Console << " on {output}; off {output}" << endl;
Console << " $id : name of the client." << endl;
Console << " rnd[(min[,max])] random number." << endl;
Console << endl;
}
else
{
while(s[0]==' ') s.erase(0,1);
if (s.length())
Console << "Unknown command (" << s.c_str() << ")" << endl;
}
if (retval != MqttOk)
{
Console << "# MQTT ERROR " << retval << endl;
}
}
}
void loop()
{
auto ms=millis();
int8_t out=0;
int16_t blink_bits = blink;
uint8_t e=0;
for(auto& every: everies)
{
if (not every.active) continue;
if (every.ms && every.cmd.length() && ms > every.next)
{
string cmd(every.cmd);
eval(cmd);
every.next += every.ms;
if (ms > every.next and ms > every.underrun)
{
every.next += every.ms;
Console << yellow << "Underrun every #" << e << ", " << (ms - every.next) << "ms late" << endl;
every.underrun = ms+5000;
}
}
e++;
}
while(blink_bits)
{
if (blink_ms_on[out] and ms > blink_next[out])
{
if (blink_state[out])
{
blink_next[out] += blink_ms_on[out];
digitalWrite(out, LOW);
}
else
{
blink_next[out] += blink_ms_off[out];
digitalWrite(abs(out), HIGH);
}
blink_state[out] = not blink_state[out];
}
blink_bits >>=1;
out++;
}
#if defined(ESP9266)
MDNS.update();
#endif
for(auto it: brokers)
it.second->loop();
for(auto it: clients)
it.second->loop();
Console.loop();
}

View File

@@ -1,7 +1,7 @@
# 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
EXTRA_CXXFLAGS=-g3 -O0 -DTINY_MQTT_DEBUG
# Remove flto flag from EpoxyDuino (too many <optimized out>)
CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics

View File

@@ -1,10 +1,7 @@
# 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 -DTINY_MQTT_DEFAULT_ALIVE=1 -DEPOXY_TEST
# Remove flto flag from EpoxyDuino (too many <optimized out>)
CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
include ../Makefile.opts
APP_NAME := local-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP TinyConsole

View File

@@ -12,10 +12,11 @@
* Also, this will allow to mock and thus run Action on github
**/
using namespace std;
using string = TinyConsole::string;
MqttBroker broker(1883);
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
std::map<string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
const char* lastPayload;
size_t lastLength;
@@ -28,36 +29,27 @@ void onPublish(const MqttClient* srce, const Topic& topic, const char* payload,
lastLength = length;
}
test(local_not_connected_by_default)
{
MqttClient client;
assertEqual(client.connected(), false);
MqttBroker broker(1883);
assertEqual(broker.connected(), false);
}
test(local_client_should_unregister_when_destroyed)
{
MqttBroker broker(1883);
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
{
assertEqual(broker.clientsCount(), (size_t)0); // Ensure client is not yet connected
MqttClient client(&broker);
assertEqual(broker.localClientsCount(), (size_t)1); // Ensure client is now connected
assertEqual(broker.clientsCount(), (size_t)1); // Ensure client is now connected
}
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
}
test(local_client_alive)
{
EpoxyTest::set_millis(0);
MqttBroker broker(1883);
MqttClient client(&broker);
broker.loop();
assertEqual(broker.localClientsCount(), (size_t)1); // Ensure client is now connected
EpoxyTest::add_millis(TINY_MQTT_DEFAULT_ALIVE*1000/2);
broker.loop();
assertEqual(broker.localClientsCount(), (size_t)1); // Ensure client is still connected
EpoxyTest::add_seconds(TINY_MQTT_DEFAULT_ALIVE*5);
broker.loop();
assertEqual(broker.localClientsCount(), (size_t)1); // Ensure client is still connected
}
test(local_wildcard_subscribe)
test(local_client_do_not_disconnect_after_publishing_and_long_inactivity)
{
EpoxyTest::set_millis(0);
MqttBroker broker(1883);
@@ -68,58 +60,82 @@ test(local_wildcard_subscribe)
client.subscribe("#");
client.subscribe("test");
client.setCallback(onPublish);
assertEqual(broker.localClientsCount(), (size_t)2);
assertEqual(broker.clientsCount(), (size_t)2);
sender.publish("test", "value");
broker.loop();
assertEqual(published.size(), (size_t)1); // client has received something
}
test(local_client_do_not_disconnect_after_publishing)
{
EpoxyTest::set_millis(0);
MqttBroker broker(1883);
MqttClient client(&broker, "client");
MqttClient sender(&broker, "sender");
broker.loop();
client.subscribe("#");
client.subscribe("test");
client.setCallback(onPublish);
assertEqual(broker.localClientsCount(), (size_t)2);
sender.publish("test", "value");
broker.loop();
EpoxyTest::add_seconds(60);
EpoxyTest::add_seconds(600);
client.loop();
sender.loop();
broker.loop();
assertEqual(broker.localClientsCount(), (size_t)2);
sender.publish("test", "value");
broker.loop();
sender.loop();
broker.loop();
assertEqual(broker.clientsCount(), (size_t)2);
assertEqual(sender.connected(), true);
assertEqual(client.connected(), true);
assertEqual(published.size(), (size_t)1); // client has received something
}
#if 0
test(local_connect)
{
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient client(&broker);
assertTrue(client.connected());
assertEqual(broker.clientsCount(), (size_t)1);
}
test(local_publish_to_nowhere)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient publisher;
MqttError status = publisher.publish("a/b");
assertEqual(status, MqttError::MqttNowhereToSend);
}
test(local_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(local_publish_should_be_dispatched_to_local_clients)
{
published.clear();
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber_a("A");
MqttClient subscriber_a(&broker, "A");
subscriber_a.setCallback(onPublish);
subscriber_a.subscribe("a/b");
subscriber_a.subscribe("a/c");
MqttClient subscriber_b("B");
MqttClient subscriber_b(&broker, "B");
subscriber_b.setCallback(onPublish);
subscriber_b.subscribe("a/b");
MqttClient publisher;
MqttClient publisher(&broker);
publisher.publish("a/b");
publisher.publish("a/c");
@@ -133,13 +149,13 @@ test(local_publish_should_be_dispatched_to_local_clients)
test(local_unsubscribe)
{
published.clear();
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber;
MqttClient subscriber(&broker, "");
subscriber.setCallback(onPublish);
subscriber.subscribe("a/b");
MqttClient publisher;
MqttClient publisher(&broker);
publisher.publish("a/b");
subscriber.unsubscribe("a/b");
@@ -153,11 +169,11 @@ test(local_unsubscribe)
test(local_nocallback_when_destroyed)
{
published.clear();
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient publisher;
MqttClient publisher(&broker);
{
MqttClient subscriber;
MqttClient subscriber(&broker);
subscriber.setCallback(onPublish);
subscriber.subscribe("a/b");
publisher.publish("a/b");
@@ -167,7 +183,6 @@ test(local_nocallback_when_destroyed)
assertEqual(published.size(), (size_t)1); // Only one publish has been received
}
#endif
//----------------------------------------------------------------------------
// setup() and loop()

View File

@@ -1,10 +1,10 @@
# 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
include ../Makefile.opts
# Remove flto flag from EpoxyDuino (too many <optimized out>)
CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics -DEPOXY_TEST
# CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
APP_NAME := network-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP TinyConsole

View File

@@ -9,16 +9,6 @@
#include <string>
#include <iostream>
uint32_t getClientKeepAlive(MqttBroker& broker)
{
if (broker.getClients().size() == 1)
for (auto& it : broker.getClients())
return it->keepAlive();
return 9999;
}
/**
* TinyMqtt network unit tests.
*
@@ -26,6 +16,8 @@ uint32_t getClientKeepAlive(MqttBroker& broker)
* Checks with a local broker. Clients must connect to the local broker
**/
using string = TinyConsole::string;
// if ascii_pos = 0, no ascii dump, else ascii dump starts after column ascii_pos
std::string bufferToHexa(const uint8_t* buffer, size_t length, char sep = 0, size_t ascii_pos = 0)
{
@@ -88,7 +80,7 @@ String toString(const IPAddress& ip)
MqttBroker broker(1883);
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
std::map<string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
char* lastPayload = nullptr;
size_t lastLength;
@@ -152,46 +144,6 @@ test(suback)
assertEqual(MqttClient::counters[MqttMessage::Type::SubAck], 1);
}
test(network_client_alive)
{
const uint32_t keep_alive=1;
start_servers(2, true);
assertEqual(WiFi.status(), WL_CONNECTED);
EpoxyTest::set_millis(0); // Enter simulated time
MqttBroker broker(1883);
broker.begin();
IPAddress broker_ip = WiFi.localIP();
ESP8266WiFiClass::selectInstance(2);
MqttClient client;
client.connect(broker_ip.toString().c_str(), 1883, keep_alive);
broker.loop();
client.loop();
assertTrue(broker.clientsCount() == 1);
assertTrue(client.connected());
uint32_t ka = getClientKeepAlive(broker);
assertEqual(ka, keep_alive);
assertEqual(broker.clientsCount(), (size_t)1);
// All is going well if we call client.loop()
// The client is able to send PingReq to the broker
EpoxyTest::add_seconds(keep_alive);
client.loop();
broker.loop();
assertEqual(broker.clientsCount(), (size_t)1);
// Now simulate that the client is frozen for
// a too long time
EpoxyTest::add_seconds(TINY_MQTT_CLIENT_ALIVE_TOLERANCE*2);
broker.loop();
assertEqual(broker.clientsCount(), (size_t)0);
EpoxyTest::set_real_time();
}
test(network_client_keep_alive_high)
{
const uint32_t keep_alive=1000;
@@ -222,7 +174,7 @@ test(network_client_keep_alive_high)
uint32_t sz = broker.getClients().size();
assertEqual(sz , (uint32_t)1);
uint32_t ka = getClientKeepAlive(broker);
uint32_t ka = broker.getClients()[0]->keepAlive();
assertEqual(ka, keep_alive);
}
@@ -312,14 +264,14 @@ test(network_one_client_one_broker_hudge_publish_and_subscribe_through_network)
assertEqual((unsigned int)lastLength, (unsigned int)sent.size());
}
test(network_local_client_should_unregister_when_destroyed)
test(network_client_should_unregister_when_destroyed)
{
assertEqual(broker.clientsCount(), (size_t)0);
{
MqttClient client(&broker);
assertEqual(broker.localClientsCount(), (size_t)1);
assertEqual(broker.clientsCount(), (size_t)1);
}
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
}
@@ -332,13 +284,13 @@ test(network_connect)
MqttClient client(&broker);
assertTrue(client.connected());
assertEqual(broker.localClientsCount(), (size_t)1);
assertEqual(broker.clientsCount(), (size_t)1);
}
test(network_publish_should_be_dispatched)
{
published.clear();
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber(&broker);
subscriber.subscribe("a/b");
@@ -439,12 +391,11 @@ test(network_small_payload)
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 !";
const char* payload="This was decoded successfully !";
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"); // Note -> this does not send any byte .... (nowhere to send) TODO
subscriber.subscribe("a/b"); // Note -> this does not send any byte .... (nowhere to send)
MqttClient publisher(&broker);
publisher.publish("a/b", payload); // This publish is received
@@ -453,13 +404,25 @@ test(network_hudge_payload)
assertEqual(payload, lastPayload);
assertEqual(lastLength, strlen(payload));
assertEqual(strcmp(payload, lastPayload), 0);
std::cout << "payload : " << payload << std::endl;
std::cout << "received: " << lastPayload << std::endl;
}
test(disconnected_when_broker_is_deleted)
{
MqttBroker* broker = new MqttBroker(1883);
broker->begin();
MqttClient client;
client.connect(broker);
assertEqual(client.connected(), true);
client.publish("a", "b");
delete broker;
assertEqual(client.connected(), false);
}
test(connack)
{
const bool view = true;
const bool view = false;
NetworkObserver check(
[this](const WiFiClient*, const uint8_t* buffer, size_t length)
@@ -516,4 +479,5 @@ void loop() {
aunit::TestRunner::run();
if (Serial.available()) ESP.reset();
published.clear(); // Avoid crash in unit tests due to exit handlers
}

View File

@@ -1,10 +1,7 @@
# 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
include ../Makefile.opts
APP_NAME := nowifi-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP TinyConsole

View File

@@ -11,11 +11,11 @@
* Checks with a local broker. Clients must connect to the local broker
**/
using namespace std;
using string = TinyConsole::string;
MqttBroker broker(1883);
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
std::map<string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
char* lastPayload = nullptr;
size_t lastLength;
@@ -32,27 +32,27 @@ void onPublish(const MqttClient* srce, const Topic& topic, const char* payload,
test(nowifi_client_should_unregister_when_destroyed)
{
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
{
MqttClient client(&broker);
assertEqual(broker.localClientsCount(), (size_t)1);
assertEqual(broker.clientsCount(), (size_t)1);
}
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
}
test(nowifi_connect)
{
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient client(&broker);
assertTrue(client.connected());
assertEqual(broker.localClientsCount(), (size_t)1);
assertEqual(broker.clientsCount(), (size_t)1);
}
test(nowifi_publish_should_be_dispatched)
{
published.clear();
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber(&broker);
subscriber.subscribe("a/b");
@@ -72,7 +72,7 @@ test(nowifi_publish_should_be_dispatched)
test(nowifi_publish_should_be_dispatched_to_clients)
{
published.clear();
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber_a(&broker, "A");
subscriber_a.setCallback(onPublish);
@@ -97,7 +97,7 @@ test(nowifi_publish_should_be_dispatched_to_clients)
test(nowifi_subscribe_with_star_wildcard)
{
published.clear();
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber(&broker, "A");
subscriber.setCallback(onPublish);
@@ -118,7 +118,7 @@ test(nowifi_subscribe_with_star_wildcard)
test(nowifi_subscribe_with_plus_wildcard)
{
published.clear();
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber(&broker, "A");
subscriber.setCallback(onPublish);
@@ -139,7 +139,7 @@ test(nowifi_subscribe_with_plus_wildcard)
test(nowifi_should_not_receive_sys_msg)
{
published.clear();
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber(&broker, "A");
subscriber.setCallback(onPublish);
@@ -154,7 +154,7 @@ test(nowifi_should_not_receive_sys_msg)
test(nowifi_subscribe_with_mixed_wildcards)
{
published.clear();
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber(&broker, "A");
subscriber.setCallback(onPublish);
@@ -173,7 +173,7 @@ test(nowifi_subscribe_with_mixed_wildcards)
test(nowifi_unsubscribe_with_wildcards)
{
published.clear();
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber(&broker, "A");
subscriber.setCallback(onPublish);
@@ -195,7 +195,7 @@ test(nowifi_unsubscribe_with_wildcards)
test(nowifi_unsubscribe)
{
published.clear();
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber(&broker);
subscriber.setCallback(onPublish);
@@ -215,7 +215,7 @@ test(nowifi_unsubscribe)
test(nowifi_nocallback_when_destroyed)
{
published.clear();
assertEqual(broker.localClientsCount(), (size_t)0);
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient publisher(&broker);
@@ -279,4 +279,5 @@ void loop() {
aunit::TestRunner::run();
if (Serial.available()) ESP.reset();
published.clear(); // Avoid crash at exit handlers
}

View File

@@ -1,7 +1,7 @@
# 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
include ../Makefile.opts
APP_NAME := string-indexer-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsync TinyConsole

View File

@@ -9,7 +9,7 @@
*
**/
using namespace std;
using string = TinyConsole::string;
test(indexer_empty)
{
@@ -84,7 +84,7 @@ test(indexer_indexed_operator_eq)
test(indexer_get_string)
{
std::string sone("one");
string sone("one");
IndexedString one(sone);
assertTrue(sone==one.str());

View File

@@ -1,7 +1,7 @@
# 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
include ../Makefile.opts
APP_NAME := topic-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsync TinyConsole

View File

@@ -5,26 +5,22 @@
#include <map>
#include <iostream>
#define endl "\n"
/**
* TinyMqtt / StringIndexer unit tests.
*
**/
using namespace std;
bool testTopicMatch(const char* a, const char* b, bool expected)
{
Topic ta(a);
Topic tb(b);
bool match(ta.matches(tb));
cout << " " << ta.c_str() << ' ';
std::cout << " " << ta.c_str() << ' ';
if (match != expected)
cout << (expected ? " should match " : " should not match ");
std::cout << (expected ? " should match " : " should not match ");
else
cout << (expected ? " matches " : " unmatches ");
cout << tb.c_str() << endl;
std::cout << (expected ? " matches " : " unmatches ");
std::cout << tb.c_str() << std::endl;
return expected == match;
}