Haskell（hspec） IOテスト方法（Couldn't match expected type ‘()’ with actual type ‘Either String b0’の解消方法）

Question

前提

• GHC: version 8.8.4
• hspec: 2.10.0
• OS: Ubuntu 22.04

実現したいこと

Haskellのhspecを用いたユニットテストで、IO出力する関数をテストすること。
（hspecのshouldReturnの使い方を間違えている可能性を疑っています）

発生している問題・エラーメッセージ

hspec公式ドキュメントを参考にテストを作成しましたが、エラーが発生します。

まず、テスト対象関数は、Falseモジュールで定義したversion関数です。

module False where

-- |The 'version' print false command version.
version :: IO ()
version = putStrLn "version 0.1.0"

次に、上記のFalse.version関数をテストするためにspecを定義しました。

module Main where

import Test.Hspec
import False

main :: IO ()
main = hspec $ do
    describe "false command unit test" $ do
            it "print false command version" $ do
                    version `shouldReturn` Left  "version 0.1.0"

この状態でテストを実施すると、以下のエラーが発生します。

/home/nao/Desktop/hs-coreutils/test/false/falseSpec.hs:10:36: error:
    • Couldn't match expected type ‘()’
                  with actual type ‘Either String b0’
    • In the second argument of ‘shouldReturn’, namely
        ‘Left "version 0.1.0"’
      In a stmt of a 'do' block:
        version `shouldReturn` Left "version 0.1.0"
      In the second argument of ‘($)’, namely
        ‘do version `shouldReturn` Left "version 0.1.0"’
   |        
10 |             version `shouldReturn` Left  "version 0.1.0"
   |                                    ^^^^^^^^^^^^^^^^^^^^^
Progress 1/2

該当のソースコード

• https://github.com/nao1215/hs-coreutils/blob/main/src/false/False.hs
• https://github.com/nao1215/hs-coreutils/blob/main/test/false/falseSpec.hs

試したこと

• 公式ドキュメント調査

Answer 1

version関数はIOをそのまま使ってしまっているのでそのままでは出力した文字列についてテストできません。直すにはいろいろなアプローチが考えられますが、今回はversion関数を一切修正しない、比較的お手軽な方法を紹介します。

拙作のmain-testerと言うパッケージを使えば、次のようにテストできるはずです:

it "..." $ do
  processResult <- captureProcessResult version
  prStdout processResult `shouldBe` "version 0.1.0"

ただし、このmain-testerが提供するcaptureProcessResult関数は、標準出力・標準エラー出力をテストの結果としてしか使えなくしてしまうので、デバッグの際に困ることがある点にご注意ください。

詳しくは https://haskell.jp/blog/posts/2018/main-tester.html をご覧ください。