FsCheckの出力をカスタマイズする

Question

私はVisualStudioのFsCheckとNUnitでテストしています。

問題は現在あります：（グラフ機能をテストするための）ランダムグラフを生成することができましたが、テストが失敗した場合、FsCheckはグラフ全体を吐き出し、ToStringを使用しないので、そこには何も見ることができません。

また、検査のための入力グラフだけでなく、プロパティを実行するときに作成するその他のデータも必要です。

テストが失敗したときに、どのように私は

• するためにFsCheckの出力動作を変更することができ、実際に入力グラフ
• 出力、さらに情報

に私のToStringメソッドを呼び出しますか？

編集： ここに私の現在のテストセットアップがあります。

module GraphProperties 

open NUnit.Framework 
open FsCheck 
open FsCheck.NUnit 

let generateRandomGraph = 
    gen { 
     let graph: Graph<int,int> = Graph<_,_>.Empty() 
     // fill in random nodes and transitions... 
     return graph 
    } 

type MyGenerators = 
    static member Graph() = 
     {new Arbitrary<Graph<int,int>>() with 
      override this.Generator = generateRandomGraph 
      override this.Shrinker _ = Seq.empty } 

[<TestFixture>] 
type NUnitTest() = 
    [<Property(Arbitrary=[|typeof<MyGenerators>|], QuietOnSuccess = true)>] 
    member __.cloningDoesNotChangeTheGraph (originalGraph: Graph<int,int>) = 
     let newGraph = clone originalGraph 
     newGraph = originalGraph 

Answer 1

FsCheckはそう、あなたが何をする必要があるか、あなたのタイプは%Aフォーマッタでフォーマットされているどのように制御され、テスト出力に文字列にテストパラメータを変換するsprintf "%A"を使用しています。 How do I customize output of a custom type using printf?によると、その方法はStructuredFormatDisplay attributeです。その属性の値は、PreText {PropertyName} PostTextという形式の文字列である必要があります。PropertyNameは、お使いのタイプのプロパティ（ではなく、の機能です）である必要があります。たとえば、葉に複雑な情報を含むツリー構造があるとしますが、テストでは葉の数だけを知る必要があります。葉の数はわかりません。したがって、次のようなデータタイプから始めましょう：

// Example 1 
type ComplicatedRecord = { ... } 
type Tree = 
    | Leaf of ComplicatedRecord 
    | Node of Tree list 
    with 
     member x.LeafCount = 
      match x with 
      | Leaf _ -> 1 
      | Node leaves -> leaves |> List.sumBy (fun x -> x.LeafCount) 
     override x.ToString() = 
      // For test output, we don't care about leaf data, just count 
      match x with 
      | Leaf -> "Tree with a total of 1 leaf" 
      | Node -> sprintf "Tree with a total of %d leaves" x.LeafCount 

これまでのところ、これはあなたが望むものではありません。このタイプはではなくのカスタム%Aフォーマットが宣言されているので、FsCheck（およびそれをフォーマットするためにsprintf "%A"を使用するもの）は、ツリーの複雑な構造全体とその無関係なテストリーフデータを出力します。 FsCheckに表示する内容を出力させるには、のプロパティを設定する必要があります。表示する内容を出力するファンクション（この目的ではToStringは機能しません）ではありません。例えば：

// Example 2 
type ComplicatedRecord = { ... } 
[<StructuredFormatDisplay("{LeafCountAsString}")>] 
type Tree = 
    | Leaf of ComplicatedRecord 
    | Node of Tree list 
    with 
     member x.LeafCount = 
      match x with 
      | Leaf _ -> 1 
      | Node leaves -> leaves |> List.sumBy (fun x -> x.LeafCount) 
     member x.LeafCountAsString = x.ToString() 
     override x.ToString() = 
      // For test output, we don't care about leaf data, just count 
      match x with 
      | Leaf -> "Tree with a total of 1 leaf" 
      | Node -> sprintf "Tree with a total of %d leaves" x.LeafCount 

注：私はちょうどスタックオーバーフローのコメントボックスにそれを入力した、F＃でこれをテストしていません - それは私がToString()一部を台無しにしたことが可能です。 （私は覚えていないし、迅速なGoogleでは、上書きがwithキーワードの前か後かであるかどうかはわからない）。しかし私はStructuredFormatDisplay属性があなたが望むものであることを知っています。なぜなら、これを使ってFsCheckからカスタム出力を得るためです。

ところで、私の例でも複雑なレコードタイプにStructuredFormatDisplay属性を設定することもできます。たとえば、あなたが葉の内容についてのツリー構造を気にしなくテストを持っている場合、あなたはそれが好きで記述します

// Example 3 
[<StructuredFormatDisplay("LeafRecord")>] // Note no {} and no property 
type ComplicatedRecord = { ... } 
type Tree = 
    | Leaf of ComplicatedRecord 
    | Node of Tree list 
    with 
     member x.LeafCount = 
      match x with 
      | Leaf _ -> 1 
      | Node leaves -> leaves |> List.sumBy (fun x -> x.LeafCount) 
     override x.ToString() = 
      // For test output, we don't care about leaf data, just count 
      match x with 
      | Leaf -> "Tree with a total of 1 leaf" 
      | Node -> sprintf "Tree with a total of %d leaves" x.LeafCount 

今、すべてのあなたのComplicatedRecordのインスタンスに関係なく、その内容、意志あなたの出力にLeafRecordのテキストとして表示されるので、代わりにツリー構造に集中することができます。TreeタイプのStructuredFormatDisplay属性を設定する必要はありません。

実行中のさまざまなテストで必要に応じて、StructuredFormatDisplay属性を適宜調整する必要があるため、これは完全に理想的な解決策ではありません。 （いくつかのテストでは、リーフデータの一部に集中することが必要な場合があります。リーフデータを完全に無視したい場合など）。そして、プロダクションに行く前に属性を取り除きたいと思うかもしれません。しかし、FsCheckが "設定パラメータで失敗したテストデータをフォーマットする機能を提供する"ことができるまでは、テストデータを必要なときにフォーマットするための最良の方法です。

Answer 2

また、テストが失敗したとき、あなたが欲しいものは何でも表示するためにラベルを使用することができます。https://fscheck.github.io/FsCheck/Properties.html#And-Or-and-Labels