如何创建一个 case class 的随机实例？

Question

假设我有几个 case classes，例如：

case class C(c1: Int, c2: Double, c3: Option[String])
case class B(b: Int, cs: Seq[C])
case class A(a: String, bs: Seq[B]) 

现在我想要生成一些具有随机值的A实例用于测试。

我正在寻找一种通用的方法来实现。我可能可以通过运行时反射来完成，但我更喜欢一个编译时的解决方案。

def randomInstance[A](a: A): A = ???

我该怎么做？可以使用shapeless吗？

- Michael

---

scalacheck有Arbitrary，应该很有用。 - erip

Answer 1

最简单的方法是使用ScalaCheck。您可以通过为您的实例定义Gen[A]来实现：

import org.scalacheck.Gen

final case class C(c1: Int, c2: Double, c3: Option[String])
object C {
  val cGen: Gen[C] = for {
    c1 <- Gen.posNum[Int]
    c2 <- Gen.posNum[Double]
    c3 <- Gen.option(Gen.oneOf("foo", "bar", "hello"))
  } yield C(c1, c2, c3)
}

并且你会消费它：

object F {
  def main(args: Array[String]): Unit = {
    val randomC: C = C.cGen.sample.get
  }
}

除此之外，你可以添加 scalacheck-shapeless，它会为你生成Gen[A]，并提供完全随机的值（你无法控制）。

你可能还想研究一下random-data-generator（感谢@Gabriele Petronella），这进一步简化了事情。从文档中可以看到：

import com.danielasfregola.randomdatagenerator.RandomDataGenerator

object MyApp extends RandomDataGenerator {

  case class Example(text: String, n: Int)

  val example: Example = random[Example]
  // Example(ਈ䈦㈾钜㔪旅ꪔ墛炝푰⡨䌆ᵅ퍧咪, 73967257)
}

这在属性基础测试中也特别有帮助。

- Yuval Itzchakov

---

值得一提的是 https://github.com/DanielaSfregola/random-data-generator，它允许您执行 val c = random[C]。 - Gabriele Petronella

好的，我会把它加到答案里。 - Yuval Itzchakov

Answer 2

我们刚刚放弃了scalacheck-shapeless，改用Scala/Java反射。

主要原因是(1) scalacheck-shapeless使用宏(编译速度慢)，(2) API有点过于冗长，不太符合我的口味，(3)生成的值过于随机(例如生成带有日文字符的字符串)。

但是，设置起来会比较麻烦。以下是完整的可工作代码，您可以将其复制到自己的代码库中：

import scala.reflect.api
import scala.reflect.api.{TypeCreator, Universe}
import scala.reflect.runtime.universe._

object Maker {
  val mirror = runtimeMirror(getClass.getClassLoader)

  var makerRunNumber = 1

  def apply[T: TypeTag]: T = {
    val method = typeOf[T].companion.decl(TermName("apply")).asMethod
    val params = method.paramLists.head
    val args = params.map { param =>
      makerRunNumber += 1
      param.info match {
        case t if t <:< typeOf[Enumeration#Value] => chooseEnumValue(convert(t).asInstanceOf[TypeTag[_ <: Enumeration]])
        case t if t =:= typeOf[Int] => makerRunNumber
        case t if t =:= typeOf[Long] => makerRunNumber
        case t if t =:= typeOf[Date] => new Date(Time.now.inMillis)
        case t if t <:< typeOf[Option[_]] => None
        case t if t =:= typeOf[String] && param.name.decodedName.toString.toLowerCase.contains("email") => s"random-$[e-mail]"
        case t if t =:= typeOf[String] => s"arbitrary-$makerRunNumber"
        case t if t =:= typeOf[Boolean] => false
        case t if t <:< typeOf[Seq[_]] => List.empty
        case t if t <:< typeOf[Map[_, _]] => Map.empty
        // Add more special cases here.
        case t if isCaseClass(t) => apply(convert(t))
        case t => throw new Exception(s"Maker doesn't support generating $t")
      }
    }

    val obj = mirror.reflectModule(typeOf[T].typeSymbol.companion.asModule).instance
    mirror.reflect(obj).reflectMethod(method)(args:_*).asInstanceOf[T]
  }

  def chooseEnumValue[E <: Enumeration: TypeTag]: E#Value = {
    val parentType = typeOf[E].asInstanceOf[TypeRef].pre
    val valuesMethod = parentType.baseType(typeOf[Enumeration].typeSymbol).decl(TermName("values")).asMethod
    val obj = mirror.reflectModule(parentType.termSymbol.asModule).instance

    mirror.reflect(obj).reflectMethod(valuesMethod)().asInstanceOf[E#ValueSet].head
  }

  def convert(tpe: Type): TypeTag[_] = {
    TypeTag.apply(
      runtimeMirror(getClass.getClassLoader),
      new TypeCreator {
        override def apply[U <: Universe with Singleton](m: api.Mirror[U]) = {
          tpe.asInstanceOf[U # Type]
        }
      }
    )
  }

  def isCaseClass(t: Type) = {
    t.companion.decls.exists(_.name.decodedName.toString == "apply") &&
      t.decls.exists(_.name.decodedName.toString == "copy")
  }
}

而当您想要使用它时，您可以调用以下命令：

val user = Maker[User]
val user2 = Maker[User].copy(email = "[e-mail]")

以上代码生成任意且独特的值。它们不是完全随机化的。最适合在测试中使用。

阅读我们的完整博客文章： https://give.engineering/2018/08/24/instantiate-case-class-with-arbitrary-value.html

- Tanin

---

博客文章链接已损坏。 - Isaac Flaum

Answer 3

我们已经开始使用Magnolia，相比于shapeless，在派生Arbitrary实例方面提供了更快的类型类派生。

这里是要使用的库，这里有一个示例 (文档):

case class Inner(int: Int, str: String)
case class Outer(inner: Inner)

// ScalaCheck Arbitrary
import magnolify.scalacheck.auto._
import org.scalacheck._ // implicit instances for Arbitrary[Int], etc.

val arb: Arbitrary[Outer] = implicitly[Arbitrary[Outer]]
arb.arbitrary.sample
// = Some(Outer(Inter(12345, abcde)))

- Anish