Haskell 使用 HSpec 进行管道和测试

Haskell Pipes and testing with HSpec

我为一个使用 Pipes 的项目编写了一个程序,我很喜欢!然而,我正在努力对我的代码进行单元测试。

我有一系列 Pipe In Out IO () 类型的函数(例如),我希望使用 HSpec 对其进行测试。我该怎么做?

例如,假设我有这个域:

data Person = Person String Int | Unknown deriving (Show, Eq)
data Classification = Friend | Foe | Undecided deriving Show

和这个管道:

classify :: Pipe Person (Person, Classification) IO ()
classify = do
    p@(Person name _) <- await
    case name of 
      "Alex" -> yield (p, Friend)
      "Bob" -> yield (p, Foe)
      _ -> yield (p, Undecided)

我想写一个规范:

main = hspec $ do
  describe "readFileP" $ 
    it "yields all the lines of a file"
      pendingWith "How can I test this Pipe? :("

您可以使用 temporary 包的功能来创建包含预期数据的临时文件,然后测试管道是否正确读取数据。

顺便说一下,您的 Pipe 正在使用执行惰性 I/O 的 readFile。惰性 I/O 和像管道这样的流式库不能很好地混合,事实上后者主要作为前者的替代品存在!

也许您应该改用执行严格 I/O 的函数,例如 openFilegetLine

严格 I/O 的一个烦恼是它迫使您更仔细地考虑资源分配。如何确保每个文件句柄在最后关闭,或者在出错的情况下关闭?实现这一目标的一种可能方法是在 ResourceT IO monad 中工作,而不是直接在 IO.

中工作

诀窍是使用 Pipes ListT monad 转换器中的 toListM

import Pipes
import qualified Pipes.Prelude as P
import Test.Hspec

data Person = Person String Int | Unknown deriving (Show, Eq)
data Classification = Friend | Foe | Undecided deriving (Show, Eq)

classify :: Pipe Person (Person, Classification) IO ()
classify = do
  p@(Person name _) <- await
  case name of 
    "Alex" -> yield (p, Friend)
    "Bob" -> yield (p, Foe)
    _ -> yield (p, Undecided)

测试,使用 ListT 转换器将管道转换为 ListT 并使用 HSpec 断言:

main = hspec $ do
  describe "classify" $ do
    it "correctly finds friends" $ do
      [(p, cl)] <- P.toListM $ each [Person "Alex" 31] >-> classify
      p `shouldBe` (Person "Alex" 31)
      cl `shouldBe` Friend

请注意,您不必使用 each,这可能是一个简单的生产者调用 yield