驗證節點說明

智慧設備順序控制系統共用骨架文件

返回首頁

驗證節點說明

驗證節點用於讓專案在完成一個可驗收功能後,能清楚呈現「實際效果怎麼樣」。

它不是每次修改都要做的例行檢查,而是在功能已經形成可觀察結果時才執行。

目的

什麼時候需要驗證節點

情境範例
狀態機完成驗證 completed 不可回到 running
Workflow 規則完成驗證起始節點不存在、重複 NodeId、NextNodeId 不存在會被擋下
Adapter 行為完成驗證未設定命令會回傳標準錯誤
ConsoleHost 代表流程完成驗證燈號導引 + Sensor 驗證流程實際輸出
Log 行為完成驗證 TaskId、NodeId、Status、ErrorCode 是否真的被記錄
Config 載入完成驗證缺少必要欄位時會回傳可讀錯誤
文件網站完成驗證線上頁面、手機版、PDF 實際呈現

什麼時候不需要完整驗證節點

情境處理方式
註解補充簡短說明已檢查編譯與 XML 註解
README 小修簡短說明檔案已更新
樣式微調若不影響主要閱讀或流程,可只做局部頁面檢查
文件文字修正簡短檢查無亂碼即可

驗證節點回報格式

驗證節點:

目的:

驗證方式:

實際結果:

是否符合預期:

發現問題或限制:

建議下一步:

範例:狀態機驗證節點

項目內容
驗證節點TaskStateMachine 狀態轉換
目的確認任務不可從完成狀態回到執行狀態
驗證方式執行 dotnet test 中的 TaskStateMachineTests
實際結果Created -> Queued -> Running -> Completed 成功,Completed -> Running 被拒絕
是否符合預期符合
發現問題或限制目前尚未實作取消流程的完整測試
建議下一步補上 CancelledPaused 的驗證案例

範例:Workflow 驗證節點

項目內容
驗證節點WorkflowDefinition.Validate
目的確認 Workflow 定義錯誤能在執行前被擋下
驗證方式執行 dotnet test 中的 WorkflowDefinitionTests
實際結果可抓出空節點、起始節點不存在、下一節點不存在、NodeId 重複、CommandName 空白
是否符合預期符合
發現問題或限制尚未加入 FailNextNodeId 與條件分支驗證
建議下一步建立 workflows.json 範例後,讓 Config Validator 共用同一套規則