Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

XUnit2

Contains tasks to run xUnit v2 unit tests.

Nested types and modules

TypeDescription
CollectionConcurrencyMode

The collection concurrency mode used by the xUnit2 runner.

ParallelMode

The parallelization mode of the xUnit2 runner.

XUnit2Params

The xUnit2 parameter type.

Functions and values

Function or valueDescription
buildArgs parameters assemblies
Signature: parameters:XUnit2Params -> assemblies:seq<string> -> string

Builds the command line arguments from the given parameter record and the given assemblies.

run setParams assemblies
Signature: setParams:(XUnit2Params -> XUnit2Params) -> assemblies:seq<string> -> unit

Runs xUnit v2 unit tests in the given assemblies via the given xUnit2 runner. Will fail if the runner terminates with non-zero exit code.

The xUnit2 runner terminates with a non-zero exit code if any of the tests in the given assembly fail.

Parameters

  • setParams - Function used to manipulate the default XUnit2Params value.
  • assemblies - Sequence of one or more assemblies containing xUnit unit tests.

Sample usage

1: 
2: 
3: 
4: 
5: 
6: 
open Fake.DotNet.Testing
open Fake.IO.Globbing.Operators
Target.create "Test" (fun _ ->
    !! (testDir @@ "xUnit.Test.*.dll")
    |> XUnit2.run (fun p -> { p with HtmlOutputPath = Some (testDir @@ "xunit.html") })
)
namespace Fake
namespace Fake.DotNet
namespace Fake.DotNet.Testing
namespace Fake.IO
namespace Fake.IO.Globbing
module Operators

from Fake.IO.Globbing
module XUnit2

from Fake.DotNet.Testing
val run : setParams:(XUnit2.XUnit2Params -> XUnit2.XUnit2Params) -> assemblies:seq<string> -> unit
union case Option.Some: Value: 'T -> Option<'T>
XUnit2Defaults
Signature: XUnit2Params

The xUnit2 default parameters.

Defaults

  • NoAppDomain - false
  • Parallel - NoParallelization
  • MaxThreads - Default
  • HtmlOutputPath - None
  • XmlOutputPath - None
  • XmlV1OutputPath - None
  • IncludeTraits - []
  • ExcludeTraits - []
  • ShadowCopy - true
  • ErrorLevel - Error
  • ToolPath - The xunit.console.exe path if it exists in a subdirectory of the current directory.
  • WorkingDir - None
  • TimeOut - 5 minutes
  • ForceTeamCity - false
  • ForceAppVeyor - false
  • Silent - false
  • Wait - false
  • Namespace - None
  • Class - None
  • Method - None