Merge branch 'logs'

Author: dlidstrom

Sprout.fs

@@ -5,6 +5,7 @@ let mutable debug: string -> unit = ignore
 
 type HookFunction = unit -> unit
 type EachFunction = Before of f: HookFunction | After of f: HookFunction
+type LogLevel = Debug of string | Info of string
 
 type EachBuilder(factory: (unit -> unit) -> EachFunction) =
   member _.Zero() = ()
@@ -35,16 +36,20 @@ type ItBuilder(name: string) =
 let it name = ItBuilder name
 let pending name = It.Pending name
 
+type DescribeStep =
+  | It of It
+  | LogStatement of LogLevel
+
 type Describe = {
   Name: string
-  TestCases: It list
+  Steps: DescribeStep list
   Each: EachFunction list
   Children: Describe list
 }
 with
   static member Empty name = {
     Name = name
-    TestCases = []
+    Steps = []
     Each = []
     Children = []
   }
@@ -54,16 +59,18 @@ type DescribeBuilder(name) =
   member _.Yield(each: EachFunction) =
     { Describe.Empty name with Each = [each] }
   member _.Yield(tc: It) =
-    { Describe.Empty name with TestCases = [tc] }
-  member _.Yield(sub: Describe) =
-    { Describe.Empty name with Children = [sub] }
+    { Describe.Empty name with Steps = [It tc] }
+  member _.Yield(log: LogLevel) =
+    { Describe.Empty name with Steps = [LogStatement log] }
+  member _.Yield(describe: Describe) =
+    { Describe.Empty name with Children = [describe] }
   member _.Combine(a, b) =
     {
       Describe.Empty name
       with
         Each = a.Each @ b.Each
         Children = a.Children @ b.Children
-        TestCases = a.TestCases @ b.TestCases
+        Steps = a.Steps @ b.Steps
     }
   member _.Delay(f: unit -> Describe) = f()
   member this.For(sequence: seq<'T>, body: 'T -> Describe) =
@@ -76,6 +83,8 @@ type DescribeBuilder(name) =
 
 let describe name = DescribeBuilder name
 
+type LogState = { Messages: string list }
+
 type Path = Path of string list
 with
   member this.Length =
@@ -107,9 +116,13 @@ module Reporters =
     let white = "\u001b[37m"
     let reset = "\u001b[0m"
 
-  type ConsoleReporter() =
+  type ConsoleReporter(passedChar, failedChar, pendingChar) =
     let sw = Stopwatch.StartNew()
     let indent (path: Path) = String.replicate ((path.Length - 1) * 2) " "
+
+    new() =
+      ConsoleReporter("✅", "❌", "❔")
+
     interface ITestReporter with
       member _.BeginSuite(name, path) =
         let indent = indent path
@@ -119,11 +132,11 @@ module Reporters =
         let indent = indent path
         match result with
         | Passed (_, name) ->
-            printfn $"%s{indent}%s{AnsiColours.green}  ✅ passed: %s{name}%s{AnsiColours.reset}"
+            printfn $"%s{indent}%s{AnsiColours.green}  %s{passedChar} passed: %s{name}%s{AnsiColours.reset}"
         | Failed (_, name, ex) ->
-            printfn $"%s{indent}%s{AnsiColours.red}  ❌ failed: %s{name} - %s{ex.Message}%s{AnsiColours.reset}"
+            printfn $"%s{indent}%s{AnsiColours.red}  %s{failedChar} failed: %s{name} - %s{ex.Message}%s{AnsiColours.reset}"
         | Pending (_, name) ->
-            printfn $"%s{indent}%s{AnsiColours.grey}  ❔ pending: %s{name}%s{AnsiColours.reset}"
+            printfn $"%s{indent}%s{AnsiColours.grey}  %s{pendingChar} pending: %s{name}%s{AnsiColours.reset}"
 
       member _.EndSuite(_, _) = ()
       member _.Debug(message: string, path: Path): unit =
@@ -169,7 +182,6 @@ with
   }
 
 type TestSuiteRunner = Describe -> TestContext -> unit
-type private LogLevel = Debug of string | Info of string
 
 let private runTestCase path (testCase: It) beforeHooks afterHooks =
   // setup logging functions
@@ -207,8 +219,14 @@ let rec private doRunTestSuite (suite: Describe) (context: TestContext): TestRes
   let afterHooks = context.ParentAfterHooks |> List.append (List.rev afterHooks)
 
   let testResults = [
-    for testCase in suite.TestCases do
-      runTestCase context.Path testCase beforeHooks afterHooks
+    for testCase in suite.Steps do
+      match testCase with
+      | It itCase ->
+        runTestCase context.Path itCase beforeHooks afterHooks
+      | LogStatement logStatement ->
+        match logStatement with
+        | Info message -> context.Reporter.Info(message, context.Path)
+        | Debug message -> context.Reporter.Debug(message, context.Path)
   ]
 
   for result, logs in testResults do
@@ -248,3 +266,11 @@ module Constraints =
   let shouldNotEqual unexpected actual =
     if unexpected = actual then
       failwithf "Expected not to be %A but got %A" unexpected actual
+
+  let shouldBeTrue condition =
+    if not condition then
+      failwith "Expected condition to be true"
+
+  let shouldBeFalse condition =
+    if condition then
+      failwith "Expected condition to be false"

Tests.fsx

@@ -15,6 +15,7 @@ let s2 = describe "Suite 2" {
 runTestSuite (describe "Main Suite" { s1; s2 })
 
 let suite = describe "A larger test suite" {
+  Info "Top level info message"
   beforeEach {
     debug "Before each test"
   }
@@ -35,6 +36,7 @@ let suite = describe "A larger test suite" {
   pending "This is a pending test"
 
   describe "Nested suite" {
+    Debug "Use beforeEach and afterEach for setup and teardown"
     it "should also pass" {
       info "Nested test passes"
     }

out.png

@@ -0,0 +1,64 @@
+#load "Sprout.fs"
+
+open Sprout
+
+let suite = describe "A test suite" {
+  it "should pass" {
+    info "This test passes"
+  }
+
+  it "should fail" {
+    info "This test fails"
+    failwith "Intentional failure"
+  }
+
+  pending "This is a pending test"
+
+  describe "Nested suite" {
+    info "Use beforeEach and afterEach for setup and teardown"
+    beforeEach {
+      debug "Before each test"
+    }
+
+    afterEach {
+      debug "After each test"
+    }
+    it "should also pass" {
+      info "Nested test passes"
+    }
+  }
+
+  describe "Arithmetic" {
+    describe "Addition" {
+      it "should add two numbers correctly" {
+        let result = 2 + 2
+        result |> shouldEqual 4
+      }
+    }
+
+    describe "Multiplication" {
+      it "should multiply two numbers correctly" {
+        let result = 3 * 3
+        result |> shouldEqual 9
+      }
+    }
+  }
+
+  describe "Comparisons" {
+    debug "Testing comparisons"
+    it "should compare numbers correctly" {
+      5 > 3 |> shouldBeTrue
+    }
+  }
+
+  describe "Parameterized Tests" {
+    info "Simply embed test cases and loop over them"
+    let numbers = [1; 2; 3; 4; 5]
+    for n in numbers do
+      it $"should handle number {n}" {
+        n > 0 |> shouldBeTrue
+      }
+  }
+}
+
+runTestSuiteWithContext suite { TestContext.Empty with Reporter = Reporters.ConsoleReporter("v", "x", "?") :> ITestReporter }