Files
secs-gem/tests/test_loader.cpp
raphael 90c177b7ce E40 Process Jobs + E94 Control Jobs + E30 communication state
GEM300 layer: SEMI E40-0705 Process Job and E94-0705 Control Job
state machines, plus the E30 §6.1 communication-state machine that
sits between HSMS SELECT and full GEM communication. Data-driven
via data/process_job_state.yaml and data/control_job_state.yaml,
mirroring the existing control_state.yaml pattern.

Wire coverage:
  S14F9/F10   CreateObject (CJ)              host -> equipment
  S14F11/F12  DeleteObject (CJ)              host -> equipment
  S16F5/F6    PRJobCommand                   host -> equipment
  S16F9       PRJobAlert                     equipment -> host
  S16F11/F12  PRJobCreate (simplified body)  host -> equipment
  S16F13/F14  PRJobDequeue                   host -> equipment
  S16F27/F28  CJobCommand                    host -> equipment

Process Job FSM exposes 8 states matching PRJOBSTATE bytes (E40 §10.3.2);
HOQ is reorder-aware (move-to-head against an insertion-order vector);
Stop/Abort on a Queued PJ routes through ABORTING so the host observes
PRJOBSTATE=7 on the wire (§6.3); alert_enabled is settable per-PJ for
PRALERT control; FSM dispatches through ProcessJobStore::on_change_
dynamically so a late set_state_change_handler() reaches existing PJs.

Hardening: loader rejects NoState (sentinel) as initial/from/to and
rejects `on: created` rows; static_asserts pin enum values to wire
bytes; ProcessJobStore is non-movable to keep the per-PJ this-capture
safe.

Server simulator cascades the full CJ -> PJ lifecycle on CJSTART so
the wire trace exercises every legal state. CEIDs 400/401 fire on CJ
state changes via the existing event-report pipeline.

Tests: 60+ new assertions across test_process_jobs, test_control_jobs,
test_communication_state, test_hsms_connection, plus loader and
messages round-trip coverage.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-06-07 21:00:32 +02:00

147 lines
5.4 KiB
C++

