4

我们正在寻找一种可行的设计模式来构建Gen可以产生正面和负面测试场景的 Scalacheck(生成器)。这将允许我们运行测试来验证功能(正面案例),并通过在所有无效数据组合上forAll失败来验证我们的案例类验证是否正常工作。

制作一个简单的、参数化Gen的一次性完成此操作非常容易。例如:

  def idGen(valid: Boolean = true): Gen[String] = Gen.oneOf(ID.values.toList).map(s => if (valid) s else Gen.oneOf(simpleRandomCode(4), "").sample.get)

通过以上,我可以得到一个有效或无效的 ID 用于测试目的。有效的,我用来确保业务逻辑成功。无效的,我用来确保我们的验证逻辑拒绝案例类。

好的,所以 - 问题是,在很大程度上,这变得非常笨拙。假设我有一个包含 100 个不同元素的数据容器。生成一个“好”的很容易。但是现在,我想生成一个“坏”的,此外:

  1. 我想为每个数据元素生成一个错误的数据元素,其中单个数据元素是错误的(因此至少有 100 个错误实例,测试每个无效参数是否被验证逻辑捕获)。

  2. 我希望能够覆盖特定元素,例如输入错误的 ID 或错误的“foobar”。不管那是什么。

我们可以寻找灵感的一种模式是applyand copy,它允许我们在指定覆盖值的同时轻松组合新对象。例如:

val f = Foo("a", "b") // f: Foo = Foo(a,b)
val t = Foo.unapply(f) // t: Option[(String, String)] = Some((a,b))
Foo(t.get._1, "c") // res0: Foo = Foo(a,c)

上面我们看到了从另一个对象的模板创建变异对象的基本思想。这在 Scala 中更容易表达为:

val f = someFoo copy(b = "c")

以此为灵感,我们可以思考我们的目标。有几点需要考虑:

  1. 首先,我们可以为数据元素和生成的值定义一个映射或键/值容器。这可以用来代替元组来支持命名值突变。

  2. 给定一个键/值对容器,我们可以轻松地随机选择一个(或多个)对并更改一个值。这支持生成一个数据集的目标,其中一个值被更改以产生故障。

  3. 给定这样一个容器,我们可以轻松地从无效的值集合中创建一个新对象(使用其中一种apply()或其他技术)。

  4. 或者,也许我们可以开发一种使用元组然后只使用apply()它的模式,有点像copy方法,只要我们仍然可以随机更改一个或多个值。

我们或许可以探索开发一种可重复使用的模式,它可以执行以下操作:

def thingGen(invalidValueCount: Int): Gen[Thing] = ???
def someTest = forAll(thingGen) { v => invalidV = v.invalidate(1); validate(invalidV) must beFalse }

在上面的代码中,我们有一个thingGen返回 (valid)的生成器Things。然后对于返回的所有实例,我们调用一个通用方法invalidate(count: Int),该方法将随机使count值无效,返回一个无效对象。然后我们可以使用它来确定我们的验证逻辑是否正常工作。

这将需要定义一个invalidate()函数,给定一个参数(按名称或按位置),然后可以将识别的参数替换为已知错误的值。这意味着对特定值有一个“反生成器”,例如,如果一个 ID 必须是 3 个字符,那么它知道创建一个长度不超过 3 个字符的字符串。

当然,要使已知的单个参数无效(将不良数据注入测试条件),我们可以简单地使用复制方法:

def thingGen(invalidValueCount: Int): Gen[Thing] = ???
def someTest = forAll(thingGen) { v => v2 = v copy(id = "xxx"); validate(v2) must beFalse }

这是我迄今为止的想法的总和。我在吠叫错误的树吗?是否有处理这种测试的好模式?关于如何最好地解决这个测试我们的验证逻辑的问题的任何评论或建议?

4

1 回答 1

2

我们可以结合一个有效的实例和一组无效的字段(这样每个字段,如果被复制,都会导致验证失败)使用shapeless库来获取一个无效的对象。

Shapeless 允许您将您的类表示为仍然是强类型并支持一些高级操作的键值对列表,并将此表示转换回您的原始类。

在下面的示例中,我将为提供的每个字段提供一个无效实例

import shapeless._, record._
import shapeless.labelled.FieldType
import shapeless.ops.record.Updater

详细介绍

假设我们有一个数据类和它的一个有效实例(我们只需要一个,所以它可以被硬编码)

