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

OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

DotCover

Contains a task which can be used to run DotCover on .NET assemblies.

Nested types and modules

TypeDescription
DotCoverMergeParams
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

DotCoverParams
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

The dotCover parameter type for running coverage

DotCoverReportParams
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

DotCoverReportType
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

Functions and values

Function or valueDescription
buildDotCoverArgs(parameters)
Signature: parameters:DotCoverParams -> string
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

buildDotCoverMergeArgs(parameters)
Signature: parameters:DotCoverMergeParams -> string
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

buildDotCoverReportArgs(parameters)
Signature: parameters:DotCoverReportParams -> string
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

buildParamsAndExecute(...)
Signature: parameters:'?10065 -> buildArguments:('?10065 -> string) -> toolPath:string -> workingDir:string -> failBuild:bool -> unit
Type parameters: '?10065 Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

DotCover(setParams)
Signature: setParams:(DotCoverParams -> DotCoverParams) -> unit
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

Runs the dotCover "cover" command, using a target executable (such as NUnit or MSpec) and generates a snapshot file.

Parameters

  • setParams - Function used to overwrite the dotCover default parameters.
DotCoverDefaults
Signature: DotCoverParams
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

The dotCover default parameters

DotCoverMerge(setParams)
Signature: setParams:(DotCoverMergeParams -> DotCoverMergeParams) -> unit
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

Runs the dotCover "merge" command. This combines dotCover snaphots into a single snapshot, enabling you to merge test coverage from multiple test running frameworks

Parameters

  • setParams - Function used to overwrite the dotCover merge default parameters.

Sample

1: 
2: 
3: 
4: 
DotCoverMerge (fun p -> { p with 
                    Source = [artifactsDir @@ "NUnitDotCoverSnapshot.dcvr"
                              artifactsDir @@ "MSpecDotCoverSnapshot.dcvr"]
                    Output = artifactsDir @@ "dotCoverSnapshot.dcvr" }) 
DotCoverMergeDefaults
Signature: DotCoverMergeParams
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

DotCoverMSpec(...)
Signature: setDotCoverParams:(DotCoverParams -> DotCoverParams) -> setMSpecParams:(MSpecParams -> MSpecParams) -> assemblies:seq<string> -> unit
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

Runs the dotCover "cover" command against the MSpec test runner.

Parameters

  • setDotCoverParams - Function used to overwrite the dotCover report default parameters.
  • setMSpecParams - Function used to overwrite the MSpec default parameters.

Sample

1: 
2: 
3: 
4: 
5: 
6: 
!! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") 
    |> DotCoverMSpec 
        (fun dotCoverOptions -> { dotCoverOptions with 
                Output = artifactsDir @@ "MSpecDotCoverSnapshot.dcvr" }) 
        (fun mSpecOptions -> { mSpecOptions with
                Silent = true })
DotCoverMSTest(...)
Signature: setDotCoverParams:(DotCoverParams -> DotCoverParams) -> setMSTestParams:(MSTestParams -> MSTestParams) -> assemblies:seq<string> -> unit
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

Runs the dotCover "cover" command against the MSTest test runner.

Parameters

  • setDotCoverParams - Function used to overwrite the dotCover report default parameters.
  • setMSTestParams - Function used to overwrite the MSTest default parameters.

Sample

1: 
2: 
3: 
4: 
!! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") 
    |> MSTest 
        (fun  -> dotCoverOptions )
        (fun MSTestOptions -> MSTestOptions) 
DotCoverNUnit(...)
Signature: setDotCoverParams:(DotCoverParams -> DotCoverParams) -> setNUnitParams:(NUnitParams -> NUnitParams) -> assemblies:seq<string> -> unit
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

Runs the dotCover "cover" command against the NUnit test runner.

Parameters

  • setDotCoverParams - Function used to overwrite the dotCover report default parameters.
  • setNUnitParams - Function used to overwrite the NUnit default parameters.

Sample

1: 
2: 
3: 
4: 
5: 
6: 
!! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") 
    |> DotCoverNUnit 
        (fun dotCoverOptions -> { dotCoverOptions with 
                Output = artifactsDir @@ "NUnitDotCoverSnapshot.dcvr" }) 
        (fun nUnitOptions -> { nUnitOptions with
                DisableShadowCopy = true })
DotCoverNUnit3(...)
Signature: setDotCoverParams:(DotCoverParams -> DotCoverParams) -> setNUnitParams:(NUnit3Params -> NUnit3Params) -> assemblies:seq<string> -> unit
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

Runs the dotCover "cover" command against the NUnit test runner.

Parameters

  • setDotCoverParams - Function used to overwrite the dotCover report default parameters.
  • setNUnitParams - Function used to overwrite the NUnit default parameters.

Sample

1: 
2: 
3: 
4: 
5: 
6: 
!! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") 
    |> DotCoverNUnit 
        (fun dotCoverOptions -> { dotCoverOptions with 
                Output = artifactsDir @@ "NUnitDotCoverSnapshot.dcvr" }) 
        (fun nUnitOptions -> { nUnitOptions with
                DisableShadowCopy = true })
DotCoverReport(setParams)
Signature: setParams:(DotCoverReportParams -> DotCoverReportParams) -> bool -> unit
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

Runs the dotCover "report" command. This generates a report from a dotCover snapshot

Parameters

  • setParams - Function used to overwrite the dotCover report default parameters.

Sample

1: 
2: 
3: 
4: 
DotCoverReport (fun p -> { p with 
                    Source = artifactsDir @@ "dotCoverSnapshot.dcvr"
                    Output = artifactsDir @@ "dotCoverReport.xml"
                    ReportType = DotCoverReportType.Xml })
DotCoverReportDefaults
Signature: DotCoverReportParams
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

DotCoverXUnit2(...)
Signature: setDotCoverParams:(DotCoverParams -> DotCoverParams) -> setXUnit2Params:(XUnit2Params -> XUnit2Params) -> assemblies:seq<string> -> unit
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead

Runs the dotCover "cover" command against the XUnit2 test runner.

Parameters

  • setDotCoverParams - Function used to overwrite the dotCover report default parameters.
  • setXUnit2Params - Function used to overwrite the XUnit2 default parameters.

Sample

1: 
2: 
3: 
4: 
!! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") 
    |> DotCoverXUnit2 
        (fun  -> dotCoverOptions )
        (fun nUnitOptions -> nUnitOptions) 
getWorkingDir(workingDir)
Signature: workingDir:string -> string
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Testing.DotCover module instead