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-process + +## 0.0.1.0 -- 2025-05-05 + +* 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,74 @@ +# pms-infra-agent-process + +---- +## โš ๏ธ 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-process`** is a Haskell infrastructure library that provides AI agents with direct, low-level control over external processes via standard input/output. + +Unlike PTY-based tools, this library communicates with spawned processes directly through `stdin`/`stdout`/`stderr` handles, without allocating a pseudo-terminal. This makes it well-suited for non-TUI programs that communicate via plain text streams, such as language servers, compilers, or custom automation scripts. + +The library is a core component of the [`pty-mcp-server`](https://github.com/phoityne/pty-mcp-server) ecosystem and implements the `agent-proc-*` family of MCP tools. + +--- + +## ๐Ÿ”ง Provided MCP Tools + +### `agent-proc-run` +Spawns an external process with the specified command and options. The process's `stdin`/`stdout` are connected for subsequent `agent-proc-read` and `agent-proc-write` operations. Only one process can be active at a time. + +Supports an `allowedAgentCmds` whitelist โ€” if configured, only commands present in the whitelist are permitted to run. + +### `agent-proc-read` +Reads up to the specified number of bytes from the `stdout` of the running process. Returns immediately with available data (non-blocking). Returns an empty string if no data is available. + +### `agent-proc-write` +Writes the specified string to the `stdin` of the running process. + +### `agent-proc-terminate` +Forcefully terminates the currently running process. Resets internal state so `agent-proc-run` can be called again. + +--- + +## ๐Ÿ—๏ธ Architecture + +### Module Structure + +``` +PMS.Infra.Agent.Process +โ”œโ”€โ”€ DM.Type -- Data type definitions (ProcData, AppData, tool parameter types) +โ”œโ”€โ”€ DM.Constant -- Constants +โ”œโ”€โ”€ DS.Core -- Core domain service logic +โ”œโ”€โ”€ DS.Utility -- Utility functions +โ””โ”€โ”€ App.Control -- Application control: tool dispatch and process lifecycle management +``` + +### Key Design Points + +- **Single active process**: Only one process can run at a time per server instance. State is managed via `STM.TMVar`. +- **Non-blocking reads**: `agent-proc-read` returns immediately without blocking, allowing the agent to poll at its own pace. +- **Whitelist enforcement**: `agent-proc-run` checks the command against `allowedAgentCmds` from the configuration before spawning. If the list is empty, all commands are denied by default. +- **Direct stdio**: No PTY allocation. Suitable for programs that do not require a terminal environment. + +--- + +## ๐Ÿ“ฆ Dependencies + +- [`pms-domain-model`](https://github.com/phoityne/pms-domain-model) + +--- + +## ๐Ÿ“œ Credits & License + +- **Execution & Process Lead:** Sonnet 4.6, Gemini 3 Flash +- **Direction & Policy:** phoityne +- **License:** Apache-2.0 โ€” see [LICENSE](./LICENSE) + +--- diff --git a/pms-infra-agent-process.cabal b/pms-infra-agent-process.cabal new file mode 100644 --- /dev/null +++ b/pms-infra-agent-process.cabal @@ -0,0 +1,141 @@ +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-process' generated by +-- 'cabal init'. For further documentation, see: +-- http://haskell.org/cabal/users-guide/ +-- +-- The name of the package. +name: pms-infra-agent-process + +-- 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-process + +-- 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-process +bug-reports: https://github.com/phoityne/pms-infra-agent-process/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.Process.DM.Type, + PMS.Infra.Agent.Process.DS.Utility, + PMS.Infra.Agent.Process.DM.Constant, + PMS.Infra.Agent.Process.App.Control, + PMS.Infra.Agent.Process.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, + containers, + data-default, + monad-logger, + mtl, + lens, + text, + safe-exceptions, + fast-logger, + conduit, + bytestring, + transformers, + stm, + async, + process, + filepath, + aeson, + directory, + strip-ansi-escape, + 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-process-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.Process.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, + aeson, + pms-domain-model, + pms-infra-agent-process + + build-tool-depends: + hspec-discover:hspec-discover diff --git a/src/PMS/Infra/Agent/Process/App/Control.hs b/src/PMS/Infra/Agent/Process/App/Control.hs new file mode 100644 --- /dev/null +++ b/src/PMS/Infra/Agent/Process/App/Control.hs @@ -0,0 +1,61 @@ +{-# LANGUAGE LambdaCase #-} + +module PMS.Infra.Agent.Process.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.Process.DM.Type +import PMS.Infra.Agent.Process.DM.Constant +import PMS.Infra.Agent.Process.DS.Utility +import PMS.Infra.Agent.Process.DS.Core + +-- | +-- +run :: DM.DomainContext () +run domDat = do + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Process.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.Process.App.Control.run finalize called." + finalizeLogger + hPutStrLn stderr "-----------------------------------------------------------------------------" + + exception e = do + hPutStrLn stderr "-----------------------------------------------------------------------------" + hPutStrLn stderr "[ERROR] PMS.Infra.Agent.Process.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.Process.App.Control.run end with error." + hPutStrLn stderr $ show e + hPutStrLn stderr "-----------------------------------------------------------------------------" diff --git a/src/PMS/Infra/Agent/Process/DM/Constant.hs b/src/PMS/Infra/Agent/Process/DM/Constant.hs new file mode 100644 --- /dev/null +++ b/src/PMS/Infra/Agent/Process/DM/Constant.hs @@ -0,0 +1,17 @@ +module PMS.Infra.Agent.Process.DM.Constant where + +-------------------------------------------------------------------------------- +-- | +-- +_LOG_FILE_NAME :: String +_LOG_FILE_NAME = "pms-infra-agent-process.log" + +-- | +-- +_READ_BUFFER_SIZE :: Int +_READ_BUFFER_SIZE = 4096 + +-- | Wait time for proc-read input (milliseconds). +-- Minimum wait to return an empty string immediately when no data is available. +_PROC_READ_WAIT_MSEC :: Int +_PROC_READ_WAIT_MSEC = 100 diff --git a/src/PMS/Infra/Agent/Process/DM/Type.hs b/src/PMS/Infra/Agent/Process/DM/Type.hs new file mode 100644 --- /dev/null +++ b/src/PMS/Infra/Agent/Process/DM/Type.hs @@ -0,0 +1,105 @@ +{-# LANGUAGE TemplateHaskell #-} + +module PMS.Infra.Agent.Process.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 Data.Map.Strict (Map) +import qualified Control.Concurrent.STM as STM +import qualified System.Process as S +import qualified GHC.IO.Handle as S + +import qualified PMS.Domain.Model.DM.Type as DM +import qualified PMS.Domain.Model.DM.TH as DM + +-- | +-- +data ProcData = ProcData { + _wHdLProcData :: S.Handle + , _rHdlProcData :: S.Handle + , _eHdlProcData :: S.Handle + , _pHdlProcData :: S.ProcessHandle + } + +makeLenses ''ProcData + +-- | +-- +data AppData = AppData { + _processAppData :: STM.TMVar (Maybe ProcData) + } + +makeLenses ''AppData + +defaultAppData :: IO AppData +defaultAppData = do + mgrVar <- STM.newTMVarIO Nothing + return AppData { + _processAppData = mgrVar + } + +-- | +-- +type AppContext = ReaderT AppData (ReaderT DM.DomainData (ExceptT DM.ErrorData (LoggingT IO))) + +-- | +-- +type IOTask = IO + + +-------------------------------------------------------------------------------------------- +-- | +-- agent-proc-run ใฎ options ใ‚ชใƒ–ใ‚ธใ‚งใ‚ฏใƒˆ +-- +data ProcRunToolParams = + ProcRunToolParams { + _commandProcRunToolParams :: String + , _argumentsProcRunToolParams :: Maybe [String] + , _environmentProcRunToolParams :: Maybe (Map String String) + } deriving (Show, Read, Eq) + +$(deriveJSON defaultOptions {fieldLabelModifier = DM.dropDataName "ProcRunToolParams", omitNothingFields = True} ''ProcRunToolParams) +makeLenses ''ProcRunToolParams + +instance Default ProcRunToolParams where + def = ProcRunToolParams { + _commandProcRunToolParams = def + , _argumentsProcRunToolParams = def + , _environmentProcRunToolParams = def + } + +-- | +-- agent-proc-read ใฎ arguments +-- +data ProcIntToolParams = + ProcIntToolParams { + _argumentsProcIntToolParams :: Int + } deriving (Show, Read, Eq) + +$(deriveJSON defaultOptions {fieldLabelModifier = DM.dropDataName "ProcIntToolParams", omitNothingFields = True} ''ProcIntToolParams) +makeLenses ''ProcIntToolParams + +instance Default ProcIntToolParams where + def = ProcIntToolParams { + _argumentsProcIntToolParams = def + } + +-- | +-- agent-proc-write ใฎ arguments +-- +data ProcStringToolParams = + ProcStringToolParams { + _argumentsProcStringToolParams :: String + } deriving (Show, Read, Eq) + +$(deriveJSON defaultOptions {fieldLabelModifier = DM.dropDataName "ProcStringToolParams", omitNothingFields = True} ''ProcStringToolParams) +makeLenses ''ProcStringToolParams + +instance Default ProcStringToolParams where + def = ProcStringToolParams { + _argumentsProcStringToolParams = def + } diff --git a/src/PMS/Infra/Agent/Process/DS/Core.hs b/src/PMS/Infra/Agent/Process/DS/Core.hs new file mode 100644 --- /dev/null +++ b/src/PMS/Infra/Agent/Process/DS/Core.hs @@ -0,0 +1,306 @@ +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE FlexibleContexts #-} + +module PMS.Infra.Agent.Process.DS.Core where + +import System.IO +import Control.Monad.Logger +import Control.Monad.IO.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 Control.Monad (when) +import qualified Control.Exception.Safe as E +import System.Exit +import qualified Data.ByteString as BS +import Data.Aeson +import qualified System.Process as S +import qualified Data.Map.Strict as Map + +import qualified PMS.Domain.Model.DM.Type as DM +import qualified PMS.Domain.Model.DM.Constant as DM + +import PMS.Infra.Agent.Process.DM.Type +import qualified PMS.Infra.Agent.Process.DM.Constant as DM_CONST +import PMS.Infra.Agent.Process.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.AgentProcessCommand AppContext () +src = lift go >>= yield >> src + where + go :: AppContext DM.AgentProcessCommand + go = do + queue <- view DM.agentProcessQueueDomainData <$> lift ask + dat <- liftIO $ STM.atomically $ STM.readTQueue queue + return dat + +--------------------------------------------------------------------------------- +-- | +-- +cmd2task :: ConduitT DM.AgentProcessCommand (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.AgentProcessCommand -> String -> ConduitT DM.AgentProcessCommand (IOTask ()) AppContext () + errHdl procCmd msg = do + let jsonrpc = DM.getJsonRpcAgentProcessCommand procCmd + $logWarnS DM._LOGTAG $ T.pack $ "cmd2task: exception occurred. skip. " ++ msg + lift $ errorToolsCallResponse jsonrpc $ "cmd2task: exception occurred. skip. " ++ msg + cmd2task + + go :: DM.AgentProcessCommand -> AppContext (IOTask ()) + go (DM.AgentProcessEchoCommand dat) = genEchoTask dat + go (DM.AgentProcessRunCommand dat) = genProcRunTask dat + go (DM.AgentProcessReadCommand dat) = genProcReadTask dat + go (DM.AgentProcessWriteCommand dat) = genProcWriteTask dat + go (DM.AgentProcessTerminateCommand dat) = genProcTerminateTask 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 () + + +--------------------------------------------------------------------------------- +-- | +-- +genEchoTask :: DM.AgentProcessEchoCommandData -> AppContext (IOTask ()) +genEchoTask dat = do + resQ <- view DM.responseQueueDomainData <$> lift ask + let val = dat^.DM.valueAgentProcessEchoCommandData + + $logDebugS DM._LOGTAG $ T.pack $ "echoTask: echo : " ++ val + return $ echoTask resQ dat val + + +-- | +-- +echoTask :: STM.TQueue DM.McpResponse -> DM.AgentProcessEchoCommandData -> String -> IOTask () +echoTask resQ cmdDat val = flip E.catchAny errHdl $ do + hPutStrLn stderr $ "[INFO] PMS.Infra.Agent.Process.DS.Core.echoTask run. " ++ val + toolsCallResponse resQ (cmdDat^.DM.jsonrpcAgentProcessEchoCommandData) ExitSuccess val "" + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Process.DS.Core.echoTask end." + + where + errHdl :: E.SomeException -> IO () + errHdl e = toolsCallResponse resQ (cmdDat^.DM.jsonrpcAgentProcessEchoCommandData) (ExitFailure 1) "" (show e) + + +--------------------------------------------------------------------------------- +-- | +-- +genProcRunTask :: DM.AgentProcessRunCommandData -> AppContext (IOTask ()) +genProcRunTask cmdDat = do + let argsBS = DM.unRawJsonByteString $ cmdDat^.DM.argumentsAgentProcessRunCommandData + resQ <- view DM.responseQueueDomainData <$> lift ask + procTMVar <- view processAppData <$> ask + argsDat <- liftEither $ eitherDecode argsBS + let cmd = argsDat^.commandProcRunToolParams + argsArray = maybe [] id (argsDat^.argumentsProcRunToolParams) + envMap = argsDat^.environmentProcRunToolParams + addEnv = maybe [] Map.toList envMap + -- whitelist check: deny all if list is empty or cmd not in list + allowedCmds <- view DM.allowedAgentCmdsDomainData <$> lift ask + when (null allowedCmds || cmd `notElem` allowedCmds) $ + throwError $ "command not allowed: " ++ cmd + return $ procRunTask cmdDat resQ procTMVar cmd argsArray addEnv + + +-- | +-- +procRunTask :: DM.AgentProcessRunCommandData + -> STM.TQueue DM.McpResponse + -> STM.TMVar (Maybe ProcData) + -> String + -> [String] + -> [(String, String)] + -> IOTask () +procRunTask cmdDat resQ procTMVar cmd argsArray addEnv = flip E.catchAny errHdl $ do + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Process.DS.Core.procRunTask run." + STM.atomically (STM.takeTMVar procTMVar) >>= \case + Just p -> do + STM.atomically $ STM.putTMVar procTMVar (Just p) + hPutStrLn stderr "[ERROR] PMS.Infra.Agent.Process.DS.Core.procRunTask: process is already running." + toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "process is already running." + Nothing -> do + runProc procTMVar cmd argsArray addEnv + let payload = "command: " ++ truncate10 cmd + ++ ", arguments: " ++ truncate10 (show argsArray) + ++ ", environment: " ++ truncate10 (show addEnv) + toolsCallResponse resQ jsonRpc ExitSuccess payload "" + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Process.DS.Core.procRunTask end." + where + jsonRpc = cmdDat^.DM.jsonrpcAgentProcessRunCommandData + errHdl :: E.SomeException -> IO () + errHdl e = do + _ <- STM.atomically $ STM.tryTakeTMVar procTMVar + STM.atomically $ STM.putTMVar procTMVar Nothing + toolsCallResponse resQ jsonRpc (ExitFailure 1) "" (show e) + + -- | + -- Truncate a string to at most 10 characters, appending "..." if truncated. + truncate10 :: String -> String + truncate10 s + | length s <= 10 = s + | otherwise = take 10 s ++ "..." + + +--------------------------------------------------------------------------------- +-- | +-- Generate a task to terminate the running process. +genProcTerminateTask :: DM.AgentProcessTerminateCommandData -> AppContext (IOTask ()) +genProcTerminateTask dat = do + $logDebugS DM._LOGTAG $ T.pack $ "genProcTerminateTask called. " + procTMVar <- view processAppData <$> ask + resQ <- view DM.responseQueueDomainData <$> lift ask + return $ procTerminateTask dat resQ procTMVar + +-- | +-- Terminate the running process and reset the TMVar to Nothing. +-- Always returns ExitSuccess if terminateProcess completes without exception. +-- The exit code from waitForProcess is recorded in the log only. +procTerminateTask :: DM.AgentProcessTerminateCommandData + -> STM.TQueue DM.McpResponse + -> STM.TMVar (Maybe ProcData) + -> IOTask () +procTerminateTask cmdDat resQ procTMVar = flip E.catchAny errHdl $ do + hPutStrLn stderr $ "[INFO] PMS.Infra.Agent.Process.DS.Core.procTerminateTask run. " + let jsonRpc = cmdDat^.DM.jsonrpcAgentProcessTerminateCommandData + + STM.atomically (STM.swapTMVar procTMVar Nothing) >>= \case + Nothing -> do + hPutStrLn stderr "[ERROR] PMS.Infra.Agent.Process.DS.Core.procTerminateTask: process is not started." + toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "process is not started." + Just procDat -> do + let pHdl = procDat^.pHdlProcData + S.terminateProcess pHdl + exitCode <- S.waitForProcess pHdl + hPutStrLn stderr $ "[INFO] PMS.Infra.Agent.Process.DS.Core.procTerminateTask closeProc : " ++ show exitCode + toolsCallResponse resQ jsonRpc ExitSuccess "" "process is terminated." + + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Process.DS.Core.procTerminateTask end." + + where + errHdl :: E.SomeException -> IO () + errHdl e = toolsCallResponse resQ (cmdDat^.DM.jsonrpcAgentProcessTerminateCommandData) (ExitFailure 1) "" (show e) + + +--------------------------------------------------------------------------------- +-- | +-- Use DM_CONST._PROC_READ_WAIT_MSEC (100msec) as the timeout value. +-- External config (timeoutMicrosecDomainData) is not used. +genProcReadTask :: DM.AgentProcessReadCommandData -> AppContext (IOTask ()) +genProcReadTask cmdData = do + resQ <- view DM.responseQueueDomainData <$> lift ask + procTMVar <- view processAppData <$> ask + let argsBS = DM.unRawJsonByteString $ cmdData^.DM.argumentsAgentProcessReadCommandData + argsDat <- liftEither $ eitherDecode $ argsBS + let size = argsDat^.argumentsProcIntToolParams + actualSize = min size DM_CONST._READ_BUFFER_SIZE + return $ procReadTask cmdData resQ procTMVar DM_CONST._PROC_READ_WAIT_MSEC actualSize + +-- | +-- +procReadTask :: DM.AgentProcessReadCommandData + -> STM.TQueue DM.McpResponse + -> STM.TMVar (Maybe ProcData) + -> Int + -> Int + -> IOTask () +procReadTask cmdDat resQ procTMVar tout actualSize = flip E.catchAny errHdl $ do + hPutStrLn stderr $ "[INFO] PMS.Infra.Agent.Process.DS.Core.procReadTask run. actualSize: " ++ show actualSize + + STM.atomically (STM.readTMVar procTMVar) >>= \case + Nothing -> do + hPutStrLn stderr "[ERROR] PMS.Infra.Agent.Process.DS.Core.procReadTask: process is not started." + toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "process is not started." + Just p -> do + output <- readProc p tout actualSize + let result = bs2strUTF8 output + toolsCallResponse resQ jsonRpc ExitSuccess result "" + + where + jsonRpc = cmdDat^.DM.jsonrpcAgentProcessReadCommandData + errHdl e = toolsCallResponse resQ jsonRpc (ExitFailure 1) "" (show e) + + +--------------------------------------------------------------------------------- +-- | +-- +genProcWriteTask :: DM.AgentProcessWriteCommandData -> AppContext (IOTask ()) +genProcWriteTask cmdData = do + let argsBS = DM.unRawJsonByteString $ cmdData^.DM.argumentsAgentProcessWriteCommandData + resQ <- view DM.responseQueueDomainData <$> lift ask + procTMVar <- view processAppData <$> ask + argsDat <- liftEither $ eitherDecode $ argsBS + let args = argsDat^.argumentsProcStringToolParams + return $ procWriteTask cmdData resQ procTMVar args + +-- | +-- +procWriteTask :: DM.AgentProcessWriteCommandData + -> STM.TQueue DM.McpResponse + -> STM.TMVar (Maybe ProcData) + -> String + -> IOTask () +procWriteTask cmdDat resQ procTMVar args = flip E.catchAny errHdl $ do + hPutStrLn stderr $ "[INFO] PMS.Infra.Agent.Process.DS.Core.procWriteTask run. " ++ args + + STM.atomically (STM.readTMVar procTMVar) >>= \case + Nothing -> do + hPutStrLn stderr "[ERROR] PMS.Infra.Agent.Process.DS.Core.procWriteTask: process is not started." + toolsCallResponse resQ jsonRpc (ExitFailure 1) "" "process is not started." + Just p -> do + let wHdl = p^.wHdLProcData + cmd = str2bsUTF8 $ appendLF args + BS.hPut wHdl cmd + hFlush wHdl + toolsCallResponse resQ jsonRpc ExitSuccess "success" "" + + where + jsonRpc = cmdDat^.DM.jsonrpcAgentProcessWriteCommandData + errHdl e = toolsCallResponse resQ jsonRpc (ExitFailure 1) "" (show e) + diff --git a/src/PMS/Infra/Agent/Process/DS/Utility.hs b/src/PMS/Infra/Agent/Process/DS/Utility.hs new file mode 100644 --- /dev/null +++ b/src/PMS/Infra/Agent/Process/DS/Utility.hs @@ -0,0 +1,152 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE LambdaCase #-} + +module PMS.Infra.Agent.Process.DS.Utility where + +import System.IO +import Control.Lens +import System.Exit +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 qualified System.Process as S +import qualified Data.ByteString as BS +import qualified Data.Text as T +import qualified Data.Text.Encoding as TE +import qualified Data.Text.Encoding.Error as TEE +import qualified Data.String.AnsiEscapeCodes.Strip.Text as ANSI +import qualified System.Environment as Env + +import qualified PMS.Domain.Model.DM.Type as DM +import qualified PMS.Domain.Model.DM.Constant as DM +import qualified PMS.Domain.Model.DS.Utility as DM +import PMS.Infra.Agent.Process.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 + +--------------------------------------------------------------------------------- +-- | +-- +toolsCallResponse :: STM.TQueue DM.McpResponse + -> DM.JsonRpcRequest + -> ExitCode + -> String + -> String + -> IO () +toolsCallResponse resQ jsonRpc code outStr errStr = do + let content = [ DM.McpToolsCallResponseResultContent "text" outStr + , DM.McpToolsCallResponseResultContent "text" errStr + ] + result = DM.McpToolsCallResponseResult { + DM._contentMcpToolsCallResponseResult = content + , DM._isErrorMcpToolsCallResponseResult = (ExitSuccess /= code) + } + resDat = DM.McpToolsCallResponseData jsonRpc result + res = DM.McpToolsCallResponse resDat + + STM.atomically $ STM.writeTQueue resQ res + +-- | +-- +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 + +-- | +-- +runProc :: STM.TMVar (Maybe ProcData) -> String -> [String] -> [(String, String)] -> IO () +runProc procVar cmd args addEnv = do + + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Process.DS.Core.procRunTask.runProc start." + + (fromPtyHandle, toProcHandle) <- S.createPipe + (fromProcHandle, toPtyHandle) <- S.createPipe + -- (fromProcEHandle, toPtyEHandle) <- S.createPipe + + hSetBuffering toProcHandle NoBuffering + hSetBuffering fromProcHandle NoBuffering + hSetBuffering fromPtyHandle NoBuffering + hSetBuffering toPtyHandle NoBuffering + + baseEnv <- Env.getEnvironment + let cwd = Nothing + runEnvs = Just $ addEnv ++ baseEnv + + hPutStrLn stderr $ "[INFO] env = " ++ show runEnvs + hPutStrLn stderr $ "[INFO] cmd = " ++ cmd + hPutStrLn stderr $ "[INFO] args = " ++ show args + + pHdl <- S.runProcess cmd args cwd runEnvs (Just fromPtyHandle) (Just toPtyHandle) (Just toPtyHandle) + -- pHdl <- S.runProcess cmd args cwd runEnvs (Just fromPtyHandle) (Just toPtyHandle) (Just toPtyEHandle) + let procData = ProcData { + _wHdLProcData = toProcHandle + , _rHdlProcData = fromProcHandle + , _eHdlProcData = fromProcHandle +-- , _eHdlProcData = fromProcEHandle + , _pHdlProcData = pHdl + } + + STM.atomically $ STM.putTMVar procVar (Just procData) + + hPutStrLn stderr "[INFO] PMS.Infra.Agent.Process.DS.Core.procRunTask.runProc end." + +-- | +-- If no data is available (timeout), return an empty ByteString instead of an error. +readProc :: ProcData -> Int -> Int -> IO BS.ByteString +readProc dat tout size = do + let hdl = dat^.rHdlProcData + ready <- hWaitForInput hdl tout + if ready + then BS.hGetSome hdl size + else return BS.empty + +--------------------------------------------------------------------------------- +-- | +-- Append LF to the end of the string only if it does not already end with '\n'. +-- If the string is empty, return LF only to avoid exception from 'last'. +appendLF :: String -> String +appendLF str + | null str = DM._LF + | last str /= '\n' = str ++ DM._LF + | otherwise = str + +-- | +-- Encode a String to a UTF-8 encoded ByteString. +str2bsUTF8 :: String -> BS.ByteString +str2bsUTF8 = TE.encodeUtf8 . T.pack + +-- | +-- Decode a ByteString to a String using UTF-8 (lenient) and strip ANSI escape sequences. +bs2strUTF8 :: BS.ByteString -> String +bs2strUTF8 = T.unpack . ANSI.stripAnsiEscapeCodes . TE.decodeUtf8With TEE.lenientDecode diff --git a/test/PMS/Infra/Agent/Process/App/ControlSpec.hs b/test/PMS/Infra/Agent/Process/App/ControlSpec.hs new file mode 100644 --- /dev/null +++ b/test/PMS/Infra/Agent/Process/App/ControlSpec.hs @@ -0,0 +1,328 @@ +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE OverloadedStrings #-} + +module PMS.Infra.Agent.Process.App.ControlSpec (spec) where + +import Test.Hspec +import Control.Concurrent +import Control.Concurrent.Async +import qualified Control.Concurrent.STM as STM +import Control.Lens +import Data.Default +import Data.Aeson (encode) +import qualified Data.ByteString.Lazy.Char8 as BL + +import qualified PMS.Domain.Model.DM.Type as DM +import qualified PMS.Infra.Agent.Process.App.Control as SUT +import qualified PMS.Infra.Agent.Process.DM.Type as SUT + +-- | +-- +data SpecContext = SpecContext { + _domainDataSpecContext :: DM.DomainData + , _appDataSpecContext :: SUT.AppData + , _threadIdSpecContext :: Maybe (Async ()) + } + +makeLenses ''SpecContext + +defaultSpecContext :: IO SpecContext +defaultSpecContext = do + domDat <- DM.defaultDomainData + appDat <- SUT.defaultAppData + return SpecContext { + _domainDataSpecContext = domDat + , _appDataSpecContext = appDat + , _threadIdSpecContext = Nothing + } + +-- | +-- +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." + +-- | +-- Each test gets a fresh domDat/appDat and a running SUT thread. +-- cmd.exe is added to the whitelist so that TC-02 / TC-04 keep working. +-- +setUp :: SpecContext -> IO SpecContext +setUp ctx = do + putStrLn "[INFO] EXECUTED BEFORE EACH TEST STARTS." + domDat <- DM.defaultDomainData + let domDat' = domDat { DM._allowedAgentCmdsDomainData = ["cmd.exe"] } + appDat <- SUT.defaultAppData + thId <- async $ SUT.runWithAppData appDat domDat' + return ctx { + _domainDataSpecContext = domDat' + , _appDataSpecContext = appDat + , _threadIdSpecContext = Just thId + } + +-- | +-- Build a SpecContext with a custom whitelist and start the SUT thread. +-- +setUpWithAllowList :: SpecContext -> [String] -> IO SpecContext +setUpWithAllowList ctx allowList = do + domDat <- DM.defaultDomainData + let domDat' = domDat { DM._allowedAgentCmdsDomainData = allowList } + appDat <- SUT.defaultAppData + thId <- async $ SUT.runWithAppData appDat domDat' + return ctx { + _domainDataSpecContext = domDat' + , _appDataSpecContext = appDat + , _threadIdSpecContext = Just thId + } + +-- | +-- Cancel the SUT thread after each test. +-- +tearDown :: SpecContext -> IO () +tearDown ctx = do + putStrLn "[INFO] EXECUTED AFTER EACH TEST FINISHES." + case ctx^.threadIdSpecContext of + Nothing -> return () + Just thId -> cancel thId + +-- --------------------------------------------------------------------------- +-- Helpers +-- --------------------------------------------------------------------------- + +-- | +-- Send a command to the SUT and receive one response. +-- +sendAndReceive :: DM.DomainData + -> DM.AgentProcessCommand + -> IO DM.McpToolsCallResponseData +sendAndReceive domDat cmd = do + let cmdQ = domDat^.DM.agentProcessQueueDomainData + resQ = domDat^.DM.responseQueueDomainData + STM.atomically $ STM.writeTQueue cmdQ cmd + (DM.McpToolsCallResponse dat) <- STM.atomically $ STM.readTQueue resQ + return dat + +-- | +-- Build a minimal JsonRpcRequest for testing. +-- +mkJsonRpc :: String -> DM.JsonRpcRequest +mkJsonRpc method = def { DM._methodJsonRpcRequest = method } + +-- | +-- Encode ProcRunToolParams to RawJsonByteString. +-- +mkRunArgs :: String -> [String] -> DM.RawJsonByteString +mkRunArgs cmd args = + DM.RawJsonByteString $ encode $ SUT.ProcRunToolParams + { SUT._commandProcRunToolParams = cmd + , SUT._argumentsProcRunToolParams = Just args + , SUT._environmentProcRunToolParams = Nothing + } + +-- | +-- Encode ProcIntToolParams (read size) to RawJsonByteString. +-- +mkReadArgs :: Int -> DM.RawJsonByteString +mkReadArgs size = + DM.RawJsonByteString $ encode $ SUT.ProcIntToolParams + { SUT._argumentsProcIntToolParams = size } + +-- | +-- Encode ProcStringToolParams (write payload) to RawJsonByteString. +-- +mkWriteArgs :: String -> DM.RawJsonByteString +mkWriteArgs s = + DM.RawJsonByteString $ encode $ SUT.ProcStringToolParams + { SUT._argumentsProcStringToolParams = s } + +-- | +-- Extract the isError flag from a response. +-- +isError :: DM.McpToolsCallResponseData -> Bool +isError dat = + dat^.DM.resultMcpToolsCallResponseData^.DM.isErrorMcpToolsCallResponseResult + +-- --------------------------------------------------------------------------- +-- Test suite +-- --------------------------------------------------------------------------- + +-- | +-- +run :: SpecWith SpecContext +run = do + + -- TC-01: echo command smoke test + describe "TC-01: echo command" $ do + context "when AgentProcessEchoCommand is sent" $ do + it "should return the same value with isError=False" $ \ctx -> do + putStrLn "[INFO] TC-01 start." + let domDat = ctx^.domainDataSpecContext + expect = "hello-echo" + echoCmd = DM.AgentProcessEchoCommand $ DM.AgentProcessEchoCommandData + { DM._jsonrpcAgentProcessEchoCommandData = mkJsonRpc "echo" + , DM._valueAgentProcessEchoCommandData = expect + } + dat <- sendAndReceive domDat echoCmd + isError dat `shouldBe` False + let contents = dat^.DM.resultMcpToolsCallResponseData^.DM.contentMcpToolsCallResponseResult + actual = DM._textMcpToolsCallResponseResultContent (head contents) + actual `shouldBe` expect + + -- TC-02: run -> read -> write -> read -> terminate smoke test + describe "TC-02: run -> read -> write -> read -> terminate" $ do + context "when cmd.exe is started and interacted with" $ do + it "should succeed for each step with isError=False" $ \ctx -> do + putStrLn "[INFO] TC-02 start." + let domDat = ctx^.domainDataSpecContext + + -- run + let runCmd = DM.AgentProcessRunCommand $ DM.AgentProcessRunCommandData + { DM._jsonrpcAgentProcessRunCommandData = mkJsonRpc "agent-proc-run" + , DM._nameAgentProcessRunCommandData = "agent-proc-run" + , DM._argumentsAgentProcessRunCommandData = mkRunArgs "cmd.exe" [] + } + runDat <- sendAndReceive domDat runCmd + isError runDat `shouldBe` False + + -- read (discard the initial prompt output after cmd.exe starts) + threadDelay (500 * 1000) -- wait 500ms for the process to start + let readCmd = DM.AgentProcessReadCommand $ DM.AgentProcessReadCommandData + { DM._jsonrpcAgentProcessReadCommandData = mkJsonRpc "agent-proc-read" + , DM._argumentsAgentProcessReadCommandData = mkReadArgs 4096 + } + readDat1 <- sendAndReceive domDat readCmd + isError readDat1 `shouldBe` False + + -- write: send "echo hello\n" + let writeCmd = DM.AgentProcessWriteCommand $ DM.AgentProcessWriteCommandData + { DM._jsonrpcAgentProcessWriteCommandData = mkJsonRpc "agent-proc-write" + , DM._argumentsAgentProcessWriteCommandData = mkWriteArgs "echo hello" + } + writeDat <- sendAndReceive domDat writeCmd + isError writeDat `shouldBe` False + + -- read (read the echo output) + threadDelay (500 * 1000) -- wait 500ms for the output to be available + readDat2 <- sendAndReceive domDat readCmd + isError readDat2 `shouldBe` False + + -- terminate + let termCmd = DM.AgentProcessTerminateCommand $ DM.AgentProcessTerminateCommandData + { DM._jsonrpcAgentProcessTerminateCommandData = mkJsonRpc "agent-proc-terminate" + } + termDat <- sendAndReceive domDat termCmd + isError termDat `shouldBe` False + + -- TC-03: terminate without prior run + describe "TC-03: terminate without prior run" $ do + context "when terminate is sent before run" $ do + it "should return isError=True" $ \ctx -> do + putStrLn "[INFO] TC-03 start." + let domDat = ctx^.domainDataSpecContext + termCmd = DM.AgentProcessTerminateCommand $ DM.AgentProcessTerminateCommandData + { DM._jsonrpcAgentProcessTerminateCommandData = mkJsonRpc "agent-proc-terminate" + } + dat <- sendAndReceive domDat termCmd + isError dat `shouldBe` True + + -- TC-04: double run (process already running) + describe "TC-04: double run" $ do + context "when run is sent twice" $ do + it "should return isError=True for the second run" $ \ctx -> do + putStrLn "[INFO] TC-04 start." + let domDat = ctx^.domainDataSpecContext + runCmd = DM.AgentProcessRunCommand $ DM.AgentProcessRunCommandData + { DM._jsonrpcAgentProcessRunCommandData = mkJsonRpc "agent-proc-run" + , DM._nameAgentProcessRunCommandData = "agent-proc-run" + , DM._argumentsAgentProcessRunCommandData = mkRunArgs "cmd.exe" [] + } + + -- first run: should succeed + runDat1 <- sendAndReceive domDat runCmd + isError runDat1 `shouldBe` False + + -- second run: should fail with error + runDat2 <- sendAndReceive domDat runCmd + isError runDat2 `shouldBe` True + + -- cleanup: terminate + let termCmd = DM.AgentProcessTerminateCommand $ DM.AgentProcessTerminateCommandData + { DM._jsonrpcAgentProcessTerminateCommandData = mkJsonRpc "agent-proc-terminate" + } + _ <- sendAndReceive domDat termCmd + return () + + -- TC-05: Whitelist - allowed command succeeds + describe "TC-05: whitelist - allowed command" $ do + context "when cmd.exe is in agentAllowedCmds" $ do + it "should start the process and return isError=False" $ \ctx -> do + putStrLn "[INFO] TC-05 start." + ctx' <- setUpWithAllowList ctx ["cmd.exe"] + let domDat = ctx'^.domainDataSpecContext + runCmd = DM.AgentProcessRunCommand $ DM.AgentProcessRunCommandData + { DM._jsonrpcAgentProcessRunCommandData = mkJsonRpc "agent-proc-run" + , DM._nameAgentProcessRunCommandData = "agent-proc-run" + , DM._argumentsAgentProcessRunCommandData = mkRunArgs "cmd.exe" [] + } + runDat <- sendAndReceive domDat runCmd + isError runDat `shouldBe` False + -- cleanup + let termCmd = DM.AgentProcessTerminateCommand $ DM.AgentProcessTerminateCommandData + { DM._jsonrpcAgentProcessTerminateCommandData = mkJsonRpc "agent-proc-terminate" + } + _ <- sendAndReceive domDat termCmd + tearDown ctx' + + -- TC-06: Whitelist - denied command returns error message + describe "TC-06: whitelist - denied command" $ do + context "when powershell.exe is NOT in agentAllowedCmds" $ do + it "should return isError=True with 'command not allowed' message" $ \ctx -> do + putStrLn "[INFO] TC-06 start." + ctx' <- setUpWithAllowList ctx ["cmd.exe"] + let domDat = ctx'^.domainDataSpecContext + runCmd = DM.AgentProcessRunCommand $ DM.AgentProcessRunCommandData + { DM._jsonrpcAgentProcessRunCommandData = mkJsonRpc "agent-proc-run" + , DM._nameAgentProcessRunCommandData = "agent-proc-run" + , DM._argumentsAgentProcessRunCommandData = mkRunArgs "powershell.exe" [] + } + runDat <- sendAndReceive domDat runCmd + isError runDat `shouldBe` True + let contents = runDat^.DM.resultMcpToolsCallResponseData^.DM.contentMcpToolsCallResponseResult + errText = DM._textMcpToolsCallResponseResultContent (head contents) + errText `shouldBe` "cmd2task: exception occurred. skip. command not allowed: powershell.exe" + tearDown ctx' + + -- TC-07: Whitelist - empty list denies all commands + describe "TC-07: whitelist - empty list denies all" $ do + context "when agentAllowedCmds is empty" $ do + it "should return isError=True for any command" $ \ctx -> do + putStrLn "[INFO] TC-07 start." + ctx' <- setUpWithAllowList ctx [] + let domDat = ctx'^.domainDataSpecContext + runCmd = DM.AgentProcessRunCommand $ DM.AgentProcessRunCommandData + { DM._jsonrpcAgentProcessRunCommandData = mkJsonRpc "agent-proc-run" + , DM._nameAgentProcessRunCommandData = "agent-proc-run" + , DM._argumentsAgentProcessRunCommandData = mkRunArgs "cmd.exe" [] + } + runDat <- sendAndReceive domDat runCmd + isError runDat `shouldBe` True + let contents = runDat^.DM.resultMcpToolsCallResponseData^.DM.contentMcpToolsCallResponseResult + errText = DM._textMcpToolsCallResponseResultContent (head contents) + errText `shouldBe` "cmd2task: exception occurred. skip. command not allowed: cmd.exe" + tearDown ctx' 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 #-}