■ はじめに

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

の続き。

今回は、Scalaの単体試験する際に
ScalaTest を使用した時のTipsについてまとめる

【１】初期処理・後処理
　１）BeforeAndAfter
　２）BeforeAndAfterAll
【２】一時的テストを停止する
　１）テストメソッドを停止する
　２）テストクラスを全体を停止する
【３】Public以外のメソッドのテスト
　１）private メソッドをテストする
　２）protected メソッドをテストする
【４】Table で色々なパターンの値を用意する
【５】例外処理をテストする
　１）発生した例外を確認する
　２）発生した例外＋メッセージを確認する

【１】初期処理・後処理

１）BeforeAndAfter

* 各テスト前・後に呼び出されるメソッドを定義できる
 => 説明よりサンプルとログの出力結果みた方が分かりやすい

１）サンプル

package  com.example

import org.scalatest.funspec.AnyFunSpec
import org.scalatest.BeforeAndAfter

class HelloWorldTest extends AnyFunSpec with BeforeAndAfter {
  before {
    println("Before") // ★ログ
  }

  after {
    println("After") // ★ログ
  }

  describe("Hello World Test") {
    describe("Normal") {
      it("Set name=Mike") {
        println("Test1") // ☆ログ
        val result = HelloWorld.sayHello("Mike")
        assert(result == "Hello, Mike!!")
      }
    }
    describe("Abnormal") {
      it("should produce IllegalArgumentException when name is empty") {
        assertThrows[IllegalArgumentException] {
          println("Test2") // ☆ログ
          HelloWorld.sayHello("")
        }
      }
    }
  }
}

出力結果

Before
Test1 << 各テスト前に「Before」、後に「After」にCallする
After
Before                                                       
Test2 << 各テスト前に「Before」、後に「After」にCallする                                                        
After

２）BeforeAndAfterAll

* １テスト前・後に呼び出されるメソッドを定義できる

サンプル

package  com.example

import org.scalatest.funspec.AnyFunSpec
import org.scalatest.BeforeAndAfterAll

class HelloWorldTest extends AnyFunSpec with BeforeAndAfterAll {
  override def beforeAll(): Unit = {
    println("beforeAll")
  }

  override def afterAll(): Unit = {
    println("afterAll")
  }
  // 略（上と同じ）
}

出力結果

beforeAll
Test1
Test2
afterAll

【２】一時的テストを停止する

* Ignore (無視)を指定する

１）テストメソッドを停止する

  describe("Hello World Test") {
    describe("Normal") {
      ignore("Set name=Mike") { // ignore() を指定

出力結果

[info] Hello World Test                                      
[info]   Normal                                              
[info]   - Set name=Mike !!! IGNORED !!!  << ★

２）テストクラスを全体を停止する

import org.scalatest.Ignore

@Ignore // ★ここ
class HelloWorldTest extends AnyFunSpec with BeforeAndAfterAll {

【３】Public以外のメソッドのテスト

１）private メソッドをテストする

* 「PrivateMethodTester」「PrivateMethod」を使う

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

１）サンプル

import org.scalatest.funspec.AnyFunSpec
import org.scalatest.PrivateMethodTester

class TargetClass {
  // private method
  private def sayHi(name: String): String = {
    require(name.nonEmpty)
    s"Hi, ${name}!!!"
  }
}

class HelloTest extends AnyFunSpec with PrivateMethodTester {
  describe("For Hello World Test") {
    val privateMethod = PrivateMethod[String]('sayHi)
    val targetClass = new TargetClass()
    it ("For private method test") {
      assert(targetClass.invokePrivate(privateMethod("Mike")) == "Hi, Mike!!!")
    }
  }
}

２）protected メソッドをテストする

* UnitTest用にクラスを設けて、そのクラスに継承して
　そのクラスのメソッドから、親クラスを呼び出すだけ
 => Scala以外のプログラムのUnitTestでも使える、、、

Hello.scala

class Hello {
  // ★ protected ★
  protected def sayHello(input: String): String = s"${input}, world"
}

HelloTest.scala

import org.scalatest.funsuite.AnyFunSuite
import org.scalatest.prop.TableDrivenPropertyChecks._

class HelloTest extends AnyFunSuite {
  // ★注目★
  class HelloForUnitTest extends Hello {
    override def sayHello(input: String): String = {
      super.sayHello(input)
    }
  }

  test("Your test case") {
    val target = new HelloForUnitTest
    val data = Table(
      ("input", "expected"),
      ("Hello", "Hello, world"),
      ("Hi", "Hi, world")
    )
    forAll(data) { (input, expected) =>
      val result = target.sayHello(input)
      assert(result == expected)
    }
  }
}

【４】Table で色々なパターンの値を用意する

* Table を使って、テストを行うと可読性があがる
 => 以下のサンプル参照

１）サンプル

Hello.scala

object  Hello {
  def sayHello(input: String): String = s"${input}, world"
}

HelloTest.scala

import org.scalatest.funsuite.AnyFunSuite
import org.scalatest.prop.TableDrivenPropertyChecks._

class HelloTest extends AnyFunSuite {
  test("Your test case") {
    // ★注目★
    val data = Table(
      ("input", "expected"),
      ("Hello", "Hello, world"),
      ("Hi", "Hi, world")
    )
    forAll(data) { (input, expected) =>
      val result = Hello.sayHello(input)
      assert(result == expected)
    }
  }
}

【５】例外処理をテストする

* 以下が参考になる

https://www.baeldung.com/scala/scalatest-test-exceptions

エラーを発生させるメソッド

object Hello {
  def explodingMethod(): Unit = {
    throw new RuntimeException("Hello, exception!!")
  }
}

１）発生した例外を確認する

package  com.example

import org.scalatest.funspec.AnyFunSpec

class HelloWorldTest extends AnyFunSpec {
    describe("Abnormal") {
      it("should produce RuntimeException when name is empty") {
        // ★注目★
        assertThrows[RuntimeException] {
         Hello.explodingMethod()
        }
      }
    }
  }
}

２）発生した例外＋メッセージを確認する

import org.scalatest.funsuite.AnyFunSuite
import org.scalatest.matchers.should.Matchers.{a, convertToAnyShouldWrapper}

class HelloTest extends AnyFunSuite  {
  test("Hello World Test") {
    val exception = intercept[Exception](Hello.explodingMethod())
    exception shouldBe a[Exception]
    exception shouldBe a[RuntimeException]
    exception.getMessage shouldBe "Hello, exception!!"
  }
}

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

Memo for Programming.

【Scala】ScalaTest ～あれこれ編～

■ はじめに

目次

【１】初期処理・後処理

１）BeforeAndAfter

１）サンプル

２）BeforeAndAfterAll

【２】一時的テストを停止する

１）テストメソッドを停止する

２）テストクラスを全体を停止する

【３】Public以外のメソッドのテスト

１）private メソッドをテストする

１）サンプル

２）protected メソッドをテストする

【４】Table で色々なパターンの値を用意する

１）サンプル

【５】例外処理をテストする

１）発生した例外を確認する

２）発生した例外＋メッセージを確認する

関連記事