👻
ScalaTestのEitherValuesでvalueに誤ったアクセスをしたら不意にNotAllowedExceptionで怒られた話
初めに結論
下記のようにAnyFreeSpecでin ではなく - の中で.valueでLeftにアクセスしていて怒られました。
単純に使い方のミスです。
EitherValuesの.valueは-ではなくinの中で使いましょう。
import org.scalatest.freespec.AnyFreeSpec
import org.scalatest.diagrams.Diagrams
import org.scalatest.EitherValues._
class TestEitherValueNotInInSpec extends AnyFreeSpec with Diagrams {
"test" - {
val v = TestEitherValueNotInIn.bar.value
"bar" in {
assert(v == "foo")
}
}
}
object TestEitherValueNotInIn {
def bar: Either[Int, String] = Left(10)
}
怒られた様子。
[info] TestEitherValueNotInInSpec:
[info] TestEitherValueNotInInSpec *** ABORTED ***
[info] Assertion should be put inside in clause, not - clause. (TestEitherValueNotInIn.scala:7)
ScalaTestのEitherValuesとは
EitherValuesの.valueはLeftが返ってくる時に.valueでアクセスするとTestFailedExceptionを投げてくれて、
Rightが返ってくるはずなのにLeftが返ってきたというときにテストを落としてくれる便利機能です。
そして、TestFailedExceptionはAnyFreeSpecの場合、inの中で記述されることを期待されています。
inの中でなければNotAllowedExceptionがthrowされます。
エラーの理由
なぜ直面したかを一言でいうと、初めRightのままで.valueを使ってもはコケなかったが、
リファクタリングしようとして破壊活動してしまったらとLeftになって急にコケてしまいました。
非常に雑なサンプルですが、冒頭に書いていたようなテストを書いていました。
import org.scalatest.freespec.AnyFreeSpec
import org.scalatest.diagrams.Diagrams
import org.scalatest.EitherValues._
class TestEitherValueNotInInSpec extends AnyFreeSpec with Diagrams {
"test" - {
val v = TestEitherValueNotInIn.bar.value
"bar" in {
assert(v == "foo")
}
}
}
object TestEitherValueNotInIn {
def bar: Either[Int, String] = Right("foo")
}
この場合、valueでアクセスしていたのはinの中ではないですが、
返ってくる値はRightなのでTestFailedExceptionにならず、NotAllowedExceptionにもなりません。
このコードをリファクタリングしようとしたとき、特定のロジックの結果Leftが返るようになっていました。
import org.scalatest.freespec.AnyFreeSpec
import org.scalatest.diagrams.Diagrams
import org.scalatest.EitherValues._
class TestEitherValueNotInInSpec extends AnyFreeSpec with Diagrams {
"test" - {
val v = TestEitherValueNotInIn.bar.value
"bar" in {
assert(v == "foo")
}
}
}
object TestEitherValueNotInIn {
private val kibun: Boolean = false
def bar: Either[Int, String] = if (kibun) Right("foo") else Left(10)
}
結果としてテストがコケたのでロジックかテストケースが誤っていたのですが、
単純にテストがコケるのではなくNotAllowedExceptionが発生し、何が怒られたのか一瞬わからず困惑の時間が過ぎました。
結論 - 用法用量を守って.valueを使おう
- EitherValuesのvalueでのアクセスはinの中でassertionと共に使おう
- 用法用量を守って意図した使い方で書いてテストがコケたときに備えよう
- リファクタリングはテストが通らなければ単なる破壊活動
Discussion