diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Revision history for pms-infra-agent-serial + +## 0.0.1.0 -- 2026-05-31 + +* First version. diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,134 @@ +# pms-infra-agent-serial + +---- +## ⚠️ Caution + +**Do not grant unrestricted control to AI.** + +Unsupervised use or misuse may lead to unintended consequences. +All AI systems must remain strictly under human oversight and control. +Use responsibly, with full awareness and at your own risk. + +---- +## 📘 Overview + +**`pms-infra-agent-serial`** is a Haskell infrastructure library that provides AI agents with direct, low-level control over serial communication endpoints. + +Unlike prompt-oriented serial abstractions, this library exposes raw serial I/O as both UTF-8 strings and byte-level hex strings. This allows agents to handle device-specific protocols, binary command frames, console sessions, and real-time serial monitoring with fine-grained control. + +The library is a core component of the [`pty-mcp-server`](https://github.com/phoityne/pty-mcp-server) ecosystem and implements the `agent-serial-*` family of MCP tools. + +--- + +## 🔧 Provided MCP Tools + +### `agent-serial-open` +Opens a serial port connection for subsequent read/write operations. +Only one serial port connection can be active at a time. + +- `device` — Serial device path (for example `/dev/ttyUSB0` or `COM3`) +- `commSpeed` — Baud rate (for example `9600` or `115200`; default: `9600`) +- `bitsPerWord` — Data bits (`5` to `8`; default: `8`) +- `stopb` — Stop bits (`1` or `2`; default: `1`) +- `parity` — Parity (`NoParity`, `Odd`, or `Even`; default: `NoParity`) +- `flowControl` — Flow control (`NoFlowControl` or `Software`; default: `NoFlowControl`) +- `timeout` — Read timeout in tenths of a second (default: `1`) + +### `agent-serial-close` +Closes the active serial port connection and releases all associated resources. + +### `agent-serial-read` +Reads up to the specified number of bytes from the active serial port and returns the data as a **UTF-8 string**. +Returns an empty string if no data is available before timeout. + +- `size` — Maximum number of bytes to read + +> ⚠️ If the received data contains non-UTF-8 bytes or binary protocol frames, use `agent-serial-read-byte` instead. + +### `agent-serial-read-byte` +Reads up to the specified number of bytes from the active serial port and returns the data as an **uppercase hex string** (e.g., `FF0A1B41`). +Use this for binary protocols or when precise byte-level inspection is required. + +- `size` — Maximum number of bytes to read + +### `agent-serial-write` +Writes the specified **UTF-8 string** to the active serial port. + +- `data` — Text data to write +- `appendNewline` — When omitted or `true`, appends CR+LF automatically. When `false`, sends the string as-is. + +> ⚠️ To send exact byte sequences (for example binary frames, checksums, or explicit CR+LF bytes), use `agent-serial-write-byte`. + +### `agent-serial-write-byte` +Decodes the specified **hex string** and writes the resulting bytes to the active serial port. +Use this for binary protocols or when precise byte-level control is required. + +- `data` — Hex string to decode and write (e.g., `DEADBEEF0D0A`; uppercase and lowercase are accepted) + +--- + +## 💡 Usage Notes + +### Serial protocol handling +Prompt detection, command framing, response parsing, retries, checksums, and other protocol-specific behavior are the **responsibility of the agent**, not the library. +Use `agent-serial-read-byte` and `agent-serial-write-byte` when communicating with devices that require byte-accurate exchanges. + +Example binary command flow: +``` +→ 010300000002C40B (Agent: write Modbus RTU request as bytes) +← 010304000A0014DA3E (Device: response read as bytes) +``` + +Example console flow: +``` +← "login: " (Device prompt — read as UTF-8 string) +→ "admin\r\n" (Username — send with appendNewline or exact bytes) +← "Password: " (Password prompt) +``` + +### Newline behavior +`agent-serial-write` appends CR+LF by default to support common serial-console workflows. +Set `appendNewline` to `false` when the target protocol requires exact text without automatic line endings. + +### Read size limit +Read operations cap the requested size to the internal read buffer size. +For large outputs, poll repeatedly with `agent-serial-read` or `agent-serial-read-byte`. + +--- + +## 🏗️ Architecture + +### Module Structure + +``` +PMS.Infra.Agent.Serial +├── DM.Type -- Data type definitions (AppData, tool parameter types) +├── DM.Constant -- Constants +├── DS.Core -- Core domain service logic +├── DS.Utility -- Utility functions (serial settings, hex decoding, AppContext helpers) +└── App.Control -- Application control: tool dispatch and serial lifecycle management +``` + +### Key Design Points + +- **Single active port**: Only one serial port can be open at a time per server instance. State is managed via `STM.TMVar`. +- **Configurable serial settings**: `agent-serial-open` supports baud rate, data bits, stop bits, parity, flow control, and read timeout. +- **Non-blocking reads**: Read operations return available data within the configured serial timeout, allowing the agent to poll at its own pace. +- **Byte-level I/F**: In addition to UTF-8 string I/F, hex string I/F is provided for binary protocol handling. Device protocol processing is delegated to the agent. + +--- + +## 📦 Dependencies + +- [`pms-domain-model`](https://github.com/phoityne/pms-domain-model) +- [`serialport`](https://hackage.haskell.org/package/serialport) + +--- + +## 📜 Credits & License + +- **Execution & Process Lead:** Claude Sonnet 4.6, Gemini 3 Flash, GPT-5.5 +- **Direction & Policy:** phoityne +- **License:** Apache-2.0 — see [LICENSE](./LICENSE) + +--- diff --git a/pms-infra-agent-serial.cabal b/pms-infra-agent-serial.cabal new file mode 100644 --- /dev/null +++ b/pms-infra-agent-serial.cabal @@ -0,0 +1,148 @@ +cabal-version: 2.4 +-- The cabal-version field refers to the version of the .cabal specification, +-- and can be different from the cabal-install (the tool) version and the +-- Cabal (the library) version you are using. As such, the Cabal (the library) +-- version used must be equal or greater than the version stated in this field. +-- Starting from the specification version 2.2, the cabal-version field must be +-- the first thing in the cabal file. + +-- Initial package description 'pms-infra-agent-serial' generated by +-- 'cabal init'. For further documentation, see: +-- http://haskell.org/cabal/users-guide/ +-- +-- The name of the package. +name: pms-infra-agent-serial + +-- The package version. +-- See the Haskell package versioning policy (PVP) for standards +-- guiding when and how versions should be incremented. +-- https://pvp.haskell.org +-- PVP summary: +-+------- breaking API changes +-- | | +----- non-breaking API additions +-- | | | +--- code changes with no API change +version: 0.0.1.0 + +-- A short (one-line) description of the package. +synopsis: pms-infra-agent-serial + +-- A longer description of the package. +description: README.md + +-- The license under which the package is released. +license: Apache-2.0 + +-- The file containing the license text. +license-file: LICENSE + +-- The package author(s). +author: phoityne.hs@gmail.com + +-- An email address to which users can send suggestions, bug reports, and patches. +maintainer: phoityne.hs@gmail.com + +-- A copyright notice. +copyright: 2025-2026 phoityne.hs@gmail.com +category: AI +build-type: Simple +homepage: https://github.com/phoityne/pms-infra-agent-serial +bug-reports: https://github.com/phoityne/pms-infra-agent-serial/issues + +-- Extra doc files to be distributed with the package, such as a CHANGELOG or a README. +extra-doc-files: README.md, + CHANGELOG.md + +-- Extra source files to be distributed with the package, such as examples, or a tutorial module. +-- extra-source-files: + + +library + -- Import common warning flags. + ghc-options: -Wall -threaded + + -- Modules exported by the library. + exposed-modules: PMS.Infra.Agent.Serial.DM.Type, + PMS.Infra.Agent.Serial.DS.Utility, + PMS.Infra.Agent.Serial.DM.Constant, + PMS.Infra.Agent.Serial.App.Control, + PMS.Infra.Agent.Serial.DS.Core + + -- Modules included in this library but not exported. + -- other-modules: + + -- LANGUAGE extensions used by modules in this package. + -- other-extensions: + + -- Other library packages from which modules are imported. + build-depends: base >= 4.18 && < 5, + data-default, + monad-logger, + mtl, + lens, + text, + safe-exceptions, + fast-logger, + conduit, + bytestring, + transformers, + stm, + async, + process, + filepath, + aeson, + directory, + network, + base16-bytestring, + serialport, + pms-domain-model + + -- Directories containing source files. + hs-source-dirs: src + + -- Base language which the package is written in. + default-language: Haskell2010 + -- default-extensions: LambdaCase + +test-suite pms-infra-agent-serial-test + -- Import common warning flags. + ghc-options: -Wall -threaded + + -- Base language which the package is written in. + default-language: Haskell2010 + + -- Modules included in this executable, other than Main. + other-modules: PMS.Infra.Agent.Serial.App.ControlSpec + + -- LANGUAGE extensions used by modules in this package. + -- other-extensions: + + -- The interface type and version of the test suite. + type: exitcode-stdio-1.0 + + -- Directories containing source files. + hs-source-dirs: test + + -- The entrypoint to the test suite. + main-is: Spec.hs + + -- Test dependencies. + build-depends: base >= 4.18 && < 5, + hspec, + hspec-discover, + data-default, + stm, + monad-logger, + async, + lens, + bytestring, + text, + directory, + network, + fast-logger, + filepath, + serialport, + base16-bytestring, + pms-domain-model, + pms-infra-agent-serial + + build-tool-depends: + hspec-discover:hspec-discover diff --git a/src/PMS/Infra/Agent/Serial/App/Control.hs b/src/PMS/Infra/Agent/Serial/App/Control.hs new file mode 100644 --- /dev/null +++ b/src/PMS/Infra/Agent/Serial/App/Control.hs @@ -0,0 +1,61 @@ +{-# LANGUAGE LambdaCase #-} + +module PMS.Infra.Agent.Serial.App.Control where + +import System.IO +import qualified Control.Exception.Safe as E +import System.Log.FastLogger + +import qualified PMS.Domain.Model.DM.Type as DM +import qualified PMS.Domain.Model.DS.Utility as DM + +import PMS.Infra.Agent.Serial.DM.Type +import PMS.Infra.Agent.Serial.DM.Constant +import PMS.Infra.Agent.Serial.DS.Utility +import PMS.Infra.Agent.Serial.DS.Core + +-- | +-- +run :: DM.DomainContext () +run domDat = do + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Serial.App.Control.run called." + appDat <- defaultAppData + runWithAppData appDat domDat + +-- | +-- +runWithAppData :: AppData -> DM.DomainContext () +runWithAppData appDat domDat = do + logDat <- DM.createLogger domDat _LOG_FILE_NAME + runWithLogger logDat appDat domDat + +-- | +-- +runWithLogger :: (TimedFastLogger, IO ()) -> AppData -> DM.DomainContext () +runWithLogger (logger, finalizeLogger) appDat domDat = + flip E.catchAny exception + $ flip E.finally finalize + $ runApp domDat appDat logger app + >>= \case + Right x -> return x + Left e -> errorEnd e + + where + finalize = do + hPutStrLn stderr "-----------------------------------------------------------------------------" + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Serial.App.Control.run finalize called." + finalizeLogger + hPutStrLn stderr "-----------------------------------------------------------------------------" + + exception e = do + hPutStrLn stderr "-----------------------------------------------------------------------------" + hPutStrLn stderr "[ERROR] PMS.Infra.Agent.Serial.App.Control.run exception occurred." + hPutStrLn stderr $ show e + hPutStrLn stderr "-----------------------------------------------------------------------------" + E.throwIO e + + errorEnd e = do + hPutStrLn stderr "-----------------------------------------------------------------------------" + hPutStrLn stderr "[ERROR] PMS.Infra.Agent.Serial.App.Control.run end with error." + hPutStrLn stderr $ show e + hPutStrLn stderr "-----------------------------------------------------------------------------" diff --git a/src/PMS/Infra/Agent/Serial/DM/Constant.hs b/src/PMS/Infra/Agent/Serial/DM/Constant.hs new file mode 100644 --- /dev/null +++ b/src/PMS/Infra/Agent/Serial/DM/Constant.hs @@ -0,0 +1,18 @@ +module PMS.Infra.Agent.Serial.DM.Constant where + +-------------------------------------------------------------------------------- +-- | +-- +_LOG_FILE_NAME :: String +_LOG_FILE_NAME = "pms-infra-agent-serial.log" + +-- | +-- +_SERIAL_READ_WAIT_MSEC :: Int +_SERIAL_READ_WAIT_MSEC = 100 + +-- | +-- +_READ_BUFFER_SIZE :: Int +_READ_BUFFER_SIZE = 4096 + diff --git a/src/PMS/Infra/Agent/Serial/DM/Type.hs b/src/PMS/Infra/Agent/Serial/DM/Type.hs new file mode 100644 --- /dev/null +++ b/src/PMS/Infra/Agent/Serial/DM/Type.hs @@ -0,0 +1,117 @@ +{-# LANGUAGE TemplateHaskell #-} + +module PMS.Infra.Agent.Serial.DM.Type where + +import Control.Monad.Logger +import Control.Monad.Reader +import Control.Monad.Except +import Control.Lens +import Data.Default +import Data.Aeson.TH +import qualified Control.Concurrent.STM as STM +import System.Hardware.Serialport + +import qualified PMS.Domain.Model.DM.Type as DM +import qualified PMS.Domain.Model.DM.TH as DM + +-- | +-- +data AppData = AppData { + _serialPortAppData :: STM.TMVar (Maybe SerialPort) + } + +makeLenses ''AppData + +defaultAppData :: IO AppData +defaultAppData = do + mgrVar <- STM.newTMVarIO Nothing + return AppData { + _serialPortAppData = mgrVar + } + +-- | +-- +type AppContext = ReaderT AppData (ReaderT DM.DomainData (ExceptT DM.ErrorData (LoggingT IO))) + +-- | +-- +type IOTask = IO + + +-------------------------------------------------------------------------------------------- +-- | +-- +-- | Arguments for agent-serial-write. +-- appendNewline: Nothing or Just True (default) -> apply appendCRLF (auto-append newline). +-- Just False -> send string as-is without any modification. +data SerialWriteToolParams = + SerialWriteToolParams { + _dataSerialWriteToolParams :: String + , _appendNewlineSerialWriteToolParams :: Maybe Bool + } deriving (Show, Read, Eq) + +$(deriveJSON defaultOptions {fieldLabelModifier = DM.dropDataName "SerialWriteToolParams", omitNothingFields = True} ''SerialWriteToolParams) +makeLenses ''SerialWriteToolParams + +instance Default SerialWriteToolParams where + def = SerialWriteToolParams { + _dataSerialWriteToolParams = def + , _appendNewlineSerialWriteToolParams = def + } + +-- | +-- +data SerialIntToolParams = + SerialIntToolParams { + _sizeSerialIntToolParams :: Int + } deriving (Show, Read, Eq) + +$(deriveJSON defaultOptions {fieldLabelModifier = DM.dropDataName "SerialIntToolParams", omitNothingFields = True} ''SerialIntToolParams) +makeLenses ''SerialIntToolParams + +instance Default SerialIntToolParams where + def = SerialIntToolParams { + _sizeSerialIntToolParams = def + } + +-- | +-- +data SerialHexToolParams = + SerialHexToolParams { + _dataSerialHexToolParams :: String -- hex string (e.g. "FF0A1B41") + } deriving (Show, Read, Eq) + +$(deriveJSON defaultOptions {fieldLabelModifier = DM.dropDataName "SerialHexToolParams", omitNothingFields = True} ''SerialHexToolParams) +makeLenses ''SerialHexToolParams + +instance Default SerialHexToolParams where + def = SerialHexToolParams { + _dataSerialHexToolParams = def + } + +-- | +-- +data SerialToolParams = + SerialToolParams { + _deviceSerialToolParams :: String -- ^ Required: device path (e.g. /dev/ttyUSB0, COM3) + , _commSpeedSerialToolParams :: Maybe Int -- ^ Optional: baud rate (e.g. 9600, 115200). Default: 9600 + , _bitsPerWordSerialToolParams :: Maybe Int -- ^ Optional: data bits (5-8). Default: 8 + , _stopbSerialToolParams :: Maybe Int -- ^ Optional: stop bits (1 or 2). Default: 1 + , _paritySerialToolParams :: Maybe String -- ^ Optional: "NoParity"|"Odd"|"Even". Default: "NoParity" + , _flowControlSerialToolParams :: Maybe String -- ^ Optional: "NoFlowControl"|"Software". Default: "NoFlowControl" + , _timeoutSerialToolParams :: Maybe Int -- ^ Optional: timeout in tenths of second. Default: 1 + } deriving (Show, Read, Eq) + +$(deriveJSON defaultOptions {fieldLabelModifier = DM.dropDataName "SerialToolParams", omitNothingFields = True} ''SerialToolParams) +makeLenses ''SerialToolParams + +instance Default SerialToolParams where + def = SerialToolParams { + _deviceSerialToolParams = def + , _commSpeedSerialToolParams = def + , _bitsPerWordSerialToolParams = def + , _stopbSerialToolParams = def + , _paritySerialToolParams = def + , _flowControlSerialToolParams = def + , _timeoutSerialToolParams = def + } diff --git a/src/PMS/Infra/Agent/Serial/DS/Core.hs b/src/PMS/Infra/Agent/Serial/DS/Core.hs new file mode 100644 --- /dev/null +++ b/src/PMS/Infra/Agent/Serial/DS/Core.hs @@ -0,0 +1,378 @@ +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE LambdaCase #-} + +module PMS.Infra.Agent.Serial.DS.Core where + +import System.IO +import System.Hardware.Serialport +import Control.Monad.Logger +import Control.Monad.IO.Class +import Control.Monad.Trans.Class +import Control.Lens +import Control.Monad.Reader +import Control.Concurrent.Async +import qualified Control.Concurrent.STM as STM +import Data.Conduit +import qualified Data.Text as T +import Control.Monad.Except +import qualified Control.Exception.Safe as E +import System.Exit +import Data.Aeson + +import qualified Data.ByteString as BS +import qualified PMS.Domain.Model.DS.Utility as DM +import qualified PMS.Domain.Model.DM.Type as DM +import qualified PMS.Domain.Model.DM.Constant as DM + +import PMS.Infra.Agent.Serial.DM.Type +import PMS.Infra.Agent.Serial.DM.Constant +import PMS.Infra.Agent.Serial.DS.Utility + + +-- | +-- +app :: AppContext () +app = do + $logDebugS DM._LOGTAG "app called." + runConduit pipeline + where + pipeline :: ConduitM () Void AppContext () + pipeline = src .| cmd2task .| sink + +--------------------------------------------------------------------------------- +-- | +-- +src :: ConduitT () DM.AgentSerialCommand AppContext () +src = lift go >>= yield >> src + where + go :: AppContext DM.AgentSerialCommand + go = do + queue <- view DM.agentSerialQueueDomainData <$> lift ask + dat <- liftIO $ STM.atomically $ STM.readTQueue queue + return dat + +--------------------------------------------------------------------------------- +-- | +-- +cmd2task :: ConduitT DM.AgentSerialCommand (IOTask ()) AppContext () +cmd2task = await >>= \case + Just cmd -> flip catchError (errHdl cmd) $ do + lift (go cmd) >>= yield >> cmd2task + Nothing -> do + $logWarnS DM._LOGTAG "cmd2task: await returns nothing. skip." + cmd2task + + where + errHdl :: DM.AgentSerialCommand -> String -> ConduitT DM.AgentSerialCommand (IOTask ()) AppContext () + errHdl serialCmd msg = do + let jsonrpc = DM.getJsonRpcAgentSerialCommand serialCmd + $logWarnS DM._LOGTAG $ T.pack $ "cmd2task: exception occurred. skip. " ++ msg + lift $ errorToolsCallResponse jsonrpc $ "cmd2task: exception occurred. skip. " ++ msg + cmd2task + + go :: DM.AgentSerialCommand -> AppContext (IOTask ()) + go (DM.AgentSerialEchoCommand dat) = genEchoTask dat + go (DM.AgentSerialOpenCommand dat) = genSerialOpenTask dat + go (DM.AgentSerialCloseCommand dat) = genSerialCloseTask dat + go (DM.AgentSerialReadCommand dat) = genSerialReadTask dat + go (DM.AgentSerialWriteCommand dat) = genSerialWriteTask dat + go (DM.AgentSerialReadByteCommand dat) = genSerialReadByteTask dat + go (DM.AgentSerialWriteByteCommand dat) = genSerialWriteByteTask dat + +--------------------------------------------------------------------------------- +-- | +-- +sink :: ConduitT (IOTask ()) Void AppContext () +sink = await >>= \case + Just req -> flip catchError errHdl $ do + lift (go req) >> sink + Nothing -> do + $logWarnS DM._LOGTAG "sink: await returns nothing. skip." + sink + + where + errHdl :: String -> ConduitT (IOTask ()) Void AppContext () + errHdl msg = do + $logWarnS DM._LOGTAG $ T.pack $ "sink: exception occurred. skip. " ++ msg + sink + + go :: (IO ()) -> AppContext () + go task = do + $logDebugS DM._LOGTAG "sink: start async." + _ <- liftIOE $ async task + $logDebugS DM._LOGTAG "sink: end async." + return () + + +--------------------------------------------------------------------------------- +-- | +-- +notImplemented :: String -> DM.JsonRpcRequest -> AppContext (IOTask ()) +notImplemented name jsonRpc = do + resQ <- view DM.responseQueueDomainData <$> lift ask + return $ DM.toolsCallResponse resQ jsonRpc (ExitFailure 1) "" (name ++ ": not implemented yet.") + +--------------------------------------------------------------------------------- +-- | +-- +genEchoTask :: DM.AgentSerialEchoCommandData -> AppContext (IOTask ()) +genEchoTask dat = do + resQ <- view DM.responseQueueDomainData <$> lift ask + let val = dat^.DM.valueAgentSerialEchoCommandData + $logDebugS DM._LOGTAG $ T.pack $ "genEchoTask: echo : " ++ val + return $ echoTask resQ dat val + +-- | +-- +echoTask :: STM.TQueue DM.McpResponse -> DM.AgentSerialEchoCommandData -> String -> IOTask () +echoTask resQ cmdDat val = flip E.catchAny errHdl $ do + hPutStrLn stderr $ "[INFO] PMS.Infra.Agent.Serial.DS.Core.echoTask run. " ++ val + DM.toolsCallResponse resQ (cmdDat^.DM.jsonrpcAgentSerialEchoCommandData) ExitSuccess val "" + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Serial.DS.Core.echoTask end." + where + errHdl :: E.SomeException -> IO () + errHdl e = DM.toolsCallResponse resQ (cmdDat^.DM.jsonrpcAgentSerialEchoCommandData) (ExitFailure 1) "" (show e) + +--------------------------------------------------------------------------------- +-- | +-- +genSerialOpenTask :: DM.AgentSerialOpenCommandData -> AppContext (IOTask ()) +genSerialOpenTask cmdDat = do + let argsBS = DM.unRawJsonByteString $ cmdDat^.DM.argumentsAgentSerialOpenCommandData + resQ <- view DM.responseQueueDomainData <$> lift ask + serialPortTMVar <- view serialPortAppData <$> ask + argsDat <- liftEither $ eitherDecode argsBS + settings <- getSerialSetting argsDat + let device = argsDat^.deviceSerialToolParams + return $ serialOpenTask cmdDat resQ serialPortTMVar device settings + +-- | +-- +serialOpenTask :: DM.AgentSerialOpenCommandData + -> STM.TQueue DM.McpResponse + -> STM.TMVar (Maybe SerialPort) + -> String + -> SerialPortSettings + -> IOTask () +serialOpenTask cmdDat resQ serialPortTMVar device settings = flip E.catchAny errHdl $ do + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Serial.DS.Core.serialOpenTask start." + STM.atomically (STM.takeTMVar serialPortTMVar) >>= \case + Just sp -> do + STM.atomically $ STM.putTMVar serialPortTMVar (Just sp) + hPutStrLn stderr "[ERROR] serialOpenTask: serial is already connected." + DM.toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "serial is already connected." + Nothing -> flip E.catchAny connErrHdl $ do + sp <- openSerial device settings + STM.atomically $ STM.putTMVar serialPortTMVar (Just sp) + DM.toolsCallResponse resQ jsonRpc ExitSuccess ("serial connected to " ++ device) "" + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Serial.DS.Core.serialOpenTask end." + where + jsonRpc = cmdDat^.DM.jsonrpcAgentSerialOpenCommandData + errHdl :: E.SomeException -> IO () + errHdl e = DM.toolsCallResponse resQ jsonRpc (ExitFailure 1) "" (show e) + connErrHdl :: E.SomeException -> IO () + connErrHdl e = do + STM.atomically $ STM.putTMVar serialPortTMVar Nothing + DM.toolsCallResponse resQ jsonRpc (ExitFailure 1) "" (show e) + +--------------------------------------------------------------------------------- +-- | +-- +genSerialCloseTask :: DM.AgentSerialCloseCommandData -> AppContext (IOTask ()) +genSerialCloseTask dat = do + $logDebugS DM._LOGTAG $ T.pack $ "genSerialCloseTask called. " + serialPortTMVar <- view serialPortAppData <$> ask + resQ <- view DM.responseQueueDomainData <$> lift ask + return $ serialCloseTask dat resQ serialPortTMVar + +-- | +-- +serialCloseTask :: DM.AgentSerialCloseCommandData + -> STM.TQueue DM.McpResponse + -> STM.TMVar (Maybe SerialPort) + -> IOTask () +serialCloseTask cmdDat resQ serialPortTMVar = flip E.catchAny errHdl $ do + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Serial.DS.Core.serialCloseTask run." + let jsonRpc = cmdDat^.DM.jsonrpcAgentSerialCloseCommandData + + STM.atomically (STM.swapTMVar serialPortTMVar Nothing) >>= \case + Nothing -> do + hPutStrLn stderr "[ERROR] PMS.Infra.Agent.Serial.DS.Core.serialCloseTask: serial is not connected." + DM.toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "serial is not connected." + Just sp -> do + closeSerial sp + DM.toolsCallResponse resQ jsonRpc ExitSuccess "" "serial is closed." + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Serial.DS.Core.serialCloseTask closeSerial." + + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Serial.DS.Core.serialCloseTask end." + + where + errHdl :: E.SomeException -> IO () + errHdl e = DM.toolsCallResponse resQ (cmdDat^.DM.jsonrpcAgentSerialCloseCommandData) (ExitFailure 1) "" (show e) + +--------------------------------------------------------------------------------- +-- | +-- +genSerialReadTask :: DM.AgentSerialReadCommandData -> AppContext (IOTask ()) +genSerialReadTask cmdData = do + let argsBS = DM.unRawJsonByteString $ cmdData^.DM.argumentsAgentSerialReadCommandData + resQ <- view DM.responseQueueDomainData <$> lift ask + serialPortTMVar <- view serialPortAppData <$> ask + argsDat <- liftEither $ eitherDecode argsBS + let size = argsDat^.sizeSerialIntToolParams + actualSize = min size _READ_BUFFER_SIZE + return $ serialReadTask cmdData resQ serialPortTMVar actualSize + +-- | +-- +serialReadTask :: DM.AgentSerialReadCommandData + -> STM.TQueue DM.McpResponse + -> STM.TMVar (Maybe SerialPort) + -> Int + -> IOTask () +serialReadTask cmdDat resQ serialPortTMVar size = flip E.catchAny errHdl $ do + hPutStrLn stderr $ "[INFO] PMS.Infra.Agent.Serial.DS.Core.serialReadTask run. " ++ show size + + STM.atomically (STM.readTMVar serialPortTMVar) >>= \case + Nothing -> do + hPutStrLn stderr "[ERROR] PMS.Infra.Agent.Serial.DS.Core.serialReadTask: serial is not connected." + DM.toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "serial is not connected." + Just sp -> do + output <- recv sp size + DM.toolsCallResponse resQ jsonRpc ExitSuccess (DM.bs2strUTF8 output) "" + + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Serial.DS.Core.serialReadTask end." + + where + jsonRpc = cmdDat^.DM.jsonrpcAgentSerialReadCommandData + errHdl :: E.SomeException -> IO () + errHdl e = DM.toolsCallResponse resQ jsonRpc (ExitFailure 1) "" (show e) + +--------------------------------------------------------------------------------- +-- | +-- +genSerialReadByteTask :: DM.AgentSerialReadByteCommandData -> AppContext (IOTask ()) +genSerialReadByteTask cmdData = do + let argsBS = DM.unRawJsonByteString $ cmdData^.DM.argumentsAgentSerialReadByteCommandData + resQ <- view DM.responseQueueDomainData <$> lift ask + serialPortTMVar <- view serialPortAppData <$> ask + argsDat <- liftEither $ eitherDecode argsBS + let size = argsDat^.sizeSerialIntToolParams + actualSize = min size _READ_BUFFER_SIZE + return $ serialReadByteTask cmdData resQ serialPortTMVar actualSize + +-- | +-- +serialReadByteTask :: DM.AgentSerialReadByteCommandData + -> STM.TQueue DM.McpResponse + -> STM.TMVar (Maybe SerialPort) + -> Int + -> IOTask () +serialReadByteTask cmdDat resQ serialPortTMVar size = flip E.catchAny errHdl $ do + hPutStrLn stderr $ "[INFO] PMS.Infra.Agent.Serial.DS.Core.serialReadByteTask run. " ++ show size + + STM.atomically (STM.readTMVar serialPortTMVar) >>= \case + Nothing -> do + hPutStrLn stderr "[ERROR] PMS.Infra.Agent.Serial.DS.Core.serialReadByteTask: serial is not connected." + DM.toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "serial is not connected." + Just sp -> do + output <- recv sp size + DM.toolsCallResponse resQ jsonRpc ExitSuccess (DM.bytesToHex output) "" + + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Serial.DS.Core.serialReadByteTask end." + + where + jsonRpc = cmdDat^.DM.jsonrpcAgentSerialReadByteCommandData + errHdl :: E.SomeException -> IO () + errHdl e = DM.toolsCallResponse resQ jsonRpc (ExitFailure 1) "" (show e) + + + +--------------------------------------------------------------------------------- +-- | CR-07 / invalidPatterns check: agent-serial-write implementation. +-- The invalidPatterns check is performed here in the gen function (AppContext), +-- consistent with how genSocketWriteTask performs the same check. +genSerialWriteTask :: DM.AgentSerialWriteCommandData -> AppContext (IOTask ()) +genSerialWriteTask cmdData = do + let argsBS = DM.unRawJsonByteString $ cmdData^.DM.argumentsAgentSerialWriteCommandData + resQ <- view DM.responseQueueDomainData <$> lift ask + serialPortTMVar <- view serialPortAppData <$> ask + invalidPatterns <- view DM.invalidPatternsDomainData <$> lift ask + argsDat <- liftEither $ eitherDecode argsBS + let str = argsDat^.dataSerialWriteToolParams + appendNewline = argsDat^.appendNewlineSerialWriteToolParams + -- invalidPatterns check (pure check, consistent with eitherDecode validation) + case DM.checkInvalidPatterns invalidPatterns str of + Just pat -> throwError $ + "agent-serial-write: rejected. input matches invalidPatterns: " ++ show pat + Nothing -> return () + return $ serialWriteTask cmdData resQ serialPortTMVar str appendNewline + +-- | +-- +serialWriteTask :: DM.AgentSerialWriteCommandData + -> STM.TQueue DM.McpResponse + -> STM.TMVar (Maybe SerialPort) + -> String + -> Maybe Bool + -> IOTask () +serialWriteTask cmdDat resQ serialPortTMVar str appendNewline = flip E.catchAny errHdl $ do + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Serial.DS.Core.serialWriteTask run." + + STM.atomically (STM.readTMVar serialPortTMVar) >>= \case + Nothing -> + DM.toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "serial is not connected." + Just sp -> do + -- Apply appendCRLF (auto-append newline) unless appendNewline is explicitly False. + let payload = if appendNewline == Just False + then str + else DM.appendCRLF str + bs = DM.str2bsUTF8 payload + hPutStrLn stderr $ "PMS.Infra.Agent.Serial.DS.Core.serialWriteTask " ++ show bs + _ <- send sp bs + DM.toolsCallResponse resQ jsonRpc ExitSuccess "" "" + + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Serial.DS.Core.serialWriteTask end." + + where + jsonRpc = cmdDat^.DM.jsonrpcAgentSerialWriteCommandData + errHdl e = DM.toolsCallResponse resQ jsonRpc (ExitFailure 1) "" (show e) + + +--------------------------------------------------------------------------------- +-- | +-- +genSerialWriteByteTask :: DM.AgentSerialWriteByteCommandData -> AppContext (IOTask ()) +genSerialWriteByteTask cmdData = do + let argsBS = DM.unRawJsonByteString $ cmdData^.DM.argumentsAgentSerialWriteByteCommandData + resQ <- view DM.responseQueueDomainData <$> lift ask + serialPortTMVar <- view serialPortAppData <$> ask + argsDat <- liftEither $ eitherDecode argsBS + let hex = argsDat^.dataSerialHexToolParams + bs <- liftEither $ hexToBytes hex + return $ serialWriteByteTask cmdData resQ serialPortTMVar bs + +-- | +-- +serialWriteByteTask :: DM.AgentSerialWriteByteCommandData + -> STM.TQueue DM.McpResponse + -> STM.TMVar (Maybe SerialPort) + -> BS.ByteString + -> IOTask () +serialWriteByteTask cmdDat resQ serialPortTMVar bs = flip E.catchAny errHdl $ do + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Serial.DS.Core.serialWriteByteTask run." + + STM.atomically (STM.readTMVar serialPortTMVar) >>= \case + Nothing -> + DM.toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "serial is not connected." + Just sp -> do + hPutStrLn stderr $ "PMS.Infra.Agent.Serial.DS.Core.serialWriteByteTask " ++ show bs + _ <- send sp bs + DM.toolsCallResponse resQ jsonRpc ExitSuccess "" "" + + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Serial.DS.Core.serialWriteByteTask end." + + where + jsonRpc = cmdDat^.DM.jsonrpcAgentSerialWriteByteCommandData + errHdl e = DM.toolsCallResponse resQ jsonRpc (ExitFailure 1) "" (show e) diff --git a/src/PMS/Infra/Agent/Serial/DS/Utility.hs b/src/PMS/Infra/Agent/Serial/DS/Utility.hs new file mode 100644 --- /dev/null +++ b/src/PMS/Infra/Agent/Serial/DS/Utility.hs @@ -0,0 +1,117 @@ +{-# LANGUAGE OverloadedStrings #-} + +module PMS.Infra.Agent.Serial.DS.Utility where + +import Control.Lens +import System.Log.FastLogger +import qualified Control.Exception.Safe as E +import Control.Monad.IO.Class +import Control.Monad.Except +import Control.Monad.Reader +import qualified Control.Concurrent.STM as STM +import System.Hardware.Serialport +import qualified Data.ByteString as BS +import qualified Data.ByteString.Base16 as B16 +import qualified Data.ByteString.Char8 as C8 +import Data.Char (toUpper) +import qualified Text.Read as R + +import qualified PMS.Domain.Model.DM.Type as DM +import qualified PMS.Domain.Model.DS.Utility as DM +import PMS.Infra.Agent.Serial.DM.Type + +-- | +-- +runApp :: DM.DomainData -> AppData -> TimedFastLogger -> AppContext a -> IO (Either DM.ErrorData a) +runApp domDat appDat logger ctx = + DM.runFastLoggerT domDat logger + $ runExceptT + $ flip runReaderT domDat + $ runReaderT ctx appDat + + +-- | +-- +liftIOE :: IO a -> AppContext a +liftIOE f = liftIO (go f) >>= liftEither + where + go :: IO b -> IO (Either String b) + go x = E.catchAny (Right <$> x) errHdl + + errHdl :: E.SomeException -> IO (Either String a) + errHdl = return . Left . show + +--------------------------------------------------------------------------------- +-- | +-- +errorToolsCallResponse :: DM.JsonRpcRequest -> String -> AppContext () +errorToolsCallResponse jsonRpc errStr = do + let content = [ DM.McpToolsCallResponseResultContent "text" errStr ] + result = DM.McpToolsCallResponseResult { + DM._contentMcpToolsCallResponseResult = content + , DM._isErrorMcpToolsCallResponseResult = True + } + resDat = DM.McpToolsCallResponseData jsonRpc result + res = DM.McpToolsCallResponse resDat + + resQ <- view DM.responseQueueDomainData <$> lift ask + liftIOE $ STM.atomically $ STM.writeTQueue resQ res + + + +--------------------------------------------------------------------------------- +-- | Decode an uppercase/lowercase hex string to a ByteString. +-- Input is uppercased before decoding to tolerate mixed case (e.g. "000a1BFF"). +-- Returns Left with an error message if the input is not valid hex. +hexToBytes :: String -> Either String BS.ByteString +hexToBytes hex = + case B16.decode (C8.pack (map toUpper hex)) of + Right bs -> Right bs + Left err -> Left $ "hexToBytes: invalid hex string: " ++ err + + +getCommSpeed :: Int -> AppContext CommSpeed +getCommSpeed n = case R.readMaybe ("CS" ++ show n) of + Just cs -> return cs + Nothing -> throwError $ "invalid comm speed: " ++ show n + +-- | +-- +getStopBits :: Maybe Int -> StopBits +getStopBits (Just 2) = Two +getStopBits _ = One + +-- | +-- +getParity :: Maybe String -> Parity +getParity (Just "Odd") = Odd +getParity (Just "Even") = Even +getParity _ = NoParity + +-- | +-- +getFlowControl :: Maybe String -> FlowControl +getFlowControl (Just "Software") = Software +getFlowControl _ = NoFlowControl + +-- | +-- +getSerialSetting :: SerialToolParams -> AppContext SerialPortSettings +getSerialSetting params = do + cs <- case params^.commSpeedSerialToolParams of + Just n -> getCommSpeed n + Nothing -> return $ commSpeed defaultSerialSettings + let bpw = maybe (bitsPerWord defaultSerialSettings) fromIntegral + (params^.bitsPerWordSerialToolParams) + sb = getStopBits (params^.stopbSerialToolParams) + par = getParity (params^.paritySerialToolParams) + fc = getFlowControl (params^.flowControlSerialToolParams) + tout = maybe 1 id (params^.timeoutSerialToolParams) + return defaultSerialSettings { + commSpeed = cs + , bitsPerWord = bpw + , stopb = sb + , parity = par + , flowControl = fc + , timeout = tout + } diff --git a/test/PMS/Infra/Agent/Serial/App/ControlSpec.hs b/test/PMS/Infra/Agent/Serial/App/ControlSpec.hs new file mode 100644 --- /dev/null +++ b/test/PMS/Infra/Agent/Serial/App/ControlSpec.hs @@ -0,0 +1,392 @@ +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE OverloadedStrings #-} + +module PMS.Infra.Agent.Serial.App.ControlSpec (spec) where + +import Test.Hspec +import Control.Concurrent.Async +import qualified Control.Concurrent.STM as STM +import Control.Lens +import Data.Default +import qualified Data.ByteString as BS +import System.IO +import System.Log.FastLogger +import qualified System.Log.FastLogger as FastLogger + +import qualified PMS.Domain.Model.DM.Type as DM +import qualified PMS.Domain.Model.DS.Utility as DM +import qualified PMS.Infra.Agent.Serial.App.Control as SUT +import qualified PMS.Infra.Agent.Serial.DM.Type as SUT +import qualified PMS.Infra.Agent.Serial.DS.Core as Core +import qualified PMS.Infra.Agent.Serial.DS.Utility as Util + +-- | +-- +data SpecContext = SpecContext { + _domainDataSpecContext :: DM.DomainData + , _appDataSpecContext :: SUT.AppData + } + +makeLenses ''SpecContext + +defaultSpecContext :: IO SpecContext +defaultSpecContext = do + domDat <- DM.defaultDomainData + appDat <- SUT.defaultAppData + return SpecContext { + _domainDataSpecContext = domDat + , _appDataSpecContext = appDat + } + +-- | +-- +spec :: Spec +spec = do + runIO $ putStrLn "Start Spec." + beforeAll setUpOnce $ + afterAll tearDownOnce . + beforeWith setUp . + after tearDown $ run + +-- | +-- +setUpOnce :: IO SpecContext +setUpOnce = do + putStrLn "[INFO] EXECUTED ONLY ONCE BEFORE ALL TESTS START." + defaultSpecContext + +-- | +-- +tearDownOnce :: SpecContext -> IO () +tearDownOnce _ = do + putStrLn "[INFO] EXECUTED ONLY ONCE AFTER ALL TESTS FINISH." + +-- | +-- +setUp :: SpecContext -> IO SpecContext +setUp ctx = do + putStrLn "[INFO] EXECUTED BEFORE EACH TEST STARTS." + domDat <- DM.defaultDomainData + appDat <- SUT.defaultAppData + return ctx { + _domainDataSpecContext = domDat + , _appDataSpecContext = appDat + } + +-- | +-- +tearDown :: SpecContext -> IO () +tearDown _ = do + putStrLn "[INFO] EXECUTED AFTER EACH TEST FINISHES." + +-- | +-- +run :: SpecWith SpecContext +run = do + + --------------------------------------------------------------------------- + -- TC-01: echo — Verify overall flow + --------------------------------------------------------------------------- + describe "TC-01: echo command" $ do + context "when echo command issued via runWithAppData" $ do + it "should return response with matching jsonrpc" $ \ctx -> do + putStrLn "[INFO] TC-01 start." + let domDat = ctx^.domainDataSpecContext + appDat = ctx^.appDataSpecContext + cmdQ = domDat^.DM.agentSerialQueueDomainData + resQ = domDat^.DM.responseQueueDomainData + expect = "tc-01-echo" + jsonR = def { DM._jsonrpcJsonRpcRequest = expect } + argDat = DM.AgentSerialEchoCommandData jsonR expect + args = DM.AgentSerialEchoCommand argDat + + thId <- async $ SUT.runWithAppData appDat domDat + STM.atomically $ STM.writeTQueue cmdQ args + (DM.McpToolsCallResponse dat) <- STM.atomically $ STM.readTQueue resQ + cancel thId + + let actual = dat^.DM.jsonrpcMcpToolsCallResponseData^.DM.jsonrpcJsonRpcRequest + actual `shouldBe` expect + + --------------------------------------------------------------------------- + -- TC-02: agent-serial-open — Guard against multiple opens + --------------------------------------------------------------------------- + describe "TC-02: agent-serial-open double open" $ do + context "when handle is already Just (serial already connected)" $ do + it "should return isError=True with 'serial is already connected.'" $ \_ -> do + putStrLn "[INFO] TC-02 start." + pendingWith "requires a real SerialPort or an injected SerialPort adapter" + + --------------------------------------------------------------------------- + -- TC-03: agent-serial-close — Close without connection + --------------------------------------------------------------------------- + describe "TC-03: agent-serial-close without open" $ do + context "when handle is Nothing" $ do + it "should return isError=True with 'serial is not connected.'" $ \ctx -> do + putStrLn "[INFO] TC-03 start." + let domDat = ctx^.domainDataSpecContext + appDat = ctx^.appDataSpecContext + resQ = domDat^.DM.responseQueueDomainData + cmdDat = DM.AgentSerialCloseCommandData + { DM._jsonrpcAgentSerialCloseCommandData = mkJsonRpc "agent-serial-close" + } + Core.serialCloseTask cmdDat resQ (appDat^.SUT.serialPortAppData) + (DM.McpToolsCallResponse dat) <- STM.atomically $ STM.readTQueue resQ + isError dat `shouldBe` True + secondContentText dat `shouldBe` "serial is not connected." + + --------------------------------------------------------------------------- + -- TC-04: agent-serial-close — Normal close + --------------------------------------------------------------------------- + describe "TC-04: agent-serial-close with open handle" $ do + context "when handle is Just hdl" $ do + it "should return isError=False and handle becomes Nothing" $ \_ -> do + putStrLn "[INFO] TC-04 start." + pendingWith "requires a real SerialPort or an injected SerialPort adapter" + + --------------------------------------------------------------------------- + -- TC-05: agent-serial-read — Not connected + --------------------------------------------------------------------------- + describe "TC-05: agent-serial-read without open" $ do + context "when handle is Nothing" $ do + it "should return isError=True with 'serial is not connected.'" $ \ctx -> do + putStrLn "[INFO] TC-05 start." + let domDat = ctx^.domainDataSpecContext + appDat = ctx^.appDataSpecContext + resQ = domDat^.DM.responseQueueDomainData + cmdDat = DM.AgentSerialReadCommandData + { DM._jsonrpcAgentSerialReadCommandData = mkJsonRpc "agent-serial-read" + , DM._argumentsAgentSerialReadCommandData = DM.RawJsonByteString "" + } + Core.serialReadTask cmdDat resQ (appDat^.SUT.serialPortAppData) 16 + (DM.McpToolsCallResponse dat) <- STM.atomically $ STM.readTQueue resQ + isError dat `shouldBe` True + secondContentText dat `shouldBe` "serial is not connected." + + --------------------------------------------------------------------------- + -- TC-06: agent-serial-read — UTF-8 read + --------------------------------------------------------------------------- + describe "TC-06: agent-serial-read UTF-8 string" $ do + context "when handle has UTF-8 bytes" $ do + it "should decode bytes as UTF-8 string" $ \_ -> do + putStrLn "[INFO] TC-06 start." + pendingWith "requires a real SerialPort or an injected SerialPort adapter" + + --------------------------------------------------------------------------- + -- TC-07: agent-serial-read-byte — Binary read + --------------------------------------------------------------------------- + describe "TC-07: agent-serial-read-byte binary data" $ do + context "when handle has binary bytes" $ do + it "should encode bytes as uppercase hex string" $ \_ -> do + putStrLn "[INFO] TC-07 start." + DM.bytesToHex (BS.pack [0x00, 0x0A, 0x1B, 0xFF]) `shouldBe` "000A1BFF" + + --------------------------------------------------------------------------- + -- TC-08: agent-serial-read — Timeout (no data) + --------------------------------------------------------------------------- + describe "TC-08: agent-serial-read timeout (no data)" $ do + context "when handle has no data pending" $ do + it "should return isError=False with empty string" $ \_ -> do + putStrLn "[INFO] TC-08 start." + pendingWith "requires a real SerialPort or an injected SerialPort adapter" + + --------------------------------------------------------------------------- + -- TC-09: agent-serial-write — Not connected + --------------------------------------------------------------------------- + describe "TC-09: agent-serial-write without open" $ do + context "when handle is Nothing" $ do + it "should return isError=True with 'serial is not connected.'" $ \ctx -> do + putStrLn "[INFO] TC-09 start." + let domDat = ctx^.domainDataSpecContext + appDat = ctx^.appDataSpecContext + resQ = domDat^.DM.responseQueueDomainData + cmdDat = DM.AgentSerialWriteCommandData + { DM._jsonrpcAgentSerialWriteCommandData = mkJsonRpc "agent-serial-write" + , DM._argumentsAgentSerialWriteCommandData = DM.RawJsonByteString "" + } + Core.serialWriteTask cmdDat resQ (appDat^.SUT.serialPortAppData) "hello" Nothing + (DM.McpToolsCallResponse dat) <- STM.atomically $ STM.readTQueue resQ + isError dat `shouldBe` True + secondContentText dat `shouldBe` "serial is not connected." + + --------------------------------------------------------------------------- + -- TC-10: agent-serial-write — UTF-8 write + --------------------------------------------------------------------------- + describe "TC-10: agent-serial-write UTF-8 string" $ do + context "when serial is connected and data is a UTF-8 string" $ do + it "should write UTF-8 encoded bytes to the serial port" $ \_ -> do + putStrLn "[INFO] TC-10 start." + pendingWith "requires a real SerialPort or an injected SerialPort adapter" + + --------------------------------------------------------------------------- + -- TC-A: agent-serial-write — appendNewline default (omitted) appends \n + --------------------------------------------------------------------------- + describe "TC-A: agent-serial-write appendNewline default appends newline" $ do + context "when appendNewline is Nothing (default True) and input has no trailing newline" $ do + it "should append \\n to the transmitted bytes" $ \ctx -> do + putStrLn "[INFO] TC-A start." + let domDat = ctx^.domainDataSpecContext + appDat = ctx^.appDataSpecContext + argsJson = "{\"data\":\"hello\"}" + cmdDat = DM.AgentSerialWriteCommandData + { DM._jsonrpcAgentSerialWriteCommandData = mkJsonRpc "agent-serial-write" + , DM._argumentsAgentSerialWriteCommandData = DM.RawJsonByteString argsJson + } + DM.appendCRLF "hello" `shouldBe` ("hello" ++ nativeLineEnding) + withStderrLogger $ \logger -> do + result <- Util.runApp domDat appDat logger (Core.genSerialWriteTask cmdDat) + case result of + Left errMsg -> expectationFailure $ "Expected Right but got Left: " ++ errMsg + Right _ -> return () + + --------------------------------------------------------------------------- + -- TC-B: agent-serial-write — appendNewline=False suppresses newline + --------------------------------------------------------------------------- + describe "TC-B: agent-serial-write appendNewline=False suppresses newline" $ do + context "when appendNewline is Just False" $ do + it "should NOT append \\n; transmitted bytes equal raw input" $ \ctx -> do + putStrLn "[INFO] TC-B start." + let domDat = ctx^.domainDataSpecContext + appDat = ctx^.appDataSpecContext + argsJson = "{\"data\":\"hello\",\"appendNewline\":false}" + cmdDat = DM.AgentSerialWriteCommandData + { DM._jsonrpcAgentSerialWriteCommandData = mkJsonRpc "agent-serial-write" + , DM._argumentsAgentSerialWriteCommandData = DM.RawJsonByteString argsJson + } + withStderrLogger $ \logger -> do + result <- Util.runApp domDat appDat logger (Core.genSerialWriteTask cmdDat) + case result of + Left errMsg -> expectationFailure $ "Expected Right but got Left: " ++ errMsg + Right _ -> return () + + --------------------------------------------------------------------------- + -- TC-11: agent-serial-write-byte — Uppercase hex write + --------------------------------------------------------------------------- + describe "TC-11: agent-serial-write-byte uppercase hex" $ do + context "when data is uppercase hex string" $ do + it "should decode uppercase hex string" $ \_ -> do + putStrLn "[INFO] TC-11 start." + Util.hexToBytes "000A1BFF" `shouldBe` Right (BS.pack [0x00, 0x0A, 0x1B, 0xFF]) + + --------------------------------------------------------------------------- + -- TC-12: agent-serial-write-byte — Lowercase/mixed hex write + --------------------------------------------------------------------------- + describe "TC-12: agent-serial-write-byte lowercase/mixed-case hex" $ do + context "when data is lowercase or mixed-case hex string" $ do + it "should decode lowercase or mixed-case hex string" $ \_ -> do + putStrLn "[INFO] TC-12 start." + let expect = BS.pack [0x00, 0x0A, 0x1B, 0xFF] + mapM_ (\hex -> Util.hexToBytes hex `shouldBe` Right expect) ["000a1bff", "000a1BFF"] + + --------------------------------------------------------------------------- + -- TC-13: agent-serial-write-byte — Invalid hex + --------------------------------------------------------------------------- + describe "TC-13: agent-serial-write-byte invalid hex string" $ do + context "when hex string contains non-hex characters" $ do + it "should return Left with hexToBytes error message" $ \ctx -> do + putStrLn "[INFO] TC-13 start." + let domDat = ctx^.domainDataSpecContext + appDat = ctx^.appDataSpecContext + argsJson = "{\"data\":\"ZZZZ\"}" + cmdDat = DM.AgentSerialWriteByteCommandData + { DM._jsonrpcAgentSerialWriteByteCommandData = mkJsonRpc "agent-serial-write-byte" + , DM._argumentsAgentSerialWriteByteCommandData = DM.RawJsonByteString argsJson + } + withStderrLogger $ \logger -> do + result <- Util.runApp domDat appDat logger (Core.genSerialWriteByteTask cmdDat) + case result of + Left errMsg -> errMsg `shouldContain` "hexToBytes" + Right _ -> expectationFailure "Expected Left (hexToBytes error) but got Right" + + --------------------------------------------------------------------------- + -- TC-14: agent-serial-write — invalidPatterns rejection (exact match) + --------------------------------------------------------------------------- + describe "TC-14: agent-serial-write rejected by invalidPatterns (exact match)" $ do + context "when input matches an invalidPatterns entry" $ do + it "should return Left with invalidPatterns error message" $ \ctx -> do + putStrLn "[INFO] TC-14 start." + let domDat = (ctx^.domainDataSpecContext) + { DM._invalidPatternsDomainData = ["reboot"] } + appDat = ctx^.appDataSpecContext + argsJson = "{\"data\":\"reboot\"}" + cmdDat = DM.AgentSerialWriteCommandData + { DM._jsonrpcAgentSerialWriteCommandData = mkJsonRpc "agent-serial-write" + , DM._argumentsAgentSerialWriteCommandData = DM.RawJsonByteString argsJson + } + withStderrLogger $ \logger -> do + result <- Util.runApp domDat appDat logger (Core.genSerialWriteTask cmdDat) + case result of + Left errMsg -> errMsg `shouldContain` "invalidPatterns" + Right _ -> expectationFailure "Expected Left (invalidPatterns error) but got Right" + + --------------------------------------------------------------------------- + -- TC-15: agent-serial-write — invalidPatterns rejection (regex partial match) + --------------------------------------------------------------------------- + describe "TC-15: agent-serial-write rejected by invalidPatterns (regex partial match)" $ do + context "when input partially matches an invalidPatterns regex" $ do + it "should return Left with invalidPatterns error message" $ \ctx -> do + putStrLn "[INFO] TC-15 start." + let domDat = (ctx^.domainDataSpecContext) + { DM._invalidPatternsDomainData = ["rm -rf"] } + appDat = ctx^.appDataSpecContext + argsJson = "{\"data\":\"sudo rm -rf /\"}" + cmdDat = DM.AgentSerialWriteCommandData + { DM._jsonrpcAgentSerialWriteCommandData = mkJsonRpc "agent-serial-write" + , DM._argumentsAgentSerialWriteCommandData = DM.RawJsonByteString argsJson + } + withStderrLogger $ \logger -> do + result <- Util.runApp domDat appDat logger (Core.genSerialWriteTask cmdDat) + case result of + Left errMsg -> errMsg `shouldContain` "invalidPatterns" + Right _ -> expectationFailure "Expected Left (invalidPatterns error) but got Right" + + --------------------------------------------------------------------------- + -- TC-16: agent-serial-write — Empty invalidPatterns list (allow all) + --------------------------------------------------------------------------- + describe "TC-16: agent-serial-write allowed when invalidPatterns is empty" $ do + context "when invalidPatterns is empty (allow all)" $ do + it "should return Right (task) without error" $ \ctx -> do + putStrLn "[INFO] TC-16 start." + let domDat = (ctx^.domainDataSpecContext) + { DM._invalidPatternsDomainData = [] } + appDat = ctx^.appDataSpecContext + argsJson = "{\"data\":\"any string\"}" + cmdDat = DM.AgentSerialWriteCommandData + { DM._jsonrpcAgentSerialWriteCommandData = mkJsonRpc "agent-serial-write" + , DM._argumentsAgentSerialWriteCommandData = DM.RawJsonByteString argsJson + } + withStderrLogger $ \logger -> do + result <- Util.runApp domDat appDat logger (Core.genSerialWriteTask cmdDat) + case result of + Left errMsg -> expectationFailure $ "Expected Right but got Left: " ++ errMsg + Right _ -> return () + +--------------------------------------------------------------------------------- +-- Helpers +--------------------------------------------------------------------------------- + +mkJsonRpc :: String -> DM.JsonRpcRequest +mkJsonRpc method = def { DM._methodJsonRpcRequest = method } + +isError :: DM.McpToolsCallResponseData -> Bool +isError dat = + dat^.DM.resultMcpToolsCallResponseData^.DM.isErrorMcpToolsCallResponseResult + +secondContentText :: DM.McpToolsCallResponseData -> String +secondContentText dat = + let contents = dat^.DM.resultMcpToolsCallResponseData^.DM.contentMcpToolsCallResponseResult + in DM._textMcpToolsCallResponseResultContent (contents !! 1) + +nativeLineEnding :: String +nativeLineEnding = case nativeNewline of + CRLF -> "\r\n" + LF -> "\n" + +-- | For TC-13: Temporarily create and use a TimedFastLogger that outputs to stderr. +withStderrLogger :: (FastLogger.TimedFastLogger -> IO a) -> IO a +withStderrLogger action = do + tc <- newTimeCache "%Y-%m-%d %H:%M:%S" + (logger, finalizer) <- newTimedFastLogger tc (LogStderr defaultBufSize) + result <- action logger + finalizer + return result diff --git a/test/Spec.hs b/test/Spec.hs new file mode 100644 --- /dev/null +++ b/test/Spec.hs @@ -0,0 +1,1 @@ +{-# OPTIONS_GHC -F -pgmF hspec-discover #-}