Browse Source
Terminal: change command-line parser (#2247)
Change the underlying command line handling: - switch to a custom parser, inspired by redis / sds - update terminalRegisterCommand signature, pass only bare minimum - clean-up `help` & `commands`. update settings `set`, `get` and `del` - allow our custom test suite to run command-line tests - clean-up Stream IO to allow us to print large things into debug stream (for example, `eeprom.dump`) - send parsing errors to the debug log As a proof of concept, introduce `TERMINAL_MQTT_SUPPORT` and `TERMINAL_WEB_API_SUPPORT` - MQTT subscribes to the `<root>/cmd/set` and sends response to the `<root>/cmd`. We can't output too much, as we don't have any large-send API. - Web API listens to the `/api/cmd?apikey=...&line=...` (or PUT, params inside the body). This one is intended as a possible replacement of the `API_SUPPORT`. Internals introduce a 'task' around the AsyncWebServerRequest object that will simulate what WiFiClient does and push data into it continuously, switching between CONT and SYS. Both are experimental. We only accept a single command and not every command is updated to use Print `ctx.output` object. We are also somewhat limited by the Print / Stream overall, perhaps I am overestimating the usefulness of Arduino compatibility to such an extent :) Web API handler can also sometimes show only part of the result, whenever the command tries to yield() by itself waiting for something. Perhaps we would need to create a custom request handler for that specific use-case.mcspr-patch-1
Max Prokhorov
4 years ago
committed by
GitHub
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
51 changed files with 1900 additions and 516 deletions
Unified View
Diff Options
-
+26 -81code/espurna/api.cpp
-
+12 -2code/espurna/api.h
-
+79 -0code/espurna/api_common.cpp
-
+14 -0code/espurna/config/dependencies.h
-
+18 -2code/espurna/config/general.h
-
+1 -1code/espurna/crash.cpp
-
+6 -1code/espurna/debug.cpp
-
+3 -1code/espurna/debug.h
-
+3 -3code/espurna/homeassistant.cpp
-
+2 -2code/espurna/i2c.cpp
-
+3 -7code/espurna/influxdb.cpp
-
+0 -26code/espurna/libs/EmbedisWrap.h
-
+59 -0code/espurna/libs/PrintString.h
-
+68 -0code/espurna/libs/StreamAdapter.h
-
+0 -105code/espurna/libs/StreamInjector.h
-
+17 -17code/espurna/light.cpp
-
+2 -2code/espurna/lightfox.cpp
-
+4 -2code/espurna/main.cpp
-
+2 -2code/espurna/mqtt.cpp
-
+1 -1code/espurna/nofuss.cpp
-
+5 -5code/espurna/ntp.cpp
-
+2 -2code/espurna/ntp_legacy.cpp
-
+1 -1code/espurna/ota.cpp
-
+3 -3code/espurna/ota_asynctcp.cpp
-
+3 -3code/espurna/ota_httpupdate.cpp
-
+6 -6code/espurna/relay.cpp
-
+15 -16code/espurna/rfbridge.cpp
-
+6 -6code/espurna/rpnrules.cpp
-
+2 -2code/espurna/rtcmem.cpp
-
+1 -1code/espurna/sensor.cpp
-
+12 -12code/espurna/sensors/PZEM004TSensor.h
-
+105 -0code/espurna/settings.cpp
-
+3 -3code/espurna/settings.h
-
+12 -10code/espurna/storage_eeprom.cpp
-
+10 -10code/espurna/telnet.cpp
-
+360 -167code/espurna/terminal.cpp
-
+16 -4code/espurna/terminal.h
-
+93 -0code/espurna/terminal_commands.cpp
-
+90 -0code/espurna/terminal_commands.h
-
+228 -0code/espurna/terminal_parsing.cpp
-
+45 -0code/espurna/terminal_parsing.h
-
+2 -2code/espurna/tuya.cpp
-
+151 -0code/espurna/web.cpp
-
+62 -0code/espurna/web.h
-
+60 -0code/espurna/web_asyncwebprint_impl.h
-
+7 -7code/espurna/wifi.cpp
-
+2 -0code/espurna/wifi.h
-
+2 -1code/espurna/ws_internal.h
-
+2 -0code/test/build/nondefault.h
-
+8 -0code/test/platformio.ini
-
+266 -0code/test/unit/terminal/terminal.cpp
+ 26
- 81
code/espurna/api.cpp
View File
+ 12
- 2
code/espurna/api.h
View File
+ 79
- 0
code/espurna/api_common.cpp
View File
| @ -0,0 +1,79 @@ | |||||
| /* | |||||
| Part of the API MODULE | |||||
| Copyright (C) 2016-2019 by Xose Pérez <xose dot perez at gmail dot com> | |||||
| Copyright (C) 2020 by Maxim Prokhorov <prokhorov dot max at outlook dot com> | |||||
| */ | |||||
| #include "espurna.h" | |||||
| #include "api.h" | |||||
| #include "ws.h" | |||||
| #include "web.h" | |||||
| // ----------------------------------------------------------------------------- | |||||
| #if WEB_SUPPORT | |||||
| namespace { | |||||
| bool _apiWebSocketOnKeyCheck(const char * key, JsonVariant& value) { | |||||
| return (strncmp(key, "api", 3) == 0); | |||||
| } | |||||
| void _apiWebSocketOnConnected(JsonObject& root) { | |||||
| root["apiEnabled"] = apiEnabled(); | |||||
| root["apiKey"] = apiKey(); | |||||
| root["apiRestFul"] = apiRestFul(); | |||||
| root["apiRealTime"] = getSetting("apiRealTime", 1 == API_REAL_TIME_VALUES); | |||||
| } | |||||
| } | |||||
| // ----------------------------------------------------------------------------- | |||||
| // Public API | |||||
| // ----------------------------------------------------------------------------- | |||||
| bool apiEnabled() { | |||||
| return getSetting("apiEnabled", 1 == API_ENABLED); | |||||
| } | |||||
| bool apiRestFul() { | |||||
| return getSetting("apiRestFul", 1 == API_RESTFUL); | |||||
| } | |||||
| String apiKey() { | |||||
| return getSetting("apiKey", API_KEY); | |||||
| } | |||||
| bool apiAuthenticate(AsyncWebServerRequest *request) { | |||||
| const auto key = apiKey(); | |||||
| if (!apiEnabled() || !key.length()) { | |||||
| DEBUG_MSG_P(PSTR("[WEBSERVER] HTTP API is not enabled\n")); | |||||
| request->send(403); | |||||
| return false; | |||||
| } | |||||
| AsyncWebParameter* keyParam = request->getParam("apikey", (request->method() == HTTP_PUT)); | |||||
| if (!keyParam || !keyParam->value().equals(key)) { | |||||
| DEBUG_MSG_P(PSTR("[WEBSERVER] Wrong / missing apikey parameter\n")); | |||||
| request->send(403); | |||||
| return false; | |||||
| } | |||||
| return true; | |||||
| } | |||||
| void apiCommonSetup() { | |||||
| wsRegister() | |||||
| .onVisible([](JsonObject& root) { root["apiVisible"] = 1; }) | |||||
| .onConnected(_apiWebSocketOnConnected) | |||||
| .onKeyCheck(_apiWebSocketOnKeyCheck); | |||||
| } | |||||
| #endif // WEB_SUPPORT == 1 | |||||
+ 14
- 0
code/espurna/config/dependencies.h
View File
+ 18
- 2
code/espurna/config/general.h
View File
+ 1
- 1
code/espurna/crash.cpp
View File
+ 6
- 1
code/espurna/debug.cpp
View File
+ 3
- 1
code/espurna/debug.h
View File
+ 3
- 3
code/espurna/homeassistant.cpp
View File
+ 2
- 2
code/espurna/i2c.cpp
View File
+ 3
- 7
code/espurna/influxdb.cpp
View File
+ 0
- 26
code/espurna/libs/EmbedisWrap.h
View File
| @ -1,26 +0,0 @@ | |||||
| // ----------------------------------------------------------------------------- | |||||
| // Wrap class around Embedis (settings & terminal) | |||||
| // ----------------------------------------------------------------------------- | |||||
| #pragma once | |||||
| #include <Embedis.h> | |||||
| class EmbedisWrap : public Embedis { | |||||
| public: | |||||
| EmbedisWrap(Stream& stream, size_t buflen = 128, size_t argvlen = 8) : | |||||
| Embedis(stream, buflen, argvlen) | |||||
| {} | |||||
| unsigned char getCommandCount() { | |||||
| return commands.size(); | |||||
| } | |||||
| String getCommandName(unsigned int i) { | |||||
| if (i < commands.size()) return commands[i].name; | |||||
| return String(); | |||||
| } | |||||
| }; | |||||
+ 59
- 0
code/espurna/libs/PrintString.h
View File
| @ -0,0 +1,59 @@ | |||||
| /* | |||||
| Arduino Print buffer. Size is fixed, unlike StreamString. | |||||
| Copyright (C) 2020 by Maxim Prokhorov <prokhorov dot max at outlook dot com> | |||||
| */ | |||||
| #pragma once | |||||
| #include <Arduino.h> | |||||
| #include <Print.h> | |||||
| #include <core_version.h> | |||||
| struct PrintString final : public Print, public String { | |||||
| PrintString(size_t reserved) : | |||||
| _reserved(reserved) | |||||
| { | |||||
| reserve(reserved); | |||||
| } | |||||
| size_t write(const uint8_t* data, size_t size) override { | |||||
| if (!size || !data) return 0; | |||||
| // we *will* receive C-strings as input | |||||
| size_t want = length() + size; | |||||
| if (data[size - 1] == '\0') { | |||||
| size -= 1; | |||||
| want -= 1; | |||||
| } | |||||
| if (want > _reserved) return 0; | |||||
| // XXX: 2.3.0 uses str... methods that expect '0' at the end of the 'data' | |||||
| // see WString{.cpp,.h} for the implementation | |||||
| #if defined(ARDUINO_ESP8266_RELEASE_2_3_0) | |||||
| std::copy(data, data + size, buffer + len); | |||||
| len = want; | |||||
| buffer[len] = '\0'; | |||||
| #else | |||||
| concat(reinterpret_cast<const char*>(data), size); | |||||
| #endif | |||||
| return size; | |||||
| } | |||||
| size_t write(uint8_t ch) override { | |||||
| if (length() + 1 > _reserved) return 0; | |||||
| return concat(static_cast<char>(ch)); | |||||
| } | |||||
| private: | |||||
| const size_t _reserved; | |||||
| }; | |||||
+ 68
- 0
code/espurna/libs/StreamAdapter.h
View File
| @ -0,0 +1,68 @@ | |||||
| /* | |||||
| Arduino Stream from a generic generic byte range | |||||
| Implementation of the Print is taken by reference and will be proxied | |||||
| Copyright (C) 2020 by Maxim Prokhorov <prokhorov dot max at outlook dot com> | |||||
| */ | |||||
| #include <Arduino.h> | |||||
| #include <core_version.h> | |||||
| #include <memory> | |||||
| #pragma once | |||||
| template <typename T> | |||||
| struct StreamAdapter final : public Stream { | |||||
| StreamAdapter(Print& writer, T&& begin, T&& end) : | |||||
| _writer(writer), | |||||
| _current(std::forward<T>(begin)), | |||||
| _begin(std::forward<T>(begin)), | |||||
| _end(std::forward<T>(end)) | |||||
| {} | |||||
| int available() override { | |||||
| return (_end - _current); | |||||
| } | |||||
| int peek() override { | |||||
| if (available() && (_end != (1 + _current))) { | |||||
| return *(1 + _current); | |||||
| } | |||||
| return -1; | |||||
| } | |||||
| int read() override { | |||||
| if (_end != _current) { | |||||
| return *(_current++); | |||||
| } | |||||
| return -1; | |||||
| } | |||||
| void flush() override { | |||||
| // 2.3.0 - Stream::flush() | |||||
| // latest - Print::flush() | |||||
| #if not defined(ARDUINO_ESP8266_RELEASE_2_3_0) | |||||
| _writer.flush(); | |||||
| #endif | |||||
| } | |||||
| size_t write(const uint8_t* buffer, size_t size) override { | |||||
| return _writer.write(buffer, size); | |||||
| } | |||||
| size_t write(uint8_t ch) override { | |||||
| return _writer.write(ch); | |||||
| } | |||||
| private: | |||||
| Print& _writer; | |||||
| T _current; | |||||
| T const _begin; | |||||
| T const _end; | |||||
| }; | |||||
+ 0
- 105
code/espurna/libs/StreamInjector.h
View File
| @ -1,105 +0,0 @@ | |||||
| /* | |||||
| StreamInjector | |||||
| Copyright (C) 2016-2019 by Xose Pérez <xose dot perez at gmail dot com> | |||||
| This program is free software: you can redistribute it and/or modify | |||||
| it under the terms of the GNU General Public License as published by | |||||
| the Free Software Foundation, either version 3 of the License, or | |||||
| (at your option) any later version. | |||||
| This program is distributed in the hope that it will be useful, | |||||
| but WITHOUT ANY WARRANTY; without even the implied warranty of | |||||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||||
| GNU General Public License for more details. | |||||
| You should have received a copy of the GNU General Public License | |||||
| along with this program. If not, see <http://www.gnu.org/licenses/>. | |||||
| */ | |||||
| #pragma once | |||||
| #include <Stream.h> | |||||
| class StreamInjector : public Stream { | |||||
| public: | |||||
| typedef std::function<void(uint8_t ch)> writeCallback; | |||||
| StreamInjector(size_t buflen = 128) : _buffer_size(buflen) { | |||||
| _buffer = new char[buflen]; | |||||
| } | |||||
| ~StreamInjector() { | |||||
| delete[] _buffer; | |||||
| } | |||||
| // --------------------------------------------------------------------- | |||||
| virtual uint8_t inject(char ch) { | |||||
| _buffer[_buffer_write] = ch; | |||||
| _buffer_write = (_buffer_write + 1) % _buffer_size; | |||||
| return 1; | |||||
| } | |||||
| virtual uint8_t inject(char *data, size_t len) { | |||||
| for (uint8_t i=0; i<len; i++) { | |||||
| inject(data[i]); | |||||
| } | |||||
| return len; | |||||
| } | |||||
| virtual void callback(writeCallback c) { | |||||
| _callback = c; | |||||
| } | |||||
| // --------------------------------------------------------------------- | |||||
| virtual size_t write(uint8_t ch) { | |||||
| if (_callback) _callback(ch); | |||||
| return 1; | |||||
| } | |||||
| virtual int read() { | |||||
| int ch = -1; | |||||
| if (_buffer_read != _buffer_write) { | |||||
| ch = _buffer[_buffer_read]; | |||||
| _buffer_read = (_buffer_read + 1) % _buffer_size; | |||||
| } | |||||
| return ch; | |||||
| } | |||||
| virtual int available() { | |||||
| unsigned int bytes = 0; | |||||
| if (_buffer_read > _buffer_write) { | |||||
| bytes += (_buffer_write - _buffer_read + _buffer_size); | |||||
| } else if (_buffer_read < _buffer_write) { | |||||
| bytes += (_buffer_write - _buffer_read); | |||||
| } | |||||
| return bytes; | |||||
| } | |||||
| virtual int peek() { | |||||
| int ch = -1; | |||||
| if (_buffer_read != _buffer_write) { | |||||
| ch = _buffer[_buffer_read]; | |||||
| } | |||||
| return ch; | |||||
| } | |||||
| virtual void flush() { | |||||
| _buffer_read = _buffer_write; | |||||
| } | |||||
| private: | |||||
| char * _buffer; | |||||
| unsigned char _buffer_size; | |||||
| unsigned char _buffer_write = 0; | |||||
| unsigned char _buffer_read = 0; | |||||
| writeCallback _callback = NULL; | |||||
| }; | |||||
+ 17
- 17
code/espurna/light.cpp
View File
+ 2
- 2
code/espurna/lightfox.cpp
View File
+ 4
- 2
code/espurna/main.cpp
View File
+ 2
- 2
code/espurna/mqtt.cpp
View File
+ 1
- 1
code/espurna/nofuss.cpp
View File
+ 5
- 5
code/espurna/ntp.cpp
View File
+ 2
- 2
code/espurna/ntp_legacy.cpp
View File
+ 1
- 1
code/espurna/ota.cpp
View File
+ 3
- 3
code/espurna/ota_asynctcp.cpp
View File
+ 3
- 3
code/espurna/ota_httpupdate.cpp
View File
+ 6
- 6
code/espurna/relay.cpp
View File
+ 15
- 16
code/espurna/rfbridge.cpp
View File
+ 6
- 6
code/espurna/rpnrules.cpp
View File
+ 2
- 2
code/espurna/rtcmem.cpp
View File
+ 1
- 1
code/espurna/sensor.cpp
View File
+ 12
- 12
code/espurna/sensors/PZEM004TSensor.h
View File
+ 105
- 0
code/espurna/settings.cpp
View File
+ 3
- 3
code/espurna/settings.h
View File
+ 12
- 10
code/espurna/storage_eeprom.cpp
View File
+ 10
- 10
code/espurna/telnet.cpp
View File
+ 360
- 167
code/espurna/terminal.cpp
View File
+ 16
- 4
code/espurna/terminal.h
View File
+ 93
- 0
code/espurna/terminal_commands.cpp
View File
| @ -0,0 +1,93 @@ | |||||
| /* | |||||
| Part of the TERMINAL MODULE | |||||
| Copyright (C) 2020 by Maxim Prokhorov <prokhorov dot max at outlook dot com> | |||||
| Heavily inspired by the Embedis design: | |||||
| - https://github.com/thingSoC/embedis | |||||
| */ | |||||
| #include <Arduino.h> | |||||
| #include "terminal_commands.h" | |||||
| #include <memory> | |||||
| namespace terminal { | |||||
| std::unordered_map<String, Terminal::CommandFunc, | |||||
| parsing::LowercaseFnv1Hash<String>, | |||||
| parsing::LowercaseEquals<String>> Terminal::commands; | |||||
| void Terminal::addCommand(const String& name, CommandFunc func) { | |||||
| if (!func) return; | |||||
| commands.emplace(std::make_pair(name, func)); | |||||
| } | |||||
| size_t Terminal::commandsSize() { | |||||
| return commands.size(); | |||||
| } | |||||
| std::vector<String> Terminal::commandNames() { | |||||
| std::vector<String> out; | |||||
| out.reserve(commands.size()); | |||||
| for (auto& command : commands) { | |||||
| out.push_back(command.first); | |||||
| } | |||||
| return out; | |||||
| } | |||||
| Terminal::Result Terminal::processLine() { | |||||
| // Arduino stream API returns either `char` >= 0 or -1 on error | |||||
| int c = -1; | |||||
| while ((c = stream.read()) >= 0) { | |||||
| if (buffer.size() >= (buffer_size - 1)) { | |||||
| buffer.clear(); | |||||
| return Result::BufferOverflow; | |||||
| } | |||||
| buffer.push_back(c); | |||||
| if (c == '\n') { | |||||
| // in case we see \r\n, offset minus one and overwrite \r | |||||
| auto end = buffer.end() - 1; | |||||
| if (*(end - 1) == '\r') { | |||||
| --end; | |||||
| } | |||||
| *end = '\0'; | |||||
| // parser should pick out at least one arg (command) | |||||
| auto cmdline = parsing::parse_commandline(buffer.data()); | |||||
| buffer.clear(); | |||||
| if (cmdline.argc >= 1) { | |||||
| auto command = commands.find(cmdline.argv[0]); | |||||
| if (command == commands.end()) return Result::CommandNotFound; | |||||
| (*command).second(CommandContext{std::move(cmdline.argv), cmdline.argc, stream}); | |||||
| return Result::Command; | |||||
| } | |||||
| } | |||||
| } | |||||
| // we need to notify about the fixable things | |||||
| if (buffer.size() && (c < 0)) { | |||||
| return Result::Pending; | |||||
| } else if (!buffer.size() && (c < 0)) { | |||||
| return Result::NoInput; | |||||
| // ... and some unexpected conditions | |||||
| } else { | |||||
| return Result::Error; | |||||
| } | |||||
| } | |||||
| bool Terminal::defaultProcessFunc(Result result) { | |||||
| return (result != Result::Error) && (result != Result::NoInput); | |||||
| } | |||||
| void Terminal::process(ProcessFunc func) { | |||||
| while (func(processLine())) { | |||||
| } | |||||
| } | |||||
| } // ns terminal | |||||
+ 90
- 0
code/espurna/terminal_commands.h
View File
| @ -0,0 +1,90 @@ | |||||
| /* | |||||
| Part of the TERMINAL MODULE | |||||
| Copyright (C) 2020 by Maxim Prokhorov <prokhorov dot max at outlook dot com> | |||||
| */ | |||||
| #pragma once | |||||
| #include <Arduino.h> | |||||
| #include "terminal_parsing.h" | |||||
| #include <unordered_map> | |||||
| #include <functional> | |||||
| #include <vector> | |||||
| namespace terminal { | |||||
| struct Terminal; | |||||
| // We need to be able to pass arbitrary Args structure into the command function | |||||
| // Like Embedis implementation, we only pass things that we actually use instead of complete obj instance | |||||
| struct CommandContext { | |||||
| std::vector<String> argv; | |||||
| size_t argc; | |||||
| Print& output; | |||||
| }; | |||||
| struct Terminal { | |||||
| enum class Result { | |||||
| Error, // Genric error condition | |||||
| Command, // We successfully parsed the line and executed the callback specified via addCommand | |||||
| CommandNotFound, // ... similar to the above, but command was never added via addCommand | |||||
| BufferOverflow, // Command line processing failed, no \r\n / \n before buffer was filled | |||||
| Pending, // We got something in the buffer, but can't yet do anything with it | |||||
| NoInput // We got nothing in the buffer and stream read() returns -1 | |||||
| }; | |||||
| using CommandFunc = void(*)(const CommandContext&); | |||||
| using ProcessFunc = bool(*)(Result); | |||||
| // stream - see `stream` description below | |||||
| // buffer_size - set internal limit for the total command line length | |||||
| Terminal(Stream& stream, size_t buffer_size = 128) : | |||||
| stream(stream), | |||||
| buffer_size(buffer_size) | |||||
| { | |||||
| buffer.reserve(buffer_size); | |||||
| } | |||||
| static void addCommand(const String& name, CommandFunc func); | |||||
| static size_t commandsSize(); | |||||
| static std::vector<String> commandNames(); | |||||
| // Try to process a single line (until either `\r\n` or just `\n`) | |||||
| Result processLine(); | |||||
| // Calls processLine() repeatedly. | |||||
| // Blocks until the stream no longer has any data available. | |||||
| // `process_f` will return each individual processLine() Result, | |||||
| // and we can either stop (false) or continue (true) the function. | |||||
| void process(ProcessFunc = defaultProcessFunc); | |||||
| private: | |||||
| static bool defaultProcessFunc(Result); | |||||
| // general input / output stream: | |||||
| // - stream.read() should return user iput | |||||
| // - stream.write() can be called from the command callback | |||||
| // - stream.write() can be called by us to show error messages | |||||
| Stream& stream; | |||||
| // buffer for the input stream, fixed in size | |||||
| std::vector<char> buffer; | |||||
| const size_t buffer_size; | |||||
| // TODO: every command is shared, instance should probably also have an | |||||
| // option to add 'private' commands list? | |||||
| // Note: we can save ~2.5KB by using std::vector<std::pair<String, CommandFunc>> | |||||
| // https://github.com/xoseperez/espurna/pull/2247#issuecomment-633689741 | |||||
| static std::unordered_map<String, CommandFunc, | |||||
| parsing::LowercaseFnv1Hash<String>, | |||||
| parsing::LowercaseEquals<String>> commands; | |||||
| }; | |||||
| } | |||||
+ 228
- 0
code/espurna/terminal_parsing.cpp
View File
| @ -0,0 +1,228 @@ | |||||
| /* | |||||
| Part of the TERMINAL MODULE | |||||
| Copyright (C) 2016-2019 by Xose Pérez <xose dot perez at gmail dot com> | |||||
| Copyright (C) 2020 by Maxim Prokhorov <prokhorov dot max at outlook dot com> | |||||
| */ | |||||
| #include <vector> | |||||
| #include <cctype> | |||||
| #include "terminal_parsing.h" | |||||
| namespace terminal { | |||||
| namespace parsing { | |||||
| // c/p with minor modifications from redis / sds, so that we don't have to roll a custom parser | |||||
| // ref: | |||||
| // - https://github.com/antirez/sds/blob/master/sds.c | |||||
| // - https://github.com/antirez/redis/blob/unstable/src/networking.c | |||||
| // | |||||
| // Things are kept mostly the same, we are replacing Redis-specific things: | |||||
| // - sds structure -> String | |||||
| // - sds array -> std::vector<String> | |||||
| // - we return always return custom structure, nullptr can no longer be used | |||||
| // to notify about the missing / unterminated / mismatching quotes | |||||
| // - hex_... function helpers types are changed | |||||
| // Original code is part of the SDSLib 2.0 -- A C dynamic strings library | |||||
| // * | |||||
| // * Copyright (c) 2006-2015, Salvatore Sanfilippo <antirez at gmail dot com> | |||||
| // * Copyright (c) 2015, Oran Agra | |||||
| // * Copyright (c) 2015, Redis Labs, Inc | |||||
| // * All rights reserved. | |||||
| // * | |||||
| // * Redistribution and use in source and binary forms, with or without | |||||
| // * modification, are permitted provided that the following conditions are met: | |||||
| // * | |||||
| // * * Redistributions of source code must retain the above copyright notice, | |||||
| // * this list of conditions and the following disclaimer. | |||||
| // * * Redistributions in binary form must reproduce the above copyright | |||||
| // * notice, this list of conditions and the following disclaimer in the | |||||
| // * documentation and/or other materials provided with the distribution. | |||||
| // * * Neither the name of Redis nor the names of its contributors may be used | |||||
| // * to endorse or promote products derived from this software without | |||||
| // * specific prior written permission. | |||||
| // * | |||||
| // * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |||||
| // * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |||||
| // * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |||||
| // * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE | |||||
| // * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |||||
| // * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |||||
| // * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |||||
| // * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |||||
| // * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |||||
| // * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |||||
| // * POSSIBILITY OF SUCH DAMAGE. | |||||
| // Helper functions to handle \xHH codes | |||||
| static bool is_hex_digit(char c) { | |||||
| return (c >= '0' && c <= '9') \ | |||||
| ||(c >= 'a' && c <= 'f') \ | |||||
| ||(c >= 'A' && c <= 'F'); | |||||
| } | |||||
| static char hex_digit_to_int(char c) { | |||||
| switch (c) { | |||||
| case '0': return 0; | |||||
| case '1': return 1; | |||||
| case '2': return 2; | |||||
| case '3': return 3; | |||||
| case '4': return 4; | |||||
| case '5': return 5; | |||||
| case '6': return 6; | |||||
| case '7': return 7; | |||||
| case '8': return 8; | |||||
| case '9': return 9; | |||||
| case 'a': case 'A': return 10; | |||||
| case 'b': case 'B': return 11; | |||||
| case 'c': case 'C': return 12; | |||||
| case 'd': case 'D': return 13; | |||||
| case 'e': case 'E': return 14; | |||||
| case 'f': case 'F': return 15; | |||||
| default: return 0; | |||||
| } | |||||
| } | |||||
| // Our port of `sdssplitargs` | |||||
| CommandLine parse_commandline(const char *line) { | |||||
| const char *p = line; | |||||
| CommandLine result {{}, 0}; | |||||
| result.argv.reserve(4); | |||||
| String current; | |||||
| while(1) { | |||||
| /* skip blanks */ | |||||
| while(*p && isspace(*p)) p++; | |||||
| if (*p) { | |||||
| /* get a token */ | |||||
| int inq=0; /* set to 1 if we are in "quotes" */ | |||||
| int insq=0; /* set to 1 if we are in 'single quotes' */ | |||||
| int done=0; | |||||
| while(!done) { | |||||
| if (inq) { | |||||
| if (*p == '\\' && *(p+1) == 'x' && | |||||
| is_hex_digit(*(p+2)) && | |||||
| is_hex_digit(*(p+3))) | |||||
| { | |||||
| // XXX: make sure that we append `char` or `char[]`, | |||||
| // even with -funsigned-char this can accidentally append itoa conversion | |||||
| unsigned char byte = | |||||
| (hex_digit_to_int(*(p+2))*16)+ | |||||
| hex_digit_to_int(*(p+3)); | |||||
| char buf[2] { static_cast<char>(byte), 0x00 }; | |||||
| current += buf; | |||||
| p += 3; | |||||
| } else if (*p == '\\' && *(p+1)) { | |||||
| char c; | |||||
| p++; | |||||
| switch(*p) { | |||||
| case 'n': c = '\n'; break; | |||||
| case 'r': c = '\r'; break; | |||||
| case 't': c = '\t'; break; | |||||
| case 'b': c = '\b'; break; | |||||
| case 'a': c = '\a'; break; | |||||
| default: c = *p; break; | |||||
| } | |||||
| current += c; | |||||
| } else if (*p == '"') { | |||||
| /* closing quote must be followed by a space or | |||||
| * nothing at all. */ | |||||
| if (*(p+1) && !isspace(*(p+1))) goto err; | |||||
| done=1; | |||||
| } else if (!*p) { | |||||
| /* unterminated quotes */ | |||||
| goto err; | |||||
| } else { | |||||
| char buf[2] {*p, '\0'}; | |||||
| current += buf; | |||||
| } | |||||
| } else if (insq) { | |||||
| if (*p == '\\' && *(p+1) == '\'') { | |||||
| p++; | |||||
| current += '\''; | |||||
| } else if (*p == '\'') { | |||||
| /* closing quote must be followed by a space or | |||||
| * nothing at all. */ | |||||
| if (*(p+1) && !isspace(*(p+1))) goto err; | |||||
| done=1; | |||||
| } else if (!*p) { | |||||
| /* unterminated quotes */ | |||||
| goto err; | |||||
| } else { | |||||
| char buf[2] {*p, '\0'}; | |||||
| current += buf; | |||||
| } | |||||
| } else { | |||||
| switch(*p) { | |||||
| case ' ': | |||||
| case '\n': | |||||
| case '\r': | |||||
| case '\t': | |||||
| case '\0': | |||||
| done=1; | |||||
| break; | |||||
| case '"': | |||||
| inq=1; | |||||
| break; | |||||
| case '\'': | |||||
| insq=1; | |||||
| break; | |||||
| default: { | |||||
| char buf[2] {*p, '\0'}; | |||||
| current += buf; | |||||
| break; | |||||
| } | |||||
| } | |||||
| } | |||||
| if (*p) p++; | |||||
| } | |||||
| /* add the token to the vector */ | |||||
| result.argv.emplace_back(std::move(current)); | |||||
| ++result.argc; | |||||
| } else { | |||||
| /* Even on empty input string return something not NULL. */ | |||||
| return result; | |||||
| } | |||||
| } | |||||
| err: | |||||
| result.argc = 0; | |||||
| result.argv.clear(); | |||||
| return result; | |||||
| } | |||||
| // Fowler–Noll–Vo hash function to hash command strings that treats input as lowercase | |||||
| // ref: https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function | |||||
| template<> | |||||
| size_t LowercaseFnv1Hash<String>::operator()(const String& str) const { | |||||
| constexpr uint32_t fnv_prime = 16777619u; | |||||
| constexpr uint32_t fnv_basis = 2166136261u; | |||||
| uint32_t hash = fnv_basis; | |||||
| for (size_t idx = 0; idx < str.length(); ++idx) { | |||||
| // TODO: String::operator[] is slightly slower here | |||||
| // does not happen with the std::string | |||||
| hash = hash ^ static_cast<uint32_t>(tolower(str.c_str()[idx])); | |||||
| hash = hash * fnv_prime; | |||||
| } | |||||
| return hash; | |||||
| } | |||||
| template<> | |||||
| bool LowercaseEquals<String>::operator()(const String& lhs, const String& rhs) const { | |||||
| return lhs.equalsIgnoreCase(rhs); | |||||
| } | |||||
| } // namespace parsing | |||||
| } // namespace terminal | |||||
+ 45
- 0
code/espurna/terminal_parsing.h
View File
| @ -0,0 +1,45 @@ | |||||
| /* | |||||
| Part of the TERMINAL MODULE | |||||
| Copyright (C) 2016-2019 by Xose Pérez <xose dot perez at gmail dot com> | |||||
| Copyright (C) 2020 by Maxim Prokhorov <prokhorov dot max at outlook dot com> | |||||
| */ | |||||
| #pragma once | |||||
| #include <Arduino.h> | |||||
| #include <vector> | |||||
| namespace terminal { | |||||
| namespace parsing { | |||||
| // Generic command line parser | |||||
| // - split each arg from the input line and put them into the argv array | |||||
| // - argc is expected to be equal to the argv | |||||
| struct CommandLine { | |||||
| std::vector<String> argv; | |||||
| size_t argc; | |||||
| }; | |||||
| CommandLine parse_commandline(const char *line); | |||||
| // Fowler–Noll–Vo hash function to hash command strings that treats input as lowercase | |||||
| // ref: https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function | |||||
| // | |||||
| // TODO: afaik, unordered_map should handle collisions (however rare they are in our case) | |||||
| // if not, we can always roll static commands allocation and just match strings | |||||
| // with LowercaseEquals (which is not that much slower) | |||||
| template <typename T> | |||||
| struct LowercaseFnv1Hash { | |||||
| size_t operator()(const T& str) const; | |||||
| }; | |||||
| template <typename T> | |||||
| struct LowercaseEquals { | |||||
| bool operator()(const T& lhs, const T& rhs) const; | |||||
| }; | |||||
| } | |||||
| } | |||||
+ 2
- 2
code/espurna/tuya.cpp
View File
+ 151
- 0
code/espurna/web.cpp
View File
+ 62
- 0
code/espurna/web.h
View File
+ 60
- 0
code/espurna/web_asyncwebprint_impl.h
View File
| @ -0,0 +1,60 @@ | |||||
| /* | |||||
| Part of the WEBSERVER MODULE | |||||
| Copyright (C) 2016-2019 by Xose Pérez <xose dot perez at gmail dot com> | |||||
| */ | |||||
| #pragma once | |||||
| #include "web.h" | |||||
| #include "libs/TypeChecks.h" | |||||
| #include <Schedule.h> | |||||
| #if WEB_SUPPORT | |||||
| namespace asyncwebprint_traits { | |||||
| template <typename T> | |||||
| using print_callable_t = decltype(std::declval<T>()(std::declval<Print&>())); | |||||
| template <typename T> | |||||
| using is_print_callable = is_detected<print_callable_t, T>; | |||||
| } | |||||
| template<typename CallbackType> | |||||
| void AsyncWebPrint::scheduleFromRequest(const AsyncWebPrintConfig& config, AsyncWebServerRequest* request, CallbackType callback) { | |||||
| static_assert(asyncwebprint_traits::is_print_callable<CallbackType>::value, "CallbackType needs to be a callable with void(Print&)"); | |||||
| // because of async nature of the server, we need to make sure we outlive 'request' object | |||||
| auto print = std::shared_ptr<AsyncWebPrint>(new AsyncWebPrint(config, request)); | |||||
| // attach one ptr to onDisconnect capture, so we can detect disconnection before scheduled function runs | |||||
| request->onDisconnect([print]() { | |||||
| print->setState(AsyncWebPrint::State::Done); | |||||
| }); | |||||
| // attach another capture to the scheduled function, so we execute as soon as we exit next loop() | |||||
| schedule_function([callback, print]() { | |||||
| if (State::None != print->getState()) return; | |||||
| callback(*print.get()); | |||||
| print->flush(); | |||||
| }); | |||||
| } | |||||
| constexpr AsyncWebPrintConfig AsyncWebPrintDefaults { | |||||
| /*mimeType =*/ "text/plain", | |||||
| /*backlogCountMax=*/ 2, | |||||
| /*backlogSizeMax= */ TCP_MSS, | |||||
| /*backlogTimeout= */ 5000 | |||||
| }; | |||||
| template<typename CallbackType> | |||||
| void AsyncWebPrint::scheduleFromRequest(AsyncWebServerRequest* request, CallbackType callback) { | |||||
| AsyncWebPrint::scheduleFromRequest(AsyncWebPrintDefaults, request, callback); | |||||
| } | |||||
| #endif | |||||
+ 7
- 7
code/espurna/wifi.cpp
View File
+ 2
- 0
code/espurna/wifi.h
View File
+ 2
- 1
code/espurna/ws_internal.h
View File
+ 2
- 0
code/test/build/nondefault.h
View File
+ 8
- 0
code/test/platformio.ini
View File
| @ -1,12 +1,20 @@ | |||||
| [platformio] | [platformio] | ||||
| test_dir = unit | test_dir = unit | ||||
| src_dir = ../espurna | |||||
| [env:test] | [env:test] | ||||
| platform = native | platform = native | ||||
| lib_compat_mode = off | lib_compat_mode = off | ||||
| test_build_project_src = true | |||||
| src_filter = | |||||
| +<../espurna/terminal_commands.cpp> | |||||
| +<../espurna/terminal_parsing.cpp> | |||||
| lib_deps = | lib_deps = | ||||
| StreamString | StreamString | ||||
| https://github.com/bxparks/UnixHostDuino#d740398e | https://github.com/bxparks/UnixHostDuino#d740398e | ||||
| build_flags = | build_flags = | ||||
| -DMANUFACTURER="PLATFORMIO" | |||||
| -DDEVICE="TEST" | |||||
| -std=gnu++11 | -std=gnu++11 | ||||
| -Os | |||||
| -I../espurna/ | -I../espurna/ | ||||
+ 266
- 0
code/test/unit/terminal/terminal.cpp
View File
| @ -0,0 +1,266 @@ | |||||
| #include <unity.h> | |||||
| #include <Arduino.h> | |||||
| #include <StreamString.h> | |||||
| #include <terminal_commands.h> | |||||
| // TODO: should we just use std::function at this point? | |||||
| // we don't actually benefit from having basic ptr functions in handler | |||||
| // test would be simplified too, we would no longer need to have static vars | |||||
| // Got the idea from the Embedis test suite, set up a proxy for StreamString | |||||
| // Real terminal processing happens with ringbuffer'ed stream | |||||
| struct IOStreamString : public Stream { | |||||
| StreamString in; | |||||
| StreamString out; | |||||
| size_t write(uint8_t ch) final override { | |||||
| return in.write(ch); | |||||
| } | |||||
| int read() final override { | |||||
| return out.read(); | |||||
| } | |||||
| int available() final override { | |||||
| return out.available(); | |||||
| } | |||||
| int peek() final override { | |||||
| return out.peek(); | |||||
| } | |||||
| void flush() final override { | |||||
| out.flush(); | |||||
| } | |||||
| }; | |||||
| // We need to make sure that our changes to split_args actually worked | |||||
| void test_hex_codes() { | |||||
| static bool abc_done = false; | |||||
| terminal::Terminal::addCommand("abc", [](const terminal::CommandContext& ctx) { | |||||
| TEST_ASSERT_EQUAL(2, ctx.argc); | |||||
| TEST_ASSERT_EQUAL_STRING("abc", ctx.argv[0].c_str()); | |||||
| TEST_ASSERT_EQUAL_STRING("abc", ctx.argv[1].c_str()); | |||||
| abc_done = true; | |||||
| }); | |||||
| IOStreamString str; | |||||
| str.out += String("abc \"\x61\x62\x63\"\r\n"); | |||||
| terminal::Terminal handler(str); | |||||
| TEST_ASSERT_EQUAL( | |||||
| terminal::Terminal::Result::Command, | |||||
| handler.processLine() | |||||
| ); | |||||
| TEST_ASSERT(abc_done); | |||||
| } | |||||
| // Ensure that we can register multiple commands (at least 3, might want to test much more in the future?) | |||||
| // Ensure that registered commands can be called and they are called in order | |||||
| void test_multiple_commands() { | |||||
| // set up counter to be chained between commands | |||||
| static int command_calls = 0; | |||||
| terminal::Terminal::addCommand("test1", [](const terminal::CommandContext& ctx) { | |||||
| TEST_ASSERT_EQUAL_MESSAGE(1, ctx.argc, "Command without args should have argc == 1"); | |||||
| TEST_ASSERT_EQUAL(0, command_calls); | |||||
| command_calls = 1; | |||||
| }); | |||||
| terminal::Terminal::addCommand("test2", [](const terminal::CommandContext& ctx) { | |||||
| TEST_ASSERT_EQUAL_MESSAGE(1, ctx.argc, "Command without args should have argc == 1"); | |||||
| TEST_ASSERT_EQUAL(1, command_calls); | |||||
| command_calls = 2; | |||||
| }); | |||||
| terminal::Terminal::addCommand("test3", [](const terminal::CommandContext& ctx) { | |||||
| TEST_ASSERT_EQUAL_MESSAGE(1, ctx.argc, "Command without args should have argc == 1"); | |||||
| TEST_ASSERT_EQUAL(2, command_calls); | |||||
| command_calls = 3; | |||||
| }); | |||||
| IOStreamString str; | |||||
| str.out += String("test1\r\ntest2\r\ntest3\r\n"); | |||||
| terminal::Terminal handler(str); | |||||
| // each processing step only executes a single command | |||||
| static int process_counter = 0; | |||||
| handler.process([](terminal::Terminal::Result result) -> bool { | |||||
| if (process_counter == 3) { | |||||
| TEST_ASSERT_EQUAL(result, terminal::Terminal::Result::NoInput); | |||||
| return false; | |||||
| } else { | |||||
| TEST_ASSERT_EQUAL(result, terminal::Terminal::Result::Command); | |||||
| ++process_counter; | |||||
| return true; | |||||
| } | |||||
| TEST_FAIL_MESSAGE("Should not be reached"); | |||||
| return false; | |||||
| }); | |||||
| TEST_ASSERT_EQUAL(3, command_calls); | |||||
| TEST_ASSERT_EQUAL(3, process_counter); | |||||
| } | |||||
| void test_command() { | |||||
| static int counter = 0; | |||||
| terminal::Terminal::addCommand("test.command", [](const terminal::CommandContext& ctx) { | |||||
| TEST_ASSERT_EQUAL_MESSAGE(1, ctx.argc, "Command without args should have argc == 1"); | |||||
| ++counter; | |||||
| }); | |||||
| IOStreamString str; | |||||
| terminal::Terminal handler(str); | |||||
| TEST_ASSERT_EQUAL_MESSAGE( | |||||
| terminal::Terminal::Result::NoInput, handler.processLine(), | |||||
| "We have not read anything yet" | |||||
| ); | |||||
| str.out += String("test.command\r\n"); | |||||
| TEST_ASSERT_EQUAL(terminal::Terminal::Result::Command, handler.processLine()); | |||||
| TEST_ASSERT_EQUAL_MESSAGE(1, counter, "At this time `test.command` was called just once"); | |||||
| str.out += String("test.command"); | |||||
| TEST_ASSERT_EQUAL(terminal::Terminal::Result::Pending, handler.processLine()); | |||||
| TEST_ASSERT_EQUAL_MESSAGE(1, counter, "We are waiting for either \\r\\n or \\n, handler still has data buffered"); | |||||
| str.out += String("\r\n"); | |||||
| TEST_ASSERT_EQUAL(terminal::Terminal::Result::Command, handler.processLine()); | |||||
| TEST_ASSERT_EQUAL_MESSAGE(2, counter, "We should call `test.command` the second time"); | |||||
| str.out += String("test.command\n"); | |||||
| TEST_ASSERT_EQUAL(terminal::Terminal::Result::Command, handler.processLine()); | |||||
| TEST_ASSERT_EQUAL_MESSAGE(3, counter, "We should call `test.command` the third time, with just LF"); | |||||
| } | |||||
| // Ensure that we can properly handle arguments | |||||
| void test_command_args() { | |||||
| static bool waiting = false; | |||||
| terminal::Terminal::addCommand("test.command.arg1", [](const terminal::CommandContext& ctx) { | |||||
| TEST_ASSERT_EQUAL(2, ctx.argc); | |||||
| waiting = false; | |||||
| }); | |||||
| terminal::Terminal::addCommand("test.command.arg1_empty", [](const terminal::CommandContext& ctx) { | |||||
| TEST_ASSERT_EQUAL(2, ctx.argc); | |||||
| TEST_ASSERT(!ctx.argv[1].length()); | |||||
| waiting = false; | |||||
| }); | |||||
| IOStreamString str; | |||||
| terminal::Terminal handler(str); | |||||
| waiting = true; | |||||
| str.out += String("test.command.arg1 test\r\n"); | |||||
| TEST_ASSERT_EQUAL(terminal::Terminal::Result::Command, handler.processLine()); | |||||
| TEST_ASSERT(!waiting); | |||||
| waiting = true; | |||||
| str.out += String("test.command.arg1_empty \"\"\r\n"); | |||||
| TEST_ASSERT_EQUAL(terminal::Terminal::Result::Command, handler.processLine()); | |||||
| TEST_ASSERT(!waiting); | |||||
| } | |||||
| // Ensure that we return error when nothing was handled, but we kept feeding the processLine() with data | |||||
| void test_buffer() { | |||||
| IOStreamString str; | |||||
| str.out += String("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\r\n"); | |||||
| terminal::Terminal handler(str, str.out.available() - 8); | |||||
| TEST_ASSERT_EQUAL(terminal::Terminal::Result::BufferOverflow, handler.processLine()); | |||||
| } | |||||
| // sdssplitargs returns nullptr when quotes are not terminated and empty char for an empty string. we treat it all the same | |||||
| void test_quotes() { | |||||
| terminal::Terminal::addCommand("test.quotes", [](const terminal::CommandContext& ctx) { | |||||
| for (auto& arg : ctx.argv) { | |||||
| TEST_MESSAGE(arg.c_str()); | |||||
| } | |||||
| TEST_FAIL_MESSAGE("`test.quotes` should not be called"); | |||||
| }); | |||||
| IOStreamString str; | |||||
| terminal::Terminal handler(str); | |||||
| str.out += String("test.quotes \"quote without a pair\r\n"); | |||||
| TEST_ASSERT_EQUAL(terminal::Terminal::Result::NoInput, handler.processLine()); | |||||
| str.out += String("test.quotes 'quote without a pair\r\n"); | |||||
| TEST_ASSERT_EQUAL(terminal::Terminal::Result::NoInput, handler.processLine()); | |||||
| TEST_ASSERT_EQUAL(terminal::Terminal::Result::NoInput, handler.processLine()); | |||||
| } | |||||
| // we specify that commands lowercase == UPPERCASE, both with hashed values and with equality functions | |||||
| // (internal note: we use std::unordered_map at this time) | |||||
| void test_case_insensitive() { | |||||
| terminal::Terminal::addCommand("test.lowercase1", [](const terminal::CommandContext& ctx) { | |||||
| __asm__ volatile ("nop"); | |||||
| }); | |||||
| terminal::Terminal::addCommand("TEST.LOWERCASE1", [](const terminal::CommandContext& ctx) { | |||||
| TEST_FAIL_MESSAGE("`test.lowercase1` was already registered, this should not be registered / called"); | |||||
| }); | |||||
| IOStreamString str; | |||||
| terminal::Terminal handler(str); | |||||
| str.out += String("TeSt.lOwErCaSe1\r\n"); | |||||
| TEST_ASSERT_EQUAL(terminal::Terminal::Result::Command, handler.processLine()); | |||||
| } | |||||
| // We can use command ctx.output to send something back into the stream | |||||
| void test_output() { | |||||
| terminal::Terminal::addCommand("test.output", [](const terminal::CommandContext& ctx) { | |||||
| if (ctx.argc != 2) return; | |||||
| ctx.output.print(ctx.argv[1]); | |||||
| }); | |||||
| IOStreamString str; | |||||
| terminal::Terminal handler(str); | |||||
| char match[] = "test1234567890"; | |||||
| str.out += String("test.output ") + String(match) + String("\r\n"); | |||||
| TEST_ASSERT_EQUAL(terminal::Terminal::Result::Command, handler.processLine()); | |||||
| TEST_ASSERT_EQUAL_STRING(match, str.in.c_str()); | |||||
| } | |||||
| // When adding test functions, don't forget to add RUN_TEST(...) in the main() | |||||
| int main(int argc, char** argv) { | |||||
| UNITY_BEGIN(); | |||||
| RUN_TEST(test_command); | |||||
| RUN_TEST(test_command_args); | |||||
| RUN_TEST(test_multiple_commands); | |||||
| RUN_TEST(test_hex_codes); | |||||
| RUN_TEST(test_buffer); | |||||
| RUN_TEST(test_quotes); | |||||
| RUN_TEST(test_case_insensitive); | |||||
| RUN_TEST(test_output); | |||||
| UNITY_END(); | |||||
| } | |||||