用于生成负Scalacheck场景的模式：使用基于属性的测试来测试Scala中的验证逻辑

问题描述 投票：4回答：1

我们正在寻找一种可行的设计模式来构建Scalacheck Gen（发电机），它可以产生正面和负面的测试场景。这将允许我们运行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”。无论那是什么。

我们可以寻找灵感的一种模式是apply和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的生成器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 }

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

scala scalacheck property-based-testing
1个回答
2
投票

我们可以组合一个有效的实例和一组无效字段（以便每个字段，如果复制，将导致验证失败）使用shapeless库获取无效对象。

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

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

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

A detailed intro

让我们假装我们有一个数据类，以及它的有效实例（我们只需要一个，所以可以硬编码）

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]将User和BogusUserFields转换为相应的记录值（稍后我们将User转换回来）

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))

Generalizing and removing all the boilerplate

现在，重点是我们可以将它推广到任意两个任意类。所有关系和操作的编码都有点麻烦，我花了一些时间来解决所有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)因为mapper的隐含需要一个稳定的标识符。另一方面，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上看到运行的代码

最新问题
© www.soinside.com 2019 - 2024. All rights reserved.