F# Other
stijnmoreels and kurtschelfthout Add Arbitrary instance for XML encoded string (#445)
Generate strings that can be used as values inside an XML document.
Latest commit 79e43c4 Aug 14, 2018
Permalink
Failed to load latest commit information.
.paket update paket bootstrapper, to avoid issue with Github disabling TLS (#… Feb 25, 2018
Docs/files/img Added PowerPoint source for logos Feb 5, 2017
docs Except for .NET Standard, require only F# Core >= 4.0. Dec 29, 2017
examples Clean up NUnit examples. Jun 16, 2018
src Add Arbitrary instance for XML encoded string (#445) Aug 14, 2018
tests Add Arbitrary instance for XML encoded string (#445) Aug 14, 2018
.gitattributes Update .gitattributes so SourceLink might work. May 24, 2014
.gitignore Ignored Paket.Restore.targets (#405) Oct 12, 2017
.travis.yml Revert "Reinstate travis CI build." Dec 25, 2017
Contributors.txt Fix my name in the contributors file Aug 16, 2013
FsCheck Release Notes.md Update release notes. Jun 15, 2018
FsCheck-mono.sln Attempt to fix mono solution. May 6, 2017
FsCheck.netcore.sln Add netcore solution to simplify build somewhat. Aug 22, 2017
FsCheck.sln Add paket.dependencies to sln. Feb 6, 2017
License.txt Clean up docs generation. May 25, 2014
README.md Update readme. Apr 20, 2016
Settings.FSharpLint Add Lint settings. Jul 31, 2016
appveyor.yml Revert "use SourceLink version 2 (#378)" Aug 28, 2017
build.cmd Put build deps in separate paket group. Dec 29, 2017
build.fsx Put build deps in separate paket group. Dec 29, 2017
build.sh Put build deps in separate paket group. Dec 29, 2017
global.json Build .NET Core seems to work. May 6, 2017
paket.dependencies Except for .NET Standard, require only F# Core >= 4.0. Dec 29, 2017
paket.lock Update FAKE and Octokit again. Apr 10, 2018

README.md

What is FsCheck?

FsCheck is a tool for testing .NET programs automatically. The programmer provides a specification of the program, in the form of properties which functions, methods or objects should satisfy, and FsCheck then tests that the properties hold in a large number of randomly generated cases. While writing the properties, you are actually writing a testable specification of your program. Specifications are expressed in F#, C# or VB, using combinators defined in the FsCheck library. FsCheck provides combinators to define properties, observe the distribution of test data, and define test data generators. When a property fails, FsCheck automatically displays a minimal counter example.

FsCheck is a port of Haskell's QuickCheck. Important parts of the manual for using FsCheck is almost literally adapted from the QuickCheck manual. Any errors and omissions are entirely my responsibility.

Since v0.5, scalacheck has influenced FsCheck as well. Scalacheck is itself a port of QuickCheck to Scala.

FsCheck's generator combinators can be used in any testing framework to easily generate a number of random values for many types, and FsCheck itself integrates nicely with existing unit testing frameworks such as NUnit, xUnit, MSTest and MbUnit.

NuGet

Releases:

FsCheck follows Semantic Versioning 2.0.0, except for the API exposed in FsCheck.Experimental which is subject to change at any time.

All AppVeyor builds are available using the NuGet feed: https://ci.appveyor.com/nuget/fscheck

If using Paket, add the source at the top of paket.dependencies.

source https://www.nuget.org/api/v2
source https://ci.appveyor.com/nuget/fscheck

See the build history for a list of available versions: https://ci.appveyor.com/project/kurtschelfthout/fscheck/history

Here are some options for specifying the dependency:

nuget FsCheck
nuget FsCheck prerelease
nuget FsCheck 2.0.4
nuget FsCheck 2.0.5-b247

Documentation

Contributing

Pull requests very welcome!

Check out the issues marked up-for-grabs if you need any inspiration.

It's very rare that we reject PRs. Generally, if you intend to make a bigger change, it's better to open an issue first to discuss.

Building

Checkout the project and run build.cmd on Windows or build.sh on Linux/OSX. That should pull in all the dependencies, build and run the tests.

For Visual Studio/MonoDevelop/Xamarin Studio: open FsCheck.sln in Visual Studio on Windows or FsCheck-mono.sln on Linux/OSX in and start coding.

For all other editors, FsCheck uses FAKE, targets for building are Build and for testing RunTests.

Documentation uses FSharp.Formatting, so literate fsx files. To generate the html files, run build.[cmd|sh] generatedocs. Then run build.[cmd|sh] keeprunning and just edit any documentation fsx file, on save it should be picked up and re-generated.

  • Windows on .NET:Build status
  • Linux on Mono: Build Status