Logo Hegel for F#

Hegel Type

 Entry points: Hegel.test runs a property and throws its failure, as a test function wants;
 Hegel.run returns the  instead. Both print the failing test case as
 F# (let xs_1 = [0; 0]) and identify the test to the database from the calling function.
 
 [<Fact>]
 let ``addition commutes`` () =
     Hegel.test (fun tc ->
         let a = tc.Draw Gen.int
         let b = tc.Draw Gen.int
         Assert.Equal(a + b, b + a))
 

Static members

Static member Description

Hegel.engineVersion

Full Usage: Hegel.engineVersion

Returns: string

The version of the engine (libhegel) this frontend is running on.

Returns: string

Hegel.run (settings, reporter, body, ?file, ?line, ?name)

Full Usage: Hegel.run (settings, reporter, body, ?file, ?line, ?name)

Parameters:
Returns: RunReport

Run with , reporting to , and return the report.

settings : Settings
reporter : Reporter
body : TestCase -> unit
?file : string
?line : int
?name : string
Returns: RunReport

Hegel.run (settings, body, ?file, ?line, ?name)

Full Usage: Hegel.run (settings, body, ?file, ?line, ?name)

Parameters:
    settings : Settings
    body : TestCase -> unit
    ?file : string
    ?line : int
    ?name : string

Returns: RunReport

Run with and return the report.

settings : Settings
body : TestCase -> unit
?file : string
?line : int
?name : string
Returns: RunReport

Hegel.run (body, ?file, ?line, ?name)

Full Usage: Hegel.run (body, ?file, ?line, ?name)

Parameters:
    body : TestCase -> unit
    ?file : string
    ?line : int
    ?name : string

Returns: RunReport

Run as test does, but return the report instead of throwing when it fails. A run that cannot complete (a health check, a stale ReproduceFailure blob) still throws.

body : TestCase -> unit
?file : string
?line : int
?name : string
Returns: RunReport

Hegel.test (settings, reporter, body, ?file, ?line, ?name)

Full Usage: Hegel.test (settings, reporter, body, ?file, ?line, ?name)

Parameters:
Returns: RunReport

Run as a property-based test with , reporting to , and throw the failure it finds.

settings : Settings
reporter : Reporter
body : TestCase -> unit
?file : string
?line : int
?name : string
Returns: RunReport

Hegel.test (settings, body, ?file, ?line, ?name)

Full Usage: Hegel.test (settings, body, ?file, ?line, ?name)

Parameters:
    settings : Settings
    body : TestCase -> unit
    ?file : string
    ?line : int
    ?name : string

Returns: RunReport

Run as a property-based test with and throw the failure it finds.

settings : Settings
body : TestCase -> unit
?file : string
?line : int
?name : string
Returns: RunReport

Hegel.test (body, ?file, ?line, ?name)

Full Usage: Hegel.test (body, ?file, ?line, ?name)

Parameters:
    body : TestCase -> unit
    ?file : string
    ?line : int
    ?name : string

Returns: RunReport

Run as a property-based test with the default settings and throw the failure it finds: the minimal failing test case's own exception, with its stack. The remaining parameters are filled in by the compiler and identify the test to the database.

body : TestCase -> unit
?file : string
?line : int
?name : string
Returns: RunReport

Type something to start searching.