Protect ESP32 HWCDC console sessions
This commit is contained in:
1 parent
36435b450f
commit
b724d19d6f
18 files changed
+196
-104
No files matched your search
@@ -24,6 +24,7 @@ HARNESS = r'''
|
||||
#include <cstdint>
|
||||
#include <helpers/FileRead.h>
|
||||
#define MESH_ESP32_TINYUSB_NONBLOCKING 1
|
||||
#define MESH_ESP32_USB_CONSOLE_COOPERATIVE 1
|
||||
#define MAX_ROUTE_HASH_BYTES 3
|
||||
#define PACKET_LOG_FILE "/packet_log"
|
||||
static void require(bool ok, const char* what) {
|
||||
@@ -248,7 +249,7 @@ class CooperativeOutputTest(unittest.TestCase):
|
||||
with self.subTest(role=role), tempfile.TemporaryDirectory() as temporary:
|
||||
text = (ROOT / f"examples/{role}/MyMesh.cpp").read_text()
|
||||
dump_start = text.index("void MyMesh::dumpLogFile()")
|
||||
dump_end = text.index("\n#if MESH_ESP32_TINYUSB_NONBLOCKING\nbool MyMesh::hasPendingSerialOutput", dump_start)
|
||||
dump_end = text.index("\n#if MESH_ESP32_USB_CONSOLE_COOPERATIVE\nbool MyMesh::hasPendingSerialOutput", dump_start)
|
||||
pump_start = text.index("bool MyMesh::hasPendingSerialOutput()", dump_end)
|
||||
pump_end = text.index("\n#endif", pump_start)
|
||||
methods = text[dump_start:dump_end] + "\n" + text[pump_start:pump_end]
|
||||
|
||||
@@ -18,13 +18,17 @@ class Esp32TinyUsbNonblockingTest(unittest.TestCase):
|
||||
if compiler is None:
|
||||
self.skipTest("a host C++17 compiler is required")
|
||||
with tempfile.TemporaryDirectory(prefix=".tmp-usb-mode0-", dir=ROOT) as temporary:
|
||||
for mode, companion in ((0, False), (0, True), (1, False)):
|
||||
with self.subTest(usb_mode=mode, companion=companion):
|
||||
for mode, companion, cdc_on_boot in (
|
||||
(0, False, 1), (0, True, 1), (1, False, 0)
|
||||
):
|
||||
with self.subTest(usb_mode=mode, companion=companion,
|
||||
cdc_on_boot=cdc_on_boot):
|
||||
binary = Path(temporary) / f"usb-mode-{mode}-{companion}.exe"
|
||||
command = [
|
||||
compiler, "-std=c++17", "-DARDUINO=1", "-DESP32=1",
|
||||
"-DESP32_PLATFORM=1", "-DMESH_DEBUG=1",
|
||||
"-DARDUINO_USB_CDC_ON_BOOT=1", f"-DARDUINO_USB_MODE={mode}",
|
||||
f"-DARDUINO_USB_CDC_ON_BOOT={cdc_on_boot}",
|
||||
f"-DARDUINO_USB_MODE={mode}",
|
||||
f"-I{FIXTURE / 'mocks'}", f"-I{ROOT / 'src'}",
|
||||
str(FIXTURE / "test_esp32_tinyusb_nonblocking.cpp"),
|
||||
str(ROOT / "src/helpers/UsbLogging.cpp"),
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Keep native-TinyUSB repeater/room output away from blocking Arduino writes."""
|
||||
"""Keep ESP32 native-USB role output away from blocking Arduino writes."""
|
||||
|
||||
from pathlib import Path
|
||||
import re
|
||||
@@ -22,6 +22,8 @@ class Esp32TinyUsbRoleHygieneTest(unittest.TestCase):
|
||||
r"Stream& usbConsolePort\(\)\s*\{\s*"
|
||||
r"#if MESH_ESP32_TINYUSB_NONBLOCKING\s+"
|
||||
r"return buffered_esp32_tinyusb_terminal_port;\s+"
|
||||
r"#elif MESH_ESP32_HWCDC_SESSION_GUARD\s+"
|
||||
r"return guarded_esp32_hwcdc_port;\s+"
|
||||
r"#else\s+return Serial;\s+#endif",
|
||||
)
|
||||
|
||||
@@ -98,14 +100,49 @@ class Esp32TinyUsbRoleHygieneTest(unittest.TestCase):
|
||||
text = source(f"examples/{role}/main.cpp")
|
||||
setup = text[text.index("void setup()") : text.index("void loop()")]
|
||||
loop = text[text.index("void loop()") :]
|
||||
self.assertLess(
|
||||
setup.index("mesh::prepareUsbLoggingPort();"),
|
||||
setup.index("Serial.begin(115200);"),
|
||||
)
|
||||
self.assertIn("mesh::beginUsbLoggingPort();", setup)
|
||||
self.assertIn("mesh::serviceUsbTerminalPort();", loop)
|
||||
|
||||
def test_sensor_uses_the_same_guarded_console_lifecycle(self):
|
||||
main = source("examples/simple_sensor/main.cpp")
|
||||
sensor = source("examples/simple_sensor/SensorMesh.cpp")
|
||||
setup = main[main.index("void setup()") : main.index("void loop()")]
|
||||
loop = main[main.index("void loop()") :]
|
||||
self.assertLess(
|
||||
setup.index("mesh::prepareUsbLoggingPort();"),
|
||||
setup.index("Serial.begin(115200);"),
|
||||
)
|
||||
self.assertIn("mesh::beginUsbLoggingPort();", setup)
|
||||
self.assertIn("mesh::takeUsbTerminalSessionReset()", loop)
|
||||
self.assertIn("mesh::tryCompleteUsbTerminalSessionReset()", loop)
|
||||
self.assertIn("mesh::canAcceptUsbConsoleCommand()", loop)
|
||||
for text in (main, sensor):
|
||||
self.assertNotRegex(
|
||||
text,
|
||||
r"\bSerial\s*\.\s*(?:print|println|printf|write|flush|available|read|peek)\s*\(",
|
||||
)
|
||||
self.assertNotRegex(text, r"\bprintHex\s*\(\s*Serial\b")
|
||||
self.assertIn("mesh::usbConsolePort()", main)
|
||||
self.assertIn("mesh::usbConsolePort()", sensor)
|
||||
|
||||
def test_hwcdc_guard_is_not_limited_to_companion_builds(self):
|
||||
header = source("src/helpers/UsbLogging.h")
|
||||
start = header.index("#if defined(ESP32) && defined(ARDUINO_USB_MODE)",
|
||||
header.index("MESH_ESP32_HWCDC_SESSION_GUARD") - 300)
|
||||
end = header.index("#if MESH_ESP32_TINYUSB_NONBLOCKING", start)
|
||||
guard = header[start:end]
|
||||
self.assertIn("ARDUINO_USB_MODE == 1", guard)
|
||||
self.assertNotIn("ENABLE_USB_INTERFACE", guard)
|
||||
|
||||
def test_sleep_keeps_raw_flush_only_for_other_esp32_transports(self):
|
||||
text = source("src/helpers/ESP32Board.cpp")
|
||||
sleep = text[text.index("void ESP32Board::enterDeepSleep(") :]
|
||||
guard = re.search(
|
||||
r"#if MESH_ESP32_TINYUSB_NONBLOCKING\s+"
|
||||
r"#if MESH_ESP32_USB_CONSOLE_COOPERATIVE\s+"
|
||||
r"mesh::serviceUsbTerminalPort\(\);\s+"
|
||||
r"#else\s+Serial\.flush\(\);\s+#endif",
|
||||
sleep,
|
||||
|
||||
@@ -53,9 +53,9 @@ class Esp32UsbSerialHygieneTest(unittest.TestCase):
|
||||
hwcdc = main[start : main.index("#elif", start)]
|
||||
|
||||
serial_begin = main.index("Serial.begin(115200);")
|
||||
tx_buffer = main.index("Serial.setTxBufferSize(candidate);")
|
||||
prepare = main.index("mesh::prepareUsbLoggingPort();")
|
||||
logging_begin = main.index("mesh::beginUsbLoggingPort();")
|
||||
self.assertLess(tx_buffer, serial_begin)
|
||||
self.assertLess(prepare, serial_begin)
|
||||
self.assertLess(serial_begin, logging_begin)
|
||||
|
||||
self.assertIn("board.isUsbHostConnected()", hwcdc)
|
||||
@@ -151,12 +151,20 @@ class Esp32UsbSerialHygieneTest(unittest.TestCase):
|
||||
self.assertNotIn("Serial.begin(", purge)
|
||||
|
||||
setup = main[main.index("void setup()") : main.index("board.begin();")]
|
||||
self.assertIn("static const size_t usb_tx_sizes[]", setup)
|
||||
self.assertIn("Serial.setTxBufferSize(candidate)", setup)
|
||||
self.assertIn("usb_tx_capacity = Serial.availableForWrite();", setup)
|
||||
self.assertIn(
|
||||
"mesh::setUsbCompanionTxBufferCapacity(usb_tx_capacity)", setup
|
||||
)
|
||||
self.assertIn("mesh::prepareUsbLoggingPort();", setup)
|
||||
prepare_start = logging.index("void prepareUsbLoggingPort()")
|
||||
prepare = logging[prepare_start : logging.index(
|
||||
"void beginUsbLoggingPort()", prepare_start
|
||||
)]
|
||||
self.assertIn("static const size_t usb_tx_sizes[]", prepare)
|
||||
self.assertIn("Serial.setTxBufferSize(candidate)", prepare)
|
||||
self.assertIn("Serial.setTxTimeoutMs(5);", prepare)
|
||||
begin_start = logging.index("void beginUsbLoggingPort()")
|
||||
begin = logging[begin_start : logging.index(
|
||||
"void serviceUsbLoggingPort()", begin_start
|
||||
)]
|
||||
self.assertIn("Serial.availableForWrite()", begin)
|
||||
self.assertIn("setUsbCompanionTxBufferCapacity(", begin)
|
||||
|
||||
debug_start = logging.index(
|
||||
"static void setPlatformDebugOutputEnabled(bool enabled)"
|
||||
@@ -189,9 +197,7 @@ class Esp32UsbSerialHygieneTest(unittest.TestCase):
|
||||
ota_context.index("#ifndef OTA_FOLDER_SERIAL_STREAM") :
|
||||
ota_context.index("#ifndef OTA_FOLDER_SERIAL_BAUD")
|
||||
]
|
||||
self.assertIn("defined(ESP32)", ota_stream)
|
||||
self.assertIn("ARDUINO_USB_MODE == 1", ota_stream)
|
||||
self.assertIn("defined(ENABLE_USB_INTERFACE)", ota_stream)
|
||||
self.assertIn("MESH_ESP32_USB_CONSOLE_COOPERATIVE", ota_stream)
|
||||
self.assertIn("::mesh::usbMotaPort()", ota_stream)
|
||||
|
||||
self.assertIn(
|
||||
|
||||
Reference in new issue
Block a user