feat: add testing framework and update build workflow for enhanced testing capabilities

Author: dlidstrom

.github/workflows/build.yml

@@ -52,6 +52,19 @@ jobs:
         with:
           dotnet-version: '9.0.x'
 
+      - name: Setup tools
+        run: |
+          npm install -g bats
+
+      - name: Tests
+        env:
+          DATABASE_HOST: localhost
+          DATABASE_PORT: 5433
+        run: |
+          mkdir test-results
+          bats . --verbose-run --print-output-on-failure --report-formatter junit --output test-results
+          ls -lah test-results
+
       - name: Restore dependencies
         run: dotnet restore
 

.gitignore

@@ -1,2 +1,4 @@
 bin
 obj
+current.log
+test-results

Tests.fsx

@@ -0,0 +1,65 @@
+#load "Sprout.fs"
+
+open Sprout
+
+let s1 = describe "Suite 1" {}
+let s2 = describe "Suite 2" {
+  beforeEach {
+    debug "Before each test in Suite 2"
+  }
+
+  it "should pass in Suite 2" {
+    info "This test passes in Suite 2"
+  }
+}
+runTestSuite (describe "Main Suite" { s1; s2 })
+
+let suite = describe "A larger test suite" {
+  beforeEach {
+    debug "Before each test"
+  }
+
+  afterEach {
+    debug "After each test"
+  }
+
+  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" {
+    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
+      }
+
+      it "should handle negative numbers" {
+        let result = -1 + -1
+        result |> shouldEqual -2
+      }
+    }
+
+    describe "Faulty Addition" {
+      it "should fail when adding incorrect numbers" {
+        let result = 2 + 2
+        result |> shouldEqual 5
+      }
+    }
+  }
+}
+
+runTestSuite suite

expected.log

@@ -0,0 +1,43 @@
+Main Suite
+  Suite 1
+  Suite 2
+  Before each test in Suite 2
+  This test passes in Suite 2
+    ✅ passed: should pass in Suite 2
+All tests passed!
+Summary: 1 passed, 0 failed, 0 pending
+Total time: 00:00:00.0045414
+A larger test suite
+Before each test
+This test passes
+After each test
+  ✅ passed: should pass
+Before each test
+This test fails
+After each test
+  ❌ failed: should fail - Intentional failure
+Before each test
+After each test
+  ❔ pending: This is a pending test
+  Nested suite
+  Before each test
+  Nested test passes
+  After each test
+    ✅ passed: should also pass
+  Arithmetic
+    Addition
+    Before each test
+    After each test
+      ✅ passed: should add two numbers correctly
+    Before each test
+    After each test
+      ✅ passed: should handle negative numbers
+    Faulty Addition
+    Before each test
+    After each test
+      ❌ failed: should fail when adding incorrect numbers - Expected 5 but got 4
+There were 2 test failures:
+- A larger test suite / should fail - Intentional failure
+- A larger test suite / Arithmetic / Faulty Addition / should fail when adding incorrect numbers - Expected 5 but got 4
+Summary: 4 passed, 2 failed, 1 pending
+Total time: 00:00:00.0034939

test.bats

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+@test "Tests.fsx" {
+  dotnet fsi Tests.fsx > current.log
+  run diff <(cat expected.log | grep -v "Total time") <(cat current.log | grep -v "Total time")
+  [ "$status" -eq 0 ]
+  printf 'Lines:\n'
+  printf 'lines %s\n' "${lines[@]}" >&2
+  printf 'output %s\n' "${output[@]}" >&2
+}