#include <doctest/doctest.h>
#include <fstream>
#include <string>
#include "secsgem/config/loader.hpp"
#include "secsgem/secs2/item.hpp"
using namespace secsgem;
namespace gem = secsgem::gem;
namespace s2 = secsgem::secs2;
#ifndef SECSGEM_DATA_DIR
#error "SECSGEM_DATA_DIR not defined; see CMakeLists.txt"
#endif
TEST_CASE("control_state.yaml parses into the same shape as default_table()") {
auto cfg = config::load_control_state(SECSGEM_DATA_DIR "/control_state.yaml");
auto baseline = gem::ControlTransitionTable::default_table();
CHECK(cfg.initial == gem::ControlState::HostOffline);
// Same row count; same (from, on) pairs map to the same destination.
CHECK(cfg.table.size() == baseline.size());
for (const auto& r : baseline.rows()) {
const auto* loaded = cfg.table.find(r.from, r.on);
REQUIRE(loaded != nullptr);
CHECK(loaded->to == r.to);
CHECK(loaded->then == r.then);
CHECK(loaded->ack_code == r.ack_code);
}
}
TEST_CASE("equipment.yaml populates SVIDs, ECIDs, CEIDs, alarms, recipes, commands") {
gem::EquipmentDataModel m;
auto desc = config::load_equipment(SECSGEM_DATA_DIR "/equipment.yaml", m);
CHECK(desc.model_name == "SECSGEM-SIM");
CHECK(desc.software_rev == "0.1.0");
REQUIRE(desc.emit_on_control_change.has_value());
CHECK(*desc.emit_on_control_change == 100);
CHECK(m.svids.all().size() == 3);
CHECK(m.svids.get(1)->name == "ControlState");
CHECK(m.svids.get(3)->value == s2::Item::boolean(true));
CHECK(m.ecids.all().size() == 2);
CHECK(m.ecids.get(10)->value == s2::Item::u4(uint32_t{1}));
CHECK(m.events.all_events().size() >= 3);
CHECK(m.events.has_event(100));
CHECK(m.events.has_event(300));
CHECK(m.events.has_event(400)); // E94 CJ Executing
CHECK(m.events.has_event(401)); // E94 CJ Completed
CHECK(m.alarms.all().size() == 2);
CHECK(m.alarms.get(1)->text == "Chiller Temp High");
CHECK(m.alarms.get(1)->severity_category == 4);
CHECK(m.recipes.list().size() == 2);
CHECK(m.recipes.get("RECIPE-A").value().find("CHAMBER ARGON") != std::string::npos);
CHECK(m.commands.has("START"));
auto start = m.commands.dispatch("START", {});
CHECK(start.ack == gem::HostCmdAck::Accept);
CHECK(start.emit_ceid.value_or(0) == 300);
auto fault = m.commands.dispatch("FAULT", {});
CHECK(fault.set_alarm.value_or(0) == 1);
// Spool config loaded from YAML.
CHECK(m.spool.is_stream_spoolable(5));
CHECK(m.spool.is_stream_spoolable(6));
CHECK_FALSE(m.spool.is_stream_spoolable(1));
CHECK(m.spool.max_size() == 100);
// force_spool flag plumbed from YAML through CommandSpec.
auto on = m.commands.dispatch("SPOOL_ON", {});
auto off = m.commands.dispatch("SPOOL_OFF", {});
REQUIRE(on.force_spool.has_value());
CHECK(*on.force_spool == true);
REQUIRE(off.force_spool.has_value());
CHECK(*off.force_spool == false);
// Capabilities + equipment_type loaded for S1F20.
CHECK(desc.equipment_type == "EQUIPMENT");
REQUIRE(desc.capabilities.size() >= 5);
bool saw_spooling = false;
for (const auto& [code, name] : desc.capabilities) {
if (code == 14) saw_spooling = true;
}
CHECK(saw_spooling);
// DVIDs loaded for S1F22.
CHECK(m.dvids.all().size() == 2);
CHECK(m.dvids.get(100)->name == "WaferCounter");
CHECK(m.dvids.get(101)->units == "Torr");
}
TEST_CASE("loader surfaces YAML errors with file path") {
CHECK_THROWS_AS(config::load_equipment("/tmp/does-not-exist.yaml", *new gem::EquipmentDataModel),
config::ConfigError);
}
TEST_CASE("loader: process_job_state.yaml -> non-empty table") {
auto cfg = config::load_process_job_state(
std::string(SECSGEM_DATA_DIR) + "/process_job_state.yaml");
CHECK(cfg.initial == gem::ProcessJobState::Queued);
CHECK(cfg.table.size() >= 18);
// Spot-check: Queued + Select -> SettingUp.
const auto* row = cfg.table.find(gem::ProcessJobState::Queued,
gem::ProcessJobEvent::Select);
REQUIRE(row != nullptr);
REQUIRE(row->to.has_value());
CHECK(*row->to == gem::ProcessJobState::SettingUp);
}
TEST_CASE("loader: NoState rejected in PJ state table") {
const std::string path = "/tmp/pj_nostate.yaml";
std::ofstream(path) << "initial: NoState\ntransitions: []\n";
CHECK_THROWS_AS(config::load_process_job_state(path), config::ConfigError);
std::ofstream(path) << "initial: Queued\ntransitions:\n"
<< " - {from: NoState, on: select, to: SettingUp}\n";
CHECK_THROWS_AS(config::load_process_job_state(path), config::ConfigError);
std::ofstream(path) << "initial: Queued\ntransitions:\n"
<< " - {from: Queued, on: select, to: NoState}\n";
CHECK_THROWS_AS(config::load_process_job_state(path), config::ConfigError);
// `created` is the synthetic observer event — never legal in the table.
std::ofstream(path) << "initial: Queued\ntransitions:\n"
<< " - {from: Queued, on: created, to: SettingUp}\n";
CHECK_THROWS_AS(config::load_process_job_state(path), config::ConfigError);
}
TEST_CASE("loader: control_job_state.yaml -> non-empty table") {
auto cfg = config::load_control_job_state(
std::string(SECSGEM_DATA_DIR) + "/control_job_state.yaml");
CHECK(cfg.initial == gem::ControlJobState::Queued);
CHECK(cfg.table.size() >= 18);
const auto* row = cfg.table.find(gem::ControlJobState::Executing,
gem::ControlJobEvent::AllJobsComplete);
REQUIRE(row != nullptr);
REQUIRE(row->to.has_value());
CHECK(*row->to == gem::ControlJobState::Completed);
}