secs-gem/tests/test_secsi_timers.cpp

// SECS-I FSM timer firing tests.
//
// The existing test_secsi.cpp covered T2 in the send direction.  This
// file fills in:
//
//   T1 inter-character — fires while RecvBlock is mid-buffer, aborts.
//   T2 protocol        — fires while in receive states (RecvEotSent or
//                        RecvBlock), aborts.
//   T3 / T4            — documented as upper-layer-driven; the FSM is
//                        a no-op on those, asserted here so a future
//                        commit that adds in-FSM enforcement breaks
//                        this test loudly.

#include <doctest/doctest.h>

#include <algorithm>
#include <variant>
#include <vector>

#include "secsgem/secsi/block.hpp"
#include "secsgem/secsi/protocol.hpp"

using namespace secsgem::secsi;

namespace {

bool has_abort(const std::vector<Action>& out) {
  return std::any_of(out.begin(), out.end(), [](const Action& a) {
    return std::holds_alternative<ActionRaiseError>(a);
  });
}

// Drive the FSM into RecvBlock by simulating "peer sends ENQ, then a
// length byte (say 3), then nothing further".
void drive_into_recv_block(Protocol& p, std::vector<Action>& out) {
  p.on_event(EventByte{kENQ}, out);
  REQUIRE(p.state() == Protocol::State::RecvEotSent);
  out.clear();
  // Now feed the length byte — FSM moves into RecvBlock.
  p.on_event(EventByte{3}, out);
  REQUIRE(p.state() == Protocol::State::RecvBlock);
  out.clear();
  // One more byte: still in RecvBlock since recv_expected_ = 1 + 3 + 2 = 6.
  p.on_event(EventByte{0xAA}, out);
  REQUIRE(p.state() == Protocol::State::RecvBlock);
  out.clear();
}

}  // namespace

TEST_CASE("SECS-I T1: inter-character timeout in RecvBlock aborts") {
  Protocol p(Role::Master);
  std::vector<Action> out;

  drive_into_recv_block(p, out);

  p.on_event(EventTimeout{Timer::T1}, out);
  CHECK(p.state() == Protocol::State::Idle);
  CHECK(has_abort(out));
  // The abort reason should mention T1 so operators can grep logs for it.
  bool t1_mentioned = std::any_of(out.begin(), out.end(), [](const Action& a) {
    auto* err = std::get_if<ActionRaiseError>(&a);
    return err && err->reason.find("T1") != std::string::npos;
  });
  CHECK(t1_mentioned);
}

TEST_CASE("SECS-I T1: ignored outside RecvBlock") {
  Protocol p(Role::Master);
  std::vector<Action> out;
  CHECK(p.state() == Protocol::State::Idle);
  p.on_event(EventTimeout{Timer::T1}, out);
  CHECK(p.state() == Protocol::State::Idle);
  CHECK_FALSE(has_abort(out));
}

TEST_CASE("SECS-I T2: timeout in RecvEotSent aborts") {
  Protocol p(Role::Master);
  std::vector<Action> out;

  p.on_event(EventByte{kENQ}, out);
  REQUIRE(p.state() == Protocol::State::RecvEotSent);
  out.clear();

  p.on_event(EventTimeout{Timer::T2}, out);
  CHECK(p.state() == Protocol::State::Idle);
  CHECK(has_abort(out));
}

TEST_CASE("SECS-I T2: timeout in RecvBlock aborts (mid-block stall)") {
  Protocol p(Role::Master);
  std::vector<Action> out;
  drive_into_recv_block(p, out);

  p.on_event(EventTimeout{Timer::T2}, out);
  CHECK(p.state() == Protocol::State::Idle);
  CHECK(has_abort(out));
}

TEST_CASE("SECS-I T3 / T4: FSM-level no-ops (upper layer enforces)") {
  // The protocol docs in protocol.hpp note T3 (reply) and T4 (inter-block)
  // are driven from the higher SECS-II / message layer.  If a future
  // commit adds in-FSM handling for either, this test will break and
  // the documentation should be updated alongside.
  Protocol p(Role::Master);
  std::vector<Action> out;
  p.on_event(EventTimeout{Timer::T3}, out);
  CHECK(p.state() == Protocol::State::Idle);
  CHECK(out.empty());
  p.on_event(EventTimeout{Timer::T4}, out);
  CHECK(p.state() == Protocol::State::Idle);
  CHECK(out.empty());
}

TEST_CASE("SECS-I T2: in send state retries (existing) AND in recv state aborts (new)") {
  // Round-trip the existing T2-send-retry to keep the contrast obvious:
  // T2 in send → retry, T2 in recv → abort.  Same timer, different
  // recovery strategy depending on which half of the protocol is
  // active.
  Block blk;
  blk.header.stream = 1;
  blk.header.function = 1;
  blk.header.block_number = 1;
  blk.header.end_block = true;
  blk.header.w_bit = true;

  Protocol sender(Role::Master);
  std::vector<Action> out;
  sender.on_event(EventSend{blk}, out);
  REQUIRE(sender.state() == Protocol::State::SendEnqSent);
  const auto rty_before = sender.rty_remaining();
  out.clear();
  sender.on_event(EventTimeout{Timer::T2}, out);
  CHECK(sender.state() == Protocol::State::SendEnqSent);
  CHECK(sender.rty_remaining() == rty_before - 1);

  // Now the receive side: T2 there *aborts* instead of retrying.
  Protocol receiver(Role::Master);
  out.clear();
  receiver.on_event(EventByte{kENQ}, out);
  REQUIRE(receiver.state() == Protocol::State::RecvEotSent);
  out.clear();
  receiver.on_event(EventTimeout{Timer::T2}, out);
  CHECK(receiver.state() == Protocol::State::Idle);
  CHECK(has_abort(out));
}