DEV: add sequencer and cli devices to utl
This commit is contained in:
@@ -0,0 +1,422 @@
|
||||
/*!
|
||||
* \file cli_device.cpp
|
||||
*
|
||||
* \copyright Copyright (C) 2020 Christos Choutouridis <christos@choutouridis.net>
|
||||
*
|
||||
* <dl class=\"section copyright\"><dt>License</dt><dd>
|
||||
* The MIT License (MIT)
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
* SOFTWARE.
|
||||
* </dd></dl>
|
||||
*
|
||||
*/
|
||||
#include <utl/dev/cli_device.h>
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
#include <utl/container/equeue.h>
|
||||
|
||||
#include <cstring>
|
||||
#include <utility>
|
||||
#include <type_traits>
|
||||
#ifndef WIN_TRHEADS
|
||||
#include <mutex>
|
||||
#include <thread>
|
||||
#else
|
||||
#include <mingw.thread.h>
|
||||
#include <mingw.mutex.h>
|
||||
#endif
|
||||
|
||||
namespace test_cli_device {
|
||||
using namespace utl;
|
||||
|
||||
// test settings
|
||||
constexpr size_t Size = 128;
|
||||
using data_type = char;
|
||||
|
||||
// cli_device implementer mock. We simulate a BG95 ATmodem for that purpose
|
||||
template<size_t N>
|
||||
class BG95 : public cli_device<BG95<N>, N> {
|
||||
using base_type = cli_device<BG95<N>, N>;
|
||||
using Queue = equeue<typename base_type::value_type, N, true>;
|
||||
|
||||
public:
|
||||
enum class event {
|
||||
MQTT_DISCONNECT, MQTT_RXDATA
|
||||
};
|
||||
// simulated modem operation
|
||||
private:
|
||||
struct cmd_pair {
|
||||
const char *cmd;
|
||||
const char *resp;
|
||||
};
|
||||
struct event_pair {
|
||||
event e;
|
||||
const char* resp;
|
||||
};
|
||||
|
||||
std::array<cmd_pair, 20> cmd_map = {{
|
||||
{"", ""},
|
||||
{"ERROR", "\r\nERROR\r\n"},
|
||||
{"ATE0\r\n", "\r\nATE0\r\nOK\r\n"},
|
||||
{"AT\r\n", "\r\nOK\r\n"},
|
||||
{"AT+QCFG=\"nwscanseq\"\r\n", "\r\n+QCFG: \"nwscanseq\",020301\r\n"},
|
||||
{"AT+QCFG=\"nwscanseq\",010302\r\n", "\r\nOK\r\n"},
|
||||
{"AT+CREG?\r\n", "\r\n+CREG: 0,5\r\n\r\nOK\r\n"},
|
||||
{"AT+CSQ\r\n", "\r\n+CSQ: 19,99\r\n\r\nOK\r\n"},
|
||||
{"AT+QNWINFO\r\n", "\r\n+QNWINFO: \"EDGE\",\"20201\",\"GSM 1800\",865\r\n\r\nOK\r\n"},
|
||||
// Files
|
||||
{"AT+QFLST\r\n", "\r\n+QFLST: \"cacert.pem\",1220\r\n+QFLST: \"security/\",2\r\nOK\r\n"},
|
||||
// MQTT config
|
||||
{"AT+QSSLCFG=\"ignorelocaltime\",2,1\r\n", "\r\nOK\r\n"},
|
||||
{"AT+QSSLCFG=\"seclevel\",2,1\r\n", "\r\nOK\r\n"},
|
||||
{"AT+QSSLCFG=\"sslversion\",2,4\r\n", "\r\nOK\r\n"},
|
||||
{"AT+QSSLCFG=\"ciphersuite\",2\r\n", "\r\n+QSSLCFG: \"ciphersuite\",2,0XFFFF\r\n\r\nOK\r\n"},
|
||||
{"AT+QMTCFG=\"ssl\",0,1,2\r\n", "\r\nOK\r\n"},
|
||||
{"AT+QMTCFG=\"keepalive\",0,3600\r\n", "\r\nOK\r\n"},
|
||||
// MQTT
|
||||
{"AT+QMTOPEN=0,\"server.com\",8883\r\n", "\r\nOK\r\n\r\n+QMTOPEN: 0,0\r\n"},
|
||||
{"AT+QMTCONN=0,\"myID\",\"user\",\"pass\"\r\n", "\r\nOK\r\n\r\n+QMTCONN: 0,0,0\r\n"},
|
||||
{"AT+QMTSUB=0,1,\"/path/topic1\",2\r\n", "\r\nOK\r\n\r\n+QMTSUB: 0,1,0,2\r\n"},
|
||||
{"AT+QMTPUB=0,0,0,0,\"/path/topic2\",9\r\n", "\r\n> \r\nOK\r\n\r\n+QMTPUB: 0,0,0\r\n"},
|
||||
}};
|
||||
std::array<event_pair, 2> event_map {{
|
||||
{event::MQTT_DISCONNECT, "\r\n+QMTSTAT: 0,1\r\n"},
|
||||
{event::MQTT_RXDATA, "\r\n+QMTRECV: 0,1,\"/path/topic1\",\"BR: hello to all of my subscribers\""}
|
||||
}};
|
||||
const char* cmd_responce (const char* cmd) {
|
||||
if (cmd != nullptr) {
|
||||
for (auto& it : cmd_map) {
|
||||
if (!std::strcmp(it.cmd, cmd))
|
||||
return it.resp;
|
||||
}
|
||||
}
|
||||
return cmd_map[1].resp;
|
||||
}
|
||||
const char* event_responce (const event e) {
|
||||
for (auto& it : event_map) {
|
||||
if (e == it.e)
|
||||
return it.resp;
|
||||
}
|
||||
return nullptr; // non reachable
|
||||
}
|
||||
|
||||
// data
|
||||
Queue RxQ{};
|
||||
std::atomic<size_t> lines{};
|
||||
clock_t t=0;
|
||||
|
||||
public:
|
||||
// cli_device driver requirements
|
||||
BG95() noexcept :
|
||||
RxQ(Queue::data_match::MATCH_PUSH, base_type::delimiter, [&](){
|
||||
lines.fetch_add(1, std::memory_order_acq_rel);
|
||||
}), lines(0) { }
|
||||
|
||||
size_t get(char* data, bool wait =false) {
|
||||
do {
|
||||
if (lines.load(std::memory_order_acquire)) {
|
||||
size_t n =0;
|
||||
do{
|
||||
*data << RxQ;
|
||||
++n;
|
||||
} while (*data++ != base_type::delimiter);
|
||||
lines.fetch_sub(1, std::memory_order_acq_rel);
|
||||
return n;
|
||||
}
|
||||
} while (wait);
|
||||
return 0;
|
||||
}
|
||||
size_t contents(char* data) {
|
||||
char* nullpos = std::copy(RxQ.begin(), RxQ.end(), data);
|
||||
*nullpos =0;
|
||||
return nullpos - data;
|
||||
}
|
||||
size_t put (const char* data, size_t n) {
|
||||
const char* reply = cmd_responce (data);
|
||||
while (*reply)
|
||||
RxQ << *reply++;
|
||||
return n;
|
||||
}
|
||||
|
||||
clock_t clock() noexcept { return ++t; }
|
||||
void clear_clock() noexcept { t=0; }
|
||||
|
||||
// extra helper for testing purposes
|
||||
void async (event e) {
|
||||
const char* reply =event_responce (e);
|
||||
while (*reply)
|
||||
RxQ << *reply++;
|
||||
}
|
||||
};
|
||||
|
||||
// Behavior flag
|
||||
bool handler_flag = false;
|
||||
void handler (const char* data, size_t n) {
|
||||
(void)*data;
|
||||
(void)n;
|
||||
handler_flag = true;
|
||||
}
|
||||
void clear_flag () {
|
||||
handler_flag = false;
|
||||
}
|
||||
|
||||
TEST(Tcli_device, traits) {
|
||||
EXPECT_EQ ( std::is_default_constructible<BG95<Size>>::value, true);
|
||||
EXPECT_EQ ( std::is_nothrow_default_constructible<BG95<Size>>::value, true);
|
||||
EXPECT_EQ (!std::is_copy_constructible<BG95<Size>>::value, true);
|
||||
EXPECT_EQ (!std::is_copy_assignable<BG95<Size>>::value, true);
|
||||
|
||||
EXPECT_EQ ((std::is_same_v<BG95<Size>::value_type, data_type>), true);
|
||||
EXPECT_EQ ((std::is_same_v<BG95<Size>::pointer_type, data_type*>), true);
|
||||
EXPECT_EQ ((std::is_same_v<BG95<Size>::size_type, size_t>), true);
|
||||
EXPECT_EQ ((std::is_same_v<BG95<Size>::string_view, std::basic_string_view<data_type>>), true);
|
||||
|
||||
}
|
||||
|
||||
/*
|
||||
* Test inetd in non blocking mode
|
||||
*/
|
||||
TEST(Tcli_device, txrx_inetd) {
|
||||
BG95<Size> modem;
|
||||
char buffer[Size];
|
||||
size_t s =0;
|
||||
|
||||
const BG95<Size>::inetd_handlers<2> async = {{
|
||||
{"+QMTSTAT:", BG95<Size>::starts_with, handler},
|
||||
{"+QMTRECV", BG95<Size>::contains, handler},
|
||||
}};
|
||||
|
||||
s = modem.transmit("", std::strlen(""));
|
||||
EXPECT_EQ (s, 0UL);
|
||||
s = modem.transmit("");
|
||||
EXPECT_EQ (s, 0UL);
|
||||
s = modem.transmit(nullptr);
|
||||
EXPECT_EQ (s, 0UL);
|
||||
|
||||
clear_flag();
|
||||
modem.inetd(false, &async);
|
||||
EXPECT_EQ (handler_flag, false);
|
||||
modem.async(BG95<Size>::event::MQTT_DISCONNECT);
|
||||
modem.inetd(false, &async); // parse "\r\n"
|
||||
EXPECT_EQ (handler_flag, false);
|
||||
modem.inetd(false, &async); // parse "+QMT*\r\n" and dispatch to handler()
|
||||
EXPECT_EQ (handler_flag, true);
|
||||
clear_flag(); // nothing to parse
|
||||
modem.inetd(false, &async);
|
||||
modem.inetd(false, &async);
|
||||
modem.inetd(false, &async);
|
||||
EXPECT_EQ (handler_flag, false);
|
||||
EXPECT_NE (modem.receive(buffer), 0UL); // "\r\n" in buffer
|
||||
EXPECT_EQ (std::strcmp(buffer, "\r\n"), 0);
|
||||
|
||||
clear_flag();
|
||||
modem.inetd(false, &async);
|
||||
EXPECT_EQ (handler_flag, false);
|
||||
modem.transmit("AT+CSQ\r\n", 8);
|
||||
EXPECT_EQ (modem.receive(buffer), 0UL);
|
||||
modem.inetd(false, &async); // parse "\r\n"
|
||||
EXPECT_NE (modem.receive(buffer), 0UL);
|
||||
EXPECT_EQ (std::strcmp(buffer, "\r\n"), 0);
|
||||
modem.inetd(false, &async); // parse "+CSQ: 19,99\r\n"
|
||||
EXPECT_NE (modem.receive(buffer), 0UL);
|
||||
EXPECT_EQ (std::strcmp(buffer, "+CSQ: 19,99\r\n"), 0);
|
||||
modem.inetd(false, &async); // parse "\r\n"
|
||||
EXPECT_NE (modem.receive(buffer), 0UL);
|
||||
EXPECT_EQ (std::strcmp(buffer, "\r\n"), 0);
|
||||
modem.inetd(false, &async); // parse "OK\r\n"
|
||||
EXPECT_NE (modem.receive(buffer), 0UL);
|
||||
EXPECT_EQ (std::strcmp(buffer, "OK\r\n"), 0);
|
||||
modem.inetd(false, &async); // nothing to parse
|
||||
modem.inetd(false, &async);
|
||||
modem.inetd(false, &async);
|
||||
EXPECT_EQ (modem.receive(buffer), 0UL);
|
||||
}
|
||||
|
||||
TEST(Tcli_device, run) {
|
||||
BG95<Size> modem;
|
||||
|
||||
using Control = BG95<Size>::control_t;
|
||||
|
||||
const BG95<Size>::script_t<4> script = {{
|
||||
{Control::NOP, "", BG95<Size>::nil, BG95<Size>::nil, BG95<Size>::go_to<1>, 100000},
|
||||
{Control::SEND, "ATE0\r\n", BG95<Size>::nil, BG95<Size>::nil, BG95<Size>::next, 0},
|
||||
{Control::EXPECT, "OK\r\n", BG95<Size>::ends_with, BG95<Size>::nil, BG95<Size>::exit_ok, 100000},
|
||||
{Control::OR_EXPECT,"ERROR", BG95<Size>::contains, BG95<Size>::nil, BG95<Size>::exit_error, 0}
|
||||
}};
|
||||
|
||||
std::mutex m;
|
||||
m.lock();
|
||||
std::thread th1 ([&](){
|
||||
do
|
||||
modem.inetd(false);
|
||||
while (!m.try_lock());
|
||||
m.unlock();
|
||||
});
|
||||
EXPECT_EQ (modem.run(script), BG95<Size>::exit_ok.value);
|
||||
m.unlock(); // stop and join inetd
|
||||
th1.join();
|
||||
}
|
||||
|
||||
TEST(Tcli_device, clear_size) {
|
||||
BG95<Size> modem;
|
||||
char buffer[Size];
|
||||
|
||||
modem.clear();
|
||||
EXPECT_EQ (modem.size(), 0UL);
|
||||
EXPECT_EQ (modem.receive(buffer), 0UL);
|
||||
|
||||
modem.transmit("abcd", 4);
|
||||
modem.inetd(false);
|
||||
modem.inetd(false);
|
||||
EXPECT_NE (modem.size(), 0UL);
|
||||
modem.clear();
|
||||
EXPECT_EQ (modem.size(), 0UL);
|
||||
|
||||
}
|
||||
|
||||
TEST(Tcli_device, command_non_extraction) {
|
||||
BG95<Size> modem;
|
||||
char buffer[Size];
|
||||
|
||||
std::mutex m;
|
||||
m.lock();
|
||||
std::thread th1 ([&](){
|
||||
do
|
||||
modem.inetd(false);
|
||||
while (!m.try_lock());
|
||||
m.unlock();
|
||||
});
|
||||
|
||||
auto run_receive = [&](size_t times) -> size_t {
|
||||
size_t s =0;
|
||||
for (size_t i=0 ; i<times ; ++i)
|
||||
s += modem.receive(buffer);
|
||||
return s;
|
||||
};
|
||||
|
||||
EXPECT_EQ (modem.command("", "", 0), true); // returns: ""
|
||||
EXPECT_EQ (modem.size(), 0UL);
|
||||
EXPECT_EQ (run_receive(100000), 0UL);
|
||||
|
||||
EXPECT_EQ (modem.command("", "abcd", 100000), false);// returns: ""
|
||||
EXPECT_EQ (modem.size(), 0UL);
|
||||
EXPECT_EQ (run_receive(100000), 0UL);
|
||||
|
||||
EXPECT_EQ (modem.command("abcd", "", 0), true); // returns: "\r\nERROR\r\n"
|
||||
EXPECT_GT (run_receive(100000), 0UL);
|
||||
|
||||
EXPECT_EQ (modem.command("AT\r\n", "Something else", 100000), false);// returns: "\r\nOK\r\n"
|
||||
EXPECT_GT (run_receive(100000), 0UL);
|
||||
|
||||
EXPECT_EQ (modem.command("AT\r\n", "\r\nOK\r\n", 100000), true); // returns: "\r\nOK\r\n"
|
||||
EXPECT_EQ (modem.size(), 0UL);
|
||||
EXPECT_EQ (run_receive(100000), 0UL);
|
||||
|
||||
EXPECT_EQ (modem.command("AT\r\n", "%OK\r\n", 100000), true); // returns: "\r\nOK\r\n"
|
||||
EXPECT_EQ (modem.size(), 0UL);
|
||||
EXPECT_EQ (run_receive(100000), 0UL);
|
||||
|
||||
// returns: "\r\n+CREG: 0,5\r\n\r\nOK\r\n
|
||||
EXPECT_EQ (modem.command<BG95<Size>::flush>("AT+CREG?\r\n", "%OK\r\n", 0), false);
|
||||
EXPECT_GT (run_receive(100000), 0UL);
|
||||
|
||||
// returns: "\r\n+CREG: 0,5\r\n\r\nOK\r\n
|
||||
EXPECT_EQ (modem.command<BG95<Size>::flush>("AT+CREG?\r\n", "%%%OK\r\n", 0), true);
|
||||
EXPECT_EQ (modem.size(), 0UL);
|
||||
EXPECT_EQ (run_receive(100000), 0UL);
|
||||
|
||||
// returns: "\r\n+CREG: 0,5\r\n\r\nOK\r\n
|
||||
EXPECT_EQ (modem.command<BG95<Size>::flush>("AT+CREG?\r\n", "%", 0), true);
|
||||
EXPECT_GT (run_receive(100000), 0UL);
|
||||
|
||||
EXPECT_EQ (modem.command<BG95<Size>::flush>("AT\r\n", "%%", 0), true); // returns: "\r\nOK\r\n"
|
||||
EXPECT_EQ (modem.size(), 0UL);
|
||||
EXPECT_EQ (run_receive(100000), 0UL);
|
||||
|
||||
EXPECT_EQ (modem.command<BG95<Size>::flush>("AT\r\n", "%%%", 10000), false); // returns: "\r\nOK\r\n"
|
||||
EXPECT_EQ (modem.size(), 0UL);
|
||||
EXPECT_EQ (run_receive(100000), 0UL);
|
||||
|
||||
// returns: "\r\n+CREG: 0,5\r\n\r\nOK\r\n
|
||||
EXPECT_EQ (modem.command<modem.flush>("AT+CREG?\r\n", "", 0), true);
|
||||
EXPECT_EQ (modem.command<modem.keep>("", "%", 0), true);
|
||||
EXPECT_EQ (modem.command<modem.keep>("", "%%", 0), true);
|
||||
EXPECT_EQ (modem.command<modem.keep>("", "%", 0), true);
|
||||
EXPECT_EQ (modem.command<modem.keep>("", "%", 10000), false);
|
||||
EXPECT_EQ (modem.size(), 0UL);
|
||||
EXPECT_EQ (run_receive(100000), 0UL);
|
||||
|
||||
m.unlock(); // stop and join inetd
|
||||
th1.join();
|
||||
}
|
||||
|
||||
TEST(Tcli_device, command_extraction) {
|
||||
BG95<Size> modem;
|
||||
char buffer[Size];
|
||||
|
||||
std::mutex m;
|
||||
m.lock();
|
||||
std::thread th1 ([&](){
|
||||
do
|
||||
modem.inetd(false);
|
||||
while (!m.try_lock());
|
||||
m.unlock();
|
||||
});
|
||||
|
||||
auto run_receive = [&](size_t times) -> size_t {
|
||||
size_t s =0;
|
||||
for (size_t i=0 ; i<times ; ++i)
|
||||
s += modem.receive(buffer);
|
||||
return s;
|
||||
};
|
||||
|
||||
int status1, status2;
|
||||
EXPECT_EQ (modem.command("AT+CREG?\r\n", "\r\n+CREG: 0,%\r\n\r\nOK\r\n", 100000, &status1), true);
|
||||
EXPECT_EQ (status1, 5);
|
||||
EXPECT_EQ (modem.command("AT+CREG?\r\n", "\r\n+CREG: %,%\r\n\r\nOK\r\n", 100000, &status1, &status2), true);
|
||||
EXPECT_EQ (status1, 0);
|
||||
EXPECT_EQ (status2, 5);
|
||||
|
||||
char substr1[32], substr2[32];
|
||||
EXPECT_EQ (modem.command("AT+CREG?\r\n", "\r\n%\r\n\r\n%\r\n", 100000, substr1, substr2), true);
|
||||
EXPECT_EQ (std::strcmp("+CREG: 0,5", substr1), 0);
|
||||
EXPECT_EQ (std::strcmp("OK", substr2), 0);
|
||||
|
||||
// returns: "\r\n+CREG: 0,5\r\n\r\nOK\r\n
|
||||
EXPECT_EQ (modem.command<modem.flush>("AT+CREG?\r\n", "", 100000), true);
|
||||
EXPECT_EQ (modem.command<modem.keep>("", "%", 100000, substr1), true);
|
||||
EXPECT_EQ (std::strcmp("\r\n", substr1), 0);
|
||||
|
||||
EXPECT_EQ (modem.command<modem.keep>("", "%%", 100000, substr1, substr2), true);
|
||||
EXPECT_EQ (std::strcmp("+CREG: 0,5\r\n", substr1), 0);
|
||||
EXPECT_EQ (std::strcmp("\r\n", substr2), 0);
|
||||
|
||||
EXPECT_EQ (modem.command<modem.keep>("", "%", 100000, substr1), true);
|
||||
EXPECT_EQ (std::strcmp("OK\r\n", substr1), 0);
|
||||
|
||||
EXPECT_EQ (modem.command<modem.keep>("", "%", 10000), false);
|
||||
|
||||
EXPECT_EQ (modem.size(), 0UL);
|
||||
EXPECT_EQ (run_receive(100000), 0UL);
|
||||
|
||||
m.unlock(); // stop and join inetd
|
||||
th1.join();
|
||||
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,451 @@
|
||||
/*!
|
||||
* \file sequencer.cpp
|
||||
*
|
||||
* \copyright Copyright (C) 2020 Christos Choutouridis <christos@choutouridis.net>
|
||||
*
|
||||
* <dl class=\"section copyright\"><dt>License</dt><dd>
|
||||
* The MIT License (MIT)
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
* SOFTWARE.
|
||||
* </dd></dl>
|
||||
*
|
||||
*/
|
||||
#include <utl/dev/sequencer.h>
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
#include <type_traits>
|
||||
#include <cstring>
|
||||
#include <ctime>
|
||||
|
||||
namespace test_sequencer {
|
||||
using namespace utl;
|
||||
|
||||
// test settings
|
||||
using data_type = char;
|
||||
constexpr size_t size = 64;
|
||||
|
||||
// Sequencer implementer mock
|
||||
class Seq : public sequencer<Seq, data_type, size> {
|
||||
static constexpr int NrCommands =5;
|
||||
static constexpr int NoCommand =-1;
|
||||
|
||||
std::array<const char*, NrCommands> command = {
|
||||
"cmd1",
|
||||
"cmd2\n",
|
||||
"cmd3\r\n",
|
||||
"cmd4\n\r",
|
||||
"cmd5\n",
|
||||
};
|
||||
std::array<const char*, NrCommands> reply {
|
||||
"reply1",
|
||||
"reply2\n",
|
||||
"reply3\n text \r text text\n",
|
||||
"reply4\n text\n text \r text\r\n",
|
||||
"reply5\n",
|
||||
};
|
||||
int cmd =NoCommand;
|
||||
clock_t t =0;
|
||||
|
||||
public:
|
||||
size_t get(char* data) {
|
||||
static int ans = 0;
|
||||
if ((++ans % 3) == 0)
|
||||
return 0;
|
||||
|
||||
if (cmd == NoCommand) {
|
||||
std::strcpy(data, "ERROR\n");
|
||||
return 6;
|
||||
} else {
|
||||
std::strcpy(data, reply[cmd]);
|
||||
size_t s = std::strlen(reply[cmd]);
|
||||
cmd =NoCommand;
|
||||
return s;
|
||||
}
|
||||
}
|
||||
size_t contents (char* data) {
|
||||
if (cmd == NoCommand) {
|
||||
std::strcpy(data, "");
|
||||
return 0;
|
||||
} else {
|
||||
std::strcpy(data, reply[cmd]);
|
||||
return std::strlen(reply[cmd]);
|
||||
}
|
||||
}
|
||||
size_t put (const char* data, size_t n) {
|
||||
for (size_t i =0 ; i<NrCommands ; ++i) {
|
||||
if (!std::strcmp(data, command[i])) {
|
||||
cmd =i;
|
||||
return n;
|
||||
}
|
||||
}
|
||||
cmd =NoCommand;
|
||||
return n;
|
||||
}
|
||||
clock_t clock() { return ++t; }
|
||||
void clear_clock() { t =0; }
|
||||
};
|
||||
|
||||
/*
|
||||
* Test sequencer object
|
||||
*/
|
||||
TEST (Tsequencer, traits) {
|
||||
EXPECT_EQ ( std::is_default_constructible<Seq>::value, true);
|
||||
EXPECT_EQ ( std::is_nothrow_default_constructible<Seq>::value, true);
|
||||
EXPECT_EQ (!std::is_copy_constructible<Seq>::value, true);
|
||||
EXPECT_EQ (!std::is_copy_assignable<Seq>::value, true);
|
||||
|
||||
EXPECT_EQ ((std::is_same_v<Seq::value_type, data_type>), true);
|
||||
EXPECT_EQ ((std::is_same_v<Seq::pointer_type, data_type*>), true);
|
||||
EXPECT_EQ ((std::is_same_v<Seq::size_type, size_t>), true);
|
||||
EXPECT_EQ ((std::is_same_v<Seq::string_view, std::basic_string_view<data_type>>), true);
|
||||
|
||||
Seq s;
|
||||
EXPECT_EQ (s.size(), size);
|
||||
}
|
||||
|
||||
TEST (Tsequencer, predicates) {
|
||||
EXPECT_EQ ((std::is_invocable_r<bool, decltype(Seq::equals), Seq::string_view, Seq::string_view>::value), true);
|
||||
EXPECT_EQ ((std::is_invocable_r<bool, decltype(Seq::starts_with), Seq::string_view, Seq::string_view>::value), true);
|
||||
EXPECT_EQ ((std::is_invocable_r<bool, decltype(Seq::ends_with), Seq::string_view, Seq::string_view>::value), true);
|
||||
EXPECT_EQ ((std::is_invocable_r<bool, decltype(Seq::contains), Seq::string_view, Seq::string_view>::value), true);
|
||||
EXPECT_EQ ((std::is_invocable_r<bool, decltype(Seq::always_true), Seq::string_view, Seq::string_view>::value), true);
|
||||
EXPECT_EQ ((std::is_invocable_r<bool, decltype(Seq::always_false), Seq::string_view, Seq::string_view>::value), true);
|
||||
|
||||
EXPECT_EQ (Seq::nil, nullptr);
|
||||
}
|
||||
|
||||
TEST (Tsequencer, actions) {
|
||||
EXPECT_EQ ( std::is_default_constructible<Seq::action_t>::value, true);
|
||||
EXPECT_EQ ( std::is_nothrow_default_constructible<Seq::action_t>::value, true);
|
||||
EXPECT_EQ ( std::is_copy_constructible<Seq::action_t>::value, true);
|
||||
EXPECT_EQ ( std::is_copy_assignable<Seq::action_t>::value, true);
|
||||
|
||||
EXPECT_EQ ((std::is_same_v<const Seq::action_t, decltype(Seq::no_action)>), true);
|
||||
EXPECT_EQ ((std::is_same_v<const Seq::action_t, decltype(Seq::next)>), true);
|
||||
EXPECT_EQ ((std::is_same_v<const Seq::action_t, decltype(Seq::exit_ok)>), true);
|
||||
EXPECT_EQ ((std::is_same_v<const Seq::action_t, decltype(Seq::exit_error)>), true);
|
||||
|
||||
EXPECT_EQ ((std::is_same_v<const Seq::action_t, decltype(Seq::go_to<0>)>), true);
|
||||
EXPECT_EQ ((std::is_same_v<const Seq::action_t, decltype(Seq::exit<0>)>), true);
|
||||
}
|
||||
|
||||
bool handler_flag = false;
|
||||
const char* text = "abc";
|
||||
|
||||
//static bool check_handle (const str_view_t buffer, const str_view_t token, match_ft match, handler_ft handle)
|
||||
TEST(Tsequencer, check_handle) {
|
||||
Seq s;
|
||||
// foo (5);
|
||||
// bar (5);
|
||||
using str_t = Seq::string_view;
|
||||
using val_t = Seq::value_type;
|
||||
|
||||
auto match = [](const str_t x, const str_t y) ->bool { (void)x; (void)y; return true; };
|
||||
auto no_match = [](const str_t x, const str_t y) ->bool { (void)x; (void)y; return false; };
|
||||
auto check_match = [] (const str_t x, const str_t y) ->bool {
|
||||
return x == y;
|
||||
};
|
||||
auto handler = [](const val_t* v, size_t s){ (void)*v; (void)s; handler_flag = true; };
|
||||
auto set_if_abc = [](const val_t* v, size_t s){
|
||||
(void)*v; (void)s;
|
||||
handler_flag = (str_t(v, s) == "abc");
|
||||
};
|
||||
|
||||
EXPECT_EQ (s.check_handle("", "", nullptr, nullptr), false);
|
||||
EXPECT_EQ (s.check_handle("", "", no_match, nullptr), false);
|
||||
EXPECT_EQ (s.check_handle("", "", match, nullptr), false);
|
||||
|
||||
handler_flag = false;
|
||||
EXPECT_EQ (s.check_handle("", "", no_match, handler), false);
|
||||
EXPECT_EQ (handler_flag, false);
|
||||
|
||||
handler_flag = false;
|
||||
EXPECT_EQ (s.check_handle("", "", match, handler), true);
|
||||
EXPECT_EQ (handler_flag, true);
|
||||
|
||||
handler_flag = false;
|
||||
EXPECT_EQ (s.check_handle("abcd", "abc", check_match, set_if_abc), false);
|
||||
EXPECT_EQ (handler_flag, false);
|
||||
|
||||
handler_flag = false;
|
||||
EXPECT_EQ (s.check_handle("abc", "abc", check_match, set_if_abc), true);
|
||||
EXPECT_EQ (handler_flag, true);
|
||||
|
||||
handler_flag = false;
|
||||
EXPECT_EQ (s.check_handle("abc", "abcd", check_match, set_if_abc), false);
|
||||
EXPECT_EQ (handler_flag, false);
|
||||
|
||||
}
|
||||
|
||||
TEST(Tsequencer, run_nop_and_exits) {
|
||||
Seq s;
|
||||
const Seq::script_t<1> script1 = {{
|
||||
{Seq::control_t::NOP, "", Seq::nil, Seq::nil, Seq::exit_ok, 1000}
|
||||
}};
|
||||
s.clear_clock();
|
||||
EXPECT_EQ (s.run(script1), Seq::exit_ok.value);
|
||||
EXPECT_GE (s.clock(), (clock_t)1000);
|
||||
|
||||
const Seq::script_t<1> script2 = {{
|
||||
{Seq::control_t::NOP, "", Seq::nil, Seq::nil, Seq::exit_error, 1000}
|
||||
}};
|
||||
s.clear_clock();
|
||||
EXPECT_EQ (s.run(script2), Seq::exit_error.value);
|
||||
EXPECT_GE (s.clock(), (clock_t)1000);
|
||||
|
||||
const Seq::script_t<3> script3 = {{
|
||||
{Seq::control_t::NOP, "", Seq::nil, Seq::nil, Seq::next, 1000},
|
||||
{Seq::control_t::NOP, "", Seq::nil, Seq::nil, Seq::next, 1000},
|
||||
{Seq::control_t::NOP, "", Seq::nil, Seq::nil, Seq::exit_ok, 1000}
|
||||
}};
|
||||
s.clear_clock();
|
||||
EXPECT_EQ (s.run(script3), Seq::exit_ok.value);
|
||||
EXPECT_GE (s.clock(), (clock_t)3000);
|
||||
}
|
||||
|
||||
TEST(Tsequencer, run_send) {
|
||||
Seq s;
|
||||
|
||||
auto send_wrapper = [](const data_type* d, size_t s){
|
||||
(void)*d; (void)s; handler_flag = true;
|
||||
};
|
||||
auto send_chk_text = [](const data_type* d, size_t s){
|
||||
handler_flag = (Seq::string_view(d,s) == Seq::string_view(text));
|
||||
};
|
||||
|
||||
const Seq::script_t<2> script1 = {{
|
||||
{Seq::control_t::SEND, "", Seq::nil, Seq::nil, Seq::next, 0},
|
||||
{Seq::control_t::SEND, "", Seq::nil, send_wrapper, Seq::exit_ok, 0}
|
||||
}};
|
||||
handler_flag =false;
|
||||
EXPECT_EQ (s.run(script1), Seq::exit_ok.value);
|
||||
EXPECT_EQ (handler_flag, true);
|
||||
|
||||
|
||||
const Seq::script_t<1> script2 = {{
|
||||
{Seq::control_t::SEND, "abcd", Seq::nil, send_chk_text, Seq::exit_ok, 0}
|
||||
}};
|
||||
handler_flag =false;
|
||||
EXPECT_EQ (s.run(script2), Seq::exit_ok.value);
|
||||
EXPECT_EQ (handler_flag, false);
|
||||
|
||||
const Seq::script_t<2> script3 = {{
|
||||
{Seq::control_t::SEND, text, Seq::nil, send_chk_text, Seq::exit_ok, 0}
|
||||
}};
|
||||
handler_flag =false;
|
||||
EXPECT_EQ (s.run(script3), Seq::exit_ok.value);
|
||||
EXPECT_EQ (handler_flag, true);
|
||||
}
|
||||
|
||||
TEST(Tsequencer, run_expect) {
|
||||
Seq s;
|
||||
|
||||
const Seq::script_t<7> script = {{
|
||||
{Seq::control_t::EXPECT, "reply1", Seq::equals, Seq::nil, Seq::exit<1UL>, 1000},
|
||||
{Seq::control_t::OR_EXPECT, "reply2", Seq::starts_with, Seq::nil, Seq::exit<2UL>, 0},
|
||||
{Seq::control_t::OR_EXPECT, "reply3", Seq::starts_with, Seq::nil, Seq::exit<3UL>, 0},
|
||||
{Seq::control_t::OR_EXPECT, "reply4\n", Seq::starts_with, Seq::nil, Seq::exit<4UL>, 0},
|
||||
{Seq::control_t::OR_EXPECT, "reply5", Seq::starts_with, Seq::nil, Seq::exit<5UL>, 0},
|
||||
{Seq::control_t::OR_EXPECT, "ERROR", Seq::contains, Seq::nil, Seq::exit<6UL>, 0},
|
||||
{Seq::control_t::NOP, "", Seq::nil, Seq::nil, Seq::exit_error, 1000}
|
||||
}};
|
||||
|
||||
s.clear_clock();
|
||||
s.put("cmd1", std::strlen("cmd1"));
|
||||
EXPECT_EQ (s.run(script), 1UL);
|
||||
EXPECT_LT (s.clock(), (clock_t)1000);
|
||||
|
||||
s.clear_clock();
|
||||
s.put("cmd2\n", std::strlen("cmd2\n"));
|
||||
EXPECT_EQ (s.run(script), 2UL);
|
||||
EXPECT_LT (s.clock(), (clock_t)1000);
|
||||
|
||||
s.clear_clock();
|
||||
s.put("cmd3\r\n", std::strlen("cmd3\r\n"));
|
||||
EXPECT_EQ (s.run(script), 3UL);
|
||||
EXPECT_LT (s.clock(), (clock_t)1000);
|
||||
|
||||
s.clear_clock();
|
||||
s.put("cmd4\n\r", std::strlen("cmd4\n\r"));
|
||||
EXPECT_EQ (s.run(script), 4UL);
|
||||
EXPECT_LT (s.clock(), (clock_t)1000);
|
||||
|
||||
s.clear_clock();
|
||||
s.put("cmd5\n", std::strlen("cmd5\n"));
|
||||
EXPECT_EQ (s.run(script), 5UL);
|
||||
EXPECT_LT (s.clock(), (clock_t)1000);
|
||||
|
||||
s.clear_clock();
|
||||
s.put("cmd", std::strlen("cmd"));
|
||||
EXPECT_EQ (s.run(script), 6UL);
|
||||
EXPECT_LT (s.clock(), (clock_t)1000);
|
||||
}
|
||||
|
||||
TEST(Tsequencer, run_detect) {
|
||||
Seq s;
|
||||
|
||||
const Seq::script_t<7> script = {{
|
||||
{Seq::control_t::DETECT, "reply1", Seq::equals, Seq::nil, Seq::exit<1UL>, 1000},
|
||||
{Seq::control_t::OR_DETECT, "reply2", Seq::starts_with, Seq::nil, Seq::exit<2UL>, 0},
|
||||
{Seq::control_t::OR_DETECT, "reply3", Seq::starts_with, Seq::nil, Seq::exit<3UL>, 0},
|
||||
{Seq::control_t::OR_DETECT, "reply4\n", Seq::starts_with, Seq::nil, Seq::exit<4UL>, 0},
|
||||
{Seq::control_t::OR_DETECT, "reply5", Seq::starts_with, Seq::nil, Seq::exit<5UL>, 0},
|
||||
{Seq::control_t::OR_DETECT, "ERROR", Seq::contains, Seq::nil, Seq::exit<6UL>, 0},
|
||||
{Seq::control_t::NOP, "", Seq::nil, Seq::nil, Seq::exit_ok, 1000}
|
||||
}};
|
||||
|
||||
s.clear_clock();
|
||||
s.put("cmd1", std::strlen("cmd1"));
|
||||
EXPECT_EQ (s.run(script), 1UL);
|
||||
EXPECT_LT (s.clock(), (clock_t)1000);
|
||||
|
||||
s.clear_clock();
|
||||
s.put("cmd2\n", std::strlen("cmd2\n"));
|
||||
EXPECT_EQ (s.run(script), 2UL);
|
||||
EXPECT_LT (s.clock(), (clock_t)1000);
|
||||
|
||||
s.clear_clock();
|
||||
s.put("cmd3\r\n", std::strlen("cmd3\r\n"));
|
||||
EXPECT_EQ (s.run(script), 3UL);
|
||||
EXPECT_LT (s.clock(), (clock_t)1000);
|
||||
|
||||
s.clear_clock();
|
||||
s.put("cmd4\n\r", std::strlen("cmd4\n\r"));
|
||||
EXPECT_EQ (s.run(script), 4UL);
|
||||
EXPECT_LT (s.clock(), (clock_t)1000);
|
||||
|
||||
s.clear_clock();
|
||||
s.put("cmd5\n", std::strlen("cmd5\n"));
|
||||
EXPECT_EQ (s.run(script), 5UL);
|
||||
EXPECT_LT (s.clock(), (clock_t)1000);
|
||||
|
||||
s.clear_clock();
|
||||
s.put("cmd", std::strlen("cmd"));
|
||||
EXPECT_EQ (s.run(script), Seq::exit_error.value);
|
||||
EXPECT_GT (s.clock(), (clock_t)1000);
|
||||
}
|
||||
|
||||
TEST(Tsequencer, run_script_blocks_n_gotos) {
|
||||
Seq s;
|
||||
const Seq::script_t<15> script = {{
|
||||
/* 0 */{Seq::control_t::NOP, "", Seq::nil, Seq::nil, Seq::go_to<1>, 1000},
|
||||
|
||||
/* 1 */{Seq::control_t::SEND, "cmd1", Seq::nil, Seq::nil, Seq::next, 0},
|
||||
/* 2 */{Seq::control_t::EXPECT, "reply1", Seq::starts_with, Seq::nil, Seq::next, 1000},
|
||||
/* 3 */{Seq::control_t::OR_EXPECT, "ERROR", Seq::contains, Seq::nil, Seq::exit_error, 0},
|
||||
|
||||
/* 4 */{Seq::control_t::SEND, "cmd2\n", Seq::nil, Seq::nil, Seq::next, 0},
|
||||
/* 5 */{Seq::control_t::DETECT, "ERROR", Seq::contains, Seq::nil, Seq::exit_error, 1000},
|
||||
/* 6 */{Seq::control_t::OR_DETECT, "reply2", Seq::contains, Seq::nil, Seq::go_to<11>, 0},
|
||||
|
||||
/* 7 */{Seq::control_t::SEND, "cmd3\r\n", Seq::nil, Seq::nil, Seq::next, 0},
|
||||
/* 8 */{Seq::control_t::EXPECT, "ERROR", Seq::contains, Seq::nil, Seq::exit_error, 1000},
|
||||
/* 9 */{Seq::control_t::OR_EXPECT, "lalala", Seq::starts_with, Seq::nil, Seq::exit_error, 0},
|
||||
/*10 */{Seq::control_t::OR_EXPECT, "text\n", Seq::ends_with, Seq::nil, Seq::go_to<14>, 0},
|
||||
|
||||
/*11 */{Seq::control_t::SEND, "cmd4\n\r", Seq::nil, Seq::nil, Seq::next, 0},
|
||||
/*12 */{Seq::control_t::EXPECT, "reply4\n", Seq::starts_with, Seq::nil, Seq::go_to<7>, 1000},
|
||||
/*13 */{Seq::control_t::OR_EXPECT, "ERROR", Seq::contains, Seq::nil, Seq::exit_error, 0},
|
||||
|
||||
/*14 */{Seq::control_t::NOP, "", Seq::nil, Seq::nil, Seq::exit_ok, 1000}
|
||||
}};
|
||||
s.clear_clock();
|
||||
EXPECT_EQ (s.run(script), Seq::exit_ok.value);
|
||||
EXPECT_GT (s.clock(), (clock_t)2000);
|
||||
}
|
||||
|
||||
TEST(Tsequencer, run_match_n_handler) {
|
||||
Seq s;
|
||||
|
||||
using str_t = Seq::string_view;
|
||||
using val_t = Seq::value_type;
|
||||
|
||||
auto match = [](const str_t x, const str_t y) ->bool { (void)x; (void)y; return true; };
|
||||
auto check_match = [] (const str_t x, const str_t y) ->bool {
|
||||
return x == y;
|
||||
};
|
||||
auto handler = [](const val_t* v, size_t s){ (void)*v; (void)s; handler_flag = true; };
|
||||
auto set_if_rpl2 = [](const val_t* v, size_t s){
|
||||
(void)*v; (void)s;
|
||||
handler_flag = (str_t(v, s) == "reply2\n");
|
||||
};
|
||||
|
||||
const Seq::script_t<4> script1 = {{
|
||||
{Seq::control_t::SEND, "cmd1", Seq::nil, Seq::nil, Seq::next, 0},
|
||||
{Seq::control_t::EXPECT, "", match, Seq::nil, Seq::next, 1000},
|
||||
{Seq::control_t::OR_EXPECT, "ERROR", Seq::contains, Seq::nil, Seq::exit_error, 0},
|
||||
|
||||
{Seq::control_t::SEND, "cmd1", Seq::nil, handler, Seq::exit_ok, 0}
|
||||
}};
|
||||
handler_flag = false;
|
||||
s.clear_clock();
|
||||
EXPECT_EQ (s.run(script1), Seq::exit_ok.value);
|
||||
EXPECT_LT (s.clock(), (clock_t)1000);
|
||||
EXPECT_EQ (handler_flag, true);
|
||||
|
||||
const Seq::script_t<2> script2 = {{
|
||||
{Seq::control_t::SEND, "cmd1", Seq::nil, Seq::nil, Seq::next, 0},
|
||||
{Seq::control_t::EXPECT, "reply1", check_match, set_if_rpl2, Seq::exit_ok, 1000},
|
||||
}};
|
||||
handler_flag = false;
|
||||
EXPECT_EQ (s.run(script2), Seq::exit_ok.value);
|
||||
EXPECT_EQ (handler_flag, false);
|
||||
|
||||
const Seq::script_t<2> script3 = {{
|
||||
{Seq::control_t::SEND, "cmd2\n", Seq::nil, Seq::nil, Seq::next, 0},
|
||||
{Seq::control_t::EXPECT, "reply2\n", check_match, set_if_rpl2, Seq::exit_ok, 1000},
|
||||
}};
|
||||
handler_flag = false;
|
||||
EXPECT_EQ (s.run(script3), Seq::exit_ok.value);
|
||||
EXPECT_EQ (handler_flag, true);
|
||||
|
||||
const Seq::script_t<1> script4 = {{
|
||||
{Seq::control_t::SEND, "cmd1", Seq::nil, handler, Seq::exit_ok, 0}
|
||||
}};
|
||||
handler_flag = false;
|
||||
EXPECT_EQ (s.run(script4), Seq::exit_ok.value);
|
||||
EXPECT_EQ (handler_flag, true);
|
||||
}
|
||||
|
||||
TEST(Tsequencer, run_boundaries) {
|
||||
Seq s;
|
||||
|
||||
const Seq::script_t<1> script1 = {{
|
||||
{Seq::control_t::NOP, "", Seq::nil, Seq::nil, Seq::next, 0},
|
||||
}};
|
||||
EXPECT_EQ (s.run(script1), Seq::exit_error.value);
|
||||
|
||||
const Seq::script_t<1> script2 = {{
|
||||
{Seq::control_t::NOP, "", Seq::nil, Seq::nil, Seq::go_to<1>, 0},
|
||||
}};
|
||||
EXPECT_EQ (s.run(script2), Seq::exit_error.value);
|
||||
|
||||
const Seq::script_t<1> script3 = {{
|
||||
{Seq::control_t::NOP, "", Seq::nil, Seq::nil, Seq::go_to<(size_t)-1>, 0},
|
||||
}};
|
||||
EXPECT_EQ (s.run(script3), Seq::exit_error.value);
|
||||
|
||||
const Seq::script_t<1> script4 = {{
|
||||
{Seq::control_t::EXPECT, "abc", Seq::nil, Seq::nil, Seq::next, 1000},
|
||||
}};
|
||||
s.clear_clock();
|
||||
EXPECT_EQ (s.run(script4), Seq::exit_error.value);
|
||||
EXPECT_GT (s.clock(), (clock_t)1000);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user