Haskell

Question

我有如下一段代码；

module Billing.Options
  (
      GlobalOpts(..)
    , globalOptsParser
    , parseDb
    , parseSql
  ) where

import Options.Applicative
import Options.Applicative.Simple
import Options.Applicative.Types
import System.FilePath.Posix
import Text.Regex.PCRE

-- ------------------------------------------------------------

data GlobalOpts = GlobalOpts
  {
    optDb          :: String,
    optSql         :: String
  } deriving Show

-- ------------------------------------------------------------

globalOptsParser :: Parser GlobalOpts
globalOptsParser = GlobalOpts
  <$> option (parseDb =<< readerAsk)
    (   long "db"
    <>  short 'd'
    <>  metavar "<DB name>"
    <>  help "dmt | report"
    )
  <*> option parseSql
    (   long "sql"
    <>  metavar "<SQL SELECT statement>"
    <>  help "sql select statement to use in order to generate JSON config file"
    )
-- ------------------------------------------------------------

matches :: String -> String -> Bool
matches = (=~)

-- ------------------------------------------------------------

parseDb :: String -> ReadM String
parseDb val = do
    if not (elem val ["dmt", "report"])
        then readerError $ "Unknown DB, '" ++ val ++ "'"
        else return val

-- ------------------------------------------------------------

parseSql :: ReadM String
parseSql = do
    val <- readerAsk
    if not (val `matches` "(?i)select .+ from .+")
        then readerError $ "Please provide a valid SQL SELECT statement"
        else return val

-- [EOF]

我正在使用以下代码测试我的参数解析器；

error' = let mp = runParser AllowOpts globalOptsParser ["-d", "billing"]
          opts = ParserPrefs "suffix" False False False 80
      in fst $ runP mp opts

所需的参数是，

  -d <DB name>
  --sql <SQL SELECT statement>

我想测试我是否收到错误消息，

Missing: --sql <SQL SELECT statement>

当我只指定“-d billing”时。

如果我打印结果，上面的测试代码会给出以下输出，

Left (MissingError (MultNode [MultNode [MultNode [AltNode [Leaf (Chunk {unChunk = Just --sql <SQL SELECT statement>})]]]]))

有没有办法根据上述结果（任一数据类型）生成预期的错误消息（字符串）？ Haskell 是否提供了一个明显的功能用于此目的，因为我在文档中找不到任何东西，谷歌搜索示例也没有产生任何答案。

Answer 1

如果您查看 optparse-applicative (link) 的源代码存储库，您会发现它本身在 tests 子目录中有一个测试套件。

文件 tests/Test.hs:

中的 checkHelpTextWith 看起来很像您想要的例程

checkHelpTextWith :: Show a => ExitCode -> ParserPrefs -> String
                  -> ParserInfo a -> [String] -> Assertion
checkHelpTextWith ecode pprefs name p args = do
  let result = execParserPure pprefs p args
  assertError result $ \failure -> do
    expected <- readFile $ name ++ ".err.txt"
    let (msg, code) = renderFailure failure name
    expected @=? msg ++ "\n"
    ecode @=? code

此函数预计选项解析器会失败，并将错误消息与文件内容进行比较。

感兴趣的主要函数有：

execParserPure :: ParserPrefs -> ParserInfo a -> [String] -> ParserResult a

renderFailure :: ParserFailure ParserHelp -> String -> (String, ExitCode)

renderFailure返回的字符串是错误信息。

Haskell - 从任一数据类型生成缺少参数错误消息

Haskell - generate missing argument error message from either data type

testing

optionparser