Skip to content

Latest commit

 

History

History
81 lines (58 loc) · 3.2 KB

README.md

File metadata and controls

81 lines (58 loc) · 3.2 KB

AutoFixture.Community.FSharp

Build

Package Version Downloads
AutoFixture.Community.FSharp AutoFixture.Community.FSharp Downloads
AutoFixture.Community.FSharp.Xunit AutoFixture.Community.FSharp.Xunit Downloads

This is a small library that builds on top of AutoFixture to add support for F#-specific types. Specifically, the important additions that are't currently handled well with vanilla AutoFixture are:

  1. Discriminated Unions
  2. F# lists

Everything else seems to work pretty well out of the box.

Useful bits:

FSharpSpecimenBuilder:

Can be inserted onto any existing IFixture by doing the following

let fixture = Fixture()
//...

fixture.Customizations.Add(FSharpSpecimenBuilder(fixture))

fsFixture

A pre-made fixture with only the F# features applied.

randVal and friends

Helper functions for creating random data inline, e.g.:

type MyDto =
  { Foo : int
    Bar : string
    Baz : DateTime }

[<Fact>]
let ``My test method when Foo is 5`` () =
  // Generate random values explicitly for specific properties
  let myDto =
    { Foo = 5
      Bar = randVal()
      Baz = randVal() }

  // Or generate a full random value and only override specific properties
  let otherDto =
    { randVal<MyDto>() with Foo = 5 }
  ~~// Do assertions~~

Thanks to F#'s type system, most of the time you can omi~~~~t the type arguments. Similar helper functions include:

  • randVal<'a>() : create a single random value
  • randVals<'a>() : create an 'a seq
  • randValsN<'a> (n: int) : create an 'a seq that is n elements long
  • randValExceptWhere<'a> (fn: 'a -> bool) : create a single random value for which fn returns false.
  • randValExcept<'a> (x: 'a) : create a random value that is not x
  • randValsExceptWhere<'a> (fn: 'a -> bool) : create an infinite sequence of random values where fn returns false
  • randValsExcept<'a> (x: 'a) : create an infinite sequence of random values except x
  • randValsNExceptWhere<'a> (n: int) (fn: 'a -> bool) : create a sequence of n random values where fn returns false
  • randValsNExcept<'a> (n: int) (x: 'a) : create a sequence of n random values except for x

AutoFixture.Community.FSharp.Xunit

This package defines just two attributes:

  1. AutoDataFSharpAttribute
  2. InlineAutoDataFSharpAttribute

Which respectively correspond to the AutoDatAttribute and InlineAutoDataAttribute from AutoFixture.Xunit2