case class User(id: String, name: String, about: String, age: Int) {
  def isValid = id.length == 3 && name.nonEmpty && age >= 0
}
val someValidUser = User("oo7", "Frank", "A good guy", 42)
assert(someValidUser.isValid)

然后我们可以定义一个用于无效值的类:

case class BogusUserFields(name: String, id: String, age: Int)
val bogusData = BogusUserFields("", "1234", -5)

此类类的实例可以使用ScalaCheck提供。编写一个所有字段都会导致失败的生成器要容易得多。字段的顺序无关紧要,但它们的名称和类型很重要。about在这里,我们从一组字段中排除,User因此我们可以按照您的要求进行操作(仅提供您要测试的字段子集)

然后我们使用和LabelledGeneric[T]转换为它们对应的记录值(稍后我们将转换回来)UserBogusUserFieldsUser

val userLG = LabelledGeneric[User]
val bogusLG = LabelledGeneric[BogusUserFields]

val validUserRecord = userLG.to(someValidUser)
val bogusRecord = bogusLG.to(bogusData)

记录是键值对的列表,所以我们可以head用来获取单个映射,并且+操作符支持添加/替换字段到另一条记录。让我们一次将每个无效字段挑选到我们的用户中。此外,这里是转换回来的行动:

val invalidUser1 = userLG.from(validUserRecord + bogusRecord.head)// invalid name
val invalidUser2 = userLG.from(validUserRecord + bogusRecord.tail.head)// invalid ID
val invalidUser3 = userLG.from(validUserRecord + bogusRecord.tail.tail.head) // invalid age

assert(List(invalidUser1, invalidUser2, invalidUser3).forall(!_.isValid))

由于我们基本上将相同的函数 ( validUserRecord + _) 应用于我们的每个键值对bogusRecord,因此我们也可以使用map运算符,除非我们将它与不寻常的多态函数一起使用。我们也可以轻松地将其转换为List,因为现在每个元素都将属于同一类型。

object polymerge extends Poly1 {
  implicit def caseField[K, V](implicit upd: Updater[userLG.Repr, FieldType[K, V]]) =
    at[FieldType[K, V]](upd(validUserRecord, _))
}

val allInvalidUsers = bogusRecord.map(polymerge).toList.map(userLG.from)
assert(allInvalidUsers == List(invalidUser1, invalidUser2, invalidUser3))

泛化和删除所有样板

现在的重点是我们可以将其推广到任意两个任意类。所有关系和操作的编码有点麻烦,我花了一段时间才把所有的implicit not found错误都弄好,所以我将跳过细节。

class Picks[A, AR <: HList](defaults: A)(implicit lgA: LabelledGeneric.Aux[A, AR]) {
  private val defaultsRec = lgA.to(defaults)

  object mergeIntoTemplate extends Poly1 {
    implicit def caseField[K, V](implicit upd: Updater[AR, FieldType[K, V]]) =
      at[FieldType[K, V]](upd(defaultsRec, _))
  }

  def from[B, BR <: HList, MR <: HList, F <: Poly](options: B)
    (implicit
      optionsLG: LabelledGeneric.Aux[B, BR],
      mapper: ops.hlist.Mapper.Aux[mergeIntoTemplate.type, BR, MR],
      toList: ops.hlist.ToTraversable.Aux[MR, List, AR]
    ) = {
    optionsLG.to(options).map(mergeIntoTemplate).toList.map(lgA.from)
  }
}

所以,它在行动:

val cp = new Picks(someValidUser)
assert(cp.from(bogusData) == allInvalidUsers)

不幸的是,你不能写new Picks(someValidUser).from(bogusData),因为隐式 formapper需要一个稳定的标识符。另一方面,cp实例可以与其他类型重用:

case class BogusName(name: String)
assert(cp.from(BogusName("")).head == someValidUser.copy(name = ""))

现在它适用于所有类型!并且虚假数据必须是类字段的任何子集,因此即使对类本身也有效

case class Address(country: String, city: String, line_1: String, line_2: String) {
  def isValid = Seq(country, city, line_1, line_2).forall(_.nonEmpty)
}

val acp = new Picks(Address("Test country", "Test city", "Test line 1", "Test line 2"))
val invalidAddresses = acp.from(Address("", "", "", ""))
assert(invalidAddresses.forall(!_.isValid))

您可以在ScalaFiddle看到运行的代码

于 2017-01-12T05:51:54.347 回答