f# - 在 FsCheck 中生成自定义数据

Question

我有一个 FsCheck题:
我有以下记录类型(我事先说过，有人告诉我我的单例 DU 可能有点矫枉过正，但我​​发现它们描述了域，因此是必要的，除非必须，否则我不会删除它们):

type Name = Name of string
type Quality = Quality of int
type ShelfLife = Days of int
type Style = Plain | Aged | Legendary

type Item = {
    Name: Name
    Quality: Quality
    ShelfLife: ShelfLife
    Style: Style
}

假设我已经定义了函数 repeat: Int -> ('a -> 'a) -> 'a和 decreaseQuality: Item -> Item , 我想编码一个 FsCheck检查不变量的测试:任何具有传奇风格之外的风格的元素，在 100 天过去后，其质量为 0。

我的问题是我不知道以下关于 FsCheck 的事情:
1. 如何定义一个自定义生成器来生成样式不是传奇的项目？相比之下，我如何仅定义 Legendary 类型的项目(以测试两种类型)？

我调查过:

 let itemGenerator = Arb.generate<Item>
 Gen.sample 80 5 itemGenerator

但这会创建非常奇怪的项目，如 size在示例中， Controller 80 还控制 Name of string 的长度(由于 of string )并且还产生 Quality和 ShelfLife我的域 Not Acceptable 值(即负值)，因为它们都定义为 ... of int大小也控制。
(我也研究过 Gen.oneof... ，但结果证明这也是个废话)。

我什至如何定义一个只测试记录的 Quality 属性的测试，即使假设我找到了一种生成自定义数据的方法？

谢谢!

Answer 1

一旦您知道如何使用 gen { }，您想要的大部分内容都会变得简单。计算表达式达到最大效果。

首先，我将解决如何生成 Style那不是传奇。您可以使用 Gen.oneOf ，但在这种情况下，我认为使用 Gen.elements 更简单, 自 oneOf需要使用一系列生成器，但 elements只需要一个项目列表并从该列表中生成一个项目。所以要生成一个 Style这不是传奇，我会使用 Gen.elements [Plain; Aged] . (并且要生成一个 Style 即传奇，我只是不使用生成器而只是将传奇分配给适当的记录字段，但稍后会详细介绍。)

至于名称太长，为了将生成的字符串的大小限制为最多 15 个字符，我会使用:

let genString15 = Gen.sized (fun s -> Gen.resize (min s 15) Arb.generate<string>)
// Note: "min" is not a typo. We want either s or 15, whichever is SMALLER
Gen.sample 80 5 genString15
// Never produces any strings longer than 15 characters

但这仍然可以生成null字符串，所以我可能会在我的最终版本中使用它:

let genString15 =
    Gen.sized (fun s -> Gen.resize (min s 15) Arb.generate<NonNull<string>>)
    |> Gen.map (fun (NonNull x) -> x)  // Unwrap
Gen.sample 80 5 genString15
// Never produces any strings longer than 15 characters, AND never produces null

现在，由于 Quality和 ShelfLife两者都不能为负，我会使用 PositiveInt (其中 0 也不允许)或 NonNegativeInt (允许为 0)。 FsCheck 文档中都没有详细记录，但它们的工作方式如下:

let x = Arb.generate<NonNegativeInt>
Gen.sample 80 5 x
// Produces [NonNegativeInt 79; NonNegativeInt 75; NonNegativeInt 0;
//           NonNegativeInt 69; NonNegativeInt 16] which is hard to deal with
let y = Arb.generate<NonNegativeInt> |> Gen.map (fun (NonNegativeInt n) -> n)
Gen.sample 80 5 y
// Much better: [79; 75; 0; 69; 16]

避免在 Quality 的生成器之间重复代码和 Days ，我会写如下:

let genNonNegativeOf (f : int -> 'a) = gen {
    let! (NonNegativeInt n) = Arb.generate<NonNegativeInt>
    return (f n)
}
Gen.sample 80 5 (genNonNegativeOf Quality)
// Produces: [Quality 79; Quality 35; Quality 2; Quality 42; Quality 73]
Gen.sample 80 5 (genNonNegativeOf Days)
// Produces: [Days 60; Days 27; Days 50; Days 22; Days 23]

最后，让我们用 gen { } 以一种漂亮、优雅的方式将它们联系在一起。行政长官:

let genNonLegendaryItem = gen {
    let! name = genString15 |> Gen.map Name
    let! quality = genNonNegativeOf Quality
    let! shelfLife = genNonNegativeOf Days
    let! style = Gen.elements [Plain; Aged]
    return {
        Name = name
        Quality = quality
        ShelfLife = shelfLife
        Style = style
    }
}
let genLegendaryItem =
    // This is the simplest way to avoid code duplication
    genNonLegendaryItem
    |> Gen.map (fun item -> { item with Style = Legendary })

然后，一旦你这样做了，要在你的测试中实际使用它，你需要注册生成器，正如 Tarmil 在他的回答中提到的那样。我可能会在这里使用单例 DU，以便轻松编写测试，如下所示:

type LegendaryItem = LegendaryItem of Item
type NonLegendaryItem = NonLegendaryItem of Item

然后你会注册 genLegendaryItem和 genNonLegendaryItem发电机作为生产 (Non)LegendaryItem通过 Gen.map 传递它们来输入类型.然后你的测试用例看起来像这样(我将在这里使用 Expecto 作为我的例子):

[<Tests>]
let tests =
    testList "Item expiration" [
        testProperty "Non-legendary items expire after 100 days" <| fun (NonLegendaryItem item) ->
            let itemAfter100Days = item |> repeat 100 decreaseQuality
            itemAfter100Days.Quality = Quality 0
        testProperty "Legendary items never expire" <| fun (LegendaryItem item) ->
            let itemAfter100Days = item |> repeat 100 decreaseQuality
            itemAfter100Days.Quality > Quality 0
    ]

请注意，使用这种方法，您基本上必须自己编写收缩器，而使用 Arb.convert正如 Tarmil 所建议的那样，您可以“免费”获得收缩器。不要低估收缩器的值(value)，但如果您发现没有它们也能生活，我喜欢 gen { } 漂亮、干净的特性。计算表达式，以及阅读结果代码的难易程度。