■ はじめに

https://dk521123.hatenablog.com/entry/2023/03/27/001306
https://dk521123.hatenablog.com/entry/2023/03/28/003906
https://dk521123.hatenablog.com/entry/2023/03/29/000014

の続き。

Scala の単体試験で、ScalaTest をベースにやってきたが、
今回は、ScalaTest + Mockito  (org.scalatestplus) で
モックを使ったテストしてみる。

【０】ScalaTest の Mock

はじめ、ScalaTestでのMockは、Mockito の1択だろって
思っていたのだが、デフォルトで「import org.scalatest.mock.MockitoSugar」
がなくなっていたしで、改めてちゃんと調べてみたら、
公式ドキュメントに以下の記述あり。

https://www.scalatest.org/user_guide/testing_with_mock_objects

より抜粋
~~~~~~~~~~~~
ScalaMock
EasyMock
JMock
Mockito
~~~~~~~~~~~~

どれを選ぶかは、自分で使ってみて使い心地がいい方でいいと思うが
とりあえず、今回は、情報量が多い「Mockito」を使ってみる
（「EasyMock」と「Mockito」は、過去の自分が使っていたし）

ScalaMock

* PureのScala製のMock

http://scalamock.org/

EasyMock

* Java製のMock
 => 以下の関連記事を参照のこと

https://dk521123.hatenablog.com/entry/2010/01/28/234207

* 導入したい場合は、以下の公式ドキュメント参照

https://www.scalatest.org/plus/easymock

JMock

* こちらもJava製のMock

http://jmock.org/

* 導入したい場合は、以下の公式ドキュメント参照

https://www.scalatest.org/plus/jmock

【１】Mockito

* Java の モックツール
 => 詳細は、以下の関連記事を参照のこと

Mockito ～入門編～
https://dk521123.hatenablog.com/entry/2014/07/18/233904
Mockito ～基本編～
https://dk521123.hatenablog.com/entry/2014/07/19/121409

【２】初期設定

https://www.scalatest.org/plus/mockito

libraryDependencies ++= Seq(
  "org.scalatestplus" %% "mockito-4-6" % "3.2.15.0" % "test",
  "org.scalatest" %% "scalatest" % "3.2.15" % "test"
)

https://mvnrepository.com/artifact/org.scalatestplus
https://mvnrepository.com/artifact/org.scalatestplus/mockito-4-6

補足：mockito-scala

* 上記とは、別に「mockito-scala」ってのもある。
 => こっちの方がよさげ？？

https://github.com/mockito/mockito-scala

libraryDependencies ++= Seq(
  "org.mockito" %% "mockito-scala" % "1.17.14" % "test"
)

https://takezoe.hatenablog.com/entry/2020/11/03/004143

【３】サンプル

例１：mock() / when().thenReturn()

import org.scalatest.funspec.AnyFunSpec
import org.scalatestplus.mockito.MockitoSugar
import org.mockito.Mockito.when

class Hello {
  def sayHello(name: String): String = {
    s"Hello, ${name}"
  }
}

// MockitoSugar trait provides some basic syntax sugar for Mockito.
class HelloTest extends AnyFunSpec with MockitoSugar {
  describe("For Hello World Test") {
    it ("Hello World For Mockito") {
      // First, create the mock object (mock オブジェクト作成用メソッド)
      val mockedHello = mock[Hello]

      // when().thenReturn(): 戻り値ありのメソッドに振る舞いを設定
      //  => 戻り値を「Fixed value」に変更
      when(mockedHello.sayHello("Mike")).thenReturn("Fixed value")
      assert("Fixed value" === mockedHello.sayHello("Mike"))
    }
  }
}

例２：verify()

import org.scalatest.funspec.AnyFunSpec
import org.scalatestplus.mockito.MockitoSugar
import org.mockito.Mockito.{verify, times, atLeastOnce, atLeast, atMost, never}

class Hello {
  def sayHello(name: String): String = {
    s"Hello, ${name}"
  }
}

// MockitoSugar trait provides some basic syntax sugar for Mockito.
class HelloTest extends AnyFunSpec with MockitoSugar {
  describe("For Hello World Test") {
    it ("Hello World For Mockito") {
      // First, create the mock object (mock オブジェクト作成用メソッド)
      val mockedHello = mock[Hello]
  
      mockedHello.sayHello("Mike")
      mockedHello.sayHello("Tom")
      mockedHello.sayHello("Tom")
      mockedHello.sayHello("Tom")

      // verify: メソッド呼び出しの妥当性検証
      verify(mockedHello, atLeastOnce()).sayHello("Mike")
      verify(mockedHello, atLeast(2)).sayHello("Tom")
      verify(mockedHello, atMost(2)).sayHello("Mike")
      verify(mockedHello, times(3)).sayHello("Tom")
      // verify(mockedHello, times(4)).sayHello("Tom") // !!Error!!
      verify(mockedHello, never()).sayHello("Sam")
    }
  }
}

補足：公式ドキュメントのサンプル

公式ドキュメントのサンプル

https://www.scalatest.org/plus/mockito

だが、さっぱり分からなかったが、
どうやら、Githubにあるテストコードの切れ端の模様。

https://github.com/scalatest/scalatestplus-mockito/blob/main/src/test/scala/org/scalatestplus/mockito/MockitoSugarSpec.scala

import もないのにわからんよ、、、

参考文献

https://takezoe.hatenablog.com/entry/2020/11/03/004143
https://inside.pixiv.blog/2022/11/24/120000
http://tkawachi.github.io/blog/2013/08/26/mockito-scala/
https://www.playframework.com/documentation/ja/2.4.x/ScalaTestingWithScalaTest

プログラムの超個人的なメモ

Memo for Programming.

【Scala】ScalaTest ～ with Mockito ～

■ はじめに

目次

【０】ScalaTest の Mock

【１】Mockito

【２】初期設定

補足：mockito-scala

【３】サンプル

例１：mock() / when().thenReturn()

例２：verify()

補足：公式ドキュメントのサンプル

参考文献

関連記事