[modbus_server] Simplify server response handling (#12376)

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com> Co-authored-by: J. Nick Koston <nick@home-assistant.io> Co-authored-by: J. Nick Koston <nick@koston.org>
2026-09-23 21:14:03 +00:00 · 2026-06-28 19:41:47 +00:00
parent 2f32c88ae5
commit 4ebecf514a
10 changed files with 476 additions and 226 deletions
@@ -0,0 +1,124 @@
+#include <gtest/gtest.h>
+
+#include "esphome/components/modbus_server/modbus_server.h"
+
+namespace esphome::modbus_server {
+
+using modbus::ModbusExceptionCode;
+using modbus::RegisterValues;
+
+namespace {
+
+RegisterValues make_registers(std::initializer_list<uint16_t> values) {
+  RegisterValues registers;
+  for (uint16_t value : values)
+    registers.push_back(value);
+  return registers;
+}
+
+}  // namespace
+
+// A single writable WORD register is applied and the handler reports success (nullopt).
+TEST(ModbusServerWrite, SingleWordSucceeds) {
+  ModbusServer server;
+  int64_t written = -1;
+  ServerRegister reg(0x0000, SensorValueType::U_WORD, 1);
+  reg.write_lambda = [&written](int64_t value) {
+    written = value;
+    return true;
+  };
+  server.add_server_register(&reg);
+
+  auto status = server.on_modbus_write_registers(0x0000, make_registers({0x1234}));
+  EXPECT_FALSE(status.has_value());  // nullopt == success
+  EXPECT_EQ(written, 0x1234);
+}
+
+// A multi-register value is decoded high word first and applied as a single number.
+TEST(ModbusServerWrite, DwordSucceeds) {
+  ModbusServer server;
+  int64_t written = -1;
+  ServerRegister reg(0x0000, SensorValueType::U_DWORD, 2);
+  reg.write_lambda = [&written](int64_t value) {
+    written = value;
+    return true;
+  };
+  server.add_server_register(&reg);
+
+  auto status = server.on_modbus_write_registers(0x0000, make_registers({0x1234, 0x5678}));
+  EXPECT_FALSE(status.has_value());
+  EXPECT_EQ(written, 0x12345678);
+}
+
+// Regression: a request that under-supplies a multi-register value is rejected before any
+// write_lambda runs, so no register is partially written.
+TEST(ModbusServerWrite, UnderSuppliedValueAppliesNothing) {
+  ModbusServer server;
+  bool word_written = false;
+  ServerRegister word_reg(0x0000, SensorValueType::U_WORD, 1);
+  word_reg.write_lambda = [&word_written](int64_t) {
+    word_written = true;
+    return true;
+  };
+  bool dword_written = false;
+  ServerRegister dword_reg(0x0001, SensorValueType::U_DWORD, 2);  // needs two registers
+  dword_reg.write_lambda = [&dword_written](int64_t) {
+    dword_written = true;
+    return true;
+  };
+  server.add_server_register(&word_reg);
+  server.add_server_register(&dword_reg);
+
+  // Two words supplied: one for the WORD at 0x0000, but only one of the two the DWORD at 0x0001 needs.
+  auto status = server.on_modbus_write_registers(0x0000, make_registers({0x1111, 0x2222}));
+  ASSERT_TRUE(status.has_value());
+  if (status.has_value())
+    EXPECT_EQ(status.value(), ModbusExceptionCode::ILLEGAL_DATA_VALUE);
+  EXPECT_FALSE(word_written);  // the writable WORD must NOT have been applied
+  EXPECT_FALSE(dword_written);
+}
+
+// A read-only register (no write_lambda) yields ILLEGAL_DATA_ADDRESS and applies nothing.
+TEST(ModbusServerWrite, UnwritableRegisterRejected) {
+  ModbusServer server;
+  ServerRegister read_only(0x0000, SensorValueType::U_WORD, 1);  // no write_lambda set
+  server.add_server_register(&read_only);
+
+  auto status = server.on_modbus_write_registers(0x0000, make_registers({0x1234}));
+  ASSERT_TRUE(status.has_value());
+  if (status.has_value())
+    EXPECT_EQ(status.value(), ModbusExceptionCode::ILLEGAL_DATA_ADDRESS);
+}
+
+// An address with no registered register yields ILLEGAL_DATA_ADDRESS.
+TEST(ModbusServerWrite, UnmatchedAddressRejected) {
+  ModbusServer server;
+  auto status = server.on_modbus_write_registers(0x0005, make_registers({0x1234}));
+  ASSERT_TRUE(status.has_value());
+  if (status.has_value())
+    EXPECT_EQ(status.value(), ModbusExceptionCode::ILLEGAL_DATA_ADDRESS);
+}
+
+// A write_lambda failing at runtime is the one non-atomic case: the earlier register is already
+// applied, and the handler reports SERVICE_DEVICE_FAILURE.
+TEST(ModbusServerWrite, CallbackFailureIsServiceDeviceFailure) {
+  ModbusServer server;
+  bool first_written = false;
+  ServerRegister first(0x0000, SensorValueType::U_WORD, 1);
+  first.write_lambda = [&first_written](int64_t) {
+    first_written = true;
+    return true;
+  };
+  ServerRegister second(0x0001, SensorValueType::U_WORD, 1);
+  second.write_lambda = [](int64_t) { return false; };  // rejects at runtime
+  server.add_server_register(&first);
+  server.add_server_register(&second);
+
+  auto status = server.on_modbus_write_registers(0x0000, make_registers({0xAAAA, 0xBBBB}));
+  ASSERT_TRUE(status.has_value());
+  if (status.has_value())
+    EXPECT_EQ(status.value(), ModbusExceptionCode::SERVICE_DEVICE_FAILURE);
+  EXPECT_TRUE(first_written);  // pre-validation passed, so the first write applied before the failure
+}
+
+}  // namespace esphome::modbus